1 つのグローバルクラスターに 1 つの管理対象名前空間を作成
指定されたグローバルクラスター内に管理対象名前空間を 1 つ作成します。管理された名前空間は、データベース名、ドット区切り、およびコレクション名を使用してコレクションを識別します。このリソースを使用するには、リクエスト元の サービス アカウント または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
必須
指定されたグローバルクラスター内に作成する管理対象名前空間。
-
このグローバルクラスターで管理するコレクションの、人間が判読可能なラベル。
-
コレクションをシャードに分割するために使用されるデータベース パラメーター。グローバルクラスターには複合シャードキーが必要です。この複合シャードキーは、ロケーション パラメーターとユーザーが選択したカスタムキーを組み合わせたものです。
-
このグローバルクラスターで管理する、人間が判読可能なデータベースのラベル。
-
指定されたコレクションのカスタム シャードキーが誰かがハッシュしたかどうかを示すフラグ。 この値を
falseに設定すると、MongoDB Cloud は範囲シャーディングを使用します。デフォルト値は
falseです。ハッシュされたシャードキー -
デフォルト値は
falseです。 -
最大値は
8192です。グローバルクラスターシャーディング -
MongoDB Cloud が、空のコレクションや存在しないコレクションの初期チャンクを作成して配布するかどうかを示すフラグ。MongoDB Cloud は、コレクションに定義されたゾーンとゾーン範囲に基づいてデータを配布します。
デフォルト値は
falseです。ハッシュされたシャードキー
curl \
--request POST 'https://cloud.mongodb.com/api/atlas/v1.0/groups/32b6e34b3d91647abb20e7b8/clusters/{clusterName}/globalWrites/managedNamespaces' \
--header "Authorization: Bearer $ACCESS_TOKEN" \
--header "Content-Type: application/json" \
--data '{"collection":"string","customShardKey":"string","db":"string","isCustomShardKeyHashed":false,"isShardKeyUnique":false,"numInitialChunks":42,"presplitHashedZones":false}'{
"collection": "string",
"customShardKey": "string",
"db": "string",
"isCustomShardKeyHashed": false,
"isShardKeyUnique": false,
"numInitialChunks": 42,
"presplitHashedZones": false
}{
"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": 405,
"detail": "(This is just an example, the exception may not be related to this endpoint)",
"reason": "Method Not Allowed",
"errorCode": "ATLAS_BACKUP_CANCEL_SHARD_RESTORE_JOB_NOT_ALLOWED"
}{
"error": 500,
"detail": "(This is just an example, the exception may not be related to this endpoint)",
"reason": "Internal Server Error",
"errorCode": "UNEXPECTED_ERROR"
}