1 つの新しい S3 互換のストレージ ブロックストアを構成します。v2.0 リソースにより keyVault オブジェクトが追加されます。このオブジェクトを使用すると、S3 互換のストレージ ブロックストアは HashiCorp Vault から Amazon Web Services 認証情報を読み取ります。詳しくは、 「スナップショットストア認証情報用 HashiCorp Vault」を参照してください。
ベース URL: https://{OPSMANAGER-HOST}:{PORT}/api/public/v2.0/admin/backup
Resource
POST /snapshot/s3Configs
リクエスト パス パラメーター
このエンドポイントは、HTTP リクエスト パス パラメーターを使用しません。
リクエスト クエリ パラメータ
次のクエリ パラメータは 任意です。
名前 | タイプ | 必要性 | 説明 | default |
|---|---|---|---|---|
pretty | ブール値 | 任意 | レスポンス本体をpretty-print形式にするかどうかを示すフラグ。 |
|
envelope | ブール値 | 任意 | 応答をエンベロープでラップするかどうかを示すフラグ。 一部のAPIクライアントは、 HTTPレスポンス ヘッダーまたはステータス コードにアクセスできません。 これを修正するには、クエリでenvelope=trueを設定します。 1 つの結果を返すエンドポイントの場合、レスポンス本体には次のものが含まれます。
|
|
リクエスト ボディ パラメータ
名前 | タイプ | 必要性 | 説明 | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
acceptTos | ブール値 | 必須 | MongoDB Ops Manager で S3 互換ストレージを使用するためのサービス利用規約に同意したかどうかを示すフラグ。S3 互換ストレージ ストアを作成するには、これを これを | |||||||||
割り当てEnabled | ブール値 | 任意 | このデータ ストアにバックアップ ジョブを割り当てられるかどうかを示すフラグ。 | |||||||||
awsAccessKey | string | 条件付き | s3bucketName で指定された S3 互換ストレージ バケットにアクセスできる アクセスAmazon Web Services キーID 。
| |||||||||
awsSecretKey | string | 条件付き |
| |||||||||
customCertificates | 配列 | 任意 | 関連付けられている S3 互換ストレージ バケットに適用される有効な証明機関証明書のリスト。 | |||||||||
customCertificates[n].filename | string | 任意 | 認証局PEMファイルを識別する名前。 | |||||||||
customCertificates[n].certString | string | 任意 | 証明機関チェーンを構成する証明機関PEMファイルの内容。 | |||||||||
disableProxyS3 | ブール値 | 任意 | S3 互換ストレージに接続するときに HTTP proxy を使用するかどうかを示すフラグ。MongoDB Ops Manager が HTTP proxy を使用するように構成していない限り、この値を設定する必要はありません。 | |||||||||
encryptionCredentials | ブール値 | 任意 | この S3 互換ストレージ ブロックストアのユーザー名とパスワードが認証情報ツールを使用して暗号化されているかどうかを示すフラグ。 | |||||||||
id | string | 必須 | ||||||||||
labels | 文字列の配列 | 任意 | がどの MongoDB Ops ManagerS3 ブロックストア に割り当てることができる バックアップ ジョブ を管理するためのタグの配列。 これらのタグを設定すると、この S3 互換ストレージ ブロックストアが処理できるバックアップジョブが制限されます。 省略した場合、この S3 互換ストレージ ブロックストアは、ジョブをフィルタリングするためにラベルを使用しないプロジェクトのバックアップ ジョブのみを処理できます。 | |||||||||
loadFactory | 数値 | 任意 | このスナップショット ストアが別のスナップショット ストアと比較して実行するバックアップ作業量を表すゼロ以外の正の整数。 このオプションは、複数のスナップショット ストアが使用されている場合にのみ必要です。 Load Factorの詳細については、 「 1 つの既存のブロックストアの編集 」を参照してください。 | |||||||||
objectLockEnabled | ブール値 | 任意 | S3バケット内のオブジェクトが削除されないようにオブジェクトロックが有効になっているかどうかを示すフラグ。 | |||||||||
oidc | オブジェクト | 任意 | 任意。 このストアの OIDC 認証設定。
ストアを OIDC から別の認証メカニズムに切り替えるには、リクエストで | |||||||||
pathTypeAccessEnabled | ブール値 | 必須 | このエンドポイントのスタイルを示すフラグ。
S3 互換のストレージバケットURL規則を確認するには、Amazon Web Services S3 のドキュメントを参照してください。 | |||||||||
s3Authメソッド | string | 任意 | s3bucketNameで指定された S3 互換ストレージ バケットへのアクセスを許可するために使用されるメソッド。 このオプションに指定できる値は
| |||||||||
s3bucketEndpoint | string | 必須 | この S3 互換ストレージ バケットにアクセスするために使用されるURL 。 | |||||||||
s3bucketName | string | 必須 | S3 互換ストレージ ブロックストアをホストする S3 互換ストレージ バケットの名前。 | |||||||||
s3MaxConnections | 数値 | 必須 | この S3 互換ストレージ ブロックストアへの最大接続数を示す正の整数。 | |||||||||
s3RegionServeride | string | 条件付き | S3 互換ストレージ バケットが存在するリージョン。 S3 互換ストレージ ストアのs3bucketEndpointがリージョンのスコープをサポートしていない場合にのみ、このフィールドを使用します。 このフィールドはAmazon Web Services S3 バケットでは使用しないでください。 | |||||||||
sseEnabled | ブール値 | 必須 | この S3 互換ストレージブロックストアがサーバー側暗号化を有効にしているかどうかを示すフラグ。 | |||||||||
ssl | ブール値 | 任意 | この S3 互換ストレージ ブロックストアがTLSを使用して暗号化された接続のみを受け入れるかどうかを示すフラグ。 | |||||||||
uri | string | 必須 | この S3 互換ストレージ ブロックストアのメタデータ データベースに接続する接続string 。 このデータベースは、 Amazon Web Services S3 互換のストレージ バケットにブロックの場所を保存します。 | |||||||||
writeConcern | string | 任意 | このブロックストアに使用される書込み保証 (write concern)。 MongoDB Ops Manager は、次の値を受け入れます。
MongoDB の書込み (write) 確認応答レベルの詳細については、「 書込み保証 (write concern) 」を参照してください。 |
注意
s3AuthMethodがKEYSの場合は、次の認証情報ソースのいずれか 1 つを正確に提供します。keyVault オブジェクト、または awsAccessKey と awsSecretKey の両方です。s3AuthMethodがIAM_ROLEの場合は、keyVault オブジェクトを提供しないでください。提供すると MongoDB Ops Manager はエラーを返し、awsAccessKey および awsSecretKey の値を無視します。
v2.0 リソースには、次のキーボールトパラメータが追加されます。
名前 | タイプ | 必要性 | 説明 |
|---|---|---|---|
keyVault | オブジェクト | 条件付き | この S3互換のスナップショット ストアの Vault バックアップされた認証情報ソース。 |
keyVault.vaultId | string | 条件付き | 認証情報を保存するキー ボールト構成の一意の識別子。この値はキー ボールト構成の |
keyVault.awsAccessKeyPath | string | 条件付き | キーボールト内の Amazon Web Services アクセスキーへのパスは、 |
keyVault.awsSecretKeyPath | string | 条件付き | キーボルト内の Amazon Web Services シークレット キーへのパス。 |
応答
名前 | タイプ | 説明 | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
acceptTos | ブール値 | MongoDB Ops Manager で S3 互換ストレージを使用するためのサービス利用規約を受け入れたかどうかを示すフラグ。S3 互換ストレージ ストアを作成するには、これを | |||||||||
割り当てEnabled | ブール値 | このデータ ストアにバックアップ ジョブを割り当てられるかどうかを示すフラグ。 | |||||||||
awsAccessKey | string | s3bucketName で指定された S3 互換ストレージ バケットにアクセスできる アクセスAmazon Web Services キーID 。 | |||||||||
awsSecretKey | string | Amazon Web Servicesシークレット アクセス キー。 s3bucketNameで指定された S3 互換ストレージ バケットにアクセスできます。 | |||||||||
customCertificates | 配列 | 関連付けられている S3 互換ストレージ バケットに適用される有効な証明機関証明書のリスト。 | |||||||||
customCertificates[n].filename | string | 認証局PEMファイルを識別する名前。 | |||||||||
customCertificates[n].certString | string | 証明機関チェーンを構成する証明機関PEMファイルの内容。 | |||||||||
disableProxyS3 | ブール値 | S3 互換ストレージに接続するときに HTTP proxy を使用するかどうかを示すフラグ。 | |||||||||
encryptionCredentials | ブール値 | この S3 互換ストレージ ブロックストアのユーザー名とパスワードが認証情報ツールを使用して暗号化されているかどうかを示すフラグ。 | |||||||||
id | string | この S3 互換ストレージ ブロックストアを一意に識別する名前。 | |||||||||
labels | 文字列の配列 | がどの MongoDB Ops ManagerS3 ブロックストア に割り当てることができる バックアップ ジョブ を管理するためのタグの配列。 | |||||||||
Links | オブジェクト配列 | サブリソースまたは関連リソースへの 1 つ以上のリンク。応答内のすべての | |||||||||
loadFactory | integer | このスナップショット ストアが別のスナップショット ストアと比較して実行するバックアップ作業量を表すゼロ以外の正の整数。 このオプションは、複数のスナップショット ストアが使用されている場合にのみ必要です。 Load Factorの詳細については、 「 1 つの既存のブロックストアの編集 」を参照してください。 | |||||||||
objectLockEnabled | ブール値 | S3バケット内のオブジェクトが削除されないようにオブジェクトロックが有効になっているかどうかを示すフラグ。 | |||||||||
oidc | オブジェクト | このストアの OIDC 認証設定。
| |||||||||
pathTypeAccessEnabled | ブール値 | このエンドポイントのスタイルを示すフラグ。
S3 互換のストレージバケットURL規則を確認するには、Amazon Web Services S3 のドキュメントを参照してください。 | |||||||||
s3Authメソッド | string |
このオプションに指定できる値は
| |||||||||
s3bucketEndpoint | string | MongoDB Ops Manager がこの S3 互換ストレージ バケットにアクセスするために使用するURL 。 | |||||||||
s3bucketName | string | S3 互換ストレージ ブロックストアをホストする S3 互換ストレージ バケットの名前。 | |||||||||
s3MaxConnections | integer | この S3 互換ストレージ ブロックストアへの最大接続数を示す正の整数。 | |||||||||
s3RegionServeride | string | ||||||||||
sseEnabled | ブール値 | この S3 互換ストレージブロックストアがサーバー側暗号化を有効にしているかどうかを示すフラグ。 | |||||||||
ssl | ブール値 | この S3 互換ストレージ ブロックストアがTLSを使用して暗号化された接続のみを受け入れるかどうかを示すフラグ。 | |||||||||
uri | string | この S3 互換ストレージ ブロックストアのメタデータ データベースに接続する接続string 。 このデータベースは、 Amazon Web Services S3 互換のストレージ バケットにブロックの場所を保存します。 | |||||||||
writeConcern | string | このブロックストアに使用される書込み保証 (write concern)。 MongoDB Ops Manager は、次のいずれかの値を返します。
MongoDB の書込み (write) 確認応答レベルの詳細については、「 書込み保証 (write concern) 」を参照してください。 |
v2.0 リソースには、次のキー ボールト フィールドが追加されます。
名前 | タイプ | 説明 |
|---|---|---|
keyVault | オブジェクト | この S3互換のスナップショットストアのバルトによってバックアップされた認証情報ソース。MongoDB Ops Manager は、スナップショットストアがキーバルトから認証情報を読み取る場合にのみ、このオブジェクトを返します。 |
keyVault.vaultId | string | 認証情報を保存するキーボルト構成の一意の識別子。 |
keyVault.awsAccessKeyPath | string | キーボールト内の Amazon Web Services アクセス キーへのパス。 |
keyVault.awsSecretKeyPath | string | キーボルト内の AWS シークレットキーへのパス。 |
リクエストの例
curl --user '{PUBLIC-KEY}:{PRIVATE-KEY}' --digest \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --include \ --request POST 'https://<OpsManagerHost>:<Port>/api/public/v2.0/admin/backup/snapshot/s3Configs?pretty=true' \ --data '{ "id": "{S3-BLOCKSTORE-CONFIG-ID}", "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" } }'
curl --user '{PUBLIC-KEY}:{PRIVATE-KEY}' --digest \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --include \ --request POST 'https://<OpsManagerHost>:<Port>/api/public/v2.0/admin/backup/snapshot/s3Configs?pretty=true' \ --data '{ "id": "{S3-BLOCKSTORE-CONFIG-ID}", "assignmentEnabled": true, "pathStyleAccessEnabled": false, "awsAccessKey": "<access>", "awsSecretKey": "<secret>", "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" }'
curl --user '{PUBLIC-KEY}:{PRIVATE-KEY}' --digest \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --include \ --request POST 'https://<OpsManagerHost>:<Port>/api/public/v2.0/admin/backup/snapshot/s3Configs?pretty=true' \ --data '{ "id": "{S3-BLOCKSTORE-CONFIG-ID}", "assignmentEnabled": true, "pathStyleAccessEnabled": false, "acceptedTos": true, "encryptedCredentials": false, "loadFactor": 1, "s3AuthMethod": "IAM_ROLE", "s3BucketEndpoint": "s3.amazonaws.com", "s3BucketName": "bucketname", "s3MaxConnections": 50, "sseEnabled": true, "uri": "mongodb://127.0.0.1:27017", "ssl": false, "writeConcern": "ACKNOWLEDGED" }'
応答例
応答ヘッダー
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
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", "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" }