删除DDM帐号_分布式数据库中间件 DDM_API参考_帐号管理_华为云

(1)

API 参考

文档版本 25

发布日期 2022-01-30

(2)

非经本公司书面许可，任何单位和个人不得擅自摘抄、复制本文档内容的部分或全部，并不得以任何形式传播。

商标声明

和其他华为商标均为华为技术有限公司的商标。

本文档提及的其他所有商标或注册商标，由各自的所有人拥有。

注意

您购买的产品、服务或特性等应受华为公司商业合同和条款的约束，本文档中描述的全部或部分产品、服务或特性可能不在您的购买或使用范围之内。除非合同另有约定，华为公司对本文档内容不做任何明示或暗示的声明或保证。

由于产品版本升级或其他原因，本文档内容会不定期进行更新。除非另有约定，本文档仅作为使用指导，本文档中的所有陈述、信息和建议不构成任何明示或暗示的担保。

(3)

1 ^{使用前必读}

1.1 概述 View

欢迎使用分布式数据库中间件（Distributed Database Middleware，简称DDM），本文档提供了分布式数据库中间件API的描述、语法、参数说明及样例等内容。

在调用分布式数据库中间件分布式数据库中间件API之前，请确保已经充分了解分布式数据库中间件相关概念。

您可以使用本文档提供API进行相关操作，如创建、修改、查询、变更、查询等。

说明

● DDM服务持续增加新的功能，将不可避免对现有接口有所调整（如增加响应参数），本接口文档将及时刷新内容。

● 为了减少接口变更带来的影响，除了DDM服务自身尽量做到接口向下兼容的同时，您在使用过程中，应当接受出现返回内容（JSON格式）含有未使用的参数和值的现象，即能够正常忽略未使用的参数和值。

1.2 调用说明

分布式数据库中间件提供了REST（Representational State Transfer）风格API，支持您通过HTTPS请求调用。

1.3 终端节点

终端节点即调用API的请求地址，不同服务不同区域的终端节点不同，您可以从地区和终端节点中查询服务的终端节点。

1.4 约束与限制

● 您能创建的分布式数据库中间件实例的数量与配额有关系。

● 更详细的限制请参见具体API的说明。

(6)

1.5 基本概念

● 帐号

用户注册时的帐号，帐号对其所拥有的资源及云服务具有完全的访问权限，可以重置用户密码、分配用户权限等。由于帐号是付费主体，为了确保帐号安全，建议您不要直接使用帐号进行日常管理工作，而是创建用户并使用他们进行日常管理工作。

● 用户

由帐号在IAM中创建的用户，是云服务的使用人员，具有身份凭证（密码和访问密钥）。

在我的凭证下，您可以查看帐号ID和用户ID。通常在调用API的鉴权过程中，您需要用到帐号、用户和密码等信息。

● 区域

指云资源所在的物理位置，同一区域内可用区间内网互通，不同区域间内网不互通。通过在不同地区创建云资源，可以将应用程序设计的更接近特定客户的要求，或满足不同地区的法律或其他要求。

● 可用区

一个可用区是一个或多个物理数据中心的集合，有独立的风火水电，AZ内逻辑上再将计算、网络、存储等资源划分成多个集群。一个Region中的多个AZ间通过高速光纤相连，以满足用户跨AZ构建高可用性系统的需求。

● 项目

区域默认对应一个项目，这个项目由系统预置，用来隔离物理区域间的资源（计算资源、存储资源和网络资源），以默认项目为单位进行授权，用户可以访问您帐号中该区域的所有资源。如果您希望进行更加精细的权限控制，可以在区域默认的项目中创建子项目，并在子项目中购买资源，然后以子项目为单位进行授权，使得用户仅能访问特定子项目中资源，使得资源的权限控制更加精确。

图1-1 项目隔离模型

– 企业项目

企业项目是项目的升级版，针对企业不同项目间资源的分组和管理，是逻辑隔离。企业项目中可以包含多个区域的资源，且项目中的资源可以迁入迁

(7)

关于企业项目ID的获取及企业项目特性的详细信息，请参见《企业管理服务用户指南》。

(8)

2 ^{API 概览}

数据复制服务所提供的接口为REST（Representational State Transfer）风格API。通过使用DDM接口，您可以使用DDM的所有功能，包括创建实例、创建逻辑库等。

表2-1 接口介绍

类型子类型说明

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实例的节点个数进行缩容。

(9)

类型子类型说明 DDM逻辑

库类接口创建DDM逻辑

库创建DDM逻辑库。

创建前需确保存在RDS实例，实例状态正常且没有被其他DDM实例关联使用。

查询DDM逻辑

库列表查询DDM逻辑库列表。

