注意
グループとプロジェクトは同義語です。 あなたの {PROJECT-ID}はプロジェクト ID と同じです。 既存のグループの場合、グループ/プロジェクト ID は同じままです。 このページでは、説明を参照するときに、より一般的な用語の グループ を使用します。 エンドポイントは ドキュメントに記載されているままです。
ベース URL: https://cloud.mongodb.com/api/public/v1.0
Resource
GET /groups/{PROJECT-ID}/backupConfigs
Request Parameters
リクエスト パス パラメーター
名前 | タイプ | 必要性 | 説明 |
|---|---|---|---|
プロジェクトID | string | 必須 | バックアップ構成が適用されるプロジェクトを識別する一意の 24 桁の 16 進数のstring 。 |
リクエスト クエリ パラメータ
次のクエリ パラメータは 任意です。
名前 | タイプ | 必要性 | 説明 | default |
|---|---|---|---|---|
pageNum | 数値 | 任意 | 結果のサブセクションを返す 1 から始まる整数。 |
|
itemsPerPage | 数値 | 任意 | 1 ページあたりに返す項目の数は最大 500 です。 |
|
pretty | ブール値 | 任意 | レスポンス本体を pretty-print 形式にするかどうかを示すフラグ。 |
|
envelope | ブール値 | 任意 | 応答をエンベロープでラップするかどうかを示すフラグ。 一部の APIクライアントは、 HTTPレスポンス ヘッダーまたはステータス コードにアクセスできません。 これを修正するには、クエリで 結果のリストを返すエンドポイントの場合、 |
|
backupJobsEnabledOnly | ブール値 | 任意 | データベースのバックアップ用に有効になっていないデーモンを応答から除外するかどうかを示すフラグ。 これを |
|
リクエスト ボディ パラメータ
このエンドポイントは、HTTP リクエスト本体パラメータを使用しません。
応答
名前 | タイプ | 説明 |
|---|---|---|
グループ ID | string | このバックアップ構成を所有するプロジェクトを識別する一意の 24 桁の 16 進数string 。 |
clusterId | string | 検索対象のバックアップ構成を持つクラスターを識別する、一意な 24 桁の 16 進数string 。 |
statusName | string | バックアップ構成の現在の（または希望）ステータス。 可能な値は次のとおりです。
|
storageEngineName | string | バックアップに使用されるストレージ エンジン。 可能な値は次のとおりです。
|
sslEnabled | ブール値 | 同期ソース データベースでTLSが有効になっているかどうかを示すフラグ。 |
excludedNamespaces | string 配列 | バックアップから省略するデータベース名とコレクション名のリスト。 各stringは、 すでにリストされている名前空間を含む、除外された名前空間の新しい完全なリストを送信する必要があります。 新しいリストで前のリストからすべての名前空間が削除される場合は、除外された名前空間の削除には完全な再同期が必要になるため、 新しいリストが前のリストにのみ追加される場合は、 |
includeNamespaces | string 配列 | バックアップに含めるデータベース名とコレクション名のリスト。 各stringは、 すでにリストされている名前空間を含む、含まれている名前空間の新しい完全なリストを送信する必要があります。 新しいリストで前のリストに名前空間が追加される場合は、含まれている名前空間を追加するには完全な再同期が必要になるため、 新しいリストで前のリストから名前空間のみが削除される場合は、 |
リクエストの例
curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \ --header "Accept: application/json" \ --include \ --request GET "https://cloud.mongodb.com/api/public/v1.0/groups/{PROJECT-ID}/backupConfigs"
応答例
応答ヘッダー
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 "totalCount" : 3, 3 "results" : [ { 4 "groupId" : "{PROJECT-ID}", 5 "clusterId" : "{CLUSTER-ID1}", 6 "statusName" : "STARTED", 7 "storageEngineName" : "WIRED_TIGER", 8 "sslEnabled" : false, 9 "excludedNamespaces" : [ ], 10 "includedNamespaces" : [ ], 11 "links" : [ ] 12 }, { 13 "groupId" : "{PROJECT-ID}", 14 "clusterId" : "{CLUSTER-ID2}", 15 "statusName" : "STARTED", 16 "storageEngineName" : "MEMORY_MAPPED", 17 "sslEnabled" : false, 18 "excludedNamespaces" : [ ], 19 "includedNamespaces" : [ ], 20 "links" : [ ] 21 }, { 22 "groupId" : "{PROJECT-ID}", 23 "clusterId" : "{CLUSTER-ID3}", 24 "statusName" : "STOPPED", 25 "storageEngineName" : "WIRED_TIGER", 26 "sslEnabled" : false, 27 "excludedNamespaces" : [ ], 28 "includedNamespaces" : [ ], 29 "links" : [ ] 30 } ], 31 "links" : [ ] 32 }