华为云用户手册

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

请求示例 变更实例规格,新的缓存实例规格是1GB。 POST https://{dcs_endpoint}/v2/{project_id}/instances/{instance_id}/resize { "spec_code" : "redis.ha.xu1.tiny.r2.1", "new_capacity" : 1, "reserved_ip" : [ "192.168.0.125" ], "change_type" : "createReplication", "available_zones" : [ "e7afd64502d64fe3bfb60c2c82ec0ec6", "d90ff6d692954373bf53be49cf3900cb" ], "node_list" : [ "ff80808282eee5f90183120188ae093e" ], "execute_immediately" : true }

响应示例 状态码： 200 查询慢日志成功。 { "total_num" : 1, "count" : 1, "slowlogs" : [ { "id" : 1, "start_time" : "2020-06-19T07:06:07Z", "command" : "SLOWLOG GET 128", "duration" : "17", "shard_name" : "group-0", "database_id" : 1, "username" : "default" } ] } 状态码： 400 非法请求。 { "error_code" : "DCS.4800", "error_msg" : "Invalid start_time in the request." }

URI GET /v2/{project_id}/instances/{instance_id}/slowlog 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。获取方法请参见获取项目ID。 instance_id 是 String 实例ID。 表2 Query参数 参数 是否必选 参数类型 描述 offset 否 Integer 偏移量，表示从此偏移量开始查询， offset大于等于0 limit 否 Integer 每页显示的条目数量。 sort_key 否 String 返回结果按该关键字排序，支持start_time，duration，默认为“start_time” 枚举值： start_time duration sort_dir 否 String 降序或升序（分别对应desc和asc，默认为“desc”） 枚举值： desc asc start_time 是 String 查询开始时间，时间为UTC时间的Unix时间戳。如：1598803200000。 end_time 是 String 查询结束时间，时间为UTC时间的Unix时间戳。如：1599494399000。

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 total_num Integer 慢日志总条数 count Integer 总数 slowlogs Array of SlowlogItem objects 慢日志列表 表4 SlowlogItem 参数 参数类型 描述 id Integer 慢日志的唯一标识 command String 慢命令 start_time String 执行开始时间,格式为“2020-06-19T07:06:07Z” duration String 持续时间，单位是ms shard_name String 慢命令所在的分片名称，仅在实例类型为集群时支持 database_id Integer 数据库id，当前只对指定客户开放 username 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

请求示例 POST https://{dcs_endpoint}/v2/{project_id}/instances/export { "included_instances" : [ ], "region" : "Region", "name" : "name", "capacity" : "2", "instance_id" : "52f265a5-13c4-42cc-b0fa-38ef830e6391", "ip" : "192.168.78.24", "available_zone" : "d539378ec1314c85b76fefa3f7071458", "status" : "RUNNING", "product_type" : "generic", "cache_mode" : "proxy", "engine" : "Redis", "engine_version" : "4.0", "cpu_type" : "x86", "enterprise_project_id" : "93085bd3-6a84-4acc-bc70-5ebfa18c77b6", "charging_mode" : "0", "tags" : "aaa=cccc" }

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

请求参数 表2 请求Body参数 参数 是否必选 参数类型 描述 included_instances 否 Array of strings 导出实例列表，如果为空，则会导出满足其余参数条件的所有实例。 region 是 String 局点名称，用于导出的文件名命名。 name 否 String 按照实例名称筛选实例。 capacity 否 String 按照实例容量筛选实例。 instance_id 否 String 按照实例ID筛选实例。 ip 否 String 按照IP地址筛选实例。 available_zone 否 String 按照可用区筛选实例。 status 否 String 按照实例状态筛选实例，取值返回如下： RUNNING：运行中 EXTENDING：扩缩容中 CREATING：创建中 ERROR：异常状态 DELETEFAILED：删除失败 FROZEN：冻结状态 RESTARTING：重启中 枚举值： RUNNING EXTENDING CREATING ERROR DELETEFAILED FROZEN RESTARTING product_type 否 String 按照产品类型筛选实例，generic-普通版本，enterprise-企业版 枚举值： generic enterprise cache_mode 否 String 按照实例类型筛选实例，取值范围如下： single：单机实例 ha：主备实例 ha_rw_split：读写分离实例 cluster：集群实例 proxy：proxy集群实例 枚举值： single ha ha_rw_split cluster proxy engine 否 String 按照缓存引擎筛选实例，当前就是redis。 枚举值： redis engine_version 否 String 按照缓存引擎版本筛选实例。 枚举值： 4.0 5.0 6.0 cpu_type 否 String 按照CPU类型筛选实例，分为x86_64和aarch64。 枚举值： x86_64 aarch64 enterprise_project_id 否 String 按照企业项目ID筛选实例。 charging_mode 否 String 按照计费方式筛选实例。 tags 否 String 按照标签筛选实例。