查询DDM逻辑库详细信息

查询指定逻辑库的详细信息。

删除DDM逻辑库

删除指定的逻辑库，释放该逻辑库的所有资源。

DDM帐号

类接口创建DDM帐号 DDM帐号用于连接和管理逻辑库。一个DDM帐号可以关联多个逻辑库。

查询DDM帐号

列表查询DDM帐号列表。

修改DDM帐号修改现有DDM帐号的权限或者与逻辑库的管理关系。

删除DDM帐号删除指定的DDM实例帐号，如果帐号关联了逻辑库，则对应的关联关系也会删除。

(10)

3 ^{如何调用 API}

3.1 构造请求

本节介绍REST API请求的组成，首先调用IAM服务的接口来获取用户Token。

您还可以通过这个视频教程了解如何构造请求调用API：https://

bbs.huaweicloud.com/videos/102987 。

请求 URI

请求URI由如下部分组成。

{URI-scheme} :// {Endpoint} / {resource-path} ? {query-string}

尽管请求URI包含在请求消息头中，但大多数语言或框架都要求您从请求消息中单独传递它，所有在此单独拿出来强调。

表3-1 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条数据。

(11)

例如您需要获取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

图3-1 URI 示意图

说明

为查看方便，在每个具体API的URI部分，只给出resource-path部分，并将请求方法写在一起。

这是因为URI-scheme都是HTTPS，而Endpoint在同一个区域也相同，所以简洁起见将这两部分省略。

请求方法

HTTP方法（也称为操作或动词），它告诉服务你正在请求什么类型的操作。

表3-2 HTTP 方法

方法说明

GET 请求服务器返回指定资源。

PUT 请求服务器更新指定资源。

POST 请求服务器新增资源或执行特殊操作。

DELETE 请求服务器删除指定资源，如删除对象等。

在获取用户Token的URI部分，您可以看到其请求方法为“POST”，则其请求为：

POST https://iam.cn-north-1.myhuaweicloud.com/v3/auth/tokens

请求消息头

附加请求头字段，如指定的URI和HTTP方法所要求的字段。例如定义消息体类型的请求头“Content-Type”，请求鉴权信息等。

可选的附加请求头字段，如指定的URI和HTTP方法所要求的字段。详细的公共请求消息头字段请参见表3-3。

(12)

表3-3 公共请求消息头

名称描述是否必选示例

Host 请求的服务器信

息，从服务API的 URL中获取。值为 hostname[:port]。

端口缺省时使用默认的端口，https的默认端口为443。

否

使用AK/SK认证时该字段必选。

code.test.com or

code.test.com:443

Content-Type 发送的实体的MIME 类型。推荐用户默认使用application/

json，如果API是对象、镜像上传等接口，媒体类型可按照流类型的不同进行确定。

是 application/json

Content-

Length 请求body长度，单

位为Byte。 POST请求为可选，GET请求该字段值留空。

3495

X-Project-Id project id，项目编号。请参考获取项目ID章节获取项目编号。

否

如果是专属云场景采用AK/SK 认证方式的接口请求或者多project 场景采用AK/SK认证的接口请求则该字段必选。

e9993fc787d94b6c886cb aa340f9c0f4

X-Auth-Token 用户Token。

请求响应成功后在响应消息头中包含的“X-Subject- Token”的值即为 Token值。

否

使用Token认证时该字段必选。

注：以下仅为Token示例片段

MIIPAgYJKoZIhvcNAQcCo ...ggg1BBIINPXsidG9rZ

说明

API同时支持使用AK/SK认证，AK/SK认证是使用SDK对请求进行签名，签名过程会自动往请求中添加Authorization（签名认证信息）和X-Sdk-Date（请求发送的时间）请求头。

AK/SK认证的详细说明请参见AK/SK认证。

对于获取用户Token接口，由于不需要认证，所以只添加“Content-Type”即可，添

(13)

POST https://iam.cn-north-1.myhuaweicloud.com/v3/auth/tokens Content-Type: application/json

请求消息体（可选）

该部分可选。请求消息体通常以结构化格式（如JSON或XML）发出，与请求消息头中 Content-Type对应，传递除请求消息头之外的内容。若请求消息体中的参数支持中文，则中文字符必须为UTF-8编码。

每个接口的请求消息体内容不同，也并不是每个接口都需要有请求消息体（或者说消息体为空），GET、DELETE操作类型的接口就不需要消息体，消息体具体内容需要根据具体接口而定。

对于获取用户Token接口，您可以从接口的请求部分看到所需的请求参数及参数说明。将消息体加入后的请求如下所示，加粗的斜体字段需要根据实际值填写，其中

username

为用户名，

domainname

