1 つの Private Link 接続を作成する
指定されたプロジェクトに 1 つの Private Link を作成します。このリソースを使用するには、リクエスト元のサービス アカウントまたは API キーに、Project Owner または Project Stream Processing Owner ロールが必要です。
path パラメータ
-
プロジェクトを識別する一意の 24 桁の 16 進数文字列。 認証済みユーザーがアクセスできるすべてのプロジェクトを取得するには、 /groups エンドポイントを使用します。
注: グループとプロジェクトは同義語です。そのため、グループ ID はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースおよび対応するエンドポイントでは、グループという用語が使用されます。
形式は次のパターンと一致する必要があります:
^([a-f0-9]{24})$。
クエリ パラメータ
-
アプリケーションがレスポンスを
envelopeJSON オブジェクトにラップするかどうかを示すフラグ。一部の API クライアントは、HTTP レスポンス ヘッダーまたはステータス コードにアクセスできません。これを修正するには、クエリで envelope=true を設定します。結果のリストを返すエンドポイントは、結果オブジェクトをエンベロープとして使用します。アプリケーションは、レスポンス本体にステータス パラメータを追加します。デフォルト値は
falseです。 -
レスポンス本体を pretty-print 形式にするかどうかを示すフラグ。
デフォルト値は
falseです。Prettyprint
body
必須
プロジェクトに対して 1 つのプライベート リンク接続を作成するための詳細。
-
Amazon リソース名（ARN）。AWS プロバイダーと MSK ベンダーに必要です。
形式は次のパターンと一致する必要があります:
^arn:aws:kafka。 -
Azure Confluent クラスターの各アベイラビリティーゾーンの Azure リソース ID。
-
ドメインのホスト名。次のプロバイダーとベンダーの組み合わせに必要です。
- AWS プロバイダーと CONFLUENT ベンダー。
- AZURE プロバイダーと EVENTHUB または CONFLUENT ベンダー。
-
Confluent クラスターのサブドメイン名。これらは通常、アベイラビリティーゾーンです。AWS プロバイダーと CONFLUENT ベンダーの場合、AWS CONFLUENT クラスターがサブドメインを使用しない場合は、これを空の配列 [] に設定する必要があります。
-
Kafka クラスターが配置されているプロバイダー。有効な値は AWS と AZURE です。
-
AZURE EVENTHUB の場合、これは名前空間エンドポイント ID です。AWS CONFLUENT クラスターの場合、これは VPC エンドポイントサービス名です。
-
クラウド サービスを管理するベンダー。以下はプロバイダーごとのベンダー値です。
Amazon Web Services -- Amazon Web Services MSK Kafkaクラスターの場合は MSK - Amazon Web Services上の Confluent Kafkaクラスターの場合は Confluent - Amazon Web Services Kinesis Data Streams のKinesis （近日サポート予定）。
Azure -- Azure EventHub 用の EEventhub。-- Azure上の Confluent Kafkaクラスターの場合
注意ベンダーフィールドを省略すると、デフォルトでジェネリックベンダーが使用されます。
atlas api streams createGroupStreamPrivateLinkConnection --helpimport (
"os"
"context"
"log"
sdk "go.mongodb.org/atlas-sdk/v20250312001/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.CreateGroupStreamPrivateLinkConnectionApiParams{}
sdkResp, httpResp, err := client.StreamsApi.
CreateGroupStreamPrivateLinkConnectionWithParams(ctx, params).
Execute()
}
curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
--header "Accept: application/vnd.atlas.2025-03-12+json" \
--header "Content-Type: application/json" \
-X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/privateLinkConnections" \
-d '{ <Payload> }'curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
--digest --include \
--header "Accept: application/vnd.atlas.2025-03-12+json" \
--header "Content-Type: application/json" \
-X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/privateLinkConnections" \
-d '{ <Payload> }'{
"arn": "string",
"azureResourceIds": [
"string"
],
"dnsDomain": "string",
"dnsSubDomain": [
"string"
],
"provider": "string",
"region": "string",
"serviceEndpointId": "string",
"vendor": "string"
}{
"_id": "32b6e34b3d91647abb20e7b8",
"arn": "string",
"azureResourceIds": [
"string"
],
"dnsDomain": "string",
"dnsSubDomain": [
"string"
],
"errorMessage": "string",
"interfaceEndpointId": "string",
"interfaceEndpointName": "string",
"links": [
{
"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"provider": "string",
"providerAccountId": "string",
"region": "string",
"serviceEndpointId": "string",
"state": "string",
"vendor": "string"
}{
"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"
}{
"error": 401,
"detail": "(This is just an example, the exception may not be related to this endpoint)",
"reason": "Unauthorized",
"errorCode": "NOT_ORG_GROUP_CREATOR"
}{
"error": 403,
"detail": "(This is just an example, the exception may not be related to this endpoint)",
"reason": "Forbidden",
"errorCode": "CANNOT_CHANGE_GROUP_NAME"
}{
"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"
}{
"error": 401,
"detail": "(This is just an example, the exception may not be related to this endpoint)",
"reason": "Unauthorized",
"errorCode": "NOT_ORG_GROUP_CREATOR"
}{
"error": 500,
"detail": "(This is just an example, the exception may not be related to this endpoint)",
"reason": "Internal Server Error",
"errorCode": "UNEXPECTED_ERROR"
}