指定されたタイプのすべてのエージェントを取得します（つまり、 プロジェクトのモニタリング、バックアップ、オートメーションなど）をサポートします。
注意
グループとプロジェクトは同義語です。 あなたの {PROJECT-ID}はプロジェクト ID と同じです。 既存のグループの場合、グループ/プロジェクト ID は同じままです。 このページでは、説明を参照するときに、より一般的な用語の グループ を使用します。 エンドポイントは ドキュメントに記載されているままです。
ベース URL: https://cloud.mongodb.com/api/public/v1.0
Resource
GET /groups/{PROJECT-ID}/agents/{TYPE}
リクエスト パス パラメーター
名前 | タイプ | 説明 |
|---|---|---|
プロジェクトID | string | エージェント API キーを所有するプロジェクトの一意の識別子。 |
タイプ | string | 検索するエージェントの種類。 Typeは次のいずれかの値になります。
|
リクエスト クエリ パラメータ
次のクエリ パラメータは 任意です。
名前 | タイプ | 必要性 | 説明 | default |
|---|---|---|---|---|
pageNum | 数値 | 任意 | 結果のサブセクションを返す 1 から始まる整数。 |
|
itemsPerPage | 数値 | 任意 | 1 ページあたりに返す項目の数は最大 500 です。 |
|
pretty | ブール値 | 任意 | レスポンス本体を pretty-print 形式にするかどうかを示すフラグ。 |
|
envelope | ブール値 | 任意 | 応答をエンベロープでラップするかどうかを示すフラグ。 一部の APIクライアントは、 HTTPレスポンス ヘッダーまたはステータス コードにアクセスできません。 これを修正するには、クエリで 結果のリストを返すエンドポイントの場合、 |
|
backupJobsEnabledOnly | ブール値 | 任意 | データベースのバックアップ用に有効になっていないデーモンを応答から除外するかどうかを示すフラグ。 これを |
|
リクエスト ボディ パラメータ
このエンドポイントは、HTTP リクエスト本体パラメータを使用しません。
応答
名前 | タイプ | 説明 |
|---|---|---|
| string | エージェントのタイプ: |
| string | プライマリ ホスト名。 ホストには通常、エイリアスが存在する可能性があるため、Cloud Managerによって決定された、使用可能な最適な名前は プライマリ になります。 |
| 数値 | 構成呼び出しの数。 |
| タイムスタンプ | 前回の構成呼び出しの日時。 |
| string | エージェントの現在の状態。
|
| 数値 | モニタリングエージェント にのみ適用されます。 モニタリングエージェントが |
| ブール値 | モニタリングエージェントとバックアップエージェント にのみ適用されます。 Cloud Manager がエージェントを管理するかどうかを指定します。 |
| タイムスタンプ | モニタリングエージェント にのみ適用されます。 最新の ping の時間。 |
| string | バックアップエージェント にのみ適用されます。 エージェントの タグ （存在する場合）。 |
リクエストの例
1 つのプロジェクトのすべてのモニタリングエージェントを取得します。
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/MONITORING"
応答例
応答ヘッダー
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}
レスポンス本体
{ "links" : [], "results": [ { "confCount": 59, "hostname": "example", "isManaged": true, "lastConf": "2015-06-18T14:21:42Z", "lastPing": "2015-06-18T14:21:42Z", "pingCount": 6, "stateName": "ACTIVE", "typeName": "MONITORING" } ], "totalCount": 1 }