分布式缓存服务 DCS-查询后台任务列表:响应参数

时间:2023-11-17 16:45:10

响应参数

状态码: 200

表3 响应Body参数

参数

参数类型

描述

task_count

String

任务个数。

tasks

Array of SingleBackgroundTask objects

任务详情数组。

表4 SingleBackgroundTask

参数

参数类型

描述

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

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

表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

support.huaweicloud.com/api-dcs/ListBackgroundTask.html