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 つの結果を返すエンドポイントの場合、レスポンス本体には次のものが含まれます。
| false |
リクエスト ボディ パラメータ
名前 | タイプ | 説明 |
|---|---|---|
割り当てEnabled | ブール値 | 任意。 このブロックストアにバックアップジョブを割り当てることができるかどうかを示すフラグ。 |
encryptionCredentials | ブール値 | 任意。 このブロックストアのユーザー名とパスワードが認証情報ツールを使用して暗号化されているかどうかを示すフラグ。 |
labels | 文字列の配列 | 任意。 がどのブロックストアに割り当てることができる MongoDB Ops Managerバックアップ ジョブ を管理するためのタグの配列 。 これらのタグを設定すると、このブロックストアが処理できるバックアップジョブが制限されます。 省略した場合、このブロックストアは、ジョブをフィルタリングするためにラベルを使用しないプロジェクトのバックアップ ジョブのみを処理できます。 |
loadFactory | 数値 | 任意。 このスナップショットストアが別のスナップショットストアと比較して実行するバックアップ作業量を表すゼロ以外の正の整数。 このオプションは、複数のスナップショット ストアが使用されている場合にのみ必要です。 Load Factorの詳細については、 「 1 つの既存のブロックストアの編集 」を参照してください。 |
maxCapacityGB | 数値 | 任意。 このブロックストアが保存できるデータの最大量（GB 単位）。 |
uri | string | このブロックストアにアクセスするために使用できる <hostname:port>形式のホストのカンマ区切りリスト。 |
ssl | ブール値 | 任意。 このブロックストアがTLSを使用して暗号化された接続のみを受け入れるかどうかを示すフラグ。 |
writeConcern | string | 任意。 このブロックストアに使用された書込み保証 (write concern )。 このオプションに指定できる値は以下のとおりです。
MongoDB の書込み (write) 確認応答レベルの詳細については、「 書込み保証 (write concern) 」を参照してください。 |
応答
名前 | タイプ | 説明 |
|---|---|---|
割り当てEnabled | ブール値 | このブロックストアにバックアップジョブを割り当てることができるかどうかを示すフラグ。 |
encryptionCredentials | ブール値 | このブロックストアのユーザー名とパスワードが credentialstool で暗号化されているかどうかを示すフラグ。 |
id | string | このブロックストアにラベルを付ける一意の名前。 |
labels | 文字列の配列 | がどのブロックストアに割り当てることができる MongoDB Ops Managerバックアップ ジョブ を管理するためのタグの配列 。 |
Links | オブジェクト配列 | サブリソースや関連リソースへの 1 つ以上のリンク。 応答内のすべての |
loadFactory | 数値 | このスナップショットストアが別のスナップショットストアと比較して実行するバックアップ作業量を表すゼロ以外の正の整数。 このオプションは、複数のスナップショット ストアが使用されている場合にのみ必要です。 Load Factorの詳細については、 「 1 つの既存のブロックストアの編集 」を参照してください。 |
maxCapacityGB | 数値 | このブロックストアが保存できるデータの最大量（GB 単位）。 |
uri | string | このブロックストアにアクセスするために使用できる <hostname:port>形式のホストのカンマ区切りリスト。 |
ssl | ブール値 | このブロックストアがTLSを使用して暗号化された接続のみを受け入れるかどうかを示すフラグ。 |
usedSize | 数値 | 既存のバックアップが消費するバックアップ容量の量（ MB単位）。 |
writeConcern | string | このブロックストアに使用された書込み保証 (write concern )。 このオプションに指定できる値は以下のとおりです。
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" }'
応答例
応答ヘッダー
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
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" }