华为云用户手册

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 total_num Integer 返回记录数。 backup_record_response Array of BackupRecordResponse objects 备份信息的详情数组。 表4 BackupRecordResponse 参数 参数类型 描述 backup_id String 备份记录ID。 period String 备份执行时间段。 backup_name String 备份记录名称。 instance_id String 实例ID。 size Long 备份文件大小（Byte）。 backup_type String 备份类型。 manual：表示备份类型为手动备份。 auto：表示备份类型为自动备份。 枚举值： manual auto created_at String 备份任务创建时间。 updated_at String 备份完成时间。 progress String 备份进度。 error_code String 备份失败后错误码 dcs.08.0001 - 启动备份恢复工具失败。 dcs.08.0002 - 执行超时。 dcs.08.0003 - 删除桶失败。 dcs.08.0004 - 获取ak/sk 失败。 dcs.08.0005 - 创建桶失败。 dcs.08.0006 - 查询备份数据大小失败。 dcs.08.0007 - 恢复时同步数据失败。 dcs.08.0008 - 自动备份任务未运行，实例正在运行其他任务。 remark String 备份缓存实例的备注信息。 status String 备份状态。 waiting：等待中。 backuping：备份中。 succeed：备份成功。 failed：备份失败。 expired：备份文件过期。 deleted：已手动删除备份文件。 枚举值： waiting backuping succeed failed expired deleted is_support_restore String 是否可以进行恢复操作，取值为TRUE或FALSE。 execution_at String 执行时间。 backup_format String 备份类型。 枚举值： aof rdb 状态码： 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/{instance_id}/backups 表1 路径参数 参数 是否必选 参数类型 描述 instance_id 是 String 实例ID。 project_id 是 String 项目ID。获取方法请参见获取项目ID。 表2 Query参数 参数 是否必选 参数类型 描述 begin_time 否 String 查询开始时间，时间为UTC时间。格式：yyyyMMddHHmmss，如：20170718235959。 end_time 否 String 查询结束时间，时间为UTC时间。格式：yyyyMMddHHmmss，如：20170718235959。 limit 否 Integer 每页显示的条目数量。 offset 否 Integer 偏移量，表示从此偏移量开始查询， offset大于等于0。

响应示例 状态码： 200 查询过期Key扫描记录成功。 { "records" : [ { "id" : "8476c93a-c3bc-494a-924c-29a2e71ea0d9", "instance_id" : "69f99808-34cd-4ce6-ae73-fd03b261b5f3", "status" : "running", "scan_type" : "auto", "num" : 100, "created_at" : "2023-06-13T13:46:14.771Z", "started_at" : "2023-06-13T13:46:15.113Z", "finished_at" : "" } ], "instance_id" : "69f99808-34cd-4ce6-ae73-fd03b261b5f3", "total" : 1, "count" : 1 }

响应参数 状态码： 200 表2 响应Body参数 参数 参数类型 描述 records Array of SimpleKeyScanRecord objects 过期key记录。 instance_id String 实例ID。 total Integer 扫描过期key的总数。 count Integer 扫描过期key的次数。 表3 SimpleKeyScanRecord 参数 参数类型 描述 id String 扫描ID。 instance_id String 实例ID。 status String 扫描状态。 枚举值： waiting running success failed scan_type String 扫描类型。 auto:自动扫描。 manual:手动扫描。 枚举值： auto manual num Integer 一次扫描过期key的数量。 created_at String 创建时间，格式为：2023-06-13T13:46:14.771Z。 started_at String 开始时间，格式为：2023-06-13T13:46:14.771Z。 finished_at String 完成时间，格式为：2020-06-15T02:21:18.669Z。 状态码： 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

URI DELETE /v2/{project_id}/instances/{instance_id}/groups/{group_id}/replications/{node_id}/remove-ip 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。获取方法请参见获取项目ID。 instance_id 是 String 实例ID。 group_id 是 String 分片ID。 node_id 是 String 节点ID。

响应参数 状态码： 200 表2 响应Body参数 参数 参数类型 描述 job_id String 域名摘除IP的任务ID。 状态码： 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

响应参数 状态码： 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参数 参数 参数类型 描述 job_id String 集群分片倒换的任务ID。 状态码： 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

