1 つのグローバルクラスターからすべてのカスタム ゾーン マッピングを削除

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

指定されたグローバルクラスターのすべてのカスタム ゾーン マッピングを削除します。カスタム ゾーン マッピングは、1 つの ISO 3166-2 ロケーション コードをグローバルクラスター内のゾーンに一致させます。カスタム ゾーン マッピングを削除すると、デフォルトのマッピングが復元されます。デフォルトでは、MongoDB Cloud は各ロケーション コードを最も近い地理的ゾーンにマッピングします。このリソースを使用するには、リクエスト元のサービス アカウントまたは API キーにプロジェクト オーナー ロールが必要です。非推奨バージョン: v2-{2023-02-01}、v2-{2023-01-01}

グローバルクラスター

path パラメータ

  • グループ ID string 必須

    プロジェクトを識別する一意の 24 桁の 16 進数文字列。 認証済みユーザーがアクセスできるすべてのプロジェクトを取得するには、 /groups エンドポイントを使用します。

    : グループとプロジェクトは同義語です。そのため、グループ ID はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースおよび対応するエンドポイントでは、グループという用語が使用されます。

    形式は次のパターンと一致する必要があります: ^([a-f0-9]{24})$

  • clusterName string 必須

    このクラスターを識別する、人間が判読できるラベル。

    形式は次のパターンと一致する必要があります: ^[a-zA-Z0-9][a-zA-Z0-9-]*$

クエリ パラメータ

  • envelope ブール値

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

    デフォルト値はfalseです。

  • pretty ブール値

    レスポンス本体を pretty-print 形式にするかどうかを示すフラグ。

    デフォルト値はfalseです。

    Prettyprint

