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

項目一覧

Resource

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

注意

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

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

Resource

PUT /admin/backup/backupDeployments/{DEPLOYMENT-ID}

Request Parameters

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

Path Parameter	タイプ	必要性	説明
{配置 ID}	string	必須	構成内のこの配置リージョンを参照する一意の識別子。

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

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

名前

タイプ

必要性

説明

default

pretty

ブール値

任意

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

false

envelope

ブール値

任意

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

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

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

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

false

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

名前	タイプ	必要性	説明
`assignmentEnabled`	ブール値	任意	バックアップリソースに配置リージョンを割り当てられるかどうかを示すフラグ。
bqProxyEndpoint	string	必須	MongoDB Ops Managerクエリ可能なバックアップリクエストを提供するのインスタンス。値の形式は次のとおりです: `domain:port` 。たとえば、 `localhost:8080` 。
deployment Description	string	必須	配置リージョンの目的を説明するstring 。
ingestionEndpoint	string	必須	MongoDB Ops Managerバックアップエージェントがスナップショットまたはoplog データを書き込むインスタンス。値は、 `http://www.mongodb.com`などの有効なURLです。 HTTPとHTTPSの両方をサポートします。
restoreEndpoint	string	必須	復元リクエストを提供する MongoDB Ops Manager インスタンス

応答

名前	タイプ	説明
`assignmentEnabled`	ブール値	バックアップリソースに配置リージョンを割り当てられるかどうかを示すフラグ。
`bqProxyEndpoint`	string	MongoDB Ops Managerクエリ可能なバックアップリクエストを提供するのインスタンス。値の形式は次のとおりです: `domain:port` 。たとえば、 `localhost:8080` 。
`deploymentDescription`	string	配置リージョンの目的を説明するstring 。
`id`	string	構成内のこの配置リージョンを参照する一意の識別子。
`ingestionEndpoint`	string	MongoDB Ops Managerバックアップエージェントがスナップショットまたはoplog データを書き込むインスタンス。値は、 `http://www.mongodb.com`などの有効なURLです。 HTTPとHTTPSの両方をサポートします。
`links`	オブジェクト配列	サブリソースや関連リソースへの 1 つ以上のリンク。応答内のすべての`links`配列には、 `self`と呼ばれるリンクが少なくとも 1 つ含まれています。 URL の関係は、 Web リンク仕様で説明されています。
`restoreEndpoint`	string	復元リクエストを提供する MongoDB Ops Manager インスタンス

リクエストの例

curl --user "{publicKey}:{privateKey}" --digest \
     --header "Accept: application/json" \
     --include \
     --request PUT
     "https://{opsManagerHost}:{port}/api/public/v1.0/admin/backup/backupDeployments/AU_NJ?pretty=true" \
     --data '
       {
         "ingestionEndpoint": "https://api-backup.mongodb.com",
         "restoreEndpoint": "https://api-backup.mongodb.com",
         "bqProxyEndpoint": "queryable-backup.mongodb.com:27217",
         "deploymentDescription": "Australia and New Zealand",
         "assignmentEnabled": true
       }'

応答例

応答ヘッダー

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}

レスポンス本体

{
  "assignmentEnabled" : true,
  "bqProxyEndpoint" : "queryable-backup.mongodb.com:27217",
  "deploymentDescription" : "Australia and New Zealand",
  "id" : "AU_NJ",
  "ingestionEndpoint" : "https://api-backup.mongodb.com",
  "links" : [ ],
  "restoreEndpoint" : "https://api-backup.mongodb.com"
}

戻る

1 つの配置リージョンを作成

1 つの配置リージョンを割り当て

注意