接口功能介绍
根据数据库实例ID查询该实例基本实例详情。
接口约束
存在用户实例并拿到实例ID。
URI
GET /v1/open-api/instance
路径参数
无
Query参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
outerProdInstId | 是 | String | 实例ID | 562b89493b1a40e1b97ea05e50dd8170 |
请求参数
请求头header参数
无
请求体body参数
无
响应参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
statusCode | 是 | Integer | 返回码 | 0 | |
message | 是 | String | 返回消息 | ||
returnObj | 是 | Object | 返回对象 | returnObj |
表 returnObj
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
prodBillType | 是 | Integer | 计费模式 0:按月计费,1:按天计费,2:按年计费,3:按流量计费 4按需计费 | 1 | |
prodType | 是 | Tinyint | 0单机 1:1M1S 2:1M2S 3:1M3S | true | |
prodRunningStatus | 是 | Integer | 0.正常 1.重启中 2.备份中 3.恢复中 4.修改参数中 5.应用参数组中 6&7.扩容中 8.修改端口中 9.迁移中 10.重置密码中 | 0 | |
prodOrderStatus | 是 | Integer | 0.正常 1.已暂停 2.已注销 3.创建中 | 0 | |
alive | 是 | Tinyint | 运行状态 0正常 -1异常 | 0 | |
vip | 是 | String | 虚拟IP地址 | ||
vip6 | 是 | String | 虚拟IP v6地址 | ||
writePort | 是 | String | 写数据端口 | ||
readPort | 是 | String | 读端口 | ||
createTime | 是 | Date | 创建时间 | ||
expireTime | 是 | Date | 到期时间 | ||
machineSpec | 是 | String | 实例规格 | ||
prodDbEngine | 是 | String | 数据库引擎 | ||
diskTotal | 是 | Integer | 存储空间大小 单位G | ||
diskRated | 是 | Integer | 磁盘使用率% | ||
diskType | 是 | String | 存储类型:1SATA2SAS 3-SSD 4-LVM | ||
diskSize | 是 | Integer | 磁盘大小 单位G | ||
backupDiskUsedRated | 是 | Integer | 备份空间使用率 | ||
backupUsedDiskSize | 是 | Integer | 备份空间已经使用大小 单位G | ||
backupStoreType | 是 | Integer | 备份空间类型: * 0: 没有设置备份 * 1: 主机挂盘备份 (展示备份空间使用信息:大小和比例) * 2: 对象存储(不展示备份空间信息) * 3: 只读实例(不展示备份空间信息) | ||
prodInstSetName | 是 | String | 实例集群名称 | ||
netName | 是 | String | 虚拟私有云 | ||
eIP | 是 | String | 弹性ip | ||
eipStatus | 是 | Integer | 弹性ip状态 0->unbind,1->bind,2->binding | ||
subnet | 是 | String | 子网名 | ||
sslStatus | 是 | Integer | Ssl状态 0->off,1->on | ||
readNode | 是 | List | 读节点信息 | ||
newMysqlVersion | 是 | String | mysql版本 | 5.7.35 | |
subnetId | 是 | String | 子网id | ||
orderId | 是 | Long | 订单id | ||
securityGroupId | 是 | String | 安全组id | ||
tplName | 是 | String | 实例模板名 | ||
auditLogStatus | 是 | Integer | 日志审计开关 | ||
securityGroup | 是 | String | 安全组名 | ||
outerProdInstId | 是 | String | 实例id | ||
prodInstId | 是 | Integer | 内部实例id | ||
prodInstFlag | 是 | String | 实例标签 | ||
prodDbEngine | 是 | String | 数据引擎版本 | ||
diskUsed | 是 | String | 磁盘使用率(取整前) | ||
parameterGroupUsed | 是 | String | 参数模板名 | ||
vpcId | 是 | String | 虚拟私有云id | ||
usezos | 是 | Integer | 是否使用对象存储 | ||
prodInstName | 是 | String | 实例名 | ||
prodId | 是 | Integer | 产品id | ||
resources | 是 | String | 订单来源 | ||
userId | 是 | Integer | 用户id | ||
prodBillTime | 是 | Integer | 计费模式 类型 | ||
tenantId | 是 | String | 租户id | ||
backupDiskSize | 是 | Integer | 备份空间大小 单位G | ||
tplCode | 是 | String | 实例模板code | ||
dbMysqlVersion | 是 | String | mysql版本 |
请求示例
请求头header
无
请求体body
无
响应示例
{
"statusCode": 0,
"message": "success",
"returnObj": {
"newMysqlVersion": "5.7.35",
"prodOrderStatus": 0,
"subnetId": "7d3fe61d-b279-4c2a-b190-afd9754125b4",
"subnet": "subnet-3t68",
"orderId": 21301,
"netName": "vpc-3t68",
"backupUsedDiskSize": 0,
"vip6": "",
"securityGroupId": "aa8ddfb7-f042-4c57-bb25-7df09d5c732a",
"diskSize": 100,
"tplName": "MySQL-5.7-金融版-1C4G-SSD",
"backupDiskUsedRated": 0,
"auditLogStatus": 0,
"prodInstSetName": "set_122191526301",
"eipStatus": 0,
"vip": "192.168.0.224",
"sslStatus": 0,
"securityGroup": "sgs-95601111",
"writePort": "13056",
"diskRated": 5,
"prodType": 2,
"outerProdInstId": "d41a628382fe44448d7c8f679d039b95",
"expireTime": 1669539124000,
"prodInstId": 5605,
"prodInstFlag": "5605-Rds-2826",
"alive": 0,
"dbMysqlVersion": "",
"prodDbEngine": "5.7",
"diskTotal": "100",
"prodId": 10001002,
"eIP": "127.0.0.1",
"prodRunningStatus": 0,
"diskUsed": "5.3",
"parameterGroupUsed": "Default-MySQL-5.7",
"vpcId": "07a41838-845c-467d-b2e8-e1001a9fc01f",
"diskType": "SATA",
"prodBillType": 0,
"usezos": 0,
"machineSpec": "1C4G",
"prodInstName": "Rds-2826",
"resources": "{}",
"userId": 3270,
"prodBillTime": 1,
"createTime": 1666860701000,
"tenantId": "3270",
"backupDiskSize": 100,
"tplCode": "rds-mysql-5.7-finance-1c-4g-ssd",
"backupStoreType": 1,
"readPort": "13048"
}
}
状态码
状态码 | 描述 |
---|---|
0 | 请求响应成功 |
错误码
错误码 | 描述 |
---|---|
2001 | 参数异常,失败原因见message |
3001 | 业务异常,失败原因见message |
5001 | 请求响应失败,失败原因见message |