URI POST /v2/{project_id}/instance/{instance_id}/groups/{group_id}/replications/{node_id}/async-switchover 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。获取方法请参见获取项目ID。 instance_id 是 String 实例ID。 group_id 是 String 分片ID。 node_id 是 String 升级为主节点的节点ID。

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

URI GET /v2/{project_id}/instances/{instance_id}/config-histories/{history_id} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。获取方法请参见获取项目ID。 instance_id 是 String 实例ID。 history_id 是 String 实例参数修改记录ID，在实例后台任务中获取。

响应示例 状态码： 200 ACL账户列表。 { "accounts" : [ { "account_id" : "cb067c67-f08b-4024-af14-f78b58b76a44", "account_name" : "roUser", "account_type" : "normal", "instance_id" : "10fda556-51c3-4cfa-ab6f-37667428da6e", "status" : "available", "account_role" : "read", "description" : "这是一个只读账号", "error_code" : null } ] } 状态码： 400 非法请求。 { "error_code" : "DCS.4964", "error_msg" : "Failed to query acl list." }

响应参数 状态码： 200 表2 响应Body参数 参数 参数类型 描述 accounts Array of AclAccountResp objects ACL账号列表。 表3 AclAccountResp 参数 参数类型 描述 account_id String 账号ID。 account_name String 账号名。 account_type String 账号类型，normal：普通账号，default：默认账号。 枚举值： normal default instance_id String 账号所属实例ID。 status String ACL账号状态。 取值范围： CREATING：账号创建中。 AVAILABLE：账号可用。 CREATEFAILED：账号创建失败。 DELETED：账号已删除。 DELETEFAILED：账号删除失败。 DELETING：账号删除中。 UPDATING：账号更新中。 ERROR：账号异常。 枚举值： CREATING AVAILABLE CREATEFAILED DELETED DELETEFAILED DELETING UPDATING ERROR account_role String 账号权限，read：只读账号，write：读写账号。 枚举值： read write description String 账号描述。 error_code String 错误码（该参数暂未使用，赋值为null）。 状态码： 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参数 参数 参数类型 描述 count Integer 查询结果的实例总数。 instances Array of InstanceNodesInfoResp objects 实例列表。 表4 InstanceNodesInfoResp 参数 参数类型 描述 instance_id String 实例ID。 node_count Integer 当前实例节点总数。 nodes Array of NodesInfoResp objects 节点详情。 表5 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不同。 表6 InstanceReplicationDimensionsInfo 参数 参数类型 描述 name String 监控维度名称。 value String 维度取值。 状态码： 500 表7 响应Body参数 参数 参数类型 描述 error_msg String 错误信息。 最大长度：1024 error_code String 错误码。 最大长度：9 error_ext_msg String 扩展错误信息（暂未使用，赋值为null）。 最大长度：1024 状态码： 400 表8 响应Body参数 参数 参数类型 描述 error_msg String 错误信息。 最大长度：1024 error_code String 错误码。 最大长度：9 error_ext_msg String 扩展错误信息（暂未使用，赋值为null）。 最大长度：1024

URI GET /v2/{project_id}/instances-logical-nodes 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。获取方法请参见获取项目ID。 表2 Query参数 参数 是否必选 参数类型 描述 offset 否 Integer 偏移量，表示从此偏移量开始查询，offset大于等于0。 limit 否 Integer 每页显示的条目数量，当前最大值为100。若不设置该参数，则为10。

响应示例 状态码： 200 查询节点信息成功。 { "count" : 1, "instances" : [ { "instance_id" : "b4468cb1-4f75-4866-a49d-86959acc0c9c", "node_count" : 2, "nodes" : [ { "logical_node_id" : "8f997eb512a92834bf5914be52ca8919", "name" : "(replica)192.168.0.178", "status" : "Active", "az_code" : "region01", "node_role" : "redis-server", "node_type" : "slave", "node_ip" : "192.168.0.178", "node_port" : "6379", "node_id" : "8a2c26c17f4d6516017f4d7b77940030", "is_access" : true, "group_id" : "ace962d1-7841-4e50-9313-c239fd75dee3", "group_name" : "group-0", "priority_weight" : 100, "is_remove_ip" : false, "replication_id" : "e40aa09e-03c2-4319-86eb-5ef4ca637544", "dimensions" : [ { "name" : "dcs_instance_id", "value" : "caf2d19f-7783-44b0-be46-8c9da3ef1e94" }, { "name" : "dcs_cluster_redis_node", "value" : "8263dc69629c5b2d840e9816fa9c6200" } ] } ] } ] } 状态码： 500 内部服务错误。 { "error_code" : "DCS.5000", "error_msg" : "Internal service error." } 状态码： 400 非法请求。 { "error_code" : "DCS.4800", "error_msg" : "Invalid offset in the request." }

