すべての Control Plane の IP アドレスを返す

GET /api/atlas/v2/unauth/controlPlaneIPAddresses

すべてのコントロールプレーンのIPアドレスを返します。

クエリパラメータ

envelope ブール値

アプリケーションがレスポンスを envelope JSON オブジェクトにラップするかどうかを示すフラグ。一部の API クライアントは、HTTP レスポンスヘッダーまたはステータスコードにアクセスできません。これを修正するには、クエリで envelope=true を設定します。結果のリストを返すエンドポイントは、結果オブジェクトをエンベロープとして使用します。アプリケーションは、レスポンス本体にステータスパラメータを追加します。

デフォルト値はfalseです。

応答

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

OK
応答属性の非表示応答属性の表示オブジェクト
- インバウンドオブジェクト
  
  Atlas コントロールプレーンへのインバウンドIPアドレスのリスト（クラウドプロバイダー別に分類されます）。アプリケーションで特定のIPアドレスへのアウトバウンドHTTPリクエストのみが許可されている場合は、 APIリクエストが Atlas コントロールプレーンに到達できるように、次のIPアドレスへのアクセスを許可する必要があります。
  
  インバウンド属性を非表示にするインバウンド属性の表示オブジェクト
  
  Amazon Web Services オブジェクト
  
  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アドレスを識別します。
- アウトバウンドオブジェクト
  
  Atlas コントロールプレーンからのアウトバウンドIPアドレスのリスト（クラウドプロバイダー別に分類されます）。ネットワークで特定のIPアドレスからのインバウンドHTTPリクエストのみが許可されている場合は、Atlas が Webhook および KMS と通信できるように、次のIPアドレスからのアクセスを許可する必要があります。
  
  アウトバウンド属性を非表示にするアウトバウンド属性の表示オブジェクト
  
  Amazon Web Services オブジェクト
  
  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

内部サーバーエラー。
応答属性の非表示応答属性の表示オブジェクト
- validRequestDetail オブジェクト
  
  無効なリクエストの詳細。
  
  validRequestDetail 属性を非表示にする validRequestDetail 属性の表示オブジェクト
  
  フィールド array[オブジェクト]
  
  クライアントリクエストにおけるすべての違反を説明します。
  
  フィールド属性を非表示にするフィールド属性の表示オブジェクト
  
  説明 string 必須
  
  リクエスト要素が禁止されている理由の説明。
  
  フィールド string 必須
  
  リクエスト本文内のフィールドにつながるパス。
- 詳細 string
  
  各タイプのエラーの原因となる特定の条件または理由について説明します。
- エラー integer(int32) 必須
  
  このエラーで返された HTTP ステータスコード。
  
  外部ドキュメント
- errorCode string 必須
  
  このエラーで返されたアプリケーションエラーコード。
- パラメーター array[オブジェクト]
  
  エラーに関する詳細情報を提供するために使用されるパラメーター。
- 理由 string
  
  このエラーで返されたアプリケーションエラーメッセージ。

GET /API/Atlas/v2/unauth/controlPlaneIPAddresses

atlas api root listControlPlaneIpAddresses --help

import (
	"os"
	"context"
	"log"
	sdk "go.mongodb.org/atlas-sdk/v20241023001/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.2024-10-23+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.2024-10-23+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"
}

すべての Control Plane の IP アドレスを返す

クエリ パラメータ

応答

クエリパラメータ