Help Center > > API Reference> API v3 (Recommended)> DB Instance Management> Querying Details About DB Instances

Querying Details About DB Instances

Updated at: Apr 22, 2020 GMT+08:00

Function

This API is used to query DB instances according to search criteria.

URI

  • URI format

    GET https://{Endpoint}/v3/{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}&tags={key}={value}

  • Example
    • Querying all DB instances

      https://rds.ap-southeast-1.myhuaweicloud.com/v3/97b026aa9cc4417888c14c84a1ad9860/instances

    • Querying DB instances based on specified conditions

      https://rds.ap-southeast-1.myhuaweicloud.com/v3/97b026aa9cc4417888c14c84a1ad9860/instances?id=ed7cc6166ec24360a5ed5c5c9c2ed726in01&name=hy&type=Ha&datastore_type=MySQL&vpc_id=19e5d45d-70fd-4a91-87e9-b27e71c9891f&subnet_id=bd51fb45-2dcb-4296-8783-8623bfe89bb7&offset=0&limit=10&tags=rds001=001,rds002=002

  • Parameter description
    Table 1 Parameter description

    Name

    Type

    Mandatory

    Description

    project_id

    String

    Yes

    Specifies the 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

    Specifies the DB 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

    Specifies the 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

    Specifies the instance type based query. The value is Single, Ha, or Replica, which correspond to single instance, primary/standby instances, and read replica, respectively.

    datastore_type

    String

    No

    Specifies the database type. Its value can be any of the following and is case-sensitive:

    • MySQL
    • PostgreSQL
    • SQLServer

    vpc_id

    String

    No

    Specifies the VPC ID.

    • Method 1: Log in to VPC console and view the VPC ID in the VPC details.
    • Method 2: See the "Querying VPCs" section in the Virtual Private Cloud API Reference.

    subnet_id

    String

    No

    Specifies the network ID of the subnet.

    • Method 1: Log in to VPC console and click the target subnet on the Subnets page. You can view the network ID on the displayed page.
    • Method 2: See the "Querying Subnets" section in the Virtual Private Cloud API Reference.

    offset

    Integer

    No

    Specifies the index position. 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 must be a positive number.

    limit

    Integer

    No

    Specifies the 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

    Array of objects

    No

    Specifies queries based on the instance tag keys and values.

    • {key} indicates the tag key. It must be unique and cannot be empty.
    • {value} indicates the tag value, which can be left empty.

    To query instances with multiple tag keys and values, separate key-value pairs with commas (,). A maximum of 10 key-value pairs are supported.

    For details, see Table 2.

    Table 2 tags field data structure description

    Name

    Type

    Mandatory

    Description

    key

    String

    Yes

    Specifies the tag key, which contains a maximum of 127 Unicode characters. key cannot be an empty string, a space, or left blank. Before using key, delete single-byte character (SBC) spaces before and after the value. The value cannot contain the following special characters: +/?#&=,%

    value

    String

    No

    Specifies the tag value, which contains a maximum of 255 Unicode characters. Before using value, delete SBC spaces before and after the value. The value cannot contain the following special characters: +/?#&=,%

    If the value is empty, it indicates any_value (querying any value).

Request

None