响应示例 状态码： 200 重置密码成功。 { "job_id" : "ff80808284d4c6d50184e8cff10248bd", "instance_id" : "10fda556-51c3-4cfa-ab6f-37667428da6e" } 状态码： 400 非法请求。 { "error_code" : "DCS.4961", "error_msg" : "Acl account request param invalid." }

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 instance_id String 账号所属实例ID。 job_id String 修改ACL账号访问权限JOB的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参数 参数 参数类型 描述 status String 任务状态。 file_name String 文件名。 link String 实例导出任务报告链接。 err_code String 错误码。 err_msg 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

响应示例 状态码： 200 查询实例参数修改记录列表成功。 { "history_num" : 1, "histories" : [ { "history_id" : "4ae8507f-7992-40e2-9928-41ccf1db4bdc", "type" : "config_param", "created_at" : "2022-10-20T03:37:44.636Z", "status" : "SUCCESS" } ] }

URI GET /v2/{project_id}/instances/{instance_id}/config-histories 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。获取方法请参见获取项目ID。 instance_id 是 String 实例ID。 表2 Query参数 参数 是否必选 参数类型 描述 offset 否 Integer 偏移量，表示从此偏移量开始查询， offset大于等于0。 limit 否 Integer 每页显示条数，最小值为1，最大值为1000，若不设置该参数，则为10。

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 history_num Integer 实例参数修改记录个数。 histories Array of HistoryInfo objects 实例参数修改记录详情。 表4 HistoryInfo 参数 参数类型 描述 history_id String 修改记录ID。 type String 修改类型。 created_at String 修改时间。 status 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

获取子网ID 在购买实例时配置正确的子网ID，才能够成功连接实例。可通过GET /v1/{project_id}/subnets?{vpc_id}获取准确子网ID，其中vpc_id可通过GET /v1/{project_id}/vpcs接口获取。 获取vpc_id的请求示例： GET https://{vpc_endpoint}/v1/7d80ae32f57b499eb8781f9a9f57c538/vpcs {vpc_endpoint}信息，请从地区和终端节点获取。 获取vpc_id的响应示例： { "vpcs": [{ "id": "743bf021-2c2d-4511-aeac-85bd48c06af7", "name": "vpc-d2d4", "description": "", "cidr": "192.168.0.0/16", "status": "OK", "routes": [], "enterprise_project_id": "0" }] } 获取子网ID的请求示例： GET https://{vpc_endpoint}/v1/7d80ae32f57b499eb8781f9a9f57c538/subnets?vpc_id=743bf021-2c2d-4511-aeac-85bd48c06af7 获取子网ID的响应示例： { "subnets": [{ "id": "b0d6e0ac-fcce-4e11-a4a6-707e851ae1c3", "name": "subnet-d2e4", "description": "", "cidr": "192.168.0.0/24", "dnsList": ["100.125.1.250", "100.125.129.250"], "status": "ACTIVE", "vpc_id": "743bf021-2c2d-4511-aeac-85bd48c06af7", "ipv6_enable": false, "gateway_ip": "192.168.0.1", "dhcp_enable": true, "primary_dns": "100.125.1.250", "secondary_dns": "100.125.129.250", "availability_zone": "xxxxxx", "neutron_network_id": "b0d6e0ac-fcce-4e11-a4a6-707e851ae1c3", "neutron_subnet_id": "3d4ccce0-cadc-4af4-8c21-14d2857ffe5e", "extra_dhcp_opts": [] }] }

