华为云用户手册

响应消息 响应参数 参数说明见表7。 表7 参数说明 参数 类型 说明 instance_id String 缓存实例ID。 如果批量创建实例，则会返回多个实例ID，以逗号分隔。 说明： 该参数用于兼容老版本，参数列出的实例列表与instances相同。 instances JSON 缓存实例列表。具体参数，请参考表8。 表8 instances参数说明 参数 类型 说明 instance_id String 缓存实例ID。 instance_name String 缓存实例名称。 响应示例 如果是按需实例，响应消息如下： { "instances": [ { "instance_id": "3c49fd6b-fc7c-419e-9644-b6cce008653f", "instance_name": "dcs-test005" } ], "instance_id": "3c49fd6b-fc7c-419e-9644-b6cce008653f" } 如果是包周期实例，响应消息如下： { "instance_id": "77284d69-cd51-4bf1-aa30-2e60f055800c", "order_id": " CS 2005091653L2DAM", "instances": [ { "instance_id": "77284d69-cd51-4bf1-aa30-2e60f055800c", "instance_name": "dcs-APITest1" } ] }

响应参数 状态码： 200 表2 响应Body参数 参数 参数类型 描述 id String 热key分析记录ID。 instance_id String 实例ID。 status String 分析任务状态。 枚举值： waiting running success failed scan_type String 分析方式。 枚举值： manual auto created_at String 分析任务创建时间，格式为："2020-06-15T02:21:18.669Z"。 started_at String 分析任务开始时间，格式为："2020-06-15T02:21:18.669Z"（创建分析任务时此值为null，不返回）。 finished_at String 分析任务结束时间，格式为："2020-06-15T02:21:18.669Z"（创建分析任务时此值为null，不返回）。 num Integer 热key的数量。 keys Array of HotkeysBody objects 热key记录（创建分析任务时此值为null，不返回）。 表3 HotkeysBody 参数 参数类型 描述 name String Key名称。 type String Key类型。 枚举值： string list set zset hash shard String 热key所在的分片，仅在实例类型为集群时支持,格式为ip:port。 db Integer 热key所在的DB。 size Long Key的value大小。 unit String 表示key的单位。count：key的数量，byte：key的大小。 freq Integer 表示某个key在一段时间的访问频度，会随着访问的频率而变化。 该值并不是简单的访问频率值，而是一个基于概率的对数计数器结果，最大为255（可表示100万次访问），超过255后如果继续频繁访问该值并不会继续增大，同时默认如果每过一分钟没有访问，该值会衰减1。 状态码： 400 表4 响应Body参数 参数 参数类型 描述 error_msg String 错误信息。 最大长度：1024 error_code String 错误码。 最大长度：9 error_ext_msg String 扩展错误信（暂未使用，赋值为null）。 最大长度：1024 状态码： 401 表5 响应Body参数 参数 参数类型 描述 error_msg String 错误信息。 最大长度：1024 error_code String 错误码。 最大长度：9 error_ext_msg String 扩展错误信（暂未使用，赋值为null）。 最大长度：1024 状态码： 403 表6 响应Body参数 参数 参数类型 描述 error_msg String 错误信息。 最大长度：1024 error_code String 错误码。 最大长度：9 error_ext_msg String 扩展错误信（暂未使用，赋值为null）。 最大长度：1024 状态码： 404 表7 响应Body参数 参数 参数类型 描述 error_msg String 错误信息。 最大长度：1024 error_code String 错误码。 最大长度：9 error_ext_msg String 扩展错误信（暂未使用，赋值为null）。 最大长度：1024 状态码： 500 表8 响应Body参数 参数 参数类型 描述 error_msg String 错误信息。 最大长度：1024 error_code String 错误码。 最大长度：9 error_ext_msg String 扩展错误信（暂未使用，赋值为null）。 最大长度：1024

响应示例 状态码： 200 创建热key分析任务成功。 { "id" : "aa735b6f-3d70-44e3-9771-66c6fae7459a", "instance_id" : "5560df16-cebf-4473-95c4-d1b573c16e79", "status" : "waiting", "scan_type" : "manual", "created_at" : "2020-06-15T02:21:18.669Z", "num" : 0 } 状态码： 400 非法请求。 { "error_code" : "DCS.4922", "error_msg" : "Does not support hotkey analyze." }

