/ /

/ /

すべての S3 ブロックストア構成を取得する

すべての S3 ブロックストアの構成を取得します。

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

Resource

GET /snapshot/s3Configs

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

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

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

名前	タイプ	必要性	説明	default
pageNum	数値	任意	結果のサブセクションを返す 1 から始まる整数。	`1`
itemsPerPage	数値	任意	1 ページあたりに返す項目の数は最大 500 です。	`100`
pretty	ブール値	任意	レスポンス本体を pretty-print形式にするかどうかを示すフラグ。	`false`
envelope	ブール値	任意	応答をエンベロープでラップするかどうかを示すフラグ。 Some API clients cannot access the HTTP response headers or status code. To remediate this, set `envelope : true` in the query. 結果のリストを返すエンドポイントの場合、 `content`オブジェクトはエンベロープです。 MongoDB Ops Manager は、レスポンス本体に`status`フィールドを追加します。	`false`

assignableOnly

ブール値

任意

新しいバックアップジョブを割り当てることができる S3 ブロックストアのみを返すかどうかを示します。

true

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

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

応答

応答ドキュメント

The response JSON document includes an array of result objects, an array of link objects and a count of the total number of result objects retrieved.

名前	タイプ	説明
`results`	配列	配列には、`results` 埋め込みドキュメントセクションに詳細な項目ごとに 1 つのオブジェクトが含まれます。
`links`	配列	配列には、サブリソースや関連リソースへの 1 つ以上のリンクが含まれます。 URL 間の関係は、 Web リンク仕様で説明されています。
`totalCount`	数値	結果セット内の項目の合計数の整数。結果セット全体がページ分割される場合は、 results配列内のオブジェクト数よりも大きくなる可能性があります。

`results` embeddedDocument

各結果は 1 つの S3 ブロックストアです。

名前

タイプ

説明

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 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 ブロックストアエンドポイントの形式	例
`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) 」を参照してください。

リクエストの例

curl --user '{PUBLIC-KEY}:{PRIVATE-KEY}' --digest \
 --header 'Accept: application/json' \
 --include \
 --request GET 'https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/admin/backup/snapshot/s3Configs?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}

レスポンス本体

{
  "links" : [ {
    "href" : "http://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/admin/backup/snapshot/s3Configs?pretty=true&pageNum=1&itemsPerPage=100",
    "rel" : "self"
  } ],
  "results" : [ {
    "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/snapshot/s3Configs/{S3-BLOCKSTORE-ID}",
        "rel": "self"
      }
    ],
    "loadFactor": 50,
    "s3BucketEndpoint": "http://example.com/backupbucket",
    "s3BucketName": "buck1",
    "uri": "mongodb://localhost:27017",
    "ssl": true,
    "writeConcern": "W2"
  } ],
  "totalCount" : 1
}