查看资源的可用配额 如需查询当前账号的资源配额信息，包括已使用的配额，可以通过调用查询租户配额接口。 请求示例： GET https://{dcs_endpoint}/v2/05041fffa40025702f6dc009cc6f8f33/quota 响应示例： { "quotas": { "resources": [ { "quota": 160, "used": 1, "type": "instance", "min": 0, "max": 2147483647, "unit": null }, { "quota": 64000, "used": 0, "type": "ram", "min": 0, "max": 1048576, "unit": "GB" } ] } } 当type为instance时，max表示可申请实例配额的最大值，min表示可申请实例配额的最小值。 当type为ram时，max表示可申请内存配额的最大值，min表示可申请内存配额的最小值。 quota为可以创建的实例最大数和总内存的配额限制。 used为已创建的实例个数和已使用的内存配额。

使用API购买实例时设置副本数 使用API购买实例后，副本数的值取决于在购买时输入的spec_code参数。副本数即为查询产品规格接口响应示例的replica_count值。 请求示例： GET https://{dcs_endpoint}/v2/flavors?cache_mode={cache_mode}&engine={engine}&engine_version={engine_version}&cpu_type={cpu_type}&capacity={capacity} 响应示例： { "flavors": [ { "dec": false, "spec_code": "redis.ha.xu1.large.r4.2", "cloud_service_type_code": "hws.service.type.dcs", "cloud_resource_type_code": "hws.resource.type.dcs3", "cache_mode": "ha", "engine": "redis", "engine_version": "4.0;5.0", "product_type": "generic", "cpu_type": "x86_64", "storage_type": "DRAM", "capacity": [ "2" ], "billing_mode": [ "Hourly", "Monthly", "Yearly" ], "tenant_ip_count": 4, "pricing_type": "normal", "is_dec": false, "attrs": [ { "capacity": "2", "name": "max_memory", "value": "2" }, { "capacity": "2", "name": "max_connections", "value": "50000" }, { "capacity": "2", "name": "sharding_num", "value": "1" }, { "capacity": "2", "name": "proxy_num", "value": "0" }, { "capacity": "2", "name": "db_number", "value": "256" }, { "capacity": "2", "name": "max_clients", "value": "10000" }, { "capacity": "2", "name": "max_bandwidth", "value": "128" } ], "flavors_available_zones": [ { "capacity": "2", "unit": "GB", "available_zones": [ "a0865121f83b41cbafce65930a22a6e8", "15dcd3f789cb4fc088dbdece9c5eb547", "2dcb154ac2724a6d92e9bcc859657c1e", "effdcbc7d4d64a02aa1fa26b42f56533" ], "az_codes": [ "xx-xx-xx1", "xx-xx-xx2", "xx-xx-xx3", "xx-xx-xx4" ] } ], "replica_count": 4, "inquery_spec_code": null } ] } 在购买实例时，输入的spec_code参数须与capacity参数一一对应。

购买实例时可用区资源不足 在购买实例时，如需要查询某一规格在某可用区是否资源充足，可通过调用查询产品规格查看规格所在可用区的详细信息，通过flavors_available_zones的值判断该规格可选的可用区。 如在某region、规格为redis.ha.xu1.large.r2.2的资源充足可用区的信息，请求示例： https://{dcs_endpoint}/v2/05041fffa40025702f6dc009cc6f8f33/flavors?spec_code=redis.ha.xu1.large.r2.2 响应示例： { "flavors": [ { "dec": false, "spec_code": "redis.ha.xu1.large.r2.2", "cloud_service_type_code": "hws.service.type.dcs", "cloud_resource_type_code": "hws.resource.type.dcs3", "cache_mode": "ha", "engine": "redis", "engine_version": "4.0;5.0", "product_type": "generic", "cpu_type": "x86_64", "storage_type": "DRAM", "capacity": [ "2" ], "billing_mode": [ "Hourly", "Monthly", "Yearly" ], "tenant_ip_count": 2, "pricing_type": "normal", "is_dec": false, "attrs": [ { "capacity": "2", "name": "max_memory", "value": "2" }, { "capacity": "2", "name": "max_connections", "value": "50000" }, { "capacity": "2", "name": "sharding_num", "value": "1" }, { "capacity": "2", "name": "proxy_num", "value": "0" }, { "capacity": "2", "name": "db_number", "value": "256" }, { "capacity": "2", "name": "max_clients", "value": "10000" }, { "capacity": "2", "name": "max_bandwidth", "value": "128" } ], "flavors_available_zones": [ { "capacity": "2", "unit": "GB", "available_zones": [ "a0865121f83b41cbafce65930a22a6e8", "15dcd3f789cb4fc088dbdece9c5eb547", "2dcb154ac2724a6d92e9bcc859657c1e", "effdcbc7d4d64a02aa1fa26b42f56533" ], "az_codes": [ "xx-xx-xx1", "xx-xx-xx2", "xx-xx-xx3", "xx-xx-xx4" ] } ], "replica_count": 2, "inquery_spec_code": null } ] } 其中flavors_available_zones罗列出了该规格资源充足的可用区。

