接口功能介绍
查询任务中心任务信息。
接口约束
实例任务中心已开启。
URI
GET /v1/open-api/instance/task-center-events
Query参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
outerProdInstId | 否 | String | 产品实例ID,若为空则查询所有开启实例的任务信息 | test1 | |
taskName | 否 | String | 任务名称,重启实例:RestartInstance;应用参数组:ApplyParameterGroup;创建实例:CreateMysqlInstance;修改密码:RestPassword;主备切换:MasterSlaveSwitch;扩容预处理:ExpansionProcess;扩容恢复:ExpansionRecovery;修改端口:UpdateWritePort;绑定弹性IP:BindElasticIp;解绑弹性IP:UnBindElasticIp | RestartInstance | |
resultStatus | 否 | Integer | 任务状态,成功:0;进行中:1;失败:2 | 1 | |
pageNow | 否 | Integer | 查询列表当前页 | 1 | |
pageSize | 否 | Integer | 页面记录数 | 10 | |
startTime | 否 | String | 开始时间 | 2022-09-13 00:00:00 | |
endTime | 否 | String | 结束时间 | 2022-09-14 00:00:00 |
响应参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
statusCode | 是 | String | 返回码 | 0 | |
message | 是 | String | 返回消息 | null | |
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 |
列表信息
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
resultStatus | 是 | Integer | 任务状态 | 1 | |
jobId | 是 | Integer | 任务ID | 3298 | |
prodInstName | 是 | String | 实例名称 | Rds-e038 | |
createTime | 是 | Integer | 创建时间 | 1662949097000 | |
prodInstId | 是 | Integer | 实例ID | 7788 | |
operateName | 是 | String | 操作名称 | RestartInstance |
请求示例
请求头header
无
请求体body
无
响应示例
{
"statusCode": 0,
"message": "success",
"returnObj": {
"navigatepageNums": [
1
],
"startRow": 1,
"hasNextPage": false,
"prePage": 0,
"nextPage": 0,
"endRow": 1,
"pageSize": 10,
"list": [
{
"resultStatus": 1,
"jobId": 3298,
"prodInstName": "Rds-e038",
"createTime": 1662949097000,
"prodInstId": 7788,
"operateName": "RestartInstance"
}
],
"pageNum": 1,
"navigatePages": 8,
"total": 1,
"pages": 1,
"firstPage": 1,
"size": 1,
"isLastPage": true,
"hasPreviousPage": false,
"isFirstPage": true
}
}
状态码
状态码 | 描述 |
---|---|
0 | 请求响应成功 |
错误码
状态码 | 描述 |
---|---|
2001 | 参数异常,失败原因见message |
3001 | 业务异常,失败原因见message |
5001 | 请求响应失败,失败原因见message |