Querying Resource Tags

Function

This API is used to query tags of a specified resource.

Constraints

A maximum of 20 tags can be added to a DB instance. The tag key must be unique.

URI

URI format
GET /v3/{project_id}/instances/{instance_id}/tags

**Table 1** Path parameters
Name	Mandatory	Type	IN	Description
project_id	Yes	string	path	Explanation: Project ID of a tenant in a region. To obtain the project ID, see Obtaining a Project ID. Constraints: N/A Value range: N/A Default value: N/A
instance_id	Yes	string	path	Explanation: Instance ID, which can be obtained by calling the API described in Querying Instances and Details. If you do not have an instance, call the API described in Creating a DB Instance to create one. Constraints: N/A Value range: N/A Default value: N/A

Request Parameters

**Table 2** Request header parameters
Name	Mandatory	Type	IN	Description
X-Auth-Token	Yes	string	header	Definition User token obtained from IAM. For details, see Authentication. Constraints N/A Range N/A Default Value N/A

Response Parameters

**Table 3** Parameter description
Name	Mandatory	Type	Description
tags	Yes	Array of objects	The tag list. For more information, see Table 4.

**Table 4** tags field data structure description
Name	Mandatory	Type	Description
key	Yes	String	The tag key. The key cannot be empty and contains 1 to 128 single-byte characters. The key can contain UTF-8 letters (including Chinese characters), digits, spaces, and the following characters: _.:/=+-@ Do not enter labels starting with _sys_, which are system labels. Character set: 0-9, A-Z, a-z, "_", and "-".
value	Yes	String	The tag value. The value can contain UTF-8 letters (including Chinese characters), digits, spaces, and the following characters: _.:/=+-@ The value can be empty or null and contains 0 to 255 single-byte characters. Character set: 0-9, A-Z, a-z, "_", "." and "-".

Example Requests

https://{Endpoint}/v3/0549b4a43100d4f32f51c01c2fe4acdb/instances/cc6345c64cec47499182467ea0dd432ain02/tags

Example Responses

{
  "tags": [
    {
      "key": "key1",
      "value": "value1"
    },
    {
      "key": "key2",
      "value": "value2"
    }
  ]
}

SDK

Click Document Database Service DDS SDK to download the SDK or view the SDK document. To learn how to install and authenticate an SDK, read the Usage section.