购买包周期实例 您可使用创建缓存实例接口购买包周期实例，其与购买按需实例的区别在于，购买实例的body体中，将bss_param.charging_mode字段配置为“prePaid”， bss_param的详细介绍请参考表3 BssParam。 如下请求体所示，在cn-north-4区域购买一个包周期DCS实例，时长为一个月，且下单后不自动续订，不自动付费。 { "name": "test", "engine": "Redis", "engine_version": "5.0", "capacity": 2, "spec_code": "redis.ha.xu1.large.r2.2", "az_codes": [ "cn-north-4a" ], "vpc_id": "c29eade3-05d3-41a3-84e4-2cc1f3057502", "subnet_id": "b573d369-2b49-4595-8727-2408244a7675", "no_password_access": true, "bss_param": { "charging_mode": "prePaid", "is_auto_pay": "false", "period_type": "month", "period_num": 2 }, "instance_backup_policy": { "backup_type": "auto", "save_days": 2, "periodical_backup_plan": { "backup_at": [ 2 ], "period_type": "weekly", "begin_at": "00:00-01:00" } }, "tags": [ { "key": "test", "value": "123" } ] } 购买任务提交成功后，会返回以下order_id，即订单ID。 { "instance_id": "23be3a34-8cc1-4eab-9ad2-b085eadee9c4", "order_id": "CS2111091732PY0DE", "instances": [ { "instance_id": "23be3a34-8cc1-4eab-9ad2-b085eadee9c4", "instance_name": "test" } ] } 上面请求体中bss_param.is_auto_pay取值为false或不填该字段则需要手动去支付，手动支付可以填写优惠券和折扣券等信息。手动支付需要调用支付包年/包月产品订单支付，示例如下。 POST https://bss.myhuaweicloud.com/v2/orders/customer-orders/pay { "order_id": "CS2111091732PY0DE" }

删除包周期实例 包周期的DCS实例无法直接删除，需要调用退订包年/包月资源接口进行退订。 POST https://bss.myhuaweicloud.com/v2/orders/subscriptions/resources/unsubscribe { "resource_ids": [ "44b393c8-e4e4-4dcb-bad3-54858dcc72c7" ], "unsubscribe_type": 1 } 其中resource_ids表示资源ID，对退订DCS来说，就是购买包周期DCS时返回的instance_id。

响应示例 状态码： 200 查询实例配置参数成功。 { "instance_id" : "50829e5a-a4fc-4c01-8651-80be8a491602", "config_status" : "SUCCESS", "config_time" : "2020-07-06T07:04:31.464Z", "redis_config" : [ { "param_id" : "1", "param_name" : "timeout", "description" : "Close the connection after a client is idle for N seconds (0 to disable)", "param_value" : "101", "value_range" : "0-7200", "value_type" : "Interger", "default_value" : "0" } ], "status" : "RUNNING" }

响应参数 状态码： 200 表2 响应Body参数 参数 参数类型 描述 config_time String 实例操作时间。格式为：2017-03-31T12:24:46.297Z instance_id String 实例ID。 redis_config Array of QueryRedisConfig objects 实例配置项数组。 config_status String 实例修改状态。 UPDATING FAILURE SUCCESS 枚举值： UPDATING FAILURE SUCCESS status String 实例运行状态。 表3 QueryRedisConfig 参数 参数类型 描述 param_value String 配置参数值。 value_type String 配置参数的值类型。 value_range String 配置参数的取值范围。 description String 配置项的描述。 default_value String 配置参数的默认值。 param_name String 配置参数名称。 param_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