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

Cloud Monitor:DescribeHybridMonitorTaskList

最終更新日:Jan 23, 2026

メトリックインポートタスクをクエリします。

操作説明

このトピックでは、現在の Alibaba Cloud アカウントに属するすべてのメトリックインポートタスクをクエリする方法の例を示します。返された結果は、現在のアカウントにメトリックインポートタスクが 1 つしかないことを示しています。メトリックインポートタスクの名前は aliyun_task です。

今すぐお試しください

この 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:DescribeHybridMonitorTaskList

list

*All Resource

*

なし なし

リクエストパラメーター

パラメーター

必須 / 任意

説明

Keyword

string

任意

検索に使用されるキーワードです。

task

TaskId

string

任意

メトリックインポートタスクの ID です。

36****

GroupId

string

任意

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

アプリケーショングループの ID を取得する方法の詳細については、「DescribeMonitorGroups」をご参照ください。

3607****

Namespace

string

任意

名前空間の名前です。

名前空間の名前を取得する方法の詳細については、「DescribeHybridMonitorNamespaceList」をご参照ください。

aliyun

PageSize

integer

任意

1 ページあたりのエントリー数です。

ページは 1 ページから始まります。デフォルト値:10。

10

PageNumber

integer

任意

ページ番号です。

ページは 1 ページから始まります。デフォルト値:1。

1

IncludeAliyunTask

boolean

任意

返される結果に Alibaba Cloud サービスのメトリックインポートタスクを含めるかどうかを指定します。有効な値:

  • true (デフォルト):返される結果には Alibaba Cloud サービスのメトリックインポートタスクが含まれます。

  • false:返される結果には Alibaba Cloud サービスのメトリックインポートタスクは含まれません。

true

TaskType

string

任意

メトリックインポートタスクのタイプです。有効な値:

  • aliyun_fc:Alibaba Cloud サービスのメトリックインポートタスク

  • aliyun_sls:Log Service からインポートされたログのメトリック

列挙値:

  • aliyun_sls :

    aliyun_sls

aliyun_fc

TargetUserId

integer

任意

メンバーアカウントの ID です。

説明

このパラメーターは、管理アカウントを使用してこの操作を呼び出し、リソースディレクトリ内のメンバーに属するメトリックインポートタスクを削除する場合にのみ必要です。この場合、TaskType パラメーターは aliyun_fc に設定されます。

120886317861****

共通リクエストパラメーターの詳細については、「共通パラメーター」をご参照ください。

レスポンスフィールド

フィールド

説明

object

なし

RequestId

string

リクエスト ID です。

11145B76-566A-5D80-A8A3-FAD98D310079

Success

string

リクエストが成功したかどうかを示します。有効な値:

  • true

  • false

true

Code

string

状態コードです。

説明

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

200

Message

string

返されたメッセージです。

  • リクエストが成功した場合、successful の値が返されます。

  • リクエストが失敗した場合、エラーメッセージが返されます。

success

PageSize

integer

1 ページあたりのエントリー数です。

10

PageNumber

integer

ページ番号です。

1

Total

integer

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

1

TaskList

array<object>

メトリックインポートタスクです。

array<object>

なし

YARMConfig

string

ハイブリッドクラウド監視を使用して監視する Alibaba Cloud サービスの設定ファイルです。

  • namespace:Alibaba Cloud サービスの名前空間です。

  • metric_list:Alibaba Cloud サービスのメトリックです。

products:- namespace: acs_ecs_dashboard metric_info: - metric_list: - cpu_total

CreateTime

string

メトリックインポートタスクが作成されたときのタイムスタンプです。

単位:ミリ秒。

1639382496000

TaskName

string

メトリックインポートタスクの名前です。

aliyun_task

Namespace

string

ホストが属する名前空間です。

aliyun

UploadRegion

string

ホストが存在するリージョンです。

cn-hangzhou

NetworkType

string

ホストのネットワークタイプです。有効な値:

  • vpc

  • Internet

vpc

CollectTimout

integer

CloudMonitor エージェントがホストのモニタリングデータを収集するタイムアウト期間です。有効な値:

  • 0

  • 15

  • 30

  • 60

単位:秒。

15

CollectTargetEndpoint

string

CloudMonitor エージェントがホストのモニタリングデータを収集する宛先の URL です。

http://localhost

TaskType

string

メトリックインポートタスクのタイプです。有効な値:

  • aliyun_fc:Alibaba Cloud サービスのメトリックインポートタスク

  • aliyun_sls:Log Service からインポートされたログのメトリック

aliyun_sls

MatchExpressRelation

string

メトリックインポートタスクをフィルターするために使用される条件間の関係です。有効な値:

  • or

  • and

