接口功能介绍
通过过期时间、过期状态等参数查询实例列表。
接口约束
无
URI
POST /v1/open-api/instance/instance-by-time
路径参数
无
Query参数
无
请求参数
请求头header参数
无
请求体body参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
pageNow | 否 | Integer | 当前页 | 1 | |
pageSize | 否 | Integer | 单页记录条数 | ||
tagVOList | 否 | Array of Objects | 标签列表 | tagVO | |
expireDays | 否 | Integer | 实例剩余可用天数。取值:0~180 少于指定天数的实例会被查出来 | ||
expire | 否 | Boolean | 是否过期 |
表tagVO
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
value | 是 | String | 标签value | ||
key | 是 | 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 | 是 | List | 结果集(每页显示的数据) | T |
列表信息
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
prodInstName | 是 | String | 实例名称 | ||
outerProdInstId | 是 | String | 实例ID | ||
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 | |
machineSpec | 是 | String | 实例规格 | ||
createTime | 是 | Date | 创建时间 | ||
expireTime | 是 | Date | 到期时间 | ||
prodInstFlag | 是 | String | 实例标签 | ||
subnet | 是 | String | 子网名称 | ||
prodDbEngine | 是 | String | 实例引擎版本 | ||
netName | 是 | String | 虚拟私有云 | ||
diskSize | 是 | Integer | 磁盘大小单位GB | ||
tplName | 是 | String | 实例模板名 | ||
backupDiskUsedRated | 是 | Integer | 备份空间使用率 | ||
parameterGroupUsed | 是 | String | 参数模板名 | ||
prodInstSetName | 是 | String | 实例集群名 | ||
diskType | 是 | String | 存储类型:1SATA2SAS 3-SSD 4-LVM | ||
machineSpec | 是 | String | 实例规格 | ||
securityGroup | 是 | String | 安全组名 | ||
prodInstId | 是 | Integer | 内部实例id | ||
prodId | 是 | Integer | 产品id | ||
resources | 是 | String | 订单来源 | ||
tplCode | 是 | String | 实例模板code |
请求示例
请求头header
无
请求体body
{
"pageNow": 1,
"expireDays": 3,
"expire": true,
"pageSize": 10
}
响应示例
{
"statusCode": 0,
"message": "success",
"returnObj": {
"navigatepageNums": [
1
],
"startRow": 1,
"hasNextPage": false,
"prePage": 0,
"nextPage": 0,
"endRow": 1,
"pageSize": 10,
"list": [
{
"prodOrderStatus": 0,
"prodInstFlag": "5605-Rds-2826",
"subnet": "subnet-3t68",
"prodDbEngine": "5.7",
"netName": "vpc-3t68",
"prodId": 10001002,
"diskSize": 100,
"tplName": "MySQL-5.7-金融版-1C4G-SSD",
"backupDiskUsedRated": -1,
"prodRunningStatus": 0,
"parameterGroupUsed": "Default-MySQL-5.7",
"prodInstSetName": "set_122191526301",
"diskType": "SATA",
"prodBillType": 0,
"machineSpec": "1C4G",
"prodInstName": "Rds-2826",
"resources": "{}",
"securityGroup": "sgs-95601111",
"prodType": 2,
"prodBillTime": 1,
"outerProdInstId": "d41a628382fe44448d7c8f679d039b95",
"expireTime": 1669539124000,
"createTime": 1666860701000,
"prodInstId": 5605,
"tplCode": "rds-mysql-5.7-finance-1c-4g-ssd"
}
],
"pageNum": 1,
"navigatePages": 8,
"navigateFirstPage": 1,
"total": 1,
"pages": 1,
"size": 1,
"isLastPage": true,
"hasPreviousPage": false,
"navigateLastPage": 1,
"isFirstPage": true
}
}
状态码
状态码 | 描述 |
---|---|
0 | 请求响应成功 |
错误码
错误码 | 描述 |
---|---|
2001 | 参数异常,失败原因见message |
3001 | 业务异常,失败原因见message |
5001 | 请求响应失败,失败原因见message |