DescribeMetricRuleTemplateList - CloudMonitor - Alibaba Cloud Documentation Center

Queries alert templates.

Operation description

This topic provides an example on how to query alert templates. In this example, the following alert templates are returned in the response: ECS_Template1 and ECS_Template2.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

Parameter	Type	Required	Description	Example
Name	string	No	The name of the alert template.	ECS_Template1
Keyword	string	No	The keyword of the alert template name.	ECS
TemplateId	long	No	The ID of the alert template.	70****
PageNumber	long	No	The page number. Default value: 1.	1
PageSize	long	No	The number of entries per page.	10
History	boolean	No	Specifies whether to display the history of applying the alert templates to application groups. Valid values: true false (default)	false
Order	boolean	No	The sorting order. Valid values: true (default): ascending order false: descending order	true
OrderBy	string	No	The sorting basis. Valid values: gmtMotified: sorts alert templates by modification time gmtCreate (default): sorts alert templates by creation time	gmtCreate

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

Response parameters

Parameter	Type	Description	Example
	object
Code	integer	The 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.	659401C0-6214-5C02-972A-CFA929D717B7
Total	long	The total number of entries returned.	2
Success	boolean	Indicates whether the request was successful. Valid values: true false	true
Templates	object []	The queried alert templates.
Description	string	The description of the alert template.
GmtCreate	long	The timestamp when the alert template was created. Unit: milliseconds.	1646018798000
Name	string	The name of the alert template.	ECS_Template1
RestVersion	long	The version of the alert template. Default value: 0.	0
GmtModified	long	The timestamp when the alert template was modified. Unit: milliseconds.	1646054798000
TemplateId	long	The ID of the alert template.	70****
ApplyHistories	object []	The history of applying the alert templates to application groups.
GroupId	long	The ID of the application group.	3607****
GroupName	string	The name of the application group.	ECS_Group
ApplyTime	long	The timestamp when the alert template was applied to the application group. Unit: milliseconds.	1646055898000

Examples

Sample success responses

JSONformat

{
  "Code": 200,
  "Message": "The Request is not authorization.",
  "RequestId": "659401C0-6214-5C02-972A-CFA929D717B7",
  "Total": 2,
  "Success": true,
  "Templates": {
    "Template": [
      {
        "Description": "",
        "GmtCreate": 1646018798000,
        "Name": "ECS_Template1",
        "RestVersion": 0,
        "GmtModified": 1646054798000,
        "TemplateId": 0,
        "ApplyHistories": {
          "ApplyHistory": [
            {
              "GroupId": 0,
              "GroupName": "ECS_Group",
              "ApplyTime": 1646055898000
            }
          ]
        }
      }
    ]
  }
}

Error codes

HTTP status code	Error code	Error message	Description
400	ParameterInvalid	Illegal parameters.	-
403	AccessForbidden	User not authorized to operate on the specified resource.	-
404	ResourceNotFound	The specified resource is not found.	The specified resource is not found.
500	InternalError	The request processing has failed due to some unknown error.	-

For a list of error codes, visit the Service error codes.

Change history

Change time

Summary of changes

Operation

2022-03-22

The Error code has changed. The request parameters of the API has changed

see changesets

Change item	Change content
Error Codes	The Error code has changed.
	delete Error Codes: 400
	delete Error Codes: 403
	delete Error Codes: 404
	delete Error Codes: 500
Input Parameters	The request parameters of the API has changed.
	Added Input Parameters: Order
	Added Input Parameters: OrderBy