更新时间:2022-05-09 GMT+08:00
分享

查询后台任务列表

功能介绍

查询后台任务列表

调试

您可以在API Explorer中调试该接口,并获取该接口关联的CLI示例: hcloud DCS ListBackgroundTask

URI

GET /v2/{project_id}/instances/{instance_id}/tasks

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID。

instance_id

String

实例ID。

表2 Query参数

参数

是否必选

参数类型

描述

offset

Integer

偏移量,表示从此偏移量开始查询, offset大于等于0

limit

Integer

每页显示的条目数量。

start_time

String

查询开始时间,时间为UTC时间。格式:yyyyMMddHHmmss,如:20200609160000。

end_time

String

查询结束时间,时间为UTC时间。格式:yyyyMMddHHmmss,如:20200617155959。

请求参数

响应参数

状态码: 200

表3 响应Body参数

参数

参数类型

描述

task_count

String

任务个数

tasks

Array of SingleBackgroundTask objects

任务详情数组

表4 SingleBackgroundTask

参数

参数类型

描述

id

String

后台任务ID

name

String

后台任务名,目前支持以下取值:

ChangeInstanceSpec:变更规格

BindEip:开启公网访问

UnBindEip:关闭公网访问

AddReplica:添加副本

DelReplica:删除副本

AddWhitelist:设置IP白名单

UpdatePort:修改端口

RemoveIpFromDns:域名摘除IP

details

DetailsBody object

详细信息

user_name

String

用户名

user_id

String

用户ID

params

String

任务相关参数

status

String

任务状态

created_at

String

任务启动时间,格式为2020-06-17T07:38:42.503Z

updated_at

String

任务结束时间,格式为2020-06-17T07:38:42.503Z

表5 DetailsBody

参数

参数类型

描述

old_capacity

String

变更前的容量,仅在变更规格时有值

new_capacity

String

变更后的容量,仅在变更规格时有值

enable_public_ip

Boolean

是否开启公网访问,仅在开启公网访问时有值

public_ip_id

String

公网IP的ID,仅在开启公网访问时有值

public_ip_address

String

公网IP地址,仅在开启公网访问时有值

enable_ssl

Boolean

是否开启ssl,仅在开启ssl时有值

old_cache_mode

String

变更前的缓存类型,仅在变更规格时有值

new_cache_mode

String

变更后的缓存类型,仅在变更规格时有值

状态码: 400

表6 响应Body参数

参数

参数类型

描述

error_msg

String

错误信息

最大长度:1024

error_code

String

错误码

最大长度:9

error_ext_msg

String

扩展错误信息(暂未使用,赋值为null)

最大长度:1024

状态码: 401

表7 响应Body参数

参数

参数类型

描述

error_msg

String

错误信息

最大长度:1024

error_code

String

错误码

最大长度:9

error_ext_msg

String

扩展错误信息(暂未使用,赋值为null)

最大长度:1024

状态码: 403

表8 响应Body参数

参数

参数类型

描述

error_msg

String

错误信息

最大长度:1024

error_code

String

错误码

最大长度:9

error_ext_msg

String

扩展错误信息(暂未使用,赋值为null)

最大长度:1024

状态码: 404

表9 响应Body参数

参数

参数类型

描述

error_msg

String

错误信息

最大长度:1024

error_code

String

错误码

最大长度:9

error_ext_msg

String

扩展错误信息(暂未使用,赋值为null)

最大长度:1024

状态码: 500

表10 响应Body参数

参数

参数类型

描述

error_msg

String

错误信息

最大长度:1024

error_code

String

错误码

最大长度:9

error_ext_msg

String

扩展错误信息(暂未使用,赋值为null)

最大长度:1024

请求示例

GET https://{dcs_endpoint}/v2/a4d31cb6-3d72-4fdc-8ec9-6e3a41e47f71/instances/5560df16-cebf-4473-95c4-d1b573c16e79/tasks?offset=0&limit=10&begin_time=20200609160000&end_time=20200617155959

响应示例

状态码: 200

查询后台任务列表成功。

{
  "task_count" : 1,
  "tasks" : [ {
    "id" : "8abf6e1e72c12e7c0172c15b508500aa",
    "name" : "ChangeInstanceSpec",
    "user_name" : "paas_dcs_a00421997_02",
    "user_id" : "d53977d1adfb49c5b025ba7d33a13fd7",
    "details" : {
      "old_cache_mode" : "single",
      "new_cahce_mode" : "single",
      "old_capacity" : 0.125,
      "new_capacity" : 0.25
    }
  } ],
  "status" : "SUCCESS",
  "created_at" : "2020-06-17T08:18:06.597Z",
  "updated_at" : "2020-06-17T08:18:10.106Z"
}

状态码

状态码

描述

200

查询后台任务列表成功。

400

非法请求。

401

认证信息非法

403

请求被拒绝访问。

404

所请求的资源不存在。

500

内部服务错误。

错误码

请参见错误码

分享:

    相关文档

    相关产品

close