文档

DescribeDynamicTagRuleList - 查询智能标签的规则列表

更新时间:

调用DescribeDynamicTagRuleList接口查询智能标签的规则列表。

接口说明

本文将提供一个示例,查找标签键tagkey1的规则列表。返回结果显示,共有 2 条规则,规则 ID 分别为1536df65-a719-429d-8813-73cc40d7****56e8cebb-b3d7-4a91-9880-78a8c84f****

调试

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

授权信息

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

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

请求参数

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

标签归属的地域 ID。

cn-hangzhou
TagKeystring

标签键。

关于如何获取标签键,请参见 DescribeTagKeyList

tagkey1
TagValuestring

标签值。

关于如何获取标签值,请参见 DescribeTagValueList

*
PageNumberstring

页码。

起始值:1。默认值:1。

1
PageSizestring

分页时每页显示的数据行数。

起始值:1。默认值:30。

30
DynamicTagRuleIdstring

智能标签规则 ID。

004155fa-15ba-466d-b61a-***********

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

返回参数

名称类型描述示例值
object

返回结果。

RequestIdstring

请求 ID。

0D50523D-8D59-4A61-B58E-E2286ECFB3A9
Successboolean

操作是否成功。取值:

  • true:成功。

  • false:失败。

true
Codestring

状态码。

说明 200 表示成功。
200
Messagestring

错误信息。

The specified resource is not found.
PageSizestring

分页时每页显示的数据行数。

30
PageNumberstring

页码。

1
Totalinteger

标签列表的条目总数。

2
TagGroupListobject []

应用分组的规则列表。

Statusstring

标签同步到应用分组的状态。

  • RUNNING:进行中。
  • FINISH:已完成。
FINISH
MatchExpressFilterRelationstring

条件表达式之间的关系。取值:

  • and:和。
  • or:或。
说明 目前仅支持一种组合条件。
or
RegionIdstring

资源所属的地域 ID。

cn-hangzhou
TagKeystring

标签键。

tagkey1
DynamicTagRuleIdstring

标签规则 ID。

1536df65-a719-429d-8813-73cc40d7****
MatchExpressobject []

标签生成应用分组的匹配表达式。

TagValuestring

标签值。

TagValueTagValueMatchFunction配合使用。

*
TagValueMatchFunctionstring

标签值的匹配方法。取值:

  • all:全部。
  • startWith:前缀。
  • endWith:后缀。
  • contains:包含。
  • notContains:不包含。
  • equals:相等。
all
TagKeystring

标签键。

azone-version
TemplateIdListarray

报警模板 ID 列表。

string

报警模板 ID。

71****
ContactGroupListarray

报警联系组列表。

string

报警联系组。

CloudMonitor
TagValueBlacklistarray

动态规则不处理的 TagValue。当用户删除动态 Tag 分组的时候,分组对应的 TagValue 会添加到黑名单;在之后有新的资源新增此 TagValue 时,不会创建对应的分组。

string
某个标签的值,例如:test,offline等。

示例

正常返回示例

JSON格式

{
  "RequestId": "0D50523D-8D59-4A61-B58E-E2286ECFB3A9",
  "Success": true,
  "Code": "200",
  "Message": "The specified resource is not found.",
  "PageSize": "30",
  "PageNumber": "1",
  "Total": 2,
  "TagGroupList": {
    "TagGroup": [
      {
        "Status": "FINISH",
        "MatchExpressFilterRelation": "or",
        "RegionId": "cn-hangzhou",
        "TagKey": "tagkey1",
        "DynamicTagRuleId": "1536df65-a719-429d-8813-73cc40d7****",
        "MatchExpress": {
          "MatchExpress": [
            {
              "TagValue": "*",
              "TagValueMatchFunction": "all",
              "TagKey": "azone-version"
            }
          ]
        },
        "TemplateIdList": {
          "TemplateIdList": [
            "71****"
          ]
        },
        "ContactGroupList": {
          "ContactGroupList": [
            "CloudMonitor"
          ]
        },
        "TagValueBlacklist": {
          "TagValueBlacklist": [
            "某个标签的值,例如:test,offline等。"
          ]
        }
      }
    ]
  }
}

错误码

HTTP status code错误码错误信息描述
400InvalidParameterValueIllegal parameters.参数错误。
403AccessForbiddenUser not authorized to operate on the specified resource.-
404ResourceNotFoundThe specified resource is not found.未找到指定资源。
500%s%s-
500InternalErrorThe request processing has failed due to some unknown error.-

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

变更历史

变更时间变更内容概要操作
2024-03-13OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
    删除错误码:403
    删除错误码:404
    删除错误码:500
出参OpenAPI 返回结构发生变更
2021-11-04OpenAPI 描述信息更新、OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更看变更集
变更项变更内容
API 描述OpenAPI 描述信息更新
错误码OpenAPI 错误码发生变更
    删除错误码:400
    删除错误码:403
    删除错误码:404
    删除错误码:500
出参OpenAPI 返回结构发生变更