华为云用户手册

状态码 状态码如表1所示。 表1 状态码 状态码 编码 错误码说明 100 Continue 继续请求。 这个临时响应用来通知客户端，它的部分请求已经被服务器接收，且仍未被拒绝。 101 Switching Protocols 切换协议。只能切换到更高级的协议。 例如，切换到HTTP的新版本协议。 201 Created 创建类的请求完全成功。 202 Accepted 已经接受请求，但未处理完成。 203 Non-Authoritative Information 非授权信息，请求成功。 204 NoContent 请求完全成功，同时HTTP响应不包含响应体。 在响应OPTIONS方法的HTTP请求时返回此状态码。 205 Reset Content 重置内容，服务器处理成功。 206 Partial Content 服务器成功处理了部分GET请求。 300 Multiple Choices 多种选择。请求的资源可包括多个位置，相应可返回一个资源特征与地址的列表用于用户终端（例如：浏览器）选择。 301 Moved Permanently 永久移动，请求的资源已被永久的移动到新的URI，返回信息会包括新的URI。 302 Found 资源被临时移动。 303 See Other 查看其它地址。 使用GET和POST请求查看。 304 Not Modified 所请求的资源未修改，服务器返回此状态码时，不会返回任何资源。 305 Use Proxy 所请求的资源必须通过代理访问。 306 Unused 已经被废弃的HTTP状态码。 400 BadRequest 非法请求。 建议直接修改该请求，不要重试该请求。 401 Unauthorized 在客户端提供认证信息后，返回该状态码，表明服务端指出客户端所提供的认证信息不正确或非法。 402 Payment Required 保留请求。 403 Forbidden 请求被拒绝访问。 返回该状态码，表明请求能够到达服务端，且服务端能够理解用户请求，但是拒绝做更多的事情，因为该请求被设置为拒绝访问，建议直接修改该请求，不要重试该请求。 404 NotFound 所请求的资源不存在。 建议直接修改该请求，不要重试该请求。 405 MethodNotAllowed 请求中带有该资源不支持的方法。 建议直接修改该请求，不要重试该请求。 406 Not Acceptable 服务器无法根据客户端请求的内容特性完成请求。 407 Proxy Authentication Required 请求要求代理的身份认证，与401类似，但请求者应当使用代理进行授权。 408 Request Time-out 服务器等候请求时发生超时。 客户端可以随时再次提交该请求而无需进行任何更改。 409 Conflict 服务器在完成请求时发生冲突。 返回该状态码，表明客户端尝试创建的资源已经存在，或者由于冲突请求的更新操作不能被完成。 410 Gone 客户端请求的资源已经不存在。 返回该状态码，表明请求的资源已被永久删除。 411 Length Required 服务器无法处理客户端发送的不带Content-Length的请求信息。 412 Precondition Failed 未满足前提条件，服务器未满足请求者在请求中设置的其中一个前提条件。 413 Request Entity Too Large 由于请求的实体过大，服务器无法处理，因此拒绝请求。为防止客户端的连续请求，服务器可能会关闭连接。如果只是服务器暂时无法处理，则会包含一个Retry-After的响应信息。 414 Request-URI Too Large 请求的URI过长（URI通常为网址），服务器无法处理。 415 Unsupported Media Type 服务器无法处理请求附带的媒体格式。 416 Requested range not satisfiable 客户端请求的范围无效。 417 Expectation Failed 服务器无法满足Expect的请求头信息。 422 UnprocessableEntity 请求格式正确，但是由于含有语义错误，无法响应。 429 TooManyRequests 表明请求超出了客户端访问频率的限制或者服务端接收到多于它能处理的请求。建议客户端读取相应的Retry-After首部，然后等待该首部指出的时间后再重试。 500 InternalServerError 表明服务端能被请求访问到，但是不能理解用户的请求。 501 Not Implemented 服务器不支持请求的功能，无法完成请求。 502 Bad Gateway 充当网关或代理的服务器，从远端服务器接收到了一个无效的请求。 503 ServiceUnavailable 被请求的服务无效。 建议直接修改该请求，不要重试该请求。 504 ServerTimeout 请求在给定的时间内无法完成。客户端仅在为请求指定超时（Timeout）参数时会得到该响应。 505 HTTP Version not supported 服务器不支持请求的HTTP协议的版本，无法完成处理。 父主题： 附录

调用API获取项目ID 项目ID可以通过调用查询指定条件下的项目信息API获取。 获取项目ID的接口为“GET https://{Endpoint}/v3/projects”，其中{Endpoint}为IAM的终端节点，可以从地区和终端节点获取。接口的认证鉴权请参见认证鉴权。 响应示例如下，其中projects下的“id”即为项目ID。 { "projects": [ { "domain_id": "65382450e8f64ac0870cd180d14e684b", "is_domain": false, "parent_id": "65382450e8f64ac0870cd180d14e684b", "name": "XXXXX", "description": "", "links": { "next": null, "previous": null, "self": "https://www.example.com/v3/projects/a4a5d4098fb4474fa22cd05f897d6b99" }, "id": "a4a5d4098fb4474fa22cd05f897d6b99", "enabled": true } ], "links": { "next": null, "previous": null, "self": "https://www.example.com/v3/projects" }}