响应示例 状态码： 200 查询参数模板列表成功。 { "template_num" : 1, "templates" : [ { "template_id" : "6", "cache_mode" : "single", "description" : null, "engine" : "Redis", "engine_version" : "4.0", "name" : "Default-Redis-4.0-single-generic-D RAM ", "product_type" : "generic", "storage_type" : "DRAM", "type" : "sys" } ] } 状态码： 400 非法请求。 { "error_code" : "111400063", "error_msg" : "Invalid {0} parameter in the request." }

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 template_num Integer 模板个数。 templates Array of ConfigTemplatesListInfo objects 模板的详情数组。 表4 ConfigTemplatesListInfo 参数 参数类型 描述 template_id String 模板ID。 cache_mode String 缓存实例类型。取值范围如下： single：表示单机实例 ha：表示主备实例 cluster：表示cluster集群实例 proxy：表示Proxy集群实例 ha_rw_split： 表示读写分离实例 description String 模板的描述信息。 engine String 缓存引擎：Redis和Memcached。 engine_version String 缓存版本。 当缓存引擎为Redis时，取值为4.0/5.0/6.0。 当缓存引擎为Memcached时，该字段为可选，取值为空。 name String 模板名称。 product_type String 产品类型。 取值范围如下： generic：普通版 enterprise：企业版 枚举值： generic enterprise storage_type String 存储类型。 枚举值： DRAM SSD type String 模板类型，取值范围： sys：系统默认模板 user：用户自定义模板 枚举值： sys user created_at String 模板创建时间，仅在自定义参数模板中有意义，格式例如：2023-05-10T11:09:35.802Z。 状态码： 400 表5 响应Body参数 参数 参数类型 描述 error_msg String 错误信息 最大长度：1024 error_code String 错误码 最大长度：9 error_ext_msg String 扩展错误信息(暂未使用，赋值为null) 最大长度：1024 状态码： 401 表6 响应Body参数 参数 参数类型 描述 error_msg String 错误信息 最大长度：1024 error_code String 错误码 最大长度：9 error_ext_msg String 扩展错误信息(暂未使用，赋值为null) 最大长度：1024 状态码： 403 表7 响应Body参数 参数 参数类型 描述 error_msg String 错误信息 最大长度：1024 error_code String 错误码 最大长度：9 error_ext_msg String 扩展错误信息(暂未使用，赋值为null) 最大长度：1024 状态码： 404 表8 响应Body参数 参数 参数类型 描述 error_msg String 错误信息 最大长度：1024 error_code String 错误码 最大长度：9 error_ext_msg String 扩展错误信息(暂未使用，赋值为null) 最大长度：1024 状态码： 500 表9 响应Body参数 参数 参数类型 描述 error_msg String 错误信息 最大长度：1024 error_code String 错误码 最大长度：9 error_ext_msg String 扩展错误信息(暂未使用，赋值为null) 最大长度：1024

URI GET /v2/{project_id}/config-templates 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。获取方法请参见获取项目ID。 表2 Query参数 参数 是否必选 参数类型 描述 name 否 String 参数模板名称，支持模糊查找。 type 是 String 模板类型。取值范围： sys：系统默认模板。 user：用户自定义模板。 枚举值： sys user engine 否 String 缓存引擎：Redis和Memcached。 engine_version 否 String 缓存版本。 当缓存引擎为Redis时，取值为4.0/5.0/6.0。 当缓存引擎为Memcached时，该字段为可选，取值为空。 cache_mode 否 String 缓存实例类型。取值范围如下： single：表示单机实例 ha：表示主备实例 cluster：表示cluster集群实例 proxy：表示Proxy集群实例 ha_rw_split：表示读写分离实例 offset 否 Integer 偏移量，表示从此偏移量开始查询，offset大于等于0。 limit 否 Integer 每页显示条数，最小值为1，最大值为1000，若不设置该参数，则为10。

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 backup_id String 备份记录ID。 状态码： 400 表4 响应Body参数 参数 参数类型 描述 error_msg String 错误信息。 最大长度：1024 error_code String 错误码。 最大长度：9 error_ext_msg String 扩展错误信息（暂未使用，赋值为null）。 最大长度：1024 状态码： 500 表5 响应Body参数 参数 参数类型 描述 error_msg String 错误信息。 最大长度：1024 error_code String 错误码。 最大长度：9 error_ext_msg String 扩展错误信息（暂未使用，赋值为null）。 最大长度：1024

