华为云用户手册

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

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 x-auth-token 是 String 用户Token。 通过调用IAM服务的“获取用户Token”接口来获取。 表3 请求Body参数 参数 是否必选 参数类型 描述 spec_code 是 String 变更至新规格的资源规格编码。 group_id 否 String 实例默认一个组，此时不需要传入该参数。当使用组功能创建多个组时, 需要传入需要规格变更的对应组的group_id。 is_auto_pay 否 Boolean 变更包年包月实例规格时可指定，表示是否自动从账户中支付，此字段不影响自动续订的支付方式。true，表示自动从账户中支付。false，表示手动从账户中支付，默认为该方式。

响应参数 状态码： 202 表4 响应Body参数 参数 参数类型 描述 job_id String 规格变更的任务ID，仅变更按需实例时会返回该参数。 order_id String 订单ID，仅变更包周期实例时会返回该参数。 状态码： 400 表5 响应Body参数 参数 参数类型 描述 errCode String 业务错误码。 externalMessage String 错误信息。 状态码： 500 表6 响应Body参数 参数 参数类型 描述 errCode String 业务错误码。 externalMessage String 错误信息。

请求示例 变更实例规格为ddm.c6.4xlarge.2。 PUT https://{endpoint}/v3/{project_id}/instances/{instance_id}/flavor{ "spec_code" : "ddm.c6.4xlarge.2", "group_id" : "3e5a9063d3b84729b0a3310fad3a0942gr09", "is_auto_pay" : false}

API概览 分布式数据库 中间件所提供的接口为REST（Representational State Transfer）风格API。通过使用DDM接口，您可以使用DDM的所有功能，包括创建实例、创建逻辑库等。 表1 接口介绍 类型 接口名称 说明 DDM实例类接口 购买DDM实例 购买DDM实例。该接口创建的DDM实例为按需计费的方式。 DDM运行于虚拟私有云。申请DDM实例前，需保证有可用的虚拟私有云，并且已配置好子网与安全组。 查询DDM实例列表 查询DDM实例列表。 查询DDM实例详情 查询指定DDM实例的详细信息。 修改DDM实例名称 修改现有DDM实例的名称。 修改DDM实例安全组 修改DDM实例安全组。 删除DDM实例 删除指定的DDM实例，释放该实例的所有资源。 重启DDM实例 重启指定的DDM实例。 DDM表数据重载 DDM实例跨region容灾场景下，针对目标DDM实例实现表数据RELOAD，使数据同步。 DDM实例节点扩容 对指定的DDM实例的节点个数进行扩容。 DDM实例节点缩容 对指定的DDM实例的节点个数进行缩容。 修改DDM已关联的数据库实例的读策略 修改DDM已关联的数据库实例的读策略。 同步DN信息 同步当前DDM实例已关联的所有DN配置信息。 查询DDM实例节点列表 查询DDM实例节点列表。 查询DDM实例节点详情 查询DDM实例节点详情。 查询DDM指定实例的参数详情 查询DDM指定实例的参数详情。 修改DDM的实例参数 修改DDM实例参数。 查询DDM引擎信息 查询DDM引擎信息详情。 查询DDM可用区规格信息 查询DDM可用区规格信息详情。 变更DDM实例规格 变更DDM实例规格。 获取实例组信息列表 获取DDM实例的组信息详情。 DDM逻辑库类接口 创建DDM逻辑库 创建DDM逻辑库。 创建前需确保存在RDS实例，实例状态正常且没有被其他DDM实例关联使用。 查询DDM逻辑库列表 查询DDM逻辑库列表。 查询DDM逻辑库详细信息 查询指定逻辑库的详细信息。 删除DDM逻辑库 删除指定的逻辑库，释放该逻辑库的所有资源。 查询创建逻辑库可选取的数据库实例列表 查询创建逻辑库可选取的数据库实例列表。 DDM账号类接口 创建DDM账号 DDM账号用于连接和管理逻辑库。一个DDM账号可以关联多个逻辑库。 查询DDM账号列表 查询DDM账号列表。 修改DDM账号 修改现有DDM账号的权限或者与逻辑库的管理关系。 删除DDM账号 删除指定的DDM实例账号，如果账号关联了逻辑库，则对应的关联关系也会删除。 重置DDM账号密码 重置现有DDM账号的密码。 弱密码效验 弱密码效验。 监控管理类 慢日志监控 查询指定时间段内在DDM实例上执行过的慢SQL相关信息。 读写比例监控（即将下线） 查询指定时间段内在DDM实例的读写次数。

响应消息 正常响应参数说明 表4 响应Body参数 参数 参数类型 描述 instance_id String DDM实例ID。 job_id String 变更内核版本的任务ID。 正常响应示例 { "instance_id" : "28e8841d0b9c4f6a9a30742ee60e1055****", "job_id" : "1eb697c0-1842-43a3-8671-f562d038****"} 异常响应 请参见异常请求结果。

URI URL格式 POST /v3/{project_id}/instances/{instance_id}/database-version/change-version 参数说明 表1 参数说明 参数 是否必选 参数类型 描述 project_id 是 String 租户在某一region下的project ID。 获取方法请参见获取项目ID。 instance_id 是 String DDM实例ID。

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务的“获取用户Token”接口来获取。 表3 请求Body参数 参数 是否必选 参数类型 描述 group_id 否 String 组ID，指定当前进行节点扩容的组。当实例的组数量大于1时，必填。 subnet_id 否 String 子网ID，当实例组下的子网ID数量大于1时，必填。 is_auto_pay 否 Boolean 对包年包月实例节点扩容时可指定，表示是否自动从账户中支付。 true，表示自动从账户中支付。 false，表示手动从账户中支付，默认为该方式。 nodes 是 Array of 表 EnlargeNodeInfo objects 节点信息列表。 最小：1 最大：实例下最大节点个数不超过32 表4 EnlargeNodeInfo 参数 是否必选 参数类型 描述 available_zone 是 String 节点可用区。取值非空，请参见地区和终端节点。

响应消息 正常响应参数说明 表5 响应Body参数 参数 参数类型 描述 job_id String 节点扩容任务ID。 仅按需实例节点扩容时会返回该参数。 order_id String 订单号，仅包年包月实例节点扩容时返回该参数。 正常响应示例 按需： { "job_id": "eff1d289-4d03-4942-8b9f-463ea07c000c"} 包周期： { "order_id" : " CS 1810251738L8VVD" }

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 success Boolean 操作是否成功。 instance_id String DDM实例ID。 状态码： 400 表5 响应Body参数 参数 参数类型 描述 errCode String 业务错误码。 externalMessage String 错误信息。 状态码： 500 表6 响应Body参数 参数 参数类型 描述 errCode String 业务错误码。 externalMessage String 错误信息。

响应示例 状态码： 200 ok { "success" : true, "instance_id" : "175f5aff-xxxx-xxxx-xxxx-d0858982bbec"} 状态码： 400 bad request { "externalMessage" : "Parameter error.", "errCode" : "DBS.280001"} 状态码： 500 server error { "externalMessage" : "Server failure.", "errCode" : "DBS.200412"}

请求示例 修改已关联的数据库实例的读策略。 PUT https://{endpoint}/v2/{project_id}/instances/{instance_id}/action/read-write-strategy{ "read_weight" : { "395298ae6fb9496d95939ed556474983in01" : 60, "38ef52c365a14b7caeb7333137900e96in01" : 50 }}

操作步骤 删除DDM实例，同时删除关联RDS上存储的数据。 接口相关信息 URI格式：DELETE /v1/{project_id}/instances/{instance_id}?delete_rds_data=true 详情请参见删除DDM实例。 请求示例 DELETE: https://{endpoint}/v1/743b4c0428d945316666666666666666/instances/d0b008c1ee95479d8799710d9f3a4097in09?delete_rds_data=true {endpoint}信息请从地区和终端节点获取。 响应示例 { "id":"d0b008c1ee95479d8799710d9f3a4097in09"} 删除DDM实例，不删除关联RDS上存储的数据。 接口相关信息 URI格式：DELETE /v1/{project_id}/instances/{instance_id}?delete_rds_data=false 详情请参见删除DDM实例。 请求示例 DELETE: https://{endpoint}/v1/743b4c0428d945316666666666666666/instances/d0b008c1ee95479d8799710d9f3a4097in09?delete_rds_data=false {endpoint}信息请从地区和终端节点获取。 DELETE: https://{endpoint}/v1/743b4c0428d945316666666666666666/instances/d0b008c1ee95479d8799710d9f3a4097in09?delete_rds_data=false 响应示例 { "id":"d0b008c1ee95479d8799710d9f3a4097in09"}

