# 查询标签列表 - ListTags #### 功能介绍 查询指定区域和实例类型中租户的所有标签 #### 调用方法 请参见[如何调用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:resourceTags:list | List | - | - | - | - | #### URI GET /v1.0/tags 表1Query参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | resource_types | 是 | String | **参数解释**： 资源类型的列表。 此参数为可输入的值（区分大小写）。例如：ecs，scaling_group，images，disk，vpc，security-groups，shared_bandwidth，eip，cdn等，具体请参见"[查询标签管理支持的服务](https://support.huaweicloud.com/api-tms/ListProviders.html)"章节。 **约束限制**： 多个资源类型间使用","（英文逗号）分隔。 **取值范围**： 1\~10000个字符。 **默认取值**： 不涉及 | | project_id | 是 | String | **参数解释**： 项目ID。 获取方式请参见：["获取项目ID"](https://support.huaweicloud.com/api-tms/zh-cn_topic_0126416752.html)。 **约束限制**： resource_type为region级别服务时，必选项。 **取值范围**： 不涉及 **默认取值**： 不涉及 | | tag_types | 是 | String | **参数解释**： 标签的类型。 **约束限制**： 不涉及 **取值范围**： - resource：资源标签，表示查询资源关联的标签 **默认取值**： 不涉及 | #### 请求参数 表2请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | X-Auth-Token | 是 | String | **参数解释**： 用户Token。（获取方式参考"[认证鉴权](https://support.huaweicloud.com/api-tms/zh-cn_topic_0173938834.html)"）。 **约束限制**： 由于TMS是全局服务，因此调用IAM服务获取用户Token接口时需要注意，作用域即scope字段应该设置为domain。 **取值范围**： 不涉及 **默认取值**： 不涉及 | #### 响应参数 **状态码：200** 表3响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | tags | Array of [TagResponse] objects | **参数解释**： 标签列表，每个元素包含标签键和对应的标签值列表。 | | errors | Array of [Errors] objects | **参数解释**： 错误列表，每个元素包含错误码、错误描述及对应的项目ID和资源类型信息。 | 表4TagResponse | 参数 | 参数类型 | 描述 | |:---|:---|:---| | key | String | **参数解释**： 标签的键。 **取值范围**： 不涉及 | | values | Array of strings | **参数解释**： 标签的值列表，每个元素为标签键对应的一个标签值。 | 表5Errors | 参数 | 参数类型 | 描述 | |:---|:---|:---| | 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** 表6响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error | [RespErrorMessage] object | **参数解释**： 响应的错误信息。 | 表7RespErrorMessage | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | **参数解释**： 错误码。请到"[错误码](https://console.huaweicloud.com/apiexplorer/#/errorcenter)"页面查询对应云服务的错误码。 **取值范围**： 不涉及 | | error_msg | String | **参数解释**： 错误描述。 **取值范围**： 不涉及 | **状态码：401** 表8响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error | [RespErrorMessage] object | **参数解释**： 响应的错误信息。 | 表9RespErrorMessage | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | **参数解释**： 错误码。请到"[错误码](https://console.huaweicloud.com/apiexplorer/#/errorcenter)"页面查询对应云服务的错误码。 **取值范围**： 不涉及 | | error_msg | String | **参数解释**： 错误描述。 **取值范围**： 不涉及 | **状态码：403** 表10响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error | [RespErrorMessage] object | **参数解释**： 响应的错误信息。 | 表11RespErrorMessage | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | **参数解释**： 错误码。请到"[错误码](https://console.huaweicloud.com/apiexplorer/#/errorcenter)"页面查询对应云服务的错误码。 **取值范围**： 不涉及 | | error_msg | String | **参数解释**： 错误描述。 **取值范围**： 不涉及 | **状态码：404** 表12响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error | [RespErrorMessage] object | **参数解释**： 响应的错误信息。 | 表13RespErrorMessage | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | **参数解释**： 错误码。请到"[错误码](https://console.huaweicloud.com/apiexplorer/#/errorcenter)"页面查询对应云服务的错误码。 **取值范围**： 不涉及 | | error_msg | String | **参数解释**： 错误描述。 **取值范围**： 不涉及 | **状态码：405** 表14响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error | [RespErrorMessage] object | **参数解释**： 响应的错误信息。 | 表15RespErrorMessage | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | **参数解释**： 错误码。请到"[错误码](https://console.huaweicloud.com/apiexplorer/#/errorcenter)"页面查询对应云服务的错误码。 **取值范围**： 不涉及 | | error_msg | String | **参数解释**： 错误描述。 **取值范围**： 不涉及 | **状态码：406** 表16响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error | [RespErrorMessage] object | **参数解释**： 响应的错误信息。 | 表17RespErrorMessage | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | **参数解释**： 错误码。请到"[错误码](https://console.huaweicloud.com/apiexplorer/#/errorcenter)"页面查询对应云服务的错误码。 **取值范围**： 不涉及 | | error_msg | String | **参数解释**： 错误描述。 **取值范围**： 不涉及 | **状态码：409** 表18响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error | [RespErrorMessage] object | **参数解释**： 响应的错误信息。 | 表19RespErrorMessage | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | **参数解释**： 错误码。请到"[错误码](https://console.huaweicloud.com/apiexplorer/#/errorcenter)"页面查询对应云服务的错误码。 **取值范围**： 不涉及 | | error_msg | String | **参数解释**： 错误描述。 **取值范围**： 不涉及 | **状态码：410** 表20响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error | [RespErrorMessage] object | **参数解释**： 响应的错误信息。 | 表21RespErrorMessage | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | **参数解释**： 错误码。请到"[错误码](https://console.huaweicloud.com/apiexplorer/#/errorcenter)"页面查询对应云服务的错误码。 **取值范围**： 不涉及 | | error_msg | String | **参数解释**： 错误描述。 **取值范围**： 不涉及 | **状态码：412** 表22响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error | [RespErrorMessage] object | **参数解释**： 响应的错误信息。 | 表23RespErrorMessage | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | **参数解释**： 错误码。请到"[错误码](https://console.huaweicloud.com/apiexplorer/#/errorcenter)"页面查询对应云服务的错误码。 **取值范围**： 不涉及 | | error_msg | String | **参数解释**： 错误描述。 **取值范围**： 不涉及 | **状态码：429** 表24响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error | [RespErrorMessage] object | **参数解释**： 响应的错误信息。 | 表25RespErrorMessage | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | **参数解释**： 错误码。请到"[错误码](https://console.huaweicloud.com/apiexplorer/#/errorcenter)"页面查询对应云服务的错误码。 **取值范围**： 不涉及 | | error_msg | String | **参数解释**： 错误描述。 **取值范围**： 不涉及 | **状态码：500** 表26响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error | [RespErrorMessage] object | **参数解释**： 响应的错误信息。 | 表27RespErrorMessage | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | **参数解释**： 错误码。请到"[错误码](https://console.huaweicloud.com/apiexplorer/#/errorcenter)"页面查询对应云服务的错误码。 **取值范围**： 不涉及 | | error_msg | String | **参数解释**： 错误描述。 **取值范围**： 不涉及 | **状态码：501** 表28响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error | [RespErrorMessage] object | **参数解释**： 响应的错误信息。 | 表29RespErrorMessage | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | **参数解释**： 错误码。请到"[错误码](https://console.huaweicloud.com/apiexplorer/#/errorcenter)"页面查询对应云服务的错误码。 **取值范围**： 不涉及 | | error_msg | String | **参数解释**： 错误描述。 **取值范围**： 不涉及 | **状态码：503** 表30响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error | [RespErrorMessage] object | **参数解释**： 响应的错误信息。 | 表31RespErrorMessage | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | **参数解释**： 错误码。请到"[错误码](https://console.huaweicloud.com/apiexplorer/#/errorcenter)"页面查询对应云服务的错误码。 **取值范围**： 不涉及 | | error_msg | String | **参数解释**： 错误描述。 **取值范围**： 不涉及 | #### 请求示例 查询标签列表 ``` GET https://{Endpoint}/v1.0/tags?tag_types=resource&resource_types=vpc&project_id=XXXXXX ``` #### 响应示例 **状态码：200** OK ``` { "tags" : [ { "key" : "env", "values" : [ "test", "prod" ] }, { "key" : "flag", "values" : [ "0", "1" ] } ], "errors" : [ { "project_id" : "e1eb7c40cbea4c8389cde527594a306d", "resource_type" : "disk", "error_code" : "TMS.0002", "error_msg" : "Bad request" } ] } ``` #### 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 ListTagsSolution { 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(); ListTagsRequest request = new ListTagsRequest(); try { ListTagsResponse response = client.listTags(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 = ListTagsRequest() response = client.list_tags(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.ListTagsRequest{} response, err := client.ListTags(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=ListTags)的代码示例页签，可生成自动对应的SDK代码示例。 #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | OK | | 400 | Bad Request | | 401 | Unauthorized | | 403 | Forbidden | | 404 | Not Found | | 405 | Method Not Allowed | | 406 | Not Acceptable | | 409 | Conflict | | 410 | Gone | | 412 | Precondition Failed | | 429 | Too Many Requests | | 500 | Internal Server Error | | 501 | Not Implemented | | 503 | Service Unavailable | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-tms/ErrorCode.html)。