响应示例 状态码： 200 查询产品规格成功。 { "flavors" : [ { "spec_code" : "redis.single.au1.large.1", "cloud_service_type_code" : "hws.resource.type.dcs3", "cloud_resource_type_code" : "hws.resource.type.dcs3", "cache_mode" : "single", "engine" : "redis", "engine_version" : "4.0;5.0", "product_type" : "generic", "cpu_type" : "aarch64", "storage_type" : "DRAM", "capacity" : [ 1 ], "billing_mode" : [ "Hourly", "Monthly", "Yearly" ], "tenant_ip_count" : 1, "pricing_type" : "normal", "is_dec" : false, "attrs" : [ { "capacity" : "1", "name" : "max_memory", "value" : "1" }, { "capacity" : "1", "name" : "max_connections", "value" : "10000" }, { "capacity" : "1", "name" : "sharding_num", "value" : "1" }, { "capacity" : "1", "name" : "proxy_num", "value" : "0" }, { "capacity" : "1", "name" : "db_number", "value" : "256" }, { "capacity" : "1", "name" : "max_clients", "value" : "10000" }, { "capacity" : "1", "name" : "max_bandwidth", "value" : "80" } ], "flavors_available_zones" : [ { "capacity" : "1", "unit" : "GB", "available_zones" : [ "d539378ec1314c85b76fefa3f7071458" ], "az_codes" : [ "region01" ] } ], "replica_count" : 1 } ] }

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 flavors Array of FlavorsItems objects 产品规格详情。 表4 FlavorsItems 参数 参数类型 描述 spec_code String 产品规格编码。 cloud_service_type_code String 云服务类型编码。 cloud_resource_type_code String 云资源类型编码。 cache_mode String 缓存实例类型。取值范围如下： single：表示单机实例 ha：表示主备实例 cluster：表示cluster集群实例 proxy：表示Proxy集群实例 ha_rw_split： 表示读写分离实例 engine String 缓存引擎类型。 engine_version String 缓存版本，当缓存引擎为Redis时，取值为3.0、4.0或5.0。 product_type String Redis缓存实例的产品类型。取值当前仅支持generic：标准类型 cpu_type String CPU架构类型。取值范围如下： x86_64：X86架构 aarch64：ARM架构 storage_type String 存储类型，取值当前仅支持DRAM：内存存储 capacity Array of strings 缓存容量（G Byte）。 billing_mode Array of strings 计费模式，取值范围如下： Hourly：按需计费 Monthly: 包月计费 Yearly: 包周期计费 tenant_ip_count Integer 租户侧IP数量。 pricing_type String 定价类型，取值如下： tier: 阶梯定价，一个规格对应多个容量 normal: 规格和容量一一对应 is_dec Boolean 是否支持专属云。 attrs Array of AttrsObject objects 规格的其他信息。 flavors_available_zones Array of FlavorAzObject objects 有资源的可用区。 replica_count Integer 副本数。 表5 AttrsObject 参数 参数类型 描述 capacity String 缓存容量（G Byte）。 name String 额外信息名，取值范围如下： sharding_num：该规格实例支持的分片数。 proxy_num：该规格Proxy实例支持的Proxy节点数量。如果不是Proxy实例，该参数为0。 db_number：该规格实例的DB数量。 max_memory：实际可使用的最大内存。 max_connections：该规格支持的最大连接数。 max_clients：该规格支持的最大客户端数，一般等于最大连接数。 max_bandwidth：该规格支持的最大带宽。 max_in_bandwidth：该规格支持的最大接入带宽，一般等于最大带宽。 value String 额外信息值。 表6 FlavorAzObject 参数 参数类型 描述 capacity String 缓存容量数值。 unit String 缓存容量单位。 available_zones Array of strings 可用区信息。 az_codes Array of strings 有资源的可用区编码。 状态码： 400 表7 响应Body参数 参数 参数类型 描述 error_msg String 错误信息。 最大长度：1024 error_code String 错误码。 最大长度：9 error_ext_msg String 扩展错误信息（暂未使用，赋值为null）。 最大长度：1024 状态码： 401 表8 响应Body参数 参数 参数类型 描述 error_msg String 错误信息。 最大长度：1024 error_code String 错误码。 最大长度：9 error_ext_msg String 扩展错误信息（暂未使用，赋值为null）。 最大长度：1024 状态码： 403 表9 响应Body参数 参数 参数类型 描述 error_msg String 错误信息。 最大长度：1024 error_code String 错误码。 最大长度：9 error_ext_msg String 扩展错误信息（暂未使用，赋值为null）。 最大长度：1024 状态码： 404 表10 响应Body参数 参数 参数类型 描述 error_msg String 错误信息。 最大长度：1024 error_code String 错误码。 最大长度：9 error_ext_msg String 扩展错误信息（暂未使用，赋值为null）。 最大长度：1024 状态码： 500 表11 响应Body参数 参数 参数类型 描述 error_msg String 错误信息。 最大长度：1024 error_code String 错误码。 最大长度：9 error_ext_msg String 扩展错误信息（暂未使用，赋值为null）。 最大长度：1024

