调用CreateHybridMonitorTask接口创建阿里云产品的数据接入任务或SLS日志的监控项。

接口说明

前提条件

请确保您已开通企业云监控。具体操作，请参见开通企业云监控。
如果您需要创建 SLS 日志的监控项，请确保您已开通 SLS 日志服务，且已创建日志项目（Project）和日志库（Logstore）。具体操作，请参见快速入门。

使用说明

本文将提供一个示例，创建阿里云产品的数据接入任务aliyun_task，将云服务器 ECS 的监控项cpu_total接入指标仓库aliyun。返回结果显示，创建数据接入任务成功。

调试

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

调试

授权信息

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

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

操作	访问级别	资源类型	条件关键字	关联操作
cms:CreateHybridMonitorTask	create	全部资源 *	无	无

请求参数

名称	类型	必填	描述	示例值
Namespace	string	是	指标仓库名称。关于如何获取指标仓库名称，请参见 DescribeHybridMonitorNamespaceList 。	aliyun
Description	string	否	监控任务描述。	阿里云产品数据接入任务。
TaskName	string	否	监控任务名称。当`TaskType`为`aliyun_fc`时，输入阿里云产品的数据接入任务名称。当`TaskType`为`aliyun_sls`时，输入 SLS 日志的监控项名称。	aliyun_task
TaskType	string	是	监控任务类型。取值： aliyun_fc：阿里云产品的数据接入任务。 aliyun_sls：SLS 日志的监控项。	aliyun_fc
CollectTargetType	string	是	监控数据的采集目标类型。当`TaskType`为`aliyun_fc`时，输入`aliyun_fc`。当`TaskType`为`aliyun_sls`时，输入 SLS 日志的 Logstore 组名称。	aliyun_fc
CollectInterval	string	否	监控项的采集周期。取值： 15 60（默认值）单位：秒。说明仅当`TaskType`为`aliyun_sls`时，需要设置该参数。	60
GroupId	string	否	应用分组 ID。关于如何获取应用分组 ID，请参见 DescribeMonitorGroups 。说明仅当`TaskType`为`aliyun_sls`时，需要设置该参数。	3607****
YARMConfig	string	否	接入企业云监控的阿里云产品的配置文件。 namespace：阿里云产品的命名空间。关于如何查询阿里云产品的命名空间，请参见 DescribeMetricMetaList 。 metric_list：阿里云服务的监控项。关于如何查询阿里云产品的监控项，请参见 DescribeMetricMetaList 。配置文件示例如下： `products: - namespace: acs_ecs_dashboard metric_info: - metric_list: - cpu_total - cpu_idle - diskusage_utilization - CPUUtilization - DiskReadBPS - InternetOut - IntranetOut - cpu_system - namespace: acs_rds_dashboard metric_info: - metric_list: - MySQL_QPS - MySQL_TPS` 说明当`TaskType`为`aliyun_fc`时，必须设置该参数。	products:- namespace: acs_ecs_dashboard metric_info: - metric_list: - cpu_total
TargetUserId	string	否	成员 ID。当您通过管理账号调用 API 时，可以选择将资源目录中的任意成员的阿里云产品接入企业云监控。通过资源目录实现企业跨账号统一监控目标阿里云产品。说明仅当`TaskType`为`aliyun_fc`时，需要设置该参数。	120886317861****
AttachLabels	array<object>	否	监控项的标签。说明仅当`TaskType`为`aliyun_sls`时，需要设置该参数。
	object	否	无。
Value	string	否	监控项的标签值。	testValue
Name	string	否	监控项的标签键。	app_service
TargetUserIdList	string	否	成员 ID。多个成员 ID 之间用半角逗号（,）分隔。说明仅当您通过管理账号调用本接口时，需要设置该参数。	120886317861****
SLSProcessConfig	object	否	SLS 日志配置。说明仅当`TaskType`为`aliyun_sls`时，需要设置该参数。
Filter	object	否	SLS 日志中参数的过滤条件。
Relation	string	否	多个参数过滤条件之间的关系。取值： and（默认值）：满足所有过滤条件，才处理日志。 or：满足任意过滤条件，即可处理日志。	and
Filters	array<object>	否	SLS 日志中参数的过滤条件列表。
	object	否	无。
SLSKeyName	string	否	SLS 日志中过滤的参数名称。	code
Operator	string	否	SLS 日志中参数值的过滤方式。取值： `contain`：包含。 `notContain`：不包含。 `>`：大于。 `<`：小于。 `=`：等于。 `!=`：不等于。 `>=`：大于等于。 `<=`：小于等于。	=
Value	string	否	SLS 日志中参数的过滤值。	200
Statistics	array<object>	否	SLS 日志的统计方式。
	object	否	无。
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	否	无。
SLSKeyName	string	否	SLS 日志统计的参数名称。	code
Alias	string	否	SLS 日志统计结果的别名。	ApiResult
Express	array<object>	否	SLS 日志统计结果的扩展字段的四则运算结果。
	object	否	无。
Express	string	否	SLS 日志统计结果的扩展字段的四则运算结果。	success_count
Alias	string	否	SLS 日志统计结果的扩展字段的四则运算结果的别名。	SuccRate
CloudAccessId	array	否	其他云厂商接入云监控的主账号 ID 列表。
	string	否	其他云厂商接入云监控的主账号 ID。	n5n9ik1b****

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

返回参数

名称	类型	描述	示例值
	object	无。
Code	string	状态码。说明 200 表示成功。	200
Message	string	错误信息。	yamlConfigFail
RequestId	string	请求 ID。	28CEA2E0-3E90-51B2-A7E8-B1ED75534E49
Success	string	操作是否成功。取值： true：成功。 false：失败。	true
TaskId	long	监控任务 ID。	36****

示例

正常返回示例

JSON格式

{
  "Code": "200",
  "Message": "yamlConfigFail",
  "RequestId": "28CEA2E0-3E90-51B2-A7E8-B1ED75534E49",
  "Success": "true",
  "TaskId": 0
}

错误码

HTTP status code	错误码	错误信息
400	%s	%s
500	InternalError	The request processing has failed due to some unknown error.

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

变更历史

变更时间	变更内容概要	操作
2023-12-21	OpenAPI 错误码发生变更、OpenAPI 入参发生变更	查看变更详情
2021-12-09	OpenAPI 错误码发生变更、OpenAPI 入参发生变更	查看变更详情