调用DescribeMetricRuleTemplateList接口查询报警模板列表。

本文将提供一个示例，查询报警模板列表。返回结果显示，报警模板列表中共有2个报警模板，分别是ECS_Template1和ECS_Template2。

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String 是 DescribeMetricRuleTemplateList

要执行的操作，取值：DescribeMetricRuleTemplateList。

Name String 否 ECS_Template1

报警模板名称。
Keyword String 否 ECS

报警模板名称关键字。
TemplateId Long 否 70****

报警模板ID。
PageNumber Long 否 1

页码。

默认值：1。
PageSize Long 否 10

每页显示模板的记录条数。
History Boolean 否 false

是否显示报警模板应用到应用分组的历史记录。取值：

  • true：显示。
  • false（默认值）：不显示。
Order Boolean 否 true

排序方式。取值：

  • true（默认值）：升序。
  • false：降序。
OrderBy String 否 gmtCreate

排序依据。取值：

  • gmtMotified：修改日期。
  • gmtCreate（默认值）：创建日期。

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

返回数据

名称 类型 示例值 描述
Code Integer 200

状态码。

说明 200表示成功。
Message String The Request is not authorization.

错误信息。
RequestId String 659401C0-6214-5C02-972A-CFA929D717B7

请求ID。
Total Long 2

总记录条数。
Success Boolean true

操作是否成功。取值：

  • true：成功。
  • false：失败。
Templates Array of Template

报警模板列表。
Template
Description String ECS的CPU使用率

报警模板描述信息。
GmtCreate Long 1646018798000

创建报警模板的时间戳。

单位：毫秒。
Name String ECS_Template1

报警模板名称。
RestVersion Long 0

报警模板版本。

默认值：0。
GmtModified Long 1646054798000

修改报警模板的时间戳。

单位：毫秒。
TemplateId Long 70****

报警模板ID。
ApplyHistories Array of ApplyHistory

报警模板应用到应用分组的历史记录。
ApplyHistory
GroupId Long 3607****

应用分组ID。
GroupName String ECS_Group

应用分组名称。
ApplyTime Long 1646055898000

报警模板应用到应用分组的时间戳。

单位：毫秒。

示例

请求示例

http(s)://[Endpoint]/?Action=DescribeMetricRuleTemplateList
&<公共请求参数>

正常返回示例

XML格式 

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

<DescribeMetricRuleTemplateListResponse>
	<RequestId>659401C0-6214-5C02-972A-CFA929D717B7</RequestId>
	<Total>2</Total>
	<Templates>
		<Template>
			<GmtCreate>1606291110000</GmtCreate>
			<Description></Description>
			<GmtModified>1646018798000</GmtModified>
			<RestVersion>0</RestVersion>
			<TemplateId>70****</TemplateId>
			<Name>ECS_Template1</Name>
		</Template>
		<Template>
			<GmtCreate>1607420429000</GmtCreate>
			<Description></Description>
			<GmtModified>1646017352000</GmtModified>
			<RestVersion>1</RestVersion>
			<TemplateId>71****</TemplateId>
			<Name>ECS_Template2</Name>
		</Template>
	</Templates>
	<Code>200</Code>
	<Success>true</Success>
</DescribeMetricRuleTemplateListResponse>

JSON格式 

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

{
  "RequestId": "659401C0-6214-5C02-972A-CFA929D717B7",
  "Total": 2,
  "Templates": {
    "Template": [
      {
        "GmtCreate": 1606291110000,
        "Description": "",
        "GmtModified": 1646018798000,
        "RestVersion": 0,
        "TemplateId": 70****,
        "Name": "ECS_Template1"
      },
      {
        "GmtCreate": 1607420429000,
        "Description": "",
        "GmtModified": 1646017352000,
        "RestVersion": 1,
        "TemplateId": 71****,
        "Name": "ECS_Template2"
      }
    ]
  },
  "Code": 200,
  "Success": true
}

错误码

HttpCode 错误码 错误信息 描述
404 ResourceNotFound The specified resource is not found. 未找到指定资源。

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