URI GET /v2/{project_id}/flavors 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。获取方法请参见获取项目ID。 表2 Query参数 参数 是否必选 参数类型 描述 instance_id 否 String 缓存实例ID，根据该字段可查询出实例可变更的规格。 spec_code 否 String 产品规格编码。 cache_mode 否 String 缓存实例类型。取值范围如下： single：表示单机实例 ha：表示主备实例 cluster：表示cluster集群实例 proxy：表示Proxy集群实例 ha_rw_split： 表示读写分离实例 engine 否 String 缓存引擎类型。 Redis Memcached engine_version 否 String 缓存版本，当缓存引擎为Redis时，取值范围如下： 3.0 4.0 5.0 6.0 cpu_type 否 String CPU架构类型。取值范围如下： x86_64：X86架构 aarch64：ARM架构 枚举值： x86_64 aarch64 capacity 否 String 缓存容量（G Byte）。 Redis4.0、Redis5.0和Redis6.0：单机和主备类型实例取值：0.125、0.25、0.5、1、2、4、8、16、24、32、48、64。集群实例规格支持4、8、16、24、32、48、64、96、128、192、256、384、512、768、1024。读写分离实例取值：8、16、32。 Memcached：单机和主备类型实例取值：2、4、8、16、32、64。

响应消息 响应参数 参数说明见表2。 表2 参数说明 参数 类型 说明 status String 实例运行状态。 instance_id String 实例ID。 redis_config Array 实例配置项数组。具体请参考表3。 config_status String 实例修改状态。 UPDATING FAILURE SUCCESS config_time String 实例操作时间。格式为：2017-03-31T12:24:46.297Z 表3 redis_config参数说明 参数 类型 说明 description String 配置项的描述。 param_id Integer 配置参数ID。取值见表4“参数ID”列。 param_name String 配置参数名称。取值见表4“参数名称”列。 param_value String 配置参数值。 default_value String 配置参数的默认值。取值见表4“默认值”列。 value_type String 配置参数的值类型。取值见表4“参数类型”列。 value_range String 配置参数的取值范围。取值见表4“取值范围”列。 缓存实例配置参数的说明见表4。 表4 缓存实例配置参数说明 参数ID 参数名称 适用引擎 参数类型 参数解释 取值范围 默认值 1 timeout Redis、Memcached Interger 客户端与服务端连接空闲超时断开时间，参数设为0表示连接永不断开。 0~7200，单位：秒 0 2 maxmemory-policy Redis、Memcached Enum 内存使用达到上限时对缓存数据管理策略。 参数说明见逐出策略。 volatile-lru allkeys-lru volatile-random allkeys-random volatile-ttl noeviction volatile-lfu allkeys-lfu volatile-lru 说明： 如果是2020年7月之前创建的Redis实例，且没有修改过该参数，则默认值为noeviction。如果是2020年7月之后创建的实例，默认值都为volatile-lru。 3 hash-max-ziplist-entries Redis Interger 当hash表中记录数少于参数值，使用ziplist编码格式，节约内存。 1~10000 512 4 hash-max-ziplist-value Redis Interger 当hash表中各字段长度的最大值小于参数值时，使用ziplist编码格式，节约内存。 1~10000 64 5 list-max-ziplist-entries Redis Interger 当列表中记录数少于参数值，使用ziplist编码格式，节约内存。 1~10000 512 6 list-max-ziplist-value Redis Interger 当列表中各字段长度的最大值小于参数值时，使用ziplist编码格式，节约内存。 1~10000 64 7 set-max-intset-entries Redis Interger 当一个集合仅包含字符串且整型元素数量少于参数值时，使用intset编码格式，节约内存。 1~10000 512 8 zset-max-ziplist-entries Redis Interger 当有序集合中记录数少于参数值，使用ziplist编码格式，节约内存。 1~10000 128 9 zset-max-ziplist-value Redis Interger 当有序集合中各字段长度的最大值小于参数值时，使用ziplist编码格式，节约内存。 1~10000 64 10 latency-monitor-threshold Redis Interger 延时监控的采样时间阈值（最小值）。 当阈值设置为0时，不做监控，也不采样；当阈值设置为大于0时，将监控并记录执行耗时大于阈值的操作。 用户可以通过LATENCY等命令获取统计数据和配置、执行采样监控。详情参考Redis官网说明：https://redis.io/docs/reference/optimization/latency-monitor/。 0~86400000，单位：毫秒。 0 12 reserved-memory Redis Interger 预留内存，只有单机、主备实例有此配置。 预留内存将被分配给实例VM，保证DCS实例后台进程在做持久化和主从同步等任务时拥有足够的内存。 预留内存大小可以调高或者调低，但不能超过实例当前剩余的可用内存，以及最大可用内存的80%。其中实例最大可用内存可参考《分布式缓存服务产品介绍》文档。 实例最大可用内存数的0-80%，同时不能超过实例当前剩余的可用内存，单位：MB。 0 13 notify-keyspace-events Redis String 键空间通知，配置该参数后客户端可以通过Redis的订阅与发布功能，来接收那些以某种方式改动了Redis数据集的事件。 当配置为空字符串""或null时，配置会使用默认值Ex。 您可配置为以下字符的任意组合，指定了服务器该发送哪些类型的通知： K：键空间通知，所有通知以__keyspace@__为前缀。 E：键事件通知，所有通知以__keyevent@__为前缀。 g：DEL、EXPIRE、RENAME等类型无关的通用命令的通知。 $：字符串命令的通知。 l：列表命令的通知。 s：集合命令的通知。 h：哈希命令的通知。 z：有序集合命令的通知。 x：过期事件：每当有过期键被删除时发送。 e：驱逐(evict)事件：每当有键因为maxmemory政策而被删除时发送。 其他描述，请参考表格下方的说明。 Ex notify-keyspace-events参数的说明如下： 有效值为[K|E|KE][A|g|l|s|h|z|x|e|$]，即输入的参数中至少要有一个K或者E。 A为“g$lshzxe”所有参数的集合别名。A与“g$lshzxe”中任意一个不能同时出现。 例如，如果只想订阅键空间中和列表相关的通知，那么参数就应该设为Kl。若将参数设为字符串"AKE"表示发送所有类型的通知。 响应样例 { "status": "RUNNING", "instance_id": "c08fdc6e-5c25-4185-ab57-c0a5529b727f", "redis_config": [ { "description": "How Redis will select what to remove when maxmemory is reached, You can select among five behaviors: volatile-lru : remove the key with an expire set using an LRU algorithm allkeys-lru : remove any key according to the LRU algorithm volatile-random: remove a random key with an expire set allkeys-random: remove a random key, any key volatile-ttl : remove the key with the nearest expire time (minor TTL) noeviction : don't expire at all, just return an error on write operations", "param_id": 2, "param_name": "maxmemory-policy", "param_value": "noeviction", "default_value": "noeviction", "value_type": "Enum", "value_range": "volatile-lru,allkeys-lru,volatile-random,allkeys-random,volatile-ttl,noeviction" }, { "description": "Hashes are encoded using a memory efficient data structure when they have a small number of entries", "param_id": 3, "param_name": "hash-max-ziplist-entries", "param_value": "512", "default_value": "512", "value_type": "Interger", "value_range": "1-10000" }, { "description": "Hashes are encoded using a memory efficient data structure when the biggest entry does not exceed a given threshold", "param_id": 4, "param_name": "hash-max-ziplist-value", "param_value": "64", "default_value": "64", "value_type": "Interger", "value_range": "1-10000" }, { "description": "Lists are encoded using a memory efficient data structure when they have a small number of entries", "param_id": 5, "param_name": "list-max-ziplist-entries", "param_value": "512", "default_value": "512", "value_type": "Interger", "value_range": "1-10000" }, { "description": "Lists are encoded using a memory efficient data structure when the biggest entry does not exceed a given threshold", "param_id": 6, "param_name": "list-max-ziplist-value", "param_value": "64", "default_value": "64", "value_type": "Interger", "value_range": "1-10000" }, { "description": "When a set is composed of just strings that happen to be integers in radix 10 in the range of 64 bit signed integers.", "param_id": 7, "param_name": "set-max-intset-entries", "param_value": "512", "default_value": "512", "value_type": "Interger", "value_range": "1-10000" }, { "description": "Sorted sets are encoded using a memory efficient data structure when they have a small number of entries", "param_id": 8, "param_name": "zset-max-ziplist-entries", "param_value": "128", "default_value": "128", "value_type": "Interger", "value_range": "1-10000" }, { "description": "Sorted sets are encoded using a memory efficient data structure when the biggest entry does not exceed a given threshold", "param_id": 9, "param_name": "zset-max-ziplist-value", "param_value": "64", "default_value": "64", "value_type": "Interger", "value_range": "1-10000" }, { "description": "Close the connection after a client is idle for N seconds (0 to disable)", "param_id": 1, "param_name": "timeout", "param_value": "0", "default_value": "0", "value_type": "Interger", "value_range": "0-7200" }, { "description": "Only events that run in more time than the configured latency-monitor-threshold will be logged as latency spikes. If latency-monitor-threshold is set to 0, latency monitoring is disabled. If latency-monitor-threshold is set to a value greater than 0, all events blocking the server for a time equal to or greater than the configured latency-monitor-threshold will be logged.", "param_id": 10, "param_name": "latency-monitor-threshold", "param_value": "0", "default_value": "0", "value_type": "Interger", "value_range": "0-86400000" }, { "description": "The total memory, in bytes, reserved for non-data usage.", "param_id": 12, "param_name": "reserved-memory", "param_value": "0", "default_value": "0", "value_type": "Interger", "value_range": "0-6553" }, { "description": "Redis can notify Pub or Sub clients about events happening in the key space", "param_id": 13, "param_name": "notify-keyspace-events", "param_value": null, "default_value": null, "value_type": "regular", "value_range": "([KE]+([A]|[g$lshzxe]+)){0,11}" } ], "config_status": "SUCCESS", "config_time": "" }

