Querying Details of a DB Instance

Function

This API is used to query the details of a specified DB instance. Before using this API:

URI

GET /v3/{project_id}/instances/{instance_id}

Table 1 URI parameters

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.

instance_id

Yes

String

DB instance ID.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token.

X-Language

No

String

Language.

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

instance

MysqlInstanceInfoDetail object

DB instance information.

Table 4 MysqlInstanceInfoDetail

Parameter

Type

Description

id

String

DB instance ID.

name

String

DB instance name.

project_id

String

Project ID of a tenant in a region.

status

String

DB instance status.

Valid value:

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

If the value is ACTIVE, the DB instance is normal.

If the value is FAILED, the DB instance is abnormal.

If the value is FROZEN, the DB instance is frozen.

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

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

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

If the value is MODIFYING INSTANCE TYPE, the DB 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 DB instance is being migrated.

If the value is BACKING UP, the DB 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 DB instance storage space is full.

port

String

Database port.

alias

String

DB instance remarks.

type

String

DB instance type. The value is Cluster.

charge_info

MysqlInstanceChargeInfo object

Billing mode, which is yearly/monthly or pay-per-use (default setting).

node_count

Integer

Number of nodes.

datastore

MysqlDatastore 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. The value is empty unless the DB instance creation is complete.

updated

String

Update time. The format is the same as that of the created field. The value is empty unless the DB instance creation is complete.

private_write_ips

Array of strings

Private IP address for write.

public_ips

String

Public IP address of the DB instance.

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 an 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. It can be single or multi.

master_az_code

String

Primary AZ.

maintenance_window

String

Maintenance window in the UTC format.

tags

Array of MysqlTags objects

Tags for managing DB instances.

dedicated_resource_id

String

Dedicated resource pool ID. This parameter is returned only when the DB instance belongs to a dedicated resource pool.

proxies

Array of MysqlProxyInfo objects

Proxy information.

Table 5 MysqlInstanceChargeInfo

Parameter

Type

Description

charge_mode

String

Billing mode.

order_id

String

Order ID.

Table 6 MysqlDatastoreWithKernelVersion

Parameter

Type

Description

type

String

DB engine. Currently, only gaussdb-mysql is supported.

version

String

DB version.

To obtain details about supported DB engine versions, call the API for querying the DB engine versions.

Table 7 MysqlBackupStrategy

Parameter

Type

Description

start_time

String

Automated backup start time. The 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.

  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.

keep_days

String

Automated backup retention days. Value: 1-732.

Table 8 MysqlInstanceNodeInfo

Parameter

Type

Description

id

String

DB instance ID.

name

String

Node name.

type

String

Node type, which can be master or slave.

status

String

Node status.

port

Integer

Database port.

private_read_ips

Array of strings

Private IP address for read of the node.

volume

MysqlInstanceNodeVolumeInfo object

Storage disk information.

az_code

String

AZ.

region_code

String

Region where the DB 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. The value is empty unless the DB instance creation is complete.

updated

String

Update time. The format is the same as that of the created field. The value is empty unless the DB instance creation is complete.

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 DB instance for the parameter modifications to take effect.

priority

Integer

Failover priority.

Table 9 MysqlInstanceNodeVolumeInfo

Parameter

Type

Description

type

String

Disk type.

used

String

Used disk size in GB.

size

Long

Disk size of the yearly/monthly DB instance in GB

Table 10 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 contains a maximum of 43 Unicode characters. The value can be an empty string. Only uppercase letters, lowercase letters, digits, periods (.), hyphens (-), and underscores (_) are allowed.

Table 11 MysqlProxyInfo

Parameter

Type

Description

pool_id

String

Proxy instance ID.

name

String

Proxy instance name.

address

String

Proxy read/write splitting address.

Status code: 400

Table 12 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Status code: 500

Table 13 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Example Request

Querying instance details

GET https://gaussdb-mysql.eu-de.otc.t-systems.com/v3/97b026aa9cc4417888c14c84a1ad9860/instances/436aaafb689c4250a9a5bb33cb271e8cin07

Example Response

Status code: 201

Note

The values of region_code and az_code are used as examples.

Success.

{
  "instance" : {
    "id" : "436aaafb689c4250a9a5bb33cb271e8cin07",
    "name" : "gaussdb-mysql-instance01",
    "alias" : "",
    "status" : "ACTIVE",
    "project_id" : "97b026aa9cc4417888c14c84a1ad9860",
    "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.154.219.187" ],
    "private_write_ips" : [ "192.168.0.142" ],
    "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" : "ACTIVE",
      "port" : 3306,
      "private_read_ips" : [ "192.168.0.163" ],
      "volume" : {
        "type" : "POOL",
        "used" : 0.07
      },
      "az_code" : "az1",
      "region_code" : "br-iaas-odin1",
      "flavor_id" : "3169caaf-6c2f-41d5-aadd-c8fc3d83597e",
      "flavor_ref" : "gaussdb.mysql.xlarge.arm.8",
      "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" : "ACTIVE",
      "port" : 3306,
      "private_read_ips" : [ "192.168.0.162" ],
      "volume" : {
        "type" : "POOL",
        "used" : 0.07
      },
      "az_code" : "az1",
      "region_code" : "br-iaas-odin1",
      "flavor_id" : "3169caaf-6c2f-41d5-aadd-c8fc3d83597e",
      "flavor_ref" : "gaussdb.mysql.xlarge.arm.8",
      "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.168.10.76",
      "name" : "proxy-name"
    } ]
  }
}

Status Code

For details, see Status Codes.

Error Code

For details, see Error Codes.

last updated: 2024-05-20 01:10