- API Reference
- APIs v3
- Tags
- Querying Tags of an Instance
Querying Tags of an Instance¶
Function¶
This API is used to query tags of a specified instance.
Constraints¶
This API supports GeminiDB Cassandra instances.
A maximum of 20 tags can be added to a DB instance. The tag key must be unique.
URI¶
GET https://{Endpoint}/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 | Instance ID. |
Request Parameters¶
Parameter | Mandatory | Type | Description |
---|---|---|---|
X-Auth-Token | Yes | String | User token. |
Response Parameters¶
Status code: 200
Parameter | Type | Description |
---|---|---|
tags | Array of ListInstanceTagsResult objects | Tags of the instance. |
Parameter | Type | Description |
---|---|---|
key | String | Tag key. The tag key can contain a maximum of 36 Unicode characters and must be specified. It is case-sensitive and can contain digits, letters, underscores (_), and hyphens (-). |
value | String | Tag value. The tag value can contain a maximum of 43 Unicode characters and can be an empty string. It is case-sensitive and can contain digits, letters, underscores (_), and hyphens (-). |
Example Requests¶
URI example
GET https://{Endpoint}/v3/375d8d8fad1f43039e23d3b6c0f60a19/instances/9136fd2a9fcd405ea4674276ce36dae8in02/tags
Example Responses¶
Status code: 200
Success
{
"tags" : [ {
"key" : "key1",
"value" : "value1"
}, {
"key" : "key2",
"value" : "value2"
} ]
}
Status Codes¶
For details, see Status Codes.
Error Codes¶
For details, see Error Codes.