操作步骤 修改DDM实例名称。 接口相关信息 URI格式：PUT /v1/{project_id}/instances/{instance_id}/modify_name 详情请参见修改DDM实例名称。 请求示例 PUT: https://{endpoint}/v1/743b4c0428d945316666666666666666/instances/modify_name {"name": "ddm-testaa"} {endpoint}信息请从地区和终端节点获取。 响应示例 {"name":"ddm-testaa"}

DDM实例状态 表1 DDM实例状态说明 状态 说明 CREATING 创建中，申请DDM实例成功之前的状态。 CREATEFAILED 创建失败，DDM实例处于创建失败的状态。 RUNNING 运行中，DDM实例可正常使用。 ERROR 故障，DDM实例不可用。 RESTARTING 重启中，DDM实例正在重启。 FREEZING 冻结中，DDM实例冻结中。 FROZEN 冻结，DDM实例处于冻结状态。 UNFREEZING 解冻中，DDM实例正在解冻中。 RESIZING 规格变更中，DDM实例规格正在变更中。 UPGRADE_VERSION_INSTANCE 升级中，版本升级中。 ROLL_BACK_DB_VERSION 回滚中，版本回滚中。 GROWING 节点扩容中。 REDUCING 节点缩容中。 RESTORE 恢复中。 BACKUP 备份中。 MODIFY_NAME DDM实例名字修改。 MIGRATE_DATABASE 逻辑库分片变更。 RESET_PASSWORD 重置密码。 ONDEMAND_TO_PERIOD 转包周期中。 PERIOD_RESOURCE_SPEC_CHG 包周期资源变更校验中。 SET_CONFIGURATION 实例参数更新中。

URI URL格式 GET /v3/{project_id}/instances/{instance_id}/processes-audit-log?offset={offset}&limit={limit}&start_time={start_time}&end_time={end_time} 参数说明 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户在某一region下的project ID。 获取方法请参见获取项目ID。 instance_id 是 String DDM实例ID或关联RDS实例ID。 表2 Query参数 参数 是否必选 参数类型 描述 offset 否 Integer 索引位置，偏移量。 从第一条数据偏移offset条数据后开始查询，默认为0。 取值必须为数字，且不能为负数。 limit 否 Integer 查询个数上限值。 取值范围：1~128。 不传该参数时，默认值为10。 start_time 是 String 开始时间，UTC time，精确到毫秒。格式为“yyyy-mm-ddThh:mm:ssZ”。其中，T指某个时间的开始；Z指时区偏移量，例如北京时间偏移显示为+0800。 end_time 是 String 结束时间，UTC time，精确到毫秒。格式为“yyyy-mm-ddThh:mm:ssZ”。其中，T指某个时间的开始；Z指时区偏移量，例如北京时间偏移显示为+0800。结束时间与开始时间，间隔不能超过7天。

响应消息 正常响应参数说明 表3 响应Body参数 参数 参数类型 描述 total_count Integer 总条数。 process_audit_logs Array of 表4 UserProcessAuditLog objects 实例的kill会话审计日志列表。 表4 UserProcessAuditLog 参数 参数类型 描述 instance_id String 实例ID。 instance_name String 实例名称。 process_id String 会话ID。 execute_user_name String 执行操作的用户名。 execute_time String 操作时间，UTC time。 正常响应示例 { "total_count": 1, "process_audit_logs": [ { "instance_id": "5af0884170a84164980f79f9f5bf230c****", "instance_name": "UTS-ddm-name", "process_id": 6708736, "execute_user_name": "user_name", "execute_time": "2024-06-18T03:08:15+0800VGltZQ==" } ]} 异常响应 请参见异常请求结果。

