华为云用户手册

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 name String DDM实例账号名称。 状态码： 400 表4 响应Body参数 参数 参数类型 描述 errCode String 业务错误码。 externalMessage String 错误信息。 状态码： 500 表5 响应Body参数 参数 参数类型 描述 errCode String 业务错误码。 externalMessage String 错误信息。

响应示例 状态码： 200 OK { "instances" : [ { "id" : "c6f68fed9e74478c8679479a07d7d568in01", "projectId" : "055d9f4ee780d4d42f96c01c1bc3c50c", "status" : "normal", "name" : "test-ddm-no-delete-test01-00", "engineName" : "mysql", "engineSoftwareVersion" : 5.7, "privateIp" : "192.168.23.97", "mode" : "Ha", "port" : 3306, "azCode" : "az1xahzaz1xahz", "timeZone" : "UTC+08: 00" }, { "id" : "337e2598c2a64cb5935079f85996731din01", "projectId" : "055d9f4ee780d4d42f96c01c1bc3c50c", "status" : "normal", "name" : "test-ddm-no-delete-test01", "engineName" : "mysql", "engineSoftwareVersion" : 5.7, "privateIp" : "192.168.23.221", "mode" : "Ha", "port" : 3306, "azCode" : "az1xahzaz1xahz", "timeZone" : "UTC+08: 00" } ], "offset" : 0, "limit" : 6, "total" : 2 } 状态码： 400 bad request { "externalMessage" : "Parameter error.", "errCode" : "DBS.280001" } 状态码： 500 server error { "externalMessage" : "Server failure.", "errCode" : "DBS.200412" }

URI GET /v1/{project_id}/instances/{instance_id}/rds?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。

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 instances Array of QueryAvailableRdsList objects 获取创建逻辑库可用数据库实例信息列表的集合。 offset Integer 分页参数: 起始值。 limit Integer 分页参数：每页多少条。 total Integer 集合总数 表5 QueryAvailableRdsList 参数 参数类型 描述 id String 数据库实例 ID。 projectId String 数据库实例所在租户在某一region下的project ID。 status String 数据库实例状态。 name String 数据库实例名称。 engineName String 数据库实例引擎名称。 engineSoftwareVersion String 数据库实例引擎版本。 privateIp String 数据库实例内网连接地址。 mode String 数据库实例类型（主备或单机）。 port Integer 数据库实例端口。 azCode String 可用区。 timeZone String 时区。 状态码： 400 表6 响应Body参数 参数 参数类型 描述 errCode String 业务错误码 externalMessage String 错误信息 状态码： 500 表7 响应Body参数 参数 参数类型 描述 errCode String 业务错误码 externalMessage String 错误信息

响应示例 状态码： 200 OK { "databases" : [ { "name" : "mytestdb" } ] } 状态码： 400 bad request { "externalMessage" : "Parameter error.", "errCode" : "DBS.280001" } 状态码： 500 server error { "externalMessage" : "Server failure.", "errCode" : "DBS.200412" }

响应参数 状态码： 200 表6 响应Body参数 参数 参数类型 描述 databases Array of CreateDatabaseDetailResponses objects 逻辑库相关信息的集合。 表7 CreateDatabaseDetailResponses 参数 参数类型 描述 name String 逻辑库名称。 状态码： 400 表8 响应Body参数 参数 参数类型 描述 errCode String 业务错误码。 externalMessage String 错误信息。 状态码： 500 表9 响应Body参数 参数 参数类型 描述 errCode String 业务错误码。 externalMessage String 错误信息。

