文档首页/标签管理服务 TMS/API参考（安卡拉区域）/API说明/预定义标签操作/查询预定义标签列表
更新时间：2025-03-31 GMT+08:00
在线调试
CLI示例
查看PDF
分享

查询预定义标签列表

功能介绍

用于查询预定义标签列表。

调用方法

详细信息请参见如何调用API。

URI

GET /v1.0/predefine_tags

表1 Query参数

参数

是否必选

参数类型

描述

key

否

String

键，支持模糊查询，不区分大小写，如果包含“non-URL-safe”的字符，需要进行“urlencoded”。

value

否

String

值，支持模糊查询，不区分大小写，如果包含“non-URL-safe”的字符，需要进行“urlencoded”。

limit

否

Integer

查询记录数。

最小为1，最大为1000，未输入时默认为10，为0时不限制查询数据条数。

marker

否

String

分页位置标识（索引）。从marker指定索引的下一条数据开始查询。说明：查询第一页数据时，不需要传入此参数，查询后续页码数据时，将查询前一页数据响应体中marker值配入此参数，当返回的tags为空列表时表示查询到最后一页。

order_field

否

String

排序字段：

可输入的值包含（区分大小写）：update_time（更新时间）、key（键）、value（值）。

只能选择以上排序字段中的一个，并按照排序方法字段order_method进行排序，如果不传则默认值为：update_time。

如以下：

若该字段为update_time，则剩余两个默认字段排序为key升序，value升序。

若该字段如为key，则剩余两个默认字段排序为update_time降序，value升序。

若该字段如为value，则剩余两个默认字段排序为update_time降序，key升序。

若该字段不传，默认字段为update_time，则剩余两个默认字段排序为key升序，value升序。

order_method

否

String

order_field字段的排序方法。

可输入的值包含（区分大小写）：

asc（升序）

desc（降序）

只能选择以上值的其中之一。

不传则默认值为：desc

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token。说明：由于TMS是全局服务，因此调用IAM服务获取用户Token接口时需要注意作用域即scope字段应该设置为domain。响应消息头中X-Subject-Token的值即为用户Token。

响应参数

状态码： 200

表3 响应Body参数

参数

参数类型

描述

marker

String

分页位置标识（索引）。

total_count

Integer

查询到的标签总数

tags

Array of PredefineTag objects

查询到的标签列表

表4 PredefineTag

参数

参数类型

描述

key

String

键。

最大长度36个字符。 字符集：A-Z，a-z ， 0-9，‘-’，‘_’，UNICODE字符（\u4E00-\u9FFF）。

value

String

值。每个值最大长度43个字符，可以为空字符串。 字符集：A-Z，a-z ， 0-9，‘.’，‘-’，‘_’，UNICODE字符（\u4E00-\u9FFF）。

update_time

String

更新时间，采用UTC时间表示。2016-12-09T00:00:00Z

状态码： 400

表5 响应Body参数

参数

参数类型

描述

error

RespErrorMessage object

响应错误信息

表6 RespErrorMessage

参数

参数类型

描述

error_code

String

请求错误码

error_msg

String

错误信息

状态码： 401

表7 响应Body参数

参数

参数类型

描述

error

RespErrorMessage object

响应错误信息

表8 RespErrorMessage

参数

参数类型

描述

error_code

String

请求错误码

error_msg

String

错误信息

状态码： 403

表9 响应Body参数

参数

参数类型

描述

error

RespErrorMessage object

响应错误信息

表10 RespErrorMessage

参数

参数类型

描述

error_code

String

请求错误码

error_msg

String

错误信息

状态码： 404

表11 响应Body参数

参数

参数类型

描述

error

RespErrorMessage object

响应错误信息

表12 RespErrorMessage

参数

参数类型

描述

error_code

String

请求错误码

error_msg

String

错误信息

状态码： 405

表13 响应Body参数

参数

参数类型

描述

error

RespErrorMessage object

响应错误信息

表14 RespErrorMessage

参数

参数类型

描述

error_code

String

请求错误码

error_msg

String

错误信息

状态码： 406

表15 响应Body参数

参数

参数类型

描述

error

RespErrorMessage object

响应错误信息

表16 RespErrorMessage

参数

参数类型

描述

error_code

String

请求错误码

error_msg

String

错误信息

状态码： 409

表17 响应Body参数

参数

参数类型

描述

error

RespErrorMessage object

响应错误信息

表18 RespErrorMessage

参数

参数类型

描述

error_code

String

请求错误码

error_msg

String

错误信息

状态码： 410

表19 响应Body参数

参数

参数类型

描述

error

RespErrorMessage object

响应错误信息

表20 RespErrorMessage

参数

参数类型

描述

error_code

String

请求错误码

error_msg

String

错误信息

状态码： 412

表21 响应Body参数

参数

参数类型

描述

error

RespErrorMessage object

响应错误信息

表22 RespErrorMessage

参数

参数类型

描述

error_code

String

请求错误码

error_msg

String

错误信息

状态码： 429

表23 响应Body参数

参数

参数类型

描述

error

RespErrorMessage object

响应错误信息

表24 RespErrorMessage

参数

参数类型

描述

error_code

String

请求错误码

error_msg

String

错误信息

状态码： 500

表25 响应Body参数

参数

参数类型

描述

error

RespErrorMessage object

响应错误信息

表26 RespErrorMessage

参数

参数类型

描述

error_code

String

请求错误码

error_msg

String

错误信息

状态码： 501

表27 响应Body参数

参数

参数类型

描述

error

RespErrorMessage object

响应错误信息

表28 RespErrorMessage

参数

参数类型

描述

error_code

String

请求错误码

error_msg

String

错误信息

状态码： 503

表29 响应Body参数

参数

参数类型

描述

error

RespErrorMessage object

响应错误信息

表30 RespErrorMessage

参数

参数类型

描述

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"
  } ]
}

状态码

状态码

描述

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

错误码

请参见错误码。

父主题： 预定义标签操作