Querying Details of DB Instances in Batches

Function

This API is used to query details of DB instances in batches. Before calling this API:

Learn how to authorize and authenticate it.
Obtain the required region and endpoint.

URI

GET /v3.1/{project_id}/instances/details

**Table 1** URI parameter
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.

**Table 2** Query parameter
Parameter	Mandatory	Type	Description
instance_ids	Yes	String	Instance ID, which is compliant with the UUID format. A maximum of 20 instance IDs can be entered at a time. Separate them with commas (,).

Request Parameters

**Table 3** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	User token. It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the token value.
X-Language	No	String	Request language type. The default value is en-us. Values: en-us zh-cn

Response Parameters

Status code: 200

**Table 4** Response body parameter
Parameter	Type	Description
instances	Array of MysqlInstanceInfoDetailUnifyStatus objects	Instance details.

**Table 5** MysqlInstanceInfoDetailUnifyStatus
Parameter	Type	Description
id	String	Instance ID, which is compliant with the UUID format.
name	String	Instance name.
project_id	String	Project ID of a tenant in a region.
status	String	Instance status. Values: creating: The DB instance is being created. normal: The instance is running properly. abnormal: The instance is abnormal. createfail: The instance failed to be created.
port	String	Database port.
alias	String	Instance description.
type	String	Instance type. The value is Cluster.
charge_info	MysqlInstanceChargeInfo object	Billing information, which is yearly/monthly or pay-per-use (default setting).
node_count	Integer	Number of nodes.
datastore	MysqlDatastoreWithKernelVersion object	Database information.
backup_used_space	Double	Used backup space in GB.
created	String	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, if the time zone offset is one hour, the value of Z is +0100.
updated	String	Update time. The format is the same as that of the created field.
private_write_ips	Array of strings	Private IP address list.
private_dns_names	Array of strings	Private domain name list. After a DB instance is created, you need to manually apply for a private domain name, or the private domain name is left blank.
public_ips	String	EIP list.
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.
configuration_id	String	ID of the parameter template used for creating a DB instance or ID of the latest parameter template that is applied to a DB instance.
backup_strategy	MysqlBackupStrategy object	Automated backup policy.
nodes	Array of MysqlInstanceNodeInfo objects	Node information.
enterprise_project_id	String	Enterprise project ID.
time_zone	String	Time zone.
az_mode	String	AZ type. Values: single: single AZ multi: multiple AZs
master_az_code	String	Primary AZ.
maintenance_window	String	Maintenance window in the UTC format.
tags	Array of MysqlTags objects	Instance tags.
dedicated_resource_id	String	Dedicated resource pool ID. This parameter is returned only when the instance belongs to a dedicated resource pool.
proxies	Array of MysqlProxyInfo objects	Proxy information.
tde_info	MysqlTdeInfo object	TDE configuration. The AES 256 and SM4 algorithms are supported. TDE is in the open beta test (OBT) phase. To use it, submit a service ticket.

**Table 6** MysqlInstanceChargeInfo
Parameter	Type	Description
charge_mode	String	Billing mode.
order_id	String	Order ID. This parameter is returned only for yearly/monthly instances.

**Table 7** MysqlDatastoreWithKernelVersion
Parameter	Type	Description
type	String	DB engine. Currently, only gaussdb-mysql is supported.
version	String	DB version.
kernel_version	String	Database kernel version.

**Table 8** MysqlBackupStrategy
Parameter	Type	Description
start_time	String	Automated backup start time. The creation of an automated backup will be triggered within one hour after the time specified by this parameter. The value cannot be empty. It must be a valid value in the "hh:mm-HH:MM" format. The current time is in the UTC format. The HH value must be 1 greater than the hh value. The values of mm and MM must be the same and must be set to 00.
keep_days	String	Automated backup retention days. Value range: 1–732.

**Table 9** MysqlInstanceNodeInfo
Parameter	Type	Description
id	String	Instance ID, which is compliant with the UUID format.
name	String	Node name.
type	String	Node type. Values: master: primary node slave: read replica
status	String	Node status.
port	Integer	Database port.
private_read_ips	Array of strings	Private IP addresses for read of nodes.
volume	MysqlInstanceNodeVolumeInfo object	Storage disk information.
az_code	String	AZ.
region_code	String	Region where the instance is located.
created	String	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, if the time zone offset is one hour, the value of Z is +0100.
updated	String	Update time. The format is the same as that of the created field.
flavor_id	String	Specification ID.
flavor_ref	String	Specification code.
max_connections	String	Maximum number of connections.
vcpus	String	Number of vCPUs.
ram	String	Memory size in GB.
need_restart	Boolean	Whether to reboot the instance for the parameter modifications to take effect.
priority	Integer	Failover priority.

**Table 10** MysqlInstanceNodeVolumeInfo
Parameter	Type	Description
type	String	Disk type.
used	String	Used disk size in GB.
size	Long	Disk size of the yearly/monthly instance in GB.