响应消息 响应参数 参数说明见表1。 表1 参数说明 参数 类型 说明 products Array 产品列表。 表2 products参数说明 参数 类型 备注 product_id String DCS服务对外销售的产品ID。 参数取值格式为：spec_code+“-” + 计费模式缩写，计费模式缩写取值范围有：h、m、y。其中，h表示计费模式为按需；m表示计费模式为包月；y表示计费模式为包年。 例如：redis.single.au1.large.1-h，表示规格redis.single.au1.large.1的按需计费产品ID。 说明： 在查询产品规格中获取product_id时，请务必确保获取的product_id对应的计费模式和您选择的计费模式一致。例如，要订购按需计费、实例类型为Redis3.0的主备实例，可从接口响应消息中，查找charging_type字段为Hourly、spec_code字段为dcs.master_standby的记录对应的product_id。 spec_code String DCS的产品规格编码。 dcs.single_node dcs.master_standby dcs.cluster cache_mode String 缓存实例类型。取值范围如下： single：表示单机 ha：表示主备实例 cluster：表示集群 proxy：表示Proxy集群 ha_rw_split：表示读写分离 product_type String Redis缓存实例的产品类型。 cpu_type String CPU架构类型。 storage_type String 存储类型。 details Array 规格详细描述，具体参数，请参考表3。 engine String 缓存引擎类型。 engine_versions String 支持的引擎版本号。 spec_details String 产品的规格大小。具体以查询结果为准。 spec_details2 String DCS的规格详细信息，如最大连接数和最大使用内存等。 charging_type String 计费类型，取值为：Yearly、Monthly、Hourly。 price doubule 价格。（已废弃，无实际意义，请不要使用。） currency String 货币单位。 prod_type String 产品类型，取值为instance或者obs_space。 cloud_service_type_code String 云服务类型编码。 cloud_resource_type_code String 云资源类型编码。 flavors Array 有资源的可用区，具体参数，请参考表4。 billing_factor String 计费因子。 表3 details参数说明 参数 类型 备注 capacity String 缓存实例的内存规格。 max_bandwidth String 该规格支持的最大带宽。 max_clients String 该规格支持的最大客户端数，一般等于最大连接数。 max_connections String 该规格支持的最大连接数。 max_in_bandwidth String 该规格支持的最大接入带宽，一般等于最大带宽。 max_memory String 实际可使用的最大内存。 tenant_ip_count String 该规格实例对应的租户侧IP数量。 sharding_num String 该规格实例支持的分片数。 proxy_num String 该规格Proxy实例支持的Proxy节点数量。如果不是Proxy实例，该参数为0。 db_number String 该规格实例的DB数量。 表4 flavors参数说明 参数 类型 备注 capacity String 缓存实例的内存规格。 unit String 容量单位 available_zones Array 可用区ID。 响应示例 {"product_id": "dcs.master_standby-h","spec_code": "dcs.master_standby","cache_mode": "ha","product_type": "generic","cpu_type": "x86_64","storage_type": "DRAM","details": {"capacity": 2,"max_memory": 1.5,"max_connections": 10000,"max_clients": 5000,"max_bandwidth": 512,"max_in_bandwidth": 42,"tenant_ip_count": 3,"sharding_num": 1,"proxy_num": 0,"db_number": 256},"engine": "redis","engine_versions": "3.0","spec_details": "[{\"mem\":\"2,4,8,16,32,64\"}]","spec_details2": "[{\"capacity\":2,\"max_memory\":1.5,\"max_connections\":10000,\"max_clients\":5000,\"max_bandwidth\":512,\"max_in_bandwidth\":42,\"tenant_ip_count\":3,\"sharding_num\":1,\"proxy_num\":0,\"db_number\":256},{\"capacity\":4,\"max_memory\":3.2,\"max_connections\":10000,\"max_clients\":5000,\"max_bandwidth\":1536,\"max_in_bandwidth\":64,\"tenant_ip_count\":3,\"sharding_num\":1,\"proxy_num\":0,\"db_number\":256},{\"capacity\":8,\"max_memory\":6.4,\"max_connections\":10000,\"max_clients\":5000,\"max_bandwidth\":1536,\"max_in_bandwidth\":64,\"tenant_ip_count\":3,\"sharding_num\":1,\"proxy_num\":0,\"db_number\":256},{\"capacity\":16,\"max_memory\":12.8,\"max_connections\":10000,\"max_clients\":5000,\"max_bandwidth\":3072,\"max_in_bandwidth\":85,\"tenant_ip_count\":3,\"sharding_num\":1,\"proxy_num\":0,\"db_number\":256},{\"capacity\":32,\"max_memory\":25.6,\"max_connections\":10000,\"max_clients\":5000,\"max_bandwidth\":3072,\"max_in_bandwidth\":85,\"tenant_ip_count\":3,\"sharding_num\":1,\"proxy_num\":0,\"db_number\":256},{\"capacity\":64,\"max_memory\":51.2,\"max_connections\":12000,\"max_clients\":5000,\"max_bandwidth\":5120,\"max_in_bandwidth\":128,\"tenant_ip_count\":3,\"sharding_num\":1,\"proxy_num\":0,\"db_number\":256}]","charging_type": "Hourly","price": 0.0,"currency": "","prod_type": "instance","cloud_service_type_code": "hws.service.type.dcs","cloud_resource_type_code": "hws.resource.type.dcs","flavors": [{"capacity": "2","unit": "GB","available_zones": ["882f6e449e3245dbb8c1c0fafa494c89","ae04cf9d61544df3806a3feeb401b204","d573142f24894ef3bd3664de068b44b0"]},{"capacity": "4","unit": "GB","available_zones": ["882f6e449e3245dbb8c1c0fafa494c89","ae04cf9d61544df3806a3feeb401b204","d573142f24894ef3bd3664de068b44b0"]},{"capacity": "8","unit": "GB","available_zones": ["882f6e449e3245dbb8c1c0fafa494c89","ae04cf9d61544df3806a3feeb401b204","d573142f24894ef3bd3664de068b44b0"]},{"capacity": "16","unit": "GB","available_zones": ["882f6e449e3245dbb8c1c0fafa494c89","ae04cf9d61544df3806a3feeb401b204","d573142f24894ef3bd3664de068b44b0"]},{"capacity": "32","unit": "GB","available_zones": ["882f6e449e3245dbb8c1c0fafa494c89","ae04cf9d61544df3806a3feeb401b204","d573142f24894ef3bd3664de068b44b0"]},{"capacity": "64","unit": "GB","available_zones": ["882f6e449e3245dbb8c1c0fafa494c89","ae04cf9d61544df3806a3feeb401b204","d573142f24894ef3bd3664de068b44b0"]}],"billing_factor": "Duration"}

