CreateHybridMonitorTask - 云监控

前提条件

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

使用说明

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

调试

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

请求参数


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

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

返回数据


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

示例

请求示例

http(s)://[Endpoint]/?Action=CreateHybridMonitorTask
&Namespace=aliyun
&TaskName=aliyun_task
&TaskType=aliyun_fc
&YARMConfig=products:
- namespace: acs_ecs_dashboard
  metric_info:
  - metric_list:
    - cpu_total
&<公共请求参数>

正常返回示例

XML格式

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

<CreateHybridMonitorTaskResponse>
	<TaskId>36****</TaskId>
	<RequestId>28CEA2E0-3E90-51B2-A7E8-B1ED75534E49</RequestId>
	<Code>200</Code>
	<Success>true</Success>
</CreateHybridMonitorTaskResponse>

JSON格式

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

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

错误码

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