/ /

/ /

1 つの oplog 構成の更新

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	ブール値	任意	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`

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

名前	タイプ	説明
割り当てEnabled	ブール値	任意。このoplog ストアにバックアップジョブを割り当てることができるかどうかを示すフラグ。
encryptionCredentials	ブール値	任意。この oplog ストアのユーザー名とパスワードがcredentialstool で暗号化されているかどうかを示すフラグ。
labels	文字列の配列	任意。がどのストア MongoDB Ops Managerに割り当てることができるoplog バックアップジョブを管理するためのタグの配列。これらのタグを設定すると、この oplog ストアが処理できるバックアップジョブが制限されます。省略した場合、この oplog ストアは、ジョブをフィルタリングするためにラベルを使用しないプロジェクトのバックアップジョブのみを処理できます。
maxCapacityGB	数値	任意。OUTSIDE_SPACE_USED_THRESTアラートで使用される、 oplogストアの予想される最大利用キャパシティー。`maxCapacityGB` はバッキングデータベースのサイズに制限を適用しません。
oidc	オブジェクト	任意。 OIDC authentication settings for this store. The `oidc` object accepts the following fields: `enabled`: boolean. Enables OIDC authentication for this store. `method`: string.`callback`、`azure`、`gcp`、`k8s`のいずれか。 `tokenUri`: string. The IdP token endpoint. Required when `method` is `callback`. `clientId`: string. The client ID registered with the IdP. Required when `method` is `callback`; optional when `method` is `azure`. `clientSecret`: string. The client secret registered with the IdP. Required when `method` is `callback`. If you edit an existing store and omit this field or submit the redacted value returned by a previous `GET` request, Ops Manager preserves the existing secret. `scope`: string. The OAuth2 scope requested from the IdP. Used only when `method` is `callback`. `tokenResource`: string. The audience or resource identifier for the workload identity token. Required when `method` is `azure` or `gcp`. This value must match the `audience` configured for this IdP in the target MongoDB deployment's `oidcIdentityProviders` setting. `callback`、`azure`、`gcp`、`k8s` メソッドでは、必要なフィールドが全て同じとは限りません。`azure`、`gcp`、`k8s` メソッドでは `clientSecret` は必要ありません。 `oidc.enabled` が `true` の場合は、ストアの `uri` フィールドにホストと接続オプションのみを提供します。MongoDB Ops Manager は、URI に埋め込まれたユーザー名またはパスワードを無視します。 To switch a store from OIDC to another authentication mechanism, submit `oidc: {enabled: false}` in the request instead of omitting the `oidc` object.
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	数値	任意。OUTSIDE_SPACE_USED_THRESTアラートで使用される、 oplogストアの予想される最大利用キャパシティー。`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	この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 構成の更新

Resource

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

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

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

応答

リクエストの例

応答例

応答ヘッダー

レスポンス本体

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

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

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