URI POST /v2/{project_id}/instances/{instance_id}/users/{username}/password 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。 获取方法请参见获取项目ID。 instance_id 是 String DDM实例ID。 username 是 String 需要修改的DDM账号名称。

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 success Boolean 操作是否成功。 instance_id String DDM实例ID。 user_name String DDM账号名称。 状态码： 400 表5 响应Body参数 参数 参数类型 描述 errCode String 业务错误码。 externalMessage String 错误信息。 状态码： 500 表6 响应Body参数 参数 参数类型 描述 errCode String 业务错误码。 externalMessage String 错误信息。

响应示例 状态码： 200 OK { "success": true, "instance_id": "e6b99563-xxxx-xxxx-xxxx-1820d4fd2a67", "user_name" : "ddmtest"} 状态码： 400 bad request { "externalMessage" : "Parameter error.", "errCode" : "DBS.280001"} 状态码： 500 server error { "externalMessage" : "Server failure.", "errCode" : "DBS.200412"}

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 is_weak_password Boolean 是否是弱密码。true为弱密码，不建议使用。false为非弱密码，可以使用。 状态码： 400 表5 响应Body参数 参数 参数类型 描述 errCode String 业务错误码。 externalMessage String 错误信息。 状态码： 500 表6 响应Body参数 参数 参数类型 描述 errCode String 业务错误码。 externalMessage String 错误信息。

