全部产品
Search
文档中心

云监控:DescribeMetricRuleTemplateList - 查询报警模板列表

更新时间:Jul 26, 2024

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

接口说明

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

调试

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

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
cms:DescribeMetricRuleTemplateListget
  • 全部资源
    *

请求参数

名称类型必填描述示例值
Namestring

报警模板名称。

ECS_Template1
Keywordstring

报警模板名称关键字。

ECS
TemplateIdlong

报警模板 ID。

70****
PageNumberlong

页码。

默认值:1。

1
PageSizelong

每页显示模板的记录条数。

10
Historyboolean

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

  • true:显示。

  • false(默认值):不显示。

false
Orderboolean

排序方式。取值:

  • true(默认值):升序。

  • false:降序。

true
OrderBystring

排序依据。取值:

  • gmtMotified:修改日期。

  • gmtCreate(默认值):创建日期。

gmtCreate

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

返回参数

名称类型描述示例值
object
Codeinteger

状态码。

说明 200 表示成功。
200
Messagestring

错误信息。

The Request is not authorization.
RequestIdstring

请求 ID。

659401C0-6214-5C02-972A-CFA929D717B7
Totallong

总记录条数。

2
Successboolean

操作是否成功。取值:

  • true:成功。

  • false:失败。

true
Templatesarray<object>

报警模板列表。

object

无。

Descriptionstring

报警模板描述信息。

ECS的CPU使用率
GmtCreatelong

创建报警模板的时间戳。

单位:毫秒。

1646018798000
Namestring

报警模板名称。

ECS_Template1
RestVersionlong

报警模板版本。

默认值:0。

0
GmtModifiedlong

修改报警模板的时间戳。

单位:毫秒。

1646054798000
TemplateIdlong

报警模板 ID。

70****
ApplyHistoriesarray<object>

报警模板应用到应用分组的历史记录。

object

无。

GroupIdlong

应用分组 ID。

3607****
GroupNamestring

应用分组名称。

ECS_Group
ApplyTimelong

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

单位:毫秒。

1646055898000

示例

正常返回示例

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错误码错误信息描述
400ParameterInvalidIllegal parameters.-
403AccessForbiddenUser not authorized to operate on the specified resource.-
404ResourceNotFoundThe specified resource is not found.未找到指定资源。
500InternalErrorThe request processing has failed due to some unknown error.-

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

变更历史

变更时间变更内容概要操作
2022-03-22OpenAPI 错误码发生变更、OpenAPI 入参发生变更查看变更详情