AI 助理
文档备案控制台
官方文档
首页 云数据库 RDS 开发参考 RDS API参考 API目录 MySQL全球多活数据库集群（旧版） CreateGADInstance - 创建GAD实例

CreateGADInstance - 创建GAD实例

更新时间：
复制 MD 格式
产品详情
我的收藏

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

接口说明

适用引擎

  • RDS MySQL

相关功能文档

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

创建与释放全球多活数据库集群

调试

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

调试

授权信息

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

  • 操作：是指具体的权限点。

  • 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。

  • 资源类型：是指操作中支持授权的资源类型。具体说明如下：

    • 对于必选的资源类型，用前面加 * 表示。

    • 对于不支持资源级授权的操作，用全部资源表示。

  • 条件关键字：是指云产品自身定义的条件关键字。

  • 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

rds:CreateGADInstance

create

*GadInstance

acs:rds::{#accountId}:gadinstance/*

 无 无

请求参数

名称

类型

必填

描述

示例值
CentralRegionId

string

是

中心节点所在地域 ID，可调用 DescribeRegions 查询。

cn-hangzhou
CentralDBInstanceId

string

是

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

说明

  • 一个主实例 ID 仅能作为一个 RDS 全球多活数据库集群的中心节点。

  • 当前仅华东 1（杭州）、华东 2（上海） 、华北 1（青岛）、华北 2（北京）、华北 3（张家口）、华南 1（深圳）、西南 1（成都）地域中的 RDS MySQL 主实例可作为 RDS 全球多活数据库集群的中心节点。

rm-uf6wjk5****
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 } } } }
Description

string

否

RDS 全球多活数据库集群的名称。

test
UnitNode

array<object>

是

单元节点信息。

object

否

单元节点相关信息。

DBInstanceDescription

string

否

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

  • 长度为2~255个字符。

  • 以中文、英文字母开头，可以包含数字、中文、英文、下划线（_）、短横线（-）。

  • 不能以http://或https://开头。

test
DBInstanceStorage

integer

否

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

20
DBInstanceStorageType

string

否

实例存储类型，取值：

  • local_ssd：高性能本地盘（推荐）。

  • cloud_ssd：SSD 云盘（不推荐，部分地域已经停止售卖）。

  • cloud_essd：ESSD PL1 云盘。

  • cloud_essd2：ESSD PL2 云盘。

  • cloud_essd3：ESSD PL3 云盘。

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

  • 规格代码为高性能本地盘规格：默认值为local_ssd。

  • 规格代码为云盘规格：默认值为cloud_essd。

cloud_essd2
DbInstanceClass

string

否

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

rds.mysql.t1.small
DtsConflict

string

是

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

  • overwrite：覆盖目标节点中发生冲突的主键。

  • interrupt：中止同步任务，报错并退出。

  • ignore：隐藏当前节点中发生冲突的主键。

overwrite
DtsInstanceClass

string

是

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

  • small

  • medium

  • large

  • micro

说明

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

medium
Engine

string

否

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

MySQL
EngineVersion

string

否

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

  • 8.0

  • 5.7

  • 5.6

  • 5.5

8.0
PayType

string

否

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

  • Postpaid：后付费（按量付费）。

  • Prepaid：预付费（包年包月）。

说明

系统会自动生成订单并自动完成支付，无需手动确认支付。

Postpaid
RegionID

string

是

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

cn-hangzhou
SecurityIPList

string

否

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

  • IP 地址形式，例如：10.10.10.10。

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

10.10.10.10
VSwitchID

string

否

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

vsw-bp1tg609m5j85****
VpcID

string

否

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

vpc-bp19ame5m1r3o****
ZoneID

string

否

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

cn-hangzhou-j
ZoneIDSlave1

string

否

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

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

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

cn-hangzhou-j
ZoneIDSlave2

string

否

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

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

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

cn-hangzhou-j
CentralRdsDtsAdminAccount

string

是

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

test
CentralRdsDtsAdminPassword

string

是

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

Test12345
Tag

array<object>

否

标签列表。

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

返回信息组成的数组。

CreateMemberCount

string

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

2
GadInstanceName

string

全球多活数据库集群 ID。

gad-rm-bp1npi2j8****
TaskID

string

任务 ID。

5374****

示例

正常返回示例

JSON格式

