# 查询当前规则列表 - ListAssociatedResourceRules #### 功能介绍 查询当前规则列表 #### 调用方法 请参见[如何调用API](https://support.huaweicloud.com/api-tms/zh-cn_topic_0056283725.html)。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-tms/zh-cn_topic_0170638684.html)。 - 如果使用身份策略授权，需具备如下身份策略权限。 | 授权项 | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 | |:---|:---|:---|:---|:---|:---| | tms:associatedResource:listRules | List | - | - | - | - | #### URI GET /v2/tms/associated-resources/rules 表1Query参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | limit | 否 | Integer | **参数解释**： 查询记录数，用于分页查询时指定每页返回的记录数量。 **约束限制**： 不涉及 **取值范围**： 1\~100 **默认取值**： 10 | | marker | 否 | String | **参数解释**： 分页位置标识（索引）。从marker指定索引的下一条数据开始查询。需要查询后续页码数据时，将查询前一页数据响应体中marker值配入此参数。 **约束限制**： 当返回的列表为空时表示查询到最后一页，不需要再查询下一页。 **取值范围**： 不涉及 **默认取值**： 不涉及 | | setting_name | 否 | String | **参数解释**： 规则的配置名称。 **约束限制**： 需要是TMS支持的规则配置的名称。请使用"[查询当前规则的配置列表](https://support.huaweicloud.com/api-tms/ListAssociatedResourceSettings.html)"接口获取支持配置信息。 **取值范围**： 只能由英文字母、数字及"_"、"-"、"."、":"组成，且长度为1\~128个字符。 **默认取值**： 不涉及 | | region_id | 否 | String | **参数解释**： 区域ID，参考"[获取账号、IAM用户、项目、用户组、区域、委托的名称和ID](https://support.huaweicloud.com/api-iam/iam_17_0002.html)"获取区域ID。 **约束限制**： 不涉及 **取值范围**： 不涉及 **默认取值**： 不涉及 | #### 请求参数 无 #### 响应参数 **状态码：200** 表2响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | rules | Array of [AssociatedResourceRule] objects | **参数解释**： 规则信息，每一个是AssociatedResourceRule对象，包含规则配置名称、规则状态等。 | | total_count | Integer | **参数解释**： 规则总数。 **取值范围**： 不涉及 | | page_info | [PageInfo] object | **参数解释**： 分页信息。 | 表3AssociatedResourceRule | 参数 | 参数类型 | 描述 | |:---|:---|:---| | 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。 **取值范围**： 不涉及 | 表4PageInfo | 参数 | 参数类型 | 描述 | |:---|:---|:---| | next_marker | String | **参数解释**： 分页位置标识（索引）。从marker指定索引的下一条数据开始查询。 需要查询后续页码数据时，将查询前一页数据响应体中marker值配入此参数。 **取值范围**： 不涉及 | | current_count | Integer | **参数解释**： 当前页的数量。 **取值范围**： 不涉及 | **状态码：400** 表5响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error | [RespErrorMessage] object | **参数解释**： 响应的错误信息。 | 表6RespErrorMessage | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | **参数解释**： 错误码。请到"[错误码](https://console.huaweicloud.com/apiexplorer/#/errorcenter)"页面查询对应云服务的错误码。 **取值范围**： 不涉及 | | error_msg | String | **参数解释**： 错误描述。 **取值范围**： 不涉及 | **状态码：401** 表7响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error | [RespErrorMessage] object | **参数解释**： 响应的错误信息。 | 表8RespErrorMessage | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | **参数解释**： 错误码。请到"[错误码](https://console.huaweicloud.com/apiexplorer/#/errorcenter)"页面查询对应云服务的错误码。 **取值范围**： 不涉及 | | error_msg | String | **参数解释**： 错误描述。 **取值范围**： 不涉及 | **状态码：403** 表9响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error | [RespErrorMessage] object | **参数解释**： 响应的错误信息。 | 表10RespErrorMessage | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | **参数解释**： 错误码。请到"[错误码](https://console.huaweicloud.com/apiexplorer/#/errorcenter)"页面查询对应云服务的错误码。 **取值范围**： 不涉及 | | error_msg | String | **参数解释**： 错误描述。 **取值范围**： 不涉及 | **状态码：500** 表11响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error | [RespErrorMessage] object | **参数解释**： 响应的错误信息。 | 表12RespErrorMessage | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | **参数解释**： 错误码。请到"[错误码](https://console.huaweicloud.com/apiexplorer/#/errorcenter)"页面查询对应云服务的错误码。 **取值范围**： 不涉及 | | 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" : 1 } } ``` #### SDK代码示例 SDK代码示例如下。 #### Java ``` 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("")) .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 ``` # 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("")) \ .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 ``` 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("")). 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](https://console.huaweicloud.com/apiexplorer/#/openapi/TMS/sdk?api=ListAssociatedResourceRules)的代码示例页签，可生成自动对应的SDK代码示例。 #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | OK | | 400 | 入参错误时返回 | | 401 | token鉴权失败时返回 | | 403 | 权限不足或网关流控拦截时 | | 500 | 出现系统错误时返回 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-tms/ErrorCode.html)。