All Products
Search
Document Center

Key Management Service:GetJob

Last Updated:Apr 17, 2025

Queries the details of an asynchronous task.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • For mandatory resource types, indicate with a prefix of * .
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
yundun-hsm:GetJobget
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
JobIdstringYes

The ID of the task.

job-202401250936hze747fd7e0007005

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

Jobobject

The details of the task.

Completedboolean

Indicates whether the task is complete. Valid values:

  • true
  • false
true
Errorstring

The error message returned if the task fails.

OperationTimeout
JobIdstring

The ID of the task.

job-202401250936hze747fd7e0007005
Progresslong

The progress of the task. Unit: percent (%).

95
Responsestring

The response returned after the task succeeds.

success
Statusstring

The task status. Valid values:

  • success
  • running
  • fail
  • cancel
fail
Typestring

The operation type. Valid values:

  • create
  • cancel
create
RequestIdstring

The request ID.

4C467B38-3910-447D-87BC-AC049166F216

Examples

Sample success responses

JSONformat

{
  "Job": {
    "Completed": true,
    "Error": "OperationTimeout",
    "JobId": "job-202401250936hze747fd7e0007005",
    "Progress": 95,
    "Response": "success",
    "Status": "fail",
    "Type": "create"
  },
  "RequestId": "4C467B38-3910-447D-87BC-AC049166F216"
}

Error codes

For a list of error codes, visit the Service error codes.