备案 控制台 登录 注册
文档中心 > DescribeDBInstanceAttribute
DescribeDBInstanceAttribute

最近更新时间：2022-09-26

请求路径：/v3/api/rds

请求方法：GET

接口描述：获取实例详情

请求参数

名称

类型

是否必选

示例值

描述

Action

String

是

DescribeDBInstanceAttribute

系统规定参数。取值：DescribeDBInstanceAttribute

DBInstanceId

String

是

mysql-lv1xxxxxxx

数据库实例ID

返回参数

状态码：200

名称

类型

示例值

描述

RequestId

String

rm-uf6wjk5xxxxxxxxxx

请求ID。

DBInstanceId

String

mysql-lv1xxxxxxx

数据库实例ID

DBInstanceName

String

mysql2318451345

数据库实例名称

InstanceType

String

normal

实例类型。取值：-normal：常规实例 -read_only：只读实例

InstanceMode

String

SE

数据库系列。取值：-SE：单机版 -HA：高可用版

SourceInstanceId

String

mysql-lv1xxxxxxx

当InstanceType为read_only时返回

Region

String

cn-beijing

地域ID

RegionName

String

华北2-北京2

地域名称。

InstanceStatus

String

running

实例状态。

Vip

String

192.168.0.6

实例Vip，配置白名单后显示

VpcId

String

vpc-wrxxxxxxxx

VpcId

VpcSubnetId

String

af308f6a8xxxxxwrxxxxxxxx

子网ID

Port

Integer

3306

数据库服务端口。

Engine

String

mysql

数据库类型

EngineVersion

String

5.7

数据库版本

PayType

String

YEAR_MONTH

计费方式。

CreateTime

String

2019-02-27   16:00:00

创建时间，格式为“yyyy-mm-dd hh:mm:ss”。

ExpireTime

String

2019-02-27   16:00:00

过期时间，格式为“yyyy-mm-dd hh:mm:ss”。后付费无到期时间

CreateUserName

String

testUser1

实例创建者

ProjectName

String

projecttest

企业用户的项目名称

Nodes

Array

[]

由节点信息组成的数组

-   NodeId

String

mysql-xxxxxxxxx_node_node0

节点ID

-   Role

String

master

节点角色

-   NodeIp

String

192.168.1.2

节点IP

-   NodeStatus

String

running

节点状态

-   AvailabilityZone

String

cn-beijing-5

可用区ID

-   NodeClass

String

db.s1.large

节点规格码

-   Cpu

Integer

2

节点Cpu个数

-   Memory

Integer

4

节点内存大小

-   AllocatedStorage

Integer

10

节点磁盘大小，单位：G

-   StorageType

String

local

节点存储类型

示例

请求示例

GET https://api.unicloud.com/v3/api/rds?

Action=DescribeDBInstanceAttribute

&DBInstanceId=mysql-xdnwcxxxxxx

返回示例

{

"RequestId": "xxxxxx",

"DBInstanceId": "mssql-xxxxxx",

"DBInstanceName": "测试中",

"InstanceType": "normal",

"InstanceMode": "SE",

"SourceInstanceId": "",

"Region": "cn-beijing",

"RegionName": "华北2-北京2",

"InstanceStatus": "running",

"Vip": "",

"VpcId": "vpc-xxxxxx",

"SubnetId": "vsnet-xxxxxx",

"Port": 1433,

"Engine": "sqlserver",

"EngineVersion": "2016-enterprise",

"PayType": "YEAR_MONTH",

"CreateTime": "2022-08-08 11:30:16",

"ExpireTime": "2022-09-09 00:00:00",

"CreateUserName": "dbstest",

"ProjectName": "default",

"Nodes": [

         {

                  "NodeId": "mssql-xxxxxx_node0_node0",

                  "NodeIp": "",

                  "Role": "master",

                  "NodeStatus": "running",

                  "AvailabilityZone": "cn-beijing-a",

                  "NodeClass": "db.s1.large",

                  "Cpu": 2,

                  "Memory": 8,

                  "AllocatedStorage": 11,

                  "StorageType": "local"

         }

]

}