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

注意

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

ベース URL: https://cloud.mongodb.com/api/public/v1.0

Resource

PATCH /groups/{projectId}/backupConfigs/{clusterId}

Request Parameters

リクエストパスパラメーター

Path Parameter	タイプ	必要性	説明
projectId	string	必須	変更対象のバックアップ構成を持つクラスターを保持するプロジェクトを識別する、一意な 24 桁の 16 進数のstring 。
clusterId	string	必須	バックアップ構成を変更したいクラスターを識別する一意な 24 桁の 16 進数のstring 。

リクエストクエリパラメータ

次のクエリパラメータは任意です。

名前	タイプ	必要性	説明	default
pretty	ブール値	任意	レスポンス本体をpretty-print形式にするかどうかを示すフラグ。	`false`
envelope	ブール値	任意	応答をエンベロープでラップするかどうかを示すフラグ。一部の API クライアントは、HTTP レスポンスヘッダーまたはステータスコードにアクセスできません。これを修正するには、クエリで envelope=true を設定します。 1 つの結果を返すエンドポイントの場合、レスポンス本体には次のものが含まれます。 `status`: HTTPレスポンスコード `content`: 期待される応答本体	`false`

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

名前	タイプ	必要性	説明
authMechanismName	string	条件付き	同期ソースデータベースに接続するために必要な認証メカニズム。同期ストアが認証を使用する場合、Cloud Manager はこのパラメータを必要とします。 Cloud Manager は以下に対応しています。 `MONGODB_CR` （これは SCRAM-SHA-1、SCRAM-SHA-256、MONGODB-CR をカバーします。） `GSSAPI` `PLAIN` `MONGODB_X509` `NONE`
excludedNamespaces	文字列の配列	条件付き	Cloud Manager は、MongoDB `FCV` 4.0 以前を実行するバックアップジョブに対してこのパラメータを受け入れます。Cloud Manager は、機能の互換性バージョン 4.2 以降を実行している MongoDB データベースをバックアップする際、このパラメーターを無視します。バックアップから省略するデータベース名とコレクション名のリスト。各 string は 1 つの名前空間を表します。名前空間では、 {database}または{database}.{collection}の形式が使用されます。このパラメーターは、次の条件を満たしている必要があります。 Cloud Manager は、このパラメーターを受け入れますまたはincludeNamespacesを受け入れますが、両方は受け入れません。 Cloud Manager では、配列内ですでに見つかった名前空間を含む、除外された名前空間の新しい完全なリストが必要です。新しいリストで既存の配列から名前空間が削除される場合は、 syncSourceパラメーターを設定します。排除された名前空間を削除するには、完全な再同期が必要です。 syncSourceパラメーターがないと、リクエストは失敗します。新しいリストが既存の配列にのみ追加する場合は、 syncSourceを設定しないでください。
includeNamespaces	文字列の配列	条件付き	Cloud Manager は、MongoDB `FCV` 4.0 以前を実行するバックアップジョブに対してこのパラメータを受け入れます。Cloud Manager は、機能の互換性バージョン 4.2 以降を実行している MongoDB データベースをバックアップする際、このパラメーターを無視します。バックアップに含めるデータベース名とコレクション名のリスト。各 string は 1 つの名前空間を表します。名前空間では、 {database}または{database}.{collection}の形式が使用されます。このパラメーターは、次の条件を満たしている必要があります。 Cloud Manager は、このパラメーターを受け入れるか、 excludedNamespacesを受け入れますが、両方を受け入れることはありません。 Cloud Manager では、配列内ですでに見つかった名前空間を含む、含まれる名前空間の新しい完全なリストが必要です。新しいリストに既存の配列の名前空間が追加される場合は、 syncSourceパラメーターを設定します。含まれる名前空間を追加するには、完全な再同期が必要です。 syncSourceパラメーターがないと、リクエストは失敗します。新しいリストが既存の配列から名前空間のみを削除する場合は、 syncSourceを設定しないでください。
パスワード	string	条件付き	同期ソースデータベースに接続するために使用するパスワード。 Cloud Manager では、同期ストア`mongod`インスタンスでクライアントの認証が必要な場合、このパラメータが必要になります。
preferenceメンバー	string	任意	ユーザーがスナップショットを作成するための優先レプリカセットノードとして指定するクラスターノード。コンソールを使用して、優先ノードを設定できます。バックアップ構成を 1 つ取得するエンドポイントを使用して、優先ノードとして機能できるレプリカセットノードを表示します。
プロビジョニングされた	ブール値	条件付き	Cloud Manager がバックアップを保存するために必要なリソースをプロビジョニングしたかどうかを示すフラグ。
sslEnabled	ブール値	任意	同期ソースデータベースでTLSが有効になっているかどうかを示すフラグ。
statusName	string	任意	バックアップ構成の現在の（または希望）ステータス。 Cloud Manager は以下に対応しています。非アクティブプロビジョニング開始済み STOPPED 終了
storageEngineName	string	任意	バックアップに使用されるストレージエンジン。 Cloud Manager は以下に対応しています。 MEMORY_MAPPED WIRED_TIGER
syncSource	string	条件付き	バックアップデータを取得するための`mongod`インスタンス。 Cloud Manager は、特定のホスト名またはプライマリおよびセカンダリのいずれかを受け入れます。 Cloud Manager は、 "storageEngineName" の場合、このパラメータが必要です。
username	string	条件付き	同期ソースデータベースに接続するために使用するユーザーの名前。 Cloud Manager では、同期ストア`mongod`インスタンスでクライアントの認証が必要な場合、このパラメータが必要になります。 Cloud Manager が管理していないレプリカセットまたはシャーディングされたクラスターのバックアップ構成を更新するときに、Cloud Manager にこのパラメーターを送信します。

