/ /

/ /

1 つのブロックストア構成の更新

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

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

Resource

PUT /snapshot/mongoConfigs/{BLOCKSTORE-ID}

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

名前	タイプ	説明
BLOCKSTORE-ID	string	このブロックストア構成にラベルを付ける一意の名前。

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

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

名前	タイプ	必要性	説明	default
pretty	ブール値	任意	レスポンス本体をpretty-print形式にするかどうかを示すフラグ。	`false`
envelope	ブール値	任意	応答をエンベロープでラップするかどうかを示すフラグ。一部のAPIクライアントは、 HTTPレスポンスヘッダーまたはステータスコードにアクセスできません。これを修正するには、クエリでenvelope=trueを設定します。 1 つの結果を返すエンドポイントの場合、レスポンス本体には次のものが含まれます。 `status`: HTTP レスポンスコード `content`: 期待される応答本体	`false`

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

名前	タイプ	説明
割り当てEnabled	ブール値	任意。このブロックストアにバックアップジョブを割り当てることができるかどうかを示すフラグ。
encryptionCredentials	ブール値	任意。このブロックストアのユーザー名とパスワードがブロックストアで暗号化されているかどうかを示すフラグ。
labels	文字列の配列	任意。がどのブロックストアに割り当てることができる MongoDB Ops Managerバックアップジョブを管理するためのタグの配列。これらのタグを設定すると、このブロックストアが処理できるバックアップジョブが制限されます。省略した場合、このブロックストアは、ジョブをフィルタリングするためにラベルを使用しないプロジェクトのバックアップジョブのみを処理できます。
loadFactory	数値	任意。このスナップショットストアが別のスナップショットストアと比較して実行するバックアップ作業量を表すゼロ以外の正の整数。このオプションは、複数のスナップショットストアが使用されている場合にのみ必要です。 Load Factorの詳細については、「 1 つの既存のブロックストアの編集」を参照してください。
maxCapacityGB	数値	任意。OUTSIDE_SPACE_USED_thresholdアラートで使用されるブロックストアの予想最大利用キャパシティー。`maxCapacityGB` はバッキングデータベースのサイズに制限を適用しません。
oidc	オブジェクト	任意。このストアの OIDC 認証設定。`oidc` オブジェクトは次のフィールドを受け入れます。 `enabled`: ブール値.このストアの OIDC 認証を有効にします。 `method`: string.`callback`、`azure`、`gcp`、`k8s`のいずれか。 `tokenUri`: string.IdP トークンエンドポイントとなる接続されたデバイス。`method` が `callback` の場合に必要です。 `clientId`: string.IdP に登録されているクライアント ID。`method` が `callback` の場合は必須。`method` が `azure` の場合は任意。 `clientSecret`: string.IdP に登録されたクライアントシークレット。`method` が `callback` の場合に必要です。既存のストアを編集してこのフィールドを省略した場合、または前の `GET` リクエストで返された隱匿値を提出した場合、MongoDB Ops Manager は既存のシークレットを維持します。 `scope`: string.IdP から要求された OAuth2 スコープ。`method` が `callback` の場合にのみ使用されます。 `tokenResource`: string.ワークロードアイデンティティトークンのオーディエンスまたはリソース識別子。`method` が `azure` または `gcp` の場合に必要です。この値は、ターゲット MongoDB 配置の `oidcIdentityProviders` 設定でこの IdP に設定されている `audience` と一致する必要があります。 `callback`、`azure`、`gcp`、`k8s` メソッドでは、必要なフィールドが全て同じとは限りません。`azure`、`gcp`、`k8s` メソッドでは `clientSecret` は必要ありません。 `oidc.enabled` が `true` の場合は、ストアの `uri` フィールドにホストと接続オプションのみを提供します。MongoDB Ops Manager は、URI に埋め込まれたユーザー名またはパスワードを無視します。ストアを OIDC から別の認証メカニズムに切り替えるには、リクエストで `oidc` オブジェクトを省略する代わりに `oidc: {enabled: false}` を送信します。
uri	string	このブロックストアにアクセスするために使用できる`<hostname:port>`形式のホストのカンマ区切りリスト。
ssl	ブール値	任意。このブロックストアがTLSを使用して暗号化された接続のみを受け入れるかどうかを示すフラグ。
writeConcern	string	任意。このブロックストアに使用された書込み保証 (write concern )。このオプションに指定できる値は以下のとおりです。 `ACKNOWLEDGED` `W2` `JOURNALED` `MAJORITY` MongoDB の書込み (write) 確認応答レベルの詳細については、「書込み保証 (write concern) 」を参照してください。

応答

名前	タイプ	説明
割り当て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 トークンエンドポイントとなる接続されたデバイス。`method` が `callback` の場合にのみ表示されます。 `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' \
 --header 'Content-Type: application/json' \
 --include \
 --request PUT 'https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/admin/backup/snapshot/mongoConfigs/{BLOCKSTORE-ID}?pretty=true' \
 --data '{
  "assignmentEnabled" : true,
  "encryptedCredentials" : false,
  "labels" : [ "l1", "l2" ],
  "loadFactor" : 2,
  "maxCapacityGB" : 8,
  "uri" : "mongodb://localhost:27017",
  "ssl" : true,
  "writeConcern" : "W2"
}'

応答例

応答ヘッダー

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"
}

戻る

作成

削除

1 つのブロックストア構成の更新

Resource

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

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

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

応答

リクエストの例

応答例

応答ヘッダー

レスポンス本体

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

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

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