缓存实例状态说明 表1 缓存实例状态说明 状态 说明 CREATING 申请缓存实例后，在缓存实例状态进入运行中之前的状态。 CREATEFAILED 缓存实例处于创建失败的状态。 RUNNING 缓存实例正常运行状态。 在这个状态的实例可以运行您的业务。 ERROR 缓存实例处于故障的状态。 RESTARTING 缓存实例正在进行重启操作。 FROZEN 缓存实例处于已冻结状态，用户可以在“我的订单”中续费开启冻结的缓存实例。 EXTENDING 缓存实例处于正在扩容的状态。 RESTORING 缓存实例数据恢复中的状态。 FLUSHING 缓存实例数据清空中的状态。 父主题： 附录

响应消息 响应参数 参数说明见表2。 表2 参数说明 参数 类型 说明 domain_id String 租户ID。 domain_name String 租户名称。 free_trials JSON 免费试用信息。 one_yuan_trials JSON 1元试用信息。 表3 free_trials和one_yuan_trials中的参数说明 参数 类型 说明 engine String 引擎类型。取值包括Redis和Memcached。 version String 引擎版本。 support Boolean 是否支持试用。 cause_id String 不支持的原因ID。 message String 额外消息。 表4 cause_id取值说明 cause_id 说明 111400129 暂时没有免费试用活动。 111400125 用户免费试用限额已经用完，或者暂不支持参加该免费试用活动。 响应示例 {"domain_id": "xx","domain_name": "xx","free_trials": [{"engine": "redis","support": true,"cause_id": "xxx","message": "xx"}]}

响应消息 响应参数 参数说明见表1。 表1 响应参数说明 参数 类型 备注 maintain_windows Array 支持的维护时间窗列表 表2 maintain_windows参数说明 参数 类型 备注 seq Integer 序号。 begin String 维护时间窗开始时间。 end String 维护时间窗结束时间。 default Boolean 是否为默认时间段。 响应示例 { "maintain_windows": [ { "seq": 1, "begin": "22", "end": "02", "default": false }, { "seq": 2, "begin": "02", "end": "06", "default": true }, { "seq": 3, "begin": "06", "end": "10", "default": false }, { "seq": 4, "begin": "10", "end": "14", "default": false }, { "seq": 5, "begin": "14", "end": "18", "default": false }, { "seq": 6, "begin": "18", "end": "22", "default": false } ]}

响应消息 响应参数 参数说明见表1。 表1 参数说明 参数 类型 说明 regionId String 区域ID。 available_zones Array 可用区数组，具体请参考表2。 表2 available_zones参数说明 参数 类型 说明 id String 可用区ID。 code String 可用区编码。 name String 可用区名称。 port String 可用区端口号。 resource_availability String 分区上是否还有可用资源。 true：还有资源。 false：资源已售罄。 响应示例

响应消息 响应参数 参数说明见表2。 表2 参数说明 参数 类型 必选 说明 quotas JSON 是 配额信息。参见表3。 表3 quotas参数说明 参数 类型 必选 说明 resources Array 是 配额列表。参见表4。 resource_user JSON 是 资源租户信息。参见表5。 表4 resources参数说明 参数 类型 说明 quota Integer 可以创建的实例最大数和总内存的配额限制。 used Integer 已创建的实例个数和已使用的内存配额。 type String 支持instance、ram两种。 instance表示实例配额。 ram表示内存配额。 unit String 资源的计数单位。 当type为instance时，无单位。 当type为ram时，单位为GB。 max Integer 当type为instance时，表示可申请实例配额的最大值。 当type为ram时，表示可申请内存配额的最大值。 min Integer 当type为instance时，表示可申请实例配额的最小值。 当type为ram时，表示可申请内存配额的最小值。 表5 resource_user参数说明 参数 类型 说明 tenant_id String 资源租户id。 tenant_name Integer 资源租户名称。 响应示例 { "quotas": { "resources": [ { "quota": 10, "used": 3, "type": "instance", "min": 1, "max": 10, "unit": null }, { "quota": 800, "used": 22, "type": "ram", "min": 1, "max": 800, "unit": "GB" } ], "resource_user": { "tenant_id": "836152f9838a44089f40f3cf6fd432bf", "tenant_name": "op_svc_dcs_003" } }}

