すべてのプロダクト
Search
ドキュメントセンター

Cloud Monitor:DescribeGroupMonitoringAgentProcess

最終更新日:Jan 23, 2026

アプリケーショングループのプロセス監視タスクを照会します。

操作説明

プロセス監視タスクを作成して、アプリケーショングループ内のすべてまたは指定された Elastic Compute Service (ECS) インスタンスを監視し、そのタスクのアラートルールを設定できます。

今すぐお試しください

この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

テスト

RAM 認証

下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

  • アクション:特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。

  • API:アクションを具体的に実行するための API。

  • アクセスレベル:各 API に対して事前定義されているアクセスの種類。有効な値:create、list、get、update、delete。

  • リソースタイプ:アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。

    • リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。

    • リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。

  • 条件キー:サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。

  • 依存アクション:ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

cms:DescribeGroupMonitoringAgentProcess

get

*All Resource

*

なし なし

リクエストパラメーター

パラメーター

必須 / 任意

説明

GroupId

string

必須

アプリケーショングループの ID。

12345

ProcessName

string

任意

プロセス名。

sshd

PageNumber

integer

任意

ページ番号。デフォルト値:1

1

PageSize

integer

任意

1 ページあたりのエントリー数。デフォルト値:10。

10

レスポンスフィールド

フィールド

説明

object

レスポンスパラメーター。

RequestId

string

リクエスト ID。

7985D471-3FA8-4EE9-8F4B-45C19DF3D36F

Success

boolean

リクエストが成功したかどうかを示します。有効値:true および false。

true

Code

string

HTTP ステータスコード。

説明

ステータスコード 200 は、リクエストが成功したことを示します。

200

Message

string

エラーメッセージ。

The Request is not authorization.

PageNumber

string

ページ番号。デフォルト値:1

1

PageSize

string

1 ページあたりのエントリー数。デフォルト値:10。

10

Total

string

返されたエントリーの総数。

28

Processes

object

Process

array<object>

プロセス監視タスク。

array<object>

プロセス監視タスク。

ProcessName

string

プロセス名。

sshd

MatchExpressFilterRelation

string

インスタンスを照合するために使用される条件式間の論理演算子。有効値:

  • all

  • and

  • or

and

GroupId

string

アプリケーショングループの ID。

12345

Id

string

プロセス監視タスクの ID。

3F6150F9-45C7-43F9-9578-A58B2E72****

MatchExpress

object

MatchExpress

array<object>

一致条件。

説明

条件式を満たすインスタンスのみが、プロセス監視タスクによって監視されます。

object

Value

string

インスタンス名に一致するキーワード。

portalHost

Name

string

インスタンスが照合される基準。

説明

値を name に設定します。値 name は、インスタンスがインスタンス名に基づいて照合されることを示します。

name

Function

string

一致条件。有効値:

  • all (デフォルト):すべてに一致

  • startWith:プレフィックスで始まる

  • endWith:サフィックスで終わる

  • contains:含む

  • notContains:含まない

  • equals:等しい

説明

一致したインスタンスは、プロセス監視タスクによって監視されます。

all

AlertConfig

object

AlertConfig

array<object>

アラートルールの設定。

array<object>

アラートルールの設定。

ComparisonOperator

string

メトリック値としきい値を比較するために使用される比較演算子。有効値:

  • GreaterThanOrEqualToThreshold:しきい値以上

  • GreaterThanThreshold:しきい値より大きい

  • LessThanOrEqualToThreshold:しきい値以下

  • LessThanThreshold:しきい値未満

  • NotEqualToThreshold:しきい値と等しくない

  • GreaterThanYesterday:昨日の同時刻のメトリック値より大きい

  • LessThanYesterday:昨日の同時刻のメトリック値より小さい

  • GreaterThanLastWeek:先週の同時刻のメトリック値より大きい

  • LessThanLastWeek:先週の同時刻のメトリック値より小さい

  • GreaterThanLastPeriod:前回の監視サイクルのメトリック値より大きい

  • LessThanLastPeriod:前回の監視サイクルのメトリック値より小さい

GreaterThanOrEqualToThreshold

SilenceTime

string

トリガー条件が満たされても新しいアラート通知が送信されないミュート期間。単位:秒。最小値:3600 (1 時間に相当)。デフォルト値:86400 (1 日に相当)。

