文档首页/ 云数据库 RDS/ API参考/ API v3（推荐）/ 获取任务信息/ 获取指定ID的任务信息

更新时间：2024-03-28 GMT+08:00

查看PDF

获取指定ID的任务信息

功能介绍

获取云数据库 RDS任务中心指定ID的任务信息。

调用接口前，您需要了解API 认证鉴权。

接口约束

RDS的job是异步的。job生成后，通常需要数秒之后才能查询到job ID。
该接口只可查询任务中心一个月内的异步任务。
目前支持查询的主要异步任务：创建实例(单实例/主备实例)、创建只读实例、删除实例、单实例转主备实例、主备切换、磁盘扩容、绑定和解绑弹性IP、规格变更、恢复到新实例、RDS for MySQL实例迁移可用区、RDS for MySQL实例小版本升级、RDS for MySQL表级时间点恢复等。

URI

URI格式
 GET /v3/{project_id}/jobs?id={id}

参数说明

表1 参数说明
名称	是否必选	说明
project_id	是	租户在某一Region下的项目ID。获取方法请参见获取项目ID。
id	是	任务ID。

请求消息

请求参数
 无。
URI样例
 GET https://{endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/jobs?id=a9767ede-fe0f-4888-9003-e843a4c90514

响应消息

正常响应要素说明

表2 参数说明
名称	参数类型	说明
job	Object	任务信息，请参见表3。

表3 job字段数据结构说明
名称	参数类型	说明
id	String	任务ID。
name	String	任务名称。
status	String	任务执行状态。取值：值为“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%”，表示任务执行进度为60%，否则返回“”。
instance	Object	执行任务的实例信息。请参见表4。
entities	Object	根据不同的任务，显示不同的内容。请参见如下各表：表5 表8 表10 表11 说明：未有entities字段说明的异步任务，返回为{}。
fail_reason	String	任务执行失败时的错误信息。

表4 instances字段数据结构说明
名称	参数类型	说明
id	String	实例ID。
name	String	实例名称。

表5 entities字段数据结构说明(创建实例，单转主备，创建只读实例)
名称	参数类型	说明
instance	Object	任务想要实现的实例信息。请参见表6。
resource_ids	List<String>	任务涉及到的资源ID。

表6 entities.instance字段数据结构说明
名称	参数类型	说明
endpoint	String	实例的连接地址。
type	String	实例类型，取值为“Single”,“Ha”或“Replica”,分别对应于单机实例、主备实例、只读实例。
datastore	Object	数据库信息，请参见表7。
replica_of	String	主实例ID，仅创建只读实例的时候返回。

表7 datastore字段数据结构说明
名称	参数类型	说明
type	String	数据库引擎。
version	String	数据库版本。

表8 entities字段数据结构说明(调整实例容量)
名称	参数类型	说明
volume	Object	调整实例容量任务的磁盘信息。详情请参见表9。
resource_ids	List<String>	任务涉及到的资源ID。

表9 volume字段数据结构说明
名称	参数类型	说明
type	String	磁盘类型。
original_size	String	实例原本的磁盘大小（单位：GB）。
target_size	String	任务的目标磁盘大小（单位：GB）。

**表10** entities字段数据结构说明(绑定/解绑弹性IP，开启远程连接)
名称	参数类型	说明
public_ip	String	任务实现的弹性公网IP。

**表11** entities字段数据结构说明(主备倒换)
名称	参数类型	说明
switch_strategy	String	主备倒换策略。

响应样例中取任务中心部分任务作为示例。

正常响应样例

创建实例：

{
	"job": {
		"id": "31b8ae23-c687-4d80-b7b4-42a66c9bb886",
		"name": "CreateMysqlSingleHAInstance",
		"status": "Completed",
		"created": "2018-08-06T10:41:14+0000",
		"ended": "2018-08-06T16:41:14+0000",
		"process": "",
		"instance": {
			"id": "a48e43ff268f4c0e879652d65e63d0fbin01",
			"name": "DO-NOT-TOUCH-mgr2-mysql-single"
		},
		"entities": {
			"instance": {
				"endpoint": "192.168.1.203:3306",
				"type": "Single",
				"datastore": {
					"type": "mysql",
					"version": "5.7"
				}
			},
			"resource_ids": ["a48e43ff268f4c0e879652d65e63d0fbin01.vm", "a48e43ff268f4c0e879652d65e63d0fbin01.volume"]
		}
	}
}

创建只读实例：