URI GET /v1.0/{project_id}/instances/{instance_id}/restores?start={start}&limit={limit}&beginTime={beginTime}&endTime={endTime} 参数说明见表1。 表1 参数说明 参数 类型 必选 说明 project_id String 是 项目ID。 instance_id String 是 实例ID。 start Integer 否 待查询的恢复记录的起始序号，默认起始序号为1。 limit Integer 否 每页显示条数，最小值为1，若不设置该参数，默认显示10条。 beginTime String 否 查询开始时间。格式：yyyyMMddHHmmss，如：20170718235959。 endTime String 否 查询结束时间。格式：yyyyMMddHHmmss，如：20170718235959。

响应消息 响应参数 参数说明见表2。 表2 参数说明 参数 类型 说明 restore_record_response Array 实例恢复记录的详情数组。 total_num Integer 返回记录数。 表3 restore_record_response参数说明 参数 类型 说明 status String 恢复状态。 waiting：等待中 restoring：恢复中 succeed：恢复成功 failed：恢复失败 progress String 恢复进度。 restore_id String 恢复记录ID。 backup_id String 备份ID。 restore_remark String 恢复备注信息。 backup_remark String 备份备注信息。 created_at String 恢复任务创建时间。 updated_at String 恢复完成时间。 restore_name String 恢复记录名称 backup_name String 备份记录名称。 error_code String 恢复失败后错误码，参见表4。 响应示例 { "restore_record_response": [ { "status": "succeed", "progress": "100.00", "restore_id": "a6155972-800c-4170-a479-3231e907d2f6", "backup_id": "f4823e9e-fe9b-4ffd-be79-4e5d6de272bb", "restore_remark": "doctest", "backup_remark": null, "created_at": "2017-07-18T21:41:20.721Z", "updated_at": "2017-07-18T21:41:35.182Z", "restore_name": "restore_20170718214120", "backup_name": "backup_20170718000002", "error_code": null } ], "total_num": 1}

响应消息 响应参数 参数说明见表2。 表2 参数说明 参数 类型 说明 backup_record_response Array 备份信息的详情数组，具体请参考表3。 total_num Integer 返回记录数。 表3 backup_record_response参数说明 参数 类型 说明 status String 备份状态。 waiting：等待中。 backuping：备份中。 succeed：备份成功。 failed：备份失败。 expired：备份文件过期。 deleted：已手动删除备份文件。 remark String 备份缓存实例的备注信息。 period String 备份执行时间段。 progress String 备份进度。 size Long 备份文件大小（Byte）。 instance_id String 实例ID。 backup_id String 备份ID。 created_at String 备份任务创建时间。 updated_at String 备份完成时间。 execution_at String 备份任务执行时间。 backup_type String 备份类型。 manual：表示备份类型为手动备份 auto：表示备份类型为自动备份 backup_name String 备份记录名称。 error_code String 备份失败后错误码，参见表4。 is_support_restore String 是否可以进行恢复操作，取值为TRUE或FALSE。 表4 DCS备份恢复错误码 错误码 说明 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 自动备份任务未运行，实例正在运行其他任务。 响应示例 { "backup_record_response": [ { "status": "succeed", "remark": "001", "period": null, "progress": "100.00", "size": 880232, "instance_id": "5560df16-cebf-4473-95c4-d1b573c16e79", "backup_id": "4631832a-14c6-45b0-a0b3-3abd8f591ad1", "created_at": "2019-05-10T08:31:16.166Z", "updated_at": "2019-05-10T08:32:30.546Z", "execution_at": "2019-05-10T08:31:21.461Z", "backup_type": "manual", "backup_name": "backup_20190510163116", "error_code": null, "is_support_restore": "TRUE" } ], "total_num": 1}

URI GET /v1.0/{project_id}/instances/{instance_id}/backups?start={start}&limit={limit}&beginTime={beginTime}&endTime={endTime} 参数说明见表1。 表1 参数说明 参数 类型 必选 说明 project_id String 是 项目ID。 instance_id String 是 实例ID。 start Integer 否 待查询的备份记录的起始序号，默认起始序号为1。 limit Integer 否 每页显示条数，最小值为1，若不设置该参数，默认显示10条。 beginTime String 否 查询开始时间。格式：yyyyMMddHHmmss，如：20170718235959。 endTime String 否 查询结束时间。格式：yyyyMMddHHmmss，如：20170718235959。

URI DELETE /v1.0/{project_id}/instances/{instance_id}/backups/{backup_id} 参数说明见表1。 表1 参数说明 参数 类型 必选 说明 project_id String 是 项目ID。 instance_id String 是 实例ID。 backup_id String 是 备份记录ID 示例 DELETE https://{dcs_endpoint}/v1.0/885cacf2d49d4bb6931ae668e9c07553/instances/e016385d-b9fa-4bf0-9f38-9379f4a5293f/backups/75509c85-50a6-4525-ad56-a1bb62e84570

请求消息 请求参数 参数说明见表2。 表2 参数说明 参数 类型 必选 说明 remark String 否 恢复缓存实例的备注信息。 backup_id String 是 备份ID。 请求示例 POST https://{dcs_endpoint}/v1.0/{project_id}/instances/{instance_id}/restores { "remark":"restore instance", "backup_id":"8ba256cb-e5ac-44f6-a3da-c03d8f0e5029"}

