# 查询预定义标签列表 - ListPredefineTags #### 功能介绍 用于查询预定义标签列表。 #### 调用方法 请参见[如何调用API](https://support.huaweicloud.com/api-tms/zh-cn_topic_0056283725.html)。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-tms/zh-cn_topic_0170638684.html)。 - 如果使用身份策略授权，需具备如下身份策略权限。 | 授权项 | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 | |:---|:---|:---|:---|:---|:---| | tms:predefineTags:list | List | - | - | - | - | #### URI GET /v1.0/predefine_tags 表1Query参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | key | 否 | String | **参数解释**： 标签的键。 **约束限制**： 1.不区分大小写。 2.参数需要进行"urlencoded"。 3.支持包含匹配模糊查询。 **取值范围**： 字符集：A-Z，a-z ， 0-9，'-'，'_'，UNICODE字符（\\u4E00-\\u9FFF）。 最大长度36个字符。 **默认取值**： 不涉及 | | value | 否 | String | **参数解释**： 标签的值。 **约束限制**： 1.不区分大小写。 2.参数需要进行"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默认降序，key与value默认升序。 **取值范围**： - update_time：按预定义标签的更新时间排序。 - key：按预定义标签的键排序。 - value：按预定义标签的值排序。 **默认取值**： update_time | | order_method | 否 | String | **参数解释**： 指定order_field字段的排序方式，用于控制查询结果的排列顺序。 **约束限制**： 需配合order_field参数使用，仅当指定order_field时此参数生效。 **取值范围**： - asc：升序 - desc：降序 **默认取值**： desc | #### 请求参数 表2请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | X-Auth-Token | 是 | String | **参数解释**： 用户Token。（获取方式参考"[认证鉴权](https://support.huaweicloud.com/api-tms/zh-cn_topic_0173938834.html)"）。 **约束限制**： 由于TMS是全局服务，因此调用IAM服务获取用户Token接口时需要注意，作用域即scope字段应该设置为domain。 **取值范围**： 不涉及 **默认取值**： 不涉及 | #### 响应参数 **状态码：200** 表3响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | marker | String | **参数解释**： 分页位置标识（索引）。从marker指定索引的下一条数据开始查询。需要查询后续页码数据时，将查询前一页数据响应体中marker值配入此参数。 **取值范围**： 数字字符串，表示分页索引位置。 | | total_count | Integer | **参数解释**： 查询到的预定义标签总数，单位：个。 **取值范围**： 不涉及 | | tags | Array of [PredefineTag] objects | **参数解释**： 查询到的预定义标签列表，每个元素为PredefineTag对象，包含标签的键、值和更新时间。 | 表4PredefineTag | 参数 | 参数类型 | 描述 | |:---|:---|:---| | key | String | **参数解释**： 标签的键。 **取值范围**： 字符集：A-Z，a-z ， 0-9，'-'，'_'，UNICODE字符（\\u4E00-\\u9FFF）。 最大长度36个字符。 | | value | String | **参数解释**： 标签的值。 **取值范围**： 字符集：A-Z，a-z ，0-9，'.'，'-'，'_'，UNICODE字符（\\u4E00-\\u9FFF）。 0\~43个字符，可以为空字符串。 | | update_time | String | **参数解释**： 更新时间，采用UTC时间表示。例如：2016-12-09T00:00:00Z。 **取值范围**： 不涉及 | **状态码：400** 表5响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error | [RespErrorMessage] object | **参数解释**： 响应的错误信息。 | 表6RespErrorMessage | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | **参数解释**： 错误码。请到"[错误码](https://console.huaweicloud.com/apiexplorer/#/errorcenter)"页面查询对应云服务的错误码。 **取值范围**： 不涉及 | | error_msg | String | **参数解释**： 错误描述。 **取值范围**： 不涉及 | **状态码：401** 表7响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error | [RespErrorMessage] object | **参数解释**： 响应的错误信息。 | 表8RespErrorMessage | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | **参数解释**： 错误码。请到"[错误码](https://console.huaweicloud.com/apiexplorer/#/errorcenter)"页面查询对应云服务的错误码。 **取值范围**： 不涉及 | | error_msg | String | **参数解释**： 错误描述。 **取值范围**： 不涉及 | **状态码：403** 表9响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error | [RespErrorMessage] object | **参数解释**： 响应的错误信息。 | 表10RespErrorMessage | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | **参数解释**： 错误码。请到"[错误码](https://console.huaweicloud.com/apiexplorer/#/errorcenter)"页面查询对应云服务的错误码。 **取值范围**： 不涉及 | | error_msg | String | **参数解释**： 错误描述。 **取值范围**： 不涉及 | **状态码：404** 表11响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error | [RespErrorMessage] object | **参数解释**： 响应的错误信息。 | 表12RespErrorMessage | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | **参数解释**： 错误码。请到"[错误码](https://console.huaweicloud.com/apiexplorer/#/errorcenter)"页面查询对应云服务的错误码。 **取值范围**： 不涉及 | | error_msg | String | **参数解释**： 错误描述。 **取值范围**： 不涉及 | **状态码：405** 表13响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error | [RespErrorMessage] object | **参数解释**： 响应的错误信息。 | 表14RespErrorMessage | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | **参数解释**： 错误码。请到"[错误码](https://console.huaweicloud.com/apiexplorer/#/errorcenter)"页面查询对应云服务的错误码。 **取值范围**： 不涉及 | | error_msg | String | **参数解释**： 错误描述。 **取值范围**： 不涉及 | **状态码：406** 表15响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error | [RespErrorMessage] object | **参数解释**： 响应的错误信息。 | 表16RespErrorMessage | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | **参数解释**： 错误码。请到"[错误码](https://console.huaweicloud.com/apiexplorer/#/errorcenter)"页面查询对应云服务的错误码。 **取值范围**： 不涉及 | | error_msg | String | **参数解释**： 错误描述。 **取值范围**： 不涉及 | **状态码：409** 表17响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error | [RespErrorMessage] object | **参数解释**： 响应的错误信息。 | 表18RespErrorMessage | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | **参数解释**： 错误码。请到"[错误码](https://console.huaweicloud.com/apiexplorer/#/errorcenter)"页面查询对应云服务的错误码。 **取值范围**： 不涉及 | | error_msg | String | **参数解释**： 错误描述。 **取值范围**： 不涉及 | **状态码：410** 表19响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error | [RespErrorMessage] object | **参数解释**： 响应的错误信息。 | 表20RespErrorMessage | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | **参数解释**： 错误码。请到"[错误码](https://console.huaweicloud.com/apiexplorer/#/errorcenter)"页面查询对应云服务的错误码。 **取值范围**： 不涉及 | | error_msg | String | **参数解释**： 错误描述。 **取值范围**： 不涉及 | **状态码：412** 表21响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error | [RespErrorMessage] object | **参数解释**： 响应的错误信息。 | 表22RespErrorMessage | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | **参数解释**： 错误码。请到"[错误码](https://console.huaweicloud.com/apiexplorer/#/errorcenter)"页面查询对应云服务的错误码。 **取值范围**： 不涉及 | | error_msg | String | **参数解释**： 错误描述。 **取值范围**： 不涉及 | **状态码：429** 表23响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error | [RespErrorMessage] object | **参数解释**： 响应的错误信息。 | 表24RespErrorMessage | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | **参数解释**： 错误码。请到"[错误码](https://console.huaweicloud.com/apiexplorer/#/errorcenter)"页面查询对应云服务的错误码。 **取值范围**： 不涉及 | | error_msg | String | **参数解释**： 错误描述。 **取值范围**： 不涉及 | **状态码：500** 表25响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error | [RespErrorMessage] object | **参数解释**： 响应的错误信息。 | 表26RespErrorMessage | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | **参数解释**： 错误码。请到"[错误码](https://console.huaweicloud.com/apiexplorer/#/errorcenter)"页面查询对应云服务的错误码。 **取值范围**： 不涉及 | | error_msg | String | **参数解释**： 错误描述。 **取值范围**： 不涉及 | **状态码：501** 表27响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error | [RespErrorMessage] object | **参数解释**： 响应的错误信息。 | 表28RespErrorMessage | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | **参数解释**： 错误码。请到"[错误码](https://console.huaweicloud.com/apiexplorer/#/errorcenter)"页面查询对应云服务的错误码。 **取值范围**： 不涉及 | | error_msg | String | **参数解释**： 错误描述。 **取值范围**： 不涉及 | **状态码：503** 表29响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error | [RespErrorMessage] object | **参数解释**： 响应的错误信息。 | 表30RespErrorMessage | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | **参数解释**： 错误码。请到"[错误码](https://console.huaweicloud.com/apiexplorer/#/errorcenter)"页面查询对应云服务的错误码。 **取值范围**： 不涉及 | | 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代码示例如下。 #### 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 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("")) .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()); } } } ``` #### 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("")) \ .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) ``` #### 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("")). WithCredential(auth). SafeBuild() if err != nil { fmt.Println(err) return } client := tms.NewTmsClient(hcClient) request := &model.ListPredefineTagsRequest{} response, err := client.ListPredefineTags(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } ``` #### 更多 更多编程语言的SDK代码示例，请参见[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/TMS/sdk?api=ListPredefineTags)的代码示例页签，可生成自动对应的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 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-tms/ErrorCode.html)。