为用户所属的帐号名称，

********

为用户登录密码，

xxxxxxxxxxxxxxxxxx

为project的名称，如“cn-north-1”，您可以从地区和终端节点获取。

说明

scope参数定义了Token的作用域，上面示例中获取的Token仅能访问project下的资源。您还可以设置Token的作用域为某个帐号下所有资源或帐号的某个project下的资源。

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。

发起请求

共有三种方式可以基于已构建好的请求消息发起请求，分别为：

● cURL

(14)

cURL是一个命令行工具，用来执行各种URL操作和信息传输。cURL充当的是 HTTP客户端，可以发送HTTP请求给服务端，并接收响应消息。cURL适用于接口调试。关于cURL详细信息请参见https://curl.haxx.se/。

说明

为了安全起见，在服务器上使用curl命令调用接口查询信息后，需要清理历史操作记录，

包括但不限于“~/.bash_history”、“/var/log/messages”（如有）。

● 编码

通过编码调用接口，组装请求消息，并发送处理请求消息。

● REST客户端

Mozilla、Google都为REST提供了图形化的浏览器插件，发送处理请求消息。针对Firefox，请参见Firefox REST Client。针对Chrome，请参见Chrome REST

Client。

3.2 认证鉴权

调用接口有如下两种认证方式，您可以选择其中一种进行认证鉴权。

● Token认证：通过Token认证通用请求。

● AK/SK认证：通过AK（Access Key ID）/SK（Secret Access Key）加密调用请求。

推荐使用AK/SK认证，其安全性比Token认证要高。

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"

(15)

} }

在构造请求中以调用获取用户Token接口为例说明了如何调用API。

获取Token后，再调用其他接口时，您需要在请求消息头中添加“X-Auth-Token”，

其值即为Token。例如Token值为“ABCDEFJ....”，则调用接口时将“X-Auth-Token:

ABCDEFJ....”加到请求消息头即可，如下所示。

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不同，使用时请注意。

3.3 返回结果

状态码

请求发送以后，您会收到响应，包含状态码、响应消息头和消息体。

状态码是一组从1xx到5xx的数字代码，状态码表示了请求响应的状态，完整的状态码列表请参见状态码。

对于获取用户Token接口，如果调用后返回状态码为“201”，则表示请求成功。

响应消息头

对应请求消息头，响应同样也有消息头，如“Content-type”。

对于获取用户Token接口，返回如图3-2所示的消息头，其中“x-subject-token”就是需要获取的用户Token。有了Token之后，您就可以使用Token认证调用其他API。

(16)

图3-2 获取用户 Token 响应消息头

响应消息体（可选）

该部分可选。响应消息体通常以结构化格式（如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”表示错误描述信息。

(17)

4 ^实例管理

4.1 购买 DDM 实例

功能介绍

创建一个DDM实例。

接口约束

调试

您可以在API Explorer中调试该接口。

URI

POST /v1/{project_id}/instances

表4-1 路径参数

参数是否必选参数类型描述

project_id 是 String 租户在某一region下的project ID。

(18)

请求参数

表4-2 请求 Header 参数

X-Auth-Token 是 String 用户Token。

通过调用IAM服务获取用户 Token接口获取（响应消息头中 X-Subject-Token的值）。

表4-3 请求 Body 参数

instance 是

CreateInstan ceDetail

object

实例相关信息的集合。

extend_param 否

CreateInstan ceExtendPara m object

扩展参数，包年/包月类型实例相关信息的集合

表4-4 CreateInstanceDetail

name 是 String DDM实例名称，命名要求如

下。

● 长度为4-64个字符。

● 必须以字母开头。

● 可以包含字母、数字、中划线，不能包含其它特殊字符。

最小长度：4 最大长度：64 flavor_id 是 String 规格ID。

node_num 是 Integer 节点个数。

engine_id 是 String 引擎ID。

enterprise_pro

ject_id 否 String 企业项目ID。

(19)

参数是否必选参数类型描述 available_zon

es 是 Array of

strings 可用区code。取值非空，请参见地区和终端节点(https://

developer.huaweicloud.com/

endpoint?DDM)。

vpc_id 是 String 虚拟私有云的ID。

security_grou

p_id 是 String 安全组ID。

subnet_id 是 String 子网ID。

param_group_

id 否 String 参数组ID.

time_zone 否 String UTC时区。默认为UTC。取值范围："UTC","UTC-12:00","UTC-11:00

","UTC-10:00","UTC-09:00",

"UTC-08:00", "UTC-07:00",

"UTC-06:00", "UTC-05:00",

"UTC-04:00", "UTC-03:00",

"UTC-02:00", "UTC-01:00",

