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

1 つの oplog 構成の更新

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

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

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 ストアのユーザー名とパスワードがcredentialstool で暗号化されているかどうかを示すフラグ。

labels

文字列の配列

任意。 がどの ストア MongoDB Ops Managerに割り当てることができるoplog バックアップ ジョブ を管理するためのタグの配列。

これらのタグを設定すると、この oplog ストアが処理できるバックアップジョブが制限されます。 省略した場合、この oplog ストアは、ジョブをフィルタリングするためにラベルを使用しないプロジェクトのバックアップ ジョブのみを処理できます。

maxCapacityGB

数値

任意。OUTSIDE_SPACE_USED_THRESTアラートで使用される、 oplogストアの予想される最大利用キャパシティー。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

このoplog ストアにアクセスするために使用できる<hostname:port>形式のホストのカンマ区切りリスト。

ssl

ブール値

Optional. Flag indicating whether this oplog store only accepts connections encrypted using TLS.

writeConcern

string

任意。 このoplog ストアに使用される書込み保証 (write concern) です。

このオプションに指定できる値は以下のとおりです。

  • ACKNOWLEDGED

  • W2

  • JOURNALED

  • MAJORITY

MongoDB の書込み (write) 確認応答レベルの詳細については、「 書込み保証 (write concern) 」を参照してください。

名前
タイプ
説明

割り当てEnabled

ブール値

このoplog ストアにバックアップジョブを割り当てることができるかどうかを示すフラグ。

encryptionCredentials

ブール値

この oplog ストアのユーザー名とパスワードがcredentialstool で暗号化されているかどうかを示すフラグ。

id

string

labels

文字列の配列

がどの ストア MongoDB Ops Managerに割り当てることができるoplog バックアップ ジョブ を管理するためのタグの配列。

Links

オブジェクト配列

サブリソースまたは関連リソースへの 1 つ以上のリンク。応答内のすべての links 配列には、self と呼ばれるリンクが少なくとも 1 つ含まれています。URLの関係は、Web リンク仕様で説明されています。

maxCapacityGB

数値

任意。OUTSIDE_SPACE_USED_THRESTアラートで使用される、 oplogストアの予想される最大利用キャパシティー。maxCapacityGB は バッキングデータベースのサイズに制限を適用しません。

oidc

オブジェクト

このストアの OIDC 認証設定。oidc オブジェクトには、次のフィールドが含まれています:

  • enabled: ブール値。このストアで OIDC 認証が有効になっているかどうかを示します。

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

  • tokenUri: string.IdP エンドポイントとなる接続されたデバイス。methodcallback{1}が{2}の場合にのみ表示されます。

  • clientId: string.IdP に登録されているクライアント ID。

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

  • scope: string.IdP からリクエストされた OAuth2 スコープ。method が 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 UnauthorizedContent-Type: application/json;charset=ISO-8859-1Date: {dateInUnixFormat}WWW-Authenticate: Digest realm="MMS Public API", domain="", nonce="{nonce}", algorithm=MD5, op="auth", stale=falseContent-Length: {requestLengthInBytes}Connection: keep-alive
HTTP/1.1 200 OKVary: Accept-EncodingContent-Type: application/jsonStrict-Transport-Security: max-age=300Date: {dateInUnixFormat}Connection: keep-aliveContent-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"}