CreateGadInstanceMember - 创建Gad实例成员_关系型数据库-阿里云帮助中心

调用CreateGadInstanceMember接口在RDS全球多活数据库集群中添加节点。

接口说明

前提条件

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

本功能的更多信息，请参见添加或移除单元节点。

调试

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

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
rds:CreateGadInstanceMember	Write	RDS acs:rds::{#accountId}:*	无	无

请求参数

名称	类型	必填	描述	示例值
CentralRegionId	string	是	中心节点（主节点）所在地域ID，可调用DescribeRegions查询。	cn-hangzhou
CentralDBInstanceId	string	是	中心节点ID，可调用DescribeGadInstances查询。	gad-rm-bp1npi2j8****
GadInstanceId	string	是	RDS全球多活数据库集群ID，可调用DescribeGadInstances查询。	gad-rm-bp1npi2j8****
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****
VSwitchID	string	是	新建单元节点的虚拟交换机（vSwitch） ID。 N为1~10的整数，代表第N个单元节点。一个RDS全球多活数据库集群中最多可以创建10个单元节点。	vsw-bp1tg609m5j85****
SecurityIPList	string	否	新建单元节点的IP白名单。多条记录请以英文逗号（,）隔开，不可重复，最多1000条记录。支持如下两种格式： IP地址形式，例如：`10.10.XX.XX`。 CIDR形式，例如：`10.10.XX.XX/24`（无类域间路由，24表示了地址中前缀的长度，范围为1~32）。 N为1~10的整数，代表第N个单元节点。一个RDS全球多活数据库集群中最多可以创建10个单元节点。	10.10.XX.XX
DBInstanceStorage	long	否	新建单元节点的存储空间大小。单位：GB。每5 GB进行递增，取值范围请参见实例规格表。您也可以调用DescribeAvailableResource接口查询目标实例规格中可用的存储空间范围。 N为1~10的整数，代表第N个单元节点。一个RDS全球多活数据库集群中最多可以创建10个单元节点。	20
ZoneIDSlave1	string	否	新建单元节点的备节点可用区ID。可调用DescribeRegions查询。如果和当前单元节点的ZoneId相同，则为单可用区部署。如果和当前单元节点的ZoneId不同，则为多可用区部署。 N为1~10的整数，代表第N个单元节点。一个RDS全球多活数据库集群中最多可以创建10个单元节点。	cn-hangzhou-h
ZoneIDSlave2	string	否	新建单元节点的日志节点可用区ID。可调用DescribeRegions查询。如果和当前单元节点的ZoneId相同，则为单可用区部署。如果和当前单元节点的ZoneId不同，则为多可用区部署。 N为1~10的整数，代表第N个单元节点。一个RDS全球多活数据库集群中最多可以创建10个单元节点。	cn-hangzhou-h
DtsInstanceClass	string	是	新建单元节点的数据同步链路规格。取值： small medium large micro 说明关于各规格的区别，请参见数据同步规格链路说明。 N为1~10的整数，代表第N个单元节点。一个RDS全球多活数据库集群中最多可以创建10个单元节点。	medium
DbInstanceClass	string	否	新建单元节点的实例规格。取值详情请参见主实例规格表。您也可以调用DescribeAvailableResource接口查询目标地域中可用的实例规格列表。 N为1~10的整数，代表第N个单元节点。一个RDS全球多活数据库集群中最多可以创建10个单元节点。	rds.mysql.t1.small
DBInstanceDescription	string	否	新建单元节点的名称。命名规则如下：长度为2~255个字符。以中文、英文字母开头，可以包含数字、中文、英文、下划线（_）、短横线（-）。不能以`http://`或`https://`开头。 N为1~10的整数，代表第N个单元节点。一个RDS全球多活数据库集群中最多可以创建10个单元节点。	test
Engine	string	否	新建单元节点的数据库引擎。当前仅支持MySQL。 N为1~10的整数，代表第N个单元节点。一个RDS全球多活数据库集群中最多可以创建10个单元节点。	MySQL
EngineVersion	string	否	新建单元节点的数据库版本。取值： 8.0 5.7 5.6 5.5 N为1~10的整数，代表第N个单元节点。一个RDS全球多活数据库集群中最多可以创建10个单元节点。	8.0
DtsConflict	string	是	新建单元节点在同步时发生主键冲突采取的修复策略。取值： overwrite：覆盖目标节点中发生冲突的主键。 interrupt：中止同步任务，报错并退出。 ignore：覆盖当前节点中发生冲突的主键。 N为1~10的整数，代表第N个单元节点。一个RDS全球多活数据库集群中最多可以创建10个单元节点。	overwrite
DBInstanceStorageType	string	否	实例存储类型，取值： local_ssd：本地SSD盘 cloud_ssd：SSD云盘 cloud_essd：ESSD PL1云盘 cloud_essd2：ESSD PL2云盘 cloud_essd3：ESSD PL3云盘	cloud_essd
CentralRdsDtsAdminAccount	string	是	中心节点的高权限账号，可调用DescribeAccounts查询。	test
CentralRdsDtsAdminPassword	string	是	中心节点的高权限账号对应的密码。	Test12345
DBList	string	是	中心节点中数据库信息的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 } } } }` 说明更多信息，请参见迁移、同步或订阅对象说明。	{ "testdb": { "name": "testdb", "all": false, "Table": { "order": { "name": "order", "all": true }, "ordernew": { "name": "ordernew", "all": true } } } }

返回参数

名称	类型	描述	示例值
	object	Schema of Response
RequestId	string	请求ID。	16C62438-491B-5C02-9B49-BA924A1372A2
Result	object	返回信息组成的数组。
GadInstanceName	string	全球多活数据库集群ID。	gad-rm-bp1npi2j8********
CreateCount	string	本次调用创建的节点数量。	2

示例

正常返回示例

JSON格式

{
  "RequestId": "16C62438-491B-5C02-9B49-BA924A1372A2",
  "Result": {
    "GadInstanceName": "gad-rm-bp1npi2j8********",
    "CreateCount": "2"
  }
}

错误码

HTTP status code	错误码	错误信息
400	IdempotentParameterMismatch	The request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical.
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

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

变更历史

变更时间	变更内容概要	操作

暂无变更历史