"UTC+01:00", "UTC+02:00",

"UTC+03:00", "UTC+04:00",

"UTC+05:00", "UTC+06:00",

"UTC+07:00", "UTC+08:00",

"UTC+09:00", "UTC+10:00",

"UTC+11:00", "UTC+12:00"

表4-5 CreateInstanceExtendParam

charge_mode 否 String 计费模式，取值范围：

● prePaid：预付费，即包年/

包月。

● postPaid：后付费，即按需付费。默认值为postPaid。

缺省值：postPaid 枚举值：

● prePaid

● postPaid

(20)

period_type 否 String 订购周期类型，取值范围：

● month：月。

● year：年。

“charge_mode”参数配置为“prePaid”时该参数有效且为必选值。

枚举值：

● month

● year

period_num 否 Integer 订购周期数，取值范围：

● period_type=month（周期类型为月）时，取值为[1，

9]。

● period_type=year（周期类型为年）时，取值为1。

“charge_mode”参数配置为“prePaid”时该参数有效且为必选值。

is_auto_renew 否 String 是否自动续订，取值范围：

● “true”：自动续订。

● “false”：不自动续订。

“charge_mode”参数配置为“prePaid”时该参数有效，不传该字段时默认为不自动续订。"

枚举值：

● true

● false

is_auto_pay 否 String 下单订购后，是否自动从客户的账户的余额中支付，取值范围：

● “true”：是（自动从客户账户的余额中支付）。

● “false”：否（需要客户手动支付）。

“charge_mode”参数配置为“prePaid”时该参数有效，不传该字段时默认为客户手动支付。"

枚举值：

● true

● false

(21)

响应参数

状态码： 200

表4-6 响应 Body 参数

参数参数类型描述

id String 实例ID。创建按需付费实例时返回该参数。

order_id String 订单号，创建包年/包月实例时返回该参数。

状态码： 400

errCode String 业务错误码 externalMess

age String 错误信息

状态码： 500

请求示例

● 请求示例（按需付费-不带扩展参数）

POST https://{endpoint}/v1/{project_id}/instances { "instance" : {

"name" : "ddm-test-001",

"flavor_id" : "8f2e696c-a9c1-30bd-af90-25522bc67606", "node_num" : "4,",

"engine_id" : "2325a707-0361-8be6-dd01-13474bbac437", "enterprise_project_id" : "0",

"available_zones" : [ "az1xahz" ],

"vpc_id" : "e1d886ec-cfe7-4cd4-b748-fc55a10b4172",

"security_group_id" : "035b70ed-319b-4086-9fd7-62a2e8548b2e", "subnet_id" : "f942f970-1a02-4eee-8927-xxxxxxxx",

"param_group_id" : "035b70ed-319b-4086-9fd7-xxxxxxxx"

}}

(22)

● 请求示例（按需付费-带扩展参数）

"flavor_id" : "8f2e696c-a9c1-30bd-af90-25522bc67606", "node_num" : 4,

"security_group_id" : "035b70ed-319b-4086-9fd7-62a2e8548b2e", "subnet_id" : "f942f970-1a02-4eee-8927-e8670ce5a882"

}, "extend_param" : {

"charge_mode" : "postPaid"

}}

● 请求示例（包年/包月）

"flavor_id" : "8f2e696c-a9c1-30bd-af90-25522bc67606", "node_num" : "4,",

"security_group_id" : "035b70ed-319b-4086-9fd7-62a2e8548b2e", "subnet_id" : "f942f970-1a02-4eee-8927-xxxxxxxx",

"param_group_id" : "035b70ed-319b-4086-9fd7-xxxxxxxx"

}, "extend_param" : {

"charge_mode" : "prePaid", "period_type" : "month", "period_num" : 1, "is_auto_renew" : "true", "is_auto_pay" : "true"

}}

响应示例

状态码： 200 OK

{ "id" : "",

"order_id" : "CS1810251738L8VVD"

}

状态码： 400 bad request

{ "externalMessage" : "Parameter error.", "errCode" : "DBS.280001"

}

状态码： 500

(23)

{ "externalMessage" : "Server failure.", "errCode" : "DBS.200412"

}

状态码

状态码描述

200 OK

400 bad request 500 server error

错误码

请参见错误码。

4.2 查询 DDM 实例列表

功能介绍

查询DDM实例列表。

接口约束

无

调试

URI

GET /v1/{project_id}/instances

表4-9 路径参数

(24)

表4-10 Query 参数

offset 否 Integer 分页参数：起始值 [大于等于

0] 。最小值：0

limit 否 Integer 分页参数：每页多少条 [大于0

且小于等于128]。

最小值：1 最大值：128

请求参数

响应参数