{
	"job": {
		"id": "31b8ae23-c687-4d80-b7b4-42a66c9bb886",
		"name": " CreateMysqlReplicaInstance",
		"status": "Completed",
		"created": "2018-08-06T10:41:14+0000",
		"ended": "2018-08-06T16:41:14+0000",
		"process": "",
		"instance": {
			"id": "288caaa9d05f4ec1a1f58de2e0945685in01",
			"name": "mysql-replica"
		},
		"entities": {
			"instance": {
				"endpoint": "192.168.1.203:3306",
				"type": "replica",
				"datastore": {
					"type": "mysql",
					"version": "5.7"
				},
				"replica_of": "a48e43ff268f4c0e879652d65e63d0fbin01"
			},
			"resource_ids": ["288caaa9d05f4ec1a1f58de2e0945685in01.vm", "288caaa9d05f4ec1a1f58de2e0945685in01.volume"]
		}
	}
}

绑定弹性公网IP：

{
	"job": {
		"id": "31b8ae23-c687-4d80-b7b4-42a66c9bb886",
		"name": "MysqlBindEIP",
		"status": "Completed",
		"created": "2018-08-06T10:41:14+0000",
		"ended": "2018-08-06T16:41:14+0000",
		"process": "",
		"instance": {
			"id": "a48e43ff268f4c0e879652d65e63d0fbin01",
			"name": "DO-NOT-TOUCH-mgr2-mysql-single"
		},
		"entities": {
			"public_ip": "10.10.10.1"
		}
	}
}

重启实例：

{
	"job": {
		"id": "31b8ae23-c687-4d80-b7b4-42a66c9bb886",
		"name": " RestartMysqlInstance",
		"status": "Completed",
		"created": "2018-08-06T10:41:14+0000",
		"ended": "2018-08-06T16:41:14+0000",
		"process": "",
		"instance": {
			"id": "a48e43ff268f4c0e879652d65e63d0fbin01",
			"name": "DO-NOT-TOUCH-mgr2-mysql-single"
		},
		"entities": {}
	}
}

任务正在执行中：

{
	"job": {
		"id": "31 b8ae23 - c687 - 4 d80 - b7b4 - 42 a66c9bb886",
		"name": "CreateMysqlSingleHAInstance”，“ status”: “Running",
		"created": "2018-08-06T10:41:14+0000",
		"process": "60 % ",
		"instance": {
			"id": "a48e43ff268f4c0e879652d65e63d0fbin01",
			"name": "DO-NOT-TOUCH-mgr2-mysql-single"
		},
		"entities": {
			"instance": {
				"type": "Single",
				"datastore": {
					"type": "mysql",
					"version": "5.7"
				}
			}
		}
	}
}

任务执行失败：

{
	"job": {
		"id": "31 b8ae23 - c687 - 4 d80 - b7b4 - 42 a66c9bb886",
		"name": "CreateMysqlSingleHAInstance",
		"status": "Failed",
		"created": "2018-08-06T10:41:14+0000",
		"ended": "2018-08-06T16:41:14+0000",
		"process": "",
		"instance": {
			"id": "a48e43ff268f4c0e879652d65e63d0fbin01",
			"name": "DO-NOT-TOUCH-mgr2-mysql-single"
		},
		"entities": {
			"instance": {
				"type": "Single",
				"datastore": {
					"type": "mysql",
					"version": "5.7"
				}
			}
		},
		"fail_reason": "createVM failed."
	}
}

{
	"job": {
		"id": "31 b8ae23 - c687 - 4 d80 - b7b4 - 42 a66c9bb886",
		"name": "CreatePostgresqlSingleHAInstance",
		"status": "Failed",
		"created": "2018-08-06T10:41:14+0000",
		"ended": "2018-08-06T16:41:14+0000",
		"process": "",
		"instance": {
			"id": "a48e43ff268f4c0e879652d65e63d0fbin01",
			"name": "DO-NOT-TOUCH-mgr2-postgresql-single"
		},
		"entities": {
			"instance": {
				"type": "Single",
				"datastore": {
					"type": "postgresql",
					"version": "9.6"
				}
			}
		},
		"fail_reason": "createVM failed."
	}
}

异常响应
 请参见异常请求结果。

状态码

正常
 200
异常
 请参见状态码。

错误码

请参见错误码。

父主题： 获取任务信息

上一篇：获取任务信息

下一篇：获取指定实例和时间范围的任务信息（SQL Server）

意见反馈

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

有帮助没帮助

提供反馈

提交成功！非常感谢您的反馈，我们会继续努力做到更好！

系统繁忙，请稍后重试

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

内容与产品页面不一致

内容不易理解

缺失示例代码

步骤不可操作

搜不到想要的内容

缺少最佳实践

意见反馈（选填）

0/500

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

字符长度不能超过500

直接提交取消