応答

名前	タイプ	説明
authMechanismName	string	同期ソースデータベースに接続するときに使用する認証メカニズムの名前。同期ストアが認証を使用する場合、Cloud Manager はこのパラメータを返します。
clusterId	string	このバックアップ構成が適用されるクラスターの一意の識別子。
excludedNamespaces	文字列の配列	バックアップから省略するデータベース名とコレクション名のリスト。各stringは、 {database}または{database}.{collection}の形式の名前空間です。
includeNamespaces	文字列の配列	バックアップに含めるデータベース名とコレクション名のリスト。各stringは、 {database}または{database}.{collection}の形式の名前空間です。
Links	オブジェクト配列	サブリソースや関連リソースへの 1 つ以上のリンク。応答内のすべての `links` 配列には、`self` と呼ばれるリンクが少なくとも 1 つ含まれています。URLの関係は、Web リンク仕様で説明されています。
preferenceメンバー	string	ユーザーがスナップショットを作成するための優先レプリカセットノードとして指定するクラスターノード。コンソールを使用して、優先ノードを設定できます。バックアップ構成を 1 つ取得するエンドポイントを使用して、優先ノードとして機能できるレプリカセットノードを表示します。
projectId	string	このバックアップ構成を所有するプロジェクトの一意の識別子。
プロビジョニングされた	ブール値	Cloud Manager がバックアップを保存するために必要なリソースをプロビジョニングしたかどうかを示すフラグ。 Cloud Manager は、バックアップするデータ量が一定のしきい値を超えると、このパラメータを返します。
sslEnabled	ブール値	同期ソースデータベースでTLSが有効になっているかどうかを示すフラグ。
statusName	string	バックアップ構成の現在の（または希望）ステータス。
storageEngineName	string	バックアップに使用されるストレージエンジン。

リクエストの例

1curl --user "{publicKey}:{privateKey}" --digest \2     --header "Accept: application/json" \3     --header "Content-Type: application/json" \4     --include --request PATCH "https://cloud.mongodb.com/api/public/v1.0/groups/{projectId}/backupConfigs/{clusterId}"5     --data '6       {7         "statusName": "STARTED",8         "storageEngineName": "WIRED_TIGER",9         "syncSource": "primary"10       }'

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

重要

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

次のリクエストでは、優先ノードを設定します。

1curl --user "{publicKey}:{privateKey}" --digest \2     --header "Accept: application/json" \3     --header "Content-Type: application/json" \4     --include --request PATCH "https://cloud.mongodb.com/api/public/v1.0/groups/{projectId}/backupConfigs/{clusterId}"5     --data '6       {7         "preferredMember":"<HOSTNAME>:<PORT>"8       }'

応答例

応答ヘッダー

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

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

レスポンス本体

1{2  "authMechanismName" : "NONE",3  "clusterId" : "{clusterId}",4  "encryptionEnabled" : false,5  "excludedNamespaces" : [ ],6  "groupId" : "{projectId}",7  "links" : [ {8    "href" : "http://cloud.mongodb.com/api/public/v1.0/groups/{projectId}/backupConfigs/{clusterId}",9  "rel" : "self"10  }, {11    "href" : "http://cloud.mongodb.com/api/public/v1.0/groups/{projectId}/clusters/{clusterId}",12    "rel" : "http://mms.mongodb.com/cluster"13  }, {14    "href" : "http://cloud.mongodb.com/api/public/v1.0/groups/{projectId}",15    "rel" : "http://mms.mongodb.com/group"16  }, {17    "href" : "http://cloud.mongodb.com/api/public/v1.0/groups/   {projectId}/backupConfigs/{clusterId}/snapshotSchedule",18    "rel" : "http://mms.mongodb.com/snapshotSchedule"19  } ],20  "sslEnabled" : false,21  "statusName" : "STARTED",22  "storageEngineName" : "WIRED_TIGER"23}

重要

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

次の応答には優先ノードが含まれます。

1{2  "authMechanismName" : "NONE",3  "clusterId" : "{clusterId}",4  "encryptionEnabled" : false,5  "excludedNamespaces" : [ ],6  "groupId" : "{projectId}",7  "links" : [ {8    "href" : "http://cloud.mongodb.com/api/public/v1.0/groups/{projectId}/backupConfigs/{clusterId}",9  "rel" : "self"10  }, {11    "href" : "http://cloud.mongodb.com/api/public/v1.0/groups/{projectId}/clusters/{clusterId}",12    "rel" : "http://mms.mongodb.com/cluster"13  }, {14    "href" : "http://cloud.mongodb.com/api/public/v1.0/groups/{projectId}",15    "rel" : "http://mms.mongodb.com/group"16  }, {17    "href" : "http://cloud.mongodb.com/api/public/v1.0/groups/   {projectId}/backupConfigs/{clusterId}/snapshotSchedule",18    "rel" : "http://mms.mongodb.com/snapshotSchedule"19  } ],20  "sslEnabled" : false,21  "statusName" : "STARTED",22  "storageEngineName" : "WIRED_TIGER",23  "preferredMember":"{HOSTNAME}:{PORT}"24}