ID を使用して 1 つのバックアップデーモン構成を取得

項目一覧

Resource

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

1 つのバックアップデーモンの構成を取得します。

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

Resource

GET /daemon/configs/{MACHINE}/{HEAD-ROOT-DIRECTORY}

名前	タイプ	必要性	説明
マシン	string	必須	バックアップデーモンを提供するマシンのホスト名または IP アドレス。
ヘッドルートディレクトリ	string	任意	ルート相対 URL エンコードパスこのバックアップデーモンホスト上のヘッドディレクトリのバックアップデーモンが設定されていない場合は、を省略できます。

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

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

名前

タイプ

必要性

説明

default

pretty

ブール値

任意

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

false

envelope

ブール値

任意

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

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

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

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

false

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

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

応答

名前	タイプ	説明
`assignmentEnabled`	ブール値	このバックアップデーモンにバックアップジョブを割り当てることができるかどうかを示すフラグ。
`backupJobsEnabled`	ブール値	このバックアップデーモンがデータベースのバックアップに使用できるかどうかを示すフラグ。
`configured`	ブール値	このバックアップデーモンが使用可能かどうかを示すフラグ。
`garbageCollectionEnabled`	ブール値	このバックアップデーモンにガベージコレクションが設定されているかどうかを示すフラグ。
`headDiskType`	string	ヘッドディレクトリを保存するために使用されるディスクのタイプ。このオプションに指定できる値は以下のとおりです。 `HDD` `SSD`
`id`	string	このバックアップデーモンの一意の識別子。
`labels`	文字列の配列	がどの MongoDB Ops Managerバックアップデーモンに割り当てることができるバックアップジョブを管理するためのタグの配列。
`links`	オブジェクト配列	サブリソースや関連リソースへの 1 つ以上のリンク。応答内のすべての`links`配列には、 `self`と呼ばれるリンクが少なくとも 1 つ含まれています。 URL の関係は、 Web リンク仕様で説明されています。
`machine`	オブジェクト	バックアップデーモンのホストとそのヘッドディレクトリ。
`machine.headRootDirectory`	string	このバックアップデーモンホスト上のヘッドディレクトリのルート相対パス。
`machine.machine`	string	バックアップデーモンホストのホスト名または IP アドレス。
`numWorkers`	数値	タスクを実行できるワーカープロセスの数（つまり、バックアップ、復元、またはグルーム）を作成します。
`resourceUsageEnabled`	ブール値	このバックアップデーモンのリソース使用量が監視されているかどうかを示すフラグ。
`restoreQueryableJobsEnabled`	ブール値	このバックアップデーモンがクエリ可能な復元を実行できるかどうかを示すフラグ。

リクエストの例

curl --user '{PUBLIC-KEY}:{PRIVATE-KEY}' --digest \
 --header 'Accept: application/json' \
 --include \
 --request GET 'https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/admin/backup/daemon/configs/{MACHINE}/{HEAD-ROOT-DIRECTORY}?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}

レスポンス本体

{
  "assignmentEnabled" : true,
  "backupJobsEnabled" : false,
  "configured" : true,
  "garbageCollectionEnabled" : true,
  "headDiskType" : "SSD",
  "id" : "5991a422ad5df350005dd062",
  "labels" : [ "l1", "l2" ],
  "links" : [ {
    "href" : "https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/admin/backup/daemon/configs/{MACHINE}/{HEAD-ROOT-DIRECTORY}",
    "rel" : "self"
  }],
  "machine" : {
    "headRootDirectory" : "/data/backup/",
    "machine" : "localhost"
  },
  "numWorkers" : 50,
  "resourceUsageEnabled" : true,
  "restoreJobsEnabled" : false,
  "restoreQueryableJobsEnabled" : true
}

戻る

バックアップデーモン

すべて取得