AI エージェント向け: ドキュメントインデックスは https://www.mongodb.com/ja-jp/docs/llms.txt で利用できます。すべてのページの markdown バージョンは、いずれかの URL パスに .md を追加することで利用できます。

すべてのブロックストア構成を取得する

すべてのブロックストアの構成を取得します。

ベース URL: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/admin/backup

GET /snapshot/mongoConfigs

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

名前
タイプ
必要性
説明
default

pageNum

数値

任意

結果のサブセクションを返す 1 から始まる整数。

1

itemsPerPage

数値

任意

1 ページあたりに返す項目の数は最大 500 です。

100

pretty

ブール値

任意

レスポンス本体を pretty-print形式にするかどうかを示すフラグ。

false

envelope

ブール値

任意

応答をエンベロープでラップするかどうかを示すフラグ。

一部の API クライアントは、HTTP レスポンス ヘッダーまたはステータス コードにアクセスできません。これを修正するには、クエリで envelope : true を設定します。

結果のリストを返すエンドポイントの場合、 contentオブジェクトはエンベロープです。 MongoDB Ops Manager は、レスポンス本体にstatusフィールドを追加します。

false

assignableOnly

ブール値

任意

新しいバックアップジョブを割り当てることができるブロックストアのみを返すかどうかを示します。

true

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

応答JSONドキュメントには、resultオブジェクトの配列、linkオブジェクトの配列、および検索されたresultオブジェクトの合計数のカウントが含まれます。

名前
タイプ
説明

results

配列

配列には、results 埋め込みドキュメント セクションに詳細な項目ごとに 1 つのオブジェクトが含まれます。

links

配列

配列には、サブリソースや関連リソースへの 1 つ以上のリンクが含まれます。 URL 間の関係は、 Web リンク仕様 で説明されています。

totalCount

数値

結果セット内の項目の合計数の整数。 結果セット全体がページ分割される場合は、 results配列内のオブジェクト数よりも大きくなる可能性があります。

各結果は 1 つのブロックストアです。

名前
タイプ
説明

割り当てEnabled

ブール値

このブロックストアにバックアップジョブを割り当てることができるかどうかを示すフラグ。

encryptionCredentials

ブール値

このブロックストアのユーザー名とパスワードが credentialstool で暗号化されているかどうかを示すフラグ。

id

string

このブロックストアにラベルを付ける一意の名前。

labels

文字列の配列

がどのブロックストアに割り当てることができる MongoDB Ops Managerバックアップ ジョブ を管理するためのタグの配列 。

Links

オブジェクト配列

サブリソースまたは関連リソースへの 1 つ以上のリンク。応答内のすべての links 配列には、self と呼ばれるリンクが少なくとも 1 つ含まれています。URLの関係は、Web リンク仕様で説明されています。

loadFactory

数値

このスナップショットストアが別のスナップショットストアと比較して実行するバックアップ作業量を表すゼロ以外の正の整数。 このオプションは、複数のスナップショット ストアが使用されている場合にのみ必要です。

Load Factorの詳細については、 「 1 つの既存のブロックストアの編集 」を参照してください。

maxCapacityGB

数値

任意。OUTSIDE_SPACE_USED_thresholdアラートで使用されるブロックストアの予想最大利用キャパシティー。maxCapacityGB は バッキングデータベースのサイズに制限を適用しません。

oidc

オブジェクト

このストアの OIDC 認証設定。oidc オブジェクトには、次のフィールドが含まれています:

  • enabled: ブール値。このストアで OIDC 認証が有効になっているかどうかを示します。

  • method: string.callback、azure、gcp、k8sのいずれか。

  • tokenUri: string.IdP エンドポイントとなる接続されたデバイス。methodcallback{1}が{2}の場合にのみ表示されます。

  • clientId: string.IdP に登録されているクライアント ID。

  • clientSecret: string.MongoDB Ops Manager は応答でこの値を難読化し、生のクライアント シークレットを返しません。

  • scope: string.IdP からリクエストされた OAuth2 スコープ。method が callback の場合にのみ表示されます。

  • tokenResource: string.ワークロードアイデンティティトークンのオーディエンスまたはリソース識別子。method が azure または gcp の場合にのみ表示されます。

uri

string

このブロックストアにアクセスするために使用できる<hostname:port>形式のホストのカンマ区切りリスト。

ssl

ブール値

このブロックストアがTLSを使用して暗号化された接続のみを受け入れるかどうかを示すフラグ。

usedSize

数値

既存のバックアップが消費するバックアップ容量の量( MB単位)。

writeConcern

string

このブロックストアに使用された書込み保証 (write concern )。

このオプションに指定できる値は以下のとおりです。

  • ACKNOWLEDGED

  • W2

  • JOURNALED

  • MAJORITY

MongoDB の書込み (write) 確認応答レベルの詳細については、「 書込み保証 (write concern) 」を参照してください。

curl --user '{PUBLIC-KEY}:{PRIVATE-KEY}' --digest \ --header 'Accept: application/json' \ --include \ --request GET 'https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/admin/backup/snapshot/mongoConfigs?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-alive
HTTP/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/snapshot/mongoConfigs?pretty=true&pageNum=1&itemsPerPage=100", "rel" : "self" } ], "results" : [ { "assignmentEnabled" : true, "encryptedCredentials" : false, "id" : "{BLOCKSTORE-CONFIG-ID}", "labels" : [ "l1", "l2" ], "links" : [ { "href" : "https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/admin/backup/snapshot/mongoConfigs/{BLOCKSTORE-CONFIG-ID}", "rel" : "self" }], "loadFactor" : 2, "maxCapacityGB" : 8, "uri" : "mongodb://localhost:27017", "ssl" : true, "usedSize" : 222, "writeConcern" : "W2" } ], "totalCount" : 1}