查询正在处理的任务信息 - ListRunningTask
功能介绍
查询正在处理的任务信息。
调用方法
请参见如何调用API。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,需具备如下身份策略权限。
授权项
访问级别
资源类型(*为必须)
条件键
别名
依赖的授权项
kps::getRunningTask
List
-
-
- kps:domainKeypairs:getrunningtask
-
URI
GET /v3/{project_id}/running-tasks
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
项目ID |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
limit |
否 |
Integer |
每页显示的条目数量。默认值1000。 |
|
offset |
否 |
Integer |
首个展示的正在处理任务信息的偏移量 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 |
响应参数
状态码:200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
total |
Integer |
正在处理的任务总数。 |
|
tasks |
Array of RunningTasks objects |
正在处理的任务列表。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
task_id |
String |
虚拟机ID |
|
operate_type |
String |
操作类型。
|
|
task_time |
String |
任务时间 |
|
server_name |
String |
虚拟机名称 |
|
server_id |
String |
虚拟机ID |
|
keypair_name |
String |
密钥对名称 |
状态码:400
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码 |
|
error_msg |
String |
错误描述 |
请求示例
无
响应示例
状态码:200
OK
{
"total" : 1,
"tasks" : [ {
"task_id" : "aee8d2fe-5484-4753-9177-5a38dc15546c",
"operate_type" : "RUNNING_RESET",
"task_time" : "1523342130000",
"server_name" : "Test",
"server_id" : "c9aa197b-a6b6-4c33-b3a6-fa0b4ec50006",
"keypair_name" : "KeyPair-xt"
} ]
}
状态码:400
Error response
{
"error_code" : "KPS.XXX",
"error_msg" : "XXX"
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
OK |
|
400 |
Error response |
错误码
请参见错误码。