1 つのグローバルクラスターにカスタム ゾーン マッピングを追加
指定されたグローバルクラスターに 1 つ以上のカスタムゾーンマッピングを追加します。カスタムゾーンマッピングは、1 つの ISO 3166-2 ロケーション コードをグローバルクラスター内のゾーンに一致させます。デフォルトでは 、 MongoDB Cloud は各ロケーション コードを最も近い 地理的ゾーンにマッピングします。このリソースを使用するには、リクエスト元のサービスアカウントまたはAPIキーにプロジェクト オーナーのロールが必要です。
path パラメータ
-
プロジェクトを識別する一意の 24 桁の 16 進数文字列。 認証済みユーザーがアクセスできるすべてのプロジェクトを取得するには、 /groups エンドポイントを使用します。
注: グループとプロジェクトは同義語です。そのため、グループ ID はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースおよび対応するエンドポイントでは、グループという用語が使用されます。
形式は次のパターンと一致する必要があります:
^([a-f0-9]{24})$。 -
このクラスターを識別する、人間が判読できるラベル。
形式は次のパターンと一致する必要があります:
^[a-zA-Z0-9][a-zA-Z0-9-]*$。
クエリ パラメータ
-
アプリケーションがレスポンスを
envelopeJSON オブジェクトにラップするかどうかを示すフラグ。一部の API クライアントは、HTTP レスポンス ヘッダーまたはステータス コードにアクセスできません。これを修正するには、クエリで envelope=true を設定します。結果のリストを返すエンドポイントは、結果オブジェクトをエンベロープとして使用します。アプリケーションは、レスポンス本体にステータス パラメータを追加します。デフォルト値は
falseです。 -
レスポンス本体を pretty-print 形式にするかどうかを示すフラグ。
デフォルト値は
falseです。Prettyprint
body
必須
指定されたグローバルクラスターに追加するカスタム ゾーン マッピング。
-
ゾーンを地理的リージョンにマッピングするための、カンマ区切りのキーと値のペアが格納されたリスト。これらのペアは、ISO 3166-1a2 ロケーション コードと、可能な場合は ISO 3166-2 下位分類コードを、人間が判読可能な目的のカスタム ゾーンのラベルにマッピングします。MongoDB Cloud は、デフォルトで ISO 3166-1a2 コードを最も近い地理的ゾーンにマッピングします。デフォルトのマッピングを変更するには、このパラメーターを含めます。
カスタム ゾーンが存在しない場合は、このパラメーターは空のオブジェクトを返します。
グローバルクラスターのサブセットを識別する、人間が判読できるラベル。
curl \
--request POST 'https://cloud.mongodb.com/api/atlas/v1.0/groups/32b6e34b3d91647abb20e7b8/clusters/{clusterName}/globalWrites/customZoneMapping' \
--header "Authorization: Bearer $ACCESS_TOKEN" \
--header "Content-Type: application/json" \
--data '{"customZoneMappings":[{"location":"string","zone":"string"}]}'{
"customZoneMappings": [
{
"location": "string",
"zone": "string"
}
]
}{
"customZoneMapping": {
"additionalProperty1": "32b6e34b3d91647abb20e7b8",
"additionalProperty2": "32b6e34b3d91647abb20e7b8"
},
"managedNamespaces": [
{
"collection": "string",
"customShardKey": "string",
"db": "string",
"isCustomShardKeyHashed": false,
"isShardKeyUnique": false,
"numInitialChunks": 42,
"presplitHashedZones": false
}
],
"selfManagedSharding": true
}{
"error": 400,
"detail": "(This is just an example, the exception may not be related to this endpoint) No provider AWS exists.",
"reason": "Bad Request",
"errorCode": "VALIDATION_ERROR"
}{
"error": 401,
"detail": "(This is just an example, the exception may not be related to this endpoint)",
"reason": "Unauthorized",
"errorCode": "NOT_ORG_GROUP_CREATOR"
}{
"error": 403,
"detail": "(This is just an example, the exception may not be related to this endpoint)",
"reason": "Forbidden",
"errorCode": "CANNOT_CHANGE_GROUP_NAME"
}{
"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"
}{
"error": 500,
"detail": "(This is just an example, the exception may not be related to this endpoint)",
"reason": "Internal Server Error",
"errorCode": "UNEXPECTED_ERROR"
}