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

項目一覧

Resource

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

Cloud Manager は、 2024年8月30日でMongoDB 3.6と4.0のオートメーション、バックアップおよびモニタリングのサポートを終了します。 MongoDB の配置をアップグレードするか、Atlas に移行してください。

Cloud Managerへのプログラムによるアクセスのための OAuth 2.0認証はプレビュー機能として利用できます。: 機能および関連するドキュメントは、プレビュー期間中にいつでも変更される可能性があります。 OAuth2.0 認証を使用するには、 Cloud Manager Public APIへのリクエストで使用するサービスアカウントを作成します。

指定されたタイプのすべてのエージェントを取得します（つまり、プロジェクトのモニタリング、バックアップ、オートメーションなど）をサポートします。

注意

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

ベース URL: https://cloud.mongodb.com/api/public/v 1.0

Resource

GET /groups/{PROJECT-ID}/agents/{TYPE}

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

名前	タイプ	説明
プロジェクトID	string	エージェント API キーを所有するプロジェクトの一意の識別子。
タイプ	string	検索するエージェントの種類。 Typeは次のいずれかの値になります。 `MONITORING` `BACKUP` `AUTOMATION`

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

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

名前	タイプ	必要性	説明	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 リクエスト本体パラメータを使用しません。

応答

名前	タイプ	説明
`typeName`	string	エージェントのタイプ: `MONITORING` 、 `BACKUP` 、または`AUTOMATION` 。
`hostname`	string	プライマリホスト名。ホストには通常、エイリアスが存在する可能性があるため、Cloud Managerによって決定された、使用可能な最適な名前はプライマリになります。
`confCount`	数値	構成呼び出しの数。
`lastConf`	タイムスタンプ	前回の構成呼び出しの日時。
`stateName`	string	エージェントの現在の状態。 `stateName`は次の値を返すことができます。 `ACTIVE`: エージェントがアクティブであり、 `STANDBY`: エージェントはスタンバイ `NO_PROCESSES`: エージェントは、プロセスを管理、監視、またはバックアップしていません。
`pingCount`	数値	モニタリングエージェントにのみ適用されます。モニタリングエージェントが`hostname` URL に送信した ping の数。
`isManaged`	ブール値	モニタリングエージェントとバックアップエージェントにのみ適用されます。 Cloud Manager がエージェントを管理するかどうかを指定します。
`lastPing`	タイムスタンプ	モニタリングエージェントにのみ適用されます。最新の ping の時間。
`tag`	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"

応答例

応答ヘッダー

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" : [],
  "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
}

戻る

リンクを取得

APIキーの作成

注意