Querying the Tag List
Function
This API is used to query all tags of a tenant with a specified region and instance type.
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:resourceTags:list
List
-
-
-
-
URI
GET /v1.0/tags
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| resource_types | Yes | String | Definition List of resource types. The value of this parameter is case-sensitive. The options include ecs, scaling_group, images, disk, vpc, security-groups, shared_bandwidth, eip, and cdn. For details, see Querying Services Supported by TMS. Constraints Multiple resource types are separated by commas (,). Range 0 to 10,000 characters. Default Value N/A |
| project_id | Yes | String | Definition Project ID. For details about how to obtain it, see Obtaining a Project ID. Constraints This parameter is mandatory when resource_type is set to a region-level service. Range N/A Default Value N/A |
| tag_types | Yes | String | Definition Tag type. Constraints N/A Range Default Value N/A |
Request 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
| Parameter | Type | Description |
|---|---|---|
| tags | Array of TagResponse objects | Definition Tag list. Each element contains a tag key and a list of tag values. |
| errors | Array of Errors objects | Definition Error list. Each element contains the error code, error description, project ID, and resource type. |
| Parameter | Type | Description |
|---|---|---|
| key | String | Definition Tag key. Range N/A |
| values | Array of strings | Definition List of tag values. |
| Parameter | Type | Description |
|---|---|---|
| error_code | String | Definition Error code. For details, see Error Codes. Range N/A |
| error_msg | String | Definition Error description. Range N/A |
| project_id | String | Definition Project ID. For details about how to obtain it, see Obtaining a Project ID. Range N/A |
| resource_type | String | Definition Resource type. The options include ecs, scaling_group, images, disk, vpc, security-groups, shared_bandwidth, eip, and cdn. For details about how to obtain it, see Querying Services Supported by TMS. Range N/A |
Status code: 400
| Parameter | Type | Description |
|---|---|---|
| error | RespErrorMessage object | Definition Error message in the response. |
| 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
| Parameter | Type | Description |
|---|---|---|
| error | RespErrorMessage object | Definition Error message in the response. |
| 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
| Parameter | Type | Description |
|---|---|---|
| error | RespErrorMessage object | Definition Error message in the response. |
| 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
| Parameter | Type | Description |
|---|---|---|
| error | RespErrorMessage object | Definition Error message in the response. |
| 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
| Parameter | Type | Description |
|---|---|---|
| error | RespErrorMessage object | Definition Error message in the response. |
| 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
| Parameter | Type | Description |
|---|---|---|
| error | RespErrorMessage object | Definition Error message in the response. |
| 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
| Parameter | Type | Description |
|---|---|---|
| error | RespErrorMessage object | Definition Error message in the response. |
| 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
| Parameter | Type | Description |
|---|---|---|
| error | RespErrorMessage object | Definition Error message in the response. |
| 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
| Parameter | Type | Description |
|---|---|---|
| error | RespErrorMessage object | Definition Error message in the response. |
| 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
| Parameter | Type | Description |
|---|---|---|
| error | RespErrorMessage object | Definition Error message in the response. |
| 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
| Parameter | Type | Description |
|---|---|---|
| error | RespErrorMessage object | Definition Error message in the response. |
| 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
| Parameter | Type | Description |
|---|---|---|
| error | RespErrorMessage object | Definition Error message in the response. |
| 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
| Parameter | Type | Description |
|---|---|---|
| error | RespErrorMessage object | Definition Error message in the response. |
| 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 the tag list
GET https://{Endpoint}/v1.0/tags?tag_types=resource&resource_types=vpc&project_id=XXXXXX Example Responses
Status code: 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 Sample Code
The SDK sample code is as follows.
Java
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()); } } } |
Python
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) |
Go
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 46 47 | 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.ListTagsRequest{} response, err := client.ListTags(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
More
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 |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot