Help Center/ Tag Management Service/ API Reference/ API Description/ Resource Tags/ Querying Tag Values

Updated on 2026-07-30 GMT+08:00

Querying Tag Values

Function

This API is used to query all tag values by tag key in a specified region.

Calling Method

For details, see Calling APIs.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
If you are using identity policy-based authorization, the following identity policy-based permissions are required.

Action

Access Level

Resource Type (*: required)

Condition Key

Alias

Dependencies

tms:tagValues:list

List

-

-

-

-

Action	Access Level	Resource Type (*: required)	Condition Key	Alias	Dependencies
tms:tagValues:list	List	-	-	-	-

URI

GET /v1.0/tag-values

**Table 1** Query Parameters
Parameter	Mandatory	Type	Description
region_id	No	String	Definition Region ID. For details about how to obtain the region ID, see Obtaining Account, IAM User, Group, Project, Region, and Agency Information. Constraints N/A Range N/A Default Value N/A
resource_types	No	Array of strings	Definition Resource type. 1 to 10 resource types can be queried at a time. The format is ecs.cloudservers. For details about how to obtain the resource types, see Listing All Interconnected Cloud Services. Constraints N/A
limit	No	Integer	Definition Number of records returned by a query. Constraints N/A Range 1–200 Default Value 200
marker	No	String	Definition Paging location marker (index position). The query starts from the next piece of data of the index specified by marker. Constraints If the returned list is empty, the last page has been reached, and no further query is required. Range When you query the data on subsequent pages, set this parameter to the value of marker in the response body of querying data on the previous page. Default Value If you do not set this parameter, the data on the first page is queried.
key	Yes	String	Definition Tag key. Constraints For details, see Notes and Constraints. Range N/A Default Value N/A

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Definition User token. For details about how to obtain it, see Authentication. Constraints TMS is a global service. Set scope to domain when you call the IAM API to obtain a user token. Range N/A Default Value N/A

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
values	Array of strings	Definition Tag values queried. The tag value range of each cloud resource may vary. For details, see the tag documentation of the corresponding cloud service.
page_info	PageInfoTag object	Definition Pagination information.

**Table 4** PageInfoTag
Parameter	Type	Description
next_marker	String	Definition Paging location marker (index position). The query starts from the next piece of data of the index specified by marker. When you query the data on subsequent pages, set this parameter to the value of marker in the response body of querying data on the previous page. Range N/A
current_count	Integer	Definition Number of tag values on the current page. Range N/A

Status code: 400

**Table 5** Response body parameters
Parameter	Type	Description
error	RespErrorMessage object	Definition Error message in the response.

**Table 6** RespErrorMessage
Parameter	Type	Description
error_code	String	Definition Error code. For details about the error codes of the corresponding cloud service, see Error Codes. Range N/A
error_msg	String	Definition Error description. Range N/A

Status code: 401

**Table 7** Response body parameters
Parameter	Type	Description
error	RespErrorMessage object	Definition Error message in the response.

**Table 8** RespErrorMessage
Parameter	Type	Description
error_code	String	Definition Error code. For details about the error codes of the corresponding cloud service, see Error Codes. Range N/A
error_msg	String	Definition Error description. Range N/A

Status code: 403

**Table 9** Response body parameters
Parameter	Type	Description
error	RespErrorMessage object	Definition Error message in the response.

**Table 10** RespErrorMessage
Parameter	Type	Description
error_code	String	Definition Error code. For details about the error codes of the corresponding cloud service, see Error Codes. Range N/A
error_msg	String	Definition Error description. Range N/A

Status code: 404

**Table 11** Response body parameters
Parameter	Type	Description
error	RespErrorMessage object	Definition Error message in the response.

**Table 12** RespErrorMessage
Parameter	Type	Description
error_code	String	Definition Error code. For details about the error codes of the corresponding cloud service, see Error Codes. Range N/A
error_msg	String	Definition Error description. Range N/A

Status code: 405

**Table 13** Response body parameters
Parameter	Type	Description
error	RespErrorMessage object	Definition Error message in the response.

