华为云用户手册

响应消息体（可选） 该部分可选。响应消息体通常以结构化格式（如JSON或XML）返回，与响应消息头中Content-Type对应，传递除响应消息头之外的内容。 对于获取用户Token接口，返回如下消息体。为篇幅起见，这里只展示部分内容。 { "token": { "expires_at": "2019-02-13T06:52:13.855000Z", "methods": [ "password" ], "catalog": [ { "endpoints": [ { "region_id": "az-01", ...... 当接口调用出错时，会返回错误码及错误信息说明，错误响应的Body体格式如下所示。 { "error_code": "AS.0001", "error_msg": "The format of message is error" } 其中，“error_code”表示错误码，“error_msg”表示错误描述信息。

响应示例 状态码： 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 错误信息。

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 { "name" : "DDM-test-04" } 状态码： 400 bad request { "externalMessage" : "Parameter error.", "errCode" : "DBS.280001" } 状态码： 500 server error { "externalMessage" : "Server failure.", "errCode" : "DBS.200412" }

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

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用 IAM 服务的“获取用户Token”接口来获取。 表3 请求Body参数 参数 是否必选 参数类型 描述 name 是 String DDM实例名称，命名要求如下。 长度为4-64个字符。 必须以字母开头。 可以包含字母、数字、中划线、下划线，不能包含其它特殊字符。 最小长度：4 最大长度：64

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

响应示例 状态码： 200 OK { "nodes" : [ { "port" : "5066", "status" : "normal", "node_id" : "4a2b97b7f5e3462c9c78aae93b46ed83no09", "ip" : "192.168.0.160" } ], "offset" : 0, "limit" : 128, "total" : 1 } 状态码： 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}/nodes?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参数 参数 参数类型 描述 nodes Array of NodeList objects DDM实例节点信息列表的集合。 offset Integer 分页参数: 起始值。 limit Integer 分页参数：每页多少条。 total Integer DDM实例节点个数。 表5 NodeList 参数 参数类型 描述 port String 端口。 status String 节点状态。 node_id String 节点ID。 ip String IP。 状态码： 400 表6 响应Body参数 参数 参数类型 描述 errCode String 业务错误码。 externalMessage String 错误信息。 状态码： 500 表7 响应Body参数 参数 参数类型 描述 errCode String 业务错误码。 externalMessage String 错误信息。

响应示例 状态码： 200 OK { "engineGroups" : [ { "id" : "b6907aa2-aacb-3ac9-9782-b90b152d456c", "name" : "ddm", "version" : "3.0.8", "supportAzs" : [ { "code" : "az1", "name" : "az1", "favored" : false }, { "code" : "az2", "name" : "az2", "favored" : true } ] } ], "offset" : 0, "limit" : 128, "total" : 1 } 状态码： 400 bad request { "externalMessage" : "Parameter error.", "errCode" : "DBS.280001" } 状态码： 500 server error { "externalMessage" : "Server failure.", "errCode" : "DBS.200412" }

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

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 engineGroups Array of EngineGroupsInfo objects 引擎信息列表。 offset Integer 分页参数: 起始值。 limit Integer 分页参数：每页多少条。 total Integer 引擎信息总数。 表5 EngineGroupsInfo 参数 参数类型 描述 id String 引擎ID。 name String 引擎名称。 version String 引擎版本。 supportAzs Array of SupportAzsInfo objects 可用区列表。 表6 SupportAzsInfo 参数 参数类型 描述 code String 可用区编码。 name String 可用区名称。 favored Boolean 是否支持。 状态码： 400 表7 响应Body参数 参数 参数类型 描述 errCode String 业务错误码。 externalMessage String 错误信息。 状态码： 500 表8 响应Body参数 参数 参数类型 描述 errCode String 业务错误码。 externalMessage String 错误信息。

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实例的读写次数。

响应示例 状态码： 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参数 参数 参数类型 描述 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 错误信息。

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 OK { "status" : "normal", "name" : "ddm2-test_node_01", "node_id" : "4a2b97b7f5e3462c9c78aae93b46ed83no09", "private_ip" : "192.168.0.160", "floating_ip" : "100.65.78.158", "server_id" : "8bd4d0bd-f63e-489a-95b6-50351f9657e6", "datavolume_id" : "30ade9fb-26de-4d1f-af08-c376974b9d86", "res_subnet_ip" : "172.16.15.224", "systemvolume_id" : "88d7de55-f886-4929-ae7c-04d842959700" } 状态码： 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}/nodes/{node_id} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户在某一region下的project ID。 获取方法请参见获取项目ID。 instance_id 是 String DDM实例ID。 node_id 是 String DDM节点ID。

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 status String 节点状态。 name String 节点名称。 node_id String 节点ID。 private_ip String 节点私有IP。 floating_ip String 节点浮动IP。 server_id String 虚拟机ID。 subnet_name String 子网名称。 datavolume_id String 数据盘ID。 res_subnet_ip String 资源子网IP。 systemvolume_id String 系统盘ID。 状态码： 400 表4 响应Body参数 参数 参数类型 描述 errCode String 业务错误码。 externalMessage String 错误信息。 状态码： 500 表5 响应Body参数 参数 参数类型 描述 errCode String 业务错误码。 externalMessage String 错误信息。

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

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

请求示例 修改账号权限为SELECT，关联的逻辑库为db_7350。 PUT https://{endpoint}/v1/{project_id}/instances/{instance_id}/users/{username} { "user" : { "base_authority" : [ "SELECT" ], "description" : "test11", "databases" : [ { "name" : "db_7350" } ] } }

响应示例 状态码： 200 OK { "name" : "ddmtest" } 状态码： 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参数 参数 是否必选 参数类型 描述 user 是 UpdateUserDetailReq object DDM实例账号相关信息的集合。 表4 UpdateUserDetailReq 参数 是否必选 参数类型 描述 base_authority 否 Array of strings DDM实例账号的基础权限，默认值为原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 UpdateUsersDatabases objects DDM实例账号相关信息的集合。 表5 UpdateUsersDatabases 参数 是否必选 参数类型 描述 name 否 String 逻辑库名称，不区分大小写，databases和name字段必须同时缺失或者同时存在。 默认值为空。

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

URI DELETE /v1/{project_id}/instances/{instance_id}/databases/{ddm_dbname}?delete_rds_data={delete_rds_data} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。 获取方法请参见获取项目ID。 instance_id 是 String DDM实例ID。 ddm_dbname 是 String 需要查询的逻辑库名称，不区分大小写。 表2 Query参数 参数 是否必选 参数类型 描述 delete_rds_data 否 String 是否同时删除关联后端数据库实例上存储的数据。 取值为“true”：删除。 取值为空或“false”：不删除。 默认值为空。 枚举值： true false

请求示例 删除DDM逻辑库(删除关联后端数据库实例上存储的数据)。 DELETE https://{endpoint}/v1/{project_id}/instances/{instance_id}/databases/{ddm_dbname}?delete_rds_data=true 删除DDM逻辑库(保留关联后端数据库实例上存储的数据)。 DELETE https://{endpoint}/v1/{project_id}/instances/{instance_id}/databases/{ddm_dbname}?delete_rds_data=false

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