Docs Menu
Docs Home
/
MongoDB Ops Manager
/
API
/
リソース
/
バックアップ管理
/
S3 Oplog

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

項目一覧

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

1 つの3 oplog ストアの構成を取得します。

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

Resource

GET /oplog/s3Configs/{S3-OPLOG-CONFIG-ID}

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

名前
タイプ
説明

S3-OPLOG-CONFIG-ID

string

この S3 oplog構成を表す一意の識別子。

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

次のクエリ パラメータは 任意です。

名前
タイプ
必要性
説明
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

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

MongoDB Ops Manager がこの S3 互換ストレージ バケットにアクセスするために使用するURL 。

s3bucketName

string

S 3互換ストレージ oplog ストアをホストする S 3互換ストレージ バケットの名前。

s3RegionServeride

string

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

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

sseEnabled

ブール値

この S3 互換ストレージ oplog ストアが サーバー側暗号化を有効にしているかどうかを示すフラグ。

ssl

ブール値

この S 3互換ストレージ oplog ストアがTLSを使用して暗号化された接続のみを受け入れるかどうかを示すフラグ。

uri

string

この S 互換ストレージ ストアのメタデータ データベースに接続する 接続string3 oplog。このデータベースは、S 3互換ストレージ バケット内のブロックの場所を保存します。

writeConcern

string

この oplog ストアに使用される書込み保証 (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/oplog/s3Configs/{S3-OPLOG-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}

レスポンス本体

1{
2  "assignmentEnabled": true,
3  "awsAccessKey": "access",
4  "awsSecretKey": "secret",
5  "customCertificates" : [{
6    "filename" : "CA.pem",
7    "certString" : "-----BEGIN CERTIFICATE-----\nMIIDljCCAn4CCQDJjCHAkAafFTANBgkqhkiG9w0BAQsFADCBjDELMAkGA1UEBhMC\nVVMxCzAJBgNVBAgMAk5ZMQwwCgYDVQQHDANOWUMxEDAOBgNVBAoMB01vbmdvREIx\nDDAKBgNVBAsMA1NXRTEZMBcGA1UEAwwQZXJpbm1jbnVsdHkudGVjaDEnMCUGCSqG\nSIb3DQEJARYYZXJpbi5tY251bHR5QG1vbmdvZGIuY29tMB4XDTIxMDYxMTE1MzY0\nMVoXDTIxMDcxMTE1MzY0MVowgYwxCzAJBgNVBAYTAlVTMQswCQYDVQQIDAJOWTEM\nMAoGA1UEBwwDTllDMRAwDgYDVQQKDAdNb25nb0RCMQwwCgYDVQQLDANTV0UxGTAX\nBgNVBAMMEGVyaW5tY251bHR5LnRlY2gxJzAlBgkqhkiG9w0BCQEWGGVyaW4ubWNu\ndWx0eUBtb25nb2RiLmNvbTCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEB\nAOoAv1btxcEgDOdCgyz+/NtyFwa0h/3yGtj+WK7nMzcEntnxG5apHVRZ6eQ4ayZU\nhZNPbNWtcsbTEiRWyywMAd7/DbIa9GhsP1/P6Cv+TnO2krx8qVKQN93j8cme/b6g\n+yeEWMAM2rvfXq/fRTtJbH1Y6c4mYh4312mPrlEfgvAUQZh3DpJQNIVZ5MM2imp0\nfBgcggrNHUniLCT8ogUA4QII8CKIC4ONX4TNtXbsNtcCzKNqvOdcvWXLTYEJav34\nlaJs1YWJx2PSufgHo+JZUeANwwpztkYhr3nUGTD8fr7JF9CO7UlFBTFqs+PeaTJV\nEbnrF26NimsAmRgRPNLE170CAwEAATANBgkqhkiG9w0BAQsFAAOCAQEAe5hAkrhz\nClXg4HPq6U3ONEUVUqQ231gogeUIIQsfn4K89QIFnsm0DC1lE21qHNcD3iHECmDJ\n9R2tXdA0shbc+hM8OHbEW6U31dLrM369PUQmw0GOkFWlYHnX4ySt+zMAjlIrQe7C\nLErYSuLDpjuKvkdpvbcwgkarB9/FPCOhORpAZqduhwUOr28tZzT3/8L7w//+7Yhy\n5ihKgTcP/CmJ+MgLlZqBtQ7lkmKDWXIUlLSRDHEciVGSXgZBreUciNFeMHVvoluc\ndxdsxqMcXgyXwmv7Ck7tCjYRwzwlf3TrcKt8QFijWTbl1Z/3d0/zpjuvR21J0z/3\ns4tNMtQdG6/bHA==\n-----END CERTIFICATE-----"
8  }],
9  "encryptedCredentials": false,
10  "id": "id",
11  "labels": [
12    "l1",
13    "l2"
14  ],
15  "links": [
16    {
17      "href": "https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/admin/backup/oplog/s3Configs/{S3-OPLOG-CONFIG-ID}",
18      "rel": "self"
19    }
20  ],
21  "s3BucketEndpoint": "http://backup.example.com/oplog",
22  "s3BucketName": "oplog",
23  "uri": "mongodb://localhost:27017",
24  "ssl": true,
25  "writeConcern": "W2"
26}

戻る

S3 Oplog

次へ

すべて取得