- APIs (Recommended)
- Tag Management
- Querying Resource Tags
Querying Resource Tags¶
Function¶
This API is used to query tags of a specified instance. Before calling this API:
Learn how to authorize and authenticate it.
Obtain the required region and endpoint.
URI¶
GET /v3/{project_id}/instances/{instance_id}/tags
Parameter | Mandatory | Type | Description |
---|---|---|---|
project_id | Yes | String | Project ID of a tenant in a region. To obtain this value, see Obtaining a Project ID. |
instance_id | Yes | String | DB instance ID. |
Parameter | Mandatory | Type | Description |
---|---|---|---|
offset | No | Integer | Index offset. If offset is set to N, the resource query starts from the N+1 piece of data. The value is 0 by default, indicating that the query starts from the first piece of data. The value cannot be a negative number. |
limit | No | Integer | Number of records to be queried. The default value is 100. The value must be a positive integer. The minimum value is 1 and the maximum value is 100. |
Request Parameters¶
Parameter | Mandatory | Type | Description |
---|---|---|---|
X-Auth-Token | Yes | String | User token. |
X-Language | No | String | Language. |
Response Parameters¶
Status code: 200
Parameter | Type | Description |
---|---|---|
total_count | Integer | Total number of records. |
tags | Array of ResourceTagItem objects | Tag list. |
Parameter | Type | Description |
---|---|---|
key | String | Tag key. |
value | String | Tag value. |
Status code: 400
Parameter | Type | Description |
---|---|---|
error_code | String | Error code. |
error_msg | String | Error message. |
Status code: 500
Parameter | Type | Description |
---|---|---|
error_code | String | Error code. |
error_msg | String | Error message. |
Example Request¶
Querying resource tags
GET https://gaussdb-mysql.eu-de.otc.t-systems.com/v3/054e292c9880d4992f02c0196d3ea468/instances/61a4ea66210545909d74a05c27a7179ein07/tags?offset=0&limit=2
Example Response¶
Status code: 200
Success.
{
"total_count" : 2,
"tags" : [ {
"key" : "key1",
"value" : "value1"
}, {
"key" : "key2",
"value" : "value2"
} ]
}
Status Code¶
For details, see Status Codes.
Error Code¶
For details, see Error Codes.