查询后台任务列表

project_id

是

String

参数解释：

项目ID。获取方法请参见获取项目ID。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

instance_id

是

String

参数解释：

实例ID。可通过DCS控制台进入实例详情界面查看。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

offset

否

Integer

参数解释：

偏移量，表示生成的列表从此偏移量开始显示，例如偏移量为3时，生成的列表从第4条开始。

约束限制：

不涉及。

取值范围：

大于等于0。

默认取值：

0

limit

否

Integer

参数解释：

每页显示的条目数量。

约束限制：

不涉及。

取值范围：

1-1000

默认取值：

10

start_time

否

String

参数解释：

查询开始时间。

约束限制：

时间为UTC时间。格式：yyyyMMddHHmmss，如：20200609160000。

取值范围：

不涉及。

默认取值：

不涉及。

end_time

否

String

参数解释：

查询结束时间。

约束限制：

时间为UTC时间。格式：yyyyMMddHHmmss，如：20200609160000。

取值范围：

不涉及。

默认取值：

不涉及。

task_count

String

参数解释：

后台任务个数。

取值范围：

不涉及。

tasks

Array of SingleBackgroundTask objects

参数解释：

任务详情。

id

String

参数解释：

后台任务ID。

取值范围：

不涉及。

name

String

参数解释：

后台任务名。

取值范围：

• EXTEND：变更规格

• BindEip：开启公网访问

• UnBindEip：关闭公网访问

• AddReplica：添加副本

• DelReplica：删除副本

• AddWhitelist：设置IP白名单

• UpdatePort：修改端口

• RemoveIpFromDns：域名摘除IP

• masterStandbySwapJob: 主备切换任务

• modify：修改密码

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。

取值范围：

不涉及。

enable_show

Boolean

参数解释：

是否有详细任务进展，可以展开查看。

取值范围：

不涉及。

old_capacity

String

参数解释：

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

取值范围：

不涉及。

new_capacity

String

参数解释：

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

取值范围：

不涉及。

enable_public_ip

Boolean

参数解释：

是否开启公网访问。

取值范围：

• true：公网访问已开启。

• false：公网访问未开启。

public_ip_id

String

参数解释：

公网IP的ID。

取值范围：

不涉及。

public_ip_address

String

参数解释：

公网IP地址。

取值范围：

不涉及。

enable_ssl

Boolean

参数解释：

是否开启SSL。

取值范围：

• true：SSL已开启。

• false：SSL未开启。

old_cache_mode

String

参数解释：

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

取值范围：

不涉及。

new_cache_mode

String

参数解释：

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

取值范围：

不涉及。

old_resource_spec_code

String

参数解释：

变更前的规格参数，仅在变更规格时有值。

取值范围：

不涉及。

new_resource_spec_code

String

参数解释：

变更后的规格参数，仅在变更规格时有值。

取值范围：

不涉及。

old_replica_num

Integer

参数解释：

变更前的副本数量，仅在变更规格时有值。

取值范围：

不涉及。

new_replica_num

Integer

参数解释：

变更后的副本数量，仅在变更规格时有值。

取值范围：

不涉及。

old_cache_type

String

参数解释：

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

取值范围：

不涉及。

new_cache_type

String

参数解释：

变更后的规格类型，仅在变更规格时有值。

取值范围：

不涉及。

replica_ip

String

参数解释：

副本IP。

取值范围：

不涉及。

replica_az

String

参数解释：

副本所在可用区。

取值范围：

不涉及。

group_name

String

参数解释：

实例分片组名。

取值范围：

不涉及。

old_port

Integer

参数解释：

旧端口。

取值范围：

不涉及。

new_port

Integer

参数解释：

新端口。

取值范围：

不涉及。

is_only_adjust_charging

Boolean

参数解释：

是否只是调整计费模式。

取值范围：

• true：只调整计费模式。

• false：有其他变更内容或未调整计费模式。

account_name

String

参数解释：

账号名称。

取值范围：

不涉及。

source_ip

String

参数解释：

源IP。

取值范围：

不涉及。

target_ip

String

参数解释：

目标IP。

取值范围：

不涉及。

node_name

String

参数解释：

节点信息。

取值范围：

不涉及。

rename_commands

Array of strings

参数解释：

重命名的指令。

updated_config_length

Integer

参数解释：

更新配置项的长度。

取值范围：

不涉及。

error_msg

String

参数解释：

错误信息。

取值范围：

不涉及。

error_code

String

参数解释：

错误码。

取值范围：

请参见错误码。

error_ext_msg

String

参数解释：

扩展错误信息（暂未使用，赋值为null）。

取值范围：

不涉及。

error_msg

String

参数解释：

错误信息。

取值范围：

不涉及。

error_code

String

参数解释：

错误码。

取值范围：

请参见错误码。

error_ext_msg

String

参数解释：

扩展错误信息（暂未使用，赋值为null）。

取值范围：

不涉及。

error_msg

String

参数解释：

错误信息。

取值范围：

不涉及。

error_code

String

参数解释：

错误码。

取值范围：

请参见错误码。

error_ext_msg

String

参数解释：

扩展错误信息（暂未使用，赋值为null）。

取值范围：

不涉及。

error_msg

String

参数解释：

错误信息。

取值范围：

不涉及。

error_code

String

参数解释：

错误码。

取值范围：

请参见错误码。

error_ext_msg

String

参数解释：

扩展错误信息（暂未使用，赋值为null）。

取值范围：

不涉及。

error_msg

String

参数解释：

错误信息。

取值范围：

不涉及。

error_code

String

参数解释：

错误码。

取值范围：

请参见错误码。

error_ext_msg

String

参数解释：

扩展错误信息（暂未使用，赋值为null）。

取值范围：

不涉及。

200

查询后台任务列表成功。

400

非法请求。

401

认证信息非法。

403

请求被拒绝访问。

404

所请求的资源不存在。

500

内部服务错误。