响应示例 状态码： 200 查询节点信息成功。 { "instance_id" : "11368fbb-de1e-4613-9080-1c374b71a1af", "total" : 1, "nodes" : [ { "logical_node_id" : "79653bcbd0e5c104fefedd188aa372d6", "name" : "(master)192.168.68.157", "status" : "Active", "az_code" : "region01", "node_role" : "redis-server", "node_type" : "master", "node_ip" : "192.168.68.157", "node_id" : "ff80808189bf92a50189d330303b77aa", "is_access" : true, "group_id" : "6e0f6e95-57cd-4baf-86d6-bea8815b25a8", "group_name" : "group-0", "priority_weight" : 100, "is_remove_ip" : false, "dimensions" : [ { "name" : "dcs_instance_id", "value" : "11368fbb-de1e-4613-9080-1c374b71a1af" }, { "name" : "dcs_cluster_redis_node", "value" : "79653bcbd0e5c104fefedd188aa372d6" } ], "replication_id" : null } ] } 状态码： 500 内部服务错误。 { "error_code" : "DCS.5000", "error_msg" : "Internal service error." } 状态码： 400 非法请求。 { "error_code" : "DCS.4800", "error_msg" : "Invalid offset in the request." }

响应参数 状态码： 200 表2 响应Body参数 参数 参数类型 描述 instance_id String 实例ID total Integer 节点数量 nodes Array of NodesInfoResp objects 节点信息 表3 NodesInfoResp 参数 参数类型 描述 logical_node_id String 逻辑节点ID。 name String 节点名称。 status String 节点状态，所有值如下: Creating：创建中。 Active：运行中。 Inactive：故障。 Deleting：删除中。 AddSharding：添加分片中。 枚举值： Creating Active Inactive Deleting AddSharding az_code String 可用区code。 node_role String 节点角色，所有值如下： redis-server：Redis server节点。 redis-proxy：proxy节点。 枚举值： redis-server redis-proxy node_type String 节点主从角色： master：主节点 slave：从节点 proxy: proxy实例节点角色为"proxy" 枚举值： master slave proxy node_ip String 节点的IP。 node_port String 节点的端口。 node_id String 节点ID。 priority_weight Integer 节点主备切换优先级权重。 is_access Boolean 节点的IP是否可直接访问。 group_id String 分片ID。 group_name String 分片名称。 is_remove_ip Boolean 是否从只读域名中摘除IP。 replication_id String 副本ID。 dimensions Array of InstanceReplicationDimensionsInfo objects 副本对应的监控指标维度信息。可用于调用 云监控服务 的查询监控数据指标相关接口。 副本的监控维度为多维度，返回数组中包含两个维度信息。从 云监控 查询监控数据时，要按多维度传递指标维度参数，才能查询到监控指标值。 第一个维度为副本父维度信息。 维度名称为dcs_instance_id，维度值对应副本所在的实例ID。 第二个维度，维度名称为dcs_cluster_redis_node，维度值为副本的监控对象ID，与副本ID和节点ID不同。 表4 InstanceReplicationDimensionsInfo 参数 参数类型 描述 name String 监控维度名称。 value String 维度取值。 状态码： 500 表5 响应Body参数 参数 参数类型 描述 error_msg String 错误信息。 最大长度：1024 error_code String 错误码。 最大长度：9 error_ext_msg String 扩展错误信息（暂未使用，赋值为null）。 最大长度：1024 状态码： 400 表6 响应Body参数 参数 参数类型 描述 error_msg String 错误信息。 最大长度：1024 error_code String 错误码。 最大长度：9 error_ext_msg String 扩展错误信息（暂未使用，赋值为null）。 最大长度：1024

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 lock_time String 锁定时间。验证密码失败时和锁定时该参数返回不为null。 result String 密码修改结果： 成功：success； 密码验证失败：passwordFailed； 已锁定：locked； 失败：failed。 枚举值： success passwordFailed locked failed lock_time_left String 锁定剩余时间。锁定时该参数返回不为null。 retry_times_left String 密码验证剩余次数。验证密码失败时该参数返回不为null。 message String 修改结果说明信息。 状态码： 400 表4 响应Body参数 参数 参数类型 描述 error_msg String 错误信息 最大长度：1024 error_code String 错误码 最大长度：9 error_ext_msg String 扩展错误信息（暂未使用，赋值为null） 最大长度：1024 状态码： 401 表5 响应Body参数 参数 参数类型 描述 error_msg String 错误信息 最大长度：1024 error_code String 错误码 最大长度：9 error_ext_msg String 扩展错误信息（暂未使用，赋值为null） 最大长度：1024 状态码： 403 表6 响应Body参数 参数 参数类型 描述 error_msg String 错误信息 最大长度：1024 error_code String 错误码 最大长度：9 error_ext_msg String 扩展错误信息（暂未使用，赋值为null） 最大长度：1024 状态码： 404 表7 响应Body参数 参数 参数类型 描述 error_msg String 错误信息 最大长度：1024 error_code String 错误码 最大长度：9 error_ext_msg String 扩展错误信息（暂未使用，赋值为null） 最大长度：1024 状态码： 500 表8 响应Body参数 参数 参数类型 描述 error_msg String 错误信息 最大长度：1024 error_code String 错误码 最大长度：9 error_ext_msg String 扩展错误信息（暂未使用，赋值为null） 最大长度：1024