请求消息 请求参数 参数说明见表2。 表2 参数说明 参数 类型 必选 说明 action String 是 对实例的操作：restart、flush。 说明： 当前版本，只有DCS2.0实例支持清空数据功能，即flush操作。 instances Array 是 实例的ID列表。 请求示例 PUT https://{dcs_endpoint}/v1.0/{project_id}/instances/status { "action": "restart", "instances": [ "2e803f66-fbb0-47ad-b6cb-fb87f5bed4ef" ]}

响应消息 响应参数 参数说明见表3。 表3 参数说明 参数 类型 说明 results Array 修改实例的结果。 表4 results参数说明 参数 类型 说明 instance String 缓存实例ID。 result String 操作结果：success、failed。 响应示例 { "results": [ { "result": "success", "instance": "2e803f66-fbb0-47ad-b6cb-fb87f5bed4ef" } ]}

URI GET /v1.0/{project_id}/instances/status?includeFailure={includeFailure} 参数说明见表1。 表1 参数说明 参数 类型 必选 说明 project_id String 是 项目ID。 includeFailure String 否 是否返回创建失败的实例数。 当参数值为“true”时，返回的统计包括创建失败的实例数。 参数值为“false”或者其他值，返回的统计不包括创建失败的实例数。

响应消息 响应参数 参数说明见表2。 表2 参数说明 参数 类型 说明 creating_count Integer 正在创建的实例数。 frozen_count Integer 已冻结的实例数。 deleting_count Integer 正在删除的实例数。 running_count Integer 正在运行的实例数。 error_count Integer 异常的实例数。 restarting_count Integer 正在重启的实例数。 createfailed_count Integer 创建失败的实例数。 extending_count Integer 扩容中的实例数。 响应示例 { "extending_count": 0, "creating_count": 0, "deleting_count": 0, "running_count": 16, "error_count": 0, "frozen_count": 0, "restarting_count": 0, "createfailed_count": 44}

响应消息 响应参数 参数说明见表2。 表2 参数说明 参数 类型 说明 statistics Array 该租户下处于“运行中”状态的实例的统计信息，具体请参考表3。 表3 statistics参数说明 参数 类型 说明 keys Integer 缓存存储的数据条数。 instance_id String 实例ID。 used_memory Integer 缓存已经使用内存，单位：MB。 max_memory Integer 缓存的总内存，单位：MB。 cmd_get_count Integer 缓存get命令被调用次数。 cmd_set_count Integer 缓存set命令被调用次数。 used_cpu String CPU使用率，单位：百分比。 input_kbps String 缓存实例网络入流量，单位：Kbps。 output_kbps String 缓存实例网络出流量，单位：Kbps。 响应示例 { "statistics" : [{ "keys" : 0, "instance_id" : "e008652d-18e0-43ff-924e-072261e0372a", "used_memory" : 0, "max_memory" : 460, "cmd_get_count" : 0, "cmd_set_count" : 0, "used_cpu" : "0.0", "input_kbps" : "0.0", "output_kbps" : "0.0" }, { "keys" : 0, "instance_id" : "c577a1eb-33b7-42c7-8231-ad32358599ac", "used_memory" : 0, "max_memory" : 460, "cmd_get_count" : 0, "cmd_set_count" : 0, "used_cpu" : "0.0", "input_kbps" : "0.0", "output_kbps" : "0.0" }, { "keys" : 0, "instance_id" : "e8b98471-55d5-4695-b0bb-8f336a98e207", "used_memory" : 0, "max_memory" : 460, "cmd_get_count" : 0, "cmd_set_count" : 0, "used_cpu" : "0.0", "input_kbps" : "0.03", "output_kbps" : "1.19" }, { "keys" : 0, "instance_id" : "bc61c690-4b34-4cbe-9ce3-11246aea7aba", "used_memory" : 0, "max_memory" : 6963, "cmd_get_count" : 0, "cmd_set_count" : 0, "used_cpu" : "0.0", "input_kbps" : "0.0", "output_kbps" : "0.0" } ]}

请求消息 请求参数 参数说明见表2。 表2 参数说明 参数 类型 必选 说明 redis_config Array 是 实例配置项数组。 表3 redis_config参数说明 字段 类型 必选 说明 param_id String 是 实例配置项ID。 param_name String 是 实例配置项名。 param_value String 是 实例配置项的值。 对于表3的参数值要求可参考表4。 请求示例 PUT https://{dcs_endpoint}/v1.0/{project_id}/instances/{instance_id}/configs { "redis_config": [ { "param_id": "1", "param_name": "timeout", "param_value": "100" } ] }

请求消息 请求参数 参数说明见表2。 表2 参数说明 参数 类型 必选 说明 instances Array 否 实例的ID列表。 仅当URI中参数allFailure值为“false”或者其他值时，才需要配置该参数。 一次最多可删除50个实例。 请求URL: DELETE https://{dcs_endpoint}/v1.0/{project_id}/instances?allFailure={allFailure} 当allFailure为false时，请求示例如下： { "instances": [ "54602a9d-5e22-4239-9123-77e350df4a34", "7166cdea-dbad-4d79-9610-7163e6f8b640" ]}

