Docs Menu
Docs Home
/
MongoDB Cloud Manager
/
API
/
Cloud Manager Administration API リソース
/
バックアップと復元
/
バックアップ構成

1 つのプロジェクトから 1 つのバックアップ構成を取得

項目一覧

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

注意

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

ベース URL: https://cloud.mongodb.com/api/public/v 1.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
ブール値
任意
false
envelope
ブール値
任意

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

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

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

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

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

このエンドポイントは、HTTP リクエスト本体パラメータを使用しません。

応答

名前
タイプ
説明
availableMetrics
string 配列
バックアップ可能なクラスター ノードのリスト。 メンバー リクエストにのみ表示されます。
clusterId
string
バックアップ用に構成するクラスターを識別する一意な 24 桁の 16 進数のstring 。
excludedNamespaces
string 配列

バックアップから省略するデータベース名とコレクション名のリスト。 各stringは、{database} または {database}.{collection} の形式の名前空間です。 このフィールドが存在する場合、 includedNamespacesフィールドは存在できません。

すでにリストされている名前空間を含む、除外された名前空間の新しい完全なリストを送信する必要があります。

新しいリストで前のリストからすべての名前空間が削除される場合は、除外された名前空間の削除には完全な再同期が必要になるため、 syncSourceフィールドも設定する必要があります。 syncSourceフィールドがない場合、リクエストは失敗します。

新しいリストが前のリストにのみ追加される場合は、 syncSourceを設定する必要はありません。

グループ ID
string
このバックアップ構成を所有するプロジェクトを識別する一意の 24 桁の 16 進数string 。
includeNamespaces
string 配列

バックアップに含めるデータベース名とコレクション名のリスト。 各stringは、{database} または {database}.{collection} の形式の名前空間です。 この配列にリストされていない名前空間はバックアップされません。 このフィールドが存在する場合、 excludedNamespacesフィールドは存在できません。

すでにリストされている名前空間を含む、含まれている名前空間の新しい完全なリストを送信する必要があります。

新しいリストで前のリストに名前空間が追加される場合は、含まれている名前空間を追加するには完全な再同期が必要になるため、 syncSourceフィールドも設定する必要があります。 syncSourceフィールドがない場合、リクエストは失敗します。

新しいリストで前のリストから名前空間のみが削除される場合は、 syncSourceを設定する必要はありません。

Links
オブジェクト配列

サブリソースや関連リソースへの 1 つ以上のリンク。 応答内のすべてのlinks配列には、 selfと呼ばれるリンクが少なくとも 1 つ含まれています。 URL の関係は、 Web リンク仕様 で説明されています。

preferenceメンバー
string
バックアップの優先ノードとして手動で指定されたクラスター ノード。 優先ノードがUIまたはAPI で設定されている場合のノード リクエストにのみ表示されます。
sslEnabled
ブール値
同期ソース データベースでTLSが有効になっているかどうかを示すフラグ。
statusName
string

バックアップ構成の現在の（または希望）ステータス。 可能な値は次のとおりです。

  • INACTIVE

  • PROVISIONING

  • STARTED

  • STOPPED

  • TERMINATING

storageEngineName
string

バックアップに使用されるストレージ エンジン。 可能な値は次のとおりです。

  • MEMORY_MAPPED

  • WIRED_TIGER

リクエストの例

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 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}

レスポンス本体

1{
2  "clusterId" : "{CLUSTER-ID}",
3  "excludedNamespaces" : [ ],
4  "groupId" : "{PROJECT-ID}",
5  "includedNamespaces" : [ ],
6  "links" : [ ],
7  "sslEnabled" : false,
8  "statusName" : "STARTED",
9  "storageEngineName" : "WIRED_TIGER"
10}

各スナップショットが開始されると、Cloud Manager はスナップショットを実行するレプリカセット メンバーを選択します。 この自動選択ノードは、レプリカセットへのパフォーマンスへの影響を最小限に抑える必要があります。 デフォルトの選択を上書きできます。

重要

可能な場合は常にdefault selectionを使用してください。 この選択により、バックアップの可用性が確保されます。

次の応答には、使用可能なノードと指定された優先ノードが含まれます。 優先ノードが未定義の場合、応答から除外されます。

1{
2  "availableMembers" : [ "{HOSTNAME1}:{PORT1}", "{HOSTNAME2}:{PORT2}", "{HOSTNAME3}:{PORT3}"],
3  "clusterId" : "{CLUSTER-ID}",
4  "excludedNamespaces" : [ ],
5  "groupId" : "{PROJECT-ID}",
6  "includedNamespaces" : [ ],
7  "links" : [ ],
8  "sslEnabled" : false,
9  "statusName" : "STARTED",
10  "storageEngineName" : "WIRED_TIGER",
11  "preferredMember" : "{HOSTNAME1}:{PORT1}"
12}

戻る

1 つのプロジェクトからすべてのバックアップ構成を取得

次へ

1 つのバックアップ構成の更新