从一个全球集群中删除所有自定义区域映射。 已弃用

删除 /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/customZoneMapping

删除指定Atlas全球集群的所有自定义区域映射。自定义区域映射将一个 ISO 3166-2位置代码与Atlas全球集群中的区域进行匹配。删除自定义区域映射可恢复默认映射。默认下, MongoDB Cloud 将每个位置代码映射到最近的地理区域。要使用此资源,请求的服务帐户或API密钥必须具有项目所有者角色。

Atlas 全球集群

路径参数

  • groupId 字符串 必需

    用于标识项目的唯一 24-十六进制数字字符串。 使用 /groups 端点检索身份验证的用户有权访问权限的所有项目。

    注意:群组和项目是同义词。您的群组 ID 与项目 ID 相同。对于现有群组,群组/项目 ID 保持不变。资源和相应的端点使用“群组”一词。

    格式应符合以下模式:^([a-f0-9]{24})$

  • 集群名称 字符串 必需

    用于标识此集群的人类可读标签。

    格式应符合以下模式:^[a-zA-Z0-9][a-zA-Z0-9-]*$

查询参数

  • envelope 布尔

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

    默认值为false

  • pretty 布尔

    指示响应正文是否应采用 prettyprint 格式的标记。

    默认值为false

    Prettyprint

响应

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

    正常

    隐藏响应属性 显示响应属性 对象
    • customZoneMapping 对象

      包含以逗号分隔的键值对的列表,用于将区域映射到地理区域。这些对将 ISO 3166-1a2位置代码(尽可能包含 ISO 3166-2 细分代码)映射到标识自定义区域的唯一 24-十六进制字符串。

      24-十六进制字符串对应于 Replication Specifications id属性。

      如果不存在自定义区域,则此参数会返回空对象。

      隐藏 customZoneMapping 属性 显示 customZoneMapping 属性 对象
      • * 字符串 additionalProperties

        包含以逗号分隔的键值对的列表,用于将区域映射到地理区域。这些对将 ISO 3166-1a2位置代码(尽可能包含 ISO 3166-2 细分代码)映射到标识自定义区域的唯一 24-十六进制字符串。

        24-十六进制字符串对应于 Replication Specifications id属性。

        如果不存在自定义区域,则此参数会返回空对象。

        格式应符合以下模式:^([a-f0-9]{24})$

    • ManagedNamespaces 大量[对象]

      包含全局集群命名空间的列表。 MongoDB Cloud 管理此集群。

      隐藏 ManagedNamespaces 属性 显示 ManagedNamespaces 属性 对象
      • 集合 字符串 必需

        用于管理此全局集群中的集合的人工可读标签。

      • customShardKey 字符串 必需

        用于将集合划分为分片的数据库参数。全局集群需要复合分片键。此复合分片键将位置参数和用户选择的自定义键组合在一起。

      • db 字符串 必需

        用于管理此全局集群的数据库的人工可读标签。

      • isCustomShardKeyHashed 布尔

        指示是否有人对指定collection的自定义分片键进行哈希处理的标志。如果将此值设置为false ,MongoDB Cloud 将使用范围分片。

        默认值为false

        哈希分片键
      • isShardKeyUnique 布尔

        指示是否有人对自定义分片键哈希哈希处理的标志。如果此参数返回false ,则该集群使用范围分片。

        默认值为false

      • numInitialChunks integer(int64)

        使用哈希分片键对集合分片,最初创建的最小数据段数。

        最大值为 8192

        全球集群分片
      • presplitHashedZones 布尔

        该标志指示 MongoDB Cloud 是否应为空或不存在的集合创建和分配初始数据段。MongoDB Cloud 根据集合的定义区域和区域范围来分发数据。

        默认值为false

        哈希片键
    • selfManagedSharding 布尔

      控制全局集群在哪种管理模式下运行的布尔值。如果此参数为 true,则启用自管理分片,并且用户可以控制全局集群中的区域分片。如果此参数为 false,则启用 Atlas 托管分片,并且Atlas控制全球集群内的区域分片。

  • 401 application/json

    未经授权。

    隐藏响应属性 显示响应属性 对象
    • badRequestDetail 对象

      错误请求详情。

      隐藏 BadRequestDetail 属性 显示 BadRequestDetail 属性 对象
      • 字段 大量[对象]

        描述客户端请求中的所有违规行为。

        隐藏字段属性 显示字段属性 对象
        • 描述 字符串 必需

          关于请求元素错误的原因的描述。

        • 字段 字符串 必需

          指向请求正文中字段的路径。

    • 详细信息 字符串

      描述导致每种错误类型的具体条件或原因。

    • 错误 integer(int32) 必需

      与此错误一起返回的 HTTP 状态代码。

      外部文档
    • 错误代码 字符串 必需

      返回此错误时附带应用程序错误代码。

    • 参数 大量[对象]

      用于提供更多错误信息的参数。

    • 原因 字符串

      随此错误返回的应用程序错误消息。

  • 403 application/json

    Forbidden.

    隐藏响应属性 显示响应属性 对象
    • badRequestDetail 对象

      错误请求详情。

      隐藏 BadRequestDetail 属性 显示 BadRequestDetail 属性 对象
      • 字段 大量[对象]

        描述客户端请求中的所有违规行为。

        隐藏字段属性 显示字段属性 对象
        • 描述 字符串 必需

          关于请求元素错误的原因的描述。

        • 字段 字符串 必需

          指向请求正文中字段的路径。

    • 详细信息 字符串

      描述导致每种错误类型的具体条件或原因。

    • 错误 integer(int32) 必需

      与此错误一起返回的 HTTP 状态代码。

      外部文档
    • 错误代码 字符串 必需

      返回此错误时附带应用程序错误代码。

    • 参数 大量[对象]

      用于提供更多错误信息的参数。

    • 原因 字符串

      随此错误返回的应用程序错误消息。

  • 404 application/json

    未找到。

    隐藏响应属性 显示响应属性 对象
    • badRequestDetail 对象

      错误请求详情。

      隐藏 BadRequestDetail 属性 显示 BadRequestDetail 属性 对象
      • 字段 大量[对象]

        描述客户端请求中的所有违规行为。

        隐藏字段属性 显示字段属性 对象
        • 描述 字符串 必需

          关于请求元素错误的原因的描述。

        • 字段 字符串 必需

          指向请求正文中字段的路径。

    • 详细信息 字符串

      描述导致每种错误类型的具体条件或原因。

    • 错误 integer(int32) 必需

      与此错误一起返回的 HTTP 状态代码。

      外部文档
    • 错误代码 字符串 必需

      返回此错误时附带应用程序错误代码。

    • 参数 大量[对象]

      用于提供更多错误信息的参数。

    • 原因 字符串

      随此错误返回的应用程序错误消息。

  • 500 application/json

    内部服务器错误。

    隐藏响应属性 显示响应属性 对象
    • badRequestDetail 对象

      错误请求详情。

      隐藏 BadRequestDetail 属性 显示 BadRequestDetail 属性 对象
      • 字段 大量[对象]

        描述客户端请求中的所有违规行为。

        隐藏字段属性 显示字段属性 对象
        • 描述 字符串 必需

          关于请求元素错误的原因的描述。

        • 字段 字符串 必需

          指向请求正文中字段的路径。

    • 详细信息 字符串

      描述导致每种错误类型的具体条件或原因。

    • 错误 integer(int32) 必需

      与此错误一起返回的 HTTP 状态代码。

      外部文档
    • 错误代码 字符串 必需

      返回此错误时附带应用程序错误代码。

    • 参数 大量[对象]

      用于提供更多错误信息的参数。

    • 原因 字符串

      随此错误返回的应用程序错误消息。

