名前	タイプ	説明
割り当てEnabled	ブール値	任意。この同期ストアにバックアップジョブを割り当てることができるかどうかを示すフラグ。
encryptionCredentials	ブール値	任意。この同期ストアのユーザー名とパスワードが認証情報ツールを使用して暗号化されているかどうかを示すフラグ。
id	string	この同期ストアにラベルを付ける一意の名前。
labels	文字列の配列	任意。がどの MongoDB Ops Manager同期ストアに割り当てることができるバックアップジョブを管理するためのタグの配列。これらのタグを設定すると、この同期ストアが処理できるバックアップジョブが制限されます。省略した場合、この同期ストアは、ジョブをフィルタリングするためにラベルを使用しないプロジェクトのバックアップジョブのみを処理できます。
maxCapacityGB	数値	任意。OUTSIDE_SPACE_USED_thresholdアラートで使用される同期ストアの予想最大利用キャパシティー。`maxCapacityGB` はバッキングデータベースのサイズに制限を適用しません。
uri	string	この同期ストアにアクセスするために使用できる`<hostname:port>`形式のホストのカンマ区切りリスト。
ssl	ブール値	任意。この同期ストアがTLSを使用して暗号化された接続のみを受け入れるかどうかを示すフラグ。
writeConcern	string	任意。この同期ストアに使用された書込み保証 (write concern) です。このオプションに指定できる値は以下のとおりです。 `ACKNOWLEDGED` `W2` `JOURNALED` `MAJORITY` MongoDB の書込み (write) 確認応答レベルの詳細については、「書込み保証 (write concern) 」を参照してください。

応答

名前	タイプ	説明
割り当てEnabled	ブール値	この同期ストアにバックアップジョブを割り当てることができるかどうかを示すフラグ。
encryptionCredentials	ブール値	この同期ストアのユーザー名とパスワードがcredentialstool で暗号化されているかどうかを示すフラグ。
id	string	この同期ストアにラベルを付ける一意の名前。
labels	文字列の配列	がどの MongoDB Ops Manager同期ストアに割り当てることができるバックアップジョブを管理するためのタグの配列。
Links	オブジェクト配列	サブリソースや関連リソースへの 1 つ以上のリンク。応答内のすべての `links` 配列には、`self` と呼ばれるリンクが少なくとも 1 つ含まれています。URLの関係は、Web リンク仕様で説明されています。
maxCapacityGB	数値	任意。OUTSIDE_SPACE_USED_thresholdアラートで使用される同期ストアの予想最大利用キャパシティー。`maxCapacityGB` はバッキングデータベースのサイズに制限を適用しません。
uri	string	この同期ストアにアクセスするために使用できる`<hostname:port>`形式のホストのカンマ区切りリスト。
ssl	ブール値	この同期ストアがTLSを使用して暗号化された接続のみを受け入れるかどうかを示すフラグ。
usedSize	数値	既存のバックアップが消費するバックアップ容量の量（ MB単位）。
writeConcern	string	この同期ストアに使用された書込み保証 (write concern) です。このオプションに指定できる値は以下のとおりです。 `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 POST 'https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/admin/backup/sync/mongoConfigs?pretty=true' \
6      --data '{
7        "assignmentEnabled" : true,
8        "encryptedCredentials" : false,
9        "id" : "{SYNCSTORE-CONFIG-ID}",
10        "labels" : [ "l1", "l2" ],
11        "maxCapacityGB" : 8,
12        "uri" : "mongodb://localhost:27017",
13        "ssl" : true,
14        "writeConcern" : "W2"
15      }'

応答例

応答ヘッダー

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   "encryptedCredentials" : false,
4   "id" : "{SYNCSTORE-CONFIG-ID}",
5   "labels" : [ "l1", "l2" ],
6   "links" : [ {
7     "href" : "https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/admin/backup/sync/mongoConfigs",
8     "rel" : "self"
9   }],
10   "maxCapacityGB" : 8,
11   "uri" : "mongodb://localhost:27017",
12   "ssl" : true,
13   "usedSize" : 222,
14   "writeConcern" : "W2"
15 }

戻る

すべて取得

Update

1	curl --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/sync/mongoConfigs?pretty=true' \
6	--data '{
7	"assignmentEnabled" : true,
8	"encryptedCredentials" : false,
9	"id" : "{SYNCSTORE-CONFIG-ID}",
10	"labels" : [ "l1", "l2" ],
11	"maxCapacityGB" : 8,
12	"uri" : "mongodb://localhost:27017",
13	"ssl" : true,
14	"writeConcern" : "W2"
15	}'

Resource

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

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

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

応答

リクエストの例

応答例

応答ヘッダー

レスポンス本体

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

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

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