URI PUT /v2/{project_id}/instances/{instance_id}/accounts/{account_id}/password/modify 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。获取方法请参见获取项目ID。 instance_id 是 String 实例ID。 account_id 是 String ACL账号ID。

响应示例 状态码： 200 修改密码成功。 { "lock_time" : "0", "result" : "success", "lock_time_left" : "0", "retry_times_left" : "5", "message" : "Modify DCSInstance password success." } 状态码： 400 非法请求。 { "error_code" : "DCS.4961", "error_msg" : "Acl account request param invalid." }

响应消息 响应参数 参数说明见表3。 表3 参数说明 参数 类型 说明 result String 密码修改结果： 成功：success； 密码验证失败：passwordFailed； 已锁定：locked； 失败：failed。 message String 修改结果。 retry_times_left String 密码验证剩余次数。验证失败时该参数返回不为null。 lock_time String 锁定时间。验证失败时和锁定时该参数返回不为null。 lock_time_left String 锁定剩余时间。锁定时该参数返回不为null。 响应示例 //Change password sucessful. { "result" : "success", "message" : "Modify DCSInstance password success.", "retry_times_left" : "5", "lock_time" : "0", "lock_time_left" : "0" } //Change password failed. { "result" : "passwordFailed", "message" : "verify password failed.", "retry_times_left" : "4", "lock_time" : "5", "lock_time_left" : "5" }

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 instance_id String 实例ID。 count Integer 大key分析的次数。 records Array of RecordsResponse objects 大key分析记录列表。 表4 RecordsResponse 参数 参数类型 描述 id String 任务执行记录ID（此ID对应“查询大key/热key分析详情”参数中的任务ID）。 status String 分析任务状态。 枚举值： waiting running success failed scan_type String 分析方式。 枚举值： manual auto created_at String 分析任务创建时间，格式为："2020-06-15T02:21:18.669Z"。 started_at String 分析任务开始时间，格式为："2020-06-15T02:21:18.669Z"。 finished_at String 分析任务结束时间，式为："2020-06-15T02:21:18.669Z"。 状态码： 400 表5 响应Body参数 参数 参数类型 描述 error_msg String 错误信息。 最大长度：1024 error_code String 错误码。 最大长度：9 error_ext_msg String 扩展错误信（暂未使用，赋值为null）。 最大长度：1024 状态码： 401 表6 响应Body参数 参数 参数类型 描述 error_msg String 错误信息。 最大长度：1024 error_code String 错误码。 最大长度：9 error_ext_msg String 扩展错误信（暂未使用，赋值为null）。 最大长度：1024 状态码： 403 表7 响应Body参数 参数 参数类型 描述 error_msg String 错误信息。 最大长度：1024 error_code String 错误码。 最大长度：9 error_ext_msg String 扩展错误信（暂未使用，赋值为null）。 最大长度：1024 状态码： 404 表8 响应Body参数 参数 参数类型 描述 error_msg String 错误信息。 最大长度：1024 error_code String 错误码。 最大长度：9 error_ext_msg String 扩展错误信（暂未使用，赋值为null）。 最大长度：1024 状态码： 500 表9 响应Body参数 参数 参数类型 描述 error_msg String 错误信息。 最大长度：1024 error_code String 错误码。 最大长度：9 error_ext_msg String 扩展错误信（暂未使用，赋值为null）。 最大长度：1024

