更新时间:2026-05-11 GMT+08:00
分享

查询标签列表 - ListTags

功能介绍

查询指定区域和实例类型中租户的所有标签

调用方法

请参见如何调用API

授权信息

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

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

    授权项

    访问级别

    资源类型(*为必须)

    条件键

    别名

    依赖的授权项

    tms:resourceTags:list

    List

    -

    -

    -

    -

URI

GET /v1.0/tags

表1 Query参数

参数

是否必选

参数类型

描述

resource_types

String

参数解释

资源类型的列表。

约束限制

10000个字符以内,资源类型间使用“,”(英文逗号)分隔。

取值范围

此参数为可输入的值(区分大小写)。例如:ecs,scaling_group, images, disk,vpcs,security-groups, shared_bandwidth,eip, cdn等,具体请参见“查询标签管理支持的服务”章节。

默认取值

不涉及

project_id

String

参数解释

项目ID。

约束限制

resource_type为region级别服务时,必选项。

取值范围

获取方式请参见:“获取项目ID“

默认取值

不涉及

tag_types

String

参数解释

标签的类型。

约束限制

不涉及

取值范围

resource:资源标签

默认取值

不涉及

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释

用户Token。(获取方式参考“认证鉴权”)

约束限制

由于TMS是全局服务,因此调用IAM服务获取用户Token接口时需要注意,作用域即scope字段应该设置为domain。

取值范围

不涉及

默认取值

不涉及

响应参数

状态码:200

表3 响应Body参数

参数

参数类型

描述

tags

Array of TagResponse objects

参数解释

标签列表。

errors

Array of Errors objects

参数解释

错误列表。

表4 TagResponse

参数

参数类型

描述

key

String

参数解释

标签的键。

取值范围

每个云资源的标签取值范围可能不同,请到对应云服务的标签资料中确认。

values

Array of strings

参数解释

标签的值列表。

取值范围

每个云资源的标签取值范围可能不同,请到对应云服务的标签资料中确认。

表5 Errors

参数

参数类型

描述

error_code

String

参数解释

错误码。

取值范围

参考“错误码”。

error_msg

String

参数解释

错误描述。

取值范围

不涉及

project_id

String

参数解释

项目ID。

取值范围

获取方式请参见:“获取项目ID“

resource_type

String

参数解释

资源类型。例如:ecs,scaling_group, images, disk,vpcs,security-groups, shared_bandwidth,eip, cdn等。

取值范围

获取方式请参见“查询标签管理支持的服务”章节。

状态码:400

表6 响应Body参数

参数

参数类型

描述

error

RespErrorMessage object

响应错误信息。

表7 RespErrorMessage

参数

参数类型

描述

error_code

String

请求错误码。

error_msg

String

错误信息。

状态码:401

表8 响应Body参数

参数

参数类型

描述

error

RespErrorMessage object

响应错误信息。

表9 RespErrorMessage

参数

参数类型

描述

error_code

String

请求错误码。

error_msg

String

错误信息。

状态码:403

表10 响应Body参数

参数

参数类型

描述

error

RespErrorMessage object

响应错误信息。

表11 RespErrorMessage

参数

参数类型

描述

error_code

String

请求错误码。

error_msg

String

错误信息。

状态码:404

表12 响应Body参数

参数

参数类型

描述

error

RespErrorMessage object

响应错误信息。

表13 RespErrorMessage

参数

参数类型

描述

error_code

String

请求错误码。

error_msg

String

错误信息。

状态码:405

表14 响应Body参数

参数

参数类型

描述

error

RespErrorMessage object

响应错误信息。

表15 RespErrorMessage

参数

参数类型

描述

error_code

String

请求错误码。

error_msg

String

错误信息。

状态码:406

表16 响应Body参数

参数

参数类型

描述

error

RespErrorMessage object

响应错误信息。

表17 RespErrorMessage

参数

参数类型

描述

error_code

String

请求错误码。

error_msg

String

错误信息。

状态码:409

表18 响应Body参数

参数

参数类型

描述

error

RespErrorMessage object

响应错误信息。

表19 RespErrorMessage

参数

参数类型

描述

error_code

String

请求错误码。

error_msg

String

错误信息。

状态码:410

表20 响应Body参数

参数

参数类型

描述

error

RespErrorMessage object

响应错误信息。

表21 RespErrorMessage

参数

参数类型

描述

error_code

String

请求错误码。

error_msg

String

错误信息。

状态码:412

表22 响应Body参数

参数

参数类型

描述

error

RespErrorMessage object

响应错误信息。

表23 RespErrorMessage

参数

参数类型

描述

error_code

String

请求错误码。

error_msg

String

错误信息。

状态码:429

表24 响应Body参数

参数

参数类型

描述

error

RespErrorMessage object

响应错误信息。

表25 RespErrorMessage

参数

参数类型

描述

error_code

String

请求错误码。

error_msg

String

错误信息。

状态码:500

表26 响应Body参数

参数

参数类型

描述

error

RespErrorMessage object

响应错误信息。

表27 RespErrorMessage

参数

参数类型

描述

error_code

String

请求错误码。

error_msg

String

错误信息。

状态码:501

表28 响应Body参数

参数

参数类型

描述

error

RespErrorMessage object

响应错误信息。

表29 RespErrorMessage

参数

参数类型

描述

error_code

String

请求错误码。

error_msg

String

错误信息。

状态码:503

表30 响应Body参数

参数

参数类型

描述

error

RespErrorMessage object

响应错误信息。

表31 RespErrorMessage

参数

参数类型

描述

error_code

String

请求错误码。

error_msg

String

错误信息。

请求示例

查询标签列表

GET https://{Endpoint}/v1.0/tags?tag_types=resource&resource_types=vpcs&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代码示例如下。

 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 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("<YOUR REGION>"))
                .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());
        }
    }
}
 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 = 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)
 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
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 := global.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        Build()

    client := tms.NewTmsClient(
        tms.TmsClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

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

更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的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

错误码

请参见错误码

相关文档