プロジェクトのエージェントリソースへのリンクを取得

項目一覧

Resource

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

プロジェクトのモニタリング、バックアップ、オートメーションエージェントのリソースへのリンクを取得します。

注意

グループとプロジェクトは同義語です。あなたの {PROJECT-ID}はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。このページでは、説明を参照するときに、より一般的な用語のグループを使用します。エンドポイントはドキュメントに記載されているままです。

ベースURL: https:// クラウド.mongodb.com/api/public/v 1.0

Resource

GET /groups/{PROJECT-ID}/agents

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

名前	タイプ	説明
プロジェクトID	string	エージェント API キーを所有するプロジェクトの一意の識別子。

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

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

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

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

応答

関係	説明
自己	Me
`http://mms.mongodb.com/group`	エージェントが属するプロジェクト
`http://mms.mongodb.com/monitoringAgents`	すべての監視エージェントへのリンク。
`http://mms.mongodb.com/backupAgents`	すべてのバックアップエージェントへのリンク。
`http://mms.mongodb.com/automationAgents`	すべてのオートメーションエージェントへのリンク。

例

リクエスト

curl --user '{PUBLIC-KEY}:{PRIVATE-KEY}' --digest \
     --header 'Accept: application/json' \
     --include \
     --request GET "https://cloud.mongodb.com/api/public/v1.0/groups/{PROJECT-ID}/agents"

応答

応答ヘッダー

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":"https://cloud.mongodb.com/api/public/v1.0/groups/{PROJECT-ID}/agents",
      "rel":"self"
    },
    {
      "href":"https://cloud.mongodb.com/api/public/v1.0/groups/{PROJECT-ID}",
      "rel":"http://mms.mongodb.com/group"
    },
    {
      "href":"https://cloud.mongodb.com/api/public/v1.0/groups/{PROJECT-ID}/agents/MONITORING",
      "rel":"http://mms.mongodb.com/monitoringAgents"
    },
    {
      "href":"https://cloud.mongodb.com/api/public/v1.0/groups/{PROJECT-ID}/agents/BACKUP",
      "rel":"http://mms.mongodb.com/backupAgents"
    },
    {
      "href":"https://cloud.mongodb.com/api/public/v1.0/groups/{PROJECT-ID}/agents/AUTOMATION",
      "rel":"http://mms.mongodb.com/automationAgents"
    }
  ]
}

戻る

エージェント

1 つのプロジェクトのタイプ別にエージェントを取得

注意