请求示例 创建逻辑库时不新建DDM账号，关联已有账号。 POST https://{endpoint}/v1/{project_id}/instances/{instance_id}/databases { "databases" : [ { "name" : "mytestdb", "shard_mode" : "cluster", "shard_number" : 8, "shard_unit" : 8, "used_rds" : [ { "id" : "f296c394f13f48449d715bf99af07e59in01", "adminUser" : "root", "adminPassword" : "xxxxxx" } ] } ] }

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用 IAM 服务的“获取用户Token”接口来获取。 表3 请求Body参数 参数 是否必选 参数类型 描述 databases 是 Array of CreateDatabaseDetail objects 逻辑库相关信息的集合。 表4 CreateDatabaseDetail 参数 是否必选 参数类型 描述 name 是 String 逻辑库名称，需要满足以下条件： 长度为2-48个字符。 必须以小写字母开头。 可以包含小写字母、数字、下划线，不能包含大写字母和其它特殊字符。 禁用关键字： "information_schema"、"mysql"、"performance_schema"、"sys"。 最小长度：2 最大长度：48 shard_mode 是 String 逻辑库的拆分模式。 cluster表示逻辑库是拆分模式。 single表示逻辑库是非拆分模式。 枚举值： cluster single shard_number 是 Integer 同一种工作模式下逻辑库分片的数量。 shard_unit不为空， shard_unit与关联rds数量的乘积 shard_unit为空，大于关联的RDS数量，小于等于关联rds数量*64。 shard_unit 否 Integer 单个RDS上的逻辑库分片数。非必选 非拆分逻辑库，固定为1。 拆分逻辑库，大于等于1，小于等于64。 最小值：1 最大值：64 used_rds 是 Array of DatabaseInstabcesParam objects 逻辑库关联的RDS。 表5 DatabaseInstabcesParam 参数 是否必选 参数类型 描述 id 是 String 逻辑库关联的RDS的ID。 adminUser 是 String 关联RDS实例的用户。 adminPassword 是 String 关联RDS实例的密码。

响应示例 状态码： 200 OK { "computeFlavorGroups" : [ { "offset" : 0, "limit" : 128, "total" : 6, "groupType" : "X86", "computeFlavors" : [ { "id" : "8f2e696c-a9c1-30bd-af90-25522bc67606", "typeCode" : "hws.resource.type.ddm", "code" : "ddm.c3.large.2", "iaasCode" : "c3.large.2", "cpu" : "2", "mem" : "4", "maxConnections" : "null", "serverType" : "KVM", "architecture" : "X86", "azStatus" : { "az2.dc0" : "unsupported", "az3xahz" : "normal", "az2xahz" : "normal", "az1xahz" : "normal" }, "regionStatus" : "normal", "dbType" : "DDM", "extendFields" : { "azCode" : "az2.dc0,az3xahz,az2xahz,az1xahz", "azDescription" : "az2.dc0,az3xahz,az2xahz,az1xahz" } } ] }, { "offset" : 0, "limit" : 128, "total" : 3, "groupType" : "ARM", "computeFlavors" : [ { "id" : "87a6cb8b-0c56-3e16-a91d-9b680a1f8b7f", "typeCode" : "hws.resource.type.ddm", "code" : "ddm.rc6.large.2", "iaasCode" : "kc1.xlarge.2", "cpu" : "4", "mem" : "8", "maxConnections" : "null", "serverType" : "KVM", "architecture" : "ARM", "azStatus" : { "az2.dc0" : "unsupported", "az3xahz" : "normal", "az2xahz" : "normal", "az1xahz" : "normal" }, "regionStatus" : "normal", "groupType" : "null", "dbType" : "DDM", "extendFields" : { "azCode" : "az2.dc0,az3xahz,az2xahz,az1xahz", "azDescription" : "az2.dc0,az3xahz,az2xahz,az1xahz" } } ] } ] } 状态码： 400 bad request { "externalMessage" : "Parameter error.", "errCode" : "DBS.280001" } 状态码： 500 server error { "externalMessage" : "Server failure.", "errCode" : "DBS.200412" }

