查询job的状态详情
功能介绍
查询job的执行状态。 可用于查询SFS Turbo异步API的执行状态。例如:可使用调用创建并绑定ldap配置接口时返回的jobId,通过该接口查询job的执行状态。
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
URI
GET /v1/{project_id}/sfs-turbo/jobs/{job_id}
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
项目id |
job_id |
是 |
String |
job ID |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
账号的token |
Content-Type |
是 |
String |
MIME类型 |
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
X-request-id |
String |
请求ID |
参数 |
参数类型 |
描述 |
---|---|---|
status |
String |
job的状态。success:成功。running:运行中。failed:失败。waiting:等待执行 |
job_id |
String |
job的ID。 |
job_type |
String |
job的类型。 |
begin_time |
String |
job开始时间。UTC时间,格式:'2016-01-02 15:04:05' |
end_time |
String |
job结束时间。UTC时间,格式:'2016-01-02 15:04:05' |
error_code |
String |
job执行失败时的错误码 |
fail_reason |
String |
job执行失败时的错误原因 |
sub_jobs |
Array of GetSubJobDetail objects |
子任务列表 |
参数 |
参数类型 |
描述 |
---|---|---|
status |
String |
子job的状态。success:成功。running:运行中。failed:失败。waiting:等待执行。 |
job_id |
String |
job的ID。 |
job_type |
String |
子job的类型。 |
begin_time |
String |
job开始时间。UTC时间,格式:'2016-01-02 15:04:05' |
end_time |
String |
job结束时间。UTC时间,格式:'2016-01-02 15:04:05' |
error_code |
String |
job执行失败时的错误码 |
fail_reason |
String |
job执行失败时的错误原因 |
状态码: 400
参数 |
参数类型 |
描述 |
---|---|---|
errCode |
String |
错误码 |
errMsg |
String |
错误描述 |
状态码: 404
参数 |
参数类型 |
描述 |
---|---|---|
errCode |
String |
错误码 |
errMsg |
String |
错误描述 |
状态码: 500
参数 |
参数类型 |
描述 |
---|---|---|
errCode |
String |
错误码 |
errMsg |
String |
错误描述 |
请求示例
无
响应示例
状态码: 200
响应Body参数
{ "job_id" : "26f6b565-xxxx-XXXX-xxxx-03f0bd975433", "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 |
内部错误 |
错误码
请参见错误码。