ID を使用して 1 つの同期ストア構成を取得
MongoDB Ops Manager v6.0 は 1 月 2025 で EOL になります。 可能な限りすぐに MongoDB Ops Manager の上位バージョンにアップグレードしてください。
1 つの同期ストアの構成を取得します。
ベース URL: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/admin/backup
Resource
GET /sync/mongoConfigs/{SYNC-STORE-CONFIG-ID}
リクエスト パス パラメーター
名前 | タイプ | 説明 |
|---|---|---|
SYNC-STORE-CONFIG-ID | string | このoplog構成を表す一意の識別子。 |
リクエスト クエリ パラメータ
次のクエリ パラメータは 任意です。
名前 | タイプ | 必要性 | 説明 | default | ||||||
|---|---|---|---|---|---|---|---|---|---|---|
pretty | ブール値 | 任意 | レスポンス本体を pretty-print に含めるかどうかを示すフラグ 形式。 | false | ||||||
envelope | ブール値 | 任意 | 応答をエンベロープでラップするかどうかを示すフラグ。 一部の APIクライアントは、 HTTPレスポンス ヘッダーまたはステータス コードにアクセスできません。 これを修正するには、クエリでenvelope=trueを設定します。 1 つの結果を返すエンドポイントの場合、レスポンス本体には次のものが含まれます。
| false |
リクエスト ボディ パラメータ
このエンドポイントは、HTTP リクエスト本体パラメータを使用しません。
応答
名前 | タイプ | 説明 |
|---|---|---|
割り当てEnabled | ブール値 | この同期ストアにバックアップジョブを割り当てることができるかどうかを示すフラグ。 |
encryptionCredentials | ブール値 | この同期ストアのユーザー名とパスワードが認証情報ツールを使用して暗号化されているかどうかを示すフラグ。 |
id | string | この同期ストアにラベルを付ける一意の名前。 |
labels | 文字列の配列 | がどの MongoDB Ops Manager同期ストア に割り当てることができる バックアップジョブ を管理するためのタグの配列。 |
Links | オブジェクト配列 | サブリソースや関連リソースへの 1 つ以上のリンク。 応答内のすべての |
maxCapacityGB | 数値 | この同期ストアが保存できるデータの最大量（GB 単位）。 |
uri | string | この同期ストアにアクセスするために使用できる <hostname:port>形式のホストのカンマ区切りリスト。 |
ssl | ブール値 | この同期ストアがTLSを使用して暗号化された接続のみを受け入れるかどうかを示すフラグ。 |
usedSize | 数値 | 既存のバックアップが消費するバックアップ容量の量（ MB単位）。 |
writeConcern | string | この同期ストアに使用された書込み保証 (write concern) です。 このオプションに指定できる値は以下のとおりです。
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/sync/mongoConfigs/{SYNC-STORE-CONFIG-ID}?pretty=true'
応答例
応答ヘッダー
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
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}
レスポンス本体
{ "assignmentEnabled" : true, "encryptedCredentials" : false, "id" : "{CONFIG-ID}", "labels" : [ "l1", "l2" ], "links" : [ { "href" : "https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/admin/backup/sync/mongoConfigs/{SYNC-STORE-CONFIG-ID}", "rel" : "self" }], "maxCapacityGB" : 8, "uri" : "mongodb://localhost:27017", "ssl" : true, "usedSize" : 222, "writeConcern" : "W2" }