URI DELETE /v1.0/{project_id}/instances?allFailure={allFailure} 参数说明见表1。 表1 参数说明 参数 类型 必选 说明 project_id String 是 项目ID。 allFailure String 否 是否批量删除创建失败的缓存实例。 取值如下： true，表示删除租户所有创建失败的缓存实例，此时请求参数instances可为空； false或者其他值，表示删除instances参数数组中指定的缓存实例。

请求消息 请求参数 参数说明见表2。 表2 参数说明 参数 类型 必选 说明 new_capacity Integer 是 新的缓存实例规格，新的规格必须大于扩容前的规格，单位：GB。 取值必须是当前产品支持的实例规格，具体取值，请查看《产品介绍》手册的实例规格章节，查找到对应的“内存规格（GB）”列。 spec_code String 是 扩容后的缓存实例产品规格编码。 如果是Redis3.0实例，该字段为可选。 如果是Redis4.0和Redis5.0实例，该字段为必选。 具体取值，请查看《产品介绍》手册的实例规格章节，查找到对应的“产品规格名称”列。 请求示例 POST https://{dcs_endpoint}/v1.0/{project_id}/instances/{instance_id}/extend

响应消息 响应参数 当URI中参数allFailure值为true时，响应返回为空。当URI中参数allFailure值为false时，参数说明见表3。 表3 参数说明 参数 类型 说明 results Array 删除实例的结果，具体请参考表4。 表4 results参数说明 参数 类型 说明 instance String 缓存实例ID。 result String 操作结果，取值有success或failed。 响应示例 { "results": [ { "instance": "54602a9d-5e22-4239-9123-77e350df4a34", "result": "success" }, { "instance": "7166cdea-dbad-4d79-9610-7163e6f8b640", "result": "success" } ]}

响应消息 响应参数 参数说明见表2。 表2 参数说明 参数 类型 说明 instances Array 实例的详情数组。 instance_num Integer 实例个数。 表3 instance参数说明 参数 类型 说明 name String 实例名称。 engine String 缓存引擎。 capacity Integer 缓存容量（G Byte）。 ip String 连接缓存实例的IP地址。如果是集群实例，返回多个IP地址，使用逗号分隔。如：192.168.0.1，192.168.0.2。 domainName String 实例的域名。 port Integer 缓存的端口。 status String 缓存实例的状态。详细状态说明见缓存实例状态说明。 max_memory Integer 总内存，单位：MB。 used_memory Integer 已使用的内存，单位：MB。 instance_id String 实例ID。 resource_spec_code String 资源规格标识。 dcs.single_node：表示实例类型为单机 dcs.master_standby：表示实例类型为主备 dcs.cluster：表示实例类型为集群 engine_version String 缓存版本。 internal_version String DCS内部版本号。 charging_mode Integer 付费模式，0表示按需计费，1表示包年/包月计费。 capacity_minor String 小规格缓存容量（G Byte）。 vpc_id String VPC ID。 vpc_name String VPC的名称。 created_at String 创建时间。格式为：2017-03-31T12:24:46.297Z error_code String 实例创建失败或状态异常时的错误码，错误码的说明见表3。 user_id String 用户id。 user_name String 用户名。 maintain_begin String 维护时间窗开始时间，格式为HH:mm:ss。 maintain_end String 维护时间窗结束时间，格式为HH:mm:ss。 no_password_access String 是否允许免密码访问缓存实例。 true：该实例无需密码即可访问。 false：该实例必须通过密码认证才能访问。 access_user String 通过密码认证访问缓存实例的认证用户名。 enable_publicip Boolean Redis缓存实例是否开启公网访问功能。 true：开启 false：不开启 publicip_address String Redis缓存实例绑定的弹性IP地址。 如果未开启公网访问功能，该字段值为null。 publicip_id String Redis缓存实例绑定的弹性IP地址的id。 如果未开启公网访问功能，该字段值为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。 security_group_id String 租户安全组名称。 tags Array of objects 实例标签键值。 响应示例 { "instances": [ { "name": "dcs-lxy", "engine": "Redis", "capacity": 4, "ip": "192.168.7.146", "domainName": null, "port": 6379, "status": "CREATING", "max_memory": 3277, "used_memory": 0, "instance_id": "a4d31cb6-3d72-4fdc-8ec9-6e3a41e47f71", "resource_spec_code": "dcs.master_standby", "engine_version": "3.0", "internal_version": null, "charging_mode": 0, "capacity_minor": null, "vpc_id": "c71d9731-9b0c-43e9-ab2a-716af9d9fd55", "vpc_name": "CCE-AutoCreate-VPC-7qvs1", "created_at": "2019-09-23T02:40:06.123Z", "error_code": null, "user_id": "50a4156d334a4a82b8745dc730dc1e00", "user_name": "hwstaff_f00443635", "maintain_begin": "02:00:00", "maintain_end": "06:00:00", "no_password_access": "true", "access_user": null, "enable_publicip": false, "publicip_id": null, "publicip_address": null, "enable_ssl": false, "service_upgrade": false, "service_task_id": "", "enterprise_project_id": "0", "tags": [ { "key": "dcs001", "value": "001" }, { "key": "dcs002", "value": "002" } ], "security_group_id": "0cc8fdb7-872a-49da-a062-88ccc39463b5" }], "instance_num": 1}

