调用CreateGADInstance接口创建RDS全球多活数据库集群。

前提条件

  • 调用此接口的阿里云账号为主账号。
  • 当前阿里云账户中的余额必须大于等于100元。
  • 已创建RDS MySQL主实例，且该实例未用于创建RDS全球多活数据库集群。可调用CreateDBInstance创建实例。
    说明 当前仅支持华东1（杭州）、华东2（上海） 、华北1（青岛）、华北2（北京）、华北3（张家口）、华南1（深圳）、西南1（成都）地域下的RDS MySQL主实例。

本功能的更多信息，请参见创建与释放全球多活数据库集群。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String 是 CreateGADInstance

系统规定参数。取值：CreateGADInstance。
CentralRegionId String 是 cn-hangzhou

中心节点所在地域ID，可调用DescribeRegions查询。
CentralDBInstanceId String 是 rm-uf6wjk5*******

主实例ID，可调用DescribeDBInstances获取。该实例将作为RDS全球多活数据库集群的中心节点（主节点）。

说明
  • 一个主实例ID仅能作为一个RDS全球多活数据库集群的中心节点。
  • 当前仅华东1（杭州）、华东2（上海） 、华北1（青岛）、华北2（北京）、华北3（张家口）、华南1（深圳）、西南1（成都）地域中的RDS MySQL主实例可作为RDS全球多活数据库集群的中心节点。
DBList String 是 { "testdb": { "name": "testdb", "all": false, "Table": { "order": { "name": "order", "all": true }, "ordernew": { "name": "ordernew", "all": true } } } }

中心节点中数据库信息的JSON数组，该数组中所有数据库信息将同步至当前单元节点（备节点）。参数说明：

  • name：数据库名称。
  • all：是否同步当前库或表中的所有数据。取值：true|false
  • Table：表名称。若all参数为false，则还需要在JSON数组中套入需要同步的表名称。

示例：{ "testdb": { "name": "testdb", "all": false, "Table": { "order": { "name": "order", "all": true }, "ordernew": { "name": "ordernew", "all": true } } } }
Description String 否 test

RDS全球多活数据库集群的名称。
UnitNode.N.RegionID String 是 cn-hangzhou

新建单元节点所在的地域ID，可调用DescribeRegions查询。

N为1~10的整数，代表第N个单元节点。一个RDS全球多活数据库集群中最多可以创建10个单元节点。
UnitNode.N.ZoneID String 否 cn-hangzhou-h

新建单元节点所在的可用区ID，可调用DescribeRegions查询。

N为1~10的整数，代表第N个单元节点。一个RDS全球多活数据库集群中最多可以创建10个单元节点。
UnitNode.N.VpcID String 否 vpc-bp19ame5m1r3o********

新建单元节点的专有网络（VPC）ID。

N为1~10的整数，代表第N个单元节点。一个RDS全球多活数据库集群中最多可以创建10个单元节点。
UnitNode.N.DBInstanceStorage Long 否 20

新建单元节点的存储空间大小。单位：GB。每5GB进行递增，取值范围请参见实例规格表。您也可以调用DescribeAvailableResource接口查询目标实例规格中可用的存储空间范围。

N为1~10的整数，代表第N个单元节点。一个RDS全球多活数据库集群中最多可以创建10个单元节点。
UnitNode.N.SecurityIPList String 否 10.10.10.10

新建单元节点的IP白名单。多条记录请以英文逗号（,）隔开，不可重复，最多1000条记录。支持如下两种格式：

  • IP地址形式，例如：10.10.10.10。
  • CIDR形式，例如：10.10.10.10/24（无类域间路由，24表示了地址中前缀的长度，范围为1~32）。

N为1~10的整数，代表第N个单元节点。一个RDS全球多活数据库集群中最多可以创建10个单元节点。
UnitNode.N.VSwitchID String 否 vsw-bp1tg609m5j85********

新建单元节点的虚拟交换机（vSwitch） ID。

N为1~10的整数，代表第N个单元节点。一个RDS全球多活数据库集群中最多可以创建10个单元节点。
UnitNode.N.ZoneIDSlave1 String 否 cn-hangzhou-h

新建单元节点的备节点可用区ID。可调用DescribeRegions查询。

  • 如果和当前单元节点的ZoneId相同，则为单可用区部署。
  • 如果和当前单元节点的ZoneId不同，则为多可用区部署。

N为1~10的整数，代表第N个单元节点。一个RDS全球多活数据库集群中最多可以创建10个单元节点。
UnitNode.N.ZoneIDSlave2 String 否 cn-hangzhou-h

新建单元节点的日志节点可用区ID。可调用DescribeRegions查询。

  • 如果和当前单元节点的ZoneId相同，则为单可用区部署。
  • 如果和当前单元节点的ZoneId不同，则为多可用区部署。

N为1~10的整数，代表第N个单元节点。一个RDS全球多活数据库集群中最多可以创建10个单元节点。
UnitNode.N.DtsInstanceClass String 是 medium

新建单元节点的数据同步链路规格。取值：

  • small
  • medium
  • large
  • micro
