全部产品
Search

搜索本产品

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

    文档中心

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

    更新时间：Jan 23, 2026

    调用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

    integer

    否

    报警模板 ID。

    70****
    PageNumber

    integer

    否

    页码。

    默认值：1。

    1
    PageSize

    integer

    否

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

    10
    History

    boolean

    否

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

    • true：显示。

    • false（默认值）：不显示。

    false
    Order

    boolean

    否

    排序方式。取值：

    • true（默认值）：升序。

    • false：降序。

    true
    OrderBy

    string

    否

    排序依据。取值：

    • gmtMotified：修改日期。

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

    gmtCreate

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

    返回参数

    名称

    类型

    描述

    示例值

    object

    Code

    integer

    状态码。

    说明

    200 表示成功。

    200
    Message

    string

    错误信息。

    The Request is not authorization.
    RequestId

    string

    请求 ID。

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

    integer

    总记录条数。

    2
    Success

    boolean

    操作是否成功。取值：

    • true：成功。

    • false：失败。

    true
    Templates

    object

    Template

    array<object>

    报警模板列表。

    array<object>

    无。

    Description

    string

    报警模板描述信息。

    ECS的CPU使用率
    GmtCreate

    integer

    创建报警模板的时间戳。

    单位：毫秒。

    1646018798000
    Name

    string

    报警模板名称。

    ECS_Template1
    RestVersion

    integer

    报警模板版本。

    默认值：0。

    0
    GmtModified

    integer

    修改报警模板的时间戳。

    单位：毫秒。

    1646054798000
    TemplateId

    integer

    报警模板 ID。

    70****
    ApplyHistories

    object

    ApplyHistory

    array<object>

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

    object

    无。

    GroupId

    integer

    应用分组 ID。

    3607****
    GroupName

    string

    应用分组名称。

    ECS_Group
    ApplyTime

    integer

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

    单位：毫秒。

    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

    错误码

    错误信息

    描述
    400 ParameterInvalid Illegal parameters.
    500 InternalError The request processing has failed due to some unknown error.
    403 AccessForbidden User not authorized to operate on the specified resource.
    404 ResourceNotFound The specified resource is not found. 未找到指定资源。

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

    变更历史

    更多信息，参考变更详情。