URI GET /v1.0/{project_id}/instances?start={start}&limit={limit}&name={name}&status={status}&id={id}&include_failure={include_failure}&isExactMatchName={isExactMatchName}&ip={ip}&tags={key}={value} 参数说明见表1。 表1 参数说明 参数 类型 必选 说明 project_id String 是 项目ID。 start Integer 否 数据的起始序号，默认起始序号为1。 limit Integer 否 每页显示条数，最小值为1，最大值为1000，若不设置该参数，则为最大显示条数1000。 name String 否 实例名称。 id String 否 实例ID。 status String 否 实例状态。详细状态说明见缓存实例状态说明。 ip String 否 连接缓存实例的IP地址。 include_failure String 否 是否返回创建失败的实例数。 当参数值为“true”时，返回创建失败的实例数。参数值为“false”或者其他值，不返回创建失败的实例数。 isExactMatchName String 否 是否按照实例名称进行精确匹配查询。 默认为“false”，表示模糊匹配实例名称查询。若参数值为“true”表示按照实例名称进行精确匹配查询。 tags Array of objects 否 根据实例标签键值对进行查询。{key}表示标签键，{value}表示标签值。 如果同时使用多个标签键值对进行查询，中间使用逗号分隔开，表示查询同时包含指定标签键值对的实例。 示例 GET https://{dcs_endpoint}/v1.0/bd6b78e2ff9e4e47bc260803ddcc7a21/instances?start=1&limit=10&name=&status=&id=&include_failure=true&isExactMatchName=false 或： GET https://{dcs_endpoint}/v1.0/bd6b78e2ff9e4e47bc260803ddcc7a21/instances?tags=dcs001=001,dcs002=002

响应消息 响应参数 参数说明见表2。 表2 参数说明 参数 类型 说明 name String 实例名称。 engine String 缓存实例的引擎类型。 capacity Integer 缓存实例的容量（G Byte）。 ip String 连接缓存实例的IP地址。如果是集群实例，返回多个IP地址，使用逗号分隔。如：192.168.0.1，192.168.0.2。 domainName String 实例的域名。 port Integer 缓存的端口。 status String 缓存实例的状态。详细状态说明见缓存实例状态说明。 libos Boolean true：该实例是libos实例。 false：该实例不是libos实例。 description String 实例描述。 max_memory Integer 总内存，单位：MB。 used_memory Integer 已使用的内存，单位：MB。 instance_id String 实例ID。 resource_spec_code String 资源规格标识。 dcs.single_node：表示实例类型为单机 dcs.master_standby：表示实例类型为主备 dcs.cluster：表示实例类型为集群 engine_version String 缓存版本。 internal_version String DCS内部版本号。 charging_mode Integer 付费模式，0表示按需计费，1表示包年/包月计费。 capacity_minor String 单机小规格的缓存容量。 vpc_id String VPC ID。 vpc_name String VPC的名称。 created_at String 完成创建时间。格式为：2017-03-31T12:24:46.297Z error_code String 实例创建失败或状态异常时的错误码，错误码说明见表3。 user_id String 用户id。 user_name String 用户名。 maintain_begin String 维护时间窗开始时间，格式为HH:mm:ss。 maintain_end String 维护时间窗结束时间，格式为HH:mm:ss。 no_password_access String 是否允许免密码访问缓存实例。 true：该实例无需密码即可访问。 false：该实例必须通过密码认证才能访问。 access_user 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。 available_zones Array 实例节点所在的可用区。返回“可用区ID”。 subnet_id String 子网ID。 security_group_id String 安全组ID。 backend_addrs String 集群实例的后端服务地址。 product_id String 产品标识。 security_group_name String 租户安全组名称。 subnet_name String 子网名称。 subnet_cidr String 子网网段。 order_id String 订单ID。 instance_backup_policy JSON 备份策略，实例类型为主备和集群时支持。详情参考表4和表5。 tags Array of objects 实例标签键值。 表3 错误码说明 错误码 说明 dcs.00.0007 系统异常。 dcs.01.0001 内部服务错误。 dcs.01.0002 内部服务错误。 dcs.01.0003 内部服务错误。 dcs.02.0001 VPC创建失败。 dcs.02.0002 VPC创建失败。 dcs.02.0003 安全组创建失败。 dcs.02.0004 子网创建失败。 dcs.02.0005 子网状态异常。 dcs.03.0001 创建ECS失败。 dcs.03.0002 创建ECS失败。 dcs.03.0003 创建ECS失败。 dcs.03.0004 创建ECS失败。 dcs.03.0005 ECS绑定网卡失败。 dcs.03.0007 ECS启动失败。 dcs.03.0008 ECS启动失败。 dcs.03.0009 ECS停止失败。 dcs.03.0017 实例部分节点故障。 dcs.04.0002 实例部署异常。 dcs.04.0003 无法连接实例。 dcs.04.0004 存在两个主节点，主备节点间网络连接可能有问题。 响应示例 {"name": "dcs-125d","engine": "Redis","capacity": 64,"ip": "192.168.1.48","domainName": "XXXXXX","port": 6379,"status": "RUNNING","libos": false,"description": null,"task": null,"max_memory": 65536,"used_memory": 33,"instance_id": "979e9a6b-e2f5-4b5d-8e98-fea495ea27a1","resource_spec_code": "dcs.cluster","engine_version": "3.0","internal_version": null,"charging_mode": 0,"capacity_minor": null,"vpc_id": "d1e8008d-8182-4c86-a142-1ae9349bdc64","vpc_name": "vpc-807d","task_status": null,"created_at": "2018-12-11T07:24:18.149Z","error_code": null,"user_id": "9bfac09d9bcd4eb7bb1465a7bcff815b","user_name": "r00209145","maintain_begin": "02:00:00","maintain_end": "06:00:00","no_password_access": "true","access_user": null,"enable_publicip": false,"publicip_id": null,"publicip_address": null,"enable_ssl": false,"service_upgrade": false,"service_task_id": null,"is_free": null,"enterprise_project_id": "0","available_zones": ["f84448fd537f46078dd8bd776747f573"],"subnet_id": "9b32218f-6389-485a-912e-076fe9df6fa7","security_group_id": "ecefdad9-c8be-42aa-9d5d-9ab46a221240","backend_addrs": ["192.168.1.136:6379","192.168.1.224:6379"],"product_id": "00301-17063-0--0","security_group_name": "sg--test-hanwang","subnet_name": "subnet-7e46","order_id": null,"subnet_cidr": "192.168.1.0/24","instance_backup_policy": null, "tags": [ { "key": "dcs001", "value": "001" }, { "key": "dcs002", "value": "002" } ],"enterprise_project_name": null}

