Querying an Instance by Tag
Function
This API is used to query a specified instance by tag.
Constraints
This API supports the following types of instances:
- GeminiDB Cassandra
- GeminiDB Mongo
- GeminiDB Influx
- GeminiDB Redis
A maximum of 20 tags can be added to a DB instance. The tag key must be unique.
URI
POST https://{Endpoint}/v3/{project_id}/instances/resource-instances/action
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. |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
X-Auth-Token |
Yes |
String |
User token. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
offset |
No |
String |
Index offset. The query starts from the next piece of data indexed by this parameter.
|
limit |
No |
String |
Number of records to be queried.
|
action |
Yes |
String |
Operation identifier.
|
matches |
No |
Array of MatchOption objects |
Search parameter.
|
tags |
No |
Array of TagOption objects |
Included tags. Each tag contains a maximum of 20 keys. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
key |
Yes |
String |
Query criteria. The value can be instance_name or instance_id, indicating that the query is based on the instance name or instance ID. |
value |
Yes |
String |
Name or ID of the instance to be queried |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
key |
Yes |
String |
Tag key. It can contain a maximum of 36 Unicode characters. The key value cannot be null, an empty string, or spaces. Before using key, delete spaces before and after the value.
NOTE:
The character set of this parameter is not verified during search. |
values |
Yes |
Array of strings |
Tag values. Each tag value can contain a maximum of 43 Unicode characters and cannot contain spaces. Before using values, delete spaces before and after the value. If the values is not specified, any parameter value can be queried. All values are in the OR relationship. |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
instances |
Array of InstanceResult objects |
All instances. |
total_count |
Integer |
Total number of records. |
Parameter |
Type |
Description |
---|---|---|
instance_id |
String |
Instance ID. |
instance_name |
String |
Instance name. |
tags |
Array of InstanceTagResult objects |
All tags. If there are no tags, tags is taken as an empty array by default. |
Parameter |
Type |
Description |
---|---|---|
key |
String |
Tag key. The tag key must be specified and can include a maximum of 36 Unicode characters. 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 (_), periods (.), and hyphens (-). |
Example Requests
- URI example
POST https://gaussdb-nosql.ap-southeast-1.myhuaweicloud.com/v3/375d8d8fad1f43039e23d3b6c0f60a19/instances/resource-instances/action
- Example request body
Querying an instance by name (Set offset to 100 and limit to 100.)
{ "offset" : 100, "limit" : 100, "action" : "filter", "matches" : [{ "key" : "instance_name", "value" : "test-single" }], "tags" : [{ "key" : "key1", "values" : [ "value1", "value2" ] }] }
Querying total records
{ "action" : "count", "tags" : [ { "key" : "key1", "values" : [ "value1", "value2" ] }, { "key" : "key2", "values" : [ "value1", "value2" ] } ], "matches" : [ { "key" : "instance_name", "value" : "test-single" }, { "key" : "instance_id", "value" : "958693039f284d6ebfb177375711072ein06" } ] }
Example Responses
Status code: 200
Success
{ "total_count": 1, "instances" : [{ "instance_id" : "2acbf2223caf3bac3c33c6153423c3ccin06", "instance_name" : "test-single", "tags" : [ { "key" : "key1", "value" : "value1" }, { "key" : "key2", "value" : "value1" } ] }] }
Status Codes
For details, see Status Codes.
Error Codes
For details, see Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot