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

1 つの S3 oplog構成を作成

項目一覧

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

新しい s 3 oplog ストアを 1 つ構成します。

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

POST /oplog/s3Configs

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

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

名前
タイプ
必要性
説明
default
pretty
ブール値
任意
レスポンス本体を pretty-print に含めるかどうかを示すフラグ 形式。
false
envelope
ブール値
任意

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

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

1 つの結果を返すエンドポイントの場合、レスポンス本体には次のものが含まれます。

名前
説明
状態
HTTPレスポンス コード
envelope
期待される応答本体
false
名前
タイプ
必要性
説明
acceptTos
ブール値
必須

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

これをfalseに設定すると、MongoDB Ops Manager はエラーを返します。 エラーには、MongoDB Ops Manager が S 3と互換性のあるストレージを作成できないことが記載されています。

割り当てEnabled
ブール値
任意
このデータ ストアにバックアップ ジョブを割り当てられるかどうかを示すフラグ。
awsAccessKey
string
条件付き

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

"s3AuthMethod" : "IAM_ROLE"の場合は、 awsAccessKeyを含める必要はありません。

awsSecretKey
string
条件付き

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

"s3AuthMethod" : "IAM_ROLE"の場合は、 awsSecretKeyを含める必要はありません。

customCertificates
配列
任意
関連付けられている S3 互換ストレージ バケットに適用される有効な証明機関証明書のリスト。
customCertificates[n].filename
string
任意
認証局PEMファイルを識別する名前。
customCertificates[n].certString
string
任意
証明機関チェーンを構成する証明機関PEMファイルの内容。
disableProxyS3
ブール値
任意
S3 互換ストレージに接続するときに HTTP proxyを使用するかどうかを示すフラグ。 Ops Manager が HTTP プロキシを使用するように構成していない限り、この値を設定する必要はありません。
encryptionCredentials
ブール値
任意
この S 3互換ストレージ oplog ストアのユーザー名とパスワードが認証情報ツールを使用して暗号化されているかどうかを示すフラグ。
id
string
必須
この S 3互換ストレージ oplog ストアを一意に識別する名前。
labels
文字列の配列
任意

がどの MongoDB Ops ManagerS ストアに割り当てることができる バックアップジョブ3oplog を管理するためのタグの配列。

これらのタグを設定すると、この S 3互換ストレージ oplog ストアが処理できるバックアップ ジョブが制限されます。 省略した場合、この S 3互換ストレージ oplog ストアは、ジョブをフィルタリングするためにラベルを使用しないプロジェクトのバックアップジョブのみを処理できます。

pathTypeAccessEnabled
ブール値
必須

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

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

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

s3Authメソッド
string
任意

s3bucketNameで指定された S3 互換ストレージ バケットへのアクセスを許可するために使用されるメソッド。

MongoDB Ops Manager は、次の値を受け入れます。

KEYS または なし
MongoDB Ops Managerは、 awsAccessKeyawsSecretKeyを使用して、 s3BbucketNameで指定された S3 互換ストレージ バケットへのアクセスを許可します。
IAM_ROLE
MongoDB Ops Managerは、 Amazon Web Services IAMロールを使用して、 s3bucketNameで指定された S3 互換ストレージ バケットへのアクセスを承認します。 awsAccessKeyawsSecretKeyフィールドは無視されます。 詳しくは、Amazon Web Services のドキュメント を参照してください。
s3bucketEndpoint
string
必須
URLこのAmazon Web Services S3 互換ストレージまたは S 互換ストレージにアクセスするために使用される3 。
s3bucketName
string
必須
S 3互換ストレージ oplog ストアをホストする S 3互換ストレージ バケットの名前。
s3MaxConnections
数値
必須
この S 3互換ストレージ oplog ストアへの最大接続数を示す正の整数。
s3RegionServeride
string
条件付き

S3 互換ストレージ バケットが存在するリージョン。

このフィールドは、S 3互換ストレージ互換ストアのS 3バケットエンドポイントがリージョン スコープをサポートしていない場合にのみ使用してください。 このフィールドはAmazon Web Services S3 互換のストレージ バケットでは使用しないでください。

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) 」を参照してください。

名前
タイプ
説明
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) 」を参照してください。

1curl --user '{PUBLIC-KEY}:{PRIVATE-KEY}' --digest \
2 --header 'Accept: application/json' \
3 --header 'Content-Type: application/json' \
4 --include \
5 --request POST 'https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/admin/backup/oplog/s3Configs?pretty=true' \
6 --data '{
7 "assignmentEnabled": true,
8 "awsAccessKey": "access",
9 "awsSecretKey": "secret",
10 "encryptedCredentials": false,
11 "id": "{S3-OPLOG-CONFIG-ID}",
12 "labels": [
13 "l1",
14 "l2"
15 ],
16 "s3BucketEndpoint": "http://backup.example.com/oplog",
17 "s3BucketName": "oplog",
18 "uri": "mongodb://localhost:27017",
19 "ssl": true,
20 "writeConcern": "W2"
21 }'
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 "encryptedCredentials": false,
6 "id": "{S3-OPLOG-CONFIG-ID}",
7 "labels": [
8 "l1",
9 "l2"
10 ],
11 "links": [
12 {
13 "href": "https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/admin/backup/oplog/s3Configs",
14 "rel": "self"
15 }
16 ],
17 "s3BucketEndpoint": "http://backup.example.com/oplog",
18 "s3BucketName": "oplog",
19 "uri": "mongodb://localhost:27017",
20 "ssl": true,
21 "writeConcern": "W2"
22}

戻る

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