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

GET /groups/{PROJECT-ID}/backupConfigs

Request Parameters

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

名前	タイプ	必要性	説明
プロジェクトID	string	必須	バックアップ構成が適用されるプロジェクトを識別する一意の 24 桁の 16 進数のstring 。

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

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

名前	タイプ	必要性	説明	default
pageNum	数値	任意	結果のサブセクションを返す 1 から始まる整数。	`1`
itemsPerPage	数値	任意	1 ページあたりに返す項目の数は最大 500 です。	`100`
pretty	ブール値	任意	レスポンス本体を pretty-print に含めるかどうかを示すフラグ形式。	`false`
envelope	ブール値	任意	応答をエンベロープでラップするかどうかを示すフラグ。一部の APIクライアントは、 HTTPレスポンスヘッダーまたはステータスコードにアクセスできません。これを修正するには、クエリで`envelope : true`を設定します。結果のリストを返すエンドポイントの場合、 `results`オブジェクトはエンベロープです。 MongoDB Ops Manager は、レスポンス本体に`status`フィールドを追加します。	`false`
backupJobsEnabledOnly	ブール値	任意	データベースのバックアップ用に有効になっていないデーモンを応答から除外するかどうかを示すフラグ。これを`false`に設定し、 `backupJobsEnabled`フラグが`false`に設定されているデーモン構成を含めます。	`true`

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

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

応答

名前	タイプ	説明
グループ ID	string	このバックアップ構成を所有するプロジェクトを識別する一意の 24 桁の 16 進数string 。
clusterId	string	検索対象のバックアップ構成を持つクラスターを識別する、一意な 24 桁の 16 進数string 。
statusName	string	バックアップ構成の現在の（または希望）ステータス。可能な値は次のとおりです。 `INACTIVE` `PROVISIONING` `STARTED` `STOPPED` `TERMINATING`
storageEngineName	string	バックアップに使用されるストレージエンジン。可能な値は次のとおりです。 `MEMORY_MAPPED` `WIRED_TIGER`

encryptionEnabled	ブール値	バックアップ構成の暗号化が有効になっているかどうかを示すフラグ。バックアップ構成の暗号化を有効にするときは、 `syncSource`フィールドを含める必要があります。プロジェクト内の既存のバックアップの場合、暗号化を有効にするにはバックアップのヘッドデータベースを再作成するための最初の同期が必要です。 FCV `4.2` 以降では、ヘッドデータベースの代わりにバックアップカーソルを使用します。詳しくは、「バックアップデーモンサービス」を参照してください。 FCV 4.2 以降のバックアップ暗号化の詳細については、「暗号化されたバックアップスナップショット」を参照してください。

sslEnabled	ブール値	同期ソースデータベースでTLSが有効になっているかどうかを示すフラグ。
excludedNamespaces	string 配列	バックアップから省略するデータベース名とコレクション名のリスト。各stringは、`<database>` または `<database>.<collection>` の形式の名前空間です。このフィールドが存在する場合、 `includedNamespaces`フィールドは存在できません。すでにリストされている名前空間を含む、除外された名前空間の新しい完全なリストを送信する必要があります。新しいリストで前のリストからすべての名前空間が削除される場合は、除外された名前空間の削除には完全な再同期が必要になるため、 `syncSource`フィールドも設定する必要があります。 `syncSource`フィールドがない場合、リクエストは失敗します。新しいリストが前のリストにのみ追加される場合は、 `syncSource`を設定する必要はありません。
includeNamespaces	string 配列	バックアップに含めるデータベース名とコレクション名のリスト。各stringは、`<database>` または `<database>.<collection>` の形式の名前空間です。この配列にリストされていない名前空間はバックアップされません。このフィールドが存在する場合、 `excludedNamespaces`フィールドは存在できません。すでにリストされている名前空間を含む、含まれている名前空間の新しい完全なリストを送信する必要があります。新しいリストで前のリストに名前空間が追加される場合は、含まれている名前空間を追加するには完全な再同期が必要になるため、 `syncSource`フィールドも設定する必要があります。 `syncSource`フィールドがない場合、リクエストは失敗します。新しいリストで前のリストから名前空間のみが削除される場合は、 `syncSource`を設定する必要はありません。

リクエストの例

curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
     --header "Accept: application/json" \
     --include \
     --request GET "https://{opsManagerHost}:{port}/api/public/v1.0/groups/{PROJECT-ID}/backupConfigs"

応答例

応答ヘッダー

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   "totalCount" : 3,
3   "results" : [ {
4     "groupId" : "{PROJECT-ID}",
5     "clusterId" : "{CLUSTER-ID1}",
6     "statusName" : "STARTED",
7     "storageEngineName" : "WIRED_TIGER",
8     "sslEnabled" : false,
9     "excludedNamespaces" : [ ],
10     "includedNamespaces" : [ ],
11     "links" : [ ]
12   }, {
13     "groupId" : "{PROJECT-ID}",
14     "clusterId" : "{CLUSTER-ID2}",
15     "statusName" : "STARTED",
16     "storageEngineName" : "MEMORY_MAPPED",
17     "sslEnabled" : false,
18     "excludedNamespaces" : [ ],
19     "includedNamespaces" : [ ],
20     "links" : [ ]
21   }, {
22     "groupId" : "{PROJECT-ID}",
23     "clusterId" : "{CLUSTER-ID3}",
24     "statusName" : "STOPPED",
25     "storageEngineName" : "WIRED_TIGER",
26     "sslEnabled" : false,
27     "excludedNamespaces" : [ ],
28     "includedNamespaces" : [ ],
29     "links" : [ ]
30   } ],
31   "links" : [ ]
32 }

戻る

バックアップ構成

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

1	{
2	"totalCount" : 3,
3	"results" : [ {
4	"groupId" : "{PROJECT-ID}",
5	"clusterId" : "{CLUSTER-ID1}",
6	"statusName" : "STARTED",
7	"storageEngineName" : "WIRED_TIGER",
8	"sslEnabled" : false,
9	"excludedNamespaces" : [ ],
10	"includedNamespaces" : [ ],
11	"links" : [ ]
12	}, {
13	"groupId" : "{PROJECT-ID}",
14	"clusterId" : "{CLUSTER-ID2}",
15	"statusName" : "STARTED",
16	"storageEngineName" : "MEMORY_MAPPED",
17	"sslEnabled" : false,
18	"excludedNamespaces" : [ ],
19	"includedNamespaces" : [ ],
20	"links" : [ ]
21	}, {
22	"groupId" : "{PROJECT-ID}",
23	"clusterId" : "{CLUSTER-ID3}",
24	"statusName" : "STOPPED",
25	"storageEngineName" : "WIRED_TIGER",
26	"sslEnabled" : false,
27	"excludedNamespaces" : [ ],
28	"includedNamespaces" : [ ],
29	"links" : [ ]
30	} ],
31	"links" : [ ]
32	}

注意