状态码： 200

instances Array of

ShowInstanc eBeanRespon se objects

DDM实例的信息。

instance_num Integer 租户下的DDM实例个数 page_no Integer 当前页码

page_size Integer 当前页码的数据条数 total_record Integer 总条数

total_page Integer 总页数

(25)

表4-13 ShowInstanceBeanResponse

id String DDM实例ID。

status String DDM实例状态。

name String 创建的实例名称。

created String 创建时间，格式为yyyy-mm-dd Thh:mm:ssZ。

其中，T指定某个时间的开始；Z指示 UTC 时间。

updated String 更新时间，格式与“created”完全相同。

available_zon

e String 可用区名称

vpc_id String 虚拟私有云的ID。

subnet_id String 子网ID。

security_grou

p_id String 安全组ID。

node_count Integer 节点数量。

access_ip String DDM实例访问地址。

access_port String DDM实例访问端口。

core_count String cpu个数。

ram_capacity String 内存大小，单位为G。

error_msg String 响应信息，若无异常信息则不返回该参数 node_status String 节点状态。

enterprise_pro

ject_id String 企业项目ID。

project_id String 租户在某一region下的project ID。

engine_versio

n String 引擎版本号（Core实例版本号）。

order_id String 包周期的实例，有订单id。

状态码： 400

errCode String 业务错误码

(26)

参数参数类型描述 externalMess

状态码： 500

请求示例

GET https://{endpoint}/v1/{project_id}/instances?offset={offset}&limit={limit}

响应示例

状态码： 200 OK

{ "instance_num" : 26, "instances" : [ {

"id" : "73f27bb0b26d4a79a9b0c58a4c700c4fin09,", "status" : "RUNNING,",

"name" : "ddm-36c7,",

"created" : "2021-12-14T07:46:22+0000,", "updated" : "2021-12-14T10:11:22+0000,", "available_zone" : "az1xahz,",

"vpc_id" : "1d9441c5-1a4b-431d-9edb-bf3564a83e74,", "subnet_id" : "20c2d83c-755b-42a2-846a-4688eb35d1a7,", "security_group_id" : "fbdff89d-32fe-45a4-832b-115ac4bfaac9,", "node_count" : "1,",

"access_ip" : "192.168.23.143", "access_port" : "5066,", "core_count" : "2,", "ram_capacity" : "4,", "node_status" : "RUNNING,", "enterprise_project_id" : "0,",

"project_id" : "055d9f4ee780d4d42f96c01c1bc3c50c,", "engine_version" : "3.0.8"

} ],

"page_size" : 1, "total_record" : 26, "total_page" : 26, "page_no" : 3 }

(27)

"errCode" : "DBS.280001"

}

状态码： 500 server error

}

状态码

状态码描述

200 OK

错误码

4.3 查询 DDM 实例详情

功能介绍

查询指定DDM实例的详细信息。

接口约束

无

调试

URI

GET /v1/{project_id}/instances/{instance_id}

表4-16 路径参数

instance_id 是 String DDM实例ID

(28)

请求参数

响应参数

状态码： 200

status String DDM实例状态。

name String DDM实例名称。

created String DDM实例创建时间。

updated String DDM实例最后更新时间。

available_zon

e String DDM实例可用区名称。

vpc_id String 虚拟私有云的ID。

subnet_id String 子网ID。

security_grou

p_id String 安全组ID。

node_count Integer 节点数量。

access_ip String DDM实例访问地址。

access_port String DDM实例访问端口。

node_status String 节点状态。

core_count String cpu个数。

ram_capacity String 内存大小，单位为G。

error_msg String 响应信息，若无异常信息则不返回该参数。

project_id String 项目ID。

(29)

参数参数类型描述 enterprise_pro

ject_id String 企业项目ID。

engine_versio

n String 引擎版本号（Core实例版本号）。

nodes Array of

GetDetailfNo desInfo

objects

节点信息。

表4-19 GetDetailfNodesInfo

status String DDM实例节点状态。

port String DDM实例节点port。

ip String DDM实例节点IP。

状态码： 400

状态码： 500

请求示例

GET https://{endpoint}/v1/{project_id}/instances/{instance_id}

(30)

响应示例

状态码： 200 OK

