华为云用户手册

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 instance_id String 在线迁移任务ID。 状态码： 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

请求参数 表2 请求Body参数 参数 是否必选 参数类型 描述 name 是 String 在线迁移任务名称。 description 否 String 在线迁移任务描述。 vpc_id 是 String 虚拟私有云ID。 获取方法如下： 方法1：登录虚拟私有云服务的控制台界面，在虚拟私有云的详情页面查找VPC ID。 方法2：通过虚拟私有云服务的API接口查询，具体操作可参考查询VPC列表。 subnet_id 是 String 子网的网络ID。 获取方法如下： 方法1：登录虚拟私有云服务的控制台界面，单击VPC下的子网，进入子网详情页面，查找网络ID。 方法2：通过虚拟私有云服务的API接口查询，具体操作可参考查询子网列表。 security_group_id 是 String 指定实例所属的安全组。 安全组用来实现安全组内和组间虚拟机的访问控制，加强虚拟机的安全保护。您可以在安全组中定义各种访问规则，当虚拟机加入该安全组后，即受到这些访问规则的保护。 获取方法如下： 方法1：登录虚拟私有云服务的控制台界面，访问控制安全组选项下可以对安全组进行创建和配置,并获取安全组ID。 方法2：通过虚拟私有云服务的API接口查询，具体操作可参考查询安全组列表。

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 result String 修改自定义模板的结果，success表示成功，如果失败则会返回对应的报错信息。 枚举值： success 状态码： 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 查询租户配额成功。 { "quotas" : { "resources" : [ { "unit" : { }, "min" : 1, "max" : 10, "quota" : 10, "used" : 3, "type" : "instance" }, { "unit" : "GB", "min" : 1, "max" : 800, "quota" : 800, "used" : 22, "type" : "ram" } ] } }

响应参数 状态码： 200 表2 响应Body参数 参数 参数类型 描述 quotas quotas object 配额信息。 表3 quotas 参数 参数类型 描述 resources Array of Resources objects 配额列表。 表4 Resources 参数 参数类型 描述 unit String 资源的计数单位。 当type为instance时，无单位。 当type为ram时，单位为GB。 min Integer 当type为instance时，表示可申请实例配额的最小值。 当type为ram时，表示可申请内存配额的最小值。 max Integer 当type为instance时，表示可申请实例配额的最大值。 当type为ram时，表示可申请内存配额的最大值。 quota Integer 可以创建的实例最大数和总内存的配额限制。 used Integer 已创建的实例个数和已使用的内存配额。 type String 支持instance、ram两种。 instance表示实例配额。 ram表示内存配额。 状态码： 400 表5 响应Body参数 参数 参数类型 描述 error_msg String 错误信息。 最大长度：1024 error_code String 错误码。 最大长度：9 error_ext_msg String 扩展错误信息（暂未使用，赋值为null）。 最大长度：1024 状态码： 500 表6 响应Body参数 参数 参数类型 描述 error_msg String 错误信息。 最大长度：1024 error_code String 错误码。 最大长度：9 error_ext_msg String 扩展错误信息（暂未使用，赋值为null）。 最大长度：1024

响应示例 状态码： 200 查询大key分析详情成功。 { "id" : "858ee14c-2271-4489-8b82-7bda7459ae3e", "instance_id" : "5f9057b5-c330-4ee2-8138-7e69896eeec3", "status" : "success", "scan_type" : "manual", "created_at" : "2020-06-15T02:21:18.669Z", "started_at" : "2020-06-15T02:21:23.534Z", "finished_at" : "2020-06-15T02:21:25.588Z", "keys" : [ { "name" : "dcs-bigkey-test", "type" : "string", "shard" : "192.168.1.134:6379", "db" : 0, "size" : 3000, "unit" : "byte" } ] } 状态码： 400 非法请求。 { "error_code" : "DCS.4919", "error_msg" : "Does not support bigkey analyze." }

响应参数 状态码： 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 BigkeysBody objects 大key记录（创建分析任务时此值为null，不返回）。 表3 BigkeysBody 参数 参数类型 描述 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的大小。 状态码： 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" : "858ee14c-2271-4489-8b82-7bda7459ae3e", "instance_id" : "5f9057b5-c330-4ee2-8138-7e69896eeec3", "status" : "waiting", "scan_type" : "manual", "created_at" : "2020-06-15T02:21:18.669Z", "num" : 0 } 状态码： 400 非法请求。 { "error_code" : "DCS.4919", "error_msg" : "Does not support bigkey analyze." }

