分布式消息服务RocketMQ版
分布式消息服务RocketMQ版
- 最新动态
- 功能总览
- 服务公告
- 产品介绍
- 计费说明
- 快速入门
- 用户指南
- 最佳实践
- 开发指南
- API参考
- SDK参考
- 常见问题
- 视频帮助
- 文档下载
- 通用参考
链接复制成功！
查询后台任务管理中的指定记录
功能介绍
查询后台任务管理中的指定记录。
调用方法
请参见如何调用API。
URI
GET /v2/{project_id}/instances/{instance_id}/tasks/{task_id}
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
参数解释： 项目ID，获取方式请参见获取项目ID。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 |
|
instance_id |
是 |
String |
参数解释： 实例ID。获取方法如下：登录RocketMQ控制台，在RocketMQ实例详情页面查找实例ID。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 |
|
task_id |
是 |
String |
参数解释： 任务ID。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 |
请求参数
无
响应参数
状态码：200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
task_count |
String |
参数解释： 任务数量。 取值范围： 不涉及。 |
|
tasks |
Array of tasks objects |
参数解释： 任务列表。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
id |
String |
参数解释： 任务ID。 取值范围： 不涉及。 |
|
name |
String |
参数解释： 任务名称。 取值范围： 不涉及。 |
|
user_name |
String |
参数解释： 用户名。 取值范围： 不涉及。 |
|
user_id |
String |
参数解释： 用户ID。 取值范围： 不涉及。 |
|
params |
String |
参数解释： 任务参数。 取值范围： 不涉及。 |
|
status |
String |
参数解释： 任务状态。 取值范围： 不涉及。 |
|
created_at |
String |
参数解释： 启动时间。 取值范围： 不涉及。 |
|
updated_at |
String |
参数解释： 结束时间。 取值范围： 不涉及。 |
请求示例
GET https://{endpoint}/v2/{project_id}/instances/{instance_id}/tasks/{task_id}响应示例
状态码：200
查询成功。
{
"task_count" : "1",
"tasks" : [ {
"id" : "ff80808272dcc90f0172df1e490f41b0",
"name" : "bindInstancePublicIp",
"user_name" : "dms_test",
"user_id" : "xxxxxxxx93ff484a828144c6xxxxxxxx",
"params" : "{\"public_ip_id\":\"06a13350-4305-4338-9f0e-6b322bb1413d\",\"public_ip_address\":\"xx.xx.xx.xx\",\"enable_public_ip\":true}",
"status" : "SUCCESS",
"created_at" : "2020-06-23T03:00:03.471Z",
"updated_at" : "2020-06-23T03:00:08.130Z"
} ]
}状态码
|
状态码 |
描述 |
|---|---|
|
200 |
查询成功。 |
错误码
请参见错误码。
父主题： 后台任务管理
