华为云用户手册

请求示例 配置在线迁移任务，迁移方式为增量迁移，开启自动重连，配置源端和目标端实例信息。 POST https://{dcs_endpoint}/v2/{project_id}/migration/{task_id}/task { "migration_method" : "incremental_migration", "bandwidth_limit_mb" : 123, "resume_mode" : "auto", "source_instance" : { "id" : null, "addrs" : "192.168.1.1:6379,192.168.0.0:6379", "password" : "xxxxxx" }, "target_instance" : { "id" : "cf4a05df-1c38-47c5-bb5a-0a7b3673b3bd", "addrs" : null, "password" : null } }

请求参数 表2 请求Body参数 参数 是否必选 参数类型 描述 migration_method 是 String 迁移方式，包括全量迁移和增量迁移两种类型。 全量迁移：该模式为Redis的一次性迁移，适用于可中断业务的迁移场景。 全量迁移过程中，如果源Redis有数据更新，这部分更新数据不会被迁移到目标Redis。 增量迁移：该模式为Redis的持续性迁移，适用于对业务中断敏感的迁移场景。 增量迁移阶段通过解析日志等技术， 持续保持源Redis和目标端Redis的数据一致。取值范围： full_amount_migration：表示全量迁移。 incremental_migration：表示增量迁移。 枚举值： full_amount_migration incremental_migration resume_mode 是 String 自动重连，根据参数决定是否自动重连。 自动重连模式在遇到网络等异常情况时，会无限自动重试。 自动重连模式在无法进行增量同步时，会触发全量同步，增加带宽占用，请谨慎选择。取值范围： auto：自动重连。 manual：手动重连。 枚举值： auto manual bandwidth_limit_mb 否 String 带宽限制，当迁移方式为增量迁移时，为保证业务正常运行，您可以启用带宽限制功能，当数据同步速度达到带宽限制时，将限制同步速度的继续增长。 - 带宽限制的单位为MB/s。 - 取值范围：1-10240（大于0小于10241之间的整数）。 source_instance 是 ConfigMigrationInstanceBody object 表示源Redis信息。 target_instance 是 ConfigMigrationInstanceBody object 表示目标Redis信息。 表3 ConfigMigrationInstanceBody 参数 是否必选 参数类型 描述 id 否 String Redis实例ID（若不填写addrs，则必须填写ID）。 addrs 否 String Redis实例地址（若不填写ID，则必须填写addrs）。 password 否 String Redis密码，如果设置了密码，则必须填写。

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 id String 迁移任务ID。 name String 迁移任务名称。 status String 迁移任务状态，这个字段的值包括：SUCCESS（成功）, FAILED（失败）, MIGRATING（迁移中），TERMINATED（已结束）。 枚举值： SUCCESS FAILED MIGRATING TERMINATED error 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

请求URI 请求URI由如下部分组成。 {URI-scheme} :// {Endpoint} / {resource-path} ? {query-string} 尽管请求URI包含在请求消息头中，但大多数语言或框架都要求您从请求消息中单独传递它，所以在此单独强调。 URI-scheme： 表示用于传输请求的协议，当前所有API均采用HTTPS协议。 Endpoint： 指定承载REST服务端点的服务器域名或IP，不同服务不同区域的Endpoint不同，您可以从地区和终端节点获取。 例如IAM服务在“华北-北京一”区域的Endpoint为“iam.cn-north-1.myhuaweicloud.com”。 resource-path： 资源路径，也即API访问路径。从具体API的URI模块获取，例如“获取用户Token”API的resource-path为“/v3/auth/tokens”。 query-string： 查询参数，是可选部分，并不是每个API都有查询参数。查询参数前面需要带一个“？”，形式为“参数名=参数取值”，例如“limit=10”，表示查询不超过10条数据。 例如您需要获取IAM在“华北-北京一”区域的Token，则需使用“华北-北京一”区域的Endpoint（iam.cn-north-1.myhuaweicloud.com），并在获取用户Token的URI部分找到resource-path（/v3/auth/tokens），拼接起来如下所示。 https://iam.cn-north-1.myhuaweicloud.com/v3/auth/tokens 图1 URI示意图 为查看方便，在每个具体API的URI部分，只给出resource-path部分，并将请求方法写在一起。这是因为URI-scheme都是HTTPS，同一个服务的Endpoint在同一个区域也相同，所以简洁起见将这两部分省略。

