1 つのバックアップ構成の更新
項目一覧
注意
グループとプロジェクトは同義語です。 あなたの {PROJECT-ID}はプロジェクト ID と同じです。 既存のグループの場合、グループ/プロジェクト ID は同じままです。 このページでは、説明を参照するときに、より一般的な用語の グループ を使用します。 エンドポイントは ドキュメントに記載されているままです。
ベース URL: https://{OPSMANAGER-HOST}:{PORT}/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 つの結果を返すエンドポイントの場合、レスポンス本体には次のものが含まれます。
| false |
リクエスト ボディ パラメータ
名前 | タイプ | 必要性 | 説明 |
|---|---|---|---|
authMechanismName | string | 条件付き | 同期ソース データベースに接続するために必要な認証メカニズム。 MongoDB Ops Manager では、同期ストアで認証を使用する場合、このパラメータが必要です。 MongoDB Ops Managerは以下に対応しています。
|
encryptionEnabled | ブール値 | 任意 | バックアップ構成の暗号化が有効になっているかどうかを示すフラグ。 バックアップ構成の暗号化を有効にするときは、 syncSourceパラメーターを含める必要があります。 プロジェクト内の既存のバックアップの場合、暗号化を有効にするにはバックアップのヘッドデータベースを再作成するための最初の同期が必要です。 FCV FCV 4.2 以降のバックアップ暗号化の詳細については、「暗号化されたバックアップ スナップショット 」を参照してください。 |
パスワード | string | 条件付き | 同期ソース データベースに接続するために使用するパスワード。 MongoDB Ops Manager では、同期ストア mongodインスタンスでクライアントの認証が必要な場合、このパラメータが必要になります。 |
preferenceメンバー | string | 任意 | ユーザーがスナップショットを作成するための優先レプリカセット ノードとして指定するクラスター ノード。 コンソールを使用して、優先ノードを設定できます。 バックアップ構成を 1 つ取得する エンドポイントを使用して、優先ノードとして機能できるレプリカセット ノードを表示します。 |
プロビジョニングされた | ブール値 | 条件付き | MongoDB Ops Managerがバックアップを保存するために必要なリソースをプロビジョニングしたかどうかを示すフラグ。 |
sslEnabled | ブール値 | 任意 | 同期ソース データベースでTLSが有効になっているかどうかを示すフラグ。 |
statusName | string | 任意 | バックアップ構成の現在の（または希望）ステータス。 MongoDB Ops Managerは以下に対応しています。
|
storageEngineName | string | 任意 | バックアップに使用されるストレージ エンジン。 MongoDB Ops Managerは以下に対応しています。
|
syncSource | string | 条件付き | バックアップ データを取得する MongoDB Ops Manager では、 "storageEngineName" : "Wired_Tiger" の場合、このパラメータが必要です。 |
username | string | 条件付き | 同期ソース データベースに接続するために使用するユーザーの名前。 MongoDB Ops Manager では、同期ストア が管理 していない レプリカセットまたはシャーディングされたクラスターのバックアップ構成を更新するときに、このパラメーターをMongoDB Ops ManagerMongoDB Ops Manager に送信します。 |
応答
名前 | タイプ | 説明 |
|---|---|---|
authMechanismName | string | 同期ソース データベースに接続するときに使用する認証メカニズムの名前。 同期ストアが認証を使用する場合、MongoDB Ops Manager はこのパラメーターを返します。 |
clusterId | string | このバックアップ構成が適用されるクラスターの一意の識別子。 |
encryptionEnabled | ブール値 | バックアップ構成の暗号化が有効になっているかどうかを示すフラグ。 バックアップ構成の暗号化を有効にするときは、 syncSourceフィールドを含める必要があります。 プロジェクト内の既存のバックアップの場合、暗号化を有効にするにはバックアップのヘッドデータベースを再作成するための最初の同期が必要です。 FCV FCV 4.2 以降のバックアップ暗号化の詳細については、「暗号化されたバックアップ スナップショット 」を参照してください。 |
excludedNamespaces | 文字列の配列 | バックアップから省略するデータベース名とコレクション名のリスト。 各stringは、 {database}または{database}.{collection}の形式の名前空間です。 |
includeNamespaces | 文字列の配列 | バックアップに含めるデータベース名とコレクション名のリスト。 各stringは、 {database}または{database}.{collection}の形式の名前空間です。 |
preferenceメンバー | string | ユーザーがスナップショットを作成するための優先レプリカセット ノードとして指定するクラスター ノード。 コンソールを使用して、優先ノードを設定できます。 バックアップ構成を 1 つ取得する エンドポイントを使用して、優先ノードとして機能できるレプリカセット ノードを表示します。 |
projectId | string | このバックアップ構成を所有するプロジェクトの一意の識別子。 |
プロビジョニングされた | ブール値 | MongoDB Ops Managerがバックアップを保存するために必要なリソースをプロビジョニングしたかどうかを示すフラグ。 MongoDB Ops Manager は、バックアップするデータ量が一定のしきい値を超えると、このパラメータを返します。 |
sslEnabled | ブール値 | 同期ソース データベースでTLSが有効になっているかどうかを示すフラグ。 |
statusName | string | バックアップ構成の現在のステータス。 |
storageEngineName | string | バックアップに使用されるストレージ エンジン。 |
リクエストの例
1 curl --user "{publicKey}:{privateKey}" --digest \ 2 --header "Accept: application/json" \ 3 --header "Content-Type: application/json" \ 4 --include --request PATCH "https://<OpsManagerHost>:<Port>/api/public/v1.0/groups/{projectId}/backupConfigs/{clusterId}" \ 5 --data ' 6 { 7 "statusName": "STARTED", 8 "storageEngineName": "WIRED_TIGER", 9 "syncSource": "primary" 10 }'
各スナップショットが開始されると、 MongoDB Ops Managerはスナップショットを実行するためのレプリカセット メンバーを選択します。 この自動選択ノードは、レプリカセットへのパフォーマンスへの影響を最小限に抑える必要があります。 デフォルトの選択を上書きできます。
重要
可能な場合は常に default selectionを使用してください。 この選択により、バックアップの可用性が確保されます。
次のリクエストでは、優先ノードを設定します。
1 curl --user "{publicKey}:{privateKey}" --digest \ 2 --header "Accept: application/json" \ 3 --header "Content-Type: application/json" \ 4 --include --request PATCH "https://<OpsManagerHost>:<Port>/api/public/v1.0/groups/{projectId}/backupConfigs/{clusterId}" \ 5 --data ' 6 { 7 "preferredMember":"{HOSTNAME}:{PORT}" 8 }'
応答例
応答ヘッダー
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 "authMechanismName" : "NONE", 3 "clusterId" : "{clusterId}", 4 "encryptionEnabled" : false, 5 "excludedNamespaces" : [ ], 6 "groupId" : "{projectId}", 7 "links" : [ { 8 "href" : "http://<OpsManagerHost>:<Port>/api/public/v1.0/groups/{projectId}/backupConfigs/{clusterId}", 9 "rel" : "self" 10 }, { 11 "href" : "http://<OpsManagerHost>:<Port>/api/public/v1.0/groups/{projectId}/clusters/{clusterId}", 12 "rel" : "http://mms.mongodb.com/cluster" 13 }, { 14 "href" : "http://<OpsManagerHost>:<Port>/api/public/v1.0/groups/{projectId}", 15 "rel" : "http://mms.mongodb.com/group" 16 }, { 17 "href" : "http://<OpsManagerHost>:<Port>/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 }
各スナップショットが開始されると、 MongoDB Ops Managerはスナップショットを実行するためのレプリカセット メンバーを選択します。 この自動選択ノードは、レプリカセットへのパフォーマンスへの影響を最小限に抑える必要があります。 デフォルトの選択を上書きできます。
重要
可能な場合は常にdefault selectionを使用してください。 この選択により、バックアップの可用性が確保されます。
次の応答には優先ノードが含まれます。
1 { 2 "authMechanismName" : "NONE", 3 "clusterId" : "{clusterId}", 4 "encryptionEnabled" : false, 5 "excludedNamespaces" : [ ], 6 "groupId" : "{projectId}", 7 "links" : [ { 8 "href" : "http://<OpsManagerHost>:<Port>/api/public/v1.0/groups/{projectId}/backupConfigs/{clusterId}", 9 "rel" : "self" 10 }, { 11 "href" : "http://<OpsManagerHost>:<Port>/api/public/v1.0/groups/{projectId}/clusters/{clusterId}", 12 "rel" : "http://mms.mongodb.com/cluster" 13 }, { 14 "href" : "http://<OpsManagerHost>:<Port>/api/public/v1.0/groups/{projectId}", 15 "rel" : "http://mms.mongodb.com/group" 16 }, { 17 "href" : "http://<OpsManagerHost>:<Port>/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 }