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.
URI
GET /v1.0/tag-values
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
region_id |
No |
String |
Specifies the region ID. If this parameter is specified, tag values of the specified region are returned. |
limit |
No |
Integer |
Specifies the number of records to be queried, which is 200 by default. The maximum value is 200 and the minimum value is 1. |
marker |
No |
String |
Specifies the paging location marker (index position). The query starts from the next piece of data of the index specified by marker.Note:You do not need to specify this parameter when you query the data on the first page. When you query the data on subsequent pages, set this parameter to the marker value returned in the response body for the previous query. If the returned next_marker is empty, the last page is queried. |
key |
Yes |
String |
Specifies the tag key. |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
X-Auth-Token |
Yes |
String |
Specifies the user token. TMS is a global service. When calling the Identity and Access Management (IAM) API to obtain a user token, set the scope field to domain. The value of X-Subject-Token in the response header is the user token. |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
values |
Array of strings |
Specifies tag values queried. |
page_info |
PageInfoTagValues object |
Specifies the pagination information. |
Parameter |
Type |
Description |
---|---|---|
next_marker |
String |
Specifies the paging location marker (index position). |
current_count |
Integer |
Specifies the number of tag values on the current page. |
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 tag values
GET https://{Endpoint}/v1.0/tag-values?limit=10&marker=9
Example Responses
Status code: 200
OK
{ "values" : [ "ENV1", "ENV2" ], "page_info" : [ { "next_marker" : "xxxxx", "current_count" : 10 } ] }
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 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()); } } } |
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 = 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) |
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.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 |
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