**Table 14** RespErrorMessage
Parameter	Type	Description
error_code	String	Definition Error code. For details about the error codes of the corresponding cloud service, see Error Codes. Range N/A
error_msg	String	Definition Error description. Range N/A

Status code: 406

**Table 15** Response body parameters
Parameter	Type	Description
error	RespErrorMessage object	Definition Error message in the response.

**Table 16** RespErrorMessage
Parameter	Type	Description
error_code	String	Definition Error code. For details about the error codes of the corresponding cloud service, see Error Codes. Range N/A
error_msg	String	Definition Error description. Range N/A

Status code: 409

**Table 17** Response body parameters
Parameter	Type	Description
error	RespErrorMessage object	Definition Error message in the response.

**Table 18** RespErrorMessage
Parameter	Type	Description
error_code	String	Definition Error code. For details about the error codes of the corresponding cloud service, see Error Codes. Range N/A
error_msg	String	Definition Error description. Range N/A

Status code: 410

**Table 19** Response body parameters
Parameter	Type	Description
error	RespErrorMessage object	Definition Error message in the response.

**Table 20** RespErrorMessage
Parameter	Type	Description
error_code	String	Definition Error code. For details about the error codes of the corresponding cloud service, see Error Codes. Range N/A
error_msg	String	Definition Error description. Range N/A

Status code: 412

**Table 21** Response body parameters
Parameter	Type	Description
error	RespErrorMessage object	Definition Error message in the response.

**Table 22** RespErrorMessage
Parameter	Type	Description
error_code	String	Definition Error code. For details about the error codes of the corresponding cloud service, see Error Codes. Range N/A
error_msg	String	Definition Error description. Range N/A

Status code: 429

**Table 23** Response body parameters
Parameter	Type	Description
error	RespErrorMessage object	Definition Error message in the response.

**Table 24** RespErrorMessage
Parameter	Type	Description
error_code	String	Definition Error code. For details about the error codes of the corresponding cloud service, see Error Codes. Range N/A
error_msg	String	Definition Error description. Range N/A

Status code: 500

**Table 25** Response body parameters
Parameter	Type	Description
error	RespErrorMessage object	Definition Error message in the response.

**Table 26** RespErrorMessage
Parameter	Type	Description
error_code	String	Definition Error code. For details about the error codes of the corresponding cloud service, see Error Codes. Range N/A
error_msg	String	Definition Error description. Range N/A

Status code: 501

**Table 27** Response body parameters
Parameter	Type	Description
error	RespErrorMessage object	Definition Error message in the response.

**Table 28** RespErrorMessage
Parameter	Type	Description
error_code	String	Definition Error code. For details about the error codes of the corresponding cloud service, see Error Codes. Range N/A
error_msg	String	Definition Error description. Range N/A

Status code: 503

**Table 29** Response body parameters
Parameter	Type	Description
error	RespErrorMessage object	Definition Error message in the response.

**Table 30** RespErrorMessage
Parameter	Type	Description
error_code	String	Definition Error code. For details about the error codes of the corresponding cloud service, see Error Codes. Range N/A
error_msg	String	Definition Error description. Range N/A

Example Requests

Querying tag values

GET https://{Endpoint}/v1.0/tag-values?limit=10&marker=9&key=tagKey

Example Responses

Status code: 200

{
  "values" : [ "ENV1", "ENV2" ],
  "page_info" : {
    "next_marker" : "xxxx",
    "current_count" : 2
  }
}

SDK Sample Code

The SDK sample code is as follows.

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 ListTagValuesSolution {

    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();
        ListTagValuesRequest request = new ListTagValuesRequest();
        try {
            ListTagValuesResponse response = client.listTagValues(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("<YOUR REGION>")) \
        .build()

    try:
        request = ListTagValuesRequest()
        response = client.list_tag_values(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("<YOUR REGION>")).
         WithCredential(auth).
         SafeBuild()


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

    client := tms.NewTmsClient(hcClient)

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

For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.

Status Codes

Status Code	Description
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