响应参数 状态码： 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 BigkeysBody objects 大key记录（创建分析任务时此值为null，不返回）。 表3 BigkeysBody 参数 参数类型 描述 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的大小。 状态码： 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 表3 响应Body参数 参数 参数类型 描述 retry_times_left String 密码验证剩余次数。 lock_time String 锁定时间。 lock_time_left String 锁定剩余时间。 状态码： 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 表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

URI GET /v2/{project_id}/instances/{instance_id}/hotkey-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

响应示例 状态码： 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.4922", "error_msg" : "Does not support hotkey analyze." }

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

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 job_id String 任务ID。 状态码： 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 表2 响应Body参数 参数 参数类型 描述 error_msg String 错误信息 最大长度：1024 error_code String 错误码 最大长度：9 error_ext_msg String 扩展错误信息（暂未使用，赋值为null） 最大长度：1024 状态码： 401 表3 响应Body参数 参数 参数类型 描述 error_msg String 错误信息 最大长度：1024 error_code String 错误码 最大长度：9 error_ext_msg String 扩展错误信息（暂未使用，赋值为null） 最大长度：1024 状态码： 403 表4 响应Body参数 参数 参数类型 描述 error_msg String 错误信息 最大长度：1024 error_code String 错误码 最大长度：9 error_ext_msg String 扩展错误信息（暂未使用，赋值为null） 最大长度：1024 状态码： 404 表5 响应Body参数 参数 参数类型 描述 error_msg String 错误信息 最大长度：1024 error_code String 错误码 最大长度：9 error_ext_msg String 扩展错误信息（暂未使用，赋值为null） 最大长度：1024 状态码： 500 表6 响应Body参数 参数 参数类型 描述 error_msg String 错误信息 最大长度：1024 error_code String 错误码 最大长度：9 error_ext_msg String 扩展错误信息（暂未使用，赋值为null） 最大长度：1024

响应示例 状态码： 200 查询参数模板列表成功。 { "template_id" : "bfa904a1-27a4-4387-9f0e-44a524c8a244", "cache_mode" : "ha_rw_split", "created_at" : "2023-05-10T11:46:21.290Z", "description" : null, "engine" : "Redis", "engine_version" : "4.0", "name" : "test", "product_type" : "generic", "storage_type" : "DRAM", "type" : "user" } 状态码： 400 非法请求。 { "error_code" : "111400063", "error_msg" : "Invalid {0} parameter in the request." }

URI GET /v2/{project_id}/config-templates/{template_id} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。获取方法请参见获取项目ID。 template_id 是 String 模板ID。 表2 Query参数 参数 是否必选 参数类型 描述 type 是 String 模板类型，取值范围： sys：系统默认模板 user：用户自定义模板 枚举值： sys user

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 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 表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 获取备份文件下载链接成功。 { "file_path" : "42489641-23c4-4855-bc89-befc85e2b7f7/ddfe5f66-a965-43ff-aec7-f3b489dc071b/", "bucket_name" : "bucket5da9cf3bfabc4cae9023695b934e5e2b", "links" : [ { "file_name" : "redis_192.168.63.250_6379_10923-16383_20190820211816.rdb", "link" : "https://bucket5da9cf3bfabc4cae9023695b934e5e2b.{obs_endpoint}:443/42489641-23c4-4855-bc89-befc85e2b7f7/ddfe5f66-a965-43ff-aec7-f3b489dc071b/redis_192.168.63.250_6379_10923-16383_20190820211816.rdb?AWSAccessKeyId=VD8CEQNG8VMQODUAAM0D&Expires=1566308915&Signature=s3I%2BrLbo%2BFZw%2BUsjVere%2FOQdKEg%3D" } ] }

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 file_path String OBS桶内文件路径。 bucket_name String OBS桶名。 links Array of LinksItem objects 备份文件下链接集合，链接数最大为64个。 表4 LinksItem 参数 参数类型 描述 file_name String 备份文件名称。 link String 备份文件下载链接地址。 状态码： 400 表5 响应Body参数 参数 参数类型 描述 error_msg String 错误信息。 最大长度：1024 error_code String 错误码。 最大长度：9 error_ext_msg String 扩展错误信息（暂未使用，赋值为null）。 最大长度：1024 状态码： 500 表6 响应Body参数 参数 参数类型 描述 error_msg String 错误信息。 最大长度：1024 error_code String 错误码。 最大长度：9 error_ext_msg String 扩展错误信息（暂未使用，赋值为null）。 最大长度：1024