响应消息 状态码为 200 时，响应参数和响应示例如下： 响应参数 参数 参数类型 描述 bucket_name String OBS桶名。 file_path String OBS桶内文件路径。 links Array 备份文件下载链接集合，链接数最大为64个。 参数 参数类型 描述 file_name String 备份文件名称。 link String 备份文件下载链接地址。 响应示例 { "bucket_name": "bucket6d1b61f3d7434f60b7e465f4037d73f3", "file_path": "3dc6ba15-ba97-4624-bcbd-3cc08d6336b0/20190924204307_redis.rdb", "links": [ { "file_name": "20190924204307_redis.rdb", "link": "https://bucket6d1b61f3d7434f60b7e465f4037d73f3.obs.cn-north-4.myhuaweicloud.com:443/3dc6ba15-ba97-4624-bcbd-3cc08d6336b0/20190924204307_redis.rdb?AWSAccessKeyId=IMRORRY3GETV9CEH3GE0&Expires=1569329601&Signature=NGhdEGwHImXNyYyryx3AYqfAvoA%3D" } ]}

响应消息 响应参数 表1 响应参数 参数 参数类型 描述 group_count String 实例分片总数。 group_list Array of objects 分片列表。具体参数请参见表2。 表2 group_list参数说明 参数 参数类型 描述 group_id String 分片id group_name String 分片名称 replication_list Array of objects 每个分片包含的副本列表。具体参数请参见表3。 表3 replication_list参数说明 参数 参数类型 描述 replication_ip String 副本IP。 replication_role String 副本角色，取值有： master：表示主节点。 slave：表示从节点。 node_id String 节点ID。 replication_id String 副本ID。 is_replication Boolean 是否是新加副本。 status String 副本状态。 响应示例 状态码为 200 时: { "group_list": [ { "group_id": "a11d3ba3-7898-4371-bfbe-783ab9280cc7", "group_name": "group-2", "replication_list": [ { "replication_ip": "192.168.0.156", "replication_role": "master", "node_id": "8aa6999f6de47c69016df0e7de1c23de", "replication_id": "1a5f2b63-eedc-4bb1-a25f-262b5d604a1f", "is_replication": false, "status": "Active" }, { "replication_ip": "192.168.0.45", "replication_role": "slave", "node_id": "8aa6999f6de47c69016df0e7de2e23df", "replication_id": "2b892b07-dfe8-4b86-98cc-736b4e8e420f", "is_replication": false, "status": "Active" } ] }, { "group_id": "2ba84ddc-558c-4465-bfe9-dbfaac024565", "group_name": "group-1", "replication_list": [ { "replication_ip": "192.168.0.95", "replication_role": "master", "node_id": "8aa6999f6de47c69016df0e7ddf623dc", "replication_id": "b46cbcca-05a7-47b0-bd01-df768a1faf73", "is_replication": false, "status": "Active" }, { "replication_ip": "192.168.0.204", "replication_role": "slave", "node_id": "8aa6999f6de47c69016df0e7de0923dd", "replication_id": "56ddd52e-0c95-40f2-a596-b578456c1431", "is_replication": false, "status": "Active" } ] }, { "group_id": "995e1f3b-f9c0-4acf-ad9d-89123d1fd12a", "group_name": "group-0", "replication_list": [ { "replication_ip": "192.168.0.233", "replication_role": "master", "node_id": "8aa6999f6de47c69016df0e7ddd223da", "replication_id": "71749f79-e9ea-4173-8bfa-b97357153af8", "is_replication": false, "status": "Active" }, { "replication_ip": "192.168.0.27", "replication_role": "slave", "node_id": "8aa6999f6de47c69016df0e7dde423db", "replication_id": "707b7318-9766-47a8-91ad-7d0feab64229", "is_replication": false, "status": "Active" } ] } ], "group_count": 3}

URI POST /v1.0/{project_id}/instance/{instance_id}/groups/{group_id}/replications 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。 instance_id 是 String 实例ID。 group_id 是 String 分片ID。即查询分片信息响应消息中的group_id参数的值。 URI示例： POST https://{dcs_endpoint}/v1.0/{project_id}/instance/{instance_id}/groups/{group_id}/replications