**Table 11** MysqlTags
Parameter	Type	Description
key	String	Tag key. The value can contain a maximum of 36 Unicode characters. The value cannot be an empty string, a space, or left blank. Only uppercase letters, lowercase letters, digits, hyphens (-), and underscores (_) are allowed.
value	String	Tag value. It can contain up to 43 Unicode characters and can be an empty string. Only uppercase letters, lowercase letters, digits, periods (.), hyphens (-), and underscores (_) are allowed.

**Table 12** MysqlProxyInfo
Parameter	Type	Description
pool_id	String	Proxy instance ID.
name	String	Proxy instance name.
address	String	Proxy read/write splitting address.

**Table 13** MysqlTdeInfo
Parameter	Type	Description
enable_tde	Boolean	Whether to enable TDE.
encryption_type	String	TDE algorithm. The AES 256 and SM4 algorithms are supported.

Status code: 400

**Table 14** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.

Status code: 500

**Table 15** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.

Example Request

Querying details of DB instances in batches

GET https://{endpoint}/v3.1/97b026aa9cc4417888c14c84a1ad9860/instances/details?instance_ids=11684a0e59e94bceba7880d58cfb07b5in07

Example Response

Status code: 200

Success.

{
  "instances" : [ {
    "id" : "11684a0e59e94bceba7880d58cfb07b5in07",
    "name" : "gaussdb-mysql-instance01",
    "alias" : "",
    "status" : "normal",
    "project_id" : "3cedfc54-b105-4652-a4e0-847b11576628",
    "enterprise_project_id" : 0,
    "type" : "Cluster",
    "charge_info" : {
      "charge_mode" : "postPaid",
      "order_id" : ""
    },
    "node_count" : 2,
    "datastore" : {
      "type" : "gaussdb-mysql",
      "version" : "8.0",
      "kernel_version" : "2.0.29.1"
    },
    "created" : "2022-07-14T16:26:58+0800",
    "updated" : "2022-07-18T14:20:33+0800",
    "public_ips" : "10.*.*.*",
    "private_write_ips" : [ "192.*.*.*" ],
    "private_dns_names" : [ "11684a0e59e94bceba7880d58cfb07b5in07.internal.cn-xianhz-1.gaussdbformysql.myhuaweicloud.com" ],
    "db_user_name" : "root",
    "port" : 3306,
    "vpc_id" : "3cedfc54-b105-4652-a4e0-847b11576b58",
    "subnet_id" : "c1cfa53c-65d3-431e-8552-326bf310c7ad",
    "security_group_id" : "fc577a1a-f202-424a-977f-24faec3fdd55",
    "backup_strategy" : {
      "start_time" : "19:00-20:00",
      "keep_days" : 7
    },
    "nodes" : [ {
      "id" : "799a0f2fa49a4151bf9f7063c1fbba36no07",
      "name" : "gauss-d616-lb07_node01",
      "type" : "master",
      "status" : "normal",
      "port" : 3306,
      "private_read_ips" : [ "192.*.*.*" ],
      "volume" : {
        "type" : "POOL",
        "used" : 0.07
      },
      "az_code" : "az1xahz",
      "region_code" : "region-1",
      "flavor_id" : "3169caaf-6c2f-41d5-aadd-c8fc3d83597e",
      "flavor_ref" : "gaussdb.mysql.xlarge.arm.4",
      "max_connections" : 1500,
      "vcpus" : 1,
      "ram" : 4,
      "need_restart" : false,
      "priority" : 1,
      "created" : "2022-07-14T16:26:58+0800",
      "updated" : "2022-07-18T09:24:18+0800"
    }, {
      "id" : "799a0f2fa49a4151bf9f7063c1fbba35no07",
      "name" : "gauss-d616-lb07_node02",
      "type" : "slave",
      "status" : "normal",
      "port" : 3306,
      "private_read_ips" : [ "192.*.*.*" ],
      "volume" : {
        "type" : "POOL",
        "used" : 0.07
      },
      "az_code" : "az1",
      "region_code" : "region-1",
      "flavor_id" : "3169caaf-6c2f-41d5-aadd-c8fc3d83597e",
      "flavor_ref" : "gaussdb.mysql.xlarge.arm.4",
      "max_connections" : 1500,
      "vcpus" : 1,
      "ram" : 4,
      "need_restart" : false,
      "priority" : 1,
      "created" : "2022-07-14T16:26:58+0800",
      "updated" : "2022-07-18T09:36:18+0800"
    } ],
    "time_zone" : "UTC+08:00",
    "backup_used_space" : 0.24,
    "az_mode" : "single",
    "master_az_code" : "az1",
    "maintenance_window" : "18:00-22:00",
    "tags" : [ ],
    "configuration_id" : "53570e0de54e40c5a15f331aa5sd2176pr07",
    "dedicated_resource_id" : "",
    "proxies" : [ {
      "pool_id" : "dab1cfc5150c4d1ca0e8c6596bfc0d8cpo01",
      "address" : "192.*.*.*",
      "name" : "proxy-name"
    } ]
  } ]
}