创建一个流连接
为指定项目中的流实例创建一个连接。要使用此资源，请求的服务账户或 API 密钥必须具有“项目所有者”或“项目流处理所有者”角色。
路径参数
-
用于标识项目的唯一 24-十六进制数字字符串。 使用 /groups 端点检索身份验证的用户有权访问权限的所有项目。
注意：群组和项目是同义词。您的群组 ID 与项目 ID 相同。对于现有群组，群组/项目 ID 保持不变。资源和相应的端点使用“群组”一词。
格式应符合以下模式：
^([a-f0-9]{24})$。 -
人类可读标签，用于标识流实例。
查询参数
-
指示应用程序是否将响应包装在
envelopeJSON 对象中的标志。某些 API 客户端无法访问 HTTP 响应标头或状态代码。要修复此问题，请在查询中设置 Envelope=true。返回结果列表的端点将结果对象用作 envelope。应用程序将状态参数添加到响应正文中。默认值为
false。 -
指示响应正文是否应采用 prettyprint 格式的标记。
默认值为
false。Prettyprint
POST /API/Atlas/v2/groups/{groupId}/streams/{tenantName}/connections
Atlas CLI
atlas api streams createStreamConnection --helpimport (
"os"
"context"
"log"
sdk "go.mongodb.org/atlas-sdk/v20240530001/admin"
)
func main() {
ctx := context.Background()
clientID := os.Getenv("MONGODB_ATLAS_CLIENT_ID")
clientSecret := os.Getenv("MONGODB_ATLAS_CLIENT_SECRET")
// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth
client, err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))
if err != nil {
log.Fatalf("Error: %v", err)
}
params = &sdk.CreateGroupStreamConnectionApiParams{}
sdkResp, httpResp, err := client.StreamsApi.
CreateGroupStreamConnectionWithParams(ctx, params).
Execute()
}
curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
--header "Accept: application/vnd.atlas.2024-05-30+json" \
--header "Content-Type: application/json" \
-X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}/connections" \
-d '{ <Payload> }'curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
--digest --include \
--header "Accept: application/vnd.atlas.2024-05-30+json" \
--header "Content-Type: application/json" \
-X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}/connections" \
-d '{ <Payload> }'
请求示例
抽检 (Sample)
{
"type": "Sample"
}{
"clusterGroupId": "string",
"clusterName": "string",
"dbRoleToExecute": {
"role": "string",
"type": "BUILT_IN"
},
"type": "Cluster"
}{
"authentication": {
"clientId": "string",
"clientSecret": "string",
"mechanism": "string",
"method": "string",
"password": "string",
"saslOauthbearerExtensions": "string",
"scope": "string",
"sslCertificate": "string",
"sslKey": "string",
"sslKeyPassword": "string",
"tokenEndpointUrl": "string",
"username": "string"
},
"bootstrapServers": "string",
"config": {
"debug": "queue, msg, protocol",
"group.protocol.type": "consumer"
},
"networking": {
"access": {
"connectionId": "32b6e34b3d91647abb20e7b8",
"name": "string",
"tgwRouteId": "32b6e34b3d91647abb20e7b8",
"type": "PUBLIC"
}
},
"security": {
"brokerPublicCertificate": "string",
"protocol": "string"
},
"type": "Kafka"
}{
"headers": {
"additionalProperty1": "string",
"additionalProperty2": "string"
},
"url": "string",
"type": "Https"
}{
"aws": {
"roleArn": "string",
"testBucket": "string"
},
"type": "AWSLambda"
}{
"aws": {
"roleArn": "string",
"testBucket": "string"
},
"networking": {
"access": {
"connectionId": "32b6e34b3d91647abb20e7b8",
"name": "string",
"tgwRouteId": "32b6e34b3d91647abb20e7b8",
"type": "PUBLIC"
}
},
"type": "S3"
}{
"aws": {
"roleArn": "string",
"testBucket": "string"
},
"networking": {
"access": {
"connectionId": "32b6e34b3d91647abb20e7b8",
"name": "string",
"tgwRouteId": "32b6e34b3d91647abb20e7b8",
"type": "PUBLIC"
}
},
"type": "AWSKinesisDataStreams"
}
响应示例 (200)
抽检 (Sample)
{
"links": [
{
"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"name": "string",
"type": "Sample"
}{
"links": [
{
"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"name": "string",
"type": "Cluster",
"clusterGroupId": "string",
"clusterName": "string",
"dbRoleToExecute": {
"links": [
{
"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"role": "string",
"type": "BUILT_IN"
}
}{
"links": [
{
"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"name": "string",
"type": "Kafka",
"authentication": {
"clientId": "string",
"links": [
{
"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"mechanism": "string",
"method": "string",
"saslOauthbearerExtensions": "string",
"scope": "string",
"sslCertificate": "string",
"tokenEndpointUrl": "string",
"username": "string"
},
"bootstrapServers": "string",
"config": {
"debug": "queue, msg, protocol",
"group.protocol.type": "consumer"
},
"networking": {
"access": {
"connectionId": "32b6e34b3d91647abb20e7b8",
"links": [
{
"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"name": "string",
"tgwRouteId": "32b6e34b3d91647abb20e7b8",
"type": "PUBLIC"
},
"links": [
{
"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
]
},
"security": {
"brokerPublicCertificate": "string",
"links": [
{
"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"protocol": "string"
}
}{
"links": [
{
"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"name": "string",
"type": "Https",
"headers": {
"additionalProperty1": "string",
"additionalProperty2": "string"
},
"url": "string"
}{
"links": [
{
"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"name": "string",
"type": "AWSLambda",
"aws": {
"links": [
{
"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"roleArn": "string",
"testBucket": "string"
}
}{
"links": [
{
"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"name": "string",
"type": "string",
"aws": {
"links": [
{
"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"roleArn": "string",
"testBucket": "string"
},
"networking": {
"access": {
"connectionId": "32b6e34b3d91647abb20e7b8",
"links": [
{
"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"name": "string",
"tgwRouteId": "32b6e34b3d91647abb20e7b8",
"type": "PUBLIC"
},
"links": [
{
"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
]
}
}{
"links": [
{
"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"name": "string",
"type": "AWSKinesisDataStreams",
"aws": {
"links": [
{
"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"roleArn": "string",
"testBucket": "string"
},
"networking": {
"access": {
"connectionId": "32b6e34b3d91647abb20e7b8",
"links": [
{
"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"name": "string",
"tgwRouteId": "32b6e34b3d91647abb20e7b8",
"type": "PUBLIC"
},
"links": [
{
"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
]
}
}
响应示例 (400)
{
"error": 400,
"detail": "(This is just an example, the exception may not be related to this endpoint) No provider AWS exists.",
"reason": "Bad Request",
"errorCode": "VALIDATION_ERROR"
}
响应示例 (401)
{
"error": 401,
"detail": "(This is just an example, the exception may not be related to this endpoint)",
"reason": "Unauthorized",
"errorCode": "NOT_ORG_GROUP_CREATOR"
}
响应示例 (403)
{
"error": 403,
"detail": "(This is just an example, the exception may not be related to this endpoint)",
"reason": "Forbidden",
"errorCode": "CANNOT_CHANGE_GROUP_NAME"
}
响应示例 (404)
{
"error": 404,
"detail": "(This is just an example, the exception may not be related to this endpoint) Cannot find resource AWS",
"reason": "Not Found",
"errorCode": "RESOURCE_NOT_FOUND"
}
响应示例 (409)
{
"error": 401,
"detail": "(This is just an example, the exception may not be related to this endpoint)",
"reason": "Unauthorized",
"errorCode": "NOT_ORG_GROUP_CREATOR"
}
响应示例 (500)
{
"error": 500,
"detail": "(This is just an example, the exception may not be related to this endpoint)",
"reason": "Internal Server Error",
"errorCode": "UNEXPECTED_ERROR"
}