応答

  • 200 application/vnd.atlas.2024-08-05+json

    OK

    応答属性の非表示 応答属性の表示 オブジェクト
    • customZoneMapping オブジェクト

      ゾーンを地理的リージョンにマッピングするためのコンマ区切りのキーと値のペアが格納されたリスト。これらのペアは、ISO 3166-1a2 ロケーション コードと、可能な場合は ISO 3166-2 下位分類コードを、カスタムゾーンを識別する一意の 24- 16進数文字列にマッピングします。

      24- 16進数文字列 は、 Replication Specifications zoneIdプロパティに対応します。

      カスタム ゾーンが存在しない場合は、このパラメーターは空のオブジェクトを返します。

      customZoneMapping 属性を非表示にする customZoneMapping 属性の表示 オブジェクト
      • * string additionalProperties

        ゾーンを地理的リージョンにマッピングするためのコンマ区切りのキーと値のペアが格納されたリスト。これらのペアは、ISO 3166-1a2 ロケーション コードと、可能な場合は ISO 3166-2 下位分類コードを、カスタムゾーンを識別する一意の 24- 16進数文字列にマッピングします。

        24- 16進数文字列 は、 Replication Specifications zoneIdプロパティに対応します。

        カスタム ゾーンが存在しない場合は、このパラメーターは空のオブジェクトを返します。

        形式は次のパターンと一致する必要があります: ^([a-f0-9]{24})$

    • ManagedNamespaces array[オブジェクト]

      グローバルクラスターの名前空間が格納されたリスト。 MongoDB Cloud がこのクラスターを管理します。

      ManagedNamespaces 属性を非表示にする ManagedNamespaces 属性の表示 オブジェクト
      • コレクション string 必須

        このグローバルクラスターで管理するコレクションの、人間が判読可能なラベル。

      • customShardKey string 必須

        コレクションをシャードに分割するために使用されるデータベース パラメーター。グローバルクラスターには複合シャードキーが必要です。この複合シャードキーは、ロケーション パラメーターとユーザーが選択したカスタムキーを組み合わせたものです。

      • db string 必須

        このグローバルクラスターで管理する、人間が判読可能なデータベースのラベル。

      • isCustomShardKeyHashed ブール値

        指定されたコレクションのカスタム シャードキーが誰かがハッシュしたかどうかを示すフラグ。 この値をfalseに設定すると、MongoDB Cloud は範囲シャーディングを使用します。

        デフォルト値はfalseです。

        ハッシュされたシャードキー
      • isShardKeyUnique ブール値

        誰かがカスタムシャードキーをハッシュしたかどうかを示すフラグ。このパラメーターがfalse を返す場合、このクラスターは 範囲シャーディングを使用します。

        デフォルト値はfalseです。

      • numInitialChunks integer(int64)

        空のコレクションをハッシュされたシャードキーでシャーディングときに最初に作成するチャンクの最小数。

        最大値は 8192 です。

        グローバルクラスターシャーディング
      • presplitHashedZones ブール値

        MongoDB Cloud が、空のコレクションや存在しないコレクションの初期チャンクを作成して配布するかどうかを示すフラグ。MongoDB Cloud は、コレクションに定義されたゾーンとゾーン範囲に基づいてデータを配布します。

        デフォルト値はfalseです。

        ハッシュされたシャードキー
    • 自己管理型シャーディング ブール値

      グローバルクラスターがどのマネジメントモードで動作しているかを制御するブール値。このパラメータが true の場合、自己管理型シャーディングが有効になり、ユーザーはグローバルクラスター内のゾーンシャーディングを制御できます。このパラメータが false の場合、Atlas マネージド シャーディングが有効になり、Atlas がグローバルクラスター内のゾーンシャーディングを制御します。

  • 401 application/ JSON

    許可されていません。

    応答属性の非表示 応答属性の表示 オブジェクト
    • validRequestDetail オブジェクト

      無効なリクエストの詳細。

      validRequestDetail 属性を非表示にする validRequestDetail 属性の表示 オブジェクト
      • フィールド array[オブジェクト]

        クライアントリクエストにおけるすべての違反を説明します。

        フィールド属性を非表示にする フィールド属性の表示 オブジェクト
        • 説明 string 必須

          リクエスト要素が禁止されている理由の説明。

        • フィールド string 必須

          リクエスト本文内のフィールドにつながるパス。

    • 詳細 string

      各タイプのエラーの原因となる特定の条件または理由について説明します。

    • エラー integer(int32) 必須

      このエラーで返された HTTP ステータス コード。

      外部ドキュメント
    • errorCode string 必須

      このエラーで返されたアプリケーション エラー コード。

    • パラメーター array[オブジェクト]

      エラーに関する詳細情報を提供するために使用されるパラメーター。

    • 理由 string

      このエラーで返されたアプリケーション エラー メッセージ。

  • 403 application/ JSON

    Forbidden.

    応答属性の非表示 応答属性の表示 オブジェクト
    • validRequestDetail オブジェクト

      無効なリクエストの詳細。

      validRequestDetail 属性を非表示にする validRequestDetail 属性の表示 オブジェクト
      • フィールド array[オブジェクト]

        クライアントリクエストにおけるすべての違反を説明します。

        フィールド属性を非表示にする フィールド属性の表示 オブジェクト
        • 説明 string 必須

          リクエスト要素が禁止されている理由の説明。

        • フィールド string 必須

          リクエスト本文内のフィールドにつながるパス。

    • 詳細 string

      各タイプのエラーの原因となる特定の条件または理由について説明します。

    • エラー integer(int32) 必須

      このエラーで返された HTTP ステータス コード。

      外部ドキュメント
    • errorCode string 必須

      このエラーで返されたアプリケーション エラー コード。

    • パラメーター array[オブジェクト]

      エラーに関する詳細情報を提供するために使用されるパラメーター。

    • 理由 string

      このエラーで返されたアプリケーション エラー メッセージ。

  • 404 application/ JSON

    見つかりません。

    応答属性の非表示 応答属性の表示 オブジェクト
    • validRequestDetail オブジェクト

      無効なリクエストの詳細。

      validRequestDetail 属性を非表示にする validRequestDetail 属性の表示 オブジェクト
      • フィールド array[オブジェクト]

        クライアントリクエストにおけるすべての違反を説明します。

        フィールド属性を非表示にする フィールド属性の表示 オブジェクト
        • 説明 string 必須

          リクエスト要素が禁止されている理由の説明。

        • フィールド string 必須

          リクエスト本文内のフィールドにつながるパス。

    • 詳細 string

      各タイプのエラーの原因となる特定の条件または理由について説明します。

    • エラー integer(int32) 必須

      このエラーで返された HTTP ステータス コード。

      外部ドキュメント
    • errorCode string 必須

      このエラーで返されたアプリケーション エラー コード。

    • パラメーター array[オブジェクト]

      エラーに関する詳細情報を提供するために使用されるパラメーター。

    • 理由 string

      このエラーで返されたアプリケーション エラー メッセージ。

  • 500 application/ JSON

    内部サーバーエラー。

    応答属性の非表示 応答属性の表示 オブジェクト
    • validRequestDetail オブジェクト

      無効なリクエストの詳細。

      validRequestDetail 属性を非表示にする validRequestDetail 属性の表示 オブジェクト
      • フィールド array[オブジェクト]

        クライアントリクエストにおけるすべての違反を説明します。

        フィールド属性を非表示にする フィールド属性の表示 オブジェクト
        • 説明 string 必須

          リクエスト要素が禁止されている理由の説明。

        • フィールド string 必須

          リクエスト本文内のフィールドにつながるパス。

    • 詳細 string

      各タイプのエラーの原因となる特定の条件または理由について説明します。

    • エラー integer(int32) 必須

      このエラーで返された HTTP ステータス コード。

      外部ドキュメント
    • errorCode string 必須

      このエラーで返されたアプリケーション エラー コード。

    • パラメーター array[オブジェクト]

      エラーに関する詳細情報を提供するために使用されるパラメーター。

    • 理由 string

      このエラーで返されたアプリケーション エラー メッセージ。

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/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.DeleteGroupClusterGlobalWriteCustomZoneMappingApiParams{}
	httpResp, err := client.GlobalClustersApi.
		DeleteGroupClusterGlobalWriteCustomZoneMappingWithParams(ctx, params).
		Execute()
}
curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
  --header "Accept: application/vnd.atlas.2024-10-23+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.2024-10-23+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"
}