错误码 当您调用API时，如果遇到“APIGW”开头的错误码，请参见API网关错误码进行处理。 状态码 错误码 错误信息 解决方案 400 DBS.280001 参数错误。 刷新页面，尝试更换部分参数信息进行重试。 400 DBS.300002 服务器错误。 稍后刷新页面进行重试。 400 DBS.300005 请求处理失败，请联系技术人员。 - 400 DBS.300100 创建逻辑库失败。 检查实例是否存在、状态是否是运行中、RDS是否在扩容中、逻辑库名称是否已重复，修改后重新下发请求。 400 DBS.300101 删除逻辑库失败。 请先检查逻辑库是否已删除，逻辑库关联的RDS是否存在或者异常。 400 DBS.300102 逻辑库关联的RDS个数不合法。 请检查逻辑库关联的RDS个数是否符合要求后，重新下发请求。 400 DBS.300103 RDS不存在或者不在同一个VPC下。 请检查RDS是否存在，VPC与实例是否一致后，重新下发请求。 400 DBS.300104 逻辑库分片规则不合法。 请检查分片规则的取值是否正确后，重新下发请求。 400 DBS.300106 RDS分片数不合法。 请检查下发的请求中RDS分片数的取值是否正确后，重新下发请求。 400 DBS.300107 逻辑库关联用户存在重复。 请检查参数中用户的名称是否重复后, 重新下发请求。 400 DBS.300108 逻辑库关联RDS存在重复。 请先检查请求中提交的RDS是否重复，如果重复需修改后重新下发请求。 400 DBS.300109 逻辑库名称不合法。 检查逻辑库名称的取值是否正确后，重新下发请求。 400 DBS.300110 RDS实例状态不允许进行逻辑库关联操作。 请先解决RDS状态异常的情况，再下发请求。 400 DBS.300112 逻辑库名称已存在。 请检查是否已创建同名的逻辑库名称，修改后重新下发请求。 400 DBS.300113 创建物理库失败。 请先检查RDS的账号密码是否正确后，重新下发请求。 400 DBS.300114 RDS用户名或密码不合法。 请检查RDS的用户和密码是否正确后，重新下发请求。 400 DBS.300115 删除物理库失败。 若您想删除逻辑库，请首先确认RDS实例是否存在。若RDS实例已删除，请先单击“同步数据库信息”，重新执行删除操作。 400 DBS.300116 查询可用RDS失败。 请检查RDS服务是否正常后，重新下发请求。 400 DBS.300117 获取关联RDS失败。 请检查RDS服务是否正常后，重新下发请求。 400 DBS.300118 逻辑库分片变更失败。 请先检查下发的参数。 400 DBS.300120 获取任务信息失败。 请先检查DDM实例是否正常后，重新下发请求。 400 DBS.300121 清理分片变更任务失败。 请先检查分片变更任务是否存在，状态是否合法，目标RDS的账号密码是否正确后，重新下发请求。 400 DBS.300122 回滚分片变更任务失败。 请先检查分片变更任务是否存在，状态是否合法，目标RDS的账号密码是否正确后，重新下发请求。 400 DBS.300123 重试分片变更任务失败。 请先检查分片变更任务是否存在，状态是否正常后，重新下发请求。 400 DBS.300125 同步RDS信息失败。 请检查RDS服务是否正常后，重新下发请求。 400 DBS.300127 逻辑库关联的RDS总分片数不合法。 请检查RDS总分片数的取值是否正确，重新下发请求。 400 DBS.300128 查询逻辑库信息失败。 请先检查DDM实例是否正常后，重新下发请求。 400 DBS.300129 查询逻辑库信息失败 。 请先检查逻辑库是不是存在后，重新下发请求。 400 DBS.300130 逻辑库状态不合法 。 请先检查逻辑库状态是不是运行中后，重新下发请求。 400 DBS.300131 更新逻辑库SQL黑名单失败。 请先检查DDM实例是否正常后，重新下发请求。 400 DBS.300132 查询逻辑库SQL黑名单失败 。 请先检查DDM实例是否正常后，重新下发请求。 400 DBS.300133 RDS正处于扩容流程中 。 先检查RDS的状态是不是扩容中或者扩容失败后， 重新下发请求。 400 DBS.300134 当前逻辑库状态不允许回滚或取消操作。 稍后刷新页面进行重试。 400 DBS.300135 更新RDS读比重失败。 请先检查DDM实例是否正常后，重新下发请求。 400 DBS.300300 创建账号失败。 请先检查DDM实例是否存在、逻辑库是否存在、账号是否已存在，检查无误后，重新下发请求。 400 DBS.300301 更新账号失败。 请先检查关联的逻辑库是否存在，账号是否存在， 密码是否合法后， 重新下发请求。 400 DBS.300302 删除账号失败。 请先检查DDM实例是否正常后，重新下发请求。 400 DBS.300305 账号名称不合法。 检查账号名称的取值是否正确，重新下发请求。 400 DBS.300306 账号密码不合法。 检查下发的请求体中账号密码的取值是否正确，重新下发请求。 400 DBS.300307 账号描述不合法。 请检查描述的最大长度是否超过256后，重新下发请求。 400 DBS.300309 账号基础权限不合法。 检查下发的请求体中基础权限的取值是否正确后，重新下发请求。 400 DBS.300310 账号额外权限不合法。 检查下发的请求体中额外权限的取值是否正确后，重新下发请求。 400 DBS.300311 账号已存在。 请先检查账号名称是否已存在，修改后重新下发请求。 400 DBS.300312 查询账号失败。 请先检查DDM实例是否正常后，重新下发请求。 400 DBS.300313 配置SQL黑名单失败。 请先确认逻辑库是否存在，状态是否是运行中的状态后，重新下发请求。 400 DBS.300314 修改读写策略失败。 请先检查DDM实例是否正常后，重新下发请求。 400 DBS.300315 读写相对权重不合法。 请先检查权重值，需大于等于0小于100。 400 DBS.300316 查询读写策略失败。 请先检查DDM实例是否正常后，重新下发请求。 400 DBS.300322 实例元信息保存失败。 提供环境信息，实例ID，进行的操作，错误现象，联系技术支持人员进行协助解决。 400 DBS.300323 关联的RDS不存在或RDS实例状态不允许进行此操作。 请检查关联的RDS是否存在，RDS的状态是否正常后，重新下发请求。 400 DBS.300327 账号不存在。 请检查账号是否存在后，重新下发请求。 400 DBS.300328 重置密码失败。 请检查用户是否存在后，重新下发请求。 400 DBS.300329 获取扩容步骤名称错误。 页面重试或者回滚。 400 DBS.300330 字符串转换出错。 提供环境信息、进行的操作，实例ID、错误现象，联系技术支持人员进行协助解决。 400 DBS.300331 分片变更数据迁移，内部错误。 提供环境信息、进行的操作、实例ID、错误现象，联系技术支持人员进行协助解决。 400 DBS.300332 分片变更执行超时。 页面重试或者回滚。 400 DBS.300333 时区检查错误。 进到“服务列表”中的“云数据库RDS”分别找到对应源RDS目标RDS实例单击实例名称，在“参数修改”搜索time_zone，查看取值是否一致，不一致需修改成一致后，重试。 400 DBS.300334 sql_mode检查错误。 进到“服务列表”中的“云数据库RDS” 分别找到对应源RDS目标RDS实例单击实例名称，在“参数修改”搜索sql_mode ，查看取值是否一致，不一致需修改成一致后，重试。 400 DBS.300335 获取RDS链接错误。 检查RDS的状态是否正常。 400 DBS.300336 物理库不存在。 登录逻辑库关联的RDS上，执行SHOW DATABASES。查看是否有以对应逻辑库名开头的物理库， 物理库的数量需要与逻辑库的分片数保持一致。 400 DBS.300337 主键检查错误。 检查是否有无主键的表。如果有无主键的表，需要添加主键后，重试。 400 DBS.300338 禁用DDL/DML失败。 提供环境信息、实例ID、进行的操作、错误现象，联系技术支持人员进行协助解决。 400 DBS.300339 扩容子任务插入失败。 联系技术支持人员进行协助解决。 400 DBS.300340 修改扩容子任务为初始化状态错误。 联系技术支持人员进行协助解决。 400 DBS.300341 扩容子任务下发失败。 联系技术支持人员进行协助解决。 400 DBS.300342 获取扩容子任务列表为空。 联系技术支持人员进行协助解决。 400 DBS.300343 扩容子任务余量数据不合法。 提供环境信息、进行的操作、错误现象，联系技术支持人员进行协助解决。 400 DBS.300344 扩容任务状态检查失败。 联系技术支持人员进行协助解决。 400 DBS.300345 扩容任务信息为空。 重试。 400 DBS.300346 获取DDM服务进程信息为空。 重试。 400 DBS.300347 链接关闭失败。 重试。 400 DBS.300348 数据校验获取子任务列表为空。 联系技术支持人员进行协助解决。 400 DBS.300349 路由切换，更新库状态失败。 联系技术支持人员进行协助解决。 400 DBS.300350 数据不合法。 提供环境信息、进行的操作、错误现象，联系技术支持人员进行协助解决。 400 DBS.300351 修改扩容子任务为error状态失败。 联系技术支持人员进行协助解决。 400 DBS.300352 更新扩容子任务状态为stop失败。 提供环境信息、进行的操作、错误现象，联系技术支持人员进行协助解决。 400 DBS.300353 数据校验失败。 提供环境信息、进行的操作、错误现象，联系技术支持人员进行协助解决。 400 DBS.300354 更新扩容子任务状态为完成失败。 提供环境信息、进行的操作、错误现象，联系技术支持人员进行协助解决。 400 DBS.300355 创建逻辑库错误。 提供环境信息、进行的操作、错误现象，联系技术支持人员进行协助解决。 400 DBS.300356 无法连接到RDS，检查RDS连通性和安全组规则是否正确。 查看RDS状态是否正常。 400 DBS.300357 RDS用户名或密码错误。 RDS账号不存在，进到“服务列表”中的“云数据库RDS”，找到对应RDS实例单击实例名称，在RDS 实例详情中查看“管理员账户名”。 400 DBS.300358 存在未清理逻辑库，请先清理再进行操作。 在DDM实例 逻辑库列表页把没清理的逻辑库单击清理。 400 DBS.300360 关联实例的备份方式不支持此操作。 提供环境信息、进行的操作、错误现象，联系技术支持人员进行协助解决。 400 DBS.300362 扩容类型不合法。 选择平移扩容或者翻倍扩容。 400 DBS.300363 扩容预检查失败。 提供环境信息、进行的操作，错误现象，联系技术支持人员进行协助解决。 400 DBS.300364 数据库实例磁盘空间检查失败。 对数据库实例磁盘进行扩容 。 输入账号和密码，登录云服务控制台。 在“服务列表”中选择“云数据库RDS”，进入云数据库RDS管理页面。 在实例列表页面单击目标RDS实例，进入实例“基本信息”页面。 在基本信息页面选择“存储空间”模块。 单击“磁盘扩容”，等待扩容成功后重试。 400 DBS.300365 元数据更新失败。 重试扩容。 400 DBS.300366 迁移时重命名物理表失败。 重试扩容。 400 DBS.300367 数据清理失败。 重试。 400 DBS.300368 数据库实例的lower_case_table_names参数不合法。 对数据库实例磁盘进行扩容 。 输入账号和密码，登录云服务控制台。 在“服务列表”中选择“云数据库RDS”，进入云数据库RDS管理页面。 在实例列表页面单击目标RDS实例，进入实例“基本信息”页面。 选择参数修改页签，搜索参数lower_case_table_names，查看取值是否为“1”，如果不是需修改成“1”后，重试。 400 DBS.300369 修改访问控制开关失败，请联系技术人员。 查看DDM实例管理日志和DBS-resource-manager的日志。根据以下具体情况修改。 若有APIG.xxxx报错码提示没有权限访问此API，联系ELB运维授权“数据库管控”访问对应的接口。 可在resource-manager的info日志中找到接口的URI。 若有ELB.xxxx字样的报错码，直接联系ELB运维协助定位。 400 DBS.300370 当前实例尚未开启弹性负载均衡，不支持该功能，请先联系技术人员开启弹性负载均衡。 如需使用ELB访问控制功能，可以在DBS运维平台为对应实例打开ELB功能。 400 DBS.300371 当前账户不支持创建该内测引擎版本，如有需要请联系技术人员开通。 建议客户使用稳定版本的engineId创建实例，如必须创建内测版，前往DBS运维平台将用户加入到对应特性白名单中。 DDM实例管理错误日志中会提示具体的特性白名单名称。 400 DBS.300372 目标实例不合法。 新建DDM实例作为目标实例。 400 DBS.300375 参数{param}不合法。 按要求修改{param}的值后，重试。 400 DBS.300376 时区不合法。 更改正确的时区信息。 400 DBS.300377 时间不合法。 检查路由开始/结束切换时间格式，是否为HH:mm:ss格式，若不是，更改为HH:mm:ss格式。 检查路由开始/结束切换时间是否在在同一天，且间隔超过1h，若没有则更改。 根据上述操作后，重试。 400 DBS.300379 任务类型不允许当前操作。 更改当前处理的任务为逻辑库扩容任务。 400 DBS.300400 任务不存在。 更改为存在的任务，重试。 400 DBS.300401 修改自动切换路由时间失败。 提供环境信息、进行的操作、错误现象、租户节点日志，联系技术支持人员进行协助解决。 400 DBS.300402 手动切换路由失败。 提供环境信息、进行的操作、错误现象、租户节点日志，联系技术支持人员进行协助解决。 400 DBS.300405 逻辑库名长度不合法。 使用2-24个字符的名称创建逻辑库。 400 DBS.300406 逻辑库名不支持关键词{keyword}。 禁用关键词："information_schema"、"mysql"、"performance_schema"、"sys"。 400 DBS.300407 逻辑库名不支持大写。 使用全小写名称创建逻辑库。 400 DBS.300408 RDS连通性检查任务失败。 升级Agent到2.6.1及以上版本。 提供环境信息、进行的操作、错误现象，联系运维人员查看DDM的Agent是否故障。 400 DBS.300541 账号权限不足。 使用有相关权限账号。 400 DBS.200057 实例参数组的ID取值非法。 请输入正确的实例参数组ID后重试。 400 DBS.280305 安全组ID非法。 请输入正确的安全组ID后重试。 父主题： 附录