説明

メトリック値が複数回アラートしきい値を超えた場合でも、各ミュート期間中には 1 つのアラート通知しか送信されません。

86400

Webhook

string

アラートルールに基づいてアラートがトリガーされたときに POST リクエストが送信されるコールバック URL。

http://www.aliyun.com

Times

string

しきい値を連続して超えることができる回数。

説明

メトリック値が指定された回数連続してしきい値に達した後にのみ、アラートがトリガーされます。

3

EscalationsLevel

string

アラートのレベル。有効値:

  • critical

  • warn

  • Info

warn

NoEffectiveInterval

string

アラートルールが無効になる期間。

00:00-23:59

EffectiveInterval

string

アラートルールが有効になる期間。

00:00-23:59

Threshold

string

アラートのしきい値。

5

Statistics

string

アラートをトリガーするメトリック値を計算するために使用されるメソッド。

Average

TargetList

object

Target

array<object>

アラートがトリガーされるリソース。

object

アラートがトリガーされるリソース。

Id

string

アラートがトリガーされるリソースの ID。

123

Arn

string

リソースの Alibaba Cloud リソースネーム (ARN)。フォーマット:acs:{Service name abbreviation}:{regionId}:{userId}:/{Resource type}/{Resource name}/message。例:acs:mns:cn-hangzhou:120886317861****:/queues/test123/message。フィールド:

  • {Service name abbreviation}:サービス名の略称。値を Simple Message Queue (旧称:MNS) (SMQ) に設定します。

  • {userId}:Alibaba Cloud アカウントの ID。

  • {regionId}:SMQ キューまたは Topic のリージョン ID。

  • {Resource type}:アラートがトリガーされるリソースのタイプ。有効値:

    • queues

    • topics

  • {Resource name}:リソース名。

    • リソースタイプが queues の場合、リソース名はキュー名です。

    • リソースタイプが topics の場合、リソース名は Topic 名です。

acs:mns:cn-hangzhou:120886317861****:/queues/test/message

Level

string

アラートレベル。有効値:

  • INFO

  • WARN

  • CRITICAL

CRITICAL

JsonParmas

string

アラートコールバックのパラメーター。パラメーターは JSON フォーマットです。

{"customField1":"value1","customField2":"$.name"}

成功レスポンス

JSONJSON

{
  "RequestId": "7985D471-3FA8-4EE9-8F4B-45C19DF3D36F",
  "Success": true,
  "Code": "200",
  "Message": "The Request is not authorization.",
  "PageNumber": "1",
  "PageSize": "10",
  "Total": "28",
  "Processes": {
    "Process": [
      {
        "ProcessName": "sshd",
        "MatchExpressFilterRelation": "and",
        "GroupId": "12345",
        "Id": "3F6150F9-45C7-43F9-9578-A58B2E72****",
        "MatchExpress": {
          "MatchExpress": [
            {
              "Value": "portalHost",
              "Name": "name",
              "Function": "all"
            }
          ]
        },
        "AlertConfig": {
          "AlertConfig": [
            {
              "ComparisonOperator": "GreaterThanOrEqualToThreshold",
              "SilenceTime": "86400",
              "Webhook": "http://www.aliyun.com",
              "Times": "3",
              "EscalationsLevel": "warn",
              "NoEffectiveInterval": "00:00-23:59",
              "EffectiveInterval": "00:00-23:59",
              "Threshold": "5",
              "Statistics": "Average",
              "TargetList": {
                "Target": [
                  {
                    "Id": "123",
                    "Arn": "acs:mns:cn-hangzhou:120886317861****:/queues/test/message",
                    "Level": "CRITICAL",
                    "JsonParmas": "{\"customField1\":\"value1\",\"customField2\":\"$.name\"}"
                  }
                ]
              }
            }
          ]
        }
      }
    ]
  }
}

エラーコード

HTTP ステータスコード

エラーコード

エラーメッセージ

説明

400 ParameterInvalid Illegal parameters.
500 InternalError The request processing has failed due to some unknown error.
403 AccessForbidden User not authorized to operate on the specified resource.
404 ResourceNotFound The specified resource is not found. The specified resource is not found.

完全なリストについては、「エラーコード」をご参照ください。

変更履歴

完全なリストについては、「変更履歴」をご参照ください。