DescribeProductsOfActiveMetricRule - Cloud Monitor - Alibaba Cloud Documentation Center

Queries the cloud services for which the initiative alert feature is enabled.

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:DescribeProductsOfActiveMetricRule

get

*All Resource

*

None

Request parameters

Parameter

Type

Required

Description

Example

No parameters required.

Response elements

Element	Type	Description	Example
	object	None.
Code	integer	The HTTP status code. Note The status code 200 indicates that the request was successful.	200
Message	string	The error message.	The Request is not authorization.
RequestId	string	The request ID.	F82E6667-7811-4BA0-842F-5B2DC42BBAAD
Datapoints	string	The information about the services for which the initiative alert feature is enabled. Services are separated with commas (,). Valid values: ECS: Elastic Compute Service (ECS) rds: ApsaraDB RDS slb: Server Load Balancer (SLB) redis_standard: Redis Open-Source Edition (standard architecture) redis_sharding: Redis Open-Source Edition (cluster architecture) redis_splitrw: Redis Open-Source Edition (read/write splitting architecture) mongodb: ApsaraDB for MongoDB of the replica set architecture mongodb_sharding: ApsaraDB for MongoDB of the sharded cluster architecture hbase: ApsaraDB for HBase elasticsearch: Elasticsearch opensearch: OpenSearch	ecs,rds
Success	boolean	Indicates whether the request was successful. Valid values: true: The request was successful. false: The request failed.	true
AllProductInitMetricRuleList	object
AllProductInitMetricRule	array<object>	The information about the services for which one-click alert is enabled.
	array<object>	The information about the services for which one-click alert is enabled.
Product	string	The abbreviation of the service name.	ecs
AlertInitConfigList	object
AlertInitConfig	array<object>	The initial alert rules that are generated after one-click alert is enabled for a service.
	object	The initial alert rules that are generated after one-click alert is enabled for a service.
MetricName	string	The metric name. For more information, see Appendix 1: Metrics.	cpu_total
EvaluationCount	string	The consecutive number of times for which the metric value meets the alert condition before an alert is triggered.	3
Namespace	string	The namespace of the service. For more information, see Appendix 1: Metrics.	acs_rds_dashboard
Threshold	string	The alert threshold.	90
Statistics	string	The method used to calculate metric values that trigger alerts. For more information, see Appendix 1: Metrics.	Average
Period	string	The aggregation period of monitoring data. Unit: minutes. For more information, see Appendix 1: Metrics.	1m
Level	string	The alert level. Valid values: INFO WARN CRITICAL Valid values: INFO : WARN : CRITICAL :	CRITICAL
ComparisonOperator	string	The operator that is used to compare the metric value with the threshold for Warn-level alerts. Valid values: LessThanThreshold: less than the threshold GreaterThanLastWeek: greater than the metric value at the same time last week LessThanOrEqualToThreshold: less than or equal to the threshold NotEqualToThreshold: does not equal to the threshold GreaterThanLastPeriod: greater than the metric value in the last monitoring cycle GreaterThanYesterday: greater than the metric value at the same time yesterday LessThanYesterday: less than the metric value at the same time yesterday LessThanLastWeek: less than the metric value at the same time last week GreaterThanOrEqualToThreshold: greater than or equal to the threshold GreaterThanThreshold: greater than the threshold LessThanLastPeriod: less than the metric value in the last monitoring cycle Valid values: LessThanThreshold : GreaterThanLastWeek : LessThanOrEqualToThreshold : NotEqualToThreshold : GreaterThanLastPeriod : GreaterThanYesterday : LessThanYesterday : LessThanLastWeek : GreaterThanOrEqualToThreshold : GreaterThanThreshold : LessThanLastPeriod :	GreaterThanOrEqualToThreshold

Examples

Success response

JSON format

{
  "Code": 200,
  "Message": "The Request is not authorization.",
  "RequestId": "F82E6667-7811-4BA0-842F-5B2DC42BBAAD",
  "Datapoints": "ecs,rds",
  "Success": true,
  "AllProductInitMetricRuleList": {
    "AllProductInitMetricRule": [
      {
        "Product": "ecs",
        "AlertInitConfigList": {
          "AlertInitConfig": [
            {
              "MetricName": "cpu_total",
              "EvaluationCount": "3",
              "Namespace": "acs_rds_dashboard",
              "Threshold": "90",
              "Statistics": "Average",
              "Period": "1m",
              "Level": "CRITICAL",
              "ComparisonOperator": "GreaterThanOrEqualToThreshold"
            }
          ]
        }
      }
    ]
  }
}

Error codes

HTTP status code	Error code	Error message
400	InvalidParameter	The specified parameter is not valid.
500	InternalError	The request processing has failed due to some unknown error.
403	InvalidAuthorization	The Request is not authorization.
406	%s	%s

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.