响应示例 状态码： 200 查询实例数量统计信息成功。 { "extending_count" : 0, "creating_count" : 0, "running_count" : 16, "error_count" : 0, "frozen_count" : 0, "createfailed_count" : 44, "restarting_count" : 0, "paying_count" : 0, "freezing_count" : 0, "migrating_count" : 0, "flushing_count" : 0, "upgrading_count" : 0, "redis" : { "extending_count" : 0, "creating_count" : 0, "running_count" : 8, "error_count" : 0, "frozen_count" : 0, "createfailed_count" : 22, "restarting_count" : 0, "paying_count" : 0, "freezing_count" : 0, "migrating_count" : 0, "flushing_count" : 0, "upgrading_count" : 0 }, "memcached" : { "extending_count" : 0, "creating_count" : 0, "running_count" : 8, "error_count" : 0, "frozen_count" : 0, "createfailed_count" : 22, "restarting_count" : 0, "paying_count" : 0, "freezing_count" : 0, "migrating_count" : 0, "flushing_count" : 0, "upgrading_count" : 0 } }

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 redis StatusStatistic object Redis实例数量统计信息。 memcached StatusStatistic object Memcached实例数量统计信息。 paying_count Integer 支付中的实例数。 freezing_count Integer 冻结中的实例数。 migrating_count Integer 迁移中的实例数。 flushing_count Integer 清空中的实例数。 upgrading_count Integer 升级中的实例数。 restoring_count Integer 恢复中的实例数。 extending_count Integer 扩容中的实例数。 creating_count Integer 正在创建的实例数。 running_count Integer 正在运行的实例数。 error_count Integer 异常的实例数。 frozen_count Integer 已冻结的实例数。 createfailed_count Integer 创建失败的实例数。 restarting_count Integer 正在重启的实例数。 表4 StatusStatistic 参数 参数类型 描述 paying_count Integer 支付中的实例数。 freezing_count Integer 冻结中的实例数。 migrating_count Integer 迁移中的实例数。 flushing_count Integer 清空中的实例数。 upgrading_count Integer 升级中的实例数。 restoring_count Integer 恢复中的实例数。 extending_count Integer 扩容中的实例数。 creating_count Integer 正在创建的实例数。 running_count Integer 正在运行的实例数。 error_count Integer 异常的实例数。 frozen_count Integer 已冻结的实例数。 createfailed_count Integer 创建失败的实例数。 restarting_count Integer 正在重启的实例数。 状态码： 400 表5 响应Body参数 参数 参数类型 描述 error_msg String 错误信息。 最大长度：1024 error_code String 错误码。 最大长度：9 error_ext_msg String 扩展错误信息（暂未使用，赋值为null）。 最大长度：1024 状态码： 500 表6 响应Body参数 参数 参数类型 描述 error_msg String 错误信息。 最大长度：1024 error_code String 错误码。 最大长度：9 error_ext_msg String 扩展错误信息（暂未使用，赋值为null）。 最大长度：1024

URI GET /v2/{project_id}/instances/status 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。获取方法请参见获取项目ID。 表2 Query参数 参数 是否必选 参数类型 描述 include_failure 否 String 是否返回创建失败的实例数。 当参数值为“true”时，返回的统计包括创建失败的实例数。 参数值为“false”或者其他值，返回的统计不包括创建失败的实例数。

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 count Integer 迁移任务数量。 migration_tasks Array of MigrationTaskList objects 迁移任务列表。 表4 MigrationTaskList 参数 参数类型 描述 task_id String 迁移任务ID。 task_name String 迁移任务名称。 status String 迁移任务状态，这个字段的值包括：SUCCESS（成功）, FAILED（失败）, MIGRATING（迁移中），TERMINATED（已结束）。 枚举值： SUCCESS FAILED MIGRATING TERMINATED migration_type String 迁移任务类型，包括备份文件导入和在线迁移两种类型。 枚举值： backupfile_import online_migration migration_method String 迁移方式，包括全量迁移和增量迁移两种类型。 枚举值： full_amount_migration incremental_migration ecs_tenant_private_ip String 迁移机租户侧私有IP，与目的/源redis私有IP处于同VPC，可将此IP加入白名单。 data_source String 源redis地址，格式为ip:port或者桶名。 source_instance_name String 源实例名称，若自建redis则为空。 source_instance_id String 源实例ID，若自建redis则为空。 target_instance_addrs String 目标redis地址，格式为ip:port。 target_instance_name String 目标实例名称。 target_instance_id String 目标实例ID。 created_at 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 查询迁移任务列表。 { "count" : 1, "migration_tasks" : [ { "task_id" : "2944a563-6f27-4604-9c16-a9a53cd95cc7", "task_name" : "dcs-migration-test-6-16", "status" : "TERMINATED", "migration_type" : "online_migration", "migration_method" : "incremental_migration", "data_source" : "192.168.0.200:6379", "source_instance_name" : "migration-resource", "source_instance_id" : "132e0017-715b-4556-930a-95c7db7e8f7a", "target_instance_addrs" : "192.168.0.153:6379", "target_instance_name" : "migration-target", "target_instance_id" : "eb1a8d1c-9ea6-4fcd-ac43-c3d3c2493f06", "created_at" : "2021-06-16T06:12:55.508Z" } ] }

