すべての S3 oplog構成を取得する
項目一覧
すべての s 3 oplog ストアの構成を取得します。
ベース URL: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/admin/backup
Resource
GET /oplog/s3Configs
リクエスト パス パラメーター
このエンドポイントは、HTTP リクエスト パス パラメーターを使用しません。
リクエスト クエリ パラメータ
名前 | タイプ | 必要性 | 説明 | default |
|---|---|---|---|---|
pageNum | 数値 | 任意 | 結果のサブセクションを返す 1 から始まる整数。 |
|
itemsPerPage | 数値 | 任意 | 1 ページあたりに返す項目の数は最大 500 です。 |
|
pretty | ブール値 | 任意 | レスポンス本体を pretty-print に含めるかどうかを示すフラグ 形式。 |
|
envelope | ブール値 | 任意 | 応答をエンベロープでラップするかどうかを示すフラグ。 一部の APIクライアントは、 HTTPレスポンス ヘッダーまたはステータス コードにアクセスできません。 これを修正するには、クエリで 結果のリストを返すエンドポイントの場合、 |
|
assignableOnly | ブール値 | この S 3 oplog ストアに新しいバックアップジョブを割り当てることができるかどうかを示すフラグ。 |
|
リクエスト ボディ パラメータ
このエンドポイントは、HTTP リクエスト本体パラメータを使用しません。
応答
応答ドキュメント
レスポンスJSONドキュメントには、 resultオブジェクトの配列、 linkオブジェクトの配列、および取得されたresultオブジェクトの合計数が含まれます。
名前 | タイプ | 説明 |
|---|---|---|
| 配列 | 配列には、 |
| 配列 | 配列には、サブリソースや関連リソースへの 1 つ以上のリンクが含まれます。 URL 間の関係は、 Web リンク仕様 で説明されています。 |
| 数値 | 結果セット内の項目の合計数の整数。 結果セット全体がページ分割される場合は、 results配列内のオブジェクト数よりも大きくなる可能性があります。 |
results embeddedDocument
各結果は 1 つの3 oplog ストアです。
名前 | タイプ | 説明 | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
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 | ブール値 | この S 3互換ストレージ oplog ストアのユーザー名とパスワードが認証情報ツールを使用して暗号化されているかどうかを示すフラグ。 | |||||||||
id | string | この S 3互換ストレージ oplog ストアを一意に識別する名前。 | |||||||||
labels | 文字列の配列 | が S 互換ストレージ ストアに割り当てることができる バックアップジョブ を管理するためのタグの配列。MongoDB Ops Manager3oplog | |||||||||
Links | オブジェクト配列 | サブリソースや関連リソースへの 1 つ以上のリンク。 応答内のすべての | |||||||||
pathTypeAccessEnabled | ブール値 | このエンドポイントのスタイルを示すフラグ。
S3 互換のストレージ バケットURL 規則を確認するには、Amazon Web Services S3 のドキュメントを参照してください。 | |||||||||
s3bucketEndpoint | string | MongoDB Ops Manager がこの S3 互換ストレージ バケットにアクセスするために使用するURL 。 | |||||||||
s3bucketName | string | S 3互換ストレージ oplog ストアをホストする S 3互換ストレージ バケットの名前。 | |||||||||
s3RegionServeride | string | ||||||||||
sseEnabled | ブール値 | この S3 互換ストレージ oplog ストアが サーバー側暗号化を有効にしているかどうかを示すフラグ。 | |||||||||
ssl | ブール値 | この S 3互換ストレージ oplog ストアがTLSを使用して暗号化された接続のみを受け入れるかどうかを示すフラグ。 | |||||||||
uri | string | この S 互換ストレージ ストアのメタデータ データベースに接続する 接続string3 oplog。このデータベースは、S 3互換ストレージ バケット内のブロックの場所を保存します。 | |||||||||
writeConcern | string | この oplog ストアに使用される書込み保証 (write concern)。 MongoDB Ops Manager は、次のいずれかの値を返します。
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/oplog/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" : "http://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/admin/backup/oplog/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/oplog/s3Configs/{S3-OPLOG-ID}", "rel": "self" } ], "s3BucketEndpoint": "http://backup.example.com/oplog", "s3BucketName": "oplog", "uri": "mongodb://localhost:27017", "ssl": true, "writeConcern": "W2" } ], "totalCount" : 1 }