/ /

単一の S3 ブロックストア構成を更新 (v2.0)

1 つの S3 互換ストレージストレージブロックストア構成を更新します。 v2.0 リソースはkeyVault オブジェクトを追加します。このオブジェクトを使用すると、S3 互換ストレージブロックストアはHashiCorp Vault からAWS認証情報を読み取ります。詳細については、「スナップショットストアの認証情報用の HashiCorp Vault 」を参照してください。

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

Resource

PUT /snapshot/s3Configs/{S3-BLOCKSTORE-CONFIG-ID}

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

名前	タイプ	説明
S3-BLOCKSTORE-CONFIG-ID	string	この S3 互換のストレージブロックストア構成にラベルを付ける一意の名前。

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

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

名前	タイプ	必要性	説明	default
pretty	ブール値	任意	レスポンス本体が pretty-print形式であるかどうかを示すフラグ。	`false`
envelope	ブール値	任意	応答をエンベロープでラップするかどうかを示すフラグ。一部のAPIクライアントは、 HTTPレスポンスヘッダーまたはステータスコードにアクセスできません。これを修正するには、クエリで envelope=true を設定します。 1 つの結果を返すエンドポイントの場合、レスポンス本体には次のものが含まれます。 `status`: HTTPレスポンスコード `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

ブール値

任意

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

labels

文字列の配列

任意

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

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

loadFactory

数値

任意

このスナップショットストアが別のスナップショットストアと比較して実行するバックアップ作業量を表すゼロ以外の正の整数。このオプションは、複数のスナップショットストアが使用されている場合にのみ必要です。

Load Factorの詳細については、「 1 つの既存のブロックストアの編集」を参照してください。

objectLockEnabled

ブール値

任意

S3バケット内のオブジェクトが削除されないようにオブジェクトロックが有効になっているかどうかを示すフラグ。

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リクエストによって返されたリダクションされた値を送信すると、Ops Manager は既存のシークレットを保持します。
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 に埋め込まれたユーザー名またはパスワードを無視します。

ストアを OIDC から別の認証メカニズムに切り替えるには、oidcオブジェクトを省略するのではなく、リクエストで oidc: {enabled: false} を送信します。

このストアを更新し、リクエストから oidcオブジェクトを省略すると、Ops Manager は既存の OIDC 構成を削除します。既存の構成を保持するには、すべてのアップデートリクエストに現在の oidcオブジェクトを含めます。

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

pathTypeAccessEnabled

ブール値

必須

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

値	S3 ブロックストアエンドポイントの形式	例
`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

必須

S3 互換ストレージブロックストアをホストする S3 互換ストレージバケットの名前。

s3MaxConnections

数値

必須

この S3 互換ストレージブロックストアへの最大接続数を示す正の整数。

s3RegionServeride

string

条件付き

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

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

sseEnabled

ブール値

必須

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

uri

string

必須

この S3 互換ストレージブロックストアにアクセスできるホストのコンマ区切りリスト（ <hostname:port>形式）。

ssl

ブール値

任意

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

writeConcern

string

任意

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

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

ACKNOWLEDGED
W2
JOURNALED
MAJORITY

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

注意

s3AuthMethodがKEYSの場合は、次の認証情報ソースのいずれか 1 つを正確に提供します。keyVault オブジェクト、または awsAccessKey と awsSecretKey の両方です。s3AuthMethodがIAM_ROLEの場合は、keyVault オブジェクトを提供しないでください。提供すると MongoDB Ops Manager はエラーを返し、awsAccessKey および awsSecretKey の値を無視します。

v2.0 リソースには、次のキーボールトパラメータが追加されます。

名前	タイプ	必要性	説明
keyVault	オブジェクト	条件付き	この S3互換のスナップショットストアの Vault バックアップされた認証情報ソース。`s3AuthMethod`が`KEYS`の場合は、`keyVault` オブジェクトか、`awsAccessKey`と`awsSecretKey`の両方のいずれかを提供しますが、両方を提供することはできません。詳細については、スナップショットストア認証情報の HashiCorp Vault を参照してください。
keyVault.vaultId	string	条件付き	認証情報を保存するキーボールト構成の一意の識別子。この値はキーボールト構成の `id` と一致します。`keyVault` を提供する場合は必須です。
keyVault.awsAccessKeyPath	string	条件付き	キーヴォールト内のAWSアクセスキーへのパス（形式は `<secret-path>/<key>`）。 Ops Manager は、に`<key>` Vault KV バージョン2 シークレットから`<secret-path>` `secret/data/s3/aws-access-keyaws-access-keysecret/data/s3`フィールドの値を読み取ります。例、は`/data/` のシークレットから2 フィールドを読み取ります。 KV バージョンに必要な`/v1/` セグメントを含めます。 APIプレフィックスは含めないでください。 Ops Manager はプレフィックスを自動的に追加します。`keyVault` を指定した場合に必須です。
keyVault.awsSecretKeyPath	string	条件付き	キーヴォールト内のAWS秘密キーへのパス。と同じ`<secret-path>/<key>` 形式を使用します。`keyVault.awsAccessKeyPath` `keyVault`を指定した場合に必須です。

