注意
グループとプロジェクトは同義語です。あなたの {PROJECT-ID} は、グループ IDと同じです。既存のグループの場合、グループ/グループ ID は同じままです。このページでは、説明を参照するときに、より一般的なタームのグループ を使用します。エンドポイントとなる接続されたデバイスは、ドキュメントに記載されているままです。
ベース URL: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0
Resource
GET /admin/backup/backupDeploymentsRequest Parameters
リクエスト クエリ パラメータ
次のクエリ パラメータは 任意です。
名前 | タイプ | 必要性 | 説明 | default |
|---|---|---|---|---|
pageNum | 数値 | 任意 | 結果のサブセクションを返す 1 から始まる整数。 |
|
itemsPerPage | 数値 | 任意 | 1 ページあたりに返す項目の数は最大 500 です。 |
|
pretty | ブール値 | 任意 | レスポンス本体を pretty-print形式にするかどうかを示すフラグ。 |
|
envelope | ブール値 | 任意 | 応答をエンベロープでラップするかどうかを示すフラグ。 一部の API クライアントは、HTTP レスポンス ヘッダーまたはステータス コードにアクセスできません。これを修正するには、クエリで 結果のリストを返すエンドポイントの場合、 |
|
リクエスト ボディ パラメータ
このエンドポイントは、HTTP リクエスト本体パラメータを使用しません。
応答
名前 | タイプ | 説明 |
|---|---|---|
| ブール値 | バックアップ リソースに配置リージョンを割り当てられるかどうかを示すフラグ。 |
| string | MongoDB Ops Managerクエリ可能な バックアップ リクエストを提供する のインスタンス。値の形式は次のとおりです: |
| string | 配置リージョンの目的を説明するstring 。 |
| string | 構成内のこの配置リージョンを参照する一意の識別子。 |
| string | バックアップエージェントがスナップショットまたは oplog データを書き込み (write)を行う MongoDB Ops Manager インスタンス。値は有効な URL です。例えば |
| オブジェクト配列 | サブリソースまたは関連リソースへの 1 つ以上のリンク。応答内のすべての |
| string | 復元リクエストを提供する MongoDB Ops Manager インスタンス |
リクエストの例
リクエスト本文
curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \ --header "Accept: application/json" \ --include \ --request GET "https://{opsManagerHost}:{port}/api/public/v1.0/admin/backup/backupDeployments"レスポンス本体
{ "links" : [ ], "results" : [ { "assignmentEnabled" : true, "bqProxyEndpoint" : "queryable-backup.mongodb.com:27217", "deploymentDescription" : "Eastern US", "id" : "NY_NJ", "ingestionEndpoint" : "https://api-backup.mongodb.com", "links" : [ ], "restoreEndpoint" : "https://api-backup.mongodb.com" } ], "totalCount" : 1}