すべてのブロックストア構成を取得する

項目一覧

Resource

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

すべてのブロックストアの構成を取得します。

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

Resource

GET /snapshot/mongoConfigs

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

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

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

名前	タイプ	必要性	説明	default
pageNum	数値	任意	結果のサブセクションを返す 1 から始まる整数。	`1`
itemsPerPage	数値	任意	1 ページあたりに返す項目の数は最大 500 です。	`100`
pretty	ブール値	任意	レスポンス本体を pretty-print に含めるかどうかを示すフラグ形式。	`false`
envelope	ブール値	任意	応答をエンベロープでラップするかどうかを示すフラグ。一部の APIクライアントは、 HTTPレスポンスヘッダーまたはステータスコードにアクセスできません。これを修正するには、クエリで`envelope : true`を設定します。結果のリストを返すエンドポイントの場合、 `content`オブジェクトはエンベロープです。 MongoDB Ops Manager は、レスポンス本体に`status`フィールドを追加します。	`false`

assignableOnly	ブール値	このブロックストアに新しいバックアップジョブを割り当てることができるかどうかを示すフラグ。	`true`

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

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

応答

応答ドキュメント

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

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

`results` embeddedDocument

各結果は 1 つのブロックストアです。

名前	タイプ	説明
割り当てEnabled	ブール値	このブロックストアにバックアップジョブを割り当てることができるかどうかを示すフラグ。
encryptionCredentials	ブール値	このブロックストアのユーザー名とパスワードが認証情報ツールを使用して暗号化されているかどうかを示すフラグ。
id	string	このブロックストアにラベルを付ける一意の名前。
labels	文字列の配列	がどのブロックストアに割り当てることができる MongoDB Ops Managerバックアップジョブを管理するためのタグの配列。
Links	オブジェクト配列	サブリソースや関連リソースへの 1 つ以上のリンク。応答内のすべての`links`配列には、 `self`と呼ばれるリンクが少なくとも 1 つ含まれています。 URL の関係は、 Web リンク仕様で説明されています。
loadFactory	数値	このスナップショットストアが別のスナップショットストアと比較して実行するバックアップ作業量を表すゼロ以外の正の整数。このオプションは、複数のスナップショットストアが使用されている場合にのみ必要です。 Load Factorの詳細については、「 1 つの既存のブロックストアの編集」を参照してください。
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/snapshot/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/snapshot/mongoConfigs?pretty=true&pageNum=1&itemsPerPage=100",
    "rel" : "self"
  } ],
  "results" : [ {
    "assignmentEnabled" : true,
    "encryptedCredentials" : false,
    "id" : "{BLOCKSTORE-CONFIG-ID}",
    "labels" : [ "l1", "l2" ],
    "links" : [ {
      "href" : "https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/admin/backup/snapshot/mongoConfigs/{BLOCKSTORE-CONFIG-ID}",
      "rel" : "self"
    }],
    "loadFactor" : 2,
    "maxCapacityGB" : 8,
    "uri" : "mongodb://localhost:27017",
    "ssl" : true,
    "usedSize" : 222,
    "writeConcern" : "W2"
  } ],
  "totalCount" : 1
}

戻る

ID を使用して 1 つのブロックストア構成を取得する

1 つのブロックストア構成を作成

Resource

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

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

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

応答