注意
グループとプロジェクトは同義期間です。あなたの {PROJECT-ID} はグループ ID と同じです。既存のグループの場合、グループ/プロジェクトID は同じままです。このページでは、説明を参照するときに、より一般的な期間のグループ を使用します。エンドポイントとなる接続されたデバイスは、ドキュメントに記載されているままです。
ベース URL: https://cloud.mongodb.com/api/public/v1.0
Resource
GET /groups/{PROJECT-ID}/backupConfigs/{CLUSTER-ID}Request Parameters
リクエスト パス パラメーター
Parameter | タイプ | 必要性 | 説明 |
|---|---|---|---|
プロジェクトID | string | 必須 | 検索対象のバックアップ構成を持つクラスターを保持するプロジェクトを識別する、一意な 24 桁の 16 進数のstring 。 |
CLUSTER-ID | string | 必須 | 検索対象のバックアップ構成を持つクラスターを識別する、一意な 24 桁の 16 進数string 。 |
リクエスト クエリ パラメータ
次のクエリ パラメータは 任意です。
名前 | タイプ | 必要性 | 説明 | default |
|---|---|---|---|---|
pretty | ブール値 | 任意 | レスポンス本体をpretty-print形式にするかどうかを示すフラグ。 |
|
envelope | ブール値 | 任意 | 応答をエンベロープでラップするかどうかを示すフラグ。 一部の API クライアントは、HTTP レスポンス ヘッダーまたはステータス コードにアクセスできません。これを修正するには、クエリで envelope=true を設定します。 1 つの結果を返すエンドポイントの場合、レスポンス本体には次のものが含まれます。
|
|
リクエスト ボディ パラメータ
このエンドポイントは、HTTP リクエスト本体パラメータを使用しません。
応答
名前 | タイプ | 説明 |
|---|---|---|
availableMetrics | string 配列 | バックアップ可能なクラスター ノードのリスト。 メンバー リクエストにのみ表示されます。 |
clusterId | string | バックアップ用に構成するクラスターを識別する一意な 24 桁の 16 進数のstring 。 |
excludedNamespaces | string 配列 | バックアップから省略するデータベース名とコレクション名のリスト。 各stringは、 すでにリストされている名前空間を含む、除外された名前空間の新しい完全なリストを送信する必要があります。 新しいリストで前のリストからすべての名前空間が削除される場合は、除外された名前空間の削除には完全な再同期が必要になるため、 新しいリストが前のリストにのみ追加される場合は、 |
グループ ID | string | このバックアップ構成を所有するプロジェクトを識別する一意の 24 桁の 16 進数string 。 |
includeNamespaces | string 配列 | バックアップに含めるデータベース名とコレクション名のリスト。 各stringは、 すでにリストされている名前空間を含む、含まれている名前空間の新しい完全なリストを送信する必要があります。 新しいリストで前のリストに名前空間が追加される場合は、含まれている名前空間を追加するには完全な再同期が必要になるため、 新しいリストで前のリストから名前空間のみが削除される場合は、 |
Links | オブジェクト配列 | サブリソースや関連リソースへの 1 つ以上のリンク。応答内のすべての |
preferenceメンバー | string | バックアップの優先ノードとして手動で指定されたクラスター ノード。 優先ノードがUIまたはAPI で設定されている場合のノード リクエストにのみ表示されます。 |
sslEnabled | ブール値 | 同期ソース データベースでTLSが有効になっているかどうかを示すフラグ。 |
statusName | string | バックアップ構成の現在の（または希望）ステータス。 可能な値は次のとおりです。
|
storageEngineName | 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/{CLUSTER-ID}"各スナップショットが開始されると、Cloud Manager はスナップショットを実行するレプリカセット メンバーを選択します。 この自動選択ノードは、レプリカセットへのパフォーマンスへの影響を最小限に抑える必要があります。 デフォルトの選択を上書きできます。
重要
可能な場合は常にdefault selectionを使用してください。 この選択により、バックアップの可用性が確保されます。
次のリクエストは、使用可能なメンバーを返します。
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/{CLUSTER-ID}/availableMembers?pretty=true"応答例
応答ヘッダー
HTTP/1.1 401 UnauthorizedContent-Type: application/json;charset=ISO-8859-1Date: {dateInUnixFormat}WWW-Authenticate: Digest realm="MMS Public API", domain="", nonce="{nonce}", algorithm=MD5, op="auth", stale=falseContent-Length: {requestLengthInBytes}Connection: keep-aliveHTTP/1.1 200 OKVary: Accept-EncodingContent-Type: application/jsonStrict-Transport-Security: max-age=300Date: {dateInUnixFormat}Connection: keep-aliveContent-Length: {requestLengthInBytes}X-MongoDB-Service-Version: gitHash={gitHash}; versionString={ApplicationVersion}レスポンス本体
{ "clusterId" : "{CLUSTER-ID}", "excludedNamespaces" : [ ], "groupId" : "{PROJECT-ID}", "includedNamespaces" : [ ], "links" : [ ], "sslEnabled" : false, "statusName" : "STARTED", "storageEngineName" : "WIRED_TIGER"}各スナップショットが開始されると、Cloud Manager はスナップショットを実行するレプリカセット メンバーを選択します。 この自動選択ノードは、レプリカセットへのパフォーマンスへの影響を最小限に抑える必要があります。 デフォルトの選択を上書きできます。
重要
可能な場合は常にdefault selectionを使用してください。 この選択により、バックアップの可用性が確保されます。
次の応答には、使用可能なノードと指定された優先ノードが含まれます。 優先ノードが未定義の場合、応答から除外されます。
{ "availableMembers" : [ "{HOSTNAME1}:{PORT1}", "{HOSTNAME2}:{PORT2}", "{HOSTNAME3}:{PORT3}"], "clusterId" : "{CLUSTER-ID}", "excludedNamespaces" : [ ], "groupId" : "{PROJECT-ID}", "includedNamespaces" : [ ], "links" : [ ], "sslEnabled" : false, "statusName" : "STARTED", "storageEngineName" : "WIRED_TIGER", "preferredMember" : "{HOSTNAME1}:{PORT1}"}