接口功能介绍
查询实例列表。
接口约束
无
URI
POST /v1/open-api/instance/instance-list
路径参数
无
Query参数
无
请求参数
请求头header参数
无
请求体body参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
pageNow | 否 | Integer | 当前页 | 1 | |
pageSize | 否 | Integer | 单页记录条数 | ||
tagVOList | 否 | Array of Objects | 标签列表 | tagVO | |
resDbEngine | 否 | String | 数据库引擎 枚举 "5.7" "8.0" | ||
prodInstName | 否 | String | 实例名称 | ||
vip | 否 | String | 连接ip | ||
tagVO
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
value | Y | String | 标签value | ||
key | Y | String | 标签key |
响应参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
statusCode | 是 | Integer | 返回码取值范围:0 成功 | 0 | |
message | 是 | String | 返回消息 | ||
returnObj | 是 | PageInfo | 分页信息 | returnObj |
表 returnObj
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
pageNum | 是 | Integer | 当前页 | 1 | |
pageSize | 是 | Integer | 每页的数量 | 1 | |
size | 是 | Integer | 当前页的数量 | 0 | |
startRow | 是 | Integer | 当前页面第一个元素在数据库中的行号 | 0 | |
endRow | 是 | Integer | 当前页面最后一个元素在数据库中的行号 | 0 | |
total | 是 | Integer | 总记录数 | ||
pages | 是 | Integer | 总页数 | ||
firstPage | 是 | Integer | 第一页 | ||
prePage | 是 | Integer | 前一页 | ||
isFirstPage | 是 | Boolean | 是否为第一页 | ||
isLastPage | 是 | Boolean | 是否为最后一页 | ||
hasPreviousPage | 是 | Boolean | 是否有前一页 | ||
hasNextPage | 是 | Boolean | 是否有下一页 | ||
navigatePages | 是 | Integer | 导航页码数 | ||
navigatepageNums | 是 | Array of Integer | 所有导航页号 | ||
list | 是 | Array of Objects | 结果集(每页显示的数据) | T |
列表信息
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
prodInstName | 是 | String | 实例名称 | ||
outerProdInstId | 是 | String | 实例ID | ||
prodBillType | 是 | Integer | 计费模式 0:按月计费,1:按天计费,2:按年计费,3:按流量计费 4按需计费 | 1 | |
prodType | 是 | Tinyint | 0单机 1:1M1S 2:1M2S 3:1M3S | ||
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 | 虚拟IPv6地址 | ||
writePort | 是 | String | 写数据端口 | ||
readPort | 是 | String | 读端口 | ||
createTime | 是 | Date | 创建时间 | ||
expireTime | 是 | Date | 到期时间 | ||
machineSpec | 是 | String | 实例规格 | ||
prodDbEngine | 是 | String | 数据库引擎 | ||
diskSize | 是 | Integer | 存储空间大小 单位G | ||
newMysqlVersion | 是 | String | mysql版本 | 5.7.35 | |
diskType | 是 | String | 存储类型:1SATA2SAS 3-SSD 4-LVM | ||
backupDiskUsedRated | 是 | Integer | 备份空间使用率 | ||
netName | 是 | String | 虚拟私有云 | ||
subnet | 是 | String | 子网名 | ||
readNode | 是 | List | 读节点信息 | ||
prodInstFlag | 是 | String | 实例标签 | ||
orderId | 是 | Long | 订单ld | ||
canOperate | 是 | Integer | 是否可升级 | ||
tplName | 是 | String | 实例模板名 | ||
auditLogStatus | 是 | Integer | 日志审计开关 | ||
parameterGroupUsed | 是 | String | 参数模板名 | ||
vpcId | 是 | String | 虚拟私有云id | ||
usezos | 是 | Integer | 是否使用对象存储 | ||
prodInstId | 是 | Integer | 内部实例id | ||
dbMysqlVersion | 是 | String | mysql版本 | ||
resources | 是 | String | 订单来源 | ||
userId | 是 | Integer | 用户id | ||
prodBillTime | 是 | Integer | 计费模式 类型 | ||
tenantId | 是 | String | 租户id | ||
tplCode | 是 | String | 实例模板code | ||
prodId | 是 | Integer | 产品id | ||
prodInstSetName | 是 | String | 实例set名称 | ||
securityGroup | 是 | String | 安全组名 |
请求示例
请求头header
无
请求体body
{
"pageNow": 1,
"pageSize": 10,
"prodInstName": "string",
"resDbEngine": "string",
"tagVOList": [{
"key": "key",
"value": "v1"
}],
"vip": "192.168.0.187"
}
响应示例
{
"statusCode": 0,
"message": "success",
"returnObj": {
"navigatepageNums": [
1
],
"startRow": 1,
"hasNextPage": false,
"prePage": 0,
"nextPage": 0,
"endRow": 3,
"pageSize": 10,
"list": [
{
"newMysqlVersion": "5.7.35",
"prodOrderStatus": 0,
"prodInstFlag": "5605-Rds-2826",
"subnet": "subnet-3t68",
"alive": 0,
"dbMysqlVersion": "",
"orderId": 21301,
"prodDbEngine": "5.7",
"netName": "vpc-3t68",
"prodId": 10001002,
"vip6": "",
"canOperate": 1,
"diskSize": 100,
"tplName": "MySQL-5.7-金融版-1C4G-SSD",
"backupDiskUsedRated": -1,
"prodRunningStatus": 0,
"auditLogStatus": 0,
"parameterGroupUsed": "Default-MySQL-5.7",
"vpcId": "07a41838-845c-467d-b2e8-e1001a9fc01f",
"prodInstSetName": "set_122191526301",
"diskType": "SATA",
"prodBillType": 0,
"usezos": 0,
"vip": "192.168.0.224",
"machineSpec": "1C4G",
"prodInstName": "Rds-2826",
"resources": "{}",
"securityGroup": "sgs-95601111",
"writePort": "13056",
"prodType": 2,
"userId": 3270,
"prodBillTime": 1,
"outerProdInstId": "d41a628382fe44448d7c8f679d039b95",
"expireTime": 1669539124000,
"createTime": 1666860701000,
"tenantId": "3270",
"prodInstId": 5605,
"tplCode": "rds-mysql-5.7-finance-1c-4g-ssd",
"readNode": [],
"readPort": "13048"
},
{
"newMysqlVersion": "8.0.300",
"prodOrderStatus": 0,
"prodInstFlag": "5612-ONLY_FOR_DAS1",
"subnet": "subnet-3t68",
"alive": -1,
"dbMysqlVersion": "",
"orderId": 21316,
"prodDbEngine": "8.0",
"netName": "vpc-3t68",
"prodId": 10001103,
"vip6": "",
"canOperate": 1,
"diskSize": 100,
"tplName": "MySQL-8.0-基础版-2C4G",
"backupDiskUsedRated": -1,
"prodRunningStatus": 0,
"auditLogStatus": 0,
"parameterGroupUsed": "Default-MySQL-8.0",
"vpcId": "07a41838-845c-467d-b2e8-e1001a9fc01f",
"prodInstSetName": "set_si_20414663011",
"diskType": "SATA",
"prodBillType": 0,
"usezos": 0,
"vip": "192.168.0.187",
"machineSpec": "2C4G",
"prodInstName": "ONLY_FOR_DAS1",
"resources": "{}",
"securityGroup": "sgs-95601111",
"writePort": "13049",
"prodType": 0,
"userId": 3270,
"prodBillTime": 1,
"outerProdInstId": "1f2e939550bb4f2997004c53751ad06f",
"expireTime": 1668183778000,
"createTime": 1666861668000,
"tenantId": "3270",
"prodInstId": 5612,
"tplCode": "rds-mysql-8.0-basic-2c-4g",
"readNode": [],
"readPort": "13048"
},
{
"newMysqlVersion": "5.7.35",
"prodOrderStatus": 0,
"prodInstFlag": "5619-ONLY_FOR_DAS",
"subnet": "subnet-cc1d",
"alive": 0,
"dbMysqlVersion": "",
"orderId": 21529,
"prodDbEngine": "5.7",
"netName": "vpc-htap2",
"prodId": 10001003,
"vip6": "",
"canOperate": 1,
"diskSize": 100,
"tplName": "MySQL-5.7-基础版-2C4G-SATA",
"backupDiskUsedRated": -1,
"prodRunningStatus": 0,
"auditLogStatus": 0,
"parameterGroupUsed": "Default-MySQL-5.7",
"vpcId": "840a039a-7926-4f96-b6f9-2d79dcfaaaac",
"prodInstSetName": "set_si_20615463011",
"diskType": "SATA",
"prodBillType": 0,
"usezos": 0,
"vip": "192.168.0.37",
"machineSpec": "2C4G",
"prodInstName": "ONLY_FOR_DAS",
"resources": "{}",
"securityGroup": "default",
"writePort": "13059",
"prodType": 0,
"userId": 3270,
"prodBillTime": 1,
"outerProdInstId": "812a545ff4324b9087dc6a2e51f506df",
"expireTime": 1668181608000,
"createTime": 1667361761000,
"tenantId": "3270",
"prodInstId": 5619,
"tplCode": "rds-mysql-5.7-basic-2c-4g-sata",
"readNode": [],
"readPort": "13048"
}
],
"pageNum": 1,
"navigatePages": 8,
"navigateFirstPage": 1,
"total": 3,
"pages": 1,
"size": 3,
"isLastPage": true,
"hasPreviousPage": false,
"navigateLastPage": 1,
"isFirstPage": true
}
}
状态码
状态码 | 描述 |
---|---|
0 | 请求响应成功 |
错误码
错误码 | 描述 |
---|---|
2001 | 参数异常,失败原因见message |
3001 | 业务异常,失败原因见message |
5001 | 请求响应失败,失败原因见message |