1 つの S3 ブロックストア構成の更新

項目一覧

Resource

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

1 つの s3 ブロックストアの構成を更新します。

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

Resource

PUT /snapshot/s3Configs/{S3-BLOCKSTORE-CONFIG-ID}

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

名前	タイプ	説明
S3-BLOCKSTORE-CONFIG-ID	string	この S3 ブロックストア構成にラベルを付ける一意の名前。

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

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

名前

タイプ

必要性

説明

default

pretty

ブール値

任意

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

false

envelope

ブール値

任意

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

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

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

名前	説明
`status`	HTTPレスポンスコード
`content`	期待される応答本体

false

リクエストボディパラメータ

名前

タイプ

必要性

説明

acceptTos

ブール値

必須

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

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

割り当て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

ブール値

任意

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

labels

文字列の配列

任意

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

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

loadFactory

数値

任意

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

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

pathTypeAccessEnabled

ブール値

必須

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

値	S3 ブロックストアエンドポイントの形式	例
`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は、 awsAccessKeyとawsSecretKeyを使用して、 s3BbucketNameで指定された S3 互換ストレージバケットへのアクセスを許可します。
`IAM_ROLE`	MongoDB Ops Managerは、 Amazon Web Services IAMロールを使用して、 s3bucketNameで指定された S3 互換ストレージバケットへのアクセスを承認します。 awsAccessKeyとawsSecretKeyフィールドは無視されます。詳しくは、Amazon Web Services のドキュメントを参照してください。

s3bucketEndpoint

string

必須

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

s3bucketName

string

必須

S3 互換ストレージブロックストアをホストする S3 互換ストレージバケットの名前。

s3MaxConnections

数値

必須

この S3 互換ストレージブロックストアへの最大接続数を示す正の整数。

s3RegionServeride

string

条件付き

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

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

sseEnabled

ブール値

必須

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

uri

string

必須

この S3 互換ストレージブロックストアにアクセスできるホストのコンマ区切りリスト（ <hostname:port>形式）。

ssl

ブール値

任意

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

writeConcern

string

任意

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

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

ACKNOWLEDGED
W2
JOURNALED
MAJORITY

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

応答

名前

タイプ

説明

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

ブール値

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

string

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

labels

文字列の配列

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

Links

オブジェクト配列

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

loadFactory

integer

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

pathTypeAccessEnabled

ブール値

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

値	S3 ブロックストアエンドポイントの形式	例
`true`	パス形式のURLエンドポイント	`s3.amazonaws.com/<bucket>`
`false`	仮想ホストスタイルのURLエンドポイント	`<bucket>.s3.amazonaws.com`

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

s3Authメソッド

string

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

このオプションに指定できる値はKEYS 、 IAM_ROLEです。

`KEYS` またはなし	MongoDB Ops Manager は、 `awsAccessKey`と`awsSecretKey`を使用して、 `s3BucketName`で指定された S3 互換ストレージバケットへのアクセスを承認します。
`IAM_ROLE`	MongoDB Ops Managerは、 Amazon Web Services IAMロールを使用して、`s3BucketName` で指定された S3 互換ストレージバケットへのアクセスを承認します。 `awsAccessKey`フィールドと`awsSecretKey`フィールドは無視されます。詳しくは、Amazon Web Services のドキュメントを参照してください。

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

ブール値

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

uri

string

この S3 互換ストレージブロックストアのメタデータデータベースに接続する接続string 。このデータベースは、 Amazon Web Services S3 互換のストレージバケットにブロックの場所を保存します。

writeConcern

string

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

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

ACKNOWLEDGED
W2
JOURNALED
MAJORITY

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

リクエストの例

1 curl --user '{PUBLIC-KEY}:{PRIVATE-KEY}' --digest \
2      --header 'Accept: application/json' \
3      --header 'Content-Type: application/json' \
4      --include \
5      --request PUT 'https://<OpsManagerHost>:<Port>/api/public/v1.0/admin/backup/snapshot/s3Configs/{S3-BLOCKSTORE-CONFIG-ID}?pretty=true' \
6      --data '{
7        "assignmentEnabled": true,
8        "awsAccessKey": "<access>",
9        "awsSecretKey": "<secret>",
10        "encryptedCredentials": false,
11        "labels": [
12          "l1",
13          "l2"
14        ],
15        "loadFactor": 50,
16        "s3BucketEndpoint": "http://example.com/backupbucket",
17        "s3BucketName": "bucketname",
18        "uri": "mongodb://localhost:27017",
19        "ssl": true,
20        "writeConcern": "W2"
21      }'

1 curl --user '{PUBLIC-KEY}:{PRIVATE-KEY}' --digest \
2      --header 'Accept: application/json' \
3      --header 'Content-Type: application/json' \
4      --include \
5      --request PUT 'https://<OpsManagerHost>:<Port>/api/public/v1.0/admin/backup/snapshot/s3Configs/{S3-BLOCKSTORE-CONFIG-ID}?pretty=true' \
6      --data '{
7        "assignmentEnabled": true,
8        "encryptedCredentials": false,
9        "labels": [
10          "l1",
11          "l2"
12        ],
13        "loadFactor": 50,
14        "s3AuthMethod": "IAM_ROLE",
15        "s3BucketEndpoint": "http://example.com/backupbucket",
16        "s3BucketName": "bucketname",
17        "uri": "mongodb://localhost:27017",
18        "ssl": true,
19        "writeConcern": "W2"
20      }'

応答例

応答ヘッダー

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   "acceptedTos": true,
3   "assignmentEnabled": true,
4   "awsAccessKey": "<access>",
5   "awsSecretKey": "<secret>",
6   "encryptedCredentials": false,
7   "id": "{S3-BLOCKSTORE-CONFIG-ID}",
8   "labels": [
9     "l1",
10     "l2"
11   ],
12   "links": [
13     {
14       "href": "https://<OpsManagerHost>:<Port>/api/public/v1.0/admin/backup/snapshot/s3Configs",
15       "rel": "self"
16     }
17   ],
18   "loadFactor": 50,
19   "pathStyleAccessEnabled": false,
20   "s3AuthMethod": "KEYS",
21   "s3BucketEndpoint": "http://example.com/backupbucket",
22   "s3BucketName": "bucketname",
23   "s3MaxConnections": 50,
24   "sseEnabled": true,
25   "ssl": false,
26   "uri": "mongodb://127.0.0.1:27017",
27   "writeConcern": "W2"
28 }

1 {
2   "acceptedTos": true,
3   "assignmentEnabled": true,
4   "encryptedCredentials": false,
5   "id": "{S3-BLOCKSTORE-CONFIG-ID}",
6   "labels": [
7     "l1",
8     "l2"
9   ],
10   "links": [
11     {
12       "href": "https://<OpsManagerHost>:<Port>/api/public/v1.0/admin/backup/snapshot/s3Configs",
13       "rel": "self"
14     }
15   ],
16   "loadFactor": 50,
17   "pathStyleAccessEnabled": false,
18   "s3AuthMethod": "IAM_ROLE",
19   "s3BucketEndpoint": "http://example.com/backupbucket",
20   "s3BucketName": "bucketname",
21   "s3MaxConnections": 50,
22   "sseEnabled": true,
23   "ssl": false,
24   "uri": "mongodb://127.0.0.1:27017",
25   "writeConcern": "W2"
26 }

戻る

作成

削除

1	curl --user '{PUBLIC-KEY}:{PRIVATE-KEY}' --digest \
2	--header 'Accept: application/json' \
3	--header 'Content-Type: application/json' \
4	--include \
5	--request PUT 'https://<OpsManagerHost>:<Port>/api/public/v1.0/admin/backup/snapshot/s3Configs/{S3-BLOCKSTORE-CONFIG-ID}?pretty=true' \
6	--data '{
7	"assignmentEnabled": true,
8	"awsAccessKey": "<access>",
9	"awsSecretKey": "<secret>",
10	"encryptedCredentials": false,
11	"labels": [
12	"l1",
13	"l2"
14	],
15	"loadFactor": 50,
16	"s3BucketEndpoint": "http://example.com/backupbucket",
17	"s3BucketName": "bucketname",
18	"uri": "mongodb://localhost:27017",
19	"ssl": true,
20	"writeConcern": "W2"
21	}'

1	{
2	"acceptedTos": true,
3	"assignmentEnabled": true,
4	"awsAccessKey": "<access>",
5	"awsSecretKey": "<secret>",
6	"encryptedCredentials": false,
7	"id": "{S3-BLOCKSTORE-CONFIG-ID}",
8	"labels": [
9	"l1",
10	"l2"
11	],
12	"links": [
13	{
14	"href": "https://<OpsManagerHost>:<Port>/api/public/v1.0/admin/backup/snapshot/s3Configs",
15	"rel": "self"
16	}
17	],
18	"loadFactor": 50,
19	"pathStyleAccessEnabled": false,
20	"s3AuthMethod": "KEYS",
21	"s3BucketEndpoint": "http://example.com/backupbucket",
22	"s3BucketName": "bucketname",
23	"s3MaxConnections": 50,
24	"sseEnabled": true,
25	"ssl": false,
26	"uri": "mongodb://127.0.0.1:27017",
27	"writeConcern": "W2"
28	}

Resource

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

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

リクエスト ボディ パラメータ

応答

リクエストの例

応答例

応答ヘッダー

レスポンス本体

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

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

リクエストボディパラメータ