PrivateLink 연결 1개 반환

얻다 /api/atlas/v2/groups/{groupId}/streams/privateLinkConnections/{connectionId}

프로젝트 내 비공개 링크 연결 한 개에 대한 세부 정보를 반환합니다. 이 리소스를 사용하려면, 요청하는 서비스 계정 또는 API 키에 프로젝트 읽기 전용 역할이 있어야 합니다.

경로 매개변수

  • groupId 문자열 필수 사항

    프로젝트 식별하는 고유한 24-16진수 문자열입니다. 인증된 사용자가 액세스 할 수 있는 모든 프로젝트를 조회 하려면 /groups 엔드포인트를 사용합니다.

    참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.

    형식은 ^([a-f0-9]{24})$ 패턴 과 일치해야 합니다.

  • connectionId 문자열 필수 사항

    Private Link 연결을 식별하는 고유 ID입니다.

쿼리 매개변수

  • envelope 부울

    애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

    기본값은 false 입니다.

응답

  • 200 application/vnd.atlas.2023-02-01+json

    확인

    응답 속성 숨기기 응답 속성 표시 객체
    • _id 문자열

      Private Link 연결의 ID입니다.

      형식은 ^([a-f0-9]{24})$ 패턴 과 일치해야 합니다.

    • ARN 문자열

      Amazon 리소스 이름(ARN)입니다. AWS 제공자 및 MSK 벤더에 필요합니다.

      형식은 ^arn:aws:kafka 패턴 과 일치해야 합니다.

    • azureResourceIds array[string]

      Azure Confluent 클러스터의 각 Azure 가용영역에 대한 Azure 리소스 ID입니다.

    • dnsDomain 문자열

      도메인 호스트 이름입니다. 다음 제공자 및 벤더 조합이 필요합니다.

      • CONFLUENT 벤더가 있는 AWS 제공자입니다.
      • AZURE 제공자와 EVENTHUB 또는 CONFLUENT 벤더입니다.
    • dnsSubDomain array[string]

      Confluent 클러스터의 하위 도메인 이름입니다. 일반적으로 이러한 영역이 가용영역입니다. AWS 제공자 및 CONFLUENT 벤더에 필요하며, AWS CONFLUENT 클러스터가 하위 도메인을 사용하지 않는 경우 빈 배열 []로 설정해야 합니다.

    • 오류 메시지 문자열

      상태 FAILED인 경우 오류 메시지입니다.

    • InterfaceEndpointId 문자열

      제공된 서비스 엔드포인트 ID로부터 생성된 인터페이스 엔드포인트 ID입니다.

    • 인터페이스 엔드포인트 이름 문자열

      제공된 서비스 엔드포인트 ID 에서 생성된 인터페이스 엔드포인트 이름입니다.

    • provider 문자열 필수 사항

      Kafka 클러스터가 배포된 제공자입니다. 유효한 값은 AWS와 AZURE입니다.

    • providerAccountId 문자열

      cloud 제공자 의 계정 ID .

    • 리전 문자열

      제공자의 클러스터 리전입니다. AZUREAWS 지원 리전을 참조하세요.

    • serviceEndpointId 문자열

      AZURE EVENTHUB의 경우 네임스페이스 엔드포인트 ID입니다. AWS CONFLUENT 클러스터의 경우, 이것은 VPC 엔드포인트 서비스 이름입니다.

    • 상태 문자열

      연결이 있는 상태입니다.

    • vendor 문자열

      클라우드 서비스를 관리하는 벤더입니다. 다음은 각 제공자별 벤더 값입니다.

      • Amazon Web Services -- Amazon Web Services MSK Kafka cluster용 MSK -- Amazon Web Services 의 Confluent Kafka cluster용 CONFLUENT -- Amazon Web Services Kinesis Data Streams용 Kinesis (출시 예정)

      • Azure -- Azure EventHub용 EVENThub. -- Azure 의 Confluent Kafka cluster를 위한 CONFLUENT

      참고 벤더 필드 생략하면 기본값 일반 벤더 사용됩니다.

  • 401 application/json

    승인되지 않았습니다.

    응답 속성 숨기기 응답 속성 표시 객체
    • badRequestDetail 객체

      요청 세부 정보가 잘못되었습니다.

      badRequestDetail 속성 숨기기 badRequestDetail 속성 표시 객체
      • 필드 배열[객체]

        클라이언트 요청 의 모든 위반 사항을 설명합니다.

        필드 속성 숨기기 필드 속성 표시 객체
        • description 문자열 필수 사항

          요청 요소가 잘못된 이유에 대한 설명입니다.

        • 필드 문자열 필수 사항

          요청 본문의 필드 로 연결되는 경로입니다.

    • 세부 정보 문자열

      각 오류 유형을 유발하는 특정 조건 또는 이유를 설명합니다.

    • 오류 integer(int32) 필수 사항

      이 오류와 함께 HTTP 상태 코드가 반환되었습니다.

      외부 문서
    • 오류 코드 문자열 필수 사항

      이 오류와 함께 반환된 애플리케이션 오류 코드입니다.

    • 매개변수 배열[객체]

      오류에 대한 자세한 정보를 제공하는 데 사용된 매개변수입니다.

    • 이유 문자열

      이 오류와 함께 반환된 애플리케이션 오류 메시지입니다.

  • 403 application/json

    Forbidden.

    응답 속성 숨기기 응답 속성 표시 객체
    • badRequestDetail 객체

      요청 세부 정보가 잘못되었습니다.

      badRequestDetail 속성 숨기기 badRequestDetail 속성 표시 객체
      • 필드 배열[객체]

        클라이언트 요청 의 모든 위반 사항을 설명합니다.

        필드 속성 숨기기 필드 속성 표시 객체
        • description 문자열 필수 사항

          요청 요소가 잘못된 이유에 대한 설명입니다.

        • 필드 문자열 필수 사항

          요청 본문의 필드 로 연결되는 경로입니다.

    • 세부 정보 문자열

      각 오류 유형을 유발하는 특정 조건 또는 이유를 설명합니다.

    • 오류 integer(int32) 필수 사항

      이 오류와 함께 HTTP 상태 코드가 반환되었습니다.

      외부 문서
    • 오류 코드 문자열 필수 사항

      이 오류와 함께 반환된 애플리케이션 오류 코드입니다.

    • 매개변수 배열[객체]

      오류에 대한 자세한 정보를 제공하는 데 사용된 매개변수입니다.

    • 이유 문자열

      이 오류와 함께 반환된 애플리케이션 오류 메시지입니다.

  • 404 application/json

    찾을 수 없습니다.

    응답 속성 숨기기 응답 속성 표시 객체
    • badRequestDetail 객체

      요청 세부 정보가 잘못되었습니다.

      badRequestDetail 속성 숨기기 badRequestDetail 속성 표시 객체
      • 필드 배열[객체]

        클라이언트 요청 의 모든 위반 사항을 설명합니다.

        필드 속성 숨기기 필드 속성 표시 객체
        • description 문자열 필수 사항

          요청 요소가 잘못된 이유에 대한 설명입니다.

        • 필드 문자열 필수 사항

          요청 본문의 필드 로 연결되는 경로입니다.

    • 세부 정보 문자열

      각 오류 유형을 유발하는 특정 조건 또는 이유를 설명합니다.

    • 오류 integer(int32) 필수 사항

      이 오류와 함께 HTTP 상태 코드가 반환되었습니다.

      외부 문서
    • 오류 코드 문자열 필수 사항

      이 오류와 함께 반환된 애플리케이션 오류 코드입니다.

    • 매개변수 배열[객체]

      오류에 대한 자세한 정보를 제공하는 데 사용된 매개변수입니다.

    • 이유 문자열

      이 오류와 함께 반환된 애플리케이션 오류 메시지입니다.

  • 500 application/json

    내부 서버 오류입니다.

    응답 속성 숨기기 응답 속성 표시 객체
    • badRequestDetail 객체

      요청 세부 정보가 잘못되었습니다.

      badRequestDetail 속성 숨기기 badRequestDetail 속성 표시 객체
      • 필드 배열[객체]

        클라이언트 요청 의 모든 위반 사항을 설명합니다.

        필드 속성 숨기기 필드 속성 표시 객체
        • description 문자열 필수 사항

          요청 요소가 잘못된 이유에 대한 설명입니다.

        • 필드 문자열 필수 사항

          요청 본문의 필드 로 연결되는 경로입니다.

    • 세부 정보 문자열

      각 오류 유형을 유발하는 특정 조건 또는 이유를 설명합니다.

    • 오류 integer(int32) 필수 사항

      이 오류와 함께 HTTP 상태 코드가 반환되었습니다.

      외부 문서
    • 오류 코드 문자열 필수 사항

      이 오류와 함께 반환된 애플리케이션 오류 코드입니다.

    • 매개변수 배열[객체]

      오류에 대한 자세한 정보를 제공하는 데 사용된 매개변수입니다.

    • 이유 문자열

      이 오류와 함께 반환된 애플리케이션 오류 메시지입니다.

GET /api/atlas/v2/groups/{groupId}/streams/privateLinkConnections/{connectionId}
atlas api streams getGroupStreamPrivateLinkConnection --help
import (
	"os"
	"context"
	"log"
	sdk "go.mongodb.org/atlas-sdk/v20231001001/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.GetGroupStreamPrivateLinkConnectionApiParams{}
	sdkResp, httpResp, err := client.StreamsApi.
		GetGroupStreamPrivateLinkConnectionWithParams(ctx, params).
		Execute()
}
curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
  --header "Accept: application/vnd.atlas.2023-10-01+json" \
  -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/privateLinkConnections/{connectionId}?pretty=true"
curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
  --digest --include \
  --header "Accept: application/vnd.atlas.2023-10-01+json" \
  -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/privateLinkConnections/{connectionId}?pretty=true"
응답 예시(200)
{
  "_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"
}
응답 예시(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"
}
응답 예시(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"
}