查询该实例基本实例详情
更新时间 2025-09-26 15:11:13
最近更新时间: 2025-09-26 15:11:13
接口功能介绍
根据数据库实例ID查询该实例基本实例详情。
接口约束
存在用户实例并拿到实例ID
URI
GET /RDS2/v1/open-api/instance
路径参数 无
Query参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| outerProdInstId | 是 | String | 实例ID | 562b89493b1a40e1b97ea05e50dd8170 |
请求参数
请求头header参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| project-id | 否 | String | 项目id | b829cb71308746a094853c21d5aac0a1 | |
| inst-id | 否 | String | 实例id （和参数outerProdInstId保持一致） | 264729201196525109 | |
| regionId | 是 | String | 资源区regionId，比如实例在资源区A，则需要填写A资源区的regionId | 81f7728662dd11ec810800155d307d5b |
请求体body参数 无
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | Integer | 返回码 取值范围：0 成功 | 0 | |
| message | String | 返回消息 | ||
| returnObj | Object | 返回对象 | returnObj | |
| error | String | 错误码。当接口失败时才返回具体错误编码，成功不返回或者为空 | MYSQL_10001 | |
| 表 returnObj |
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| prodBillType | Integer | 计费模式 0:按月计费,1:按天计费,2:按年计费,3:按流量计费 4按需计费 | 1 | |
| prodType | Integer | 0单机 1：1M1S 2:1M2S 3:1M3S | 1 | |
| prodRunningStatus | Integer | 0.正常 1.重启中 2.备份中 3.恢复中 4.修改参数中 5.应用参数组中 6&7.扩容中 8.修改端口中 9.迁移中 10.重置密码中 | 0 | |
| prodOrderStatus | Integer | 0.正常 1.已暂停 2.已注销 3.创建中 | 0 | |
| alive | Integer | 运行状态 0正常 -1异常 | 0 | |
| vip | String | 虚拟IP地址 | ||
| vip6 | String | 虚拟IP v6地址 | ||
| writePort | String | 写数据端口 | ||
| readPort | String | 读端口 | ||
| createTime | Long | 创建时间 | ||
| expireTime | Long | 到期时间 | ||
| machineSpec | String | 实例规格 | ||
| prodDbEngine | String | 数据库引擎 | ||
| diskTotal | String | 存储空间大小 单位G | 1 | |
| diskRated | Integer | 磁盘使用率% | 1 | |
| diskType | String | 存储类型：1SATA2SAS 3-SSD 4-LVM | ||
| diskSize | Integer | 磁盘大小单位G | 1 | |
| backupDiskUsedRated | Integer | 备份空间使用率 | 1 | |
| backupUsedDiskSize | Float | 备份空间已经使用大小（单位G） | 1 | |
| backupStoreType | Integer | 备份空间类型： * 0: 没有设置备份 * 1: 主机挂盘备份 （展示备份空间使用信息：大小和比例） * 2： 对象存储（不展示备份空间信息） * 3： 只读实例（不展示备份空间信息） | 1 | |
| prodInstSetName | String | 实例集群名称 | ||
| netName | String | 虚拟私有云 | ||
| eIP | String | 弹性ip | ||
| eipStatus | Integer | 弹性ip状态 0->unbind，1->bind,2->binding | 1 | |
| subnet | String | 子网名 | ||
| sslStatus | Integer | Ssl状态 0->off，1->on | 1 | |
| azInfoList | Array of Objects | 可用区信息 | azInfo | |
| newMysqlVersion | String | mysql版本 | 5.7.35 | |
| subnetId | String | 子网id | ||
| orderId | Long | 订单id | ||
| securityGroupId | String | 安全组id | ||
| tplName | String | 实例模板名 | ||
| auditLogStatus | Integer | 日志审计开关 | 1 | |
| securityGroup | String | 安全组名 | ||
| outerProdInstId | String | 实例id | ||
| prodInstId | Integer | 内部实例id | 1 | |
| prodInstFlag | String | 实例标签 | ||
| diskUsed | String | 磁盘使用率（取整前） | ||
| parameterGroupUsed | String | 参数模板名 | ||
| vpcId | String | 虚拟私有云id | ||
| usezos | Integer | 是否使用对象存储 | 1 | |
| prodInstName | String | 实例名 | ||
| prodId | Integer | 产品id | 1 | |
| resources | String | 订单来源 | ||
| userId | Integer | 用户id | 1 | |
| prodBillTime | Integer | 计费模式 类型 | 1 | |
| tenantId | String | 租户id | ||
| backupDiskSize | Integer | 备份空间大小 单位G | 1 | |
| tplCode | String | 实例模板code | ||
| dbMysqlVersion | String | mysql版本 | ||
| projectId | String | 项目id（可通过接口/teledb-dcp/v2/openapi/dcp-order-info/project/list查询所有项目id） | 0 | |
| projectName | String | 项目名 | default | |
| diskDataUsed | String | data文件已使用的存储大小 | 3 | |
| pauseEnable | Boolean | 是否允许暂停 | false | |
| lowerCaseTableNames | Integer | 大小写配置 | 0 | |
| instReleaseProtectionStatus | Integer | 实例释放保护开关 1:on,0:off | 1 | |
| mysqlPort | String | 数据库端口 | 3306 | |
| diskLogUsed | String | binlog文件已使用的存储大小 | 20 | |
| diskDataUsedRated | Integer | data文件已使用的存储使用率 | 3 | |
| timezone | String | 时区 | +8:00 | |
| lastManualBackUp | Integer | 最后系统全备id | -1 | |
| hostSeries | String | 主机系列 | KS1 | |
| securityGroupStatus | Integer | 安全组状态 0->normal, 1->changing, 2->deleted | 0 | |
| renewalEnable | Boolean | 是否允许续订 | true | |
| isMGR | Integer | 1：mgr实例 0：非mgr实例 | 1 | |
| diskLogUsedRated | Integer | binlog文件已使用的存储使用率 | 2 | |
| usedBackupSize | Float | 备份使用大小，单位G | 2.0 | |
| backupBinlogSize | Float | binlog备份文件大小，单位G | 1.0 | |
| backupDataSize | Float | 物理备份文件大小，单位G | 1.0 | |
| securityGroupList | Array of Objects | 实例绑定的安全组列表 | securityGroupInfo | |
| 表 securityGroupInfo |
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| securityGroupId | String | 安全组id | test-id | |
| securityGroupName | String | 安全组名称 | test-name | |
| 表 azInfo |
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| resId | Integer | 资源id | 1 | |
| role | String | 实例角色 | m | |
| azName | String | AZ名称 | 1 | |
| azId | String | azId | cn-bj5-1A-hybrid-test |
枚举参数
无
请求示例
请求url
/RDS2/v1/open-api/instance?outerProdInstId=b829cb71308746a094853c21d5aac0a1
请求头header
无
请求体body
无
响应示例
{"statusCode":0,"message":"success","returnObj":{"newMysqlVersion":"8.0.40","prodOrderStatus":0,"subnetId":"subnet-mk9nj8mi2e","subnet":"subNet-44jo4d136","diskDataUsed":"3.0","orderId":260,"netName":"vpc-cx18y09vj-20240222","pauseEnable":false,"backupUsedDiskSize":1,"lowerCaseTableNames":1,"instReleaseProtectionStatus":0,"vip6":"","securityGroupId":"sg-9o7hv6qqrk","diskSize":100,"tplName":"Mysql-8.0","backupDiskUsedRated":1,"auditLogStatus":0,"prodInstSetName":"set_2252222236301_1","eipStatus":0,"vip":"192.168.0.33","sslStatus":0,"azInfoList":[{"role":"m","azName":"az1","azId":"cn-bj5-1A-hybrid-test","resId":165},{"role":"s","azName":"az1","azId":"cn-bj5-1A-hybrid-test","resId":166},{"role":"s","azName":"az1","azId":"cn-bj5-1A-hybrid-test","resId":167}],"mysqlPort":"6301","securityGroup":"Default-Security-Group","writePort":"13049","diskLogUsed":"0.0","diskRated":4,"prodType":2,"diskDataUsedRated":3,"outerProdInstId":"959fac80-bb86-4190-9d74-ce4cd093ceee","expireTime":1724830011000,"prodInstId":262,"projectName":"az","projectId":"f1811128286c4b21a94ae3d0f2099534","prodInstFlag":"262-mysql-750-test","alive":0,"dbMysqlVersion":"8.0.40","prodDbEngine":"8.0","timezone":"+8:00","diskTotal":"100.0","prodId":10001102,"eIP":"127.0.0.1","lastManualBackUp":-1,"prodRunningStatus":0,"diskUsed":"3.8","parameterGroupUsed":"Default-MySQL-8.0","vpcId":"vpc-u76mj2dn03","diskType":"SAS","hostSeries":"KS1","prodBillType":0,"usezos":0,"machineSpec":"2C4G","prodInstName":"mysql-750-","resources":"{}","securityGroupStatus":0,"userId":55,"prodBillTime":6,"renewalEnable":false,"isMGR":0,"createTime":1709105196000,"tenantId":"55","diskLogUsedRated":0,"backupDiskSize":100,"tplCode":"Mysql-8.0","backupStoreType":1,"readPort":"13048","usedBackupSize":2.0,"backupBinlogSize":1.0,"backupDataSize":1.0,"securityGroupList":[{"securityGroupId":"sg-9o7hv6qqrk","securityGroupName":"Default-Security-Group"}]}}
状态码
请参考 状态码
错误码
请参考 错误码