响应示例 状态码： 200 查询指定实例成功。 { "publicip_id" : null, "vpc_name" : "dcs-beta", "charging_mode" : 0, "enterprise_project_name" : "default", "vpc_id" : "5e37b3be-950a-48e1-b498-65b63d336481", "user_name" : "clouduser", "created_at" : "2022-08-29T08:53:47.319Z", "description" : null, "cache_mode" : "ha", "security_group_id" : "securityGroupId", "enable_ssl" : false, "max_memory" : 128, "publicip_address" : null, "capacity" : 0, "maintain_begin" : "18:00:00", "engine" : "Redis", "maintain_end" : "19:00:00", "capacity_minor" : ".125", "service_upgrade" : false, "subnet_name" : "dcs-beta", "no_password_access" : "true", "service_task_id" : null, "ip" : "192.168.0.251", "subnet_cidr" : "192.168.0.0/24", "used_memory" : 2, "security_group_name" : "securityGroupId", "instance_backup_policy" : null, "az_codes" : [ "xx-xxxxx-xx" ], "available_zones" : [ "d539378ec1314c85b76fefa3f7071458" ], "access_user" : null, "enterprise_project_id" : "0", "instance_id" : "a4c545cd-10b2-4efc-b0ab-a9b554ca0621", "enable_publicip" : false, "port" : 6379, "user_id" : "d53977d1adfb49c5b025ba7d33a13fd7", "domain_name" : "redis-a4c545cd-10b2-4efc-b0ab-a9b554ca0621.dcs.xxx.com", "name" : "dcs-billing", "spec_code" : "redis.ha.xu1.tiny.r2.128", "subnet_id" : "a4112635-3ec0-471c-95c3-5cf49b9533af", "engine_version" : "5.0", "order_id" : null, "status" : "RUNNING", "features" : { "support_acl" : true, "support_transparent_client_ip" : true, "support_ssl" : false, "support_audit_log" : false }, "domain_name_info" : { "support_public_resolve" : true, "is_latest_rules" : true, "zone_name" : "dcs.xxx.com", "history_domain_names" : null }, "transparent_client_ip_enable" : true, "sub_status" : "normal", "cpu_type" : "x86_64", "cloud_service_type_code" : "hws.service.type.dcs", "cloud_resource_type_code" : "hws.resource.type.dcs3", "inquery_spec_code" : "redis.ha.xu1.tiny.r2.128" }

