すべての S3 互換ストレージ ブロックストアの構成を取得します。v リソースは、HashiCorp Vault から Amazon Web Services 2.0認証情報を読み取る各keyVault S 互換ストレージ ブロックストアの オブジェクトを返します。3
ベース URL: https://{OPSMANAGER-HOST}:{PORT}/api/public/v2.0/admin/backup
Resource
GET /snapshot/s3Configs
リクエスト パス パラメーター
このエンドポイントは、HTTP リクエスト パス パラメーターを使用しません。
リクエスト クエリ パラメータ
名前 | タイプ | 必要性 | 説明 | default |
|---|---|---|---|---|
pageNum | 数値 | 任意 | 結果のサブセクションを返す 1 から始まる整数。 |
|
itemsPerPage | 数値 | 任意 | 1 ページあたりに返す項目の数は最大 500 です。 |
|
pretty | ブール値 | 任意 | レスポンス本体を pretty-print形式にするかどうかを示すフラグ。 |
|
envelope | ブール値 | 任意 | 応答をエンベロープでラップするかどうかを示すフラグ。 一部のAPIクライアントは、 HTTPレスポンス ヘッダーまたはステータス コードにアクセスできません。 これを修正するには、クエリで 結果のリストを返すエンドポイントの場合、 |
|
assignableOnly | ブール値 | 任意 | S3 互換のストレージ ブロックストアのみを返すかどうかを示します。これらのブロックストアには新しいバックアップジョブを割り当てることができます。 |
|
リクエスト ボディ パラメータ
このエンドポイントは、HTTP リクエスト本体パラメータを使用しません。
応答
応答ドキュメント
レスポンスJSONドキュメントには、result オブジェクトの配列、link オブジェクトの配列、および取得されたresult オブジェクトの合計数が含まれます。
名前 | タイプ | 説明 |
|---|---|---|
| 配列 | 配列には、 |
| 配列 | 配列には、サブリソースや関連リソースへの 1 つ以上のリンクが含まれます。URL間の関係は、Web リンク仕様で説明されています。 |
| 数値 | 結果セット内の項目の合計数の整数。 結果セット全体がページ分割される場合は、 results配列内のオブジェクト数よりも大きくなる可能性があります。 |
results embeddedDocument
各 結果 は、S3互換のストレージ ブロックストアです。
名前 | タイプ | 説明 | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
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' \ --include \ --request GET 'https://<OpsManagerHost>:<Port>/api/public/v2.0/admin/backup/snapshot/s3Configs?pretty=true'
応答例
応答ヘッダー
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}
レスポンス本体
{ "links": [ { "href": "https://<OpsManagerHost>:<Port>/api/public/v2.0/admin/backup/snapshot/s3Configs?pretty=true&pageNum=1&itemsPerPage=100", "rel": "self" } ], "results": [ { "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": 50, "s3BucketEndpoint": "http://example.com/backupbucket", "s3BucketName": "buck1", "uri": "mongodb://localhost:27017", "ssl": true, "writeConcern": "W2" } ], "totalCount": 1 }