Join us Sept 17 at .local NYC! Use code WEB50 to save 50% on tickets. Learn more >
MongoDB Event
Docs Menu
Docs Home
/
Ops Manager
/
API
/
リソース
/
バックアップと復元
/
バックアップ構成

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 つの結果を返すエンドポイントの場合、レスポンス本体には次のものが含まれます。

名前
説明

status

HTTPレスポンス コード

content

期待される応答本体

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

文字列の配列

条件付き

バックアップから省略するデータベースとコレクション名のリスト。各 string は 1 つの名前空間を表します。 名前空間は次のいずれかの形式を使用します。

  • {データベース}

  • {データベース}.{コレクション} .

MongoDB Ops Manager は、MongoDB FCV 4.0またはそれ以前のバージョンを実行しているバックアップ ジョブにこのパラメータを受け入れます。 MongoDB Ops ManagerMongoDBは、 FCV4.2 以降を実行している データベースをバックアップする場合、このパラメーターを無視します。

このパラメーターは、次の条件を満たしている必要があります。

  • MongoDB Ops Manager は、このパラメーターと includeNamespaces のいずれかを受け入れますが、両方は受け入れません。

  • MongoDB Ops Manager では、配列内ですでに見つかった名前空間を含む、除外された名前空間の新しい完全なリストが必要です。

    • 新しいリストで既存の配列から名前空間が削除される場合は、 syncSourceパラメーターを設定します。

      • 排除された名前空間を削除するには、 完全な再同期 が必要です。

      • syncSourceパラメーターがないと、リクエストは失敗します。

    • 新しいリストが既存の配列にのみ追加する場合は、 syncSourceを設定しないでください。

includeNamespaces

文字列の配列

条件付き

バックアップに含めるデータベースとコレクション名のリスト。各 string は 1 つの名前空間を表します。 名前空間は次のいずれかの形式を使用します。

  • {データベース}

  • {データベース}.{コレクション} .

MongoDB Ops Manager は、MongoDB FCV 4.0またはそれ以前のバージョンを実行しているバックアップ ジョブにこのパラメータを受け入れます。 MongoDB Ops ManagerMongoDBは、 FCV4.2 以降を実行している データベースをバックアップする場合、このパラメーターを無視します。

このパラメーターは、次の条件を満たしている必要があります。

  • 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 に送信します。

snapshotStore

オブジェクト

任意

移行先の読み取りを指定するオブジェクト。このオブジェクトには、読み取りタイプと S3バケット（ S3ブロックストア）のIDが含まれています。既存のスナップショットは、構成された保持ポリシーに基づいて、有効期限が切れるまで、元のストアに残ります。ジョブ ページから S3 互換のスナップショット ストア間で移行することもできます。

snapshotStore.snapshotStoreType

string

条件付き

読み取りのタイプを識別する string。 現在、S3バケット（ S3ブロックストア）のみがサポートされています。値は s3blockstore である必要があります。snapshotStoreオブジェクトを指定する場合は、snapshotStoreType パラメータと snapshotStoreId パラメータの両方を指定する必要があります。

snapshotStore.snapshotStoreId

string

条件付き

移行先の S3ブロックストアを識別する string。 新しいスナップショットは、この宛先 S3ブロックストアに保存されます。既存のスナップショットは、構成された保持ポリシーに基づいて、有効期限が切れるまで、元のストアに残ります。snapshotStoreオブジェクトを指定する場合は、snapshotStoreType パラメータと snapshotStoreId パラメータの両方を指定する必要があります。

応答

名前
タイプ
説明

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

バックアップに使用されるストレージ エンジン。

snapshotStore

オブジェクト

移行先の読み取りを指定するオブジェクト。このオブジェクトには、読み取りタイプと S3バケット（ S3ブロックストア）のIDが含まれています。既存のスナップショットは、構成された保持ポリシーに基づいて、有効期限が切れるまで、元のストアに残ります。ジョブ ページから S3 互換のスナップショット ストア間で移行することもできます。

snapshotStore.snapshotStoreType

string

読み取りのタイプを識別する string。 現在、S3バケット（ S3ブロックストア）のみがサポートされています。値は s3blockstore である必要があります。snapshotStoreオブジェクトを指定する場合は、snapshotStoreType パラメータと snapshotStoreId パラメータの両方を指定する必要があります。

snapshotStore.snapshotStoreId

string

移行先の S3ブロックストアを識別する string。 新しいスナップショットは、この宛先 S3ブロックストアに保存されます。既存のスナップショットは、構成された保持ポリシーに基づいて、有効期限が切れるまで、元のストアに残ります。snapshotStoreオブジェクトを指定する場合は、snapshotStoreType パラメータと snapshotStoreId パラメータの両方を指定する必要があります。

リクエストの例

1curl --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を使用してください。 この選択により、バックアップの可用性が確保されます。

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

1curl --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       }'
1curl --user "grdktmix:c030563c-6b65-4568-88c0-82fd8c91ec07" \
2     --digest \
3     --header "Accept: application/json" \
4     --header "Content-Type: application/json" \
5     --include --request PATCH "http://<OpsManagerHost>:<Port>/api/public/v1.0/groups/{projectId}/backupConfigs/{clusterId}" \
6     --data '
7       {
8         "snapshotStore": {"snapshotStoreId":"after", "snapshotStoreType":"s3blockstore"}
9       }'

応答例

応答ヘッダー

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}

各スナップショットが開始されると、 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}
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  "snapshotStore": {
24    "snapshotStoreType": "s3blockstore",
25    "snapshotStoreId": "your-snapshot-store-id"
26  }
27}

戻る

1 つの取得

次へ

配置リージョン

項目一覧