URI GET /v2/{project_id}/flavors?engine_id={engine_id}&offset={offset}&limit={limit} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户在某一region下的project ID。 获取方法请参见获取项目ID。 表2 Query参数 参数 是否必选 参数类型 描述 engine_id 是 String 引擎ID，通过查询DDM引擎信息接口获取。 offset 否 Integer 索引位置，偏移量。 从第一条数据偏移offset条数据后开始查询，默认为0。 取值必须为数字，且不能为负数。 limit 否 Integer 查询个数上限值。 取值范围：1~128。 不传该参数时，默认值为10。

响应参数 状态码： 200 表6 响应Body参数 参数 参数类型 描述 users Array of CreateUsersDetailResponses objects DDM实例账号相关信息的集合。 表7 CreateUsersDetailResponses 参数 参数类型 描述 name String DDM实例账号名称。 状态码： 400 表8 响应Body参数 参数 参数类型 描述 errCode String 业务错误码。 externalMessage String 错误信息。 状态码： 500 表9 响应Body参数 参数 参数类型 描述 errCode String 业务错误码。 externalMessage String 错误信息。

请求示例 创建账号DDMuser1，具有CREATE、DROP、ALTER、INDEX、INSERT、DELETE、UPDATE、SELECT基础权限，关联的逻辑库为DDMdb1。 POST https://{endpoint}/v1/{project_id}/instances/{instance_id}/users { "users" : [ { "name" : "DDMuser1", "password" : "xxxxxx", "base_authority" : [ "CREATE", "DROP", "ALTER", "INDEX", "INSERT", "DELETE", "UPDATE", "SELECT" ], "description" : "", "databases" : [ { "name" : "DDMdb1" } ] } ] }

响应示例 状态码： 200 OK { "users" : [ { "name" : "DDMuser1" } ] } 状态码： 400 bad request { "externalMessage" : "Parameter error.", "errCode" : "DBS.280001" } 状态码： 500 server error { "externalMessage" : "Server failure.", "errCode" : "DBS.200412" }

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务的“获取用户Token”接口来获取。 表3 请求Body参数 参数 是否必选 参数类型 描述 users 是 Array of CreateUsersInfo objects DDM实例账号相关信息的集合。 表4 CreateUsersInfo 参数 是否必选 参数类型 描述 name 是 String DDM实例账号名称，命名要求如下。 长度为1-32个字符。 必须以字母开头。 可以包含字母，数字、下划线，不能包含其它特殊字符。 最小长度：1 最大长度：32 password 是 String DDM实例账号密码。 base_authority 是 Array of strings DDM实例账号的基础权限。 取值为：CREATE、DROP、ALTER、INDEX、INSERT、DELETE、UPDATE、SELECT 枚举值： CREATE DROP ALTER INDEX INSERT DELETE UPDATE SELECT description 否 String DDM实例账号的描述，最大长度不能超过256。默认值为空。 最大长度：256 databases 否 Array of CreateUsersDatabases objects 关联的逻辑库的集合。 databases字段可以省略，即创建用户时可以不关联逻辑库。 表5 CreateUsersDatabases 参数 是否必选 参数类型 描述 name 是 String 关联逻辑库名称。

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 security_group_id String 安全组ID。 状态码： 400 表5 响应Body参数 参数 参数类型 描述 errCode String 业务错误码。 externalMessage String 错误信息。 状态码： 500 表6 响应Body参数 参数 参数类型 描述 errCode String 业务错误码。 externalMessage String 错误信息。

响应示例 状态码： 200 OK { "security_group_id" : "035b70ed-319b-4086-9fd7-62a2e8548b2e" } 状态码： 400 bad request { "externalMessage" : "Parameter error.", "errCode" : "DBS.280001" } 状态码： 500 server error { "externalMessage" : "Server failure.", "errCode" : "DBS.200412" }

响应示例 状态码： 200 ok { } 状态码： 400 bad request { "externalMessage" : "Parameter error.", "errCode" : "DBS.280001" } 状态码： 500 server error { "externalMessage" : "Server failure.", "errCode" : "DBS.200412" }

