모든 제어 영역 IP 주소 반환

얻다 /api/atlas/v2/unauth/controlPlaneIPAddresses

모든 제어 영역 IP 주소를 반환합니다.

쿼리 매개변수

  • envelope 부울

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

    기본값은 false 입니다.

응답

  • 200 application/vnd.atlas.2023-11-15+json

    확인

    응답 속성 숨기기 응답 속성 표시 객체
    • 인바운드 객체

      cloud 제공자 별로 분류된, Atlas 컨트롤 플레인에 대한 인바운드 IP 주소 목록입니다. 애플리케이션 특정 IP 주소로만 아웃바운드 HTTP 요청을 허용하는 경우, API 요청이 Atlas 컨트롤 플레인에 도달할 수 있도록 다음 IP 주소에 대한 액세스 허용해야 합니다.

      인바운드 속성 숨기기 인바운드 속성 표시 객체
      • AWS 객체

        AWS의 컨트롤 플레인 IP 주소. 각 키는 Amazon Web Services (AWS) 리전 식별합니다. 각 값은 AWS 리전 의 컨트롤 플레인 IP 주소를 식별합니다.

        AWS 속성 숨기기 AWS 속성 표시 객체
        • * array[string] additionalProperties

          AWS의 컨트롤 플레인 IP 주소. 각 키는 Amazon Web Services (AWS) 리전 식별합니다. 각 값은 AWS 리전 의 컨트롤 플레인 IP 주소를 식별합니다.

      • Azure 객체

        Azure 의 컨트롤 플레인 IP 주소입니다. 각 키는 Azure 리전 식별합니다. 각 값은 Azure 리전 의 컨트롤 플레인 IP 주소를 식별합니다.

        Azure 속성 숨기기 Azure 속성 표시 객체
        • * array[string] additionalProperties

          Azure 의 컨트롤 플레인 IP 주소입니다. 각 키는 Azure 리전 식별합니다. 각 값은 Azure 리전 의 컨트롤 플레인 IP 주소를 식별합니다.

      • GCP 객체

        GCP 의 컨트롤 플레인 IP 주소입니다. 각 키는 Google Cloud( GCP) 리전 식별합니다. 각 값은 GCP 리전 의 컨트롤 플레인 IP 주소를 식별합니다.

        gcp 속성 숨기기 gcp 속성 표시 객체
        • * array[string] additionalProperties

          GCP 의 컨트롤 플레인 IP 주소입니다. 각 키는 Google Cloud( GCP) 리전 식별합니다. 각 값은 GCP 리전 의 컨트롤 플레인 IP 주소를 식별합니다.

    • 아웃바운드 객체

      cloud 제공자 별로 분류된 Atlas 컨트롤 플레인의 아웃바운드 IP 주소 목록입니다. 네트워크에서 특정 IP 주소로부터의 인바운드 HTTP 요청만 허용하는 경우, Atlas 웹훅 및 KMS 와 통신할 수 있도록 다음 IP 주소로부터 액세스 허용해야 합니다.

      아웃바운드 속성 숨기기 아웃바운드 속성 표시 객체
      • AWS 객체

        AWS의 컨트롤 플레인 IP 주소. 각 키는 Amazon Web Services (AWS) 리전 식별합니다. 각 값은 AWS 리전 의 컨트롤 플레인 IP 주소를 식별합니다.

        AWS 속성 숨기기 AWS 속성 표시 객체
        • * array[string] additionalProperties

          AWS의 컨트롤 플레인 IP 주소. 각 키는 Amazon Web Services (AWS) 리전 식별합니다. 각 값은 AWS 리전 의 컨트롤 플레인 IP 주소를 식별합니다.

      • Azure 객체

        Azure 의 컨트롤 플레인 IP 주소입니다. 각 키는 Azure 리전 식별합니다. 각 값은 Azure 리전 의 컨트롤 플레인 IP 주소를 식별합니다.

        Azure 속성 숨기기 Azure 속성 표시 객체
        • * array[string] additionalProperties

          Azure 의 컨트롤 플레인 IP 주소입니다. 각 키는 Azure 리전 식별합니다. 각 값은 Azure 리전 의 컨트롤 플레인 IP 주소를 식별합니다.

      • GCP 객체

        GCP 의 컨트롤 플레인 IP 주소입니다. 각 키는 Google Cloud( GCP) 리전 식별합니다. 각 값은 GCP 리전 의 컨트롤 플레인 IP 주소를 식별합니다.

        gcp 속성 숨기기 gcp 속성 표시 객체
        • * array[string] additionalProperties

          GCP 의 컨트롤 플레인 IP 주소입니다. 각 키는 Google Cloud( GCP) 리전 식별합니다. 각 값은 GCP 리전 의 컨트롤 플레인 IP 주소를 식별합니다.

  • 500 application/json

    내부 서버 오류입니다.

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

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

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

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

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

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

        • 필드 문자열 필수 사항

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

    • 세부 정보 문자열

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

    • 오류 integer(int32) 필수 사항

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

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

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

    • 매개변수 배열[객체]

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

    • 이유 문자열

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

GET /API/Atlas/v2/unauth/controlPlaneIPAddresses
atlas api root listControlPlaneIpAddresses --help
import (
	"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.ListControlPlaneIpAddressesApiParams{}
	sdkResp, httpResp, err := client.RootApi.
		ListControlPlaneIpAddressesWithParams(ctx, params).
		Execute()
}
curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
  --header "Accept: application/vnd.atlas.2025-03-12+json" \
  -X GET "https://cloud.mongodb.com/api/atlas/v2/unauth/controlPlaneIPAddresses?pretty=true"
curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
  --digest --include \
  --header "Accept: application/vnd.atlas.2025-03-12+json" \
  -X GET "https://cloud.mongodb.com/api/atlas/v2/unauth/controlPlaneIPAddresses?pretty=true"
응답 예시(200)
{
  "inbound": {
    "aws": {
      "additionalProperty1": [
        "string"
      ],
      "additionalProperty2": [
        "string"
      ]
    },
    "azure": {
      "additionalProperty1": [
        "string"
      ],
      "additionalProperty2": [
        "string"
      ]
    },
    "gcp": {
      "additionalProperty1": [
        "string"
      ],
      "additionalProperty2": [
        "string"
      ]
    }
  },
  "outbound": {
    "aws": {
      "additionalProperty1": [
        "string"
      ],
      "additionalProperty2": [
        "string"
      ]
    },
    "azure": {
      "additionalProperty1": [
        "string"
      ],
      "additionalProperty2": [
        "string"
      ]
    },
    "gcp": {
      "additionalProperty1": [
        "string"
      ],
      "additionalProperty2": [
        "string"
      ]
    }
  }
}
응답 예시(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"
}