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

すべての同期ストア構成を取得する

項目一覧

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

すべての同期ストアの構成を取得します。

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

GET /sync/mongoConfigs

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

名前
タイプ
必要性
説明
default
pageNum
数値
任意
結果のサブセクションを返す 1 から始まる整数。
1
itemsPerPage
数値
任意
1 ページあたりに返す項目の数は最大 500 です。
100
pretty
ブール値
任意
レスポンス本体を pretty-print に含めるかどうかを示すフラグ 形式。
false
envelope
ブール値
任意

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

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

結果のリストを返すエンドポイントの場合、 resultsオブジェクトはエンベロープです。 MongoDB Ops Manager は、レスポンス本体にstatusフィールドを追加します。

false
backupJobsEnabledOnly
ブール値
任意
データベースのバックアップ用に有効になっていないデーモンを応答から除外するかどうかを示すフラグ。 これをfalseに設定し、 backupJobsEnabledフラグがfalseに設定されているデーモン構成を含めます。
true
assignableOnly
ブール値
この同期ストアに新しいバックアップジョブを割り当てることができるかどうかを示すフラグ。
true

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

レスポンスJSONドキュメントには、 resultオブジェクトの配列、 linkオブジェクトの配列、および取得されたresultオブジェクトの合計数が含まれます。

名前
タイプ
説明
results
配列
配列には、 results埋め込みドキュメントセクションに詳細な項目ごとに 1 つのオブジェクトが含まれます。
links
配列
配列には、サブリソースや関連リソースへの 1 つ以上のリンクが含まれます。 URL 間の関係は、 Web リンク仕様 で説明されています。
totalCount
数値
結果セット内の項目の合計数の整数。 結果セット全体がページ分割される場合は、 results配列内のオブジェクト数よりも大きくなる可能性があります。

結果は 1 つの同期ストアです。

名前
タイプ
説明
割り当てEnabled
ブール値
この同期ストアにバックアップジョブを割り当てることができるかどうかを示すフラグ。
encryptionCredentials
ブール値
この同期ストアのユーザー名とパスワードが認証情報ツールを使用して暗号化されているかどうかを示すフラグ。
id
string
この同期ストアにラベルを付ける一意の名前。
labels
文字列の配列
がどの MongoDB Ops Manager同期ストア に割り当てることができる バックアップジョブ を管理するためのタグの配列。
Links
オブジェクト配列

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

maxCapacityGB
数値
この同期ストアが保存できるデータの最大量(GB 単位)。
uri
string
この同期ストアにアクセスするために使用できる<hostname:port>形式のホストのカンマ区切りリスト。
ssl
ブール値
この同期ストアがTLSを使用して暗号化された接続のみを受け入れるかどうかを示すフラグ。
usedSize
数値
既存のバックアップが消費するバックアップ容量の量( MB単位)。
writeConcern
string

この同期ストアに使用された書込み保証 (write concern) です。

このオプションに指定できる値は以下のとおりです。

  • 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/sync/mongoConfigs?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}
{
"links" : [ {
"href" : "http://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/admin/backup/sync/mongoConfigs?pretty=true&pageNum=1&itemsPerPage=100",
"rel" : "self"
} ],
"results" : [ {
"assignmentEnabled" : true,
"encryptedCredentials" : false,
"id" : "{CONFIG-ID}",
"labels" : [ "l1", "l2" ],
"links" : [ {
"href" : "https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/admin/backup/sync/mongoConfigs/{SYNCSTORE-ID}",
"rel" : "self"
}],
"maxCapacityGB" : 8,
"uri" : "mongodb://localhost:27017",
"ssl" : true,
"usedSize" : 222,
"writeConcern" : "W2"
} ],
"totalCount" : 1
}

戻る

ID を使用して 1 つの同期ストア構成を取得