操作步骤 删除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" }

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

响应示例 状态码： 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" }

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

操作步骤 指定limit与offset查询DDM实例列表。 接口相关信息 URI格式： GET /v1/{project_id}/instances 详情请参见查询DDM实例列表。 请求示例 GET: https://{endpoint}/v1/743b4c0428d945316666666666666666/instances?offset=0&limit=1 {endpoint}信息请从地区和终端节点获取。 limit值可根据DDM实例数据调整。 响应示例 { "instance_num":10, "instances": [ { "id":"cab932b426ed4215a8d76b9d71322661in09", "status":"RUNNING", "name":"ddm-20-single-2u4g-1-202010231552401522260", "created":"2020-10-23T07:52:46+0000", "updated":"2020-10-23T07:59:56+0000", "available_zone":"az1xahz", "vpc_id":"9cf0f8f5-9748-4ebb-9905-bbe429182bd6", "subnet_id":"b35a4be7-65a5-4176-bec9-7a437493c498", "security_group_id":"9d10da6d-38cc-4cf0-8f96-c34940a3fd15", "node_count":1, "access_ip":"192.168.60.13", "access_port":"5066", "core_count":"2", "ram_capacity":"4", "node_status":"RUNNING", "enterprise_project_id":"0", "project_id":"070c071d8e80d58c2f42c0121b10cf9f", "engine_version":"2.5.10.10222119" } ], "page_no":1, "page_size":1, "total_record":10, "total_page":10 } 汇总查询结果。 参考1持续调用，如果查询的DDM实例列表为空，或者返回的body体中不存在instances字段，表明所有DDM实例查询完成。 汇总所有查询到的DDM实例即当前查询条件下的所有DDM实例。

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

响应示例 状态码： 200 OK { "instanceId" : "1f5c9fd6cd984056ba89c8c87cc03278in09", "jobId" : "6f1334ca-faa6-479e-837f-f3219192675e" } 状态码： 400 bad request { "externalMessage" : "Parameter error.", "errCode" : "DBS.280001" } 状态码： 500 server error { "externalMessage" : "Server failure.", "errCode" : "DBS.200412" }

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 instanceId String DDM实例ID。 jobId String 任务ID。 状态码： 400 表4 响应Body参数 参数 参数类型 描述 errCode String 业务错误码。 externalMessage String 错误信息。 状态码： 500 表5 响应Body参数 参数 参数类型 描述 errCode String 业务错误码。 externalMessage String 错误信息。

Token认证 Token的有效期为24小时，需要使用一个Token鉴权时，可以先缓存起来，避免频繁调用。 Token在计算机系统中代表令牌（临时）的意思，拥有Token就代表拥有某种权限。Token认证就是在调用API的时候将Token加到请求消息头，从而通过身份认证，获得操作API的权限。 Token可通过调用获取用户Token接口获取，调用本服务API需要project级别的Token，即调用获取用户Token接口时，请求body中auth.scope的取值需要选择project，如下所示。 { "auth": { "identity": { "methods": [ "password" ], "password": { "user": { "name": "username", "password": "********", "domain": { "name": "domainname" } } } }, "scope": { "project": { "name": "xxxxxxxx" } } } } 在构造请求中以调用获取用户Token接口为例说明了如何调用API。 获取Token 后，再调用其他接口时，您需要在请求消息头中添加“X-Auth-Token”，其值即为Token。例如Token值为“ABCDEFJ....”，则调用接口时将“X-Auth-Token: ABCDEFJ....”加到请求消息头即可，如下所示。 1 2 3 POST https://iam.cn-north-1.myhuaweicloud.com/v3/auth/projects Content-Type: application/json X-Auth-Token: ABCDEFJ.... 您还可以通过这个视频教程了解如何使用Token认证：https://bbs.huaweicloud.com/videos/101333 。

