1 つの oplog 構成の更新

項目一覧

Resource

リクエストパスパラメーター
リクエストクエリパラメータ
リクエストボディパラメータ
応答
リクエストの例
応答例
応答ヘッダー
レスポンス本体

1 つの oplog ストアの構成を更新します。

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

Resource

PUT /oplog/mongoConfigs/{OPLOG-CONFIG-ID}

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

名前	タイプ	説明
OPLOG-CONFIG-ID	string	このoplog構成を表す一意の識別子。

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

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

名前

タイプ

必要性

説明

default

pretty

ブール値

任意

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

false

envelope

ブール値

任意

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

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

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

名前	説明
`status`	HTTPレスポンスコード
`content`	期待される応答本体

false

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

名前	タイプ	説明
割り当てEnabled	ブール値	任意。このoplog ストアにバックアップジョブを割り当てることができるかどうかを示すフラグ。
encryptionCredentials	ブール値	任意。この oplog ストアのユーザー名とパスワードが認証情報ツールを使用して暗号化されているかどうかを示すフラグ。
labels	文字列の配列	任意。がどのストア MongoDB Ops Managerに割り当てることができるoplog バックアップジョブを管理するためのタグの配列。これらのタグを設定すると、この oplog ストアが処理できるバックアップジョブが制限されます。省略した場合、この oplog ストアは、ジョブをフィルタリングするためにラベルを使用しないプロジェクトのバックアップジョブのみを処理できます。
maxCapacityGB	数値	任意。このoplog ストアが保存できるデータの最大量（GB 単位）。
uri	string	このoplog ストアにアクセスするために使用できる`<hostname:port>`形式のホストのカンマ区切りリスト。
ssl	ブール値	任意。この oplog ストアがTLSを使用して暗号化された接続のみを受け入れるかどうかを示すフラグ。
writeConcern	string	任意。このoplog ストアに使用される書込み保証 (write concern) です。このオプションに指定できる値は以下のとおりです。 `ACKNOWLEDGED` `W2` `JOURNALED` `MAJORITY` MongoDB の書込み (write) 確認応答レベルの詳細については、「書込み保証 (write concern) 」を参照してください。

応答

名前	タイプ	説明
割り当てEnabled	ブール値	このoplog ストアにバックアップジョブを割り当てることができるかどうかを示すフラグ。
encryptionCredentials	ブール値	この oplog ストアのユーザー名とパスワードがcredentialstool で暗号化されているかどうかを示すフラグ。
id	string	このoplog ストアにラベルを付ける一意の名前。
labels	文字列の配列	がどのストア MongoDB Ops Managerに割り当てることができるoplog バックアップジョブを管理するためのタグの配列。
Links	オブジェクト配列	サブリソースや関連リソースへの 1 つ以上のリンク。応答内のすべての`links`配列には、 `self`と呼ばれるリンクが少なくとも 1 つ含まれています。 URL の関係は、 Web リンク仕様で説明されています。
maxCapacityGB	数値	このoplog ストアが保存できるデータの最大量（GB 単位）。
uri	string	このoplog ストアにアクセスするために使用できる`<hostname:port>`形式のホストのカンマ区切りリスト。
ssl	ブール値	この oplog ストアがTLSを使用して暗号化された接続のみを受け入れるかどうかを示すフラグ。
usedSize	数値	既存のバックアップが消費するバックアップ容量の量（ MB単位）。
writeConcern	string	このoplog ストアに使用される書込み保証 (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/oplog/mongoConfigs/{OPLOG-CONFIG-ID}?pretty=true' \
 --data '{
  "assignmentEnabled" : true,
  "encryptedCredentials" : false,
  "labels" : [ "l1", "l2" ],
  "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" : "{CONFIG-ID}",
  "labels" : [ "l1", "l2" ],
  "links" : [ {
    "href" : "https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/admin/backup/oplog/mongoConfigs/{OPLOG-CONFIG-ID}",
    "rel" : "self"
  }],
  "maxCapacityGB" : 8,
  "uri" : "mongodb://localhost:27017",
  "ssl" : true,
  "usedSize" : 222,
  "writeConcern" : "W2"
}

戻る

1 つの oplog 構成を作成する

1 つの oplog 構成を削除