Querying Running Tasks

Function

This API is used to query running tasks.

Calling Method

For details, see Calling APIs.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
If you are using identity policy-based authorization, the following identity policy-based permissions are required.

Action

Access Level

Resource Type (*: required)

Condition Key

Alias

Dependencies

kps::getRunningTask

List

-

-

kps:domainKeypairs:getrunningtask

-

Action	Access Level	Resource Type (*: required)	Condition Key	Alias	Dependencies
kps::getRunningTask	List	-	-	kps:domainKeypairs:getrunningtask	-

URI

GET /v3/{project_id}/running-tasks

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Definition Project ID. For details, see Obtaining a Project ID. Constraints N/A Range The value returned by the IAM API is used, which contains 32 characters. Default Value N/A

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
limit	No	Integer	Definition Number of running tasks returned on each page Constraints N/A Range N/A Default Value 1000
offset	No	Integer	Definition Index location. The query starts from the next data specified by offset. When you query resources on subsequent pages, set offset to the location returned in the response body for the previous query. Constraints The value of offset must be a non-negative number. Range N/A Default Value N/A

Request Parameters

**Table 3** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Definition User token. It can be obtained by calling the IAM API. The value of X-Subject-Token in the response header is the user token. Constraints N/A Range Obtain the value by calling the IAM API for obtaining the user token. Default Value N/A

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
total	Integer	Definition Total number of running tasks Range N/A
tasks	Array of RunningTasks objects	Definition List of running tasks Range N/A

**Table 5** RunningTasks
Parameter	Type	Description
task_id	String	Definition Task ID Range N/A
operate_type	String	Definition Operation type Range FAILED_RESET: reset FAILED_REPLACE: replace FAILED_UNBIND: unbind
task_time	String	Definition Task time Range N/A
server_name	String	Definition VM name Range N/A
server_id	String	Definition VM ID Range N/A
keypair_name	String	Definition Key pair name Range N/A

Example Requests

None

Example Responses

Status code: 200

{
  "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"
  } ]
}