GetJobStatus - 获取异步API运行状态

更新时间:2025-04-03 10:41

返回异步任务的状态信息,调用异步化API后,通过轮训此API来获取成功状态。

调试

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

授权信息

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

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用前面加 * 表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
操作访问级别资源类型条件关键字关联操作
dataworks:GetJobStatusget
*全部资源
*

请求参数

名称类型必填描述示例值
名称类型必填描述示例值
JobIdstring

调用异步 API 后返回的任务 ID。

70ecdaec-bf21-4c11-8ecb-4f77453ceea8

返回参数

名称类型描述示例值
名称类型描述示例值
object

Schema of Response

RequestIdstring

请求 ID。

5E2BFE96-C0E0-5A98-85C8-633EC803198D
JobStatusobject

任务状态实时结果。

JobIdstring

异步任务 ID。

C664CDE3-9C0B-5792-B17F-6C543783BBBC
JobTypestring

任务类型。

  • Create:创建类任务。

  • Update:更新类任务。

  • Cancel:取消类任务。

Create
Completedstring

操作是否完成 True:当前 Job 已经执行完成。 False:当前 Job 还在执行中。

False
Statusstring

任务状态。取值:

  • Success:成功
  • Fail:失败
  • Cancel:取消
  • Running:执行中
Success
Errorstring

任务失败信息

Not Found
CreateTimestring

创建时间。

1729063449802

示例

正常返回示例

JSON格式

{
  "RequestId": "5E2BFE96-C0E0-5A98-85C8-633EC803198D",
  "JobStatus": {
    "JobId": "C664CDE3-9C0B-5792-B17F-6C543783BBBC",
    "JobType": "Create",
    "Completed": "False",
    "Status": "Success",
    "Error": "Not Found",
    "CreateTime": "1729063449802"
  }
}

错误码

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

变更历史

变更时间变更内容概要操作
变更时间变更内容概要操作
暂无变更历史
  • 本页导读 (1)
  • 调试
  • 授权信息
  • 请求参数
  • 返回参数
  • 示例
  • 错误码
  • 变更历史
文档反馈