响应参数 状态码： 200 表2 响应Body参数 参数 参数类型 描述 vpc_name String VPC的名称。 charging_mode Integer 付费模式，0表示按需计费，1表示包年/包月计费。 vpc_id String VPC ID。 user_name String 用户名。 created_at String 完成创建时间。格式为：2017-03-31T12:24:46.297Z description String 实例描述。 security_group_id String 安全组ID。 security_group_name String 租户安全组名称。 max_memory Integer 总内存，单位：MB。 used_memory Integer 已使用的内存，单位：MB。 capacity Integer 缓存实例的容量（G Byte）。 capacity_minor String 小规格缓存实例（小于1G）的容量（G Byte）。 maintain_begin String 维护时间窗开始时间，为UTC时间，格式为HH:mm:ss。 maintain_end String 维护时间窗结束时间，为UTC时间，格式为HH:mm:ss。 engine String 缓存实例的引擎类型。 no_password_access String 是否允许免密码访问缓存实例。 true：该实例无需密码即可访问。 false：该实例必须通过密码认证才能访问。 ip String 连接缓存实例的IP地址。如果是集群实例，返回多个IP地址，使用逗号分隔。如：192.168.0.1，192.168.0.2。 instance_backup_policy InstanceBackupPolicy object 备份策略，实例类型为主备和集群时支持。 az_codes Array of strings 实例所在的可用区。返回“可用区Code” available_zones Array of strings 实例所在的可用区ID。返回"可用区ID"。 access_user String 通过密码认证访问缓存实例的认证用户名。 instance_id String 实例ID。 port Integer 缓存的端口。 user_id String 用户ID。 name String 实例名称。 spec_code String 产品规格编码 subnet_id String 子网ID。 subnet_name String 子网名称。 subnet_cidr String 子网网段。 engine_version String 缓存版本。 order_id String 订单ID。 status String 缓存实例的状态。详细状态说明见缓存实例状态说明 domain_name String 实例的域名。 readonly_domain_name String 实例的只读域名，只有主备实例有该字段。 enable_publicip Boolean Redis缓存实例是否开启公网访问功能。 true：开启 false：不开启 publicip_id String Redis缓存实例绑定的弹性IP地址的id。 如果未开启公网访问功能，该字段值为null。 publicip_address String Redis缓存实例绑定的弹性IP地址。 如果未开启公网访问功能，该字段值为null。 enable_ssl Boolean Redis缓存实例开启公网访问功能时，是否选择支持ssl。 true：开启 false：不开启 service_upgrade Boolean 实例是否存在升级任务。 true：存在 false：不存在 service_task_id String 升级任务的ID。 当service_upgrade为true时，为升级任务的ID。 当service_upgrade为false时，该参数为空。 enterprise_project_id String 企业项目ID。 backend_addrs String 集群实例的后端服务地址。 features Features object 实例支持特性。 domain_name_info DomainNameInfo object 实例域名重建、公网解析操作相关信息。 transparent_client_ip_enable Boolean 是否开启客户端ip透传。 sub_status String 实例子状态。 tags Array of ResourceTag objects 实例标签键值。 cpu_type String 实例CPU类型，通常为x86_64或aarch64。 enterprise_project_name String 企业项目名称。 update_at String 更新时间，形如2022-07-06T09:32:16.502Z product_type String 版本类型：社区版、企业版 枚举值： generic enterprise storage_type String 存储类型：内存存储。 枚举值： DRAM launched_at String 启动时间，形如2022-07-06T09:32:16.502Z cache_mode String 缓存实例类型。取值范围如下： single：表示单机实例 ha：表示主备实例 cluster：表示cluster集群实例 proxy：表示Proxy集群实例 ha_rw_split： 表示读写分离实例 support_slow_log_flag String 是否支持慢日志。 db_number Integer 数据库数量。 replica_count Integer 副本数。 sharding_count Integer 集群实例分片个数。 bandwidth_info BandwidthInfo object 带宽信息。 cloud_service_type_code String 云服务类型编码。 cloud_resource_type_code String 云资源类型编码。 inquery_spec_code String 运营系统中的规格编码。 表3 InstanceBackupPolicy 参数 参数类型 描述 backup_policy_id String 备份策略ID。 created_at String 创建时间。格式为：2022-04-11T09:45:24.790Z updated_at String 更新时间。格式为：2022-04-12T02:22:03.269Z policy BackupPolicy object 备份策略。 tenant_id String 租户ID。 表4 BackupPolicy 参数 参数类型 描述 backup_type String 备份类型。 auto：自动备份 manual：手动备份 save_days Integer 当backup_type设置为auto时，该参数为必填。 保留天数，单位：天，取值范围：1-7。由自动切换为手动时，保留自动备份策略信息。 periodical_backup_plan BackupPlan object 备份计划，当backup_type设置为auto时，该参数为必填。由自动切换为手动时，保留自动备份策略信息。 表5 BackupPlan 参数 参数类型 描述 timezone_offset String 备份的时区。该参数已废弃，没有实际作用。 backup_at Array of integers 每周的周几开始备份，取值1-7，1代表周一，7代表周日。由自动切换为手动时，保留自动备份策略信息。 period_type String 备份周期类型，目前支持“weekly”。由自动切换为手动时，保留自动备份策略信息。 begin_at String 备份开始执行时间，该时间为UTC时间，例如“00:00-01:00”代表UTC时间0点开始执行备份。只能是整点时间段，间隔时间限定为一个小时。由自动切换为手动时，保留自动备份策略信息。 表6 Features 参数 参数类型 描述 support_acl Boolean 是否支持ACL。 true：是 false：否 support_transparent_client_ip Boolean 实例是否支持客户端IP透传。 true：是 false：否 support_ssl Boolean 是否支持SSL。 true：是 false：否 support_audit_log Boolean 是否支持审计日志。 true: 是 false: 否 表7 DomainNameInfo 参数 参数类型 描述 support_public_resolve Boolean 是否开启公网域名解析。 true：开启 false：未开启 is_latest_rules Boolean 当前域名是否已为最新。 true：是 false：否 zone_name String 域名的区域后缀。 history_domain_names Array of DomainNameEntity objects 历史域名信息。 表8 DomainNameEntity 参数 参数类型 描述 domain_name String 实例历史域名。 is_readonly Boolean 是否只读域名。 true：是 false：否 表9 ResourceTag 参数 参数类型 描述 key String 标签键。 不能为空。 对于同一资源键值唯一。 长度不超过36个字符。 标签的键必须唯一且输入不能为空。 value String 标签值。 action为create时必选。action为delete时非必选。 长度不超过43个字符。 表10 BandwidthInfo 参数 参数类型 描述 begin_time Long 临时扩容开始时间。 end_time Long 临时扩容结束时间。 current_time Long 当前时间。 bandwidth Integer 当前带宽，单位为Mbit/s。 next_expand_time Long 下一个扩容时间。 expand_count Integer 扩容数量。 expand_effect_time Long 临时扩容时间间隔。 expand_interval_time Long 下一次可以扩容间隔时间。 max_expand_count Integer 最大扩容数量。 task_running Boolean 任务是否运行。

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 router Array of strings 当前查询维度路由。如果是主维度，则数组中是自身ID。 children Array of DimChild objects 当前查询维度子维度对象列表。当前只有维度为dcs_instance_id时才有值。 Proxy集群有两个子维度，分别为dcs_cluster_redis_node和dcs_cluster_proxy_node。 Cluster集群有一个子维度 dcs_cluster_proxy_node。 instances Array of InstancesMonitoredObject objects 当前查询维度监控对象列表。 total Integer 主维度监控对象的总数。 表4 DimChild 参数 参数类型 描述 dim_name String 维度名称，当前支持维度有dcs_instance_id、dcs_cluster_redis_node、 dcs_cluster_proxy_node和dcs_memcached_instance_id。 dim_route String 维度的路由，结构为主维度名称,当前维度名称，比如： dim_name字段为dcs_cluster_redis_node时，这个字段的值为dcs_instance_id,dcs_cluster_redis_node。 表5 InstancesMonitoredObject 参数 参数类型 描述 dcs_instance_id String 测量对象ID，即实例的ID。 name String 测量对象名称，即实例名称。 status String 测量对象状态，即实例状态。 状态码： 500 表6 响应Body参数 参数 参数类型 描述 error_msg String 错误信息。 最大长度：1024 error_code String 错误码。 最大长度：9 error_ext_msg String 扩展错误信息（暂未使用，赋值为null）。 最大长度：1024