or

Description

string

メトリックインポートタスクの説明です。

aliyun

GroupId

string

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

3607****

CollectInterval

integer

CloudMonitor エージェントがホストのモニタリングデータを収集する間隔です。有効な値:

  • 15

  • 30

  • 60

単位:秒。

60

TargetUserId

string

メンバーアカウントの ID です。

説明

このパラメーターは、管理アカウントを使用してこの操作を呼び出した場合にのみ表示されます。

120886317861****

CollectTargetPath

string

CloudMonitor エージェントがモニタリングデータを収集する相対パスです。

/metrics

CollectTargetType

string

モニタリングデータのタイプです。有効な値:Spring、Tomcat、Nginx、Tengine、JVM、Redis、MySQL。

nginx

TaskId

string

メトリックインポートタスクの ID です。

36****

AttachLabels

array<object>

メトリックインポートタスクのタグです。

object

なし

Name

string

タグキーです。

key1

Value

string

タグの値です。

value1

MatchExpress

array<object>

アプリケーショングループ内のインスタンスを照合するために使用される条件です。

object

なし

Value

string

インスタンス名に対応するキーワードです。

ECS_instance1

Name

string

インスタンス名です。

name

Function

string

インスタンス名を照合するために使用されるメソッドです。有効な値:

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

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

  • all:すべてに一致

  • equals:等しい

  • contains:含む

  • notContains:含まない

all

Instances

array

モニタリングデータがバッチで収集されるインスタンスです。

string

インスタンス ID です。

i-hp368focau7dp0hw****

ExtraInfo

string

インスタンスの追加情報です。

test

LogFilePath

string

オンプレミスログデータが保存されるパスです。オンプレミスログデータは、CloudMonitor がデプロイされているホストの指定されたパスに保存されます。

  • Windows:ログパスはドライブ文字で始まる必要があります。例:C:\UserData\log\\*.Log。ログパスにワイルドカードは指定できません。

  • Linux:ログパスはスラッシュ (/) で始まる必要があります。例:/home/appdata/log/**/*.log。この例では、/**/ は appdata ディレクトリ内のすべてのファイルを照合するために使用されます。

C:\UserData\log\*.Log

LogSplit

string

指定された照合モードに基づいてオンプレミスログデータが分割された後に返される結果です。

説明

オンプレミスログデータの照合モードには、完全正規表現モード、区切り文字モード、JSON モードが含まれます。

{"type": "regex","regex": "\\d+\\.\\d+\\.\\d+\\.\\d+\\s+(\\d+)\\s+\\S+\\s+\\[\\d+/\\S+/\\d+:\\d+:\\d+:\\d+\\s+\\+\\d+\\]\\s+(\\S+)\\s+\\S+\\s+/\\S+/\\S+/\\S+\\s+(\\d+)","columns": [{"name": "field1"},{"name": "filed2","translate": {"default": "-","mappings": [{"from": "(\\w+)","to": "$1x","type": "regex"}]}},{"name": "filed3","translate": {"default": "-","mappings": [{"from": "NumberRange(100,300)","to": "true","type": "function"}]}}]}

LogProcess

string

オンプレミスログデータを集約するために使用されるメソッドです。

[{"metric": "metric1","filters": [{"column": "filed2","type": "include","values": ["222222"]}],"groupBys": [{"column": "filed3","name": "filed3"}],"calculates": [{"column": "field1","name": "avg","type": "avg"}]},{"metric": "metric2","filters": [{"column": "field1","type": "include","values": ["11111"]}],"groupBys": [{"column": "filed2","name": "filed2"}],"calculates": [{"column": "field1","name": "avg","type": "avg"}]}]

LogSample

string

サンプルのオンプレミスログです。

{"logContent":"100.116.134.26 1119 - [13/Aug/2019:16:55:46 +0800] POST metrichub-cn-hongkong.aliyun.com /agent/metrics/putLines 200 0 \"-\" \"127.0.0.1:7001\" \"Go-http-client/1.1\" \"-\" \"-\" \"0a98a21a15656865460656276e\"","addData":{"field1":["1119","1119"],"filed2":["POSTx","POST"],"filed3":["true","200"]}}

SLSProcess

string

Log Service からインポートされたログの設定です。

{"express": [],"filter": {"filters": [{"key": "task_type","operator": "=","value": "1"}]},"groupby": [{"alias": "isp","key": "isp","sqlKey": "t.`isp`","valueKey": "isp"}],"interval": 60,"labels": [{"name": "__cms_app__","type": 0,"value": "sitemonitor"}],"statistics": [{"alias": "http_dns_time_avg","function": "avg","key": "http_dns_time"}]}

SLSProcessConfig

object

