文档首页/ 标签管理服务 TMS/ API参考/ API说明/ 关联资源标签继承规则/ 查询当前规则列表 - ListAssociatedResourceRules
更新时间:2026-07-31 GMT+08:00
分享

查询当前规则列表 - ListAssociatedResourceRules

功能介绍

查询当前规则列表

调用方法

请参见如何调用API

授权信息

账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。

  • 如果使用角色与策略授权,具体权限要求请参见权限和授权项
  • 如果使用身份策略授权,需具备如下身份策略权限。

    授权项

    访问级别

    资源类型(*为必须)

    条件键

    别名

    依赖的授权项

    tms:associatedResource:listRules

    List

    -

    -

    -

    -

URI

GET /v2/tms/associated-resources/rules

表1 Query参数

参数

是否必选

参数类型

描述

limit

Integer

参数解释

查询记录数,用于分页查询时指定每页返回的记录数量。

约束限制

不涉及

取值范围

1~100

默认取值

10

marker

String

参数解释

分页位置标识(索引)。从marker指定索引的下一条数据开始查询。需要查询后续页码数据时,将查询前一页数据响应体中marker值配入此参数。

约束限制

当返回的列表为空时表示查询到最后一页,不需要再查询下一页。

取值范围

不涉及

默认取值

不涉及

setting_name

String

参数解释

规则的配置名称。

约束限制

需要是TMS支持的规则配置的名称。请使用“查询当前规则的配置列表”接口获取支持配置信息。

取值范围

只能由英文字母、数字及“_”、“-”、“.”、“:”组成,且长度为1~128个字符。

默认取值

不涉及

region_id

String

参数解释

区域ID,参考“获取账号、IAM用户、项目、用户组、区域、委托的名称和ID”获取区域ID。

约束限制

不涉及

取值范围

不涉及

默认取值

不涉及

请求参数

响应参数

状态码:200

表2 响应Body参数

参数

参数类型

描述

rules

Array of AssociatedResourceRule objects

参数解释

规则信息,每一个是AssociatedResourceRule对象,包含规则配置名称、规则状态等。

total_count

Integer

参数解释

规则总数。

取值范围

不涉及

page_info

PageInfo object

参数解释

分页信息。

表3 AssociatedResourceRule

参数

参数类型

描述

setting_name

String

参数解释

规则的配置名称。

取值范围

只能由英文字母、数字及“_”、“-”、“.”、“:”组成,且长度为1~128个字符。

tag_keys

Array of strings

参数解释

规则作用标签的范围。如果为空则表示对全部标签生效。

existing_resource_status

String

参数解释

特性开关,规则是否在存量资源生效。

取值范围

  • enabled: 存量资源生效的特性开启。

  • disabled: 存量资源生效的特性关闭。

auto_delete_status

String

参数解释

特性开关,主资源与子资源关系解除后是否自动删除子资源中与主资源标签键一致的标签。

取值范围

  • enabled: 自动删除子资源标签的特性开启。

  • disabled: 自动删除子资源标签的特性关闭。

status

String

参数解释

规则状态。

取值范围

  • enabled: 规则已开启。

region_id

String

参数解释

规则生效的区域ID。

取值范围

不涉及

表4 PageInfo

参数

参数类型

描述

next_marker

String

参数解释

分页位置标识(索引)。从marker指定索引的下一条数据开始查询。 需要查询后续页码数据时,将查询前一页数据响应体中marker值配入此参数。

取值范围

不涉及

current_count

Integer

参数解释

当前页的数量。

取值范围

不涉及

状态码:400

表5 响应Body参数

参数

参数类型

描述

error

RespErrorMessage object

参数解释

响应的错误信息。

表6 RespErrorMessage

参数

参数类型

描述

error_code

String

参数解释

错误码。请到“错误码”页面查询对应云服务的错误码。

取值范围

不涉及

error_msg

String

参数解释

错误描述。

取值范围

不涉及

状态码:401

表7 响应Body参数

参数

参数类型

描述

error

RespErrorMessage object

参数解释

响应的错误信息。

表8 RespErrorMessage

参数

参数类型

描述

error_code

String

参数解释

错误码。请到“错误码”页面查询对应云服务的错误码。

取值范围

不涉及

error_msg

String

参数解释

错误描述。

取值范围

不涉及

状态码:403

表9 响应Body参数

参数

参数类型

描述

error

RespErrorMessage object

参数解释

响应的错误信息。

表10 RespErrorMessage

参数

参数类型

描述

error_code

String

参数解释

错误码。请到“错误码”页面查询对应云服务的错误码。

取值范围

不涉及

error_msg

String

参数解释

错误描述。