AK/SK认证 AK/SK签名认证方式仅支持消息体大小12MB以内，12MB以上的请求请使用Token认证。 AK/SK认证就是使用AK/SK对请求进行签名，在请求时将签名信息添加到消息头，从而通过身份认证。 AK(Access Key ID)：访问密钥ID。与私有访问密钥关联的唯一标识符；访问密钥ID和私有访问密钥一起使用，对请求进行加密签名。 SK(Secret Access Key)：与访问密钥ID结合使用的密钥，对请求进行加密签名，可标识发送方，并防止请求被修改。 使用AK/SK认证时，您可以基于签名算法使用AK/SK对请求进行签名，也可以使用专门的签名SDK对请求进行签名。详细的签名方法和SDK使用方法请参见API签名指南。 签名SDK只提供签名功能，与服务提供的SDK不同，使用时请注意。

修订记录 发布日期 修订记录 2024-06-30 第十七次正式发布。 2023-09-04 第十六次正式发布。 权限管理，新增如下操作的细粒度权限策略：查询标签列表、添加/修改/删除标签、查询会话、Kill会话。 2022-08-18 第十五次正式发布。 优化DN实例使用限制章节。 优化产品核心功能章节。 2022-08-09 第十四次正式发布。 优化不支持的特性和使用限制章节。 2022-03-29 第十三次正式发布。 增加DDM原理图。 2022-02-08 第十二次正式发布。 增加不支持的功能特性章节。 2022-01-27 第十一次正式发布。 优化SQL语法使用限制章节。 2022-01-21 第十次正式发布。 优化产品概述章节。 2021-12-30 第九次正式发布。 修改产品概述。 2021-12-13 第八次正式发布。 完善SQL语法使用限制。 2021-11-11 第七次正式发布。 修改DDM实现原理图。 2021-01-15 第六次正式发布。 增加常用概念。 完善MySQ L实例 使用限制。 2020-12-28 第五次正式发布。 刷新DDM实现原理图。 2020-10-20 第四次正式发布。 刷新产品功能、网络访问使用限制等内容。 2020-09-30 第三次正式发布。 刷新产品规格、应用场景等内容。 2020-08-07 第二次正式发布。 刷新权限管理等内容。 2020-04-30 DDM 2.0第一次正式发布。

操作场景 CDM 集群已经创建成功后，您可以查看集群基本信息，并修改集群的配置。 查看集群基本信息： 集群信息：集群版本、创建时间、项目ID、实例ID和集群ID等。 节点配置：集群规格、CPU和内存配置等信息。 网络信息：网络配置。 支持修改集群的以下配置： 消息通知 ：CDM的迁移作业（目前仅支持表/文件迁移的作业）失败时，或者EIP异常时，会发送短信或邮件通知用户。该功能产生的消息通知不会计入收费项。 用户隔离：控制其他用户是否能够查看、操作该集群中的迁移作业和连接。 开启该功能时，该集群中的迁移作业、连接会被隔离，华为账号下的其他IAM用户无法查看、操作该集群中的迁移作业和连接。 按组批量启动作业会运行组内所有作业。如果开启了用户隔离功能，即使华为账号下的其他IAM用户无法查看到组内作业，按组批量启动作业依然会将组内作业运行，因此在用户隔离场景不建议使用按组批量启动作业功能。 关闭该功能时，该集群中的迁移作业、连接信息可以用户共享，华为账号下的所有拥有相应权限的IAM用户可以查看、操作迁移作业和连接。 注意，用户隔离关闭后需要重启集群VM才能生效。 最大抽取并发数：限制作业运行的总抽取并发数，如果当前所有作业总并发数超出限制，超出部分将排队等待。 注意，最大抽取并发数取值范围为1-1000，建议根据集群规格进行配置，建议值详见最大抽取并发数。过高的并发数可能导致内存溢出，请谨慎修改。 此处的“最大抽取并发数”参数与作业配置管理处的“最大抽取并发数”参数同步，在任意一处修改即可生效。