ID による 1 つの S3 ブロックストア構成の取得 (v2.0)

1 つの S3 互換ストレージストレージブロックストアの構成を取得します。2.0 keyVaultS3 互換ストレージブロックストアがHashiCorp Vault からAWS認証情報を読み取るときに、v リソースはオブジェクトを返します。

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

Resource

GET /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`

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

このエンドポイントは、HTTP リクエスト本体パラメータを使用しません。

応答

名前	タイプ	説明
acceptTos	ブール値	MongoDB Ops Manager で S3 互換ストレージを使用するためのサービス利用規約を受け入れたかどうかを示すフラグ。S3 互換ストレージストアを作成するには、これを `true` に設定する必要があります。
割り当てEnabled	ブール値	このデータストアにバックアップジョブを割り当てられるかどうかを示すフラグ。
awsAccessKey	string	s3 bucketName で指定された S 互換ストレージバケットにアクセスできるAWSアクセスキーID3 。
awsSecretKey	string	s3 bucketName で指定された S 互換ストレージバケットにアクセスできるAWSシークレット3 アクセスキー。
customCertificates	配列	関連付けられている S3 互換ストレージバケットに適用される有効な証明機関証明書のリスト。
customCertificates[n].filename	string	認証局PEMファイルを識別する名前。
customCertificates[n].certString	string	証明機関チェーンを構成する証明機関PEMファイルの内容。
disableProxyS3	ブール値	S3 互換ストレージに接続するときに HTTP proxy を使用するかどうかを示すフラグ。
encryptionCredentials	ブール値	この S3 互換ストレージブロックストアのユーザー名とパスワードが認証情報ツールを使用して暗号化されているかどうかを示すフラグ。
id	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。 IdP トークンエンドポイント。`method` が`callback` の場合にのみ表示されます。 `clientId`: string。 IdP に登録されたクライアントID 。 `clientSecret`: string.MongoDB Ops Manager は応答でこの値を難読化し、生のクライアントシークレットを返しません。 `scope`: string。2 IdP から要求された OAuth スコープ。`method` が`callback` の場合にのみ表示されます。 `tokenResource`: string.ワークロードアイデンティティトークンのオーディエンスまたはリソース識別子。`method` が `azure` または `gcp` の場合にのみ表示されます。
pathTypeAccessEnabled	ブール値	このエンドポイントのスタイルを示すフラグ。 `true`: パス形式のURLエンドポイント。例:`s3.amazonaws.com/<bucket>` `false`: 仮想ホストスタイルのURLエンドポイント。例:`<bucket>.s3.amazonaws.com` S3 互換のストレージバケットURL規則を確認するには、 AWS S3 ドキュメントを参照してください。
s3Authメソッド	string	`s3BucketName`で指定された S3 互換ストレージバケットへのアクセスを許可するために使用される方法。このオプションに指定できる値は`KEYS` 、 `IAM_ROLE`です。 `KEYS` またはなし: Ops Manager は `awsAccessKey` と `awsSecretKey` を使用して、`s3BucketName` で指定された S3 互換ストレージバケットへのアクセスを承認します。 `IAM_ROLE`: Ops Manager はAWS IAM 3`s3BucketName`ロールを使用して、で指定された S`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	この S 互換ストレージブロックストアのメタデータデータベースに接続する接続文字列3 。このデータベースは、 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' \
     --include \
     --request GET 'https://<OpsManagerHost>:<Port>/api/public/v2.0/admin/backup/snapshot/s3Configs/{S3-BLOCKSTORE-CONFIG-ID}?pretty=true'

応答例

応答ヘッダー

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)

すべて取得