响应示例 状态码： 200 查询大key分析历史记录。 { "instance_id" : "5f9057b5-c330-4ee2-8138-7e69896eeec3", "count" : 1, "records" : [ { "id" : "858ee14c-2271-4489-8b82-7bda7459ae3e", "scan_type" : "manual", "status" : "success", "created_at" : "2020-06-15T02:21:18.669Z", "started_at" : "2020-06-15T02:21:23.534Z", "finished_at" : "2020-06-15T02:21:25.588Z" } ] } 状态码： 400 非法请求。 { "error_code" : "DCS.4919", "error_msg" : "Does not support bigkey analyze." }

URI GET /v2/{project_id}/instances/{instance_id}/bigkey-tasks 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。获取方法请参见获取项目ID。 instance_id 是 String 实例ID。 表2 Query参数 参数 是否必选 参数类型 描述 offset 否 Integer 偏移量，表示从此偏移量开始查询， offset大于等于0。 limit 否 Integer 每页显示的条目数量。 status 否 String 分析任务状态。 枚举值： waiting running success failed

响应参数 状态码： 400 表3 响应Body参数 参数 参数类型 描述 error_msg String 错误信息 最大长度：1024 error_code String 错误码 最大长度：9 error_ext_msg String 扩展错误信息（暂未使用，赋值为null） 最大长度：1024 状态码： 401 表4 响应Body参数 参数 参数类型 描述 error_msg String 错误信息 最大长度：1024 error_code String 错误码 最大长度：9 error_ext_msg String 扩展错误信息（暂未使用，赋值为null） 最大长度：1024 状态码： 403 表5 响应Body参数 参数 参数类型 描述 error_msg String 错误信息 最大长度：1024 error_code String 错误码 最大长度：9 error_ext_msg String 扩展错误信息（暂未使用，赋值为null） 最大长度：1024 状态码： 404 表6 响应Body参数 参数 参数类型 描述 error_msg String 错误信息 最大长度：1024 error_code String 错误码 最大长度：9 error_ext_msg String 扩展错误信息（暂未使用，赋值为null） 最大长度：1024 状态码： 500 表7 响应Body参数 参数 参数类型 描述 error_msg String 错误信息 最大长度：1024 error_code String 错误码 最大长度：9 error_ext_msg String 扩展错误信息（暂未使用，赋值为null） 最大长度：1024

响应参数 状态码： 200 表2 响应Body参数 参数 参数类型 描述 check_result Boolean 是否有可供选择的副本组进行删除。 available_zone String 可选的可用区ID列表。 replication_list Array of ReplicationInfo objects 可选的保留节点列表。 表3 ReplicationInfo 参数 参数类型 描述 replication_id String 副本ID。 node_id String 节点ID。 replication_ip String 副本的IP和端口。 group_id String 分片ID。 group_name String 分片名称。 available_zone String 可用区ID。 状态码： 400 表4 响应Body参数 参数 参数类型 描述 error_msg String 错误信息。 最大长度：1024 error_code String 错误码。 最大长度：9 error_ext_msg String 扩展错误信息（暂未使用，赋值为null）。 最大长度：1024 状态码： 500 表5 响应Body参数 参数 参数类型 描述 error_msg String 错误信息。 最大长度：1024 error_code String 错误码。 最大长度：9 error_ext_msg String 扩展错误信息（暂未使用，赋值为null）。 最大长度：1024