{ "nodes" : [ {

"status" : "RUNNING", "port" : 5066, "ip" : "192.168.0.160"

} ],

"id" : "1f5c9fd6cd984056ba89c8c87cc03278in09,", "status" : "RUNNING,",

"name" : "BUG-ddm2-lixingqiao-test,", "created" : "2021-11-09T03:30:01+0000,", "updated" : "2021-12-15T09:12:58+0000,", "available_zone" : "az1xahz,",

"vpc_id" : "cfaa4024-0603-4aba-81d4-2203b4ad26fb,", "subnet_id" : "48f270ef-af70-4ad9-bb1c-c28dd5b37f93,", "security_group_id" : "bc28ef93-0083-4652-bce6-381e14284db6,", "node_count" : "1,",

"access_ip" : "192.168.0.160,", "access_port" : "5066,", "core_count" : "2,", "ram_capacity" : "8,", "node_status" : "RUNNING,", "enterprise_project_id" : "0,",

"project_id" : "070c071d8e80d58c2f42c0121b10cf9f,", "engine_version" : "3.0.6"

}

状态码

状态码描述

200 OK

错误码

(31)

4.4 修改 DDM 实例名称

功能介绍

修改DDM实例名称。

接口约束

无

调试

URI

PUT /v1/{project_id}/instances/{instance_id}/modify-name

表4-22 路径参数

请求参数

(32)

name 是 String DDM实例名称，命名要求如

下。

● 长度为4-64个字符。

● 必须以字母开头。

● 可以包含字母、数字、中划线，不能包含其它特殊字符。

最小长度：4 最大长度：64

响应参数

状态码： 200

name String DDM实例名称

状态码： 400

状态码： 500

(33)

请求示例

PUT https://{endpoint}/v1/{project_id}/instances/{instance_id}/modify-name { "name" : "DDM_test_04"

}

响应示例

状态码： 200 OK

{ "name" : "DDM_test_04"

}

状态码

状态码描述

200 OK

错误码

4.5 修改 DDM 实例安全组

功能介绍

修改DDM实例安全组。

(34)

接口约束

无

调试

URI

PUT /v1/{project_id}/instances/{instance_id}/modify-security-group

表4-28 路径参数

请求参数

security_grou

p_id 是 String 安全组ID，默认值为原安全组

ID，可根据需要判断是否修改安全组ID

响应参数

状态码： 200

(35)

security_grou

p_id String 安全组ID

状态码： 400

状态码： 500

请求示例

PUT https://{endpoint}/v1/{project_id}/instances/{instance_id}/modify-security-group { "security_group_id" : "035b70ed-319b-4086-9fd7-62a2e8548b2e"

}

响应示例

状态码： 200 OK

{ "security_group_id" : "035b70ed-319b-4086-9fd7-62a2e8548b2e"

}

{ "externalMessage" : "Parameter error.",

(36)

}

状态码

状态码描述

200 OK

错误码

4.6 删除 DDM 实例

功能介绍

删除指定的DDM实例，释放该实例的所有资源。

接口约束

无

调试

URI

DELETE /v1/{project_id}/instances/{instance_id}

表4-34 路径参数

project_id 是 String 项目ID。

instance_id 是 String DDM实例ID。

(37)

delete_rds_da

ta 否 String 是否同时删除关联后端数据库实

例上存储的数据。

● 取值为空或“true”：删除。

● 取值为“false”：不删除。

默认值为空。

枚举值：

● true

● false

请求参数

响应参数

状态码： 200

状态码： 400

(38)

状态码： 500

请求示例

● 删除DDM实例(删除关联后端数据库实例上存储的数据)

DELETE https://{endpoint}/v1/{project_id}/instances/{instance_id}?delete_rds_data=true

● 删除DDM实例(保留关联后端数据库实例上存储的数据)

DELETE https://{endpoint}/v1/{project_id}/instances/{instance_id}?delete_rds_data=false

响应示例

状态码： 200 OK

{ "id" : "9608ce63-bf66-4342-be8a-44f9b6b15d54"

}

状态码

状态码描述

200 OK

(39)

错误码

4.7 重启 DDM 实例

功能介绍

重启指定的DDM实例。

接口约束

无。

调试

URI

POST /v1/{project_id}/instances/{instance_id}/action

表4-40 路径参数

请求参数

restart 否

RestarInstanc

eInfo object

重启相关的参数。

(40)

表4-43 RestarInstanceInfo

type 否 String 重启的类型，soft或者hard。

● soft表示软重启（只重启进程）。

● hard表示强制重启（重启虚拟机）。

枚举值：

● soft

● hard

响应参数

状态码： 200

instanceId String DDM实例ID。

instanceName String DDM实例名称。

jobId String 任务ID。

状态码： 400

状态码： 500

(41)

请求示例

POST https://{endpoint}/v1/{project_id}/instances/{instance_id}/action { "restart" : {

"type" : "soft"

}}

响应示例

状态码： 200 ok

{ "instanceId" : "28e8841d0b9c4f6a9a30742ee60e1068in09", "instanceName" : "BUG-ddm-fb88-test",

"jobId" : "1eb697c0-1842-43a3-8671-f562d0385cb9"

}

