# 根据标签过滤资源 - ListResource #### 功能介绍 根据标签过滤资源。 #### 调用方法 请参见[如何调用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:resources:list | List | - | - | - | - | #### URI POST /v1.0/resource-instances/filter #### 请求参数 表1请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | X-Auth-Token | 是 | String | **参数解释**： 用户Token。（获取方式参考"[认证鉴权](https://support.huaweicloud.com/api-tms/zh-cn_topic_0173938834.html)"）。 **约束限制**： 由于TMS是全局服务，因此调用IAM服务获取用户Token接口时需要注意，作用域即scope字段应该设置为domain。 **取值范围**： 不涉及 **默认取值**： 不涉及 | 表2请求Body参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 否 | String | **参数解释**： 项目ID。 获取方式请参见：["获取项目ID"](https://support.huaweicloud.com/api-tms/zh-cn_topic_0126416752.html) **约束限制**： resource_type为region级别服务时，必选项。 **取值范围**： 不涉及 **默认取值**： 不涉及 | | resource_types | 是 | Array of strings | **参数解释**： 资源类型。例如：ecs，scaling_group，images，disk，vpc，security-groups，shared_bandwidth，eip，cdn等。获取方式请参见"[查询标签管理支持的服务](https://support.huaweicloud.com/api-tms/ListProviders.html)"章节。 **约束限制**： 1\~100个之间。 | | tags | 是 | Array of [Tag] objects | **参数解释**： 标签列表，Tag对象包含key和values字段。 **约束限制**： 标签个数：1\~10。 | | without_any_tag | 否 | Boolean | **参数解释**： 是否仅查询未带标签的资源。 **约束限制**： 不涉及 **取值范围**： true：查询不带标签的资源。 false：查询不带标签与带标签的资源。 **默认取值**： false | | offset | 否 | Integer | **参数解释**： 索引位置，从offset指定的下一条数据开始查询。 **约束限制**： 不涉及 **取值范围**： ≥0 **默认取值**： 0 | | limit | 否 | Integer | **参数解释**： 查询记录数。 **约束限制**： 不涉及 **取值范围**： 1\~200 **默认取值**： 10 | 表3Tag | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | key | 是 | String | **参数解释**： 标签的键。参考章节"[约束与限制](https://support.huaweicloud.com/productdesc-tms/zh-cn_topic_0142168380.html)" **约束限制**： 不涉及 **取值范围**： 不涉及 **默认取值**： 不涉及 | | values | 是 | Array of strings | **参数解释**： 标签的值。参考章节"[约束与限制](https://support.huaweicloud.com/productdesc-tms/zh-cn_topic_0142168380.html)" **约束限制**： 不涉及 | #### 响应参数 **状态码：200** 表4响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | resources | Array of [Resources] objects | **参数解释**： 资源列表，每一个Resources对象包含项目ID、项目名称、资源ID等字段。 | | errors | Array of [Errors] objects | **参数解释**： 查询异常时返回的错误信息，每个元素包含错误码、错误描述及对应的项目ID和资源类型信息。 | | total_count | Integer | **参数解释**： 标签下的资源总数。 **取值范围**： 不涉及 | 表5Resources | 参数 | 参数类型 | 描述 | |:---|:---|:---| | project_id | String | **参数解释**： 项目ID。获取方式请参见：["获取项目ID"](https://support.huaweicloud.com/api-tms/zh-cn_topic_0126416752.html)。 **取值范围**： 不涉及 | | project_name | String | **参数解释**： 项目名称。 **取值范围**： 不涉及 | | resource_detail | Object | **参数解释**： 资源详情。 | | resource_id | String | **参数解释**： 资源ID。 **取值范围**： 不涉及 | | resource_name | String | **参数解释**： 资源名称。 **取值范围**： 不涉及 | | resource_type | String | **参数解释**： 资源类型。例如：ecs，scaling_group，images，disk，vpc，security-groups，shared_bandwidth，eip，cdn等。获取方式请参见"[查询标签管理支持的服务](https://support.huaweicloud.com/api-tms/ListProviders.html)"章节。 **取值范围**： 不涉及 | | tags | Array of [FilterTagResponse] objects | **参数解释**： 资源的标签，每一个元素是FilterTagResponse，包含标签的键与值。 | 表6FilterTagResponse | 参数 | 参数类型 | 描述 | |:---|:---|:---| | key | String | **参数解释**： 标签的键。 **取值范围**： 不涉及 | | value | String | **参数解释**： 标签的值。 **取值范围**： 不涉及 | 表7Errors | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | **参数解释**： 错误码。参考["错误码](https://console.huaweicloud.com/apiexplorer/#/errorcenter/TMS)"。 **取值范围**： 不涉及 | | error_msg | String | **参数解释**： 错误描述。 **取值范围**： 不涉及 | | project_id | String | **参数解释**： 项目ID。 获取方式请参见：["获取项目ID"](https://support.huaweicloud.com/api-tms/zh-cn_topic_0126416752.html)。 **取值范围**： 不涉及 | | resource_type | String | **参数解释**： 资源类型。例如：ecs，scaling_group，images，disk，vpc，security-groups，shared_bandwidth，eip，cdn等。 获取方式请参见"[查询标签管理支持的服务](https://support.huaweicloud.com/api-tms/ListProviders.html)"章节。 **取值范围**： 不涉及 | **状态码：400** 表8响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error | [RespErrorMessage] object | **参数解释**： 响应的错误信息。 | 表9RespErrorMessage | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | **参数解释**： 错误码。请到"[错误码](https://console.huaweicloud.com/apiexplorer/#/errorcenter)"页面查询对应云服务的错误码。 **取值范围**： 不涉及 | | error_msg | String | **参数解释**： 错误描述。 **取值范围**： 不涉及 | **状态码：401** 表10响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error | [RespErrorMessage] object | **参数解释**： 响应的错误信息。 | 表11RespErrorMessage | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | **参数解释**： 错误码。请到"[错误码](https://console.huaweicloud.com/apiexplorer/#/errorcenter)"页面查询对应云服务的错误码。 **取值范围**： 不涉及 | | error_msg | String | **参数解释**： 错误描述。 **取值范围**： 不涉及 | **状态码：402** 表12响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error | [RespErrorMessage] object | **参数解释**： 响应的错误信息。 | 表13RespErrorMessage | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | **参数解释**： 错误码。请到"[错误码](https://console.huaweicloud.com/apiexplorer/#/errorcenter)"页面查询对应云服务的错误码。 **取值范围**： 不涉及 | | error_msg | String | **参数解释**： 错误描述。 **取值范围**： 不涉及 | **状态码：403** 表14响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error | [RespErrorMessage] object | **参数解释**： 响应的错误信息。 | 表15RespErrorMessage | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | **参数解释**： 错误码。请到"[错误码](https://console.huaweicloud.com/apiexplorer/#/errorcenter)"页面查询对应云服务的错误码。 **取值范围**： 不涉及 | | error_msg | String | **参数解释**： 错误描述。 **取值范围**： 不涉及 | **状态码：404** 表16响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error | [RespErrorMessage] object | **参数解释**： 响应的错误信息。 | 表17RespErrorMessage | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | **参数解释**： 错误码。请到"[错误码](https://console.huaweicloud.com/apiexplorer/#/errorcenter)"页面查询对应云服务的错误码。 **取值范围**： 不涉及 | | error_msg | String | **参数解释**： 错误描述。 **取值范围**： 不涉及 | **状态码：405** 表18响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error | [RespErrorMessage] object | **参数解释**： 响应的错误信息。 | 表19RespErrorMessage | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | **参数解释**： 错误码。请到"[错误码](https://console.huaweicloud.com/apiexplorer/#/errorcenter)"页面查询对应云服务的错误码。 **取值范围**： 不涉及 | | error_msg | String | **参数解释**： 错误描述。 **取值范围**： 不涉及 | **状态码：406** 表20响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error | [RespErrorMessage] object | **参数解释**： 响应的错误信息。 | 表21RespErrorMessage | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | **参数解释**： 错误码。请到"[错误码](https://console.huaweicloud.com/apiexplorer/#/errorcenter)"页面查询对应云服务的错误码。 **取值范围**： 不涉及 | | error_msg | String | **参数解释**： 错误描述。 **取值范围**： 不涉及 | **状态码：407** 表22响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error | [RespErrorMessage] object | **参数解释**： 响应的错误信息。 | 表23RespErrorMessage | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | **参数解释**： 错误码。请到"[错误码](https://console.huaweicloud.com/apiexplorer/#/errorcenter)"页面查询对应云服务的错误码。 **取值范围**： 不涉及 | | error_msg | String | **参数解释**： 错误描述。 **取值范围**： 不涉及 | **状态码：408** 表24响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error | [RespErrorMessage] object | **参数解释**： 响应的错误信息。 | 表25RespErrorMessage | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | **参数解释**： 错误码。请到"[错误码](https://console.huaweicloud.com/apiexplorer/#/errorcenter)"页面查询对应云服务的错误码。 **取值范围**： 不涉及 | | error_msg | String | **参数解释**： 错误描述。 **取值范围**： 不涉及 | **状态码：409** 表26响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error | [RespErrorMessage] object | **参数解释**： 响应的错误信息。 | 表27RespErrorMessage | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | **参数解释**： 错误码。请到"[错误码](https://console.huaweicloud.com/apiexplorer/#/errorcenter)"页面查询对应云服务的错误码。 **取值范围**： 不涉及 | | error_msg | String | **参数解释**： 错误描述。 **取值范围**： 不涉及 | **状态码：500** 表28响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error | [RespErrorMessage] object | **参数解释**： 响应的错误信息。 | 表29RespErrorMessage | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | **参数解释**： 错误码。请到"[错误码](https://console.huaweicloud.com/apiexplorer/#/errorcenter)"页面查询对应云服务的错误码。 **取值范围**： 不涉及 | | error_msg | String | **参数解释**： 错误描述。 **取值范围**： 不涉及 | **状态码：501** 表30响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error | [RespErrorMessage] object | **参数解释**： 响应的错误信息。 | 表31RespErrorMessage | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | **参数解释**： 错误码。请到"[错误码](https://console.huaweicloud.com/apiexplorer/#/errorcenter)"页面查询对应云服务的错误码。 **取值范围**： 不涉及 | | error_msg | String | **参数解释**： 错误描述。 **取值范围**： 不涉及 | **状态码：502** 表32响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error | [RespErrorMessage] object | **参数解释**： 响应的错误信息。 | 表33RespErrorMessage | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | **参数解释**： 错误码。请到"[错误码](https://console.huaweicloud.com/apiexplorer/#/errorcenter)"页面查询对应云服务的错误码。 **取值范围**： 不涉及 | | error_msg | String | **参数解释**： 错误描述。 **取值范围**： 不涉及 | **状态码：503** 表34响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error | [RespErrorMessage] object | **参数解释**： 响应的错误信息。 | 表35RespErrorMessage | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | **参数解释**： 错误码。请到"[错误码](https://console.huaweicloud.com/apiexplorer/#/errorcenter)"页面查询对应云服务的错误码。 **取值范围**： 不涉及 | | error_msg | String | **参数解释**： 错误描述。 **取值范围**： 不涉及 | **状态码：504** 表36响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error | [RespErrorMessage] object | **参数解释**： 响应的错误信息。 | 表37RespErrorMessage | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | **参数解释**： 错误码。请到"[错误码](https://console.huaweicloud.com/apiexplorer/#/errorcenter)"页面查询对应云服务的错误码。 **取值范围**： 不涉及 | | error_msg | String | **参数解释**： 错误描述。 **取值范围**： 不涉及 | #### 请求示例 根据标签过滤资源。 ``` POST https://{Endpoint}/v1.0/resource-instances/filter { "project_id" : "e1eb7c40cbea4c8389cde527594a306d", "resource_types" : [ "disk", "ecs" ], "tags" : [ { "key" : "env", "values" : [ "dev", "prod" ] }, { "key" : "test", "values" : [ "test" ] } ], "offset" : 0, "limit" : 10 } ``` #### 响应示例 **状态码：200** OK ``` { "resources" : [ { "project_id" : "e1eb7c40cbea4c8389cde527594a306d", "project_name" : "XXXX", "resource_type" : "disk", "resource_id" : "b621f5ae-b5c1-49d7-a660-752c445434b4", "resource_name" : "lhj1-volume-0001", "tags" : [ { "key" : "ENV", "value" : "dev" } ] }, { "project_id" : "e1eb7c40cbea4c8389cde527594a306d", "project_name" : "XXXX", "resource_type" : "disk", "resource_id" : "87c9edc9-f66c-48b8-a22f-372b2e22d579", "resource_name" : "lhj2-volume-0002", "tags" : [ { "key" : "prod", "value" : "disk" } ] } ], "errors" : [ { "project_id" : "e1eb7c40cbea4c8389cde527594a306d", "resource_type" : "disk", "error_code" : "TMS.0002", "error_msg" : "Bad request" } ], "total_count" : 2 } ``` #### 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.*; import java.util.List; import java.util.ArrayList; public class ListResourceSolution { 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(); ListResourceRequest request = new ListResourceRequest(); ResqTagResource body = new ResqTagResource(); List listTagsValues = new ArrayList<>(); listTagsValues.add("test"); List listTagsValues1 = new ArrayList<>(); listTagsValues1.add("dev"); listTagsValues1.add("prod"); List listbodyTags = new ArrayList<>(); listbodyTags.add( new Tag() .withKey("env") .withValues(listTagsValues1) ); listbodyTags.add( new Tag() .withKey("test") .withValues(listTagsValues) ); List listbodyResourceTypes = new ArrayList<>(); listbodyResourceTypes.add("disk"); listbodyResourceTypes.add("ecs"); body.withLimit(10); body.withOffset(0); body.withTags(listbodyTags); body.withResourceTypes(listbodyResourceTypes); body.withProjectId("e1eb7c40cbea4c8389cde527594a306d"); request.withBody(body); try { ListResourceResponse response = client.listResource(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 = ListResourceRequest() listValuesTags = [ "test" ] listValuesTags1 = [ "dev", "prod" ] listTagsbody = [ Tag( key="env", values=listValuesTags1 ), Tag( key="test", values=listValuesTags ) ] listResourceTypesbody = [ "disk", "ecs" ] request.body = ResqTagResource( limit=10, offset=0, tags=listTagsbody, resource_types=listResourceTypesbody, project_id="e1eb7c40cbea4c8389cde527594a306d" ) response = client.list_resource(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.ListResourceRequest{} var listValuesTags = []string{ "test", } var listValuesTags1 = []string{ "dev", "prod", } var listTagsbody = []model.Tag{ { Key: "env", Values: listValuesTags1, }, { Key: "test", Values: listValuesTags, }, } var listResourceTypesbody = []string{ "disk", "ecs", } limitResqTagResource:= int32(10) offsetResqTagResource:= int32(0) projectIdResqTagResource:= "e1eb7c40cbea4c8389cde527594a306d" request.Body = &model.ResqTagResource{ Limit: &limitResqTagResource, Offset: &offsetResqTagResource, Tags: listTagsbody, ResourceTypes: listResourceTypesbody, ProjectId: &projectIdResqTagResource, } response, err := client.ListResource(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=ListResource)的代码示例页签，可生成自动对应的SDK代码示例。 #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | OK | | 400 | Bad Request | | 401 | Unauthorized | | 402 | Payment Required | | 403 | Forbidden | | 404 | Not Found | | 405 | Method Not Allowed | | 406 | Not Acceptable | | 407 | Proxy Authentication Required | | 408 | Request Timeout | | 409 | Conflict | | 500 | Internal Server Error | | 501 | Not Implemented | | 502 | Bad Gateway | | 503 | Service Unavailable | | 504 | Gateway Timeout | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-tms/ErrorCode.html)。