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

1 つの S3 oplog 構成の更新

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

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

Resource

PUT /oplog/s3Configs/{S3-OPLOG-CONFIG-ID}

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

名前
タイプ
説明

S3-OPLOG-CONFIG-ID

string

この S3 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

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

名前
タイプ
必要性
説明

acceptTos

ブール値

必須

MongoDB Ops Manager で S3 互換ストレージを使用するためのサービス利用規約に同意したかどうかを示すフラグ。S3 互換ストレージ ストアを作成するには、これを true に設定する必要があります。

これをfalseに設定すると、MongoDB Ops Manager はエラーを返します。 エラーには、 MongoDB Ops Managerが S3 互換ストレージストアを作成できないことが記載されています。

割り当てEnabled

ブール値

任意

このデータ ストアにバックアップ ジョブを割り当てられるかどうかを示すフラグ。

awsAccessKey

string

条件付き

s3bucketName で指定された S3 互換ストレージバケットにアクセスできるAWSアクセス キーID 。

"s3AuthMethod" : "IAM_ROLE"の場合は、 awsAccessKeyを含める必要はありません。

awsSecretKey

string

条件付き

AWSシークレット アクセス キー。これにより、<s3BucketName> で指定された S3 互換ストレージバケットにアクセスできます。

"s3AuthMethod" : "IAM_ROLE"の場合は、 awsSecretKeyを含める必要はありません。

customCertificates

配列

任意

関連付けられている S3 互換ストレージ バケットに適用される有効な証明機関証明書のリスト。

customCertificates[n].filename

string

任意

認証局PEMファイルを識別する名前。

customCertificates[n].certString

string

任意

証明機関チェーンを構成する証明機関PEMファイルの内容。

disableProxyS3

ブール値

任意

S3 互換ストレージに接続するときに HTTP proxy を使用するかどうかを示すフラグ。MongoDB Ops Manager が HTTP proxy を使用するように構成していない限り、この値を設定する必要はありません。

encryptionCredentials

ブール値

任意

この S 3互換ストレージ oplog ストアのユーザー名とパスワードが認証情報ツールを使用して暗号化されているかどうかを示すフラグ。

labels

文字列の配列

任意

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

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

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.

If you update this store and omit the oidc object from the request, Ops Manager removes the existing OIDC configuration. To preserve the existing configuration, include the current oidc object in every update request.

clientSecret は唯一の例外です。oidc オブジェクトから clientSecret を省略するか、前の GET リクエストによって返された抽出値を送信すると、MongoDB Ops Manager は既存のシークレットを保持します。シークレットを変更するには、新しいプレーンテキスト値を送信します。

pathTypeAccessEnabled

ブール値

必須

このエンドポイントのスタイルを示すフラグ。

値
S3 oplogストア エンドポイント スタイル
例

true

パス形式のURLエンドポイント

s3.amazonaws.com/<bucket>

false

仮想ホスト スタイルのURLエンドポイント

<bucket>.s3.amazonaws.com

To review the S3-compatible storage bucket URL conventions, see the AWS S3 documentation.

s3Authメソッド

string

任意

s3bucketNameで指定された S3 互換ストレージ バケットへのアクセスを許可するために使用されるメソッド。

MongoDB Ops Manager は、次の値を受け入れます。

KEYS または なし

MongoDB Ops Managerは、 awsAccessKeyとawsSecretKeyを使用して、 s3BbucketNameで指定された S3 互換ストレージ バケットへのアクセスを許可します。

IAM_ROLE

Ops Manager は、 AWS IAM ロールを使用して、 s3bucketName で指定された S3 互換ストレージバケットへのアクセスを承認します。 awsAccessKey と awsSecretKey フィールドは無視されます。詳細については、 AWS のドキュメントを参照してください

s3bucketEndpoint

string

必須

この S3 互換ストレージバケットにアクセスするために使用されるURL 。

s3bucketName

string

必須

S 3互換ストレージ oplog ストアをホストする S 3互換ストレージ バケットの名前。

s3MaxConnections

数値

必須

この S 3互換ストレージ oplog ストアへの最大接続数を示す正の整数。

s3RegionServeride

string

条件付き

S3 互換ストレージ バケットが存在するリージョン。

このフィールドは、S3 互換ストレージストアの s3bucketEndpoint がリージョンのスコープをサポートしていない場合にのみ使用してください。このフィールドはAWS S3 バケットでは使用しないでください。

sseEnabled

ブール値

必須

この S3 互換ストレージ oplog ストアが サーバー側暗号化を有効にしているかどうかを示すフラグ。

uri

string

必須

この S 3互換ストレージ oplog ストアにアクセスできる<hostname:port>形式のホストのカンマ区切りリスト。

