Help Center> Tag Management Service> API Reference> API Description> Operations on Predefined Tags> Querying the Predefined Tag List

View PDF

Querying the Predefined Tag List

Function

Used to query the predefined tag list.

Debugging

You can use API Explorer to debug this API.

URI

GET /v1.0/predefine_tags

**Table 1** Query parameters
Parameter	Mandatory	Type	Description
key	No	String	Key. Supports fuzzy search and is case insensitive. If the value contains non-URL-safe characters, it must be URL encoded.
value	No	String	Value. Supports fuzzy search and is case insensitive. If the parameter contains non-URL-safe characters, it must be URL encoded.
limit	No	Integer	Specifies the number of records to be queried. The value ranges from 1 to 1000. If no value is specified, the default value 10 is used. If the value is 0, the number of data records to be queried is not limited. Minimum: 1 Maximum: 1000 Default: 10
marker	No	String	Paging location ID (index). 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 querying the data on the first page. When querying the data on subsequent pages, set this parameter to the marker value in the response body for querying the data on the previous page. If the returned tags is an empty list, the last page is queried.
order_field	No	String	Sort By: The value can be update_time (update time), key (key), or value (value). The value is case sensitive. You can select only one of the preceding sorting fields and sort data based on the sorting method field order_method. If this parameter is not transferred, the default value update_time is used. For example: If the value of this field is update_time, keys and values are sorted in ascending order. If the field is key, values of update_time are sorted in descending order and values in ascending order. If this field is set to value, the values of update_time are sorted in descending order and keys in ascending order. If this parameter is not transferred, the default value is update_time Default: update_time
order_method	No	String	Sorting method of the order_field field. The value can be (case sensitive): asc (ascending order) desc (descending order) Only one of the preceding values can be selected. If this parameter is not transferred, the default value is desc. Default: desc

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	User token. Note: TMS is a global service. Therefore, when calling the IAM service to obtain user tokens, 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

**Table 3** Response body parameters
Parameter	Type	Description
marker	String	Paging location ID (index).
total_count	Integer	Total number of queried tags.
tags	Array of PredefineTag objects	List of queried tags.

**Table 4** PredefineTag
Parameter	Type	Description
key	String	\t\n key. \nThe value can contain a maximum of 36 characters. Only letters, digits, hyphens (-), and underscores (_) are allowed.
value	String	Value. A tag value can contain a maximum of 43 characters and can be an empty string. Character set: A-Z, a-z, 0-9, '.', '-', '_', UNICODE characters (\u4E00-\u9FFF).
update_time	String	Update time, which must be the UTC time. 2016-12-09T00:00:00Z

Status code: 400

**Table 5** Response body parameters
Parameter	Type	Description
error	RespErrorMessage object	Response error information.

**Table 6** RespErrorMessage
Parameter	Type	Description
error_code	String	Request error code.
error_msg	String	Error message

Status code: 401

**Table 7** Response body parameters
Parameter	Type	Description
error	RespErrorMessage object	Response error information.

**Table 8** RespErrorMessage
Parameter	Type	Description
error_code	String	Request error code.
error_msg	String	Error message

Status code: 403

**Table 9** Response body parameters
Parameter	Type	Description
error	RespErrorMessage object	Response error information.

**Table 10** RespErrorMessage
Parameter	Type	Description
error_code	String	Request error code.
error_msg	String	Error message

Status code: 404

**Table 11** Response body parameters
Parameter	Type	Description
error	RespErrorMessage object	Response error information.

**Table 12** RespErrorMessage
Parameter	Type	Description
error_code	String	Request error code.
error_msg	String	Error message

Status code: 405

**Table 13** Response body parameters
Parameter	Type	Description
error	RespErrorMessage object	Response error information.

**Table 14** RespErrorMessage
Parameter	Type	Description
error_code	String	Request error code.
error_msg	String	Error message

Status code: 406

**Table 15** Response body parameters
Parameter	Type	Description
error	RespErrorMessage object	Response error information.

**Table 16** RespErrorMessage
Parameter	Type	Description
error_code	String	Request error code.
error_msg	String	Error message

Status code: 409

**Table 17** Response body parameters
Parameter	Type	Description
error	RespErrorMessage object	Response error information.

**Table 18** RespErrorMessage
Parameter	Type	Description
error_code	String	Request error code.
error_msg	String	Error message

Status code: 410

**Table 19** Response body parameters
Parameter	Type	Description
error	RespErrorMessage object	Response error information.

**Table 20** RespErrorMessage
Parameter	Type	Description
error_code	String	Request error code.
error_msg	String	Error message

Status code: 412

**Table 21** Response body parameters
Parameter	Type	Description
error	RespErrorMessage object	Response error information.

**Table 22** RespErrorMessage
Parameter	Type	Description
error_code	String	Request error code.
error_msg	String	Error message

Status code: 429

**Table 23** Response body parameters
Parameter	Type	Description
error	RespErrorMessage object	Response error information.

**Table 24** RespErrorMessage
Parameter	Type	Description
error_code	String	Request error code.
error_msg	String	Error message

Status code: 500

**Table 25** Response body parameters
Parameter	Type	Description
error	RespErrorMessage object	Response error information.

**Table 26** RespErrorMessage
Parameter	Type	Description
error_code	String	Request error code.
error_msg	String	Error message

Status code: 501

**Table 27** Response body parameters
Parameter	Type	Description
error	RespErrorMessage object	Response error information.

**Table 28** RespErrorMessage
Parameter	Type	Description
error_code	String	Request error code.
error_msg	String	Error message

Status code: 503

**Table 29** Response body parameters
Parameter	Type	Description
error	RespErrorMessage object	Response error information.

**Table 30** RespErrorMessage
Parameter	Type	Description
error_code	String	Request error code.
error_msg	String	Error message

Example Requests

Querying the Predefined Tag List

GET https://{Endpoint}/v1.0/predefine_tags?key=ENV&value=DEV&limit=10&marker=9&order_field=key&order_method=asc

Example Responses

Status code: 200

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

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.

Parent topic: Operations on Predefined Tags

Last Article: Creating and Deleting Predefined Tags

Next Article: Modifying a predefined tag

Did this article solve your problem?

Thank you for your score！Your feedback would help us improve the website.

Products

Compute

Application

Dedicated Cloud

Storage

Management & Deployment

Migration

Network

Enterprise Intelligence

Video

Database

Edge Cloud Services

DevCloud

Security

Cloud Communications

Internet of Things

Solutions

Industry-Specific Solutions

General-Purpose Solutions

Security

DevOps

Enterprise Intelligence

Essential Platform

Big Data

Visual Cognition

Speech and Semantics

Support

Help Center

Customer Services

Developers

Console

语言 - Language

中国站 - 简体中文

中国站 - English

International - 简体中文

International - English

Help Center

Querying the Predefined Tag List

Function

Debugging

URI

Request Parameters

Response Parameters

Example Requests

Example Responses

Status Codes

Error Codes