Queries alert templates.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes DescribeMetricRuleTemplateList

The operation that you want to perform. Set the value to DescribeMetricRuleTemplateList.

History Boolean No false

Specifies whether to display the history of applying the alert templates to application groups. Valid values: true and false. Default value: false.

Keyword String No My template

The name of the alert template. You can perform fuzzy search based on the template name.

Name String No Template name

The name of the alert template.

PageNumber Long No 1

The number of the page to return. Default value: 1.

PageSize Long No 10

The number of entries to return on each page.

TemplateId Long No 12345

The ID of the alert template.

Response parameters

Parameter Type Example Description
Code Integer 200

The HTTP status code. The status code 200 indicates that the call was successful. Other status codes indicate that the call failed.

Success Boolean true

Indicates whether the call was successful.

Message String success

The returned message.

Total Long 11

The total number of entries returned.

RequestId String 1A1B405A-B877-4A27-9922-471F080E4985

The ID of the request.

Templates N/A N/A

The alert templates.

ApplyHistories N/A N/A

The application history of the alert template.

ApplyTime Long 1543459583000

The time when the alert template was applied.

GroupId Long 12345

The ID of the application group.

GroupName String My alert group name

The name of the application group.

Description String CPU alert template

The description of the alert template.

GmtCreate Long 1543302440000

The time when the alert template was created.

GmtModified Long 1543302440000

The time when the alert template was modified.

Name String template1

The name of the alert template.

RestVersion Long 0

The version of the alert template. Default value: 0.

TemplateId Long 12345

The ID of the alert template.

Examples

Sample requests


http(s)://[Endpoint]/? Action=DescribeMetricRuleTemplateList
&<Common request parameters>

Sample success responses

XML format


				<DescribeMetricRuleTemplateListResponse id="DescribeMetricRuleTemplateListResponse_3n9_dnl_kh0">
					<RequestId id="RequestId_jnn_8du_a47">03AE5FA9-8CB2-4B5B-8306-1BBBF012A1A7</RequestId>
					<Templates id="Templates_g30_amh_30h">
						<Template id="Template_sor_kzn_fbb">
							<RestVersion id="RestVersion_ac1_woe_tqk">0</RestVersion>
							<Name id="Name_nn7_dnz_upe">newtemplate_1</Name>
							<Description id="Description_3s6_h47_xvy">description_111111</Description>
							<GmtCreate id="GmtCreate_8lc_6ha_090">1543302440000</GmtCreate>
							<GmtModified id="GmtModified_n7f_u51_jp0">1543302440000</GmtModified>
							<TemplateId id="TemplateId_wuy_rp3_0vg">32</TemplateId>
						</Template>
						<Template id="Template_4ws_q15_x66">
							<RestVersion id="RestVersion_25y_atk_lax">0</RestVersion>
							<Name id="Name_1mn_e2v_dsb">newtemplate_2</Name>
							<Description id="Description_61g_ezd_zec"></Description>
							<GmtCreate id="GmtCreate_i7r_1ur_tdp">1543307344000</GmtCreate>
							<GmtModified id="GmtModified_k4c_nst_ys3">1543307344000</GmtModified>
							<TemplateId id="TemplateId_ejj_33m_6fa">42</TemplateId>
						</Template>
					</Templates>
					<Success id="Success_f8c_y9w_0hu">true</Success>
					<Code id="Code_a9i_7ar_wkf">200</Code>
					<Total id="Total_9rt_m1b_y88">65</Total>
				</DescribeMetricRuleTemplateListResponse>
			

JSON format

{
	"RequestId":"03AE5FA9-8CB2-4B5B-8306-1BBBF012A1A7",
	"Templates":{
		"Template":[
			{
				"Name":"newtemplate_1",
				"RestVersion":0,
				"Description":"description_111111",
				"GmtCreate":1543302440000,
				"GmtModified":1543302440000,
				"TemplateId":32
			},
			{
				"Name":"newtemplate_2",
				"RestVersion":0,
				"Description":"",
				"GmtCreate":1543307344000,
				"GmtModified":1543307344000,
				"TemplateId":42
			}
		]
	},
	"Success":true,
	"Code":200,
	"Total":65
}

Error codes

For a list of error codes, visit the API Error Center.