文档首页/ 高性能弹性文件服务 SFS Turbo/ API参考/ API/ 任务管理/ 查询job的状态详情 - ShowJobDetail
更新时间:2026-10-10 GMT+08:00
分享

查询job的状态详情 - ShowJobDetail

功能介绍

用于查询SFS Turbo异步API的执行状态。例如:可使用调用创建并绑定LDAP配置接口时返回的jobId,通过该接口查询job的执行状态。

调试

您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。

授权信息

账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限,具体权限要求请参见权限和授权项。

URI

GET /v1/{project_id}/sfs-turbo/jobs/{job_id}

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释:

项目ID,用于标识资源所属的IAM项目空间,实现项目级资源隔离与权限管控。

获取方法请参见获取项目ID。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

job_id

是

String

参数解释:

任务ID,用于唯一标识一个异步任务。

可通过调用创建并绑定LDAP配置、加入AD域等接口响应获取。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释:

用户Token,用于鉴权认证。

通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

Content-Type

是

String

参数解释:

请求消息体MIME类型,用于标识请求正文的数据格式。

约束限制:

不涉及。

取值范围:

application/json

默认取值:

application/json

响应参数

状态码:200

表3 响应Header参数

参数

参数类型

描述

X-request-id

String

参数解释:

请求ID,用于唯一标识和追踪本次请求。

取值范围:

不涉及。

表4 响应Body参数

参数

参数类型

描述

status

String

参数解释:

任务执行状态,用于标识异步任务的当前执行进度。

取值范围:

  • success:表示任务执行成功。

  • failed:表示任务执行失败。

  • waiting:表示等待执行任务。

  • running:表示任务运行中。

job_id

String

参数解释:

任务ID,用于唯一标识异步任务。

取值范围:

不涉及。

job_type

String

参数解释:

任务类型,用于标识异步任务的类型。

取值范围:

  • create_share:表示创建文件系统。

  • hpc_create_share:表示创建文件系统。

  • delete_share:表示删除文件系统。

  • extend_share:表示扩容文件系统。

  • change_security_group:表示修改文件系统绑定的安全组。

  • create_obs_target:表示绑定OBS后端存储。

  • delete_obs_target:表示删除OBS后端存储。

  • add_ad_domain:表示加入AD域。

  • change_ad_domain:表示修改AD域。

  • quit_ad_domain:表示退出AD域。

  • bind_ldap:表示创建并绑定LDAP配置。

  • unbind_ldap:表示删除LDAP配置。

  • update_ldap:表示修改LDAP配置。

begin_time

String

参数解释:

任务开始执行时间。

采用UTC时间,格式为yyyy-mm-dd hh:mm:ss,例如2016-01-02 15:04:05。

取值范围:

不涉及。

end_time

String

参数解释:

任务结束执行时间。

采用UTC时间,格式为yyyy-mm-dd hh:mm:ss,例如2016-01-02 15:04:05。

取值范围:

不涉及。

error_code

String

参数解释:

job执行失败时的错误码。仅当status为failed时返回。

取值范围:

不涉及。

fail_reason

String

参数解释:

job执行失败时的错误原因。仅当status为failed时返回。

取值范围:

不涉及。

sub_jobs

Array of GetSubJobDetail objects

参数解释:

子任务列表,包含当前任务下的所有子任务及其执行状态信息。

取值范围:

不涉及。

表5 GetSubJobDetail

参数

参数类型

描述

status

String

参数解释:

子任务执行状态,用于标识子任务的当前执行进度。

取值范围:

  • success:表示子任务执行成功。

  • failed:表示子任务执行失败。

  • waiting:表示子任务等待执行。

  • running:表示子任务运行中。

job_id

String

参数解释:

子任务ID,用于唯一标识子任务。

取值范围:

不涉及。

job_type

String

参数解释:

子任务类型,用于标识子任务的类型。

取值范围:

  • create_share:表示创建文件系统。

  • hpc_create_share:表示创建文件系统。

  • delete_share:表示删除文件系统。

  • extend_share:表示扩容文件系统。

  • change_security_group:表示修改文件系统绑定的安全组。

  • create_obs_target:表示绑定OBS后端存储。

  • delete_obs_target:表示删除OBS后端存储。

  • add_ad_domain:表示加入AD域。

  • change_ad_domain:表示修改AD域。

  • quit_ad_domain:表示退出AD域。

  • bind_ldap:表示创建并绑定LDAP配置。

  • unbind_ldap:表示删除LDAP配置。

  • update_ldap:表示修改LDAP配置。

begin_time

String

参数解释:

子任务开始执行时间。

采用UTC时间,格式为yyyy-mm-dd hh:mm:ss,例如2016-01-02 15:04:05。

取值范围:

不涉及。

end_time

String

参数解释:

子任务结束执行时间。

采用UTC时间,格式为yyyy-mm-dd hh:mm:ss,例如2016-01-02 15:04:05。

取值范围:

不涉及。

error_code

String

参数解释:

子任务执行失败时的错误码。仅当status为failed时返回。

取值范围:

不涉及。

fail_reason

String

参数解释:

子任务执行失败时的错误原因。仅当status为failed时返回。

取值范围:

不涉及。

状态码:400

表6 响应Header参数

参数

参数类型

描述

X-request-id

String

参数解释:

请求ID,用于唯一标识和追踪本次请求。

取值范围:

不涉及。

表7 响应Body参数

参数

参数类型

描述

errCode

String

参数解释:

错误码,用于标识请求失败的原因。详细错误码请参见错误码。

取值范围:

不涉及。

errMsg

String

参数解释:

错误描述,用于描述请求失败的具体原因,便于排查问题。请参见错误码。

取值范围:

不涉及。

状态码:404

表8 响应Header参数

参数

参数类型

描述

X-request-id

String

参数解释:

请求ID,用于唯一标识和追踪本次请求。

取值范围:

不涉及。

表9 响应Body参数

参数

参数类型

描述

errCode

String

参数解释:

错误码,用于标识请求失败的原因。详细错误码请参见错误码。

取值范围:

不涉及。

errMsg

String

参数解释:

错误描述,用于描述请求失败的具体原因,便于排查问题。请参见错误码。

取值范围:

不涉及。

状态码:500

表10 响应Header参数

参数

参数类型

描述

X-request-id

String

参数解释:

请求ID,用于唯一标识和追踪本次请求。

取值范围:

不涉及。

表11 响应Body参数

参数

参数类型

描述

errCode

String

参数解释:

错误码,用于标识请求失败的原因。详细错误码请参见错误码。

取值范围:

不涉及。

errMsg

String

参数解释:

错误描述,用于描述请求失败的具体原因,便于排查问题。请参见错误码。

取值范围:

不涉及。

请求示例

无

响应示例

状态码:200

{
  "job_id" : "b959dfbb-1a2b-3c4d-5e6f-8930ec3a87b7",
  "status" : "success",
  "job_type" : "bind_ldap",
  "begin_time" : "2023-07-26 09:33:58",
  "end_time" : "2023-07-26 09:33:58"
}

状态码:400

{
  "errCode" : "SFS.TURBO.0001",
  "errMsg" : "parameter error"
}

状态码:404

{
  "errCode" : "SFS.TURBO.0001",
  "errMsg" : "parameter error"
}

状态码:500

{
  "errCode" : "SFS.TURBO.0005",
  "errMsg" : "Internal server error"
}

状态码

状态码

描述

200

响应Body参数

400

客户端错误

404

资源不存在

500

内部错误

错误码

请参见错误码。

相关文档