该接口用于创建RDS全球多活数据库集群。
接口说明
适用引擎
- RDS MySQL
相关功能文档
注意 使用该接口前，请仔细阅读功能文档，确保完全了解使用接口的前提条件及使用后造成的影响后，再进行操作。
创建与释放全球多活数据库集群
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI
Explorer可以自动生成SDK代码示例。
调试
调试
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| rds:CreateGADInstance | Write |
|
|
无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| CentralRegionId | string | 是 | cn-hangzhou | |
| CentralDBInstanceId | string | 是 |
主实例ID，可调用DescribeDBInstances获取。该实例将作为RDS全球多活数据库集群的中心节点（主节点）。 说明 |
rm-uf6wjk5**** |
| DBList | string | 是 |
中心节点中数据库信息的JSON数组，该数组中所有数据库信息将同步至当前单元节点（备节点）。参数说明：
示例： |
{ “testdb”: { “name”: “testdb”, “all”: false, “Table”: { “order”: { “name”: “order”, “all”: true }, “ordernew”: { “name”: “ordernew”, “all”: true } } } } |
| Description | string | 否 |
RDS全球多活数据库集群的名称。 |
test |
| UnitNode | object [] | 是 |
单元节点信息。 |
|
| RegionID | string | 是 |
新建单元节点所在的地域ID，可调用DescribeRegions查询。 N为1~10的整数，代表第N个单元节点。一个RDS全球多活数据库集群中最多可以创建10个单元节点。 |
cn-hangzhou |
| ZoneID | string | 否 |
新建单元节点所在的可用区ID，可调用DescribeRegions查询。 N为1~10的整数，代表第N个单元节点。一个RDS全球多活数据库集群中最多可以创建10个单元节点。 |
cn-hangzhou-h |
| VpcID | string | 否 |
新建单元节点的专有网络（VPC）ID。 N为1~10的整数，代表第N个单元节点。一个RDS全球多活数据库集群中最多可以创建10个单元节点。 |
vpc-bp19ame5m1r3o**** |
| DBInstanceStorage | long | 否 |
新建单元节点的存储空间大小。单位：GB。每5GB进行递增，取值范围请参见实例规格表。您也可以调用DescribeAvailableResource接口查询目标实例规格中可用的存储空间范围。 N为1~10的整数，代表第N个单元节点。一个RDS全球多活数据库集群中最多可以创建10个单元节点。 |
20 |
| SecurityIPList | string | 否 |
新建单元节点的IP白名单。多条记录请以英文逗号（,）隔开，不可重复，最多1000条记录。支持如下两种格式：
N为1~10的整数，代表第N个单元节点。一个RDS全球多活数据库集群中最多可以创建10个单元节点。 |
10.10.10.10 |
| VSwitchID | string | 否 |
新建单元节点的虚拟交换机（vSwitch） ID。 N为1~10的整数，代表第N个单元节点。一个RDS全球多活数据库集群中最多可以创建10个单元节点。 |
vsw-bp1tg609m5j85**** |
| ZoneIDSlave1 | string | 否 |
新建单元节点的备节点可用区ID。可调用DescribeRegions查询。
N为1~10的整数，代表第N个单元节点。一个RDS全球多活数据库集群中最多可以创建10个单元节点。 |
cn-hangzhou-h |
| ZoneIDSlave2 | string | 否 |
新建单元节点的日志节点可用区ID。可调用DescribeRegions查询。
N为1~10的整数，代表第N个单元节点。一个RDS全球多活数据库集群中最多可以创建10个单元节点。 |
cn-hangzhou-h |
| DtsInstanceClass | string | 是 |
新建单元节点的数据同步链路规格。取值：
说明 N为1~10的整数，代表第N个单元节点。一个RDS全球多活数据库集群中最多可以创建10个单元节点。 |
medium |
| DbInstanceClass | string | 否 |
新建单元节点的实例规格。取值详情请参见主实例规格表。您也可以调用DescribeAvailableResource接口查询目标地域中可用的实例规格列表。 N为1~10的整数，代表第N个单元节点。一个RDS全球多活数据库集群中最多可以创建10个单元节点。 |
rds.mysql.t1.small |
| PayType | string | 否 |
新建单元节点的付费类型。取值：
说明 N为1~10的整数，代表第N个单元节点。一个RDS全球多活数据库集群中最多可以创建10个单元节点。 |
Postpaid |
| DBInstanceDescription | string | 否 |
新建单元节点的名称。命名规则如下：
N为1~10的整数，代表第N个单元节点。一个RDS全球多活数据库集群中最多可以创建10个单元节点。 |
test |
| Engine | string | 否 |
新建单元节点的数据库引擎。当前仅支持MySQL。 N为1~10的整数，代表第N个单元节点。一个RDS全球多活数据库集群中最多可以创建10个单元节点。 |
MySQL |
| EngineVersion | string | 否 |
新建单元节点的数据库版本。取值：
N为1~10的整数，代表第N个单元节点。一个RDS全球多活数据库集群中最多可以创建10个单元节点。 |
8.0 |
| DtsConflict | string | 是 |
新建单元节点在同步时发生主键冲突采取的修复策略。取值：
N为1~10的整数，代表第N个单元节点。一个RDS全球多活数据库集群中最多可以创建10个单元节点。 |
overwrite |
| DBInstanceStorageType | string | 否 |
实例存储类型，取值：
本参数的默认值根据DBInstanceClass参数中传的规格代码自动判断：
|
cloud_essd2 |
| CentralRdsDtsAdminAccount | string | 是 |
中心节点的高权限账号，可调用DescribeAccounts查询。 |
test |
| CentralRdsDtsAdminPassword | string | 是 |
中心节点的高权限账号对应的密码。 |
Test12345 |
| Tag | object [] | 否 |
标签列表。 |
|
| Key | string | 否 |
标签键。可以同时创建N个标签键，N的取值范围：1~20。不允许传入空字符串。 |
testkey1 |
| Value | string | 否 |
标签键对应的标签值。可以同时创建N个标签值，N的取值范围：1~20。允许传入空字符串。 |
testvalue1 |
| ResourceGroupId | string | 否 |
资源组ID。 |
rg-acfmy**** |
返回参数
| 名称 | 类型 | 描述 | 示例值 |
|---|---|---|---|
| object |
返回参数详情。 |
||
| RequestId | string |
请求ID。 |
9F8C06AD-3F37-57A0-ABBF-ABD7824F55CE |
| Result | object |
返回信息组成的数组。 |
|
| GadInstanceName | string |
全球多活数据库集群ID。 |
gad-rm-bp1npi2j8**** |
| CreateMemberCount | string |
本次调用创建的节点数量。 |
2 |
| TaskID | string |
任务ID。 |
5374**** |
示例
正常返回示例
JSON格式
{
"RequestId": "9F8C06AD-3F37-57A0-ABBF-ABD7824F55CE",
"Result": {
"GadInstanceName": "gad-rm-bp1npi2j8****",
"CreateMemberCount": "2",
"TaskID": "5374****"
}
}错误码
| HTTP status code | 错误码 | 错误信息 |
|---|---|---|
| 400 | CreateGlobalActiveDatabase.GadInstanceNotActive | gad instance not in active |
| 400 | CreateGlobalActiveDatabaseFailed.CentralNodeNotSupportGAD | CentralNode DB not support GAD |
| 400 | CreateGlobalActiveDatabaseFailed.UnitMemberParamsEmpty | UnitMemberParams not valid |
| 400 | CreateGlobalActiveDatabaseFailed.UnitMemberParamsError | UnitMemberParams not valid |
| 400 | CreateGlobalActiveDatabaseFailed.GadNameNotMatchCentralNode | the gadInstanceName not match with the central node |
| 400 | CreateGlobalActiveDatabaseFailed.GadInstanceExists | gad instance has exists,please add member! |
| 400 | CreateGlobalActiveDatabaseFailed.GadInstanceNotExists | gad instance not exists,please create GAD! |
| 400 | CreateGlobalActiveDatabase.GadInstanceNotFound | gad instance not Found |
| 400 | CreateGlobalActiveDatabase.GetInstanceMemberFaied | get instance member list failed |
| 400 | CreateGlobalActiveDatabaseImpl.preCheckGadInstance | exceed max member count 10 |
| 400 | CreateGlobalActiveDatabaseImpl.preCheckMemberParams | centralNode not exists |
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|
| 2022-08-10 | OpenAPI 错误码发生变更，OpenAPI 入参发生变更 | 看变更集 | ||||||||
|
内容没看懂？ 不太想学习？想快速解决？ 有偿解决： 联系专家
阿里云企业补贴进行中： 马上申请
腾讯云限时活动1折起，即将结束： 马上收藏
同尘科技为腾讯云授权服务中心。
购买腾讯云产品享受折上折，更有现金返利:同意关联，立享优惠
转转请注明出处：https://www.yunxiaoer.com/156582.html