GetJob - 获取异步任务_密钥管理服务(KMS)-阿里云帮助中心

获取异步任务的详细信息。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
yundun-hsm:GetJob	get	全部资源 *	无	无

请求参数

名称	类型	必填	描述	示例值
JobId	string	是	任务 ID。	job-202401250936hze747fd7e0007005

返回参数

名称	类型	描述	示例值
	object	响应信息。
RequestId	string	本次调用请求的 ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。	4C467B38-3910-447D-87BC-AC049166F216
Job	object	任务详情。
JobId	string	任务 ID。	job-202401250936hze747fd7e0007005
Type	string	操作类型。 create：创建任务 cancel：取消任务	create
Completed	boolean	任务是否完成。 true：已完成 false：未完成	true
Status	string	任务状态。 success：成功 running：执行中 fail：失败 cancel：取消	fail
Response	string	任务成功后返回的响应信息。	success
Error	string	任务失败时的错误信息。	OperationTimeout
Progress	long	任务执行进度。单位为百分比。	95

示例

正常返回示例

JSON格式

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

错误码

访问错误中心查看更多错误码。