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

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

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String 是 DescribeHybridMonitorTaskList

要执行的操作，取值：DescribeHybridMonitorTaskList。
Keyword String 否 task

搜索关键字。
TaskId String 否 36****

监控任务ID。
GroupId String 否 3607****

应用分组ID。

关于如何获取应用分组ID，请参见DescribeMonitorGroups。
Namespace String 否 aliyun

指标仓库名称。

关于如何获取指标仓库名称，请参见DescribeHybridMonitorNamespaceList。
PageSize Integer 否 10

分页时每页显示的数据行数。

起始值：1。默认值：10。
PageNumber Integer 否 1

页码。

起始值：1。默认值：1。
IncludeAliyunTask Boolean 否 true

返回结果是否包含阿里云产品的数据接入任务。取值：

  • true（默认值）：包含。
  • false：不包含。
TaskType String 否 aliyun_fc

监控任务类型。取值：

  • aliyun_fc：阿里云产品的数据接入任务。
  • aliyun_sls：SLS日志的监控项。
TargetUserId Long 否 120886317861****

成员ID。

说明 仅当您通过管理账号调用本接口删除成员的阿里云数据接入任务（即TaskType为aliyun_fc）时，需要设置该参数。

关于公共请求参数的详情，请参见公共参数。

返回数据

名称 类型 示例值 描述
RequestId String 11145B76-566A-5D80-A8A3-FAD98D310079

请求ID。
Success String true

操作是否成功。取值：

  • true：成功。
  • false：失败。
Code String 200

状态码。

说明 200表示成功。
Message String success

返回信息。

  • 当操作成功时，返回success。
  • 当操作失败时，返回错误信息。
PageSize Integer 10

分页时每页显示的数据行数。
PageNumber Integer 1

页码。
Total Integer 1

总记录条数。
TaskList Array of TaskList

监控任务列表。
YARMConfig String products:- namespace: acs_ecs_dashboard metric_info: - metric_list: - cpu_total

接入企业云监控的阿里云产品的配置文件。

  • namespace：阿里云产品的命名空间。
  • metric_list：阿里云服务的监控项。
CreateTime String 1639382496000

创建监控任务的时间戳。

单位：毫秒。
TaskName String aliyun_task

监控任务名称。
Namespace String aliyun

主机归属的指标仓库。
UploadRegion String cn-hangzhou

主机归属的地域。
NetworkType String vpc

主机的网络类型。取值：

  • vpc：专有网络。
  • Internet：公网。
CollectTimout Integer 15

云监控插件采集主机监控数据的超时时间。取值：

  • 0
  • 15
  • 30
  • 60

单位：秒。
CollectTargetEndpoint String http://localhost

云监控插件采集主机监控数据的地址。
TaskType String aliyun_sls

监控任务类型。取值：

  • aliyun_fc：阿里云产品的数据接入任务。
  • aliyun_sls：SLS日志的监控项。
MatchExpressRelation String or

监控任务的实例过滤条件。取值：

  • or：或。
  • and：和。
Description String aliyun

监控任务描述。
GroupId String 3607****

应用分组ID。
CollectInterval Integer 60

云监控插件采集主机监控数据的间隔时间。取值：

  • 15
  • 30
  • 60

单位：秒。
TargetUserId String 120886317861****

成员ID。

说明 仅当您通过管理账号调用本接口时，显示该参数。
CollectTargetPath String /metrics

云监控Agent采集的时候，采集的相对路径。
CollectTargetType String nginx

采集目标类型。包括：Spring、Tomcat、Nginx、Tengine、JVM、Redis和MySQL等。
TaskId String 36****

监控任务ID。
AttachLabels Array of AttachLabels

监控任务的标签。
Name String key1

标签键。
Value String value1

标签值。
MatchExpress Array of MatchExpress

应用分组中实例的匹配条件。
Value String ECS_instance1

实例名称的值。
Name String name

实例名称。
Function String all

实例名称的匹配方法。取值：

  • startWith：前缀。
  • endWith：后缀。
  • all：全部。
  • equals：等于。
  • contains：包含。
  • notContains：不包含。
Instances Array of String i-hp368focau7dp0hw****

实例ID。
ExtraInfo String test

实例的附加信息。
LogFilePath String C:\UserData\log\*.Log

本地日志数据保存在云监控所在主机的指定路径。

  • Windows：仅支持盘符开头，例如：C:\UserData\log\*.Log（不支持通配路径）。
  • Linux：仅支持以“/”开头，例如：/home/appdata/log/**/*.log（/**/用于匹配appdata下的所有文件）。
LogSplit String {"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"}]}}]}

本地日志数据根据不同匹配模式的切分结果。

说明 本地日志数据的匹配模式包括：完整正则模式、分隔符模式和JSON模式。
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 {"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"}]}

SLS日志数据的配置信息。
SLSProcessConfig Object

SLS日志配置。

说明 仅当TaskType为aliyun_sls时，显示该参数。
Filter Object

SLS日志中参数的过滤条件。
Relation String and

