查询实例详情信息
调试
您可以在API Explorer中调试该接口。
URI
GET /mysql/v3/{project_id}/instances/{instance_id}
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
租户在某一region下的project ID。 获取方法请参见获取项目ID。 |
instance_id |
是 |
String |
实例ID。 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
用户Token。 通过调用IAM服务获取用户Token接口获取。 请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。 |
X-Language |
否 |
String |
请求语言类型。默认en-us。 取值范围:
|
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
instance |
MysqlInstanceInfoDetail object |
实例信息。 |
参数 |
参数类型 |
描述 |
---|---|---|
id |
String |
实例ID。 |
name |
String |
创建的实例名称。 |
project_id |
String |
租户在某一region下的project ID。 |
status |
String |
实例状态。 取值:
|
port |
String |
数据库端口号。 |
type |
String |
实例类型,取值为“Cluster”。 |
node_count |
Integer |
节点个数。 |
datastore |
MysqlDatastore object |
数据库信息。 |
backup_used_space |
Number |
备份空间使用大小,单位为GB。 |
created |
String |
创建时间,格式为"yyyy-mm-ddThh:mm:ssZ"。 其中,T指某个时间的开始;Z指时区偏移量,例如北京时间偏移显示为+0800。说明:创建时返回值为空,数据库实例创建成功后该值不为空。 |
updated |
String |
更新时间,格式与"created"字段对应格式完全相同。说明:创建时返回值为空,数据库实例创建成功后该值不为空。 |
private_write_ips |
Array of strings |
实例的写内网IP。 |
public_ips |
String |
实例的公网IP。 |
db_user_name |
String |
默认用户名。 |
vpc_id |
String |
虚拟私有云ID。 |
subnet_id |
String |
子网的网络ID信息。 |
security_group_id |
String |
安全组ID。 |
configuration_id |
String |
实例创建的模板ID,或者应用到实例的最新参数组模板ID。 |
volume |
MysqlVolumeInfo object |
存储盘信息。 |
backup_strategy |
MysqlBackupStrategy object |
自动备份策略 |
nodes |
Array of MysqlInstanceNodeInfo objects |
节点信息。 |
enterprise_project_id |
String |
企业项目ID。 |
time_zone |
String |
时区。 |
az_mode |
String |
可用区模式,单可用区single或多可用区multi。 |
master_az_code |
String |
主可用区。 |
maintenance_window |
String |
可维护时间窗,为UTC时间。 |
tags |
Array of MysqlTags objects |
实例标签。 |
dedicated_resource_id |
String |
专属资源池ID,只有数据库实例属于专属资源池才会返回该参数。 |
参数 |
参数类型 |
描述 |
---|---|---|
type |
String |
数据库引擎,现在只支持gaussdb-mysql |
version |
String |
数据库版本。 数据库支持的详细版本信息,可调用查询数据库引擎的版本接口获取。 |
kernel_version |
String |
数据库内核版本。 |
参数 |
参数类型 |
描述 |
---|---|---|
start_time |
String |
自动备份开始时间段。自动备份将在该时间一个小时内触发。 取值范围:非空,格式必须为hh:mm-HH:MM且有效,当前时间指UTC时间。
|
keep_days |
String |
自动备份保留天数。 |
参数 |
参数类型 |
描述 |
---|---|---|
id |
String |
实例ID。 |
name |
String |
节点名称。 |
type |
String |
节点类型,master或slave。 |
status |
String |
节点状态。 |
port |
Integer |
数据库端口号。 |
private_read_ips |
Array of strings |
节点的读内网地址。 |
volume |
MysqlVolumeInfo object |
存储盘信息。 |
az_code |
String |
可用区。 |
region_code |
String |
实例所在的区域。 |
created |
String |
创建时间,格式为"yyyy-mm-ddThh:mm:ssZ"。 其中,T指某个时间的开始;Z指时区偏移量,例如北京时间偏移显示为+0800。说明:创建时返回值为空,数据库实例创建成功后该值不为空。 |
updated |
String |
更新时间,格式与"created"字段对应格式完全相同。说明:创建时返回值为空,数据库实例创建成功后该值不为空。 |
flavor_ref |
String |
规格码。 |
max_connections |
String |
允许的最大连接数。 |
vcpus |
String |
CPU核数。 |
ram |
String |
内存大小,单位为GB。 |
need_restart |
Boolean |
是否需要重启使修改的参数生效。 |
priotiry |
Integer |
主备倒换优先级。 |
参数 |
参数类型 |
描述 |
---|---|---|
key |
String |
标签键。最大长度36个unicode字符。 key不能为空或者空字符串,不能为空格。 字符集:A-Z,a-z ,0-9,‘-’,‘_’,UNICODE字符(\u4E00-\u9FFF)。 |
value |
String |
标签值。最大长度43个unicode字符。 可以为空字符串。 字符集:A-Z,a-z ,0-9,‘.’,‘-’,‘_’,UNICODE字符(\u4E00-\u9FFF)。 |
状态码: 400
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码。 |
error_msg |
String |
错误消息。 |
状态码: 500
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码。 |
error_msg |
String |
错误消息。 |
请求示例
查询实例详情信息
GET https://{endpoint}/mysql/v3/97b026aa9cc4417888c14c84a1ad9860/instances/436aaafb689c4250a9a5bb33cb271e8cin07
响应示例
状态码: 200
Success.
{ "instance" : { "id" : "d738399de028480fabb2b8120d4e01a4in07", "name" : "gaussdb-mysql-instance01", "project_id" : "3cedfc54-b105-4652-a4e0-847b11576628", "status" : "ACTIVE", "port" : 3306, "type" : "Cluster", "node_count" : 2, "backup_used_space" : 20, "private_write_ips" : [ "192.168.0.142" ], "public_ips" : [ "10.154.219.187" ], "db_user_name" : "root", "datastore" : { "type" : "gaussdb-mysql", "version" : "8.0.22", "kernel_version" : "2.0.48.231200" }, "created" : "2018-08-20T02:33:49+0800", "updated" : "2018-08-20T02:33:49+0800", "volume" : { "type" : "POOL", "used_size" : 100 }, "vpc_id" : "3cedfc54-b105-4652-a4e0-847b11576b58", "subnet_id" : "c1cfa53c-65d3-431e-8552-326bf310c7ad", "security_group_id" : "fc577a1a-f202-424a-977f-24faec3fdd55", "configuration_id" : "3cedfc54-b105-4652-a4e0-24faec3fdd23", "backup_strategy" : { "start_time" : "19:00-20:00", "keep_days" : 7 }, "enterprise_project_id" : 0, "time_zone" : "UTC+08:00", "az_mode" : "single", "master_az_code" : "cn-north-4b", "maintenance_window" : "18:00-22:00", "nodes" : [ { "id" : "799a0f2fa49a4151bf9f7063c1fbba36no07", "name" : "gauss-d616-lb07_node01", "type" : "master", "status" : "normal", "port" : 3306, "private_read_ips" : [ "192.168.0.163" ], "volume" : { "type" : "POOL", "used" : 0.0 }, "az_code" : "cn-north-4b", "region_code" : "cn-north-4", "flavor_id" : "3169caaf-6c2f-41d5-aadd-c8fc3d83597e", "flavor_ref" : "taurus.large.4", "max_connections" : null, "vcpus" : 1, "ram" : 4, "need_restart" : false, "priority" : 1 }, { "id" : "799a0f2fa49a4151bf9f7063c1fbba35no07", "name" : "gauss-d616-lb07_node02", "type" : "slave", "status" : "normal", "port" : 3306, "private_read_ips" : [ "192.168.0.162" ], "volume" : { "type" : "POOL", "used" : 0.0 }, "az_code" : "cn-north-4b", "region_code" : "cn-north-4", "flavor_id" : "3169caaf-6c2f-41d5-aadd-c8fc3d83597e", "flavor_ref" : "taurus.large.4", "max_connections" : null, "vcpus" : 1, "ram" : 4, "need_restart" : false, "priority" : 1 } ] } }
状态码
状态码 |
描述 |
---|---|
201 |
Success. |
400 |
Client error. |
500 |
Server error. |
错误码
请参见错误码。