查询任务中心任务信息
更新时间 2025-09-16 11:39:41
最近更新时间: 2025-09-16 11:39:41
接口功能介绍
查询任务中心任务信息
接口约束
实例任务中心(RDS历史记录)已开启。
URI
GET /RDS2/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 |
请求参数
请求头header参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
project-id | 否 | String | 项目id | b829cb71308746a094853c21d5aac0a1 | |
inst-id | 否 | String | 实例id (和参数outerProdInstId保持一致) | 264729201196525109 | |
regionId | 是 | String | 资源池regionId,比如实例在资源池A,则需要填写A资源池的regionId。 | 81f7728662dd11ec810800155d307d5b |
请求体body参数 无
响应参数
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
statusCode | Integer | 返回码 | 0 | |
message | String | 返回消息 | null | |
returnObj | Object | 分页信息 | returnObj | |
error | String | 错误码。当接口失败时才返回具体错误编码,成功不返回或者为空 | MYSQL_10001 | |
表 returnObj |
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
pageNum | Integer | 当前页 | 1 | |
pageSize | Integer | 每页的数量 | 1 | |
size | Integer | 当前页的数量 | 0 | |
startRow | Integer | 当前页面第一个元素在数据库中的行号 | 0 | |
endRow | Integer | 当前页面最后一个元素在数据库中的行号 | 0 | |
total | Integer | 总记录数 | 1 | |
pages | Integer | 总页数 | 1 | |
firstPage | Integer | 第一页 | 1 | |
prePage | Integer | 前一页 | 1 | |
isFirstPage | Boolean | 是否为第一页 | ||
isLastPage | Boolean | 是否为最后一页 | ||
hasPreviousPage | Boolean | 是否有前一页 | ||
hasNextPage | Boolean | 是否有下一页 | ||
navigatePages | Integer | 导航页码数 | 1 | |
navigatepageNums | Array of Integers | 所有导航页号 | ||
list | Array of Objects | 结果集(每页显示的数据) | T | |
表 T |
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
resultStatus | Integer | 任务状态 | 1 | |
jobId | Integer | 任务ID | 3298 | |
prodInstName | String | 实例名称 | Rds-e038 | |
createTime | Integer | 创建时间 | 1662949097000 | |
prodInstId | Integer | 实例ID | 7788 | |
operateName | String | 操作名称 | RestartInstance |
枚举参数
无
请求示例
请求url
/v1/rdsConsole/task-center/getTaskList?pageNow=1&pageSize=10&outerProdInstId=test2
请求头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
}
}
状态码
请参考 状态码
错误码
请参考 错误码