Log Service からインポートされたログの設定です。

説明

このパラメーターは、TaskType パラメーターが aliyun_sls に設定されている場合にのみ返されます。

Filter

object

Log Service からインポートされたログをフィルターするために使用される条件です。

Relation

string

複数のフィルター条件間の関係です。有効な値:

  • and (デフォルト):すべてのフィルター条件が満たされた場合にのみログが処理されます。

  • or:フィルター条件のいずれかが満たされた場合にログが処理されます。

and

Filters

array<object>

Log Service からインポートされたログをフィルターするために使用される条件です。

object

Log Service からインポートされたログをフィルターするために使用される条件です。

SLSKeyName

string

Log Service からインポートされたログをフィルターするために使用されるキーの名前です。

host

Operator

string

Log Service からインポートされたログをフィルターするために使用されるメソッドです。有効な値:

  • contain:含む

  • notContain:含まない

  • >:より大きい

  • <:より小さい

  • =:等しい

  • ! =:等しくない

  • >=:以上

  • <=:以下

=

Value

string

Log Service からインポートされたログをフィルターするために使用されるキーの値です。

200

Statistics

array<object>

Log Service からインポートされたログを集約するために使用されるメソッドです。

object

Log Service からインポートされたログを集約するために使用されるメソッドです。

SLSKeyName

string

Log Service からインポートされたログを集約するために使用されるキーの名前です。

name

Function

string

統計期間内にログデータを集約するために使用される関数です。有効な値:

  • count:数をカウントします。

  • sum:合計値を計算します。

  • avg:平均値を計算します。

  • max:最大値を計算します。

  • min:最小値を計算します。

  • value:統計期間内にサンプルを収集します。

  • countps:次の数式を使用して、指定されたフィールドの 1 秒あたりの平均数を計算します:指定されたフィールドのカウント数/統計期間内の合計秒数。

  • sumps:次の数式を使用して、指定されたフィールドの 1 秒あたりの平均数を計算します:指定されたフィールドの合計値/統計期間内の合計秒数。

  • distinct:統計期間内に指定されたフィールドが表示されるログの数をカウントします。

  • distribution:統計期間内に指定された条件を満たすログの数をカウントします。

  • percentile:指定されたフィールドの値を昇順にソートし、統計期間内に指定されたパーセンタイルにある値を返します。例:P50。

count

Alias

string

集約結果のエイリアスです。

level_count

Parameter1

string

Log Service からインポートされたログを集約するために使用される関数の値です。

  • Function パラメーターが distribution に設定されている場合、このパラメーターは統計間隔の下限を示します。たとえば、200 は、ステータスコードが 2XX である HTTP リクエストの数が計算されることを示します。

  • Function パラメーターが percentile に設定されている場合、このパラメーターは期待値があるパーセンタイルを指定します。たとえば、0.5 は P50 を指定します。

200

Parameter2

string

Log Service からインポートされたログを集約するために使用される関数の値です。

説明

このパラメーターは、Function パラメーターが distribution に設定されている場合にのみ返されます。このパラメーターは、統計間隔の上限を示します。たとえば、299 は、ステータスコードが 2XX である HTTP リクエストの数が計算されることを示します。

299

GroupBy

array<object>

データが集約されるディメンションです。このパラメーターは、SQL の GROUP BY 句に相当します。

object

データが集約されるディメンションです。このパラメーターは、SQL の GROUP BY 句に相当します。

SLSKeyName

string

Log Service からインポートされたログを集約するために使用されるキーの名前です。

code

Alias

string

集約結果のエイリアスです。

ApiResult

Express

array<object>

集約結果に対して実行される基本操作の結果を示す拡張フィールドです。

object

集約結果に対して実行される基本操作の結果を示す拡張フィールドです。

Express

string

集約結果に対して実行される基本操作の結果を示す拡張フィールドです。

success_count

Alias

string

集約結果に対して実行される基本操作の結果を示す拡張フィールドのエイリアスです。

SuccRate

成功レスポンス

JSONJSON

