Docs Menu
Docs Home
/
MongoDB Ops Manager
/ / / /

すべての S3 oplog構成を取得する

項目一覧

  • Resource
  • リクエスト パス パラメーター
  • リクエスト クエリ パラメータ
  • リクエスト ボディ パラメータ
  • 応答
  • 応答ドキュメント
  • results embeddedDocument
  • リクエストの例
  • 応答例
  • 応答ヘッダー
  • レスポンス本体

すべての s 3 oplog ストアの構成を取得します。

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

GET /oplog/s3Configs

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

名前
タイプ
必要性
説明
default
pageNum
数値
任意
結果のサブセクションを返す 1 から始まる整数。
1
itemsPerPage
数値
任意
1 ページあたりに返す項目の数は最大 500 です。
100
pretty
ブール値
任意
レスポンス本体を pretty-print に含めるかどうかを示すフラグ 形式。
false
envelope
ブール値
任意

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

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

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

false
backupJobsEnabledOnly
ブール値
任意
データベースのバックアップ用に有効になっていないデーモンを応答から除外するかどうかを示すフラグ。 これをfalseに設定し、 backupJobsEnabledフラグがfalseに設定されているデーモン構成を含めます。
true
assignableOnly
ブール値
この S 3 oplog ストアに新しいバックアップジョブを割り当てることができるかどうかを示すフラグ。
true

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

レスポンスJSONドキュメントには、 resultオブジェクトの配列、 linkオブジェクトの配列、および取得されたresultオブジェクトの合計数が含まれます。

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

結果は 1 つの3 oplog ストアです。

名前
タイプ
説明
acceptTos
ブール値
MongoDB Ops Managerで S3 互換ストレージを使用するためのサービス利用規約を受け入れたかどうかを示すフラグ。 S 3互換ストレージ 互換ストアを作成するには、これをtrueに設定する必要があります。
割り当て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 つ以上のリンク。 応答内のすべてのlinks配列には、 selfと呼ばれるリンクが少なくとも 1 つ含まれています。 URL の関係は、 Web リンク仕様 で説明されています。

pathTypeAccessEnabled
ブール値

このエンドポイントのスタイルを示すフラグ。

S3 oplogストア エンドポイント スタイル
true
パス形式のURLエンドポイント
s3.amazonaws.com/<bucket>
false
仮想ホスト スタイルのURLエンドポイント
<bucket>.s3.amazonaws.com

S3 互換のストレージ バケットURL 規則を確認するには、Amazon Web Services S3 のドキュメントを参照してください。

s3bucketEndpoint
string
URLMongoDB Ops ManagerがこのAmazon Web Services S3 互換ストレージまたは S3 互換ストレージにアクセスするために使用する 。
s3bucketName
string
S 3互換ストレージ oplog ストアをホストする S 3互換ストレージ バケットの名前。
s3RegionServeride
string

S 3互換ストレージ バケットが存在するリージョン。 このフィールドは、S 3互換ストレージ互換ストアのS 3バケットエンドポイントがリージョン スコープをサポートしていない場合にのみ適用されます。

MongoDB Ops Managerは、この S3 互換ストレージ ストアを 作成 または 更新oplog したときにこのフィールドを含めた場合にのみ、このフィールドを返します。

sseEnabled
ブール値
ssl
ブール値
この S 3互換ストレージ oplog ストアがTLSを使用して暗号化された接続のみを受け入れるかどうかを示すフラグ。
uri
string
この S 互換ストレージ ストアのメタデータ データベースに接続する 接続string3 oplog。このデータベースは、 Amazon Web Services S3 互換のストレージ バケットにブロックの場所を保存します。
writeConcern
string

この oplog ストアに使用される書込み保証 (write concern)。

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

  • ACKNOWLEDGED

  • W2

  • JOURNALED

  • MAJORITY

MongoDB の書込み (write) 確認応答レベルの詳細については、「 書込み保証 (write concern) 」を参照してください。

curl --user '{USERNAME}:{APIKEY}' --digest \
--header 'Accept: application/json' \
--include \
--request GET 'https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/admin/backup/oplog/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/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
}

戻る

を使用して 1 つの S3 構成を取得oplogID