请求方法 HTTP请求方法（也称为操作或动词），它告诉服务你正在请求什么类型的操作。 GET：请求服务器返回指定资源。 PUT：请求服务器更新指定资源。 POST：请求服务器新增资源或执行特殊操作。 DELETE：请求服务器删除指定资源，如删除对象等。 HEAD：请求服务器资源头部。 PATCH：请求服务器更新资源的部分内容。当资源不存在的时候，PATCH可能会去创建一个新的资源。 在获取用户Token的URI部分，您可以看到其请求方法为“POST”，则其请求为： POST https://iam.cn-north-1.myhuaweicloud.com/v3/auth/tokens

请求消息头 附加请求头字段，如指定的URI和HTTP方法所要求的字段。例如定义消息体类型的请求头“Content-Type”，请求鉴权信息等。 如下公共消息头需要添加到请求中。 Content-Type：消息体的类型（格式），必选，默认取值为“application/json”，有其他取值时会在具体接口中专门说明。 X-Auth-Token：用户Token，可选，当使用Token方式认证时，必须填充该字段。用户Token也就是调用获取用户Token接口的响应值，该接口是唯一不需要认证的接口。 DCS API同时支持使用AK/SK认证，AK/SK认证是使用SDK对请求进行签名，签名过程会自动往请求中添加Authorization（签名认证信息）和X-Sdk-Date（请求发送的时间）请求头。 AK/SK认证的详细说明请参见AK/SK认证。 对于获取用户Token接口，由于不需要认证，所以只添加“Content-Type”即可，添加消息头后的请求如下所示。 POST https://iam.cn-north-1.myhuaweicloud.com/v3/auth/tokens Content-Type: application/json

请求消息体 请求消息体通常以结构化格式发出，与请求消息头中Content-type对应，传递除请求消息头之外的内容。若请求消息体中参数支持中文，则中文字符必须为UTF-8编码。 每个接口的请求消息体内容不同，也并不是每个接口都需要有请求消息体（或者说消息体为空），GET、DELETE操作类型的接口就不需要消息体，消息体具体内容需要根据具体接口而定。 对于获取用户Token接口，您可以从接口的请求部分看到所需的请求参数及参数说明。将消息体加入后的请求如下所示，加粗的斜体字段需要根据实际值填写，其中username为用户名，domainname为用户所属的账号名称，********为用户登录密码，xxxxxxxxxxxxxxxxxx为project的名称，如“cn-north-1”，您可以从地区和终端节点获取，即对应地区和终端节点页面的“区域”字段的值。 scope参数定义了Token的作用域，上面示例中获取的Token仅能访问project下的资源。您还可以设置Token作用域为某个账号下所有资源或账号的某个project下的资源，详细定义请参见获取用户Token。 POST https://iam.cn-north-1.myhuaweicloud.com/v3/auth/tokens Content-Type: application/json { "auth": { "identity": { "methods": [ "password" ], "password": { "user": { "name": "username", "password": "********", "domain": { "name": "domainname" } } } }, "scope": { "project": { "name": "xxxxxxxxxxxxxxxxxx" } } } } 到这里为止这个请求需要的内容就具备齐全了，您可以使用curl、Postman或直接编写代码等方式发送请求调用API。对于获取用户Token接口，返回的响应消息头中“x-subject-token”就是需要获取的用户Token。有了Token之后，您就可以使用Token认证调用其他API。

支持的授权项 策略包含系统策略和自定义策略，如果系统策略不满足授权要求，管理员可以创建自定义策略，并通过给用户组授予自定义策略来进行精细的访问控制。策略支持的操作与API相对应，授权项列表说明如下： 权限：允许或拒绝某项操作。 对应API接口：自定义策略实际调用的API接口。 授权项：自定义策略中支持的Action，在自定义策略中的Action中写入授权项，可以实现授权项对应的权限功能。 依赖的授权项：部分Action存在对其他Action的依赖，需要将依赖的Action同时写入授权项，才能实现对应的权限功能。 IAM项目(Project)/企业项目(Enterprise Project)：自定义策略的授权范围，包括IAM项目与企业项目。授权范围如果同时支持IAM项目和企业项目，表示此授权项对应的自定义策略，可以在IAM和企业管理两个服务中给用户组授权并生效。如果仅支持IAM项目，不支持企业项目，表示仅能在IAM中给用户组授权并生效，如果在企业管理中授权，则该自定义策略不生效。管理员可以在授权项列表中查看授权项是否支持IAM项目或企业项目，“√”表示支持，“×”表示暂不支持。关于IAM项目与企业项目的区别，详情请参见：IAM与企业管理的区别。 DCS的支持自定义策略授权项如表1所示。

