Querying Resource Tags
Description
This API is used to query tags of a specified resource.
Restrictions
A maximum of 10 tags can be added to a DB instance. The tag key must be unique.
URI
- URI format
GET https://{Endpoint}/v3/{project_id}/instances/{instance_id}/tags
Requests
Parameter description
Name | Type | IN | Mandatory | Description |
---|---|---|---|---|
X-Auth-Token | string | header | Yes | User token |
project_id | string | path | Yes | Project ID of a tenant in a region. To obtain the project ID, see Obtaining a Project ID. |
instance_id | string | path | Yes | 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. |
Responses
- Parameter description
Table 2 Parameter description Name
Mandatory
Type
Description
tags
Yes
Array of objects
The tag list. For more information, see Table 3.
Table 3 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 "-".
- Response example{"tags": [{"key": "key1","value": "value1"},{"key": "key2","value": "value2"}]}
Status Code
For more information, see Status Code.
Error Code
For more information, see Error Code.
- Description
- Restrictions
- URI
- Requests
- Responses
- Status Code
- Error Code