AI エージェント向け: ドキュメントインデックスは https://www.mongodb.com/ja-jp/docs/llms.txt で利用できます。すべてのページの markdown バージョンは、いずれかの URL パスに .md を追加することで利用できます。

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

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

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

GET /snapshot/s3Configs

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

名前
タイプ
必要性
説明
default

pageNum

数値

任意

結果のサブセクションを返す 1 から始まる整数。

1

itemsPerPage

数値

任意

1 ページあたりに返す項目の数は最大 500 です。

100

pretty

ブール値

任意

レスポンス本体を pretty-print形式にするかどうかを示すフラグ。

false

envelope

ブール値

任意

応答をエンベロープでラップするかどうかを示すフラグ。

一部の API クライアントは、HTTP レスポンス ヘッダーまたはステータス コードにアクセスできません。これを修正するには、クエリで envelope : true を設定します。

結果のリストを返すエンドポイントの場合、 contentオブジェクトはエンベロープです。 MongoDB Ops Manager は、レスポンス本体にstatusフィールドを追加します。

false

assignableOnly

ブール値

任意

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

true

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

応答JSONドキュメントには、resultオブジェクトの配列、linkオブジェクトの配列、および検索されたresultオブジェクトの合計数のカウントが含まれます。

名前
タイプ
説明

results

配列

配列には、results 埋め込みドキュメント セクションに詳細な項目ごとに 1 つのオブジェクトが含まれます。

links

配列

配列には、サブリソースや関連リソースへの 1 つ以上のリンクが含まれます。 URL 間の関係は、 Web リンク仕様 で説明されています。

totalCount

数値

結果セット内の項目の合計数の整数。 結果セット全体がページ分割される場合は、 results配列内のオブジェクト数よりも大きくなる可能性があります。

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

名前
タイプ
説明

acceptTos

ブール値

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

割り当てEnabled

ブール値

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

awsAccessKey

string

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

awsSecretKey

string

s3 BucketName で指定された S 互換のストレージ バケットにアクセスできる Amazon Web Services シークレット3 アクセス キー。

customCertificates

配列

関連付けられている S3 互換ストレージ バケットに適用される有効な証明機関証明書のリスト。

customCertificates[n].filename

string

認証局PEMファイルを識別する名前。

customCertificates[n].certString

string

証明機関チェーンを構成する証明機関PEMファイルの内容。

disableProxyS3

ブール値

S3 互換ストレージに接続するときに HTTP proxy を使用するかどうかを示すフラグ。

encryptionCredentials

ブール値

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

id

string

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

labels

文字列の配列

Links

オブジェクト配列

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

loadFactory

integer

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

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

objectLockEnabled

ブール値

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

objectLockEnabledAt

タイムスタンプ

この S3 互換ストレージブロックストアに対してオブジェクトロックが有効になっている日時。 MongoDB Ops Manager は、GET リクエストに応答してのみこのフィールドを返します。

objectRetentionDays

integer

Ops Manager がこの S3 互換ストレージストアのオブジェクトを オブジェクト ロック で保護する日数。

objectRetentionMode

string

Ops Manager がこの S3 互換ストレージストレージストアのオブジェクトに適用するオブジェクト ロック保持モード。

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

  • GOVERNANCE

  • COMPLIANCE

oidc

オブジェクト

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

  • enabled: ブール値。このストアで OIDC 認証が有効になっているかどうかを示します。

  • method: string.callback、azure、gcp、k8sのいずれか。

  • tokenUri: string.IdP エンドポイントとなる接続されたデバイス。methodcallback{1}が{2}の場合にのみ表示されます。

  • clientId: string.IdP に登録されているクライアント ID。

  • clientSecret: string.MongoDB Ops Manager は応答でこの値を難読化し、生のクライアント シークレットを返しません。

  • scope: string.IdP からリクエストされた OAuth2 スコープ。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 または None: MongoDB Ops Manager は awsAccessKey と awsSecretKey を使用して、s3BucketName で指定された S3 互換ストレージ バケットへのアクセスを承認します。

  • IAM_ROLE: Ops Manager uses an AWS IAM role to authorize access to S3-compatible storage bucket specified in s3BucketName. awsAccessKey and awsSecretKey fields are ignored. To learn more, see the AWS documentation

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

ブール値

この S 3互換ストレージ ブロックストアが 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 UnauthorizedContent-Type: application/json;charset=ISO-8859-1Date: {dateInUnixFormat}WWW-Authenticate: Digest realm="MMS Public API", domain="", nonce="{nonce}", algorithm=MD5, op="auth", stale=falseContent-Length: {requestLengthInBytes}Connection: keep-alive
HTTP/1.1 200 OKVary: Accept-EncodingContent-Type: application/jsonStrict-Transport-Security: max-age=300Date: {dateInUnixFormat}Connection: keep-aliveContent-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}