Querying Details of a DB Instance

project_id

Yes

String

Definition:

Project ID of a tenant in a region.

To obtain this value, see Obtaining a Project ID.

Constraints:

N/A

Range:

The value contains 32 characters. Only letters and digits are allowed.

Default value:

N/A

instance_id

Yes

String

Instance ID, which is compliant with the UUID format.

X-Auth-Token

Yes

String

Definition:

User token. To obtain this value, call the IAM API for obtaining a user token.

The value of X-Subject-Token in the response header is the token value.

Constraints:

N/A

Range:

N/A

Default value:

N/A

X-Language

No

String

Definition:

Request language type.

Constraints:

N/A

Range:

• en-us

• zh-cn

Default value:

en-us

instance

MysqlInstanceInfoDetailUnifyStatus object

Definition:

Instance information.

id

String

Definition:

Instance ID.

Range:

The value can contain 36 characters with a suffix of in07. Only letters and digits are allowed.

name

String

Definition:

Instance name.

Range:

N/A

project_id

String

Definition:

Project ID of a tenant in a region.

Range:

N/A

status

String

Definition:

Instance status.

Range:

• creating: The instance is being created.

• normal: The instance is normal.

• abnormal: The instance is abnormal.

• createfail: The instance failed to be created.

port

String

Definition:

Database port.

Range:

N/A

alias

String

Definition:

Instance description.

Range:

N/A

type

String

Definition:

Instance type.

Range:

Cluster

charge_info

MysqlInstanceChargeInfo object

Definition:

Billing information.

node_count

Integer

Definition:

Number of nodes.

Range:

N/A

datastore

MysqlDatastoreWithKernelVersion object

Definition:

Database information.

backup_used_space

Double

Definition:

Used backup space, in GB.

Range:

N/A

created

String

Definition:

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.

Range:

N/A

updated

String

Definition:

Update 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.

Range:

N/A

private_write_ips

Array of strings

Definition:

Private IP addresses for write of instances.

Range:

N/A

private_dns_names

Array of strings

Definition:

Private domain names of instances. After an instance is created, you need to manually apply for a private domain name, or the private domain name is left blank.

Range:

N/A

public_ips

String

Definition:

EIPs.

Range:

N/A

db_user_name

String

Definition:

Default username.

Range:

N/A

vpc_id

String

Definition:

VPC ID.

Range:

N/A

subnet_id

String

Definition:

Network ID of the subnet.

Range:

N/A

security_group_id

String

Definition:

Security group ID.

Range:

N/A

configuration_id

String

Definition:

ID of the parameter template used for creating an instance or ID of the latest parameter template that is applied to an instance.

Range:

N/A

backup_strategy

MysqlBackupStrategy object

Definition:

Automated backup policy.

Constraints:

N/A

nodes

Array of MysqlInstanceNodeInfo objects

Definition:

Node information.

enterprise_project_id

String

Definition:

Enterprise project ID.

Range:

N/A

time_zone

String

Definition:

Time zone.

Range:

N/A

az_mode

String

Definition:

AZ type.

Range:

• single: single AZ

• multi: multiple AZs

master_az_code

String

Definition:

Primary AZ.

Range:

N/A

maintenance_window

String

Definition:

Maintenance window in the UTC format.

Range:

N/A

tags

Array of MysqlTags objects

Definition:

Instance tags.

Range:

N/A

proxies

Array of MysqlProxyInfo objects

Definition:

Proxy information.

charge_mode

String

Definition:

Billing mode.

Range:

• prePaid: yearly/monthly

• postPaid: pay-per-use

order_id

String

Definition:

Order ID. This parameter is only returned for yearly/monthly instances.

Range:

N/A

type

String

Definition:

DB engine.

Range:

gaussdb-mysql

version

String

Definition:

DB version.

Range:

N/A

start_time

String

Definition:

Automated backup start time. An automated backup will be triggered within one hour after the time specified by this parameter.

Constraints:

N/A

Range:

The value cannot be empty. It must be a valid value in the "hh:mm-HH:MM" format. The current time is the UTC time.

1. The HH value must be 1 greater than the hh value.

2. The values of mm and MM must be the same and must be set to 00.

Default value:

N/A

keep_days

String

Definition:

Retention period of automated backups.

Constraints:

The value must be a positive integer.

Range:

1–732

Default value:

N/A

id

String

Definition:

Instance ID, which is compliant with the UUID format.

Range:

The value can contain 36 characters with a suffix of in07. Only letters and digits are allowed.

name

String

Definition:

Node name.

Range:

N/A

type

String

Definition:

Node type.

Range:

• master: primary node

• slave: read replica

status

String

Definition:

Node status.

Range:

N/A

port

Integer

Definition:

Database port.

Range:

N/A

private_read_ips

Array of strings

Definition:

Private IP addresses for read of nodes.

Range:

N/A

volume

MysqlInstanceNodeVolumeInfo object

Definition:

Storage disk information.

Range:

N/A

az_code

String

Definition:

AZ.

Range:

N/A

region_code

String

Definition:

Region where an instance is deployed.

Range:

N/A

created

String

Definition:

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.

Range:

N/A

updated

String

Definition:

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

Range:

N/A

flavor_id

String

Definition:

Specification ID.

Range:

N/A

flavor_ref

String

Definition:

Specification code.

Range:

N/A

max_connections

String

Definition:

Maximum number of connections.

Range:

N/A

vcpus

String

Definition:

Number of vCPUs.

Range:

N/A

ram

String

Definition:

Memory size, in GB.

Range:

N/A

need_restart

Boolean

Definition:

Whether to reboot the instance for the parameter modifications to take effect.

Range:

N/A

priority

Integer

Definition:

Failover priority.

Range:

–1 or 1–16

type

String

Definition:

Disk type.

Range:

N/A

used

String

Definition:

Used disk size, in GB.

Range:

N/A

size

Long

Definition:

Storage space of a yearly/monthly instance, in GB.

Range:

N/A

key

String

Definition:

Tag key.

Constraints:

It cannot be an empty string, a space, or left blank.

Range:

The value contains a maximum of 36 Unicode characters. Only uppercase letters, lowercase letters, digits, hyphens (-), and underscores (_) are allowed.

Default value:

N/A

value

String

Definition:

Tag value.

Constraints:

It can be an empty string.

Range:

The value contains a maximum of 43 Unicode characters. Only uppercase letters, lowercase letters, digits, hyphens (-), and underscores (_) are allowed.

Default value:

N/A

pool_id

String

Definition:

Proxy instance ID.

Range:

N/A

name

String

Definition:

Proxy instance name.

Range:

N/A

address

String

Definition:

Proxy address.

Range:

N/A

error_code

String

Error code.

error_msg

String

Error message.

error_code

String

Error code.

error_msg

String

Error message.

200

Success.

400

Client error.

500

Server error.