ssl

ブール値

任意

この S 3互換ストレージ oplog ストアがTLSを使用して暗号化された接続のみを受け入れるかどうかを示すフラグ。

writeConcern

string

任意

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

MongoDB Ops Manager は、次の値を受け入れます。

  • ACKNOWLEDGED

  • W2

  • JOURNALED

  • MAJORITY

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

応答

名前
タイプ
説明

acceptTos

ブール値

MongoDB Ops Manager で S3 互換ストレージを使用するためのサービス利用規約に同意したかどうかを示すフラグ。S3 互換ストレージ ストアを作成するには、これを true に設定する必要があります。

割り当てEnabled

ブール値

このデータ ストアにバックアップ ジョブを割り当てられるかどうかを示すフラグ。

awsAccessKey

string

AWS Access Key ID that can access the S3-compatible storage bucket specified in s3BucketName.

awsSecretKey

string

AWS Secret Access Key that can access the S3-compatible storage bucket specified in s3BucketName.

customCertificates

配列

関連付けられている S3 互換ストレージ バケットに適用される有効な証明機関証明書のリスト。

customCertificates[n].filename

string

認証局PEMファイルを識別する名前。

customCertificates[n].certString

string

証明機関チェーンを構成する証明機関PEMファイルの内容。

disableProxyS3

ブール値

S3 互換ストレージに接続するときに HTTP proxy を使用するかどうかを示すフラグ。

encryptionCredentials

ブール値

この S 3互換ストレージ oplog ストアのユーザー名とパスワードが認証情報ツールを使用して暗号化されているかどうかを示すフラグ。

id

string

この S 3互換ストレージ oplog ストアを一意に識別する名前。

labels

文字列の配列

が S 互換ストレージ ストアに割り当てることができる バックアップジョブ を管理するためのタグの配列。MongoDB Ops Manager3oplog

Links

オブジェクト配列

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

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 の場合にのみ表示されます。

pathTypeAccessEnabled

ブール値

このエンドポイントのスタイルを示すフラグ。

値
S3 oplogストア エンドポイント スタイル
例

true

パス形式のURLエンドポイント

s3.amazonaws.com/<bucket>

false

仮想ホスト スタイルのURLエンドポイント

<bucket>.s3.amazonaws.com

To review the S3-compatible storage bucket URL conventions, see the AWS S3 documentation.

s3bucketEndpoint

string

MongoDB Ops Manager がこの S3 互換ストレージバケットにアクセスするために使用するURL 。

s3bucketName

string

S 3互換ストレージ oplog ストアをホストする S 3互換ストレージ バケットの名前。

s3RegionServeride

string

S3 互換ストレージ バケットが存在するリージョン。 このフィールドは、S3 互換ストレージ ストアのs3bucketEndpointがリージョンのスコープをサポートしていない場合にのみ適用されます。

MongoDB Ops Managerは、この S3 互換ストレージ ストアを 作成 または 更新oplog したときにこのフィールドを含めた場合にのみ、このフィールドを返します。

sseEnabled

ブール値

この S3 互換ストレージ oplog ストアが サーバー側暗号化を有効にしているかどうかを示すフラグ。

ssl

ブール値

この S 3互換ストレージ oplog ストアがTLSを使用して暗号化された接続のみを受け入れるかどうかを示すフラグ。

uri

string

この S3 互換ストレージoplogストアのメタデータデータベースに接続する 接続文字列 。このデータベースは、 S3 互換ストレージバケットにブロックのロケーションを保存します。

writeConcern

string

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

MongoDB Ops Manager は、次のいずれかの値を返します。

  • 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/s3Configs/{S3-OPLOG-CONFIG-ID}?pretty=true' \
 --data '{
   "assignmentEnabled": true,
   "awsAccessKey": "access",
   "awsSecretKey": "secret",
   "encryptedCredentials": false,
   "labels": [
     "l1",
     "l2"
   ],
   "s3BucketEndpoint": "http://backup.example.com/oplog",
   "s3BucketName": "oplog",
   "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,
  "awsAccessKey": "access",
  "awsSecretKey": "secret",
  "encryptedCredentials": false,
  "id": "id",
  "labels": [
    "l1",
    "l2"
  ],
  "links": [
    {
      "href": "https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/admin/backup/oplog/s3Configs/{S3-OPLOG-CONFIG-ID}",
      "rel": "self"
    }
  ],
  "s3BucketEndpoint": "http://backup.example.com/oplog",
  "s3BucketName": "oplog",
  "uri": "mongodb://localhost:27017",
  "ssl": true,
  "writeConcern": "W2"
}
戻る
作成
次へ
削除
このページを評価

項目一覧