Response

  • Normal response
    Table 3 Parameter description

    Name

    Type

    Description

    instances

    Array of objects

    Indicates the DB instance information.

    For details, see Table 4.

    total_count

    Integer

    Indicates the total number of resources.

    Table 4 instances field data structure description

    Name

    Type

    Description

    id

    String

    Indicates the DB instance ID.

    name

    String

    Indicates the created DB instance name.

    status

    String

    Indicates the DB instance status.

    Value:

    If the value is BUILD, the instance is being created.

    If the value is ACTIVE, the instance is normal.

    If the value is FAILED, the instance is abnormal.

    If the value is FROZEN, the instance is frozen.

    If the value is MODIFYING, the instance is being scaled up.

    If the value is REBOOTING, the instance is being rebooted.

    If the value is RESTORING, the instance is being restored.

    If the value is MODIFYING INSTANCE TYPE, the instance is changing from primary to standby.

    If the value is SWITCHOVER, the primary/standby switchover is being performed.

    If the value is MIGRATING, the instance is being migrated.

    If the value is BACKING UP, the instance is being backed up.

    If the value is MODIFYING DATABASE PORT, the database port is being changed.

    If the value is STORAGE FULL, the instance storage space is full.

    private_ips

    List<String>

    Indicates the private IP address list. It is a blank string until an ECS is created.

    public_ips

    List<String>

    Indicates the public IP address list.

    port

    Integer

    Indicates the database port number.

    • The MySQL database port ranges from 1024 to 65535 (excluding 12017 and 33071, which are occupied by the RDS system and cannot be used).
    • The PostgreSQL database port ranges from 2100 to 9500.
    • The Microsoft SQL Server database port is 1433 or ranges from 2100 to 9500 (excluding 5355 and 5985). For Microsoft SQL Server 2017 Enterprise, Standard, and Web editions, the database port is 1433 or ranges from 2100 to 9500, excluding 5050, 5353, and 5986.

    If this parameter is not set, the default value is as follows:

    • For MySQL, the default value is 3306.
    • For PostgreSQL, the default value is 5432.
    • For Microsoft SQL Server, the default value is 1433.

    type

    String

    The value is Single, Ha, or Replica, which correspond to single instance, primary/standby instances, and read replica, respectively.

    ha

    Object

    Indicates the primary/standby DB instance information. Returned only when you obtain a primary/standby DB instance list.

    For details, see Table 5.

    region

    String

    Indicates the region where the DB instance is deployed.

    datastore

    Object

    Indicates the database information.

    For details, see Table 6.

    created

    String

    Indicates the creation time in the "yyyy-mm-ddThh:mm:ssZ" format.

    T is the separator between the calendar and the hourly notation of time. Z indicates the time zone offset. For example, in the Beijing time zone, the time zone offset is shown as +0800.

    The value is empty when the DB instance is being created. After the DB instance is created, the value is not empty.

    updated

    String

    Indicates the update time. The format is the same as that of the created field.

    The value is empty when the DB instance is being created. After the DB instance is created, the value is not empty.

    db_user_name

    String

    Indicates the default username.

    vpc_id

    String

    Indicates the VPC ID.

    subnet_id

    String

    Indicates the network ID of the subnet.

    security_group_id

    String

    Indicates the security group ID.

    flavor_ref

    String

    Indicates the specification code.

    volume

    Object

    Indicates the volume information.

    For details, see Table 7.

    switch_strategy

    String

    Indicates the database switchover policy. The value can be reliability or availability, indicating the reliability first and availability first, respectively.

    backup_strategy

    Object

    Indicates the backup policy.

    For details, see Table 8.

    maintenance_window

    String

    Indicates the start time of the maintenance time window in the UTC format.

    nodes

    Array of objects

    Indicates the primary/standby DB instance information.

    For details, see Table 9.

    related_instance

    Array of objects

    Indicates the list of associated DB instances.

    For details, see Table 10.

    disk_encryption_id

    String

    Indicates the disk encryption key ID.

    enterprise_project_id

    String

    Indicates the enterprise project ID.

    time_zone

    String

    Indicates the time zone.

    charge_info

    Object

    Indicates the billing information, which is yearly/monthly or pay-per-use. By default, pay-per-use is used.

    For details, see Table 11.

    tags

    Array of objects

    Indicates the tag list. If there is no tag in the list, an empty array is returned.

    For details, see Table 12.

    backup_used_space

    Double

    Indicates the backup space usage in GB.

    This field is returned only when you query information about a specified SQL Server DB instance.

    storage_used_space

    Double

    Indicates the storage space usage in GB.

    This field is returned only when you query information about a specified SQL Server DB instance.

    Table 5 ha field data structure description

    Name

    Type

    Description

    replication_mode

    String

    Indicates the replication mode for the standby DB instance.

    The value cannot be empty.

    • For MySQL, the value is async or semisync.
    • For PostgreSQL, the value is async or sync.
    • For Microsoft SQL Server, the value is sync.
    NOTE:
    • async indicates the asynchronous replication mode.
    • semisync indicates the semi-synchronous replication mode.
    • sync indicates the synchronous replication mode.
    Table 6 datastore field data structure description

    Name

    Type

    Description

    type

    String

    Indicates the DB engine.

    version

    String

    Indicates the database version.

    Table 7 volume field data structure description

    Name

    Type

    Description

    type

    String

    Indicates the volume type.

    size

    Integer

    Indicates the volume size.

    Table 8 backup_strategy field data structure description

    Name

    Type

    Description

    start_time

    String

    Indicates the backup time window. Automated backups will be triggered during the backup time window.

    The time is in the UTC format.

    keep_days

    Integer

    Indicates the number of days to retain the generated backup files.

    The value range is from 0 to 732. If the value is 0, the automated backup policy is not configured or has been disabled. To extend the retention period, contact customer service. Automated backups can be retained for up to 2562 days.

    Table 9 nodes field data structure description

    Name

    Type

    Description

    id

    String

    Indicates the node ID.

    name

    String

    Indicates the node name.

    role

    String

    Indicates the node type. The value can be master, slave, or readreplica, indicating the primary node, standby node, and read replica node, respectively.

    status

    String

    Indicates the node status.

    availability_zone

    String

    Indicates the AZ.

    Table 10 related_instance field data structure description

    Name

    Type

    Description

    id

    String

    Indicates the associated DB instance ID.

    type

    String

    Indicates the associated DB instance type.

    • replica_of: indicates the primary DB instance.
    • replica: indicates read replicas.
    Table 11 chargeInfo field data structure description

    Name

    Mandatory

    Type

    Description

    charge_mode

    Yes

    String

    Indicates the billing mode.

    Valid value:

    • prePaid: indicates the yearly/monthly billing mode.
    • postPaid: indicates the pay-per-use billing mode.
    Table 12 tags field data structure description

    Name

    Type

    Description

    key

    String

    Indicates the tag key.

    value

    String

    Indicates the tag value.

    The values of region and availability_zone are used as examples.

  • Example normal response

    Query DB instances based on specified conditions.

    {
    	"instances": [{
    	"id": "ed7cc6166ec24360a5ed5c5c9c2ed726in01",
    	"status": "ACTIVE",
    	"name": "mysql-0820-022709-01",
    	"port": 3306,
    	"type": "Single",
    	"region": "aaa",
    	"datastore": {
    		"type": "MySQL",
    		"version": "5.7"
    	},
    	"created": "2018-08-20T02:33:49+0800",
    	"updated": "2018-08-20T02:33:50+0800",
    	"volume": {
    		"type": "ULTRAHIGH",
    		"size": 100
    	},
    	"nodes": [{
    		"id": "06f1c2ad57604ae89e153e4d27f4e4b8no01",
    		"name": "mysql-0820-022709-01_node0",
    		"role": "master",
    		"status": "ACTIVE",
    		"availability_zone": "bbb"
    	}],
    	"private_ips": ["192.168.0.142"],
    	"public_ips": ["10.154.219.187", "10.154.219.186"],
    	"db_user_name": "root",
    	"vpc_id": "b21630c1-e7d3-450d-907d-39ef5f445ae7",
    	"subnet_id": "45557a98-9e17-4600-8aec-999150bc4eef",
    	"security_group_id": "38815c5c-482b-450a-80b6-0a301f2afd97",
    	"flavor_ref": "rds.mysql.s1.large",
    	"switch_strategy": "",
            "charge_info": {
                "charge_mode": "postPaid"
            },
    	"backup_strategy": {
    		"start_time": "19:00-20:00",
    		"keep_days": 7
    	},
    	"maintenance_window": "02:00-06:00",
    	"related_instance": [],
    	"disk_encryption_id": "",
    	"enterprise_project_id": "0",
    	"time_zone": "",
            "tags" [
                {
                    "key": "rds001",
                    "value": "001"
                },
                {
                    "key": "rds002",
                    "value": "002"
                }
             ]
    }], "total_count": 1
    }
  • Query all DB instances.
    {
    	"instances": [{
    		"id": "ed7cc6166ec24360a5ed5c5c9c2ed726in01",
    		"status": "ACTIVE",
    		"name": "mysql-0820-022709-01",
    		"port": 3306,
    		"type": "Single",
    		"region": "eu-de",
    		"datastore": {
    			"type": "MySQL",
    			"version": "5.7"
    		},
    		"created": "2018-08-20T02:33:49+0800",
    		"updated": "2018-08-20T02:33:50+0800",
    		"volume": {
    			"type": "ULTRAHIGH",
    			"size": 100
    		},
    		"nodes": [{
    			"id": "06f1c2ad57604ae89e153e4d27f4e4b8no01",
    			"name": "mysql-0820-022709-01_node0",
    			"role": "master",
    			"status": "ACTIVE",
    			"availability_zone": "eu-de-01"
    		}],
    		"private_ips": ["192.168.0.142"],
    		"public_ips": ["10.154.219.187", "10.154.219.186"],
    		"db_user_name": "root",
    		"vpc_id": "b21630c1-e7d3-450d-907d-39ef5f445ae7",
    		"subnet_id": "45557a98-9e17-4600-8aec-999150bc4eef",
    		"security_group_id": "38815c5c-482b-450a-80b6-0a301f2afd97",
    		"flavor_ref": "rds.mysql.s1.large",
    		"switch_strategy": "",
    		"backup_strategy": {
    			"start_time": "19:00-20:00",
    			"keep_days": 7
    		},
    		"maintenance_window": "02:00-06:00",
    		"related_instance": [],
    		"disk_encryption_id": "",
    		"time_zone": "",
                    "tags": [
                        {
                            "key": "rds001",
                            "value": "001"
                        },
                        {
                            "key": "rds002",
                            "value": "002"
                        }
                     ]
    	}, {
    		"id": "ed7cc6166ec24360a5ed5c5c9c2ed726in02",
    		"status": "ACTIVE",
    		"name": "mysql-0820-022709-02",
    		"port": 3306,
    		"type": "Single",
    		"region": "eu-de",
    		"datastore": {
    			"type": "MySQL",
    			"version": "5.6"
    		},
    		"created": "2019-08-20T02:33:49+0800",
    		"updated": "2019-08-20T02:33:50+0800",
    		"volume": {
    			"type": "ULTRAHIGH",
    			"size": 100
    		},
    		"nodes": [{
    			"id": "06f1c2ad57604ae89e153e4d27f4e4b8no01",
    			"name": "mysql-0820-022709-01_node0",
    			"role": "master",
    			"status": "ACTIVE",
    			"availability_zone": "eu-de-01"
    		}],
    		"private_ips": ["192.168.0.142"],
    		"public_ips": ["10.154.219.187", "10.154.219.186"],
    		"db_user_name": "root",
    		"vpc_id": "b21630c1-e7d3-450d-907d-39ef5f445ae7",
    		"subnet_id": "45557a98-9e17-4600-8aec-999150bc4eef",
    		"security_group_id": "38815c5c-482b-450a-80b6-0a301f2afd97",
    		"flavor_ref": "rds.mysql.s1.large",
    		"switch_strategy": "",
    		"backup_strategy": {
    			"start_time": "19:00-20:00",
    			"keep_days": 7
    		},
    		"maintenance_window": "02:00-06:00",
    		"related_instance": [],
    		"disk_encryption_id": "",
    		"time_zone": "",
                    "tags": [
                        {
                            "key": "rds001",
                            "value": "001"
                        },
                        {
                            "key": "rds002",
                            "value": "002"
                        }
                     ]
    	}],
    	"total_count": 2
    }

  • Abnormal Response

    For details, see Abnormal Request Results.

Status Code

For details, see Status Codes.

Error Code

For details, see Error Codes.

Did you find this page helpful?

Submit successfully!

Thank you for your feedback. Your feedback helps make our documentation better.

Failed to submit the feedback. Please try again later.

Which of the following issues have you encountered?







Please complete at least one feedback item.

Content most length 200 character

Content is empty.

OK Cancel