基本概念 账号 用户注册账号时，账号对其所拥有的资源及云服务具有完全的访问权限，可以重置用户密码、分配用户权限等。由于账号是付费主体，为了确保账号安全，建议您不要直接使用账号进行日常管理工作，而是创建用户并使用他们进行日常管理工作。 用户 由账号在IAM中创建的用户，是云服务的使用人员，具有身份凭证（密码和访问密钥）。 在我的凭证下，您可以查看账号ID和用户ID。通常在调用API的鉴权过程中，您需要用到账号、用户和密码等信息。 区域（Region）：从地理位置和网络时延维度划分，同一个Region内共享弹性计算、对象存储、VPC网络、弹性公网IP等公共服务。同一区域内可用区间内网互通，不同区域间内网不互通。通过在不同地区创建云资源，可以将应用程序设计的更接近特定客户或不同地区的要求。 可用区：一个可用区是一个或多个物理数据中心的集合，有独立的风火水电，AZ内逻辑上再将计算、网络、存储等资源划分成多个集群。一个Region中的多个AZ间通过高速光纤相连，以满足用户跨AZ构建高可用性系统的需求。 项目 区域默认对应一个项目，这个项目由系统预置，用来隔离物理区域间的资源（计算资源、存储资源和网络资源），以默认项目为单位进行授权，用户可以访问您账号中该区域的所有资源。如果您希望进行更加精细的权限控制，可以在区域默认的项目中创建子项目，并在子项目中购买资源，然后以子项目为单位进行授权，使得用户仅能访问特定子项目中资源，使得资源的权限控制更加精确。 图1 项目隔离模型 同样在我的凭证下，您可以查看项目ID。 企业项目 企业项目是项目的升级版，针对企业不同项目间资源的分组和管理，是逻辑隔离。企业项目中可以包含多个区域的资源，且项目中的资源可以迁入迁出。 关于企业项目ID的获取及企业项目特性的详细信息，请参见《企业管理服务用户指南》。 父主题： 使用前必读

请求示例 POST https://{dcs_endpoint}/v2/{project_id}/orders/instances/{instance_id}/resize { "auto_open_security_group_rule" : false, "execute_immediately" : true, "new_capacity" : 0.125, "password" : "", "spec_code" : "redis.single.xu1.tiny.128" }

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 order_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参数 参数 是否必选 参数类型 描述 auto_open_security_group_rule 否 Boolean 自动开启安全组规则。 execute_immediately 否 Boolean 直接启动规格变更。 new_capacity 否 Float 新的容量，单位是GB。 password 否 String 密码。 spec_code 否 String 产品规格编码。

响应参数 状态码： 200 表2 响应Body参数 参数 参数类型 描述 id String 过期key扫描记录ID。 最小长度：0 最大长度：36 instance_id String 实例ID。 最小长度：0 最大长度：36 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，不返回）。 状态码： 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 创建过期key扫描任务成功。 { "id" : "aa735b6f-3d70-44e3-9771-66c6fae7459a", "instance_id" : "5560df16-cebf-4473-95c4-d1b573c16e79", "status" : "waiting", "scan_type" : "manual", "created_at" : "2020-06-15T02:21:18.669Z" } 状态码： 400 非法请求。 { "error_code" : "DCS.4818", "error_msg" : "Do not support auto expire scan." }

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 diagnosis_report_list Array of DiagnosisReportInfo objects 诊断报告列表。 total_num Integer 诊断报告总数。 表4 DiagnosisReportInfo 参数 参数类型 描述 report_id String 诊断报告ID。 status String 诊断任务状态。 枚举值： diagnosing finished begin_time String 诊断时间段的开始时间。格式为：2017-03-31T12:24:46.297Z。 end_time String 诊断时间段的结束时间。格式为：2017-03-31T12:24:46.297Z。 created_at String 诊断报告创建时间。 node_num Integer 参与诊断的节点个数。 abnormal_item_sum Integer 诊断结果为异常的诊断项总数。 failed_item_sum 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

响应示例 状态码： 200 查询实例诊断报告列表成功。 { "diagnosis_report_list" : [ { "report_id" : "fb98e37a-3cd9-4c7a-96b1-d878266019e2", "status" : "finished", "begin_time" : "2021-04-15T06:02:00.000Z", "end_time" : "2021-04-15T06:12:00.000Z", "created_at" : "2021-04-15T06:12:06.641Z", "abnormal_item_sum" : 2, "failed_item_sum" : 0, "node_num" : 2 } ], "total_num" : 1 }

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

响应示例 状态码： 200 查询后台任务详情成功。 { "job_id" : "ff8080818822bbf70188235afc24141a", "job_type" : "masterStandbySwapJob", "status" : "SUCCESS", "begin_time" : "1684191545379", "end_time" : "1684191548248", "fail_reason" : null } 状态码： 400 非法请求。 { "error_code" : "111400063", "error_msg" : "Invalid {0} parameter in the request." }