URI GET /v2/{project_id}/instances/{instance_id}/slowlog?curPage={curPage}&perPage={perPage}&startDate={startDate}&endDate={endDate} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。 获取方法请参见获取项目ID。 instance_id 是 String DDM实例ID。 表2 Query参数 参数 是否必选 参数类型 描述 curPage 是 String 分页参数：起始值 [大于等于1] 。 perPage 是 String 分页参数：每页多少条。 startDate 是 String 开始时间，UNIX时间戳格式，单位是毫秒。 endDate 是 String 结束时间，UNIX时间戳格式，单位是毫秒。 结束时间与开始时间，间隔不能超过7天。

响应示例 状态码： 200 OK { "totalRecord" : 2, "slowLogList" : [ { "users" : "testddm", "database" : "test1", "querySample" : "select id, sleep(3) from test", "logTime" : "2021-04-26T02:40:21", "time" : "12002", "shards" : "test1_0000", "rowsExamined" : "4", "host" : "192.168.16.18" } ]} 状态码： 400 bad request { "externalMessage" : "Parameter error.", "errCode" : "DBS.280001"} 状态码： 500 server error { "externalMessage" : "Server failure.", "errCode" : "DBS.200412"}

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 totalRecord Integer DDM慢SQL日志条数。 slowLogList Array of SlowLogList objects DDM慢SQL日志信息列表的集合。 表5 SlowLogList 参数 参数类型 描述 users String 执行慢SQL的DDM账号名称。 database String 慢SQL所属逻辑库的名称。 querySample String 慢SQL执行语法。 logTime String DDM慢SQL开始执行时间，格式为“yyyy-mm-ddThh:mm:ssZ”。 time String 慢SQL的执行时长，精确到毫秒。 shards String 逻辑库物理分片名称。 rowsExamined String 慢SQL影响行数。 host String 客户端IP，该IP地址可能涉及个人数据，建议用户依据实际IP地址的敏感性做查询后脱敏处理。 状态码： 400 表6 响应Body参数 参数 参数类型 描述 errCode String 业务错误码。 externalMessage String 错误信息。 状态码： 500 表7 响应Body参数 参数 参数类型 描述 errCode String 业务错误码。 externalMessage String 错误信息。

