注意
グループとプロジェクトは同義語です。あなたの {PROJECT-ID} は、グループ IDと同じです。既存のグループの場合、グループ/グループ ID は同じままです。このページでは、説明を参照するときに、より一般的なタームのグループ を使用します。エンドポイントとなる接続されたデバイスは、ドキュメントに記載されているままです。
ベース URL: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0
Resource
GET /admin/backup/backupDeployments/{DEPLOYMENT-ID}
Request Parameters
リクエスト パス パラメーター
Parameter | タイプ | 必要性 | 説明 |
|---|---|---|---|
配置 ID | string | 必須 | 構成内の配置リージョンを参照する一意の識別子です。 |
リクエスト クエリ パラメータ
次のクエリ パラメータは 任意です。
名前 | タイプ | 必要性 | 説明 | default |
|---|---|---|---|---|
pageNum | 数値 | 任意 | 結果のサブセクションを返す 1 から始まる整数。 |
|
itemsPerPage | 数値 | 任意 | 1 ページあたりに返す項目の数は最大 500 です。 |
|
pretty | ブール値 | 任意 | レスポンス本体を pretty-print形式にするかどうかを示すフラグ。 |
|
envelope | ブール値 | 任意 | 応答をエンベロープでラップするかどうかを示すフラグ。 Some API clients cannot access the HTTP response headers or status code. To remediate this, set 結果のリストを返すエンドポイントの場合、 |
|
リクエスト ボディ パラメータ
このエンドポイントは、HTTP リクエスト本体パラメータを使用しません。
応答
名前 | タイプ | 説明 |
|---|---|---|
| ブール値 | バックアップ リソースに配置リージョンを割り当てられるかどうかを示すフラグ。 |
| string | Ops Manager instance that serves Queryable Backup requests. Value is in the following format: |
| string | 配置リージョンの目的を説明するstring 。 |
| string | 構成内のこの配置リージョンを参照する一意の識別子。 |
| string | Ops Manager instance to which the Backup Agent writes snapshot or oplog data. Value is a valid URL such as |
| オブジェクト配列 | サブリソースまたは関連リソースへの 1 つ以上のリンク。応答内のすべての |
| string | 復元リクエストを提供する MongoDB Ops Manager インスタンス |
リクエストの例
curl --user "{publicKey}:{privateKey}" --digest \ --header "Accept: application/json" \ --include \ --request GET "https://{opsManagerHost}:{port}/api/public/v1.0/admin/backup/backupDeployments/NY_NJ?pretty=true"
応答例
応答ヘッダー
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
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}
レスポンス本体
1 { 2 "assignmentEnabled" : true, 3 "bqProxyEndpoint" : "queryable-backup.mongodb.com:27217", 4 "deploymentDescription" : "Eastern US", 5 "id" : "NY_NJ", 6 "ingestionEndpoint" : "https://api-backup.mongodb.com", 7 "links" : [ ], 8 "restoreEndpoint" : "https://api-backup.mongodb.com" 9 }