Querying DB Instances (v3.1)
Function
This API is used to query instances according to search criteria. Before calling this API:
- Learn how to authenticate this API.
- Obtain the required region and endpoint.
URI
GET https://{Endpoint}/v3.1/{project_id}/instances?id={id}&name={name}&type={type}&datastore_type={datastore_type}&vpc_id={vpc_id}&subnet_id={subnet_id}&offset={offset}&limit={limit}
Name |
Type |
Mandatory |
Description |
---|---|---|---|
project_id |
String |
Yes |
Project ID of a tenant in a region. For details about how to obtain the project ID, see Obtaining a Project ID. |
id |
String |
No |
Instance ID. The asterisk (*) is reserved for the system. If the instance ID starts with *, it indicates that fuzzy match is performed based on the value following *. Otherwise, the exact match is performed based on the instance ID. The value cannot contain only asterisks (*). |
name |
String |
No |
DB instance name. The asterisk (*) is reserved for the system. If the instance name starts with *, it indicates that fuzzy match is performed based on the value following *. Otherwise, the exact match is performed based on the instance name. The value cannot contain only asterisks (*). |
type |
String |
No |
Instance type to be queried. Currently, the following values are supported:
|
datastore_type |
String |
No |
Database type. Its value is case-insensitive. GaussDB |
vpc_id |
String |
No |
VPC ID. To obtain this parameter value, use the following methods:
|
subnet_id |
String |
No |
Network ID of the subnet.
|
offset |
Integer |
No |
Index offset. If offset is set to N, the resource query starts from the N+1 data entry. The default value is 0, indicating that the query starts from the first data entry. The value cannot be a negative number. |
limit |
Integer |
No |
Number of records to be queried. The default value is 100. The value cannot be a negative number. The minimum value is 1 and the maximum value is 100. |
tags |
String |
No |
Queries based on the instance tag keys and values.
To query instances with multiple tag keys and values, separate key-value pairs with commas (,). A maximum of 20 key-value pairs are supported. |
charge_mode |
String |
No |
Billing mode. Value:
|
Request Parameters
None
Response Parameters
Name |
Type |
Description |
---|---|---|
instances |
Array of objects |
Instance information. For details, see Table 3. |
total_count |
Integer |
Total number of records. |
Name |
Type |
Description |
---|---|---|
id |
String |
Instance ID. |
name |
String |
Instance name. |
status |
String |
Instance status. Value:
|
private_ips |
List<String> |
Private IP address list. The value is an empty string until ECSs where CNs of distributed instances are deployed or ECSs where DNs of primary/standby instances are deployed are created. |
public_ips |
List<String> |
EIPs bound to the instance. This parameter cannot be left blank after an EIP is bound. |
port |
Integer |
Database port number. The GaussDB database port is from 1024 to 39998 (excluding the following which are occupied by the system and cannot be used: 2378, 2379, 2380, 4999, 5000, 5999, 6000, 6001, 8097, 8098, 20049, 20050, 21731, and 21732). |
type |
String |
Instance type. The value is case-sensitive.
|
ha |
Object |
Instance high availability. For details, see Table 4. |
replica_num |
Integer |
Number of replicas. |
region |
String |
Region where the instance is deployed. |
datastore |
Object |
Database information. For details, see Table 5. |
created |
String |
Creation time in the "yyyy-mm-dd hh:mm:ss timezone" format. timezone indicates the time zone. When the instance is being created, the value is the time when the creation request is delivered. After the instance is created, the value is the time when the creation is complete. |
updated |
String |
Update time. The format is the same as that of the created field. The value is empty when the instance is being created. After the instance is created, the value is not empty. |
db_user_name |
String |
Default username. |
vpc_id |
String |
VPC ID. |
subnet_id |
String |
Network ID of the subnet. |
security_group_id |
String |
Security group ID. |
flavor_ref |
String |
Specification code. To obtain its value, see the spec_code field in Querying Instance Specifications. |
flavor_info |
Object |
Flavor information. For details, see Table 6. |
volume |
Object |
Volume information. For details, see Table 7. |
switch_strategy |
String |
Database failover priority. The value can be Reliability or Availability, indicating that the reliability or availability is given priority during the failover, respectively. If no failover priority is selected during the creation, the failover priority is not displayed. |
backup_strategy |
Object |
Backup policy. For details, see Table 8. |
maintenance_window |
String |
Maintenance window in the UTC format. |
nodes |
Array of objects |
Instance node information. For details, see Table 9. |
disk_encryption_id |
String |
Disk encryption key ID. This parameter is displayed only when the instance disk is encrypted. |
enterprise_project_id |
String |
Enterprise project ID. If an instance does not belong to any enterprise project, the default value is 0. |
instance_mode |
String |
enterprise indicates enterprise edition, standard indicates the standard edition, and basic indicates the basic edition. |
time_zone |
String |
Time zone. |
charge_info |
Object |
Billing type, which can be pay-per-use or yearly/monthly. For details, see Table 10. |
tags |
Array of objects |
Tags. This parameter is not returned if there is no tag. For details, see Table 11. |
backup_used_space |
String |
Used backup space, in KB. |
disk_usage |
String |
Available disk usage of the instance. The value ranges from 0 to 1 and contains four decimal places. The returned value of this parameter is not a real-time value. The system updates data at 02:00 every day. It is not displayed for deleted instances. |
Name |
Type |
Description |
---|---|---|
consistency |
String |
Transaction consistency type. Value:
|
replication_mode |
String |
Replication mode for the standby node. The value cannot be empty. sync.
NOTE:
sync indicates synchronous replication. |
Name |
Type |
Description |
---|---|---|
type |
String |
DB engine. |
version |
String |
Major version of the database. The value is a two-digit number. |
complete_version |
String |
Minor version of the database. The value is a three-digit number. |
hotfix_versions |
String |
Hot patch version that has been upgraded. After the hot patch version is successfully upgraded, the value of this parameter cannot be empty. |
target_version |
String |
Target version that the database is being upgraded to. |
hotfix_finished_times |
Array of strings |
List of time when the hot patch installation is complete. The time when the hot patch installation is complete is expressed in the "yyyy-mm-dd hh:mm:ss timezone" format. timezone indicates the time zone. |
Name |
Type |
Description |
---|---|---|
vcpu |
Integer |
Number of vCPUs. |
mem |
Integer |
Memory size in GB. |
Name |
Type |
Description |
---|---|---|
type |
String |
Disk type. |
size |
Integer |
Disk size. |
Name |
Type |
Description |
---|---|---|
start_time |
String |
Backup time window. The creation of an automated backup will be triggered during the backup time window. The time is in the UTC format. |
keep_days |
Integer |
Number of days to retain the generated backup files. Value range: 1-732. |
Name |
Type |
Description |
---|---|---|
id |
String |
Node ID. |
name |
String |
Node name. |
role |
String |
Node type. Value:
|
status |
String |
Node status. |
availability_zone |
String |
AZ. |
private_ip |
String |
Private IP address of the node. For distributed instances, this parameter is valid only for CNs. For primary/standby instances, this parameter is valid for all nodes. The parameter value is returned after an ECS is created. |
public_ip |
String |
EIP that has been bound. For distributed instances, this parameter is valid only for CNs. For primary/standby instances, this parameter is valid for all nodes. The parameter value is returned after an ECS is created and an EIP is bound to a DB instance. |
component_names |
String |
Component information on the node (for example, cn_6001:60011). Separate information of multiple components with commas (,). |
Example Request
- Querying all instances
GET https://gaussdb-opengauss.ap-southeast-1.myhuaweicloud.com/v3.1/97b026aa9cc4417888c14c84a1ad9860/instances
- Querying instances based on search criteria
GET https://gaussdb-opengauss.ap-southeast-1.myhuaweicloud.com/v3.1/97b026aa9cc4417888c14c84a1ad9860/instances?id=ed7cc6166ec24360a5ed5c5c9c2ed726in01&name=hy&type=Ha&datastore_type=GaussDB&vpc_id=19e5d45d-70fd-4a91-87e9-b27e71c9891f&subnet_id=bd51fb45-2dcb-4296-8783-8623bfe89bb7&offset=0&limit=10&tags=rds001=001,rds002=002
Example Response
{
"instances": [
{
"id": "b331ed66cc3249f78bc20737308c01f4in14",
"status": "ACTIVE",
"name": "gauss-9e88",
"port": 8000,
"type": "Enterprise",
"ha": {
"consistency": "strong",
"replication_mode": "sync"
},
"region": "eu-de",
"datastore": {
"type": "GaussDB",
"version": "2.7",
"complete_version": "2.7.2",
"hotfix_versions": "2.7.2.1,2.7.2.2",
"target_version": "3.208.0",
"hotfix_finished_times": [
"2020-12-23 03:21:41 UTC",
"2020-12-23 03:22:41 UTC"
]
},
"created": "2021-01-15 01:46:40 UTC",
"updated": "2021-01-15 02:05:03 UTC",
"volume": {
"type": "ULTRAHIGH",
"size": 120
},
"nodes": [
{
"id": "02ebf757aaf94074855f49cc6e0e4712no14",
"name": "gauss-9e88_gaussdbv5cn_2",
"role": "master",
"status": "ACTIVE",
"availability_zone": "az2xahz",
"private_ip": "192.168.16.253",
"component_names": "cn_5001:"
},
{
"id": "0a87b8ecbfeb46aba1409cfc0f0d5c34no14",
"name": "gauss-9e88_gaussdbv5cn_0",
"role": "master",
"status": "ACTIVE",
"availability_zone": "az2xahz",
"private_ip": "192.168.28.81",
"component_names": "cn_5002:"
},
{
"id": "2d9fec1ab3834936b074d63acf48b1f2no14",
"name": "gauss-9e88_gaussdbv5dn3_2",
"role": "master",
"status": "ACTIVE",
"availability_zone": "az2xahz"
},
{
"id": "48bb08a2d635435891ac0caa1c0bf2e3no14",
"name": "gauss-9e88_gaussdbv5dn1_0",
"role": "master",
"status": "ACTIVE",
"availability_zone": "az2xahz"
},
{
"id": "5df830f652204827ada32f8bc28b107eno14",
"name": "gauss-9e88_gaussdbv5dn1_1",
"role": "slave",
"status": "ACTIVE",
"component_names": "dn_6002:60011",
"availability_zone": "az2xahz"
},
{
"id": "8a97a246cee841b38c5b47290d4c9c38no14",
"name": "gauss-9e88_gaussdbv5cn_1",
"role": "master",
"status": "ACTIVE",
"availability_zone": "az2xahz",
"private_ip": "192.168.27.52",
"component_names": "cn_5003:"
},
{
"id": "8c1a3f8eecca4d9e9974a868bb6dd942no14",
"name": "gauss-9e88_gaussdbv5dn2_0",
"role": "master",
"status": "ACTIVE",
"component_names": "dn_6004:60042",
"availability_zone": "az2xahz"
},
{
"id": "9bd0c80b8a684cc9bd7d99dd5adffb07no14",
"name": "gauss-9e88_gaussdbv5dn3_1",
"role": "slave",
"status": "ACTIVE",
"component_names": "dn_6005:60073",
"availability_zone": "az2xahz"
},
{
"id": "9e2a3cd541e249d4af5aa57c5d3a7f39no14",
"name": "gauss-9e88_gaussdbv5dn1_2",
"role": "slave",
"status": "ACTIVE",
"component_names": "dn_6006:60011",
"availability_zone": "az2xahz"
},
{
"id": "b046d28989ec4ae5a1a9ab20fe65f248no14",
"name": "gauss-9e88_gaussdbv5dn2_2",
"role": "slave",
"status": "ACTIVE",
"component_names": "dn_6007:60042",
"availability_zone": "az2xahz"
},
{
"id": "b614cc12fd3742dbb230245f88a7bf00no14",
"name": "gauss-9e88_gaussdbv5dn3_0",
"role": "slave",
"status": "ACTIVE",
"component_names": "dn_6008:60073",
"availability_zone": "az2xahz"
},
{
"id": "caba8e88c3c84ae58202f1f589490611no14",
"name": "gauss-9e88_gaussdbv5dn2_1",
"role": "slave",
"status": "ACTIVE",
"component_names": "dn_6009:60042",
"availability_zone": "az2xahz"
}
],
"private_ips": [
"192.168.16.253 / 192.168.28.81 / 192.168.27.52"
],
"replica_num": 3,
"db_user_name": "root",
"vpc_id": "5f84a5c4-2f93-41de-8359-d7acedb585cc",
"subnet_id": "300036af-a92f-4e9e-8e9f-7d20e7878b05",
"security_group_id": "2dcfd40a-8f32-46b8-8a47-6cfab5eba163",
"flavor_ref": "gaussdb.opengauss.ee.dn.m6.large.8.in",
"flavor_info": {
"vcpu": 2,
"mem": 16
},
"switch_strategy": "Reliability",
"charge_info": {
"charge_mode": "postPaid"
},
"backup_strategy": {
"start_time": "19:00-20:00",
"keep_days": 7
},
"maintenance_window": "18:00-22:00",
"disk_encryption_id": "24ae42b5-4009-4ea2-b66a-0b211e424dab",
"enterprise_project_id": "6e76681b-a2f5-4c5f-97c5-ba4fd3c0dfb2",
"time_zone": "UTC+08:00",
"instance_mode":"enterprise",
"disk_usage": "0.9890",
"backup_used_space": "37846"
},
{
"id": "226b4afcfcc84c86bf1b9cb345d3b00fin14",
"status": "ACTIVE",
"name": "UTS-gauss-ad53-2C3D",
"port": 8000,
"type": "Enterprise",
"ha": {
"consistency": "strong",
"replication_mode": "sync"
},
"region": "cn-xianhz-1",
"datastore": {
"type": "GaussDB",
"version": "2.7",
"complete_version": "2.7.2",
"hotfix_versions": "2.7.2.1,2.7.2.2",
"target_version": "3.208.0",
"hotfix_finished_times": [
"2020-12-23 03:21:41 UTC",
"2020-12-23 03:22:41 UTC"
]
},
"created": "2021-01-08 09:18:27 UTC",
"updated": "2021-01-14 13:25:03 UTC",
"volume": {
"type": "ULTRAHIGH",
"size": 120
},
"nodes": [
{
"id": "07538a1def584cee99e2a5685eeab36ano14",
"name": "UTS-gauss-ad53-2C3D_gaussdbv5dn3_1",
"role": "slave",
"status": "ACTIVE",
"availability_zone": "az2xahz"
},
{
"id": "21f41baba1e2454f82331b7cb5aeabe5no14",
"name": "UTS-gauss-ad53-2C3D_gaussdbv5dn1_2",
"role": "master",
"status": "ACTIVE",
"component_names": "dn_6008:60042",
"availability_zone": "az2xahz"
},
{
"id": "2909771a3b3e4e3998f9388e77d22391no14",
"name": "UTS-gauss-ad53-2C3D_gaussdbv5dn1_0",
"role": "slave",
"status": "ACTIVE",
"component_names": "dn_6007:60011",
"availability_zone": "az2xahz"
},
{
"id": "2bd9a90a5da242a6b0743a7f597f6106no14",
"name": "UTS-gauss-ad53-2C3D_gaussdbv5dn2_2",
"role": "master",
"status": "ACTIVE",
"component_names": "dn_6006:60042",
"availability_zone": "az2xahz"
},
{
"id": "77092f1dadb74d3ea13d28269cdd3590no14",
"name": "UTS-gauss-ad53-2C3D_gaussdbv5dn3_2",
"role": "master",
"status": "ACTIVE",
"component_names": "dn_6005:60072",
"availability_zone": "az2xahz"
},
{
"id": "a46bfaa6d5a24355a60fce7432b964cano14",
"name": "UTS-gauss-ad53-2C3D_gaussdbv5dn3_0",
"role": "slave",
"status": "ACTIVE",
"component_names": "dn_6004:60072",
"availability_zone": "az2xahz"
},
{
"id": "aa5277736f3844e2a7adeb9de529e2b1no14",
"name": "UTS-gauss-ad53-2C3D_gaussdbv5dn2_1",
"role": "slave",
"status": "ACTIVE",
"component_names": "dn_6003:60042",
"availability_zone": "az2xahz"
},
{
"id": "b1d798e4ea7344dfa95032984bc6cfd7no14",
"name": "UTS-gauss-ad53-2C3D_gaussdbv5cn_1",
"role": "master",
"status": "ACTIVE",
"availability_zone": "az2xahz",
"private_ip": "192.168.29.231",
"component_names": "cn_5002:"
},
{
"id": "b9a46540186f4c0781eabaa2a79594cbno14",
"name": "UTS-gauss-ad53-2C3D_gaussdbv5dn1_1",
"role": "slave",
"status": "ACTIVE",
"component_names": "dn_6002:60011",
"availability_zone": "az2xahz"
},
{
"id": "d283813030364060ab64371d50294977no14",
"name": "UTS-gauss-ad53-2C3D_gaussdbv5dn2_0",
"role": "slave",
"status": "ACTIVE",
"component_names": "dn_6001:60042",
"availability_zone": "az2xahz"
},
{
"id": "eb7bce29b2284cd290405eaddc1b1a1eno14",
"name": "UTS-gauss-ad53-2C3D_gaussdbv5cn_0",
"role": "master",
"status": "FAILED",
"availability_zone": "az2xahz",
"private_ip": "192.168.30.44",
"component_names": "cn_5001:",
"public_ip": "10.154.217.248"
}
],
"private_ips": [
"192.168.29.231 / 192.168.30.44"
],
"public_ips": [
"10.154.217.248"
],
"replica_num": 3,
"db_user_name": "root",
"vpc_id": "5f84a5c4-2f93-41de-8359-d7acedb585cc",
"subnet_id": "300036af-a92f-4e9e-8e9f-7d20e7878b05",
"security_group_id": "2dcfd40a-8f32-46b8-8a47-6cfab5eba163",
"flavor_ref": "gaussdb.opengauss.ee.dn.m6.large.8.in",
"flavor_info": {
"vcpu": 2,
"mem": 16
},
"switch_strategy": "Reliability",
"charge_info": {
"charge_mode": "postPaid"
},
"backup_strategy": {
"start_time": "18:00-19:00",
"keep_days": 7
},
"maintenance_window": "18:00-22:00",
"enterprise_project_id": "0",
"time_zone": "UTC+08:00",
"instance_mode":"enterprise",
"disk_usage": "1.0000",
"backup_used_space": "55824"
}
],
"total_count": 2
}
Status Code
- Normal
- Abnormal
For details, see Status Codes.
Error Code
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