响应参数 状态码： 200 表2 响应Body参数 参数 参数类型 描述 job_id String 任务ID。 job_type String Job类型，取值范围： masterStandbySwapJob：主备倒换任务 modifyClientIpTransJob：修改源IP透传 枚举值： masterStandbySwapJob modifyClientIpTransJob status String Job状态。 枚举值： INIT RUNNING SUCCESS FAIL begin_time String Job开始时间戳，单位为ms，格式为:1684191545379。 end_time String Job开始时间戳，单位为ms，格式为:1684191548248。 fail_reason String 失败原因。 状态码： 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 查询自动扫描配置成功。 { "instance_id" : "162d315d-a67d-4ba1-8ca5-8d0e95c5bf7c", "enable_auto_scan" : false, "first_scan_at" : null, "interval" : null, "timeout" : null, "scan_keys_count" : null, "updated_at" : null }

响应参数 状态码： 200 表2 响应Body参数 参数 参数类型 描述 instance_id String 实例ID。 enable_auto_scan Boolean 是否开启自动扫描。 first_scan_at String 首次扫描时间，例如：2023-07-07T15:00:05.000。 interval Integer 间隔时间（单位：秒）。 timeout Integer 超时时间（单位：秒）。 scan_keys_count Integer 扫描密钥计数。 updated_at String 更新时间，例如：2023-06-15T06:20:13.283Z 状态码： 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 查询在线迁移进度明细成功。 { "full_migration_progress" : 100, "offset" : 100, "source_dbsize" : 531221, "target_dbsize" : 531211, "target_input_kbps" : 50, "target_ops" : 5300, "is_migrating" : true } 状态码： 400 非法请求。 { "error_code" : "DCS.4133", "error_msg" : "Instance job is not found." }

响应参数 状态码： 200 表2 响应Body参数 参数 参数类型 描述 full_migration_progress String 全量迁移进度百分比。 offset String 增量迁移偏移量。 source_dbsize String 源redis键数量。 target_dbsize String 目标redis键数量。 target_input_kbps String 目标redis键写入流量，单位KB/s。 target_ops String 目标redis每秒并发操作数。 is_migrating Boolean 迁移任务是否在进行。 状态码： 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 表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

请求示例 PUT https://{dcs_endpoint}/v2/{project_id}/instances/{instance_id}/scan-expire-keys/autoscan-config { "enable_auto_scan" : "true", "first_scan_at" : "2023-02-07T15:00:05.000Z", "interval" : 86400, "timeout" : 172800, "scan_keys_count" : 10 }

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 instance_id String 实例ID。 enable_auto_scan Boolean 是否开启自动扫描。 first_scan_at String 首次扫描时间，例如：2023-07-07T15:00:05.000。 interval Integer 间隔时间（单位：秒）。 timeout Integer 超时时间（单位：秒）。 scan_keys_count Integer 扫描密钥计数。 updated_at String 更新时间，例如：2023-06-15T06:20:13.283Z 状态码： 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 修改自动扫描配置成功。 { "instance_id" : "162d315d-a67d-4ba1-8ca5-8d0e95c5bf7c", "enable_auto_scan" : true, "first_scan_at" : "2023-06-13T21:00:00.000Z", "interval" : 86400, "timeout" : 172800, "scan_keys_count" : 10, "updated_at" : "2023-06-13T13:13:12.685Z" } 状态码： 400 非法请求。 { "error_code" : "DCS.4822", "error_msg" : "The scan_keys_count parameter is invalid. Its must Greater than or equal to 10, and Less than or equal to 1000." }

请求参数 表2 请求Body参数 参数 是否必选 参数类型 描述 enable_auto_scan 否 Boolean 启用自动扫描。 first_scan_at 否 String 首次扫描时间，例如：2023-07-07T15:00:05.000。 interval 否 Integer 间隔时间（单位：秒）。 timeout 否 Integer 超时时间（单位：秒）。 scan_keys_count 否 Integer 扫描密钥计数。

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 code String 任务执行成功代码。 message String 重置结果说明信息。 lock_time String 锁定时间。验证失败时和锁定时该参数返回不为null。 lock_time_left String 锁定剩余时间。锁定时该参数返回不为null。 retry_times_left 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 重置密码成功。 { "code" : "1", "message" : "Reset DCSInstance password success.", "lock_time" : "0", "lock_time_left" : "0", "retry_times_left" : "5" } 状态码： 400 非法请求。 { "error_code" : "DCS.4961" }