すべてのプロジェクトのバックアップジョブの構成を取得します。
ベース URL: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/admin/backup
Resource
GET /groupsリクエスト パス パラメーター
このエンドポイントは、HTTP リクエスト パス パラメーターを使用しません。
リクエスト クエリ パラメータ
次のクエリ パラメータは 任意です。
名前 | タイプ | 必要性 | 説明 | default |
|---|---|---|---|---|
pageNum | 数値 | 任意 | 結果のサブセクションを返す 1 から始まる整数。 |
|
itemsPerPage | 数値 | 任意 | 1 ページあたりに返す項目の数は最大 500 です。 |
|
pretty | ブール値 | 任意 | レスポンス本体を pretty-print形式にするかどうかを示すフラグ。 |
|
envelope | ブール値 | 任意 | 応答をエンベロープでラップするかどうかを示すフラグ。 一部の API クライアントは、HTTP レスポンス ヘッダーまたはステータス コードにアクセスできません。これを修正するには、クエリで 結果のリストを返すエンドポイントの場合、 |
|
リクエスト ボディ パラメータ
このエンドポイントは、HTTP リクエスト本体パラメータを使用しません。
応答
応答ドキュメント
応答JSONドキュメントには、resultオブジェクトの配列、linkオブジェクトの配列、および検索されたresultオブジェクトの合計数のカウントが含まれます。
名前 | タイプ | 説明 |
|---|---|---|
| 配列 | 配列には、 |
| 配列 | 配列には、サブリソースや関連リソースへの 1 つ以上のリンクが含まれます。 URL 間の関係は、 Web リンク仕様 で説明されています。 |
| 数値 | 結果セット内の項目の合計数の整数。 結果セット全体がページ分割される場合は、 results配列内のオブジェクト数よりも大きくなる可能性があります。 |
results embeddedDocument
各結果は 1 つのプロジェクトのバックアップジョブです。
名前 | タイプ | 説明 |
|---|---|---|
damonFilter | オブジェクト配列 | このプロジェクトのバックアップジョブが制限されるバックアップデーモンのホストとそのヘッドディレクトリのペアの配列。 |
damonFilter.headRootDirectory | string | この バックアップデーモン ホスト上の ヘッドディレクトリ のルート相対パス。 |
デーモンフィルター.マシン | string | 1 つのバックアップデーモンホストのホスト アドレス。 |
id | string | このプロジェクトとそのバックアップジョブ構成を表す一意の識別子。 |
kmipClientCertPassword | string | KMIPクライアント証明書を暗号化するパスワード。 |
kmipClientCertPath | string | KMIP クライアント証明書を保存する バックアップデーモン ホスト上のディレクトリへのパス。 |
Links | オブジェクト配列 | サブリソースまたは関連リソースへの 1 つ以上のリンク。応答内のすべての |
labelsFilter | 文字列の配列 | このプロジェクトの バックアップジョブ を処理できる バックアップデーモン と スナップショット ストア を制限するタグの配列。 |
oplogStoreFilter | オブジェクトの配列 | このプロジェクトのバックアップジョブで使用される可能性のあるoplogストアを表す一意の識別子の配列。 |
oplogStoreFilter.id | string | このプロジェクトのバックアップジョブで使用可能なoplog ストアを表す一意の識別子。 |
oplogStoreFilter.type | string | |
snapshotStoreFilter | オブジェクトの配列 | このプロジェクトのバックアップジョブで使用できる特定のスナップショット ストアとそのタイプを表す一意な識別子の配列。 省略すると、使用可能なすべてのスナップショット ストアが使用されます。 |
snapshotStoreFilter.id | string | このプロジェクトのバックアップジョブで使用できる特定のスナップショット ストアを表す一意の識別子。 |
snapshotStoreFilter.type | string |
このオプションに指定できる値は以下のとおりです。
|
syncStoreFilter | 文字列の配列 | このプロジェクトのバックアップジョブで使用できる同期ストア フィルターの配列。 省略すると、利用可能なすべての同期ストアが使用されます。 |
リクエストの例
curl --user '{PUBLIC-KEY}:{PRIVATE-KEY}' --digest \ --header 'Accept: application/json' \ --include \ --request GET 'https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/admin/backup/groups?pretty=true'応答例
応答ヘッダー
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-aliveHTTP/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}レスポンス本体
{ "links" : [ { "href" : "http://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/admin/backup/groups?pretty=true&pageNum=1&itemsPerPage=100", "rel" : "self" } ], "results" : [ { "daemonFilter" : [ { "headRootDirectory" : "/data/backup", "machine" : "http://backup.example.com" } ], "id" : "{PROJECT-ID}", "kmipClientCertPassword" : "P4$$w0rD", "kmipClientCertPath" : "/certs/kmip", "labelFilter" : [ "label1", "label2" ], "links" : [ { "href" : "https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/admin/backup/groups/{PROJECT-ID}", "rel" : "self" }, { "href" : "https://{OPSMANAGER-HOST}:{PORT}/api/public/groups/{PROJECT-ID}", "rel" : "http://mms.mongodb.com/group" } ], "oplogStoreFilter" : [ { "id" : "oplog1", "type" : "oplogStore" } ], "snapshotStoreFilter" : [ { "id" : "sPid", "type" : "s3blockstore" } ], "syncStoreFilter" : [ "s1", "s2" ] } ], "totalCount" : 1}