CreateHybridMonitorTask-阿里云帮助中心

Calls the CreateHybridMonitorTask operation to create a data import task for an Alibaba Cloud service or a metric for Simple Log Service (SLS) logs.

Operation description

Before you begin

Make sure that you have activated Hybrid Cloud Monitoring. For more information, see Activate Hybrid Cloud Monitoring.
If you want to create a metric for SLS logs, make sure that you have activated SLS and created a project and a Logstore. For more information, see Quick Start.

Operation description

This topic provides an example of how to create a data import task named aliyun_task for an Alibaba Cloud service to import the cpu_total metric of Elastic Compute Service (ECS) into the aliyun metric repository. The response shows that the data import task is created.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

cms:CreateHybridMonitorTask

create

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
Namespace	string	Yes	The name of the metric repository. For information about how to obtain the name of a metric repository, see DescribeHybridMonitorNamespaceList.	aliyun
Description	string	No	The description of the monitoring task.	Alibaba Cloud product data ingestion task.
TaskName	string	No	The name of the monitoring task. If TaskType is set to `aliyun_fc`, specify the name of the data import task for the Alibaba Cloud service. If TaskType is set to `aliyun_sls`, specify the metric name for SLS logs.	aliyun_task
TaskType	string	Yes	The type of the monitoring task. Valid values: aliyun_fc: data import task for an Alibaba Cloud service. aliyun_sls: metric for SLS logs. Valid values: aliyun_fc : aliyun_fc aliyun_sls : aliyun_sls	aliyun_fc
CollectTargetType	string	Yes	The type of the collection target for monitoring data. If TaskType is set to `aliyun_fc`, set this parameter to `aliyun_fc`. If TaskType is set to `aliyun_sls`, set this parameter to the name of the Logstore group for SLS logs.	aliyun_fc
CollectInterval	string	No	The collection period of the metric. Valid values: 15 60 (default) Unit: seconds. Note This parameter is required only when TaskType is set to `aliyun_sls`. Valid values: 15 : 15 60 : 60	60
GroupId	string	No	The ID of the application group. For information about how to obtain the application group ID, see DescribeMonitorGroups. Note This parameter is required only when TaskType is set to `aliyun_sls`.	3607****
YARMConfig	string	No	The configuration file of the Alibaba Cloud service that is connected to Hybrid Cloud Monitoring. namespace: the namespace of the Alibaba Cloud service. For information about how to query the namespace of an Alibaba Cloud service, see DescribeMetricMetaList. metric_list: the metrics of the Alibaba Cloud service. For information about how to query the metrics of an Alibaba Cloud service, see DescribeMetricMetaList. The following example shows a sample configuration file: `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` Note This parameter is required only when TaskType is set to `aliyun_fc`.	products:- namespace: acs_ecs_dashboard metric_info: - metric_list: - cpu_total
TargetUserId	string	No	The ID of the member account. When you call this operation by using a management account, you can connect any Alibaba Cloud service of any member account in the resource directory to Hybrid Cloud Monitoring. This allows you to use the resource directory to monitor the Alibaba Cloud services of member accounts across the enterprise in a unified manner. Note This parameter is required only when TaskType is set to `aliyun_fc`.	120886317861****
AttachLabels	array<object>	No	The tags of the metric. Note This parameter is required only when TaskType is set to `aliyun_sls`.
	object	No	None.
Value	string	No	The tag value of the metric.	testValue
Name	string	No	The tag key of the metric.	app_service
TargetUserIdList	string	No	The IDs of the member accounts. Separate multiple IDs with commas (,). Note This parameter is required only when you call this operation by using a management account.	120886317861****
SLSProcessConfig	object	No	The configurations of SLS logs. Note This parameter is required only when TaskType is set to `aliyun_sls`.
Filter	object	No	The filter conditions for parameters in SLS logs.
Relation	string	No	The relationship between multiple filter conditions. Valid values: and (default): Logs are processed only when all filter conditions are met. or: Logs are processed when any filter condition is met. Valid values: or : or and : and	and
Filters	array<object>	No	The list of filter conditions for parameters in SLS logs.
	object	No	None.
SLSKeyName	string	No	The name of the parameter that is used to filter logs.	code
Operator	string	No	The operator that is used to filter logs based on the parameter value. Valid values: `contain`: contains. `notContain`: does not contain. `>`: greater than. `<`: less than. `=`: equal to. `!=`: not equal to. `>=`: greater than or equal to. `<=`: less than or equal to.	=
Value	string	No	The value of the parameter that is used to filter logs.	200
Statistics	array<object>	No	The method used to aggregate SLS log data.
	object	No	None.
SLSKeyName	string	No	The name of the parameter for SLS log statistics.	name
Function	string	No	Aggregates log data within the statistical period by using the specified statistical method. Valid values: count: counts the number of occurrences. sum: calculates the sum. avg: calculates the average. max: returns the maximum value. min: returns the minimum value. value: samples within the statistical period. countps: calculates the average count per second for the specified field within the statistical period. sumps: calculates the average sum per second for the specified field within the statistical period. distinct: counts the number of occurrences of the specified field after deduplication within the statistical period. distribution: counts the number of occurrences of field values within a specified range. percentile: calculates the distribution value of field values, such as P50.	count
Alias	string	No	The alias of the SLS log statistics result.	level_count
Parameter1	string	No	The statistical value of SLS logs. If Function is set to `distribution`, this parameter specifies the lower limit of the statistical range. For example, to count the number of 2XX HTTP status codes, set this parameter to 200. If Function is set to `percentile`, this parameter specifies the percentile of the statistical distribution. For example, 0.5 indicates P50.	200
Parameter2	string	No	The statistical value of SLS logs. Note This parameter is required only when Function is set to `distribution`. This parameter specifies the upper limit of the statistical range. For example, to count the number of 2XX HTTP status codes, set this parameter to 299.	299
GroupBy	array<object>	No	Aggregates data by spatial dimension, which is equivalent to the GROUP BY clause in SQL.
	object	No	None.
SLSKeyName	string	No	The name of the parameter for SLS log statistics.	code
Alias	string	No	The alias of the SLS log statistics result.	ApiResult
Express	array<object>	No	The result of arithmetic operations on the extended fields of SLS log statistics results.
	object	No	None.
Express	string	No	The result of arithmetic operations on the extended fields of SLS log statistics results.	success_count
Alias	string	No	The alias of the arithmetic operation result on the extended fields of SLS log statistics results.	SuccRate
CloudAccessId	array	No	The IDs of the accounts of other cloud providers that are connected to CloudMonitor.
	string	No	The ID of the account of another cloud provider that is connected to CloudMonitor.	n5n9ik1b****

For more information about common request parameters, see Common parameters.

Response elements

Element	Type	Description	Example
	object	None.
Code	string	The status code. Note 200 indicates success.	200
Message	string	The error message.	yamlConfigFail
RequestId	string	The request ID.	28CEA2E0-3E90-51B2-A7E8-B1ED75534E49
Success	string	Indicates whether the operation was successful. Valid values: true: successful. false: failed.	true
TaskId	integer	The ID of the monitoring task.	36****

Examples

Success response

JSON format

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

Error codes

HTTP status code	Error code	Error message
400	%s	%s
500	%s	%s
500	InternalError	The request processing has failed due to some unknown error.
403	%s	%s
404	%s	%s
409	%s	%s

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.