响应消息 正常响应参数说明 表3 响应Body参数 参数 参数类型 描述 total_count Integer 总条数。 logical_processes Array of 表4 objects 实例的逻辑会话列表。 表4 logicalProcessesInfo 参数 参数类型 描述 id String 逻辑会话ID。 user String 当前连接的用户。 host String 所属的IP和端口。 db String 数据库名。 command String 连接状态，一般是休眠（sleep），查询（query），连接（connect）。 time String 连接状态持续的时间，单位是秒（s）。 state String 当前SQL语句的状态。 info String 当前所执行的SQL语句。 正常响应示例 { "logical_processes": [ { "id": "4564224", "user": "drdsagent", "host": "127.0.0.1:54486", "db": "None", "command": "Query", "time": "0", "state": "starting", "info": "show processlist" } ], "total_count": 1} 异常响应 请参见异常请求结果。

URI URL格式 GET /v3/{project_id}/instances/{instance_id}/logical-processes?offset={offset}&limit={limit} 参数说明 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户在某一region下的project ID。 获取方法请参见获取项目ID。 instance_id 是 String DDM实例ID。 表2 Query参数 参数 是否必选 参数类型 描述 offset 否 Integer 索引位置，偏移量。 从第一条数据偏移offset条数据后开始查询，默认为0。 取值必须为数字，且不能为负数。 limit 否 Integer 查询个数上限值。 取值范围：1~128。 不传该参数时，默认值为10。 keyword 否 String 会话结果筛选关键字，支持返回结果全字段模糊匹配，长度最大255。

URI URL格式 DELETE /v3/{project_id}/instances/{instance_id}/databases/{database_name}?delete_dn_data={delete_dn_data} 参数说明 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户在某一region下的project ID。 获取方法请参见获取项目ID。 instance_id 是 String DDM实例ID。 database_name 是 String 逻辑库名称。 表2 Query参数 参数 是否必选 参数类型 描述 delete_dn_data 是 Boolean 是否同时删除关联后端数据库实例上存储的数据。 取值为true：删除。 取值false：不删除。

调用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": "project_name", "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" }}

请求消息 请求参数 无。 URI样例 删除逻辑库(删除关联后端数据库实例上存储的数据)。 DELETE https://{endpoint}/v3/{project_id}/instances/{instance_id}/databases/{database_name}?delete_dn_data=true 删除逻辑库(保留关联后端数据库实例上存储的数据)。 DELETE https://{endpoint}/v3/{project_id}/instances/{instance_id}/databases/{database_name}?delete_dn_data=false