文档

CreateGadInstanceMember - 创建Gad实例成员

更新时间:

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

接口说明

适用引擎

  • RDS MySQL

相关功能文档

注意 使用该接口前,请仔细阅读功能文档,确保完全了解使用接口的前提条件及使用后造成的影响后,再进行操作。

添加或移除单元节点

调试

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

授权信息

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

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

请求参数

名称类型必填描述示例值
CentralRegionIdstring

中心节点(主节点)所在地域 ID,可调用 DescribeRegions 查询。

cn-hangzhou
CentralDBInstanceIdstring

中心节点 ID,可调用 DescribeGadInstances 查询。

rm-bp190h8y69tad****
GadInstanceIdstring

RDS 全球多活数据库集群 ID,可调用 DescribeGadInstances 查询。

gad-rm-bp1npi2j8****
UnitNodeobject []

单元节点(备节点)信息列表。

RegionIDstring

新建单元节点(备节点)所在的地域 ID,可调用 DescribeRegions 查询。

N1~10的整数,代表第 N 个单元节点。一个 RDS 全球多活数据库集群中最多可以创建 10 个单元节点。

cn-hangzhou
ZoneIDstring

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

N1~10的整数,代表第 N 个单元节点。一个 RDS 全球多活数据库集群中最多可以创建 10 个单元节点。

cn-hangzhou-h
VpcIDstring

新建单元节点的专有网络(VPC)ID。

N1~10的整数,代表第 N 个单元节点。一个 RDS 全球多活数据库集群中最多可以创建 10 个单元节点。

vpc-bp19ame5m1r3o****
VSwitchIDstring

新建单元节点的虚拟交换机(vSwitch) ID。

N1~10的整数,代表第 N 个单元节点。一个 RDS 全球多活数据库集群中最多可以创建 10 个单元节点。

vsw-bp1tg609m5j85****
SecurityIPListstring

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

  • IP 地址形式,例如:10.10.XX.XX
  • CIDR 形式,例如:10.10.XX.XX/24(无类域间路由,24 表示了地址中前缀的长度,范围为1~32)。

N1~10的整数,代表第 N 个单元节点。一个 RDS 全球多活数据库集群中最多可以创建 10 个单元节点。

10.10.XX.XX
DBInstanceStoragelong

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

N1~10的整数,代表第 N 个单元节点。一个 RDS 全球多活数据库集群中最多可以创建 10 个单元节点。

20
ZoneIDSlave1string

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

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

N1~10的整数,代表第 N 个单元节点。一个 RDS 全球多活数据库集群中最多可以创建 10 个单元节点。

cn-hangzhou-h
ZoneIDSlave2string

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

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

N1~10的整数,代表第 N 个单元节点。一个 RDS 全球多活数据库集群中最多可以创建 10 个单元节点。

cn-hangzhou-h
DtsInstanceClassstring

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

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

N1~10的整数,代表第 N 个单元节点。一个 RDS 全球多活数据库集群中最多可以创建 10 个单元节点。

medium
DbInstanceClassstring

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

N1~10的整数,代表第 N 个单元节点。一个 RDS 全球多活数据库集群中最多可以创建 10 个单元节点。

rds.mysql.t1.small
DBInstanceDescriptionstring

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

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

N1~10的整数,代表第 N 个单元节点。一个 RDS 全球多活数据库集群中最多可以创建 10 个单元节点。

test
Enginestring

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

N1~10的整数,代表第 N 个单元节点。一个 RDS 全球多活数据库集群中最多可以创建 10 个单元节点。

MySQL
EngineVersionstring

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

  • 8.0
  • 5.7
  • 5.6
  • 5.5

N1~10的整数,代表第 N 个单元节点。一个 RDS 全球多活数据库集群中最多可以创建 10 个单元节点。

8.0
DtsConflictstring

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

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

N1~10的整数,代表第 N 个单元节点。一个 RDS 全球多活数据库集群中最多可以创建 10 个单元节点。

overwrite
DBInstanceStorageTypestring

实例存储类型,取值:

  • local_ssd:本地 SSD 盘
  • cloud_ssd:SSD 云盘
  • cloud_essd:ESSD PL1 云盘
  • cloud_essd2:ESSD PL2 云盘
  • cloud_essd3:ESSD PL3 云盘
cloud_essd
CentralRdsDtsAdminAccountstring

中心节点的高权限账号,可调用 DescribeAccounts 查询。

test
CentralRdsDtsAdminPasswordstring

中心节点的高权限账号对应的密码。

Test12345
DBListstring

中心节点中数据库信息的 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

返回参数详情。

RequestIdstring

请求 ID。

16C62438-491B-5C02-9B49-BA924A1372A2
Resultobject

返回信息组成的数组。

GadInstanceNamestring

全球多活数据库集群 ID。

gad-rm-bp1npi2j8****
CreateCountstring

本次调用创建的节点数量。

2

示例

正常返回示例

JSON格式

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

错误码

HTTP status code错误码错误信息描述
400IdempotentParameterMismatchThe 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.-
400CreateGlobalActiveDatabase.GadInstanceNotActivegad instance not in active-
400CreateGlobalActiveDatabaseFailed.CentralNodeNotSupportGADCentralNode DB not support GAD-
400CreateGlobalActiveDatabaseFailed.UnitMemberParamsEmptyUnitMemberParams not valid-
400CreateGlobalActiveDatabaseFailed.UnitMemberParamsErrorUnitMemberParams not valid-
400CreateGlobalActiveDatabaseFailed.GadNameNotMatchCentralNodethe gadInstanceName not match with the central node-
400CreateGlobalActiveDatabaseFailed.GadInstanceExistsgad instance has exists,please add member!-
400CreateGlobalActiveDatabaseFailed.GadInstanceNotExistsgad instance not exists,please create GAD!-
400CreateGlobalActiveDatabase.GadInstanceNotFoundgad instance not Found-
400CreateGlobalActiveDatabase.GetInstanceMemberFaiedget instance member list failed-
400CreateGlobalActiveDatabaseImpl.preCheckGadInstanceexceed max member count 10-
400CreateGlobalActiveDatabaseImpl.preCheckMemberParamscentralNode not exists-
400Order.ComboInstanceNotAllowOperateA package instance is not allowed to operate independently.套餐实例不允许单独操作。
400Price.PricingPlanResultNotFoundPricing plan price result not found.定价计划价格结果没有找到。
400Order.NoRealNameAuthenticationYou have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.您还未通过实名认证,不符合购买条件,请登录用户中心进行实名认证。
400InsufficientAvailableQuotaYour account quota limit is less than 0, please recharge before trying to purchase.您的账户可用额度小于0,请先充值后再尝试购买。
400CommodityServiceCalling.ExceptionFailed to call commodity service.调用商品服务返回失败。

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

变更历史

变更时间变更内容概要操作
暂无变更历史
  • 本页导读 (1)
文档反馈