URI GET /v2/{project_id}/migration-tasks 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。获取方法请参见获取项目ID。 表2 Query参数 参数 是否必选 参数类型 描述 offset 否 Integer 偏移量，表示从此偏移量开始查询， offset大于等于0。 limit 否 Integer 每页显示的条目数量。 name 否 String 迁移任务名称。

响应示例 状态码： 200 查询指定报告成功。 { "abnormal_item_sum" : 1, "failed_item_sum" : 0, "diagnosis_node_report_list" : [ { "group_name" : "group-0", "az_code" : "region01", "node_ip" : "192.168.0.170:6379", "abnormal_sum" : 1, "failed_sum" : 0, "role" : "master", "command_time_taken_list" : { "command_list" : [ { "calls_sum" : 329, "usec_sum" : 20.732, "command_name" : "info", "per_usec" : "68.61%", "average_usec" : 0.063 }, { "calls_sum" : 1788, "usec_sum" : 1.787, "command_name" : "ping", "per_usec" : "5.91%", "average_usec" : 0.001 }, { "calls_sum" : 2, "usec_sum" : 0.025, "command_name" : "config", "per_usec" : "0.08%", "average_usec" : 0.013 }, { "calls_sum" : 60, "usec_sum" : 0.186, "command_name" : "slowlog", "per_usec" : "0.62%", "average_usec" : 0.003 }, { "calls_sum" : 1764, "usec_sum" : 7.485, "command_name" : "publish", "per_usec" : "24.77%", "average_usec" : 0.004 } ], "result" : "succeed", "error_code" : null, "total_num" : 5, "total_usec_sum" : 30.215 }, "diagnosis_dimension_list" : [ { "name" : "load", "abnormal_num" : 0, "failed_num" : 0, "diagnosis_item_list" : [ { "name" : "cpu_usage", "result" : "normal", "cause_ids" : null, "impact_ids" : null, "advice_ids" : null, "error_code" : null }, { "name" : "time_consuming_commands", "result" : "normal", "cause_ids" : null, "impact_ids" : null, "advice_ids" : null, "error_code" : null } ] }, { "name" : "storage", "abnormal_num" : 1, "failed_num" : 0, "diagnosis_item_list" : [ { "name" : "inner_memory_fragmentation", "result" : "normal", "cause_ids" : [ { "id" : 7, "params" : null } ], "impact_ids" : [ { "id" : 3, "params" : null } ], "advice_ids" : [ { "id" : 4, "params" : null } ], "error_code" : null }, { "name" : "persistence", "result" : "normal", "cause_ids" : null, "impact_ids" : null, "advice_ids" : null, "error_code" : null }, { "name" : "centralized_expiration", "result" : "normal", "cause_ids" : null, "impact_ids" : null, "advice_ids" : null, "error_code" : null }, { "name" : "memory_usage", "result" : "normal", "cause_ids" : null, "impact_ids" : null, "advice_ids" : null, "error_code" : null }, { "name" : "hit_ratio", "result" : "normal", "cause_ids" : null, "impact_ids" : null, "advice_ids" : null, "error_code" : null } ] }, { "name" : "network", "abnormal_num" : 0, "failed_num" : 0, "diagnosis_item_list" : [ { "name" : "connection_num", "result" : "normal", "cause_ids" : null, "impact_ids" : null, "advice_ids" : null, "error_code" : null }, { "name" : "rx_controlled", "result" : "normal", "cause_ids" : null, "impact_ids" : null, "advice_ids" : null, "error_code" : null } ] } ] } ] }

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

响应示例 状态码： 200 查询缓存实例备份信息成功。 { "total_num" : 1, "backup_record_response" : [ { "period" : { }, "backup_type" : "manual", "created_at" : "2019-05-10T08:31:16.166Z", "remark" : "001", "is_support_restore" : "TRUE", "backup_id" : "4631832a-14c6-45b0-a0b3-3abd8f591ad1", "backup_name" : "backup_20190510163116", "instance_id" : "5560df16-cebf-4473-95c4-d1b573c16e79", "size" : 880232, "updated_at" : "2019-05-10T08:32:30.546Z", "progress" : "100.00", "error_code" : { }, "status" : "succeed", "execution_at" : "2019-05-11T08:31:16.166Z", "backup_format" : "aof" } ] }