响应示例 状态码： 200 获取可删除的副本成功。 { "check_result" : true, "available_zone" : "9f1c5806706d4c1fb0eb72f0a9b18c77", "replication_list" : [ { "replication_id" : "435a6322-0c64-4d0e-8bc2-8adefa2eca26", "node_id" : "8abf6e1e7fd3e695017fd4046bb9006b", "replication_ip" : "192.168.73.139:6379", "group_id" : "cbf8deba-d69f-41b8-8556-83337d32ad40", "group_name" : "group-2", "available_zone" : "9f1c5806706d4c1fb0eb72f0a9b18c77" }, { "replication_id" : "193683cf-f693-4a6a-950a-20f615ed6c47", "node_id" : "8abf6e1e7fd3e695017fd4046bb8006a", "replication_ip" : "192.168.67.86:6379", "group_id" : "7a153688-d31d-4541-b635-191885c71e93", "group_name" : "group-1", "available_zone" : "9f1c5806706d4c1fb0eb72f0a9b18c77" }, { "replication_id" : "ae38792f-60b7-4c8c-b1dc-175f2151f85f", "node_id" : "8abf6e1e7fd3e695017fd4046bb40069", "replication_ip" : "192.168.66.157:6379", "group_id" : "4f26a524-1525-4975-82fa-b2291091f9e7", "group_name" : "group-0", "available_zone" : "9f1c5806706d4c1fb0eb72f0a9b18c77" } ] } 状态码： 400 非法请求。 { "error_code" : 111400800, "error_msg" : "Only native cluster supported." } 状态码： 500 内部服务错误。 { "error_code" : 111500024, "error_msg" : "Query instance error." }

响应示例 状态码： 200 登录webCli成功。 { "client_id" : "238d8f22ccbc1f497482d5c8c87df023de14ea3eaee55dc8", "databases" : 256 } 状态码： 400 非法请求。 { "error_code" : "111400063", "error_msg" : "Invalid {0} parameter in the request." }

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 client_id String 客户端ID。 databases Integer DB数量。 状态码： 400 表4 响应Body参数 参数 参数类型 描述 error_msg String 错误信息。 最大长度：1024 error_code String 错误码。 最大长度：9 error_ext_msg String 扩展错误信息（暂未使用，赋值为null）。 最大长度：1024 状态码： 401 表5 响应Body参数 参数 参数类型 描述 error_msg String 错误信息。 最大长度：1024 error_code String 错误码。 最大长度：9 error_ext_msg String 扩展错误信息（暂未使用，赋值为null）。 最大长度：1024 状态码： 403 表6 响应Body参数 参数 参数类型 描述 error_msg String 错误信息。 最大长度：1024 error_code String 错误码。 最大长度：9 error_ext_msg String 扩展错误信息（暂未使用，赋值为null）。 最大长度：1024 状态码： 404 表7 响应Body参数 参数 参数类型 描述 error_msg String 错误信息。 最大长度：1024 error_code String 错误码。 最大长度：9 error_ext_msg String 扩展错误信息（暂未使用，赋值为null）。 最大长度：1024 状态码： 500 表8 响应Body参数 参数 参数类型 描述 error_msg String 错误信息。 最大长度：1024 error_code String 错误码。 最大长度：9 error_ext_msg String 扩展错误信息（暂未使用，赋值为null）。 最大长度：1024

响应参数 状态码： 400 表3 响应Body参数 参数 参数类型 描述 error_msg String 错误信息 最大长度：1024 error_code String 错误码 最大长度：9 error_ext_msg String 扩展错误信息（暂未使用，赋值为null） 最大长度：1024 状态码： 401 表4 响应Body参数 参数 参数类型 描述 error_msg String 错误信息 最大长度：1024 error_code String 错误码 最大长度：9 error_ext_msg String 扩展错误信息（暂未使用，赋值为null） 最大长度：1024 状态码： 403 表5 响应Body参数 参数 参数类型 描述 error_msg String 错误信息 最大长度：1024 error_code String 错误码 最大长度：9 error_ext_msg String 扩展错误信息（暂未使用，赋值为null） 最大长度：1024 状态码： 404 表6 响应Body参数 参数 参数类型 描述 error_msg String 错误信息 最大长度：1024 error_code String 错误码 最大长度：9 error_ext_msg String 扩展错误信息（暂未使用，赋值为null） 最大长度：1024 状态码： 500 表7 响应Body参数 参数 参数类型 描述 error_msg String 错误信息 最大长度：1024 error_code String 错误码 最大长度：9 error_ext_msg String 扩展错误信息（暂未使用，赋值为null） 最大长度：1024