响应示例 状态码： 200 查询主维度监控列表成功。 { "router" : [ "dcs_instance_id" ], "total" : 3, "children" : [ { "dim_name" : "dcs_cluster_redis_node", "dim_route" : "dcs_instance_id,dcs_cluster_redis_node" }, { "dim_name" : "dcs_cluster_proxy_node", "dim_route" : "dcs_instance_id,dcs_cluster_proxy_node" } ], "instances" : [ { "name" : "dcs-redis-single-node", "status" : "RUNNING", "dcs_instance_id" : "fe909c47-8990-44a0-9154-d0a1e95e78fe" }, { "name" : "dcs-redis-master-standby", "status" : "RUNNING", "dcs_instance_id" : "877e5ae3-482e-4c38-88a0-030a0fa6f399" }, { "name" : "dcs-proxy-cluster", "status" : "RUNNING", "dcs_instance_id" : "448ee851-1366-47f2-913a-e21032e690c4" } ] }

URI GET /v2/{project_id}/dims/monitored-objects 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户ID。 表2 Query参数 参数 是否必选 参数类型 描述 dim_name 是 String 主维度ID，当前支持dcs_instance_id，dcs_memcached_instance_id。 offset 否 Integer 偏移量，表示从此偏移量开始查询，offset大于等于0。 缺省值：0 limit 否 Integer 每页显示的条目数量。 缺省值：10

