返回所有控制平面 IP 地址

获取 /api/atlas/v2/unauth/controlPlaneIPAddresses

返回所有控制平面 IP 地址。

查询参数

envelope 布尔

指示应用程序是否将响应包装在envelope JSON 对象中的标志。某些 API 客户端无法访问 HTTP 响应标头或状态代码。要修复此问题，请在查询中设置 Envelope=true。返回结果列表的端点将结果对象用作 envelope。应用程序将状态参数添加到响应正文中。

默认值为false 。

响应

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

正常
隐藏响应属性显示响应属性对象
- 入站对象
  
  Atlas控制平面的入站IP地址列表，按云提供商分类。如果您的应用程序仅允许向特定IP地址发出出站HTTP请求，则必须允许访问权限以下IP地址，以便您的API请求可以到达Atlas控制平面。
  
  隐藏入站属性显示入站属性对象
  
  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地址。
- 出站对象
  
  Atlas控制平面的出站IP地址列表，按云提供商分类。如果您的网络仅允许来自特定IP地址的入站HTTP请求，则必须允许来自以下IP地址的访问权限，以便Atlas可以与您的 webhook 和KMS通信。
  
  隐藏出站属性显示出站属性对象
  
  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 属性对象
  
  字段大量[对象]
  
  描述客户端请求中的所有违规行为。
  
  隐藏字段属性显示字段属性对象
  
  描述字符串必需
  
  关于请求元素错误的原因的描述。
  
  字段字符串必需
  
  指向请求正文中字段的路径。
- 详细信息字符串
  
  描述导致每种错误类型的具体条件或原因。
- 错误 integer(int32) 必需
  
  与此错误一起返回的 HTTP 状态代码。
  
  外部文档
- 错误代码字符串必需
  
  返回此错误时附带应用程序错误代码。
- 参数大量[对象]
  
  用于提供更多错误信息的参数。
- 原因字符串
  
  随此错误返回的应用程序错误消息。

GET /API/Atlas/v2/unauth/controlPlaneIPAddresses

atlas api root listControlPlaneIpAddresses --help

import (
	"os"
	"context"
	"log"
	sdk "go.mongodb.org/atlas-sdk/v20241113001/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-11-13+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-11-13+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"
}