获取指定ID的任务信息
接口约束
- 该接口只可查询任务中心一个月内的异步任务。
- job生成后,通常需要数秒之后才能查询到job ID。
URI
GET /v3/{project_id}/jobs
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
参数解释: 租户在某一Region下的project ID。 获取方法请参见获取项目ID。 约束限制: 不涉及。 取值范围: 只能由英文字母、数字组成,且长度为32个字符。 默认值: 不涉及。 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
参数解释: 用户Token。 通过调用IAM服务获取用户Token接口获取。 请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。 约束限制: 不涉及。 取值范围: 不涉及。 默认值: 不涉及。 |
X-Language |
否 |
String |
参数解释: 请求语言类型。 约束限制: 不涉及。 取值范围:
默认值: en-us。 |
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
job |
GetJobInfoDetail object |
参数解释: 任务信息。 |
参数 |
参数类型 |
描述 |
---|---|---|
id |
String |
参数解释: 任务ID。 取值范围: 与入参保持一致。 |
name |
String |
参数解释: 任务名称。 取值范围: 不涉及。 |
status |
String |
参数解释: 任务执行状态。 取值范围:
|
created |
String |
参数解释: 创建时间,格式为"yyyy-mm-ddThh:mm:ssZ"。其中,T指某个时间的开始;Z指时区偏移量,例如偏移1个小时显示为+0100。 取值范围: 不涉及。 |
ended |
String |
参数解释: 结束时间,格式为"yyyy-mm-ddThh:mm:ssZ"。其中,T指某个时间的开始;Z指时区偏移量,例如偏移1个小时显示为+0100。 取值范围: 不涉及。 |
process |
String |
参数解释: 任务执行进度。 取值范围: 执行中状态才返回执行进度,例如60%,否则返回""。 |
instance |
GetJobInstanceInfoDetail object |
参数解释: 指定ID任务的实例信息。 |
entities |
Object |
参数解释: 根据不同的任务,显示不同的内容。 |
fail_reason |
String |
参数解释: 任务执行失败时的错误信息。 取值范围: 不涉及。 |
参数 |
参数类型 |
描述 |
---|---|---|
id |
String |
参数解释: 实例ID,此参数是实例的唯一标识。 取值范围: 只能由英文字母、数字组成,后缀为in07,长度为36个字符。 |
name |
String |
参数解释: 实例名称。 取值范围: 最小为4个字符,最大为64个字符且不超过64个字节(注意:一个中文字符占用3个字节),必须以字母或中文开头,区分大小写,可以包含字母、数字、中划线、下划线或中文,不能包含其他特殊字符。 |
状态码: 400
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码。 |
error_msg |
String |
错误消息。 |
状态码: 500
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码。 |
error_msg |
String |
错误消息。 |
请求示例
获取指定ID的任务信息。
GET https://{endpoint}/v3/054e292c9880d4992f02c0196d3ea468/jobs?id=a9767ede-fe0f-4888-9003-e843a4c90514
响应示例
状态码: 200
响应样例中取任务中心部分任务作为示例。
Success.
{ "job" : { "id" : "31b8ae23-c687-4d80-b7b4-42a66c9bb886", "name" : "CreateGaussDBforMySQLInstance", "status" : "Completed", "created" : "2018-08-06T10:41:14+0800", "ended" : "2018-08-06T16:41:14+0000", "process" : "", "instance" : { "id" : "a48e43ff268f4c0e879652d65e63d0fbin07", "name" : "DO-NOT-TOUCH-mgr2-mysql-single" }, "entities" : { "instance" : { "endpoint" : "192.168.1.203:3306", "type" : "Cluster", "datastore" : { "type" : "gaussdb-mysql", "version" : "8.0" } }, "resource_ids" : [ "a48e43ff268f4c0e879652d65e63d0fbin07.vm", "a48e43ff268f4c0e879652d65e63d0fbin07.volume" ] } } }
状态码
请参见状态码。
错误码
请参见错误码。