状态码

状态码描述

200 ok

(42)

错误码

4.8 DDM 表数据重载

功能介绍

DDM实例跨region容灾场景下，针对目标DDM实例实现表数据reload，使数据同步。

接口约束

无。

调试

URI

POST /v1/{project_id}/instances/{instance_id}/reload-config

表4-47 路径参数

请求参数

响应参数

(43)

状态码： 500

请求示例

POST https://{endpoint}/v1/{project_id}/instances/{instance_id}/reload_config { }

响应示例

状态码： 200 ok

{ }

}

(44)

状态码

状态码描述

200 ok

错误码

4.9 DDM 实例节点扩容

功能介绍

对指定的DDM实例的节点个数进行扩容。

接口约束

请确保实例关联的RDS状态正常并且没有进行其他操作。包周期实例不支持该操作。

调试

URI

POST /v2/{project_id}/instances/{instance_id}/action/enlarge

表4-51 路径参数

(45)

请求参数

flavor_id 是 String 当前进行节点扩容的DDM实例底层虚机规格id

node_number 是 Integer 需要扩容的节点个数

group_id 否 String 组id，指定当前进行节点扩容的组。当实例的组>1时，必填。

响应参数

状态码： 200

状态码： 400

(46)

状态码： 500

请求示例

● 请求示例1

POST https://{endpoint}/v2/{project_id}/instances/{instance_id}/action/enlarge { "flavor_id" : "8f2e696c-a9c1-30bd-af90-25522bc67606",

"node_number" : 1 }

● 请求示例2, 实例有多个组

POST https://{endpoint}/v2/{project_id}/instances/{instance_id}/action/enlarge { "flavor_id" : "8f2e696c-a9c1-30bd-af90-25522bc67606",

"group_id" : "f080abf2010d45118068c28c8958f5fcgr09", "node_number" : 1

}

响应示例

状态码： 200 ok

"jobId" : "1eb697c0-1842-43a3-8671-f562d0385cb9"

}

(47)

状态码

状态码描述

200 ok

错误码

4.10 DDM 实例节点缩容

功能介绍

对指定的DDM实例的节点个数进行缩容。

接口约束

请确保实例关联的RDS状态正常并且没有进行其他操作。包周期实例不支持该操作。

调试

URI

POST /v2/{project_id}/instances/{instance_id}/action/reduce

表4-57 路径参数

(48)

请求参数

node_number 是 Integer 需要缩容的节点数量，最大值为实例节点数减1。

group_id 否 String 组id，指定当前进行节点扩容的组。当实例的组>1时，必填。

响应参数

状态码： 200

状态码： 400

(49)

请求示例

● 请求示例1

POST https://{endpoint}/v2/{project_id}/instances/{instance_id}/action/reduce { "node_number" : 2

}

● 请求示例2, 实例有多个组

POST https://{endpoint}/v2/{project_id}/instances/{instance_id}/action/reduce { "group_id" : "f080abf2010d45118068c28c8958f5fcgr09",

"node_number" : 1 }

响应示例

状态码： 200 ok

"jobId" : "1eb697c0-1842-43a3-8671-f562d0385cb9"

}

状态码

状态码描述

200 ok

(50)

状态码描述

错误码

4.11 修改 DDM 已关联的数据库实例的读策略

功能介绍

修改DDM已关联的数据库实例的读策略。

接口约束

请确保实例关联的RDS状态正常并且没有进行其他操作。

调试

URI

PUT /v2/{project_id}/instances/{instance_id}/action/read-write-strategy

表4-63 路径参数

请求参数

(51)

read_weight 是 Object 主数据库实例与只读数据库实例的读权重集合。

响应参数

状态码： 200

success Boolean 操作是否成功。

instance_id String DDM实例ID。

状态码： 400

状态码： 500

请求示例

PUT https://{endpoint}/v2/{project_id}/instances/{instance_id}/action/read-write-strategy { "read_weight" : {

"395298ae6fb9496d95939ed556474983in01" : 60, "38ef52c365a14b7caeb7333137900e96in01" : 50

(52)

}}

响应示例

状态码： 200 ok

{ "success" : true,

"instance_id" : "175f5aff-xxxx-xxxx-xxxx-d0858982bbec"

}

状态码

状态码描述

200 ok

错误码

4.12 同步数据库实例信息

功能介绍

同步当前DDM实例已关的所有数据库实例配置信息。

接口约束

(53)

调试

URI

POST /v1/{project_id}/instances/{instance_id}/rds/sync

表4-69 路径参数

请求参数

响应参数

状态码： 200

instanceId String DDM实例id。

状态码： 400