多个参数过滤条件之间的关系。取值：

  • and（默认值）：满足所有过滤条件，才处理日志。
  • or：满足任意过滤条件，即可处理日志。
Filters Array of Filters

SLS日志中参数的过滤条件。
SLSKeyName String host

SLS日志中过滤的参数名称。
Operator String =

SLS日志中参数值的过滤方式。取值：

  • contain：包含。
  • notContain：不包含。
  • >：大于。
  • <：小于。
  • =：等于。
  • !=：不等于。
  • >=：大于等于。
  • <=：小于等于。
Value String 200

SLS日志中参数的过滤值。
Statistics Array of Statistics

SLS日志的统计方式。
SLSKeyName String name

SLS日志统计的参数名称。
Function String count

在计算周期内根据选定的统计方法对日志数据进行聚合处理。取值：

  • count：计数。
  • sum：求和。
  • avg：平均值。
  • max：最大值。
  • min：最小值。
  • value：周期内采样。
  • countps：计算统计周期内指定字段求count后的每秒平均值。
  • sumps：计算统计周期内指定字段求sum后的每秒平均值。
  • distinct：去重后计算统计周期内指定字段出现的次数。
  • distribution：计算字段值在一个区间内的出现次数。
  • percentile：计算字段值的分布值，例如：P50。
Alias String level_count

SLS日志统计结果的别名。
Parameter1 String 200

SLS日志的统计值。

  • 当Function为distribution时，表示统计区间的下限，例如：统计HttpCode的2XX数量，填写200。
  • 当Function为percentile时，表示统计分布的百分位，例如：0.5表示P50。
Parameter2 String 299

SLS日志的统计值。

说明 仅当Function为distribution时，需要设置该参数。表示统计区间的上限，例如：统计HttpCode的2XX数量，填写299。
GroupBy Array of GroupBy

对数据进行空间维度聚合，相当于SQL中的Group By。
SLSKeyName String code

SLS日志统计的参数名称。
Alias String ApiResult

SLS日志统计结果的别名。
Express Array of Express

SLS日志统计结果的扩展字段的四则运算结果。
Express String success_count

SLS日志统计结果的扩展字段的四则运算结果。
Alias String SuccRate

SLS日志统计结果的扩展字段的四则运算结果的别名。

示例

请求示例

http(s)://[Endpoint]/?Action=DescribeHybridMonitorTaskList
&<公共请求参数>

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeHybridMonitorTaskListResponse>
	<RequestId>11145B76-566A-5D80-A8A3-FAD98D310079</RequestId>
	<PageSize>10</PageSize>
	<PageNumber>1</PageNumber>
	<Total>1</Total>
	<TaskList>
		<CollectTimout>15</CollectTimout>
		<CollectInterval>0</CollectInterval>
		<Description></Description>
		<TaskId>36****</TaskId>
		<CreateTime>1639382496000</CreateTime>
		<YARMConfig></YARMConfig>
		<CollectTargetPath></CollectTargetPath>
		<Namespace>aliyun</Namespace>
		<GroupId>0</GroupId>
		<MatchExpressRelation></MatchExpressRelation>
		<SLSProcess>{\"express\":[],\"filter\":{\"filters\":[]},\"groupby\":[],\"interval\":60,\"labels\":[],\"statistics\":[{\"alias\":\"referer_count\",\"function\":\"count\",\"key\":\"referer\"}]}</SLSProcess>
		<CollectTargetEndpoint></CollectTargetEndpoint>
		<TaskName>aliyun_task</TaskName>
		<UploadRegion>unknown</UploadRegion>
		<NetworkType>vpc</NetworkType>
		<TaskType>aliyun_sls</TaskType>
		<CollectTargetType></CollectTargetType>
		<TargetUserId></TargetUserId>
	</TaskList>
	<Code>200</Code>
	<Success>true</Success>
</DescribeHybridMonitorTaskListResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "11145B76-566A-5D80-A8A3-FAD98D310079",
  "PageSize" : 10,
  "PageNumber" : 1,
  "Total" : 1,
  "TaskList" : [ {
    "CollectTimout" : 15,
    "CollectInterval" : 0,
    "Description" : "",
    "TaskId" : "36****",
    "CreateTime" : 1639382496000,
    "AttachLabels" : [ ],
    "YARMConfig" : "",
    "CollectTargetPath" : "",
    "Namespace" : "aliyun",
    "GroupId" : 0,
    "MatchExpressRelation" : "",
    "Instances" : [ ],
    "SLSProcess" : "{\"express\":[],\"filter\":{\"filters\":[]},\"groupby\":[],\"interval\":60,\"labels\":[],\"statistics\":[{\"alias\":\"referer_count\",\"function\":\"count\",\"key\":\"referer\"}]}",
    "CollectTargetEndpoint" : "",
    "TaskName" : "aliyun_task",
    "UploadRegion" : "unknown",
    "NetworkType" : "vpc",
    "TaskType" : "aliyun_sls",
    "CollectTargetType" : "",
    "TargetUserId" : ""
  } ],
  "Code" : 200,
  "Success" : true
}

错误码

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