说明 关于各规格的区别，请参见数据同步规格链路说明。

N为1~10的整数，代表第N个单元节点。一个RDS全球多活数据库集群中最多可以创建10个单元节点。
UnitNode.N.DbInstanceClass String 否 rds.mysql.t1.small

新建单元节点的实例规格。取值详情请参见主实例规格表。您也可以调用DescribeAvailableResource接口查询目标地域中可用的实例规格列表。

N为1~10的整数，代表第N个单元节点。一个RDS全球多活数据库集群中最多可以创建10个单元节点。
UnitNode.N.PayType String 否 Postpaid

新建单元节点的付费类型。取值：

  • Postpaid：后付费（按量付费）。
  • Prepaid：预付费（包年包月）。
说明 系统会自动生成订单并自动完成支付，无需手动确认支付。

N为1~10的整数，代表第N个单元节点。一个RDS全球多活数据库集群中最多可以创建10个单元节点。
UnitNode.N.DBInstanceDescription String 否 test

新建单元节点的名称。命名规则如下：

  • 长度为2~255个字符。
  • 以中文、英文字母开头，可以包含数字、中文、英文、下划线（_）、短横线（-）。
  • 不能以http://或https://开头。

N为1~10的整数，代表第N个单元节点。一个RDS全球多活数据库集群中最多可以创建10个单元节点。
UnitNode.N.Engine String 否 MySQL

新建单元节点的数据库引擎。当前仅支持MySQL。

N为1~10的整数，代表第N个单元节点。一个RDS全球多活数据库集群中最多可以创建10个单元节点。
UnitNode.N.EngineVersion String 否 8.0

新建单元节点的数据库版本。取值：

  • 8.0
  • 5.7
  • 5.6
  • 5.5

N为1~10的整数，代表第N个单元节点。一个RDS全球多活数据库集群中最多可以创建10个单元节点。
UnitNode.N.DtsConflict String 是 overwrite

新建单元节点在同步时发生主键冲突采取的修复策略。取值：

  • overwrite：覆盖目标节点中发生冲突的主键。
  • interrupt：中止同步任务，报错并退出。
  • ignore：隐藏当前节点中发生冲突的主键。

N为1~10的整数，代表第N个单元节点。一个RDS全球多活数据库集群中最多可以创建10个单元节点。
UnitNode.N.DBInstanceStorageType String 否 cloud_essd2

实例存储类型，取值：

  • local_ssd：本地SSD盘（推荐）。
  • cloud_ssd：SSD云盘（不推荐，部分地域已经停止售卖）。
  • cloud_essd：ESSD PL1云盘。
  • cloud_essd2：ESSD PL2云盘。
  • cloud_essd3：ESSD PL3云盘。

本参数的默认值根据DBInstanceClass参数中传的规格代码自动判断：

  • 规格代码为本地盘规格：默认值为local_ssd。
  • 规格代码为云盘规格：默认值为cloud_essd。
CentralRdsDtsAdminAccount String 是 test

中心节点的高权限账号，可调用DescribeAccounts查询。
CentralRdsDtsAdminPassword String 是 Test12345

中心节点的高权限账号对应的密码。
Tag.N.Key String 否 testkey1

标签键。可以同时创建N个标签键，N的取值范围：1~20。不允许传入空字符串。
Tag.N.Value String 否 testvalue1

标签键对应的标签值。可以同时创建N个标签值，N的取值范围：1~20。允许传入空字符串。
ResourceGroupId String 否 rg-acfmy*****

资源组ID。

返回数据

名称 类型 示例值 描述
RequestId String 9F8C06AD-3F37-57A0-ABBF-ABD7824F55CE

请求ID。
Result Object

返回信息组成的数组。
GadInstanceName String gad-rm-bp1npi2j8********

全球多活数据库集群ID。
CreateMemberCount String 2

本次调用创建的节点数量。
TaskID String 5374xxxx

任务ID。

示例

请求示例

http(s)://rds.aliyuncs.com/?Action=CreateGADInstance
&CentralDBInstanceId=rm-uf6wjk5xxxxxxx
&CentralRdsDtsAdminAccount=test
&CentralRdsDtsAdminPassword=Test12345
&CentralRegionId=cn-hangzhou
&DBList={\"dtstestdata\":{\"name\":\"dtstestdata\",\"all\":true}}
&UnitNode.1.RegionID=cn-hangzhou
&UnitNode.1.DtsConflict=overwrite
&UnitNode.1.DtsInstanceClass=medium
&<公共请求参数>

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<CreateGADInstanceResponse>
<RequestId>9F8C06AD-3F37-57A0-ABBF-ABD7824F55CE</RequestId>
<Result>
    <GadInstanceName>gad-rm-bp1npi2j8********</GadInstanceName>
    <CreateMemberCount>1</CreateMemberCount>
</Result>
</CreateGADInstanceResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "9F8C06AD-3F37-57A0-ABBF-ABD7824F55CE",
  "Result" : {
    "GadInstanceName" : "gad-rm-bp1npi2j8********",
    "CreateMemberCount" : "1"
  }
}

错误码

访问错误中心查看更多错误码。