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

ID を使用して 1 つのブロックストア構成を取得する

1 つのブロックストアの構成を検索します。

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

Resource

GET /snapshot/mongoConfigs/{BLOCKSTORE-ID}

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

名前
タイプ
説明

BLOCKSTORE-ID

string

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

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

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

名前
タイプ
必要性
説明
default

pretty

ブール値

任意

Flag indicating whether the response body is in a prettyprint format.

false

envelope

ブール値

任意

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

Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query.

1 つの結果を返すエンドポイントの場合、レスポンス本体には次のものが含まれます。

  • status: HTTP response code

  • content: 期待される応答本体

false

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

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

応答

名前
タイプ
説明

割り当て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 authentication settings for this store. The oidc object contains the following fields:

  • enabled: boolean. Indicates whether OIDC authentication is enabled for this store.

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

  • tokenUri: string. The IdP token endpoint. Present only when method is callback.

  • clientId: string. The client ID registered with the IdP.

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

  • scope: string. The OAuth2 scope requested from the IdP. Present only when method is 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/{BLOCKSTORE-ID}?pretty=true'

応答例

応答ヘッダー

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}

レスポンス本体

{
  "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-ID}",
    "rel" : "self"
  }],
  "loadFactor" : 2,
  "maxCapacityGB" : 8,
  "uri" : "mongodb://localhost:27017",
  "ssl" : true,
  "usedSize" : 222,
  "writeConcern" : "W2"
}
戻る
Blockstore
次へ
すべて取得
このページを評価

項目一覧