Querying Task Information

This API is used to query the task status based on the task ID returned by the SSH key pair API.

For details, see Calling APIs.

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::getTask

List

-

-

kps:domainKeypairs:gettask

-

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

GET /v3/{project_id}/tasks/{task_id}

**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
task_id	Yes	String	Definition Key pair task ID Constraints N/A Range N/A Default Value N/A

**Table 2** 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

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
server_id	String	Definition Tenant VM ID Range N/A
task_id	String	Definition Task ID returned when a task is delivered Range N/A
task_status	String	Definition Current status of the key pair task Range READY_RESET: To be reset RUNNING_RESET: Being reset FAILED_RESET: Reset failed SUCCESS_RESET: Reset succeeded READY_REPLACE: To be replaced RUNNING_REPLACE: Being replaced FAILED_RESET: Replacement failed SUCCESS_RESET: Replacement succeeded READY_UNBIND: To be unbound RUNNING_UNBIND: Being unbound FAILED_UNBIND: Unbinding failed SUCCESS_UNBIND: Unbinding succeeded

None

Status code: 200

{
  "task_id" : "aee8d2fe-5484-4753-9177-5a38dc15546c",
  "task_status" : "RUNNING_RESET",
  "server_id" : "c9aa197b-a6b6-4c33-b3a6-fa0b4ec50006"
}

Status Code	Description
200	OK

Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.

The system is busy. Please try again later.

For any further questions, feel free to contact us through the chatbot.