応答

名前

タイプ

説明

acceptTos

ブール値

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

割り当てEnabled

ブール値

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

awsAccessKey

string

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

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

ブール値

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

string

この S3 互換ストレージブロックストアを一意に識別する名前。

labels

文字列の配列

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

Links

オブジェクト配列

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

loadFactory

integer

Load Factorの詳細については、「 1 つの既存のブロックストアの編集」を参照してください。

objectLockEnabled

ブール値

S3バケット内のオブジェクトが削除されないようにオブジェクトロックが有効になっているかどうかを示すフラグ。

oidc

オブジェクト

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

enabled:ブール値。このストアで OIDC認証が有効になっているかどうかを示します。
method: string.callback、azure、gcp、k8sのいずれか。
tokenUri: string. The IdP token endpoint. Present only when method is callback.
clientId: string。 IdP に登録されたクライアントID 。
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 ブロックストアエンドポイントの形式	例
`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 互換ストレージバケットへのアクセスを許可するために使用される方法。

このオプションに指定できる値はKEYS 、 IAM_ROLEです。

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

s3bucketEndpoint

string

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

s3bucketName

string

S3 互換ストレージブロックストアをホストする S3 互換ストレージバケットの名前。

s3MaxConnections

integer

この S3 互換ストレージブロックストアへの最大接続数を示す正の整数。

s3RegionServeride

string

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

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

sseEnabled

ブール値

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

ssl

ブール値

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

uri

string

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

writeConcern

string

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

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

ACKNOWLEDGED
W2
JOURNALED
MAJORITY

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

v2.0 リソースには、次のキーボールトフィールドが追加されます。

名前	タイプ	説明
keyVault	オブジェクト	この S3互換のスナップショットストアのバルトによってバックアップされた認証情報ソース。MongoDB Ops Manager は、スナップショットストアがキーバルトから認証情報を読み取る場合にのみ、このオブジェクトを返します。
keyVault.vaultId	string	認証情報を保存するキーボルト構成の一意の識別子。
keyVault.awsAccessKeyPath	string	AWSアクセスキーへのキーヴォールト内のパス。
keyVault.awsSecretKeyPath	string	AWS秘密キーへのキーヴォールト内のパス。

リクエストの例

curl --user '{PUBLIC-KEY}:{PRIVATE-KEY}' --digest \
     --header 'Accept: application/json' \
     --header 'Content-Type: application/json' \
     --include \
     --request PUT 'https://<OpsManagerHost>:<Port>/api/public/v2.0/admin/backup/snapshot/s3Configs/{S3-BLOCKSTORE-CONFIG-ID}?pretty=true' \
     --data '{
       "assignmentEnabled": true,
       "pathStyleAccessEnabled": false,
       "acceptedTos": true,
       "encryptedCredentials": false,
       "loadFactor": 1,
       "s3AuthMethod": "KEYS",
       "s3BucketEndpoint": "s3.amazonaws.com",
       "s3BucketName": "bucketname",
       "s3MaxConnections": 50,
       "sseEnabled": true,
       "uri": "mongodb://127.0.0.1:27017",
       "ssl": false,
       "writeConcern": "ACKNOWLEDGED",
       "keyVault": {
         "vaultId": "{KEY-VAULT-ID}",
         "awsAccessKeyPath": "path/to/awsAccessKey",
         "awsSecretKeyPath": "path/to/awsSecretKey"
       }
     }'

応答例

応答ヘッダー

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}

レスポンス本体

{
  "acceptedTos": true,
  "assignmentEnabled": true,
  "encryptedCredentials": false,
  "id": "{S3-BLOCKSTORE-CONFIG-ID}",
  "keyVault": {
    "vaultId": "{KEY-VAULT-ID}",
    "awsAccessKeyPath": "path/to/awsAccessKey",
    "awsSecretKeyPath": "path/to/awsSecretKey"
  },
  "links": [
    {
      "href": "https://<OpsManagerHost>:<Port>/api/public/v2.0/admin/backup/snapshot/s3Configs/{S3-BLOCKSTORE-CONFIG-ID}",
      "rel": "self"
    }
  ],
  "loadFactor": 1,
  "pathStyleAccessEnabled": false,
  "s3AuthMethod": "KEYS",
  "s3BucketEndpoint": "s3.amazonaws.com",
  "s3BucketName": "bucketname",
  "s3MaxConnections": 50,
  "sseEnabled": true,
  "ssl": false,
  "uri": "mongodb://127.0.0.1:27017",
  "writeConcern": "ACKNOWLEDGED"
}

戻る

作成

削除

単一の S3 ブロックストア構成を更新 (v2.0)

Resource

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

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

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

注意

応答

リクエストの例

応答例

応答ヘッダー

レスポンス本体

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

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

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