响应示例 状态码： 200 查询实例白名单成功。 { "instance_id" : "5560df16-cebf-4473-95c4-d1b573c16e79", "enable_whitelist" : true, "whitelist" : [ { "group_name" : "test001", "ip_list" : [ "10.10.10.1", "10.10.10.2" ] } ] }

响应参数 状态码： 200 表2 响应Body参数 参数 参数类型 描述 instance_id String 实例ID。 enable_whitelist Boolean 是否启用白名单（true/false）。 枚举值： true false whitelist Array of Whitelist objects IP白名单分组列表。 表3 Whitelist 参数 参数类型 描述 group_name String 白名单分组名称，每个实例支持创建4个分组。 ip_list Array of strings 白名单分组下的IP列表,每个实例最多可以添加20个IP地址/地址段。如果有多个，可以用逗号分隔。不支持的IP和地址段：0.0.0.0和0.0.0.0/0。

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 results Array of Item objects 删除实例诊断结果 表4 Item 参数 参数类型 描述 result String 诊断结果 id String 诊断报告ID 状态码： 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 查询主维度监控对象成功。 { "router" : [ "dcs_instance_id" ], "total" : 1, "children" : [ { "dim_name" : "dcs_cluster_redis_node", "dim_route" : "dcs_instance_id,dcs_cluster_redis_node" } ], "instances" : [ { "name" : "dcs-test001", "status" : "RUNNING", "dcs_instance_id" : "03ca9da0-1104-40a5-b49d-5ef8e41bfd19" } ], "dcs_cluster_redis_node" : [ { "name" : "(master)192.168.2.145", "status" : "RUNNING", "dcs_instance_id" : "03ca9da0-1104-40a5-b49d-5ef8e41bfd19", "dcs_cluster_redis_node" : "b1f4aa9e4dae50888e58c9caecdfc108" }, { "name" : "(replica)192.168.2.199", "status" : "RUNNING", "dcs_instance_id" : "03ca9da0-1104-40a5-b49d-5ef8e41bfd19", "dcs_cluster_redis_node" : "e0e10e489a73487147928167396474bc" }, { "name" : "(master)192.168.2.243", "status" : "RUNNING", "dcs_instance_id" : "03ca9da0-1104-40a5-b49d-5ef8e41bfd19", "dcs_cluster_redis_node" : "e797c3ba8bee782e25cdd4a90eb00517" }, { "name" : "(replica)192.168.2.164", "status" : "RUNNING", "dcs_instance_id" : "03ca9da0-1104-40a5-b49d-5ef8e41bfd19", "dcs_cluster_redis_node" : "d810fb44f9f7a359e000cf277a824c43" }, { "name" : "(master)192.168.2.95", "status" : "RUNNING", "dcs_instance_id" : "03ca9da0-1104-40a5-b49d-5ef8e41bfd19", "dcs_cluster_redis_node" : "f25c37a4654d50b07e629fc2adfba60f" }, { "name" : "(replica)192.168.2.51", "status" : "RUNNING", "dcs_instance_id" : "03ca9da0-1104-40a5-b49d-5ef8e41bfd19", "dcs_cluster_redis_node" : "da5149a20dc7caf35587e4d2433fe452" } ] }

