Help Center/ Data Encryption Workshop/ API Reference/ APIs/ Key Pair Management APIs/ Key pair task management/ Querying Task Failure Information
Updated on 2025-10-16 GMT+08:00
View PDF
Share

Querying Task Failure Information

Function

Queries information about failed tasks, such as binding and unbinding 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::getFailedTask

    List

    -

    -
    • kps:domainKeypairs:getfailtask

    -

URI

GET /v3/{project_id}/failed-tasks

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID.
Table 2 Query Parameters

Parameter

Mandatory

Type

Description

limit

No

Integer

Specifies the number of items displayed per page. Default value: 1000

offset

No

Integer

Offset of the failed task information list.

Request Parameters

Table 3 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token.

Can be obtained by calling the IAM API for obtaining the user token (the value of X-Subject-Token in the response header).

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

total

Integer

Total number of failed tasks.

tasks

Array of FailedTasks objects

List of failed tasks.
Table 5 FailedTasks

Parameter

Type

Description

task_id

String

VM ID.

operate_type

String

Operation type of a task. It can be:

- FAILED_RESET: reset

- FAILED_REPLACE: replace

- FAILED_UNBIND: unbind

task_time

String

Task time

task_error_code

String

Error code of a task failure

task_error_msg

String

Error code of a task failure

server_name

String

VM Name

server_id

String

VM ID.

keypair_name

String

Key pair name

Status code: 400

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Error Codes

error_msg

String

Description

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",
    "task_error_code" : null,
    "task_error_msg" : "Update public key error",
    "server_name" : "Test",
    "server_id" : "c9aa197b-a6b6-4c33-b3a6-fa0b4ec50006",
    "keypair_name" : "KeyPair-xt"
  } ]
}

Status code: 400

Error response

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

Status Codes

Status Code

Description

200

OK

400

Error response

Error Codes

See Error Codes.

Parent Topic: Key pair task management