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

項目一覧

Resource

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

MongoDB Ops Manager v6.0 は 1 月 2025 で EOL になります。可能な限りすぐに MongoDB Ops Manager の上位バージョンにアップグレードしてください。

注意

グループとプロジェクトは同義語です。あなたの {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 つの結果を返すエンドポイントの場合、レスポンス本体には次のものが含まれます。

名前	説明
状態	HTTPレスポンスコード
envelope	期待される応答本体

false

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

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

応答

名前	タイプ	説明
authMechanismName	string	同期ソースデータベースに接続するときに使用する認証メカニズムの名前。同期ストアが認証を使用する場合、MongoDB Ops Manager はこのパラメーターを返します。
clusterId	string	このバックアップ構成が適用されるクラスターの一意の識別子。
encryptionEnabled	ブール値	バックアップ構成の暗号化が有効になっているかどうかを示すフラグ。バックアップ構成の暗号化を有効にするときは、 syncSourceフィールドを含める必要があります。プロジェクト内の既存のバックアップの場合、暗号化を有効にするにはバックアップのヘッドデータベースを再作成するための最初の同期が必要です。 FCV `4.2` 以降では、ヘッドデータベースの代わりにバックアップカーソルを使用します。詳細については、「バックアップデーモンサービス」を参照してください。 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        }'

応答例

応答ヘッダー

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

重要

可能な場合は常に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 }

戻る

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

スナップショットの予定

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

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	}

注意