DescribeHybridMonitorTaskList - 查询数据接入任务列表 - 云监控

调用DescribeHybridMonitorTaskList接口查询数据接入任务列表。

接口说明

本文将提供一个示例，查询当前账号下的所有数据接入任务。返回结果显示，当前账号下只有一个数据接入任务aliyun_task。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

cms:DescribeHybridMonitorTaskList

list

*全部资源

*

无

请求参数

名称	类型	必填	描述	示例值
Keyword	string	否	搜索关键字。	task
TaskId	string	否	监控任务 ID。	36****
GroupId	string	否	应用分组 ID。关于如何获取应用分组 ID，请参见 DescribeMonitorGroups 。	3607****
Namespace	string	否	指标仓库名称。关于如何获取指标仓库名称，请参见 DescribeHybridMonitorNamespaceList 。	aliyun
PageSize	integer	否	分页时每页显示的数据行数。起始值：1。默认值：10。	10
PageNumber	integer	否	页码。起始值：1。默认值：1。	1
IncludeAliyunTask	boolean	否	返回结果是否包含阿里云产品的数据接入任务。取值： true（默认值）：包含。 false：不包含。	true
TaskType	string	否	监控任务类型。取值： aliyun_fc：阿里云产品的数据接入任务。 aliyun_sls：SLS 日志的监控项。枚举值： 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	返回信息。当操作成功时，返回`success`。当操作失败时，返回错误信息。	success
PageSize	integer	分页时每页显示的数据行数。	10
PageNumber	integer	页码。	1
Total	integer	总记录条数。	1
TaskList	array<object>	监控任务列表。
	array<object>	无。
YARMConfig	string	接入企业云监控的阿里云产品的配置文件。 namespace：阿里云产品的命名空间。 metric_list：阿里云服务的监控项。	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	云监控插件采集主机监控数据的超时时间。取值： 0 15 30 60 单位：秒。	15
CollectTargetEndpoint	string	云监控插件采集主机监控数据的地址。	http://localhost
TaskType	string	监控任务类型。取值： aliyun_fc：阿里云产品的数据接入任务。 aliyun_sls：SLS 日志的监控项。	aliyun_sls
MatchExpressRelation	string	监控任务的实例过滤条件。取值： or：或。 and：和。	or
Description	string	监控任务描述。	aliyun
GroupId	string	应用分组 ID。	3607****
CollectInterval	integer	云监控插件采集主机监控数据的间隔时间。取值： 15 30 60 单位：秒。	60
TargetUserId	string	成员 ID。说明仅当您通过管理账号调用本接口时，显示该参数。	120886317861****
CollectTargetPath	string	云监控 Agent 采集的时候，采集的相对路径。	/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	本地日志数据保存在云监控所在主机的指定路径。 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	SLS 日志数据的配置信息。	{"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	SLS 日志配置。说明仅当`TaskType`为`aliyun_sls`时，显示该参数。
Filter	object	SLS 日志中参数的过滤条件。
Relation	string	多个参数过滤条件之间的关系。取值： and（默认值）：满足所有过滤条件，才处理日志。 or：满足任意过滤条件，即可处理日志。	and
Filters	array<object>	SLS 日志中参数的过滤条件。
	object	SLS 日志中参数的过滤条件。
SLSKeyName	string	SLS 日志中过滤的参数名称。	host
Operator	string	SLS 日志中参数值的过滤方式。取值： `contain`：包含。 `notContain`：不包含。 `>`：大于。 `<`：小于。 `=`：等于。 `!=`：不等于。 `>=`：大于等于。 `<=`：小于等于。	=
Value	string	SLS 日志中参数的过滤值。	200
Statistics	array<object>	SLS 日志的统计方式。
	object	SLS 日志的统计方式。
SLSKeyName	string	SLS 日志统计的参数名称。	name
Function	string	在计算周期内根据选定的统计方法对日志数据进行聚合处理。取值： count：计数。 sum：求和。 avg：平均值。 max：最大值。 min：最小值。 value：周期内采样。 countps：计算统计周期内指定字段求 count 后的每秒平均值。 sumps：计算统计周期内指定字段求 sum 后的每秒平均值。 distinct：去重后计算统计周期内指定字段出现的次数。 distribution：计算字段值在一个区间内的出现次数。 percentile：计算字段值的分布值，例如：P50。	count
Alias	string	SLS 日志统计结果的别名。	level_count
Parameter1	string	SLS 日志的统计值。当`Function`为`distribution`时，表示统计区间的下限，例如：统计 HttpCode 的 2XX 数量，填写 200。当`Function`为`percentile`时，表示统计分布的百分位，例如：0.5 表示 P50。	200
Parameter2	string	SLS 日志的统计值。说明仅当`Function`为`distribution`时，需要设置该参数。表示统计区间的上限，例如：统计 HttpCode 的 2XX 数量，填写 299。	299
GroupBy	array<object>	对数据进行空间维度聚合，相当于 SQL 中的 Group By。
	object	对数据进行空间维度聚合，相当于 SQL 中的 Group By。
SLSKeyName	string	SLS 日志统计的参数名称。	code
Alias	string	SLS 日志统计结果的别名。	ApiResult
Express	array<object>	SLS 日志统计结果的扩展字段的四则运算结果。
	object	SLS 日志统计结果的扩展字段的四则运算结果。
Express	string	SLS 日志统计结果的扩展字段的四则运算结果。	success_count
Alias	string	SLS 日志统计结果的扩展字段的四则运算结果的别名。	SuccRate

示例

正常返回示例

JSON格式

{
  "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 status code	错误码	错误信息
400	%s	%s
500	%s	%s
500	InternalError	%s
403	%s	%s
404	%s	%s

访问错误中心查看更多错误码。

变更历史

更多信息，参考变更详情。