DELETE /api/atlas/v2 /groups/{groupId}/clusters/{clusterName}/globalWrites/customZoneMapping
atlas api globalClusters deleteGroupClusterGlobalWriteCustomZoneMapping --help
import (
	"os"
	"context"
	"log"
	sdk "go.mongodb.org/atlas-sdk/v20230101001/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.DeleteGroupClusterGlobalWriteCustomZoneMappingApiParams{}
	httpResp, err := client.GlobalClustersApi.
		DeleteGroupClusterGlobalWriteCustomZoneMappingWithParams(ctx, params).
		Execute()
}
curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
  --header "Accept: application/vnd.atlas.2023-01-01+json" \
  -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/customZoneMapping"
curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
  --digest --include \
  --header "Accept: application/vnd.atlas.2023-01-01+json" \
  -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/customZoneMapping"
响应示例 (200)
{
  "customZoneMapping": {
    "additionalProperty1": "32b6e34b3d91647abb20e7b8",
    "additionalProperty2": "32b6e34b3d91647abb20e7b8"
  },
  "managedNamespaces": [
    {
      "collection": "string",
      "customShardKey": "string",
      "db": "string",
      "isCustomShardKeyHashed": false,
      "isShardKeyUnique": false,
      "numInitialChunks": 42,
      "presplitHashedZones": false
    }
  ],
  "selfManagedSharding": true
}
响应示例 (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"
}