errCode String 业务错误码

(54)

参数参数类型描述 externalMess

状态码： 500

请求示例

POST https://{endpoint}/v1/{project_id}/instances/{instance_id}/rds/sync 无

响应示例

状态码： 200 OK

{ "instanceId" : "1f5c9fd6cd984056ba89c8c87cc03278in09", "jobId" : "6f1334ca-faa6-479e-837f-f3219192675e"

}

状态码

状态码描述

(55)

状态码描述

错误码

4.13 查询 DDM 实例节点列表

功能介绍

查询DDM实例节点列表。

接口约束

无

调试

URI

GET /v1/{project_id}/instances/{instance_id}/nodes

表4-74 路径参数

0] 。最小值：0

(56)

请求参数

响应参数

状态码： 200

nodes Array of

NodeList

objects

DDM实例节点信息列表的集合。

offset Integer 分页参数: 起始值。

limit Integer 分页参数：每页多少条。

total Integer DDM实例节点个数。

表4-78 NodeList

port String 端口。

status String 节点状态。

node_id String 节点id。

ip String ip

(57)

状态码： 400

状态码： 500

请求示例

GET https://{endpoint}/v1/{project_id}/instances/{instance_id}/nodes

响应示例

状态码： 200 OK

{ "nodes" : [ { "port" : "5066,", "status" : "normal,",

"node_id" : "4a2b97b7f5e3462c9c78aae93b46ed83no09,", "ip" : "192.168.0.160"

} ],

"offset" : "DBS.280001", "limit" : 128,

"total" : 1 }

}

{ "externalMessage" : "Server failure.",

(58)

}

状态码

状态码描述

200 OK

错误码

4.14 查询 DDM 实例节点详情

功能介绍

查询DDM实例节点详情。

接口约束

无

调试

URI

GET /v1/{project_id}/instances/{instance_id}/nodes/{node_id}

表4-81 路径参数

node_id 是 String DDM节点ID

(59)

请求参数

响应参数

状态码： 200

status String 节点状态。

name String 节点名称。

node_id String 节点id。

private_ip String 节点私有ip。

floating_ip String 节点浮动ip。

server_id String 虚机id。

subnet_name String 子网名称。

datavolume_i

d String 数据盘id。

res_subnet_ip String 资源子网ip。

systemvolume

_id String 系统盘id。

状态码： 400

(60)

状态码： 500

请求示例

GET https://{endpoint}/v1/{project_id}/instances/{instance_id}/nodes/{node_id}

响应示例

状态码： 200 OK

{ "status" : "normal,",

"name" : "BUG-ddm2-lixingqiao-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"

}

状态码

状态码描述

200 OK

400 bad request

(61)

错误码

4.15 查询 DDM 指定实例的参数详情

功能介绍

查询DDM指定实例的参数详情。

接口约束

无

调试

URI

GET /v3/{project_id}/instances/{instance_id}/configurations

表4-86 路径参数

0] 。最小值：0

删除DDM帐号_分布式数据库中间件 DDM_API参考_帐号管理_华为云

API 参考

目 录

1 使用前必读... 1

2 API 概览... 4

3 如何调用 API...6

4 实例管理...13

5 逻辑库管理...75

6 帐号管理...94

7 监控管理... 112

8 应用示例... 119

9 授权策略及授权项...122

10 附录... 127

11 修订记录... 139

1 使用前必读

1.1 概述 View

1.2 调用说明

1.3 终端节点

1.4 约束与限制

1.5 基本概念

2 API 概览

3 如何调用 API

3.1 构造请求

bbs.huaweicloud.com/videos/102987 。

请求 URI

请求方法

请求消息头

请求消息体（可选）

username

domainname

********

xxxxxxxxxxxxxxxxxx

发起请求

Client。

3.2 认证鉴权

Token 认证

bbs.huaweicloud.com/videos/101333 。

AK/SK 认证

3.3 返回结果

状态码

响应消息头

响应消息体（可选）

4 实例管理

4.1 购买 DDM 实例

功能介绍

接口约束

调试

URI

请求参数

CreateInstan ceDetail

CreateInstan ceExtendPara m object

响应参数

请求示例

响应示例

状态码

错误码

4.2 查询 DDM 实例列表

功能介绍

接口约束

调试

URI

请求参数

响应参数

ShowInstanc eBeanRespon se objects

请求示例

响应示例

状态码

错误码

4.3 查询 DDM 实例详情

功能介绍

接口约束

调试

URI

请求参数

响应参数

GetDetailfNo desInfo

请求示例

响应示例

状态码

错误码

目录

1 ^{使用前必读}

2 ^{API 概览}

3 ^{如何调用 API}

4 ^实例管理