1 つのシャードへの配置リージョンの割り当て

項目一覧

Resource

Request Parameters
リクエストパスパラメーター
リクエストクエリパラメータ
リクエストボディパラメータ
応答
リクエストの例
応答例
応答ヘッダー
レスポンス本体

注意

グループとプロジェクトは同義語です。あなたの {PROJECT-ID}はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。このページでは、説明を参照するときに、より一般的な用語のグループを使用します。エンドポイントはドキュメントに記載されているままです。

ベース URL: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0

Resource

PATCH /groups/{PROJECT-ID}/backupConfigs/{CLUSTER-ID}

Request Parameters

リクエストパスパラメーター

Parameter	タイプ	必要性	説明
プロジェクトID	string	必須	検索対象のバックアップ構成を持つクラスターを保持するプロジェクトを識別する、一意な 24 桁の 16 進数のstring 。
CLUSTER-ID	string	必須	検索対象のバックアップ構成を持つクラスターを識別する、一意な 24 桁の 16 進数string 。

リクエストクエリパラメータ

次のクエリパラメータは任意です。

名前

タイプ

必要性

説明

default

pretty

ブール値

任意

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

false

envelope

ブール値

任意

応答をエンベロープでラップするかどうかを示すフラグ。

一部の APIクライアントは、 HTTPレスポンスヘッダーまたはステータスコードにアクセスできません。これを修正するには、クエリでenvelope=trueを設定します。

1 つの結果を返すエンドポイントの場合、レスポンス本体には次のものが含まれます。

名前	説明
`status`	HTTPレスポンスコード
`content`	期待される応答本体

false

リクエストボディパラメータ

名前	タイプ	必要性	説明
`deploymentConfigs`	オブジェクトの配列	必須	配置リージョンを割り当てるクラスターノードの仕様オブジェクト。
`deploymentConfigs` `.rsId`	string	必須	シャードを識別するレプリカセットラベル。
`deploymentConfigs` `.deploymentId`	string	必須	シャードに割り当てる配置リージョンを参照する一意の識別子。
`multiRegionBackupEnabled`	ブール値	必須	クラスターでマルチリージョンバックアップが有効になっているかどうかを示すフラグ。

応答

名前	タイプ	説明
`authMechanismName`	string	同期ソースデータベースに接続するために必要な認証メカニズム。 MongoDB Ops Manager では、同期ストアで認証を使用する場合、このパラメータが必要です。 MongoDB Ops Manager は次のいずれかを返します。 `MONGODB_CR` （これは SCRAM-SHA-1、SCRAM-SHA-256、MONGODB-CR をカバーします。） `GSSAPI` `PLAIN` `MONGODB_X509` `NONE`
`clusterId`	string	バックアップ用に構成されたクラスターを識別する一意の 24 桁の 16 進数string 。
`encryptionEnabled`	ブール値	バックアップ構成の暗号化が有効になっているかどうかを示すフラグ。
`excludedNamespaces`	文字列の配列	バックアップから省略されたデータベース名とコレクション名のリスト。各stringは、`{database}` または `{database}.{collection}` の形式の名前空間を指定します。
`groupId`	string	このバックアップ構成を所有するプロジェクトを識別する一意の 24 桁の 16 進数string 。
`includedNamespaces`	string 配列	バックアップに含まれるデータベース名とコレクション名のリスト。各stringは、`{database}` または `{database}.{collection}` の形式の名前空間を指定します。この配列にリストされていない名前空間はバックアップされません。
`links`	オブジェクト配列	サブリソースや関連リソースへの 1 つ以上のリンク。応答内のすべての`links`配列には、 `self`と呼ばれるリンクが少なくとも 1 つ含まれています。 URL の関係は、 Web リンク仕様で説明されています。
`multiRegionBackupEnabled`	ブール値	クラスターでマルチリージョンバックアップが有効になっているかどうかを示すフラグ。
`multiRegionMisconfigured`	ブール値	マルチリージョンバックアップが有効になっている場合は、 `Misconfigured`状態であるかどうかを示すフラグ。値は次のいずれかになります。 `true` - ステータスは `Misconfigured` で、 MongoDB Ops Managerは新しいスナップショットを取得しませんが、 MongoDB Ops Managerは割り当てられたリージョンを持つクラスターノードのoplogを中断することなくテーリングを続行します。 MongoDB Ops Managerがすべてのクラスターノードの新しいスナップショットの取得を再開するには、新しいクラスターノード用に配置リージョンを選択する必要があります。 `false` - ステータスは`Active`です。
`preferredMember`	string	バックアップの優先ノードとして手動で指定されたクラスターノード。優先ノードがUIまたはAPI で設定されている場合のノードリクエストにのみ表示されます。
`sslEnabled`	ブール値	同期ソースデータベースでTLSが有効になっているかどうかを示すフラグ。
`statusName`	string	バックアップ構成の現在の（または希望）ステータス。可能な値は次のとおりです。 `INACTIVE` `PROVISIONING` `STARTED` `STOPPED` `TERMINATING`
`storageEngineName`	string	バックアップに使用されるストレージエンジン。可能な値は次のとおりです。 `MEMORY_MAPPED` `WIRED_TIGER`

リクエストの例

curl --user "{publicKey}:{privateKey}" --digest \
     --header "Accept: application/json" \
     --include \
     --request PATCH "https://{opsManagerHost}:{port}/api/public/v1.0/admin/backup/backupDeployments/?pretty=true"
     --data '
       {
         "multiRegionBackupEnabled" : true,
         "deploymentConfigs": [
           {"rsId":"myShard_2", "deploymentId":"NY_NJ"},
         ]
       }'

応答例

応答ヘッダー

HTTP/1.1 401 Unauthorized
Content-Type: application/json;charset=ISO-8859-1
Date: {dateInUnixFormat}
WWW-Authenticate: Digest realm="MMS Public API", domain="", nonce="{nonce}", algorithm=MD5, op="auth", stale=false
Content-Length: {requestLengthInBytes}
Connection: keep-alive

HTTP/1.1 200 OK
Vary: Accept-Encoding
Content-Type: application/json
Strict-Transport-Security: max-age=300
Date: {dateInUnixFormat}
Connection: keep-alive
Content-Length: {requestLengthInBytes}
X-MongoDB-Service-Version: gitHash={gitHash}; versionString={ApplicationVersion}

レスポンス本体

{
  "authMechanismName" : "NONE",
  "clusterId" : "{CLUSTER-ID}",
  "encryptionEnabled" : false,
  "excludedNamespaces" : [ ],
  "groupId" : "{PROJECT-ID}",
  "links" : [ ],
  "multiRegionBackupEnabled" : true,
  "multiRegionMisconfigured" : false,
  "sslEnabled" : false,
  "statusName" : "STARTED",
  "storageEngineName" : "WIRED_TIGER"
}

戻る

ID を使用して 1 つの配置リージョンを作成

1 つの配置リージョンを削除

注意