响应参数 状态码： 200 表1 响应Body参数 参数 参数类型 描述 region_id String 区域ID。 available_zones Array of AvailableZones objects 可用分区数组。 表2 AvailableZones 参数 参数类型 描述 code String 可用区编码。 port String 可用区端口号。 name String 可用区名称。 id String 可用区ID。 resource_availability String 分区上是否还有可用资源。 true：还有资源。 false：没有可用资源。 枚举值： true false

响应示例 状态码： 200 查询成功。 { "region_id" : "region00", "available_zones" : [ { "code" : "region01", "port" : "8403", "name" : "可用区1", "id" : "effdcbc7d4d64a02aa1fa26b42f56533", "resource_availability" : "true" }, { "code" : "region02", "port" : "8404", "name" : "可用区2", "id" : "a0865121f83b41cbafce65930a22a6e8", "resource_availability" : "true" }, { "code" : "region03", "port" : "8408", "name" : "可用区3", "id" : "2dcb154ac2724a6d92e9bcc859657c1e", "resource_availability" : "true" } ] }

响应示例 状态码： 200 查询后台任务列表成功。 { "task_count" : 1, "tasks" : [ { "id" : "8abf6e1e72c12e7c0172c15b508500aa", "name" : "EXTEND", "user_name" : "paas_dcs_000_02", "user_id" : "d53977d1adfb49c5b025ba7d33a13fd7", "details" : { "old_cache_mode" : "single", "new_cache_mode" : "single", "old_capacity" : "0.125", "new_capacity" : "0.25" }, "enable_show" : false, "status" : "SUC CES S", "created_at" : "2020-06-17T08:18:06.597Z", "updated_at" : "2020-06-17T08:18:10.106Z" } ] }

响应参数 状态码： 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

URI GET /v2/{project_id}/instances/{instance_id}/tasks 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。获取方法请参见获取项目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。

URI GET /v2/{project_id}/instances/{instance_id}/operations 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。获取方法请参见获取项目ID。 instance_id 是 String 实例ID。 表2 Query参数 参数 是否必选 参数类型 描述 operation 是 String 操作信息。扩容即extend。 枚举值： extend

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 instance_id String 实例ID operations Array of Operations objects 支持的操作列表，目前只支持扩容 表4 Operations 参数 参数类型 描述 operation String 操作信息。 is_support Boolean 是否支持该操作。 cause_id String 不支持该操作的错误原因。 状态码： 400 表5 响应Body参数 参数 参数类型 描述 error_msg String 错误信息。 最大长度：1024 error_code String 错误码。 最大长度：9 error_ext_msg String 扩展错误信息（暂未使用，赋值为null）。 最大长度：1024 状态码： 401 表6 响应Body参数 参数 参数类型 描述 error_msg String 错误信息。 最大长度：1024 error_code String 错误码。 最大长度：9 error_ext_msg String 扩展错误信息（暂未使用，赋值为null）。 最大长度：1024 状态码： 403 表7 响应Body参数 参数 参数类型 描述 error_msg String 错误信息。 最大长度：1024 error_code String 错误码。 最大长度：9 error_ext_msg String 扩展错误信息（暂未使用，赋值为null）。 最大长度：1024 状态码： 404 表8 响应Body参数 参数 参数类型 描述 error_msg String 错误信息。 最大长度：1024 error_code String 错误码。 最大长度：9 error_ext_msg String 扩展错误信息（暂未使用，赋值为null）。 最大长度：1024 状态码： 500 表9 响应Body参数 参数 参数类型 描述 error_msg String 错误信息。 最大长度：1024 error_code String 错误码。 最大长度：9 error_ext_msg String 扩展错误信息（暂未使用，赋值为null）。 最大长度：1024

响应示例 状态码： 200 查询实例是否可以扩容成功。 { "instance_id" : "dacf949d-7f8a-4244-a4e8-6a4119186ac3", "operations" : [ { "operation" : "extend", "is_support" : true, "cause_id" : null } ] } 状态码： 400 非法请求。 { "error_code" : "111400063", "error_msg" : "Invalid {0} parameter in the request." }