Docs Menu
Docs Home
/
MongoDB Ops Manager
/ / /

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

項目一覧

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

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

注意

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

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

GET /groups/{PROJECT-ID}/agents/{TYPE}
名前
タイプ
説明
プロジェクトID
string
エージェント API キーを所有するプロジェクトの一意の識別子。
タイプ
string

検索するエージェントの種類。 Typeは次のいずれかの値になります。

  • MONITORING

  • BACKUP

  • AUTOMATION

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

名前
タイプ
必要性
説明
default
pageNum
数値
任意
結果のサブセクションを返す 1 から始まる整数。
1
itemsPerPage
数値
任意
1 ページあたりに返す項目の数は最大 500 です。
100
pretty
ブール値
任意
false
envelope
ブール値
任意

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

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

結果のリストを返すエンドポイントの場合、 contentオブジェクトはエンベロープです。 MongoDB Ops Manager は、レスポンス本体にstatusフィールドを追加します。

false

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

名前
タイプ
説明
typeName
string
エージェントのタイプ: MONITORINGBACKUP 、またはAUTOMATION
hostname
string
プライマリ ホスト名。 ホストには通常、エイリアスが存在する可能性があるため、MongoDB Ops Manager によって決定された、使用可能な最適な名前は プライマリ です。
confCount
数値
構成呼び出しの数。
lastConf
タイムスタンプ
前回の構成呼び出しの日時。
stateName
string

エージェントの現在の状態。 stateNameは次の値を返すことができます。

  • ACTIVE: エージェントがアクティブであり、

  • STANDBY: エージェントはスタンバイ

  • NO_PROCESSES: エージェントは、プロセスを管理、監視、またはバックアップしていません。

pingCount
数値
モニタリングエージェント にのみ適用されます。 モニタリングエージェントがhostname URL に送信した ping の数。
isManaged
ブール値
モニタリングエージェントとバックアップエージェント にのみ適用されます。 MongoDB Ops Managerがエージェントを管理するかどうかを指定します。
lastPing
タイムスタンプ
モニタリングエージェント にのみ適用されます。 最新の ping の時間。
tag
string
バックアップエージェント にのみ適用されます。 エージェントの タグ (存在する場合)。

1 つのプロジェクトのすべてのモニタリングエージェントを取得します。

curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
--header "Accept: application/json" \
--include \
--request GET "https://<ops-manager-host>/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
}

戻る

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