5.2 预定义标签操作
5.2.2 查询预定义标签列表
功能介绍
用于查询预定义标签列表。
调试
您可以在API Explorer中调试该接口。
URI
GET /v1.0/predefine_tags
表5-83 Query 参数
参数 是否必选 参数类型 描述
key 否 String 键，支持模糊查询，不区分大小
写，如果包含“non-URL-safe”的字符，需要进行
“urlencoded”。
参数 是否必选 参数类型 描述
order_field 否 String 排序字段： 可输入的值包含
（区分大小写）：update_time
update_time。 如以下： 若该 字段为update_time，则剩余两 order_method 否 String order_field字段的排序方法。
可输入的值包含（区分大小 写）： asc（升序） desc（降 序） 只能选择以上值的其中之 一。 不传则默认值为：desc 缺省值：desc
请求参数
表5-84 请求 Header 参数
参数 是否必选 参数类型 描述
X-Auth-Token 是 String 用户Token。说明：由于TMS是 全局服务，因此调用IAM服务获
marker String 分页位置标识（索引）。
total_count Integer 查询到的标签总数 tags Array of
PredefineTag objects
查询到的标签列表
表5-86 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-87 响应 Body 参数
参数 参数类型 描述
error RespErrorMe
ssage object 响应错误信息
表5-88 RespErrorMessage
参数 参数类型 描述
error_code String 请求错误码 error_msg String 错误信息
状态码： 401
表5-89 响应 Body 参数
参数 参数类型 描述
error RespErrorMe
ssage object 响应错误信息
表5-90 RespErrorMessage
参数 参数类型 描述
error_code String 请求错误码 error_msg String 错误信息
状态码： 403
表5-91 响应 Body 参数
参数 参数类型 描述
error RespErrorMe
ssage object 响应错误信息
表5-92 RespErrorMessage
参数 参数类型 描述
error_code String 请求错误码 error_msg String 错误信息
状态码： 404
表5-93 响应 Body 参数
参数 参数类型 描述
error RespErrorMe
ssage object 响应错误信息
表5-94 RespErrorMessage
参数 参数类型 描述
error_code String 请求错误码 error_msg String 错误信息
状态码： 405
表5-95 响应 Body 参数
参数 参数类型 描述
error RespErrorMe
ssage object 响应错误信息
表5-96 RespErrorMessage
参数 参数类型 描述
error_code String 请求错误码 error_msg String 错误信息
状态码： 406
表5-97 响应 Body 参数
参数 参数类型 描述
error RespErrorMe
ssage object 响应错误信息
表5-98 RespErrorMessage
参数 参数类型 描述
error_code String 请求错误码 error_msg String 错误信息
状态码： 409
表5-99 响应 Body 参数
参数 参数类型 描述
error RespErrorMe
ssage object 响应错误信息
表5-100 RespErrorMessage
参数 参数类型 描述
error_code String 请求错误码 error_msg String 错误信息
状态码： 410
表5-101 响应 Body 参数
参数 参数类型 描述
error RespErrorMe
ssage object 响应错误信息
表5-102 RespErrorMessage
参数 参数类型 描述
error_code String 请求错误码 error_msg String 错误信息
状态码： 412
表5-103 响应 Body 参数
参数 参数类型 描述
error RespErrorMe
ssage object 响应错误信息
表5-104 RespErrorMessage
参数 参数类型 描述
error_code String 请求错误码 error_msg String 错误信息
状态码： 429
表5-105 响应 Body 参数
参数 参数类型 描述
error RespErrorMe
ssage object 响应错误信息
表5-106 RespErrorMessage
参数 参数类型 描述
error_code String 请求错误码 error_msg String 错误信息
状态码： 500
表5-107 响应 Body 参数
参数 参数类型 描述
error RespErrorMe
ssage object 响应错误信息
表5-108 RespErrorMessage
参数 参数类型 描述
error_code String 请求错误码 error_msg String 错误信息
状态码： 501
表5-109 响应 Body 参数
参数 参数类型 描述
error RespErrorMe
ssage object 响应错误信息
表5-110 RespErrorMessage
参数 参数类型 描述
error_code String 请求错误码 error_msg String 错误信息
状态码： 503
表5-111 响应 Body 参数
参数 参数类型 描述
error RespErrorMe
ssage object 响应错误信息
表5-112 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
错误码
请参见错误码。