{
  "RequestId": "11145B76-566A-5D80-A8A3-FAD98D310079",
  "Success": "true",
  "Code": "200",
  "Message": "success",
  "PageSize": 10,
  "PageNumber": 1,
  "Total": 1,
  "TaskList": [
    {
      "YARMConfig": "products:- namespace: acs_ecs_dashboard metric_info: - metric_list: - cpu_total",
      "CreateTime": "1639382496000",
      "TaskName": "aliyun_task",
      "Namespace": "aliyun",
      "UploadRegion": "cn-hangzhou",
      "NetworkType": "vpc",
      "CollectTimout": 15,
      "CollectTargetEndpoint": "http://localhost",
      "TaskType": "aliyun_sls",
      "MatchExpressRelation": "or",
      "Description": "aliyun",
      "GroupId": "3607****",
      "CollectInterval": 60,
      "TargetUserId": "120886317861****",
      "CollectTargetPath": "/metrics",
      "CollectTargetType": "nginx",
      "TaskId": "36****",
      "AttachLabels": [
        {
          "Name": "key1",
          "Value": "value1"
        }
      ],
      "MatchExpress": [
        {
          "Value": "ECS_instance1",
          "Name": "name",
          "Function": "all"
        }
      ],
      "Instances": [
        "i-hp368focau7dp0hw****"
      ],
      "ExtraInfo": "test",
      "LogFilePath": "C:\\UserData\\log\\*.Log",
      "LogSplit": "{\"type\": \"regex\",\"regex\": \"\\\\d+\\\\.\\\\d+\\\\.\\\\d+\\\\.\\\\d+\\\\s+(\\\\d+)\\\\s+\\\\S+\\\\s+\\\\[\\\\d+/\\\\S+/\\\\d+:\\\\d+:\\\\d+:\\\\d+\\\\s+\\\\+\\\\d+\\\\]\\\\s+(\\\\S+)\\\\s+\\\\S+\\\\s+/\\\\S+/\\\\S+/\\\\S+\\\\s+(\\\\d+)\",\"columns\": [{\"name\": \"field1\"},{\"name\": \"filed2\",\"translate\": {\"default\": \"-\",\"mappings\": [{\"from\": \"(\\\\w+)\",\"to\": \"$1x\",\"type\": \"regex\"}]}},{\"name\": \"filed3\",\"translate\": {\"default\": \"-\",\"mappings\": [{\"from\": \"NumberRange(100,300)\",\"to\": \"true\",\"type\": \"function\"}]}}]}",
      "LogProcess": "[{\"metric\": \"metric1\",\"filters\": [{\"column\": \"filed2\",\"type\": \"include\",\"values\": [\"222222\"]}],\"groupBys\": [{\"column\": \"filed3\",\"name\": \"filed3\"}],\"calculates\": [{\"column\": \"field1\",\"name\": \"avg\",\"type\": \"avg\"}]},{\"metric\": \"metric2\",\"filters\": [{\"column\": \"field1\",\"type\": \"include\",\"values\": [\"11111\"]}],\"groupBys\": [{\"column\": \"filed2\",\"name\": \"filed2\"}],\"calculates\": [{\"column\": \"field1\",\"name\": \"avg\",\"type\": \"avg\"}]}]",
      "LogSample": "{\"logContent\":\"100.116.134.26 1119 - [13/Aug/2019:16:55:46 +0800] POST metrichub-cn-hongkong.aliyun.com /agent/metrics/putLines 200 0 \\\"-\\\" \\\"127.0.0.1:7001\\\" \\\"Go-http-client/1.1\\\" \\\"-\\\" \\\"-\\\" \\\"0a98a21a15656865460656276e\\\"\",\"addData\":{\"field1\":[\"1119\",\"1119\"],\"filed2\":[\"POSTx\",\"POST\"],\"filed3\":[\"true\",\"200\"]}}",
      "SLSProcess": "{\"express\": [],\"filter\": {\"filters\": [{\"key\": \"task_type\",\"operator\": \"=\",\"value\": \"1\"}]},\"groupby\": [{\"alias\": \"isp\",\"key\": \"isp\",\"sqlKey\": \"t.`isp`\",\"valueKey\": \"isp\"}],\"interval\": 60,\"labels\": [{\"name\": \"__cms_app__\",\"type\": 0,\"value\": \"sitemonitor\"}],\"statistics\": [{\"alias\": \"http_dns_time_avg\",\"function\": \"avg\",\"key\": \"http_dns_time\"}]}",
      "SLSProcessConfig": {
        "Filter": {
          "Relation": "and",
          "Filters": [
            {
              "SLSKeyName": "host",
              "Operator": "=",
              "Value": "200"
            }
          ]
        },
        "Statistics": [
          {
            "SLSKeyName": "name",
            "Function": "count",
            "Alias": "level_count",
            "Parameter1": "200",
            "Parameter2": "299"
          }
        ],
        "GroupBy": [
          {
            "SLSKeyName": "code",
            "Alias": "ApiResult"
          }
        ],
        "Express": [
          {
            "Express": "success_count",
            "Alias": "SuccRate"
          }
        ]
      }
    }
  ]
}

エラーコード

HTTP ステータスコード

エラーコード

エラーメッセージ

説明

400 %s %s
500 %s %s
500 InternalError %s
403 %s %s
404 %s %s

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

変更履歴

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