调用DescribeMetricRuleTemplateList接口查询报警模板列表。
接口说明
本文将提供一个示例，查询报警模板列表。返回结果显示，报警模板列表中共有 2 个报警模板，分别是ECS_Template1和ECS_Template2。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| cms:DescribeMetricRuleTemplateList | get | *全部资源 * |
| 无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| Name | string | 否 | 报警模板名称。 | ECS_Template1 |
| Keyword | string | 否 | 报警模板名称关键字。 | ECS |
| TemplateId | long | 否 | 报警模板 ID。 | 70**** |
| PageNumber | long | 否 | 页码。 默认值：1。 | 1 |
| PageSize | long | 否 | 每页显示模板的记录条数。 | 10 |
| History | boolean | 否 | 是否显示报警模板应用到应用分组的历史记录。取值：
| false |
| Order | boolean | 否 | 排序方式。取值：
| true |
| OrderBy | string | 否 | 排序依据。取值：
| gmtCreate |
关于公共请求参数的详情，请参见公共参数。
返回参数
示例
正常返回示例
JSON格式
{
"Code": 200,
"Message": "The Request is not authorization.",
"RequestId": "659401C0-6214-5C02-972A-CFA929D717B7",
"Total": 2,
"Success": true,
"Templates": {
"Template": [
{
"Description": "ECS的CPU使用率",
"GmtCreate": 1646018798000,
"Name": "ECS_Template1",
"RestVersion": 0,
"GmtModified": 1646054798000,
"TemplateId": 0,
"ApplyHistories": {
"ApplyHistory": [
{
"GroupId": 0,
"GroupName": "ECS_Group",
"ApplyTime": 1646055898000
}
]
}
}
]
}
}错误码
| HTTP status code | 错误码 | 错误信息 | 描述 |
|---|---|---|---|
| 400 | ParameterInvalid | Illegal parameters. | - |
| 403 | AccessForbidden | User not authorized to operate on the specified resource. | - |
| 404 | ResourceNotFound | The specified resource is not found. | 未找到指定资源。 |
| 500 | InternalError | The request processing has failed due to some unknown error. | - |
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 |
|---|---|---|
| 2022-03-22 | OpenAPI 错误码发生变更、OpenAPI 入参发生变更 | 查看变更详情 |