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.
URI
GET /v1.0/tags
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
resource_type |
Yes |
String |
Resource type. |
project_id |
Yes |
String |
Project ID. |
tag_types |
Yes |
String |
Tag type. |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
X-Auth-Token |
Yes |
String |
User token. TMS is a global service. Set scope to domain when you call the IAM API to obtain a user token. The value of X-Subject-Token in the response header is the user token. |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
tags |
Array of TagResponse objects |
Tag list. |
errors |
Array of TagListErrorItem objects |
Error list. |
Parameter |
Type |
Description |
---|---|---|
key |
String |
Tag key. |
values |
Array of strings |
Tag value list. |
Parameter |
Type |
Description |
---|---|---|
project_id |
String |
Project ID. |
resource_type |
String |
Resource type. |
error_code |
String |
Error code. |
error_msg |
String |
Error message. |
Status code: 400
Parameter |
Type |
Description |
---|---|---|
error |
RespErrorMessage object |
Response error information. |
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Request error code |
error_msg |
String |
Error message |
Status code: 401
Parameter |
Type |
Description |
---|---|---|
error |
RespErrorMessage object |
Response error information. |
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Request error code |
error_msg |
String |
Error message |
Status code: 403
Parameter |
Type |
Description |
---|---|---|
error |
RespErrorMessage object |
Response error information. |
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Request error code |
error_msg |
String |
Error message |
Status code: 404
Parameter |
Type |
Description |
---|---|---|
error |
RespErrorMessage object |
Response error information. |
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Request error code |
error_msg |
String |
Error message |
Status code: 405
Parameter |
Type |
Description |
---|---|---|
error |
RespErrorMessage object |
Response error information. |
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Request error code |
error_msg |
String |
Error message |
Status code: 406
Parameter |
Type |
Description |
---|---|---|
error |
RespErrorMessage object |
Response error information. |
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Request error code |
error_msg |
String |
Error message |
Status code: 409
Parameter |
Type |
Description |
---|---|---|
error |
RespErrorMessage object |
Response error information. |
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Request error code |
error_msg |
String |
Error message |
Status code: 410
Parameter |
Type |
Description |
---|---|---|
error |
RespErrorMessage object |
Response error information. |
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Request error code |
error_msg |
String |
Error message |
Status code: 412
Parameter |
Type |
Description |
---|---|---|
error |
RespErrorMessage object |
Response error information. |
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Request error code |
error_msg |
String |
Error message |
Status code: 429
Parameter |
Type |
Description |
---|---|---|
error |
RespErrorMessage object |
Response error information. |
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Request error code |
error_msg |
String |
Error message |
Status code: 500
Parameter |
Type |
Description |
---|---|---|
error |
RespErrorMessage object |
Response error information. |
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Request error code |
error_msg |
String |
Error message |
Status code: 501
Parameter |
Type |
Description |
---|---|---|
error |
RespErrorMessage object |
Response error information. |
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Request error code |
error_msg |
String |
Error message |
Status code: 503
Parameter |
Type |
Description |
---|---|---|
error |
RespErrorMessage object |
Response error information. |
Example Requests
Querying the tag list
GET https://{Endpoint}/v1.0/tags?tag_types=resource&resource_types=vpcs&projects=05c734153980d4202f2ec0176f1ef6b9
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.
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) } } |
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