取值范围

不涉及

状态码:500

表11 响应Body参数

参数

参数类型

描述

error

RespErrorMessage object

参数解释

响应的错误信息。

表12 RespErrorMessage

参数

参数类型

描述

error_code

String

参数解释

错误码。请到“错误码”页面查询对应云服务的错误码。

取值范围

不涉及

error_msg

String

参数解释

错误描述。

取值范围

不涉及

请求示例

查询标签继承规则的信息

GET https://{Endpoint}/v2/tms/associated-resources/rules?region_id=cn-north-4&setting_name=rule:AttachVolume-DetachVolume-TagServer:Ecs-Cloudservers:Evs-Volumes

响应示例

状态码:200

OK

{
  "rules" : [ {
    "setting_name" : "rule:AttachVolume-DetachVolume-TagServer:Ecs-Cloudservers:Evs-Volumes",
    "tag_keys" : [ "key1", "key2" ],
    "status" : "enabled",
    "existing_resource_status" : "enabled",
    "auto_delete_status" : "enabled",
    "region_id" : "cn-north-7"
  } ],
  "total_count" : 2,
  "page_info" : {
    "next_marker" : "rule:AssociatePublicip-DisassociatePublicip-TagServer:Ecs-Cloudservers:Vpc-Publicips",
    "current_count" : 2
  }
}

SDK代码示例

SDK代码示例如下。

Java

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
package com.huaweicloud.sdk.test;

import com.huaweicloud.sdk.core.auth.ICredential;
import com.huaweicloud.sdk.core.auth.GlobalCredentials;
import com.huaweicloud.sdk.core.exception.ConnectionException;
import com.huaweicloud.sdk.core.exception.RequestTimeoutException;
import com.huaweicloud.sdk.core.exception.ServiceResponseException;
import com.huaweicloud.sdk.tms.v1.region.TmsRegion;
import com.huaweicloud.sdk.tms.v1.*;
import com.huaweicloud.sdk.tms.v1.model.*;


public class ListAssociatedResourceRulesSolution {

    public static void main(String[] args) {
        // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
        // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
        String ak = System.getenv("CLOUD_SDK_AK");
        String sk = System.getenv("CLOUD_SDK_SK");

        ICredential auth = new GlobalCredentials()
                .withAk(ak)
                .withSk(sk);

        TmsClient client = TmsClient.newBuilder()
                .withCredential(auth)
                .withRegion(TmsRegion.valueOf("<YOUR REGION>"))
                .build();
        ListAssociatedResourceRulesRequest request = new ListAssociatedResourceRulesRequest();
        try {
            ListAssociatedResourceRulesResponse response = client.listAssociatedResourceRules(request);
            System.out.println(response.toString());
        } catch (ConnectionException e) {
            e.printStackTrace();
        } catch (RequestTimeoutException e) {
            e.printStackTrace();
        } catch (ServiceResponseException e) {
            e.printStackTrace();
            System.out.println(e.getHttpStatusCode());
            System.out.println(e.getRequestId());
            System.out.println(e.getErrorCode());
            System.out.println(e.getErrorMsg());
        }
    }
}

Python

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
# coding: utf-8

import os
from huaweicloudsdkcore.auth.credentials import GlobalCredentials
from huaweicloudsdktms.v1.region.tms_region import TmsRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdktms.v1 import *

if __name__ == "__main__":
    # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak = os.environ["CLOUD_SDK_AK"]
    sk = os.environ["CLOUD_SDK_SK"]

    credentials = GlobalCredentials(ak, sk)

    client = TmsClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(TmsRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = ListAssociatedResourceRulesRequest()
        response = client.list_associated_resource_rules(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)

Go

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/global"
    tms "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/tms/v1"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/tms/v1/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/tms/v1/region"
)

func main() {
    // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak := os.Getenv("CLOUD_SDK_AK")
    sk := os.Getenv("CLOUD_SDK_SK")

    auth, err := global.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        SafeBuild()

    if err != nil {
        fmt.Println(err)
        return
    }

    hcClient, err := tms.TmsClientBuilder().
         WithRegion(region.ValueOf("<YOUR REGION>")).
         WithCredential(auth).
         SafeBuild()


    if err != nil {
        fmt.Println(err)
        return
    }

    client := tms.NewTmsClient(hcClient)

    request := &model.ListAssociatedResourceRulesRequest{}
	response, err := client.ListAssociatedResourceRules(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

更多

更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。

状态码

状态码

描述

200

OK

400

入参错误时返回

401

token鉴权失败时返回

403

权限不足或网关流控拦截时

500

出现系统错误时返回

错误码

请参见错误码

相关文档