Updated on 2024-01-09 GMT+08:00

Querying Predefined Tags

Function

This API is used to query predefined tags.

Calling Method

For details, see Calling APIs.

URI

GET /v1.0/predefine_tags

Table 1 Query Parameters

Parameter

Mandatory

Type

Description

key

No

String

Specifies the tag key. Fuzzy search is supported. Key is case insensitive. If the key contains non-URL-safe characters, it must be URL encoded.

value

No

String

Specifies the tag value. Fuzzy search is supported. Value is case insensitive. If the value contains non-URL-safe characters, it must be URL encoded.

limit

No

Integer

Specifies the number of records to be queried, which is 10 by default. The maximum value is 1000 and the minimum value is 1. If the value is 0, the number of records to be queried is not limited.

Minimum: 1

Maximum: 1000

Default: 10

marker

No

String

Specifies the paging location marker (index position). 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 you query the data on the first page. When you query the data on subsequent pages, set this parameter to the marker value returned in the response body for the previous query. If the returned tags is empty, the last page is queried.

order_field

No

String

Specifies the sorting field. The value can be update_time, key, or value. The value is case sensitive. You can sort tags based on the value of order_method. If this value is not specified, the default value is update_time. For example: If order_field is set to update_time, values of key and value are sorted in ascending order. If order_field is set to key, values of update_time are sorted in descending order and value in ascending order. If order_field is set to value, values of update_time are sorted in descending order and value in ascending order. If order_field is not specified, the default value update_time is used, and values of key and value are sorted in ascending order.

Default: update_time

order_method

No

String

Specifies the sorting method of order_field. The value can be asc or desc. The value is case sensitive. If this parameter is not specified, the default value is desc.

Default: desc

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Specifies the user token. TMS is a global service. When calling the Identity and Access Management (IAM) API to obtain a user token, 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

Specifies the paging location marker (index position).

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

Specifies the tag key. The value can contain up to 36 characters including letters, digits, hyphens (-), and underscores (_).

value

String

Specifies the tag value.The value can contain up to 43 characters including letters, digits, periods (.), hyphens (-), and underscores (_). It can be an empty string.

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 predefined tags

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

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

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.