本文导读

功能介绍
接口约束
调试
URI
请求参数
响应参数
请求示例
响应示例
状态码
错误码

展开导读

文档首页/ 云数据库 TaurusDB/ API参考/ API（即将下线）/ 获取任务信息/ 获取指定ID的任务信息

获取指定ID的任务信息

更新时间：2024-12-02 GMT+08:00

查看PDF

功能介绍

获取指定ID的任务信息。

须知：

该接口计划于2025-03-31下线，建议及时切换到新接口获取指定ID的任务信息。

接口约束

该接口只可查询任务中心一个月内的异步任务。

调试

您可以在API Explorer中调试该接口。

URI

GET /mysql/v3/{project_id}/jobs

表1 路径参数
参数	是否必选	参数类型	描述
project_id	是	String	租户在某一region下的project ID。获取方法请参见获取项目ID。

表2 Query参数
参数	是否必选	参数类型	描述
id	是	String	任务ID。

请求参数

表3 请求Header参数
参数	是否必选	参数类型	描述
x-auth-token	是	String	用户Token。通过调用IAM服务获取用户Token接口获取。请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。
X-Language	否	String	请求语言类型。默认en-us。取值范围： en-us zh-cn

响应参数

状态码： 200

表4 响应Body参数
参数	参数类型	描述
job	GetJobInfoDetail object	任务信息。

表5 GetJobInfoDetail
参数	参数类型	描述
id	String	任务ID。
name	String	任务名称。
status	String	任务执行状态。取值：值为“Running”，表示任务正在执行。值为“Completed”，表示任务执行成功。值为“Failed”，表示任务执行失败。枚举值： Running Completed Failed
created	String	创建时间，格式为"yyyy-mm-ddThh:mm:ssZ"。其中，T指某个时间的开始；Z指时区偏移量，例如北京时间偏移显示为 +0800 说明：创建时返回值为空，数据库实例创建成功后该值不为空。
ended	String	结束时间，格式为"yyyy-mm-ddThh:mm:ssZ"。其中，T指某个时间的开始；Z指时区偏移量，例如北京时间偏移显示为 +0800 说明：创建时返回值为空，数据库实例创建成功后该值不为空。
process	String	任务执行进度。执行中状态才返回执行进度，例如60%，否则返回""。
instance	GetJobInstanceInfoDetail object	指定ID任务的实例信息。
entities	Object	根据不同的任务，显示不同的内容。
fail_reason	String	任务执行失败时的错误信息。

表6 GetJobInstanceInfoDetail
参数	参数类型	描述
id	String	实例ID。
name	String	实例名称。

状态码： 400

表7 响应Body参数
参数	参数类型	描述
error_code	String	错误码。
error_msg	String	错误消息。

状态码： 500

表8 响应Body参数
参数	参数类型	描述
error_code	String	错误码。
error_msg	String	错误消息。

请求示例

GET https://{endpoint}/mysql/v3/054e292c9880d4992f02c0196d3ea468/jobs?id=a9767ede-fe0f-4888-9003-e843a4c90514

响应示例

状态码： 200

Success.

{
  "job" : {
    "id" : "31b8ae23-c687-4d80-b7b4-42a66c9bb886",
    "name" : "CreateMysqlInstance",
    "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" ]
    }
  }
}

状态码

状态码	描述
200	Success.
400	Client error.
500	Server error.

错误码

请参见错误码。

父主题： 获取任务信息

上一篇：获取任务信息

下一篇：权限策略和授权项

意见反馈

文档内容是否对您有帮助？

有帮助没帮助

提供反馈

提交成功！非常感谢您的反馈，我们会继续努力做到更好！您可在我的云声建议查看反馈及问题处理状态。

系统繁忙，请稍后重试

在使用文档中是否遇到以下问题

内容与产品页面不一致

内容不易理解

缺失示例代码

步骤不可操作

搜不到想要的内容

缺少最佳实践

意见反馈（选填）

0/500

请至少选择一项反馈信息并填写问题反馈

字符长度不能超过500

直接提交取消

如您有其它疑问，您也可以通过华为云社区问答频道来与我们联系探讨

智能客服提问云社区提问

获取指定ID的任务信息

功能介绍

接口约束

调试

URI

请求参数

响应参数

请求示例

响应示例

状态码

错误码

相关文档

意见反馈

文档内容是否对您有帮助？

7*24

备案

专业服务

退订

建议反馈

售前咨询热线

文档反馈