{
  "RequestId": "9F8C06AD-3F37-57A0-ABBF-ABD7824F55CE",
  "Result": {
    "CreateMemberCount": "2",
    "GadInstanceName": "gad-rm-bp1npi2j8****",
    "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
400 Order.ComboInstanceNotAllowOperate A package instance is not allowed to operate independently. 套餐实例不允许单独操作。
400 Price.PricingPlanResultNotFound Pricing plan price result not found. 定价计划价格结果没有找到。
400 Order.NoRealNameAuthentication You 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. 您还未通过实名认证，不符合购买条件，请登录费用与成本进行实名认证。
400 InsufficientAvailableQuota Your account quota limit is less than 0, please recharge before trying to purchase. 您的账户可用额度小于0，请先充值后再尝试购买。
400 CommodityServiceCalling.Exception Failed to call commodity service. 调用商品服务返回失败。
400 RegionDissolvedEOM Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support. 客户您好，阿里云计划对当前地域进行优化调整，该区域云服务将停止运营，为确保您的业务连续性及数据迁移工作的平稳过渡，您目前无法操作新购类型的订单，感谢理解与支持。
400 Commodity.InvalidComponent The module you purchased is not legal, please buy it again. 您购买的模块不合法，请重新购买。
400 RegionEndTimeDissolvedAustralia Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024. 客户您好，该地域已裁撤。
400 Price.CommoditySys Commodity system call exception. 商品系统调用异常。
400 Pay.InsufficientBalance Insufficient available balance. 可用金不足。
400 Order.PeriodInvalid There is a problem with the period you selected, please choose again. 您选购的周期有问题，请重新选购。
400 pay.noCreditCard Account not bound to credit card. 账户未绑定信用卡。
400 Order.InstHasUnpaidOrder There is an unpaid order for the service you have purchased. Please pay or void it before placing the order. 您选购的服务存在未支付订单，请支付或作废后再下单。
400 noAvailablePaymentMethod No payment method is specified for your account. We recommend that you add a payment method. 没有为您的账户指定付款方式。我们建议您添加一种付款方式。
400 BasicInfoUncompleted Your information is incomplete. Complete your information before the operation. 您的基本信息未完善，请在操作前先完善您的基本信息。
400 Risk.RiskControlRejection Your account is abnormal, please contact customer service for details. 您的账户出现异常，详情请联系客服。
400 Api.NotSupport Specified api is not supported. 当前接口不支持。
400 ContainForbiddenLabelError There is a label that prohibits placing orders. Please contact your distributor for assistance. 存在禁止下单的标签，请联系您的分销商处理
400 InvalidDBInstanceId.NotFound The DBInstanceId provided does not exist in records. 提供的DBInstanceId不存在。
400 InvalidInstanceLevel.DiskType Specified instance level not support request disk type 当前实例规格不支持该存储类型。
400 InvalidParam Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica. 指定的 wal_level 参数无效。实例中仍然存在复制槽，因此无法将其设置为replica。
400 KmsApiError User secret key invalid. 用户密钥失效。
400 System.SaleValidateFailed Sales expression validation system error. 销售表达式校验系统错误。
400 Abs.InvalidAccount.NotFound account is not found. 账户不存在。
400 SqlExecuteFailedOrTimeout sql command execution failed or timed out:%s. sql命令执行失败或执行超时
400 ColdData.EngineVersionNotSupport The current instance engine version not support coldDataEnabled. 当前实例引擎版本不支持归档冷数据。
400 ColdData.MinorVersionNotSupport The current instance minor version not support coldDataEnabled. 当前内核版本不支持归档冷数据。
400 IncorrectTargetClasscode The current instance type does not support this operation. 当前规格不支持此操作。
400 InvalidConnectionString.Duplicate Specified connection string already exists in the RDS. 链接地址名重复，请重新设置连接字符串。
400 RequiredParam.NotFound Required input param is not found. 没有传入必要的参数。
400 Parameters.Invalid Parameter error, please check the parameters. 参数错误，请检查参数。
400 BackupPolicyNotSupport Cold Data won't open with CrossBackup or Flash Backup, please check Backup Policy. 数据归档不支持跨地域备份和秒级快照，请检查备份策略。
400 InvalideStatus.Format The instance status does not support this operation. 实例状态不支持此操作。
400 InvalidReleasedKeepPolicy.Format Specified Released Keep Policy is not valid. 实例释放后的归档备份保留策略无效。
400 InvalidDBInstanceEngineType.Format the DB instance engine type does not support this operation. DB实例引擎类型不支持此操作。
400 Pay.NoCreditCard No credit cards. 无信用卡。
400 VpcNetworkTypeNotSupport The vpc network type instance does not support this operation. vpc网络类型实例不支持此操作。
400 MirrorInsExists Specified DB instance mirror ins already existed. 当前数据库实例镜像已存在。
400 UnsupportedClassCode The specified DB instance class stops selling. 实例规格停止售卖。
400 InvalidBackupSet The specified database does not exist in the backup set. 备份集中没有指定的数据库。
400 OrdTCommodityQueryError Failed to query for product. 查询产品失败。
400 ProductInstanceReleased The instance has been released. Please check before placing the order. 实例已释放，请核实后下单。
400 RegionEndTimeDissolvedIndia The region is no longer supported. 指定的地域无效。
500 ExternalFailure The request processing has failed due to external service failure. 请求服务失败，请稍后重试。
500 RequestMetaDataFailed The service request failed. Please try again later or contact service personnel. 请求服务失败，请稍后再试或联系服务人员。
500 InvokeProxyFailure The request processing has failed due to service failure of rds api. 由于rds api服务失败，请求处理失败。
403 OrderStatus.UnPaid The specified db instance has unpaid order. 实例当前存在未支付订单，请支付后重试。
403 InvalidReduceDiskSize The storage capacity after the scale-down must be larger than the used amount. 缩容目标容量不能小于当前存储空间使用量
403 CloudSSDNotSupport Cloud ssd does not support this operation, please upgrade to essd. SSD盘不支持此操作，请升级至ESSD。
403 InvalidUserOperatorPermission The user permission does not support this operation. 用户权限不支持此操作。
403 InvalidVswitchId Specified conn vswitch id is not valid. 指定的VSwitchId格式不正确或为空
403 IncorrectMinorVersion Current engine minor version does not support operations. 当前引擎小版本不支持此操作。
403 OperationDenied.ZoneResource There is no available zone for inventory. 没有可用的库存区域。
403 NotInFlowController Sorry,no permission. 非集团上云用户不可用，无权限。
403 InvalidKmsKey Kms key is disabled. Kms key已禁用。
403 InvalidInstanceLevel.Malformed Current DB instance level does not support this operation. 当前数据库实例级别不支持此操作。
404 InvalidClusterKms The current instance does not authorized to access the Key Management Service. 当前实例未授权访问密钥管理服务。
404 Request.NotFound The requested resource is not available. 请求的资源不可用。
404 HostInfo.NotFound The specified host info is not found. 指定的主机信息不存在。

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

变更历史

更多信息，参考变更详情。

上一篇：MySQL全球多活数据库集群（旧版）下一篇：CreateGadInstanceMember - 创建Gad实例成员