Obtaining a DB Instance List

Function

This API is used to obtain a DB instance list.

URI

• URI format

  PATH: /rds/v1/{project_id}/instances

  Method: GET

• Parameter description

  Table 1 Parameter description

  Name	Mandatory	Description
  project_id	Yes	Specifies the project ID of a tenant in a region.

Request

None

Normal Response

• Parameter description

  Table 2 Parameter description

  Name	Type	Description
  instances	List data structure. For details, see Table 3.	Indicates the DB instance information.

  Table 3 instances field data structure description

  Name	Type	Description
  id	String	Indicates the primary node ID of the DB instance. NOTE: This field is not the DB instance ID. You are advised to use API v3 and the DB instance ID to perform related operations.
  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 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.
  name	String	Indicates the created DB instance name.
  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. NOTE: The value is empty when the DB instance is being created. After the DB instance is created, the value is not empty.
  hostname	String	Indicates the DB instance connection address. It is a blank string until an ECS is created.
  type	String	Indicates the DB instance type, which can be master, slave, or readreplica.
  region	String	Indicates the region where the DB instance is deployed.
  updated	String	Indicates the updated time, which is the same as created in the format. NOTE: The value is empty when the DB instance is being created. After the DB instance is created, the value is not empty.
  availabilityZone	String	Indicates the AZ ID.
  vpc	String	Indicates the VPC ID.
  nics	Dictionary data structure. For details, see Table 4.	Indicates the nics information.
  securityGroup	Dictionary data structure. For details, see Table 5.	Indicates the security group information.
  flavor	Dictionary data structure. For details, see Table 6.	Indicates the specification information.
  volume	Dictionary data structure. For details, see Table 7.	Indicates the volume information.
  dataStoreInfo	Dictionary data structure. For details, see Table 8.	Indicates the database information.
  dbPort	Int	Indicates the database port number.
  backupStrategy	Dictionary data structure. For details, see Table 9.	Indicates the advanced backup policy.
  slaveId	String	Returned only when you create primary/standby DB instances.
  ha	Dictionary data structure. For details, see Table 10.	Indicates the primary/standby DB instance information. Returned only when you obtain a primary/standby DB instance list.
  replicaOf	String	Returned only when you obtain the read replica information.

  Table 4 nics field data structure description

  Name	Type	Description
  subnetId	String	Indicates the network ID of the subnet.

  Table 5 securityGroup field data structure description

  Name	Type	Description
  id	String	Indicates the security group ID.

  Table 6 flavor field data structure description

  Name	Type	Description
  id	String	Indicates the specification ID.

  Table 7 volume field data structure description

  Name	Type	Description
  type	String	Indicates the volume type.
  size	Int	Indicates the volume size.

  Table 8 dataStoreInfo field data structure description

  Name	Type	Description
  type	String	Indicates the DB engine.
  version	String	Indicates the database version.

  Table 9 backupStrategy field data structure description

  Name	Type	Description
  startTime	String	Indicates the backup start time that has been set. The backup task will be triggered within one hour after the backup start time. The time is in the UTC format.
  keepDays	Int	Indicates the number of days to retain the generated backup files. The value range is from 0 to 732. If this parameter is 0, the automated backup policy is not set. To extend the retention period, contact customer service. Automated backups can be retained for up to 2562 days.

  Table 10 ha field data structure description

  Name	Type	Description
  replicationMode	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.

Abnormal Response

For details, see Abnormal Request Results.