查询预定义标签列表 - ListPredefineTags
功能介绍
用于查询预定义标签列表。
调用方法
请参见如何调用API。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,需具备如下身份策略权限。
授权项
访问级别
资源类型(*为必须)
条件键
别名
依赖的授权项
tms:predefineTags:list
List
-
-
-
-
URI
GET /v1.0/predefine_tags
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| key | 否 | String | 参数解释: 标签的键。 约束限制: 1.不区分大小写。 2.如果包含“non-URL-safe”的字符,需要进行“urlencoded”。 3.支持模糊查询。 取值范围: 字符集:A-Z,a-z , 0-9,‘-’,‘_’,UNICODE字符(\u4E00-\u9FFF)。 最大长度36个字符。 默认取值: 不涉及 |
| value | 否 | String | 参数解释: 标签的值。 约束限制: 1.不区分大小写。 2.如果包含“non-URL-safe”的字符,需要进行“urlencoded”。 3.支持模糊查询。 取值范围: 字符集:A-Z,a-z ,0-9,‘.’,‘-’,‘_’,UNICODE字符(\u4E00-\u9FFF)。 每个值最大长度43个字符,可以为空字符串。 默认取值: 不涉及 |
| limit | 否 | Integer | 参数解释: 查询记录数。 约束限制: 不涉及 取值范围: 1-1000 默认取值: 10 |
| marker | 否 | String | 参数解释: 分页位置标识(索引)。从marker指定索引的下一条数据开始查询。 约束限制: 当返回的列表为空时表示查询到最后一页,不需要再查询下一页。 取值范围: 需要查询后续页码数据时,将查询前一页数据响应体中marker值配入此参数。 默认取值: 空:表示查询第一页数据。 |
| order_field | 否 | String | 参数解释: 排序字段。 约束限制: 只能选择排序字段中的一个,并按照排序方法字段order_method进行排序。 取值范围: 默认取值: update_time |
| order_method | 否 | String | 参数解释: order_field字段的排序方法。 约束限制: 只能选择值的其中之一。 取值范围: 默认取值: desc |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| X-Auth-Token | 是 | String | 参数解释: 用户Token。(获取方式参考“认证鉴权”) 约束限制: 由于TMS是全局服务,因此调用IAM服务获取用户Token接口时需要注意,作用域即scope字段应该设置为domain。 取值范围: 不涉及 默认取值: 不涉及 |
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| marker | String | 参数解释: 分页位置标识(索引)。从marker指定索引的下一条数据开始查询。 取值范围: 需要查询后续页码数据时,将查询前一页数据响应体中marker值配入此参数。 |
| total_count | Integer | 参数解释: 查询到的标签总数。 取值范围: 不涉及 |
| tags | Array of PredefineTag objects | 参数解释: 查询到的预定义标签列表。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| key | String | 参数解释: 标签的键。 取值范围: 字符集:A-Z,a-z , 0-9,‘-’,‘_’,UNICODE字符(\u4E00-\u9FFF)。 最大长度36个字符。 |
| value | String | 参数解释: 标签的值。 取值范围: 字符集:A-Z,a-z ,0-9,‘.’,‘-’,‘_’,UNICODE字符(\u4E00-\u9FFF)。 每个值最大长度43个字符,可以为空字符串。 |
| update_time | String | 参数解释: 更新时间,采用UTC时间表示。例如:2016-12-09T00:00:00Z。 |
状态码:400
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error | RespErrorMessage object | 响应错误信息。 |
状态码:401
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error | RespErrorMessage object | 响应错误信息。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 请求错误码。 |
| error_msg | String | 错误信息。 |
状态码:403
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error | RespErrorMessage object | 响应错误信息。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 请求错误码。 |
| error_msg | String | 错误信息。 |
状态码:404
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error | RespErrorMessage object | 响应错误信息。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 请求错误码。 |
| error_msg | String | 错误信息。 |
状态码:405
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error | RespErrorMessage object | 响应错误信息。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 请求错误码。 |
| error_msg | String | 错误信息。 |
状态码:406
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error | RespErrorMessage object | 响应错误信息。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 请求错误码。 |
| error_msg | String | 错误信息。 |
状态码:409
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error | RespErrorMessage object | 响应错误信息。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 请求错误码。 |
| error_msg | String | 错误信息。 |
状态码:410
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error | RespErrorMessage object | 响应错误信息。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 请求错误码。 |
| error_msg | String | 错误信息。 |
状态码:412
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error | RespErrorMessage object | 响应错误信息。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 请求错误码。 |
| error_msg | String | 错误信息。 |
状态码:429
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error | RespErrorMessage object | 响应错误信息。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 请求错误码。 |
| error_msg | String | 错误信息。 |
状态码:500
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error | RespErrorMessage object | 响应错误信息。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 请求错误码。 |
| error_msg | String | 错误信息。 |
状态码:501
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error | RespErrorMessage object | 响应错误信息。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 请求错误码。 |
| error_msg | String | 错误信息。 |
状态码:503
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error | RespErrorMessage object | 响应错误信息。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 请求错误码。 |
| error_msg | String | 错误信息。 |
请求示例
查询预定义标签列表
GET https://{Endpoint}/v1.0/predefine_tags?key=ENV&value=DEV&limit=10&marker=9&order_field=key&order_method=asc 响应示例
状态码:200
OK
{
"marker" : "12",
"total_count" : 13,
"tags" : [ {
"key" : "ENV1",
"value" : "DEV1",
"update_time" : "2017-04-12T14:22:34Z"
}, {
"key" : "ENV2",
"value" : "DEV2",
"update_time" : "2017-04-12T14:22:34Z"
} ]
} 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 ListPredefineTagsSolution { 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(); ListPredefineTagsRequest request = new ListPredefineTagsRequest(); try { ListPredefineTagsResponse response = client.listPredefineTags(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 = ListPredefineTagsRequest() response = client.list_predefine_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.ListPredefineTagsRequest{} response, err := client.ListPredefineTags(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 |
错误码
请参见错误码。