Help Center> Data Encryption Workshop> API Reference> APIs> Key Pair Management APIs> Key Pair Task Management> Query running tasks
View PDF

Query running tasks

Function

This API is used to query running tasks.

URI

GET /v3/{project_id}/running-tasks

Table 1 Path parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token. The token can be obtained by calling the IAM API (value of X-Subject-Token in the response header).

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

total

Integer

Total number of running tasks.

tasks

Array of RunningTasks objects

List of running tasks.
Table 4 RunningTasks

Parameter

Type

Description

task_id

String

VM ID.

operate_type

String

Operation type. It can be:

  • FAILED_RESET: reset

  • FAILED_REPLACE: replace

  • FAILED_UNBIND: unbind

task_time

String

Task time.

server_name

String

VM name.

server_id

String

VM ID.

keypair_name

String

Key pair name.

Status code: 400

Table 5 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Example Requests

None

Example Responses

Status code: 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"
  } ]
}

Status code: 400

Error occurred.

{
  "error_code" : "KPS.XXX",
  "error_msg" : "XXX"
}

Status Codes

Status Code

Description

200

OK.

400

Error occurred.

Error Codes

See Error Codes.

Parent topic: Key Pair Task Management