URI GET /v2/{project_id}/dims/monitored-objects/{instance_id} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户ID。 instance_id 是 String 主维度对象ID，与DCS实例列表中实例ID相同。 表2 Query参数 参数 是否必选 参数类型 描述 dim_name 是 String 主维度ID，当前支持子维度的主维度ID的有dcs_instance_id。

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 router Array of strings 当前查询维度路由。如果是主维度，则数组中是自身ID。 children Array of DimChild objects 当前查询维度子维度对象列表。当前只有维度为dcs_instance_id时才有值。 Proxy集群有两个子维度，分别为dcs_cluster_redis_node和dcs_cluster_proxy_node。 Cluster集群有一个子维度 dcs_cluster_proxy_node。 instances Array of InstancesMonitoredObject objects 当前查询维度监控对象列表。 dcs_cluster_redis_node Array of ClusterRedisNodeMonitoredObject objects Proxy集群或Cluster集群时才存在，表示集群数据节点维度的监控对象列表。字段名称与children的子维度对象名称相同。 dcs_cluster_proxy_node Array of ProxyNodeMonitoredObject objects Redis 3.0 Proxy集群时才存在，表示集群Proxy节点维度的监控对象列表。字段名称与children的子维度对象名称相同。 dcs_cluster_proxy2_node Array of Proxy2NodeMonitoredObject objects Redis 4.0和5.0的Proxy集群时才存在，表示集群Proxy节点维度的监控对象列表。字段名称与children的子维度对象名称相同。 total Integer 主维度监控对象的总数。 表4 DimChild 参数 参数类型 描述 dim_name String 维度名称，当前支持维度有dcs_instance_id、dcs_cluster_redis_node、 dcs_cluster_proxy_node和dcs_memcached_instance_id。 dim_route String 维度的路由，结构为主维度名称,当前维度名称，比如： dim_name字段为dcs_cluster_redis_node时，这个字段的值为dcs_instance_id,dcs_cluster_redis_node。 表5 InstancesMonitoredObject 参数 参数类型 描述 dcs_instance_id String 测量对象ID，即实例的ID。 name String 测量对象名称，即实例名称。 status String 测量对象状态，即实例状态。 表6 ClusterRedisNodeMonitoredObject 参数 参数类型 描述 dcs_instance_id String 测量对象ID，即节点的ID。 name String 测量对象名称，即节点IP。 dcs_cluster_redis_node String 维度dcs_cluster_redis_node的测量对象的ID。 status String 测量对象状态，即节点状态。 表7 ProxyNodeMonitoredObject 参数 参数类型 描述 dcs_instance_id String 测量对象ID，即节点的ID。 name String 测量对象名称，即节点IP。 dcs_cluster_proxy_node String 维度dcs_cluster_proxy_node 的测量对象的ID。 status String 测量对象状态，即节点状态。 表8 Proxy2NodeMonitoredObject 参数 参数类型 描述 dcs_instance_id String 测量对象ID，即节点的ID。 name String 测量对象名称，即节点IP。 dcs_cluster_proxy2_node String 维度dcs_cluster_proxy2_node 的测量对象的ID。 status String 测量对象状态，即节点状态。 状态码： 500 表9 响应Body参数 参数 参数类型 描述 error_msg String 错误信息。 最大长度：1024 error_code String 错误码。 最大长度：9 error_ext_msg String 扩展错误信息（暂未使用，赋值为null）。 最大长度：1024

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 task_id_list Array of strings 删除的迁移任务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

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 report_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

请求示例 创建实例诊断任务，设置诊断的起止时间和需要诊断的节点IP。 POST https://{dcs_endpoint}/v2/{project_id}/instances/{instance_id}/diagnosis { "begin_time" : 1618466522486, "end_time" : 1618467122486, "node_ip_list" : [ "192.168.0.111" ] }

请求参数 表2 请求Body参数 参数 是否必选 参数类型 描述 begin_time 是 String 诊断开始时间。UNIX时间戳，单位毫秒。 end_time 是 String 诊断结束时间。UNIX时间戳，单位毫秒。 node_ip_list 否 Array of strings 诊断节点IP列表。默认诊断所有节点。 非读写分离实例查询方法如下： 方法一：参考查看实例信息。 方法二：调用查询指定实例接口查询。 读写分离实例查询方法：调用查询分片信息接口。

响应示例 状态码： 200 查询迁移日志列表成功。 { "log_num" : 2, "migration_logs" : [ { "created_at" : "2023-05-15T09:14:40.000Z", "keyword" : [ "8abfa7aa87ef158901881ead51a47dcd" ], "log_code" : "migration.0012", "log_level" : "INFO", "message" : "job success, all files import complete.Job id: 8abfa7aa87ef158901881ead51a47dcd." }, { "created_at" : "2023-05-15T09:14:38.000Z", "keyword" : [ "DCS_Cache_Hidden_Image_3.0.10.tar.gz", "1/1" ], "log_code" : "migration.0026", "log_level" : "INFO", "message" : "Migrating files succeeded. File name: DCS_Cache_Hidden_Image_3.0.10.tar.gz; progress: 1/1." } ] } 状态码： 400 非法请求。 { "error_code" : "111400063", "error_msg" : "Invalid {0} parameter in the request." }

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 log_num Integer 日志条数。 migration_logs Array of MigrationLog objects 日志列表。 表4 MigrationLog 参数 参数类型 描述 created_at String 迁移日志生成时间，形如：2023-05-15T09:11:25.449Z。 log_level String 日志级别。 枚举值： INFO ERROR message String 日志信息。 log_code String 日志的编码。 keyword Array of strings 日志中的关键字。 状态码： 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}/migration-task/{task_id}/logs 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。获取方法请参见获取项目ID。 task_id 是 String 数据迁移任务ID。 表2 Query参数 参数 是否必选 参数类型 描述 offset 否 Integer 偏移量，表示从此偏移量开始查询， offset大于等于0。 limit 否 Integer 每页显示的条目数量。 log_level 否 String 日志级别。