Class: TencentCloud::Cdb::V20170320::CreateDBInstanceHourRequest

Inherits:
TencentCloud::Common::AbstractModel
  • Object
show all
Defined in:
lib/v20170320/models.rb

Overview

CreateDBInstanceHour请求参数结构体

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(goodsnum = nil, memory = nil, volume = nil, engineversion = nil, uniqvpcid = nil, uniqsubnetid = nil, projectid = nil, zone = nil, masterinstanceid = nil, instancerole = nil, masterregion = nil, port = nil, password = nil, paramlist = nil, protectmode = nil, deploymode = nil, slavezone = nil, backupzone = nil, securitygroup = nil, rogroup = nil, autorenewflag = nil, instancename = nil, resourcetags = nil, deploygroupid = nil, clienttoken = nil, devicetype = nil, paramtemplateid = nil, alarmpolicylist = nil, instancenodes = nil, cpu = nil, autosyncflag = nil, cageid = nil, paramtemplatetype = nil, alarmpolicyidlist = nil, dryrun = nil, enginetype = nil, vips = nil, dataprotectvolume = nil, clustertopology = nil, disktype = nil, clustertype = nil, destroyprotect = nil) ⇒ CreateDBInstanceHourRequest

Returns a new instance of CreateDBInstanceHourRequest.



3171
3172
3173
3174
3175
3176
3177
3178
3179
3180
3181
3182
3183
3184
3185
3186
3187
3188
3189
3190
3191
3192
3193
3194
3195
3196
3197
3198
3199
3200
3201
3202
3203
3204
3205
3206
3207
3208
3209
3210
3211
3212
3213
3214
# File 'lib/v20170320/models.rb', line 3171

def initialize(goodsnum=nil, memory=nil, volume=nil, engineversion=nil, uniqvpcid=nil, uniqsubnetid=nil, projectid=nil, zone=nil, masterinstanceid=nil, instancerole=nil, masterregion=nil, port=nil, password=nil, paramlist=nil, protectmode=nil, deploymode=nil, slavezone=nil, backupzone=nil, securitygroup=nil, rogroup=nil, autorenewflag=nil, instancename=nil, resourcetags=nil, deploygroupid=nil, clienttoken=nil, devicetype=nil, paramtemplateid=nil, alarmpolicylist=nil, instancenodes=nil, cpu=nil, autosyncflag=nil, cageid=nil, paramtemplatetype=nil, alarmpolicyidlist=nil, dryrun=nil, enginetype=nil, vips=nil, dataprotectvolume=nil, clustertopology=nil, disktype=nil, clustertype=nil, destroyprotect=nil)
  @GoodsNum = goodsnum
  @Memory = memory
  @Volume = volume
  @EngineVersion = engineversion
  @UniqVpcId = uniqvpcid
  @UniqSubnetId = uniqsubnetid
  @ProjectId = projectid
  @Zone = zone
  @MasterInstanceId = masterinstanceid
  @InstanceRole = instancerole
  @MasterRegion = masterregion
  @Port = port
  @Password = password
  @ParamList = paramlist
  @ProtectMode = protectmode
  @DeployMode = deploymode
  @SlaveZone = slavezone
  @BackupZone = backupzone
  @SecurityGroup = securitygroup
  @RoGroup = rogroup
  @AutoRenewFlag = autorenewflag
  @InstanceName = instancename
  @ResourceTags = resourcetags
  @DeployGroupId = deploygroupid
  @ClientToken = clienttoken
  @DeviceType = devicetype
  @ParamTemplateId = paramtemplateid
  @AlarmPolicyList = alarmpolicylist
  @InstanceNodes = instancenodes
  @Cpu = cpu
  @AutoSyncFlag = autosyncflag
  @CageId = cageid
  @ParamTemplateType = paramtemplatetype
  @AlarmPolicyIdList = alarmpolicyidlist
  @DryRun = dryrun
  @EngineType = enginetype
  @Vips = vips
  @DataProtectVolume = dataprotectvolume
  @ClusterTopology = clustertopology
  @DiskType = disktype
  @ClusterType = clustertype
  @DestroyProtect = destroyprotect
end

Instance Attribute Details

#AlarmPolicyIdListObject

说明:创建非云盘版实例时,请根据需要指定实例版本(推荐5.7或8.0),若此参数不填,则默认值为8.0;若创建的是云盘版实例,则此参数仅能指定为5.7或8.0。说明:如果创建的是云盘版实例,此参数为必填且为私有网络类型。若此项不填,则系统会选择默认的 VPC。说明:若此项不填,则系统会选择默认 VPC 下的默认子网。说明:若您创建单节点、双节点、三节点实例,此参数为必填项,请指定可用区,若不指定可用区,则系统会自动选择一个可用区(可能不是您希望部署的可用区);若您创建云盘版实例,此参数不填,请通过参数 ClusterTopology 进行读写节点和只读节点的可用区配置。说明:请选择实例类型,不填会默认选择 master。说明:不填则默认为3306。说明:表名大小写敏感的开启和关闭可通过参数 lower_case_table_names 进行设置,参数值为0表示开启,参数值为1表示关闭,若不设置则此参数默认值为0。若您创建的是 MySQL 8.0 版本的实例,则需要在创建实例时通过设置 lower_case_table_names 参数来开启或关闭表名大小写敏感,创建实例后无法修改参数,即创建后无法修改表名大小写敏感。其他数据库版本的实例支持在创建实例后修改 lower_case_table_names 参数。创建实例时设置表名大小写敏感的 API 调用方法请参见本文中的示例2。说明:双节点、三节点实例请指定此参数值,若不指定,则默认为 Zone 的值;云盘版实例此参数可不填,请通过参数 ClusterTopology 进行读写节点和只读节点的可用区配置;单节点实例为单可用区,无需指定此参数。说明:如果创建的是云盘版实例,此参数为必填。备注:如您使用自定义参数模板 id,可传入自定义参数模板 id;如您计划使用默认参数模板,该参数模板 id 传入 id 无效,需设置 ParamTemplateType。备注:如您需使用云数据库 MySQL 默认参数模板,请设置 ParamTemplateType。说明:若购买的是云盘版实例,此参数为必填,需设置云盘版实例的 RW 和 RO 节点拓扑,RO 节点范围是1 - 5个,请至少设置1个 RO 节点。说明:单节点(云盘)、云盘版实例硬盘类型所支持的地域略有不同,具体支持情况请参考 [地域和可用区](cloud.tencent.com/document/product/236/8458)。

Parameters:

  • GoodsNum:

    实例数量,默认值为 1,最小值 1,最大值为 100。

  • Memory:

    实例内存大小,单位:MB,请使用 [获取云数据库可售卖规格](cloud.tencent.com/document/api/236/17229) 接口获取可创建的内存规格。

  • Volume:

    实例硬盘大小,单位:GB,请使用 [获取云数据库可售卖规格](cloud.tencent.com/document/api/236/17229) 接口获取可创建的硬盘范围。

  • EngineVersion:

    MySQL 版本,值包括:5.5、5.6、5.7和8.0,请使用 [获取云数据库可售卖规格](cloud.tencent.com/document/api/236/17229) 接口获取可创建的实例版本。

  • UniqVpcId:

    私有网络 ID,请使用 [查询私有网络列表](/document/api/215/15778)。

  • UniqSubnetId:

    私有网络下的子网 ID,如果设置了 UniqVpcId,则 UniqSubnetId 必填,请使用 [查询子网列表](/document/api/215/15784)。

  • ProjectId:

    项目 ID,不填为默认项目。

  • Zone:

    可用区信息,请使用 [获取云数据库可售卖规格](cloud.tencent.com/document/api/236/17229) 接口获取可创建的可用区。

  • MasterInstanceId:

    实例 ID,购买只读实例或者灾备实例时必填,该字段表示只读实例或者灾备实例的主实例 ID,请使用 [查询实例列表](cloud.tencent.com/document/api/236/15872) 接口查询云数据库实例 ID。

  • InstanceRole:

    实例类型,支持值包括:master - 表示主实例,dr - 表示灾备实例,ro - 表示只读实例。

  • MasterRegion:

    主实例地域信息,购买灾备、RO实例时,该字段必填。

  • Port:

    自定义端口,端口支持范围:[1024 - 65535]。

  • Password:

    设置 root 账号密码,密码规则:8 - 64 个字符,至少包含字母、数字、字符(支持的字符:_+-&=!@#$%^*())中的两种,购买主实例时可指定该参数,购买只读实例或者灾备实例时指定该参数无意义。

  • ParamList:

    参数列表,参数格式如 ParamList.0.Name=auto_increment&ParamList.0.Value=1。可通过 [查询默认的可设置参数列表](cloud.tencent.com/document/api/236/32662) 查询支持设置的参数。

  • ProtectMode:

    数据复制方式,默认为 0,支持值包括:0 - 表示异步复制,1 - 表示半同步复制,2 - 表示强同步复制,购买主实例时可指定该参数,购买只读实例或者灾备实例时指定该参数无意义。

  • DeployMode:

    多可用区域,默认为 0,支持值包括:0 - 表示单可用区,1 - 表示多可用区,购买主实例时可指定该参数,购买只读实例或者灾备实例时指定该参数无意义。

  • SlaveZone:

    备库 1 的可用区信息。

  • BackupZone:

    备库 2 的可用区信息,默认为空,购买三节点主实例时可指定该参数。

  • SecurityGroup:

    安全组参数,可使用 [查询项目安全组信息](cloud.tencent.com/document/api/236/15850) 接口查询某个项目的安全组详情。

  • RoGroup:

    只读实例信息。购买只读实例时,该参数必传。

  • AutoRenewFlag:

    购买按量计费实例该字段无意义。

  • InstanceName:

    实例名称。一次购买多个实例命名会用后缀数字区分,例instanceName=db,goodsNum=3,实例命名分别为db1,db2,db3。

  • ResourceTags:

    实例标签信息。

  • DeployGroupId:

    置放群组 ID。

  • ClientToken:

    用于保证请求幂等性的字符串。该字符串由客户生成,需保证不同请求之间在48小时内唯一,最大值不超过64个ASCII字符。若不指定该参数,则无法保证请求的幂等性。

  • DeviceType:

    实例隔离类型。支持值包括:“UNIVERSAL” - 通用型实例,“EXCLUSIVE” - 独享型实例,“BASIC_V2” - ONTKE 单节点实例,“CLOUD_NATIVE_CLUSTER” - 云盘版标准型,“CLOUD_NATIVE_CLUSTER_EXCLUSIVE” - 云盘版加强型。不指定则默认为通用型实例。

  • ParamTemplateId:

    参数模板 id。

  • AlarmPolicyList:

    告警策略id数组。腾讯云可观测平台DescribeAlarmPolicy接口返回的OriginId。

  • InstanceNodes:

    实例节点数。对于 RO 和 基础版实例, 该值默认为1。 如果需要购买三节点实例, 请将该值设置为3 或指定 BackupZone 参数。当购买主实例,且未指定该参数和 BackupZone 参数时,该值默认是 2, 即购买两节点实例。

  • Cpu:

    实例cpu核数, 如果不传将根据memory指定的内存值自动填充对应的cpu值。

  • AutoSyncFlag:

    是否自动发起灾备同步功能。该参数仅对购买灾备实例生效。 可选值为:0 - 不自动发起灾备同步;1 - 自动发起灾备同步。该值默认为0。

  • CageId:

    金融围拢 ID 。

  • ParamTemplateType:

    默认参数模板类型。支持值包括:“HIGH_STABILITY” - 高稳定模板,“HIGH_PERFORMANCE” - 高性能模板,默认值是:“HIGH_STABILITY”。

  • AlarmPolicyIdList:

    告警策略名数组,例如:,AlarmPolicyList不为空时该参数无效。

  • DryRun:

    是否只预检此次请求。true:发送检查请求,不会创建实例。检查项包括是否填写了必需参数,请求格式,业务限制等。如果检查不通过,则返回对应错误码;如果检查通过,则返回RequestId.默认为false:发送正常请求,通过检查后直接创建实例。

  • EngineType:

    实例引擎类型,默认为“InnoDB”,支持值包括:“InnoDB”,“RocksDB”。

  • Vips:

    指定实例的IP列表。仅支持主实例指定,按实例顺序,不足则按未指定处理。

  • DataProtectVolume:

    云盘版实例的数据保护空间大小,单位 GB,设置范围1 - 10。

  • ClusterTopology:

    云盘版节点拓扑配置。

  • DiskType:

    硬盘类型,单节点(云盘)或者云盘版实例可以指定此参数。CLOUD_SSD 表示 SSD 云硬盘,CLOUD_HSSD 表示增强型 SSD 云硬盘,CLOUD_PREMIUM 表示高性能云硬盘。

  • ClusterType:

    集群类型:cage——金融围拢,cdc——CDB ON CDC;dedicate——独享集群

  • DestroyProtect:

    开启或关闭实例销毁保护。on-开启,off-关闭



3169
3170
3171
# File 'lib/v20170320/models.rb', line 3169

def AlarmPolicyIdList
  @AlarmPolicyIdList
end

#AlarmPolicyListObject

说明:创建非云盘版实例时,请根据需要指定实例版本(推荐5.7或8.0),若此参数不填,则默认值为8.0;若创建的是云盘版实例,则此参数仅能指定为5.7或8.0。说明:如果创建的是云盘版实例,此参数为必填且为私有网络类型。若此项不填,则系统会选择默认的 VPC。说明:若此项不填,则系统会选择默认 VPC 下的默认子网。说明:若您创建单节点、双节点、三节点实例,此参数为必填项,请指定可用区,若不指定可用区,则系统会自动选择一个可用区(可能不是您希望部署的可用区);若您创建云盘版实例,此参数不填,请通过参数 ClusterTopology 进行读写节点和只读节点的可用区配置。说明:请选择实例类型,不填会默认选择 master。说明:不填则默认为3306。说明:表名大小写敏感的开启和关闭可通过参数 lower_case_table_names 进行设置,参数值为0表示开启,参数值为1表示关闭,若不设置则此参数默认值为0。若您创建的是 MySQL 8.0 版本的实例,则需要在创建实例时通过设置 lower_case_table_names 参数来开启或关闭表名大小写敏感,创建实例后无法修改参数,即创建后无法修改表名大小写敏感。其他数据库版本的实例支持在创建实例后修改 lower_case_table_names 参数。创建实例时设置表名大小写敏感的 API 调用方法请参见本文中的示例2。说明:双节点、三节点实例请指定此参数值,若不指定,则默认为 Zone 的值;云盘版实例此参数可不填,请通过参数 ClusterTopology 进行读写节点和只读节点的可用区配置;单节点实例为单可用区,无需指定此参数。说明:如果创建的是云盘版实例,此参数为必填。备注:如您使用自定义参数模板 id,可传入自定义参数模板 id;如您计划使用默认参数模板,该参数模板 id 传入 id 无效,需设置 ParamTemplateType。备注:如您需使用云数据库 MySQL 默认参数模板,请设置 ParamTemplateType。说明:若购买的是云盘版实例,此参数为必填,需设置云盘版实例的 RW 和 RO 节点拓扑,RO 节点范围是1 - 5个,请至少设置1个 RO 节点。说明:单节点(云盘)、云盘版实例硬盘类型所支持的地域略有不同,具体支持情况请参考 [地域和可用区](cloud.tencent.com/document/product/236/8458)。

Parameters:

  • GoodsNum:

    实例数量,默认值为 1,最小值 1,最大值为 100。

  • Memory:

    实例内存大小,单位:MB,请使用 [获取云数据库可售卖规格](cloud.tencent.com/document/api/236/17229) 接口获取可创建的内存规格。

  • Volume:

    实例硬盘大小,单位:GB,请使用 [获取云数据库可售卖规格](cloud.tencent.com/document/api/236/17229) 接口获取可创建的硬盘范围。

  • EngineVersion:

    MySQL 版本,值包括:5.5、5.6、5.7和8.0,请使用 [获取云数据库可售卖规格](cloud.tencent.com/document/api/236/17229) 接口获取可创建的实例版本。

  • UniqVpcId:

    私有网络 ID,请使用 [查询私有网络列表](/document/api/215/15778)。

  • UniqSubnetId:

    私有网络下的子网 ID,如果设置了 UniqVpcId,则 UniqSubnetId 必填,请使用 [查询子网列表](/document/api/215/15784)。

  • ProjectId:

    项目 ID,不填为默认项目。

  • Zone:

    可用区信息,请使用 [获取云数据库可售卖规格](cloud.tencent.com/document/api/236/17229) 接口获取可创建的可用区。

  • MasterInstanceId:

    实例 ID,购买只读实例或者灾备实例时必填,该字段表示只读实例或者灾备实例的主实例 ID,请使用 [查询实例列表](cloud.tencent.com/document/api/236/15872) 接口查询云数据库实例 ID。

  • InstanceRole:

    实例类型,支持值包括:master - 表示主实例,dr - 表示灾备实例,ro - 表示只读实例。

  • MasterRegion:

    主实例地域信息,购买灾备、RO实例时,该字段必填。

  • Port:

    自定义端口,端口支持范围:[1024 - 65535]。

  • Password:

    设置 root 账号密码,密码规则:8 - 64 个字符,至少包含字母、数字、字符(支持的字符:_+-&=!@#$%^*())中的两种,购买主实例时可指定该参数,购买只读实例或者灾备实例时指定该参数无意义。

  • ParamList:

    参数列表,参数格式如 ParamList.0.Name=auto_increment&ParamList.0.Value=1。可通过 [查询默认的可设置参数列表](cloud.tencent.com/document/api/236/32662) 查询支持设置的参数。

  • ProtectMode:

    数据复制方式,默认为 0,支持值包括:0 - 表示异步复制,1 - 表示半同步复制,2 - 表示强同步复制,购买主实例时可指定该参数,购买只读实例或者灾备实例时指定该参数无意义。

  • DeployMode:

    多可用区域,默认为 0,支持值包括:0 - 表示单可用区,1 - 表示多可用区,购买主实例时可指定该参数,购买只读实例或者灾备实例时指定该参数无意义。

  • SlaveZone:

    备库 1 的可用区信息。

  • BackupZone:

    备库 2 的可用区信息,默认为空,购买三节点主实例时可指定该参数。

  • SecurityGroup:

    安全组参数,可使用 [查询项目安全组信息](cloud.tencent.com/document/api/236/15850) 接口查询某个项目的安全组详情。

  • RoGroup:

    只读实例信息。购买只读实例时,该参数必传。

  • AutoRenewFlag:

    购买按量计费实例该字段无意义。

  • InstanceName:

    实例名称。一次购买多个实例命名会用后缀数字区分,例instanceName=db,goodsNum=3,实例命名分别为db1,db2,db3。

  • ResourceTags:

    实例标签信息。

  • DeployGroupId:

    置放群组 ID。

  • ClientToken:

    用于保证请求幂等性的字符串。该字符串由客户生成,需保证不同请求之间在48小时内唯一,最大值不超过64个ASCII字符。若不指定该参数,则无法保证请求的幂等性。

  • DeviceType:

    实例隔离类型。支持值包括:“UNIVERSAL” - 通用型实例,“EXCLUSIVE” - 独享型实例,“BASIC_V2” - ONTKE 单节点实例,“CLOUD_NATIVE_CLUSTER” - 云盘版标准型,“CLOUD_NATIVE_CLUSTER_EXCLUSIVE” - 云盘版加强型。不指定则默认为通用型实例。

  • ParamTemplateId:

    参数模板 id。

  • AlarmPolicyList:

    告警策略id数组。腾讯云可观测平台DescribeAlarmPolicy接口返回的OriginId。

  • InstanceNodes:

    实例节点数。对于 RO 和 基础版实例, 该值默认为1。 如果需要购买三节点实例, 请将该值设置为3 或指定 BackupZone 参数。当购买主实例,且未指定该参数和 BackupZone 参数时,该值默认是 2, 即购买两节点实例。

  • Cpu:

    实例cpu核数, 如果不传将根据memory指定的内存值自动填充对应的cpu值。

  • AutoSyncFlag:

    是否自动发起灾备同步功能。该参数仅对购买灾备实例生效。 可选值为:0 - 不自动发起灾备同步;1 - 自动发起灾备同步。该值默认为0。

  • CageId:

    金融围拢 ID 。

  • ParamTemplateType:

    默认参数模板类型。支持值包括:“HIGH_STABILITY” - 高稳定模板,“HIGH_PERFORMANCE” - 高性能模板,默认值是:“HIGH_STABILITY”。

  • AlarmPolicyIdList:

    告警策略名数组,例如:,AlarmPolicyList不为空时该参数无效。

  • DryRun:

    是否只预检此次请求。true:发送检查请求,不会创建实例。检查项包括是否填写了必需参数,请求格式,业务限制等。如果检查不通过,则返回对应错误码;如果检查通过,则返回RequestId.默认为false:发送正常请求,通过检查后直接创建实例。

  • EngineType:

    实例引擎类型,默认为“InnoDB”,支持值包括:“InnoDB”,“RocksDB”。

  • Vips:

    指定实例的IP列表。仅支持主实例指定,按实例顺序,不足则按未指定处理。

  • DataProtectVolume:

    云盘版实例的数据保护空间大小,单位 GB,设置范围1 - 10。

  • ClusterTopology:

    云盘版节点拓扑配置。

  • DiskType:

    硬盘类型,单节点(云盘)或者云盘版实例可以指定此参数。CLOUD_SSD 表示 SSD 云硬盘,CLOUD_HSSD 表示增强型 SSD 云硬盘,CLOUD_PREMIUM 表示高性能云硬盘。

  • ClusterType:

    集群类型:cage——金融围拢,cdc——CDB ON CDC;dedicate——独享集群

  • DestroyProtect:

    开启或关闭实例销毁保护。on-开启,off-关闭



3169
3170
3171
# File 'lib/v20170320/models.rb', line 3169

def AlarmPolicyList
  @AlarmPolicyList
end

#AutoRenewFlagObject

说明:创建非云盘版实例时,请根据需要指定实例版本(推荐5.7或8.0),若此参数不填,则默认值为8.0;若创建的是云盘版实例,则此参数仅能指定为5.7或8.0。说明:如果创建的是云盘版实例,此参数为必填且为私有网络类型。若此项不填,则系统会选择默认的 VPC。说明:若此项不填,则系统会选择默认 VPC 下的默认子网。说明:若您创建单节点、双节点、三节点实例,此参数为必填项,请指定可用区,若不指定可用区,则系统会自动选择一个可用区(可能不是您希望部署的可用区);若您创建云盘版实例,此参数不填,请通过参数 ClusterTopology 进行读写节点和只读节点的可用区配置。说明:请选择实例类型,不填会默认选择 master。说明:不填则默认为3306。说明:表名大小写敏感的开启和关闭可通过参数 lower_case_table_names 进行设置,参数值为0表示开启,参数值为1表示关闭,若不设置则此参数默认值为0。若您创建的是 MySQL 8.0 版本的实例,则需要在创建实例时通过设置 lower_case_table_names 参数来开启或关闭表名大小写敏感,创建实例后无法修改参数,即创建后无法修改表名大小写敏感。其他数据库版本的实例支持在创建实例后修改 lower_case_table_names 参数。创建实例时设置表名大小写敏感的 API 调用方法请参见本文中的示例2。说明:双节点、三节点实例请指定此参数值,若不指定,则默认为 Zone 的值;云盘版实例此参数可不填,请通过参数 ClusterTopology 进行读写节点和只读节点的可用区配置;单节点实例为单可用区,无需指定此参数。说明:如果创建的是云盘版实例,此参数为必填。备注:如您使用自定义参数模板 id,可传入自定义参数模板 id;如您计划使用默认参数模板,该参数模板 id 传入 id 无效,需设置 ParamTemplateType。备注:如您需使用云数据库 MySQL 默认参数模板,请设置 ParamTemplateType。说明:若购买的是云盘版实例,此参数为必填,需设置云盘版实例的 RW 和 RO 节点拓扑,RO 节点范围是1 - 5个,请至少设置1个 RO 节点。说明:单节点(云盘)、云盘版实例硬盘类型所支持的地域略有不同,具体支持情况请参考 [地域和可用区](cloud.tencent.com/document/product/236/8458)。

Parameters:

  • GoodsNum:

    实例数量,默认值为 1,最小值 1,最大值为 100。

  • Memory:

    实例内存大小,单位:MB,请使用 [获取云数据库可售卖规格](cloud.tencent.com/document/api/236/17229) 接口获取可创建的内存规格。

  • Volume:

    实例硬盘大小,单位:GB,请使用 [获取云数据库可售卖规格](cloud.tencent.com/document/api/236/17229) 接口获取可创建的硬盘范围。

  • EngineVersion:

    MySQL 版本,值包括:5.5、5.6、5.7和8.0,请使用 [获取云数据库可售卖规格](cloud.tencent.com/document/api/236/17229) 接口获取可创建的实例版本。

  • UniqVpcId:

    私有网络 ID,请使用 [查询私有网络列表](/document/api/215/15778)。

  • UniqSubnetId:

    私有网络下的子网 ID,如果设置了 UniqVpcId,则 UniqSubnetId 必填,请使用 [查询子网列表](/document/api/215/15784)。

  • ProjectId:

    项目 ID,不填为默认项目。

  • Zone:

    可用区信息,请使用 [获取云数据库可售卖规格](cloud.tencent.com/document/api/236/17229) 接口获取可创建的可用区。

  • MasterInstanceId:

    实例 ID,购买只读实例或者灾备实例时必填,该字段表示只读实例或者灾备实例的主实例 ID,请使用 [查询实例列表](cloud.tencent.com/document/api/236/15872) 接口查询云数据库实例 ID。

  • InstanceRole:

    实例类型,支持值包括:master - 表示主实例,dr - 表示灾备实例,ro - 表示只读实例。

  • MasterRegion:

    主实例地域信息,购买灾备、RO实例时,该字段必填。

  • Port:

    自定义端口,端口支持范围:[1024 - 65535]。

  • Password:

    设置 root 账号密码,密码规则:8 - 64 个字符,至少包含字母、数字、字符(支持的字符:_+-&=!@#$%^*())中的两种,购买主实例时可指定该参数,购买只读实例或者灾备实例时指定该参数无意义。

  • ParamList:

    参数列表,参数格式如 ParamList.0.Name=auto_increment&ParamList.0.Value=1。可通过 [查询默认的可设置参数列表](cloud.tencent.com/document/api/236/32662) 查询支持设置的参数。

  • ProtectMode:

    数据复制方式,默认为 0,支持值包括:0 - 表示异步复制,1 - 表示半同步复制,2 - 表示强同步复制,购买主实例时可指定该参数,购买只读实例或者灾备实例时指定该参数无意义。

  • DeployMode:

    多可用区域,默认为 0,支持值包括:0 - 表示单可用区,1 - 表示多可用区,购买主实例时可指定该参数,购买只读实例或者灾备实例时指定该参数无意义。

  • SlaveZone:

    备库 1 的可用区信息。

  • BackupZone:

    备库 2 的可用区信息,默认为空,购买三节点主实例时可指定该参数。

  • SecurityGroup:

    安全组参数,可使用 [查询项目安全组信息](cloud.tencent.com/document/api/236/15850) 接口查询某个项目的安全组详情。

  • RoGroup:

    只读实例信息。购买只读实例时,该参数必传。

  • AutoRenewFlag:

    购买按量计费实例该字段无意义。

  • InstanceName:

    实例名称。一次购买多个实例命名会用后缀数字区分,例instanceName=db,goodsNum=3,实例命名分别为db1,db2,db3。

  • ResourceTags:

    实例标签信息。

  • DeployGroupId:

    置放群组 ID。

  • ClientToken:

    用于保证请求幂等性的字符串。该字符串由客户生成,需保证不同请求之间在48小时内唯一,最大值不超过64个ASCII字符。若不指定该参数,则无法保证请求的幂等性。

  • DeviceType:

    实例隔离类型。支持值包括:“UNIVERSAL” - 通用型实例,“EXCLUSIVE” - 独享型实例,“BASIC_V2” - ONTKE 单节点实例,“CLOUD_NATIVE_CLUSTER” - 云盘版标准型,“CLOUD_NATIVE_CLUSTER_EXCLUSIVE” - 云盘版加强型。不指定则默认为通用型实例。

  • ParamTemplateId:

    参数模板 id。

  • AlarmPolicyList:

    告警策略id数组。腾讯云可观测平台DescribeAlarmPolicy接口返回的OriginId。

  • InstanceNodes:

    实例节点数。对于 RO 和 基础版实例, 该值默认为1。 如果需要购买三节点实例, 请将该值设置为3 或指定 BackupZone 参数。当购买主实例,且未指定该参数和 BackupZone 参数时,该值默认是 2, 即购买两节点实例。

  • Cpu:

    实例cpu核数, 如果不传将根据memory指定的内存值自动填充对应的cpu值。

  • AutoSyncFlag:

    是否自动发起灾备同步功能。该参数仅对购买灾备实例生效。 可选值为:0 - 不自动发起灾备同步;1 - 自动发起灾备同步。该值默认为0。

  • CageId:

    金融围拢 ID 。

  • ParamTemplateType:

    默认参数模板类型。支持值包括:“HIGH_STABILITY” - 高稳定模板,“HIGH_PERFORMANCE” - 高性能模板,默认值是:“HIGH_STABILITY”。

  • AlarmPolicyIdList:

    告警策略名数组,例如:,AlarmPolicyList不为空时该参数无效。

  • DryRun:

    是否只预检此次请求。true:发送检查请求,不会创建实例。检查项包括是否填写了必需参数,请求格式,业务限制等。如果检查不通过,则返回对应错误码;如果检查通过,则返回RequestId.默认为false:发送正常请求,通过检查后直接创建实例。

  • EngineType:

    实例引擎类型,默认为“InnoDB”,支持值包括:“InnoDB”,“RocksDB”。

  • Vips:

    指定实例的IP列表。仅支持主实例指定,按实例顺序,不足则按未指定处理。

  • DataProtectVolume:

    云盘版实例的数据保护空间大小,单位 GB,设置范围1 - 10。

  • ClusterTopology:

    云盘版节点拓扑配置。

  • DiskType:

    硬盘类型,单节点(云盘)或者云盘版实例可以指定此参数。CLOUD_SSD 表示 SSD 云硬盘,CLOUD_HSSD 表示增强型 SSD 云硬盘,CLOUD_PREMIUM 表示高性能云硬盘。

  • ClusterType:

    集群类型:cage——金融围拢,cdc——CDB ON CDC;dedicate——独享集群

  • DestroyProtect:

    开启或关闭实例销毁保护。on-开启,off-关闭



3169
3170
3171
# File 'lib/v20170320/models.rb', line 3169

def AutoRenewFlag
  @AutoRenewFlag
end

#AutoSyncFlagObject

说明:创建非云盘版实例时,请根据需要指定实例版本(推荐5.7或8.0),若此参数不填,则默认值为8.0;若创建的是云盘版实例,则此参数仅能指定为5.7或8.0。说明:如果创建的是云盘版实例,此参数为必填且为私有网络类型。若此项不填,则系统会选择默认的 VPC。说明:若此项不填,则系统会选择默认 VPC 下的默认子网。说明:若您创建单节点、双节点、三节点实例,此参数为必填项,请指定可用区,若不指定可用区,则系统会自动选择一个可用区(可能不是您希望部署的可用区);若您创建云盘版实例,此参数不填,请通过参数 ClusterTopology 进行读写节点和只读节点的可用区配置。说明:请选择实例类型,不填会默认选择 master。说明:不填则默认为3306。说明:表名大小写敏感的开启和关闭可通过参数 lower_case_table_names 进行设置,参数值为0表示开启,参数值为1表示关闭,若不设置则此参数默认值为0。若您创建的是 MySQL 8.0 版本的实例,则需要在创建实例时通过设置 lower_case_table_names 参数来开启或关闭表名大小写敏感,创建实例后无法修改参数,即创建后无法修改表名大小写敏感。其他数据库版本的实例支持在创建实例后修改 lower_case_table_names 参数。创建实例时设置表名大小写敏感的 API 调用方法请参见本文中的示例2。说明:双节点、三节点实例请指定此参数值,若不指定,则默认为 Zone 的值;云盘版实例此参数可不填,请通过参数 ClusterTopology 进行读写节点和只读节点的可用区配置;单节点实例为单可用区,无需指定此参数。说明:如果创建的是云盘版实例,此参数为必填。备注:如您使用自定义参数模板 id,可传入自定义参数模板 id;如您计划使用默认参数模板,该参数模板 id 传入 id 无效,需设置 ParamTemplateType。备注:如您需使用云数据库 MySQL 默认参数模板,请设置 ParamTemplateType。说明:若购买的是云盘版实例,此参数为必填,需设置云盘版实例的 RW 和 RO 节点拓扑,RO 节点范围是1 - 5个,请至少设置1个 RO 节点。说明:单节点(云盘)、云盘版实例硬盘类型所支持的地域略有不同,具体支持情况请参考 [地域和可用区](cloud.tencent.com/document/product/236/8458)。

Parameters:

  • GoodsNum:

    实例数量,默认值为 1,最小值 1,最大值为 100。

  • Memory:

    实例内存大小,单位:MB,请使用 [获取云数据库可售卖规格](cloud.tencent.com/document/api/236/17229) 接口获取可创建的内存规格。

  • Volume:

    实例硬盘大小,单位:GB,请使用 [获取云数据库可售卖规格](cloud.tencent.com/document/api/236/17229) 接口获取可创建的硬盘范围。

  • EngineVersion:

    MySQL 版本,值包括:5.5、5.6、5.7和8.0,请使用 [获取云数据库可售卖规格](cloud.tencent.com/document/api/236/17229) 接口获取可创建的实例版本。

  • UniqVpcId:

    私有网络 ID,请使用 [查询私有网络列表](/document/api/215/15778)。

  • UniqSubnetId:

    私有网络下的子网 ID,如果设置了 UniqVpcId,则 UniqSubnetId 必填,请使用 [查询子网列表](/document/api/215/15784)。

  • ProjectId:

    项目 ID,不填为默认项目。

  • Zone:

    可用区信息,请使用 [获取云数据库可售卖规格](cloud.tencent.com/document/api/236/17229) 接口获取可创建的可用区。

  • MasterInstanceId:

    实例 ID,购买只读实例或者灾备实例时必填,该字段表示只读实例或者灾备实例的主实例 ID,请使用 [查询实例列表](cloud.tencent.com/document/api/236/15872) 接口查询云数据库实例 ID。

  • InstanceRole:

    实例类型,支持值包括:master - 表示主实例,dr - 表示灾备实例,ro - 表示只读实例。

  • MasterRegion:

    主实例地域信息,购买灾备、RO实例时,该字段必填。

  • Port:

    自定义端口,端口支持范围:[1024 - 65535]。

  • Password:

    设置 root 账号密码,密码规则:8 - 64 个字符,至少包含字母、数字、字符(支持的字符:_+-&=!@#$%^*())中的两种,购买主实例时可指定该参数,购买只读实例或者灾备实例时指定该参数无意义。

  • ParamList:

    参数列表,参数格式如 ParamList.0.Name=auto_increment&ParamList.0.Value=1。可通过 [查询默认的可设置参数列表](cloud.tencent.com/document/api/236/32662) 查询支持设置的参数。

  • ProtectMode:

    数据复制方式,默认为 0,支持值包括:0 - 表示异步复制,1 - 表示半同步复制,2 - 表示强同步复制,购买主实例时可指定该参数,购买只读实例或者灾备实例时指定该参数无意义。

  • DeployMode:

    多可用区域,默认为 0,支持值包括:0 - 表示单可用区,1 - 表示多可用区,购买主实例时可指定该参数,购买只读实例或者灾备实例时指定该参数无意义。

  • SlaveZone:

    备库 1 的可用区信息。

  • BackupZone:

    备库 2 的可用区信息,默认为空,购买三节点主实例时可指定该参数。

  • SecurityGroup:

    安全组参数,可使用 [查询项目安全组信息](cloud.tencent.com/document/api/236/15850) 接口查询某个项目的安全组详情。

  • RoGroup:

    只读实例信息。购买只读实例时,该参数必传。

  • AutoRenewFlag:

    购买按量计费实例该字段无意义。

  • InstanceName:

    实例名称。一次购买多个实例命名会用后缀数字区分,例instanceName=db,goodsNum=3,实例命名分别为db1,db2,db3。

  • ResourceTags:

    实例标签信息。

  • DeployGroupId:

    置放群组 ID。

  • ClientToken:

    用于保证请求幂等性的字符串。该字符串由客户生成,需保证不同请求之间在48小时内唯一,最大值不超过64个ASCII字符。若不指定该参数,则无法保证请求的幂等性。

  • DeviceType:

    实例隔离类型。支持值包括:“UNIVERSAL” - 通用型实例,“EXCLUSIVE” - 独享型实例,“BASIC_V2” - ONTKE 单节点实例,“CLOUD_NATIVE_CLUSTER” - 云盘版标准型,“CLOUD_NATIVE_CLUSTER_EXCLUSIVE” - 云盘版加强型。不指定则默认为通用型实例。

  • ParamTemplateId:

    参数模板 id。

  • AlarmPolicyList:

    告警策略id数组。腾讯云可观测平台DescribeAlarmPolicy接口返回的OriginId。

  • InstanceNodes:

    实例节点数。对于 RO 和 基础版实例, 该值默认为1。 如果需要购买三节点实例, 请将该值设置为3 或指定 BackupZone 参数。当购买主实例,且未指定该参数和 BackupZone 参数时,该值默认是 2, 即购买两节点实例。

  • Cpu:

    实例cpu核数, 如果不传将根据memory指定的内存值自动填充对应的cpu值。

  • AutoSyncFlag:

    是否自动发起灾备同步功能。该参数仅对购买灾备实例生效。 可选值为:0 - 不自动发起灾备同步;1 - 自动发起灾备同步。该值默认为0。

  • CageId:

    金融围拢 ID 。

  • ParamTemplateType:

    默认参数模板类型。支持值包括:“HIGH_STABILITY” - 高稳定模板,“HIGH_PERFORMANCE” - 高性能模板,默认值是:“HIGH_STABILITY”。

  • AlarmPolicyIdList:

    告警策略名数组,例如:,AlarmPolicyList不为空时该参数无效。

  • DryRun:

    是否只预检此次请求。true:发送检查请求,不会创建实例。检查项包括是否填写了必需参数,请求格式,业务限制等。如果检查不通过,则返回对应错误码;如果检查通过,则返回RequestId.默认为false:发送正常请求,通过检查后直接创建实例。

  • EngineType:

    实例引擎类型,默认为“InnoDB”,支持值包括:“InnoDB”,“RocksDB”。

  • Vips:

    指定实例的IP列表。仅支持主实例指定,按实例顺序,不足则按未指定处理。

  • DataProtectVolume:

    云盘版实例的数据保护空间大小,单位 GB,设置范围1 - 10。

  • ClusterTopology:

    云盘版节点拓扑配置。

  • DiskType:

    硬盘类型,单节点(云盘)或者云盘版实例可以指定此参数。CLOUD_SSD 表示 SSD 云硬盘,CLOUD_HSSD 表示增强型 SSD 云硬盘,CLOUD_PREMIUM 表示高性能云硬盘。

  • ClusterType:

    集群类型:cage——金融围拢,cdc——CDB ON CDC;dedicate——独享集群

  • DestroyProtect:

    开启或关闭实例销毁保护。on-开启,off-关闭



3169
3170
3171
# File 'lib/v20170320/models.rb', line 3169

def AutoSyncFlag
  @AutoSyncFlag
end

#BackupZoneObject

说明:创建非云盘版实例时,请根据需要指定实例版本(推荐5.7或8.0),若此参数不填,则默认值为8.0;若创建的是云盘版实例,则此参数仅能指定为5.7或8.0。说明:如果创建的是云盘版实例,此参数为必填且为私有网络类型。若此项不填,则系统会选择默认的 VPC。说明:若此项不填,则系统会选择默认 VPC 下的默认子网。说明:若您创建单节点、双节点、三节点实例,此参数为必填项,请指定可用区,若不指定可用区,则系统会自动选择一个可用区(可能不是您希望部署的可用区);若您创建云盘版实例,此参数不填,请通过参数 ClusterTopology 进行读写节点和只读节点的可用区配置。说明:请选择实例类型,不填会默认选择 master。说明:不填则默认为3306。说明:表名大小写敏感的开启和关闭可通过参数 lower_case_table_names 进行设置,参数值为0表示开启,参数值为1表示关闭,若不设置则此参数默认值为0。若您创建的是 MySQL 8.0 版本的实例,则需要在创建实例时通过设置 lower_case_table_names 参数来开启或关闭表名大小写敏感,创建实例后无法修改参数,即创建后无法修改表名大小写敏感。其他数据库版本的实例支持在创建实例后修改 lower_case_table_names 参数。创建实例时设置表名大小写敏感的 API 调用方法请参见本文中的示例2。说明:双节点、三节点实例请指定此参数值,若不指定,则默认为 Zone 的值;云盘版实例此参数可不填,请通过参数 ClusterTopology 进行读写节点和只读节点的可用区配置;单节点实例为单可用区,无需指定此参数。说明:如果创建的是云盘版实例,此参数为必填。备注:如您使用自定义参数模板 id,可传入自定义参数模板 id;如您计划使用默认参数模板,该参数模板 id 传入 id 无效,需设置 ParamTemplateType。备注:如您需使用云数据库 MySQL 默认参数模板,请设置 ParamTemplateType。说明:若购买的是云盘版实例,此参数为必填,需设置云盘版实例的 RW 和 RO 节点拓扑,RO 节点范围是1 - 5个,请至少设置1个 RO 节点。说明:单节点(云盘)、云盘版实例硬盘类型所支持的地域略有不同,具体支持情况请参考 [地域和可用区](cloud.tencent.com/document/product/236/8458)。

Parameters:

  • GoodsNum:

    实例数量,默认值为 1,最小值 1,最大值为 100。

  • Memory:

    实例内存大小,单位:MB,请使用 [获取云数据库可售卖规格](cloud.tencent.com/document/api/236/17229) 接口获取可创建的内存规格。

  • Volume:

    实例硬盘大小,单位:GB,请使用 [获取云数据库可售卖规格](cloud.tencent.com/document/api/236/17229) 接口获取可创建的硬盘范围。

  • EngineVersion:

    MySQL 版本,值包括:5.5、5.6、5.7和8.0,请使用 [获取云数据库可售卖规格](cloud.tencent.com/document/api/236/17229) 接口获取可创建的实例版本。

  • UniqVpcId:

    私有网络 ID,请使用 [查询私有网络列表](/document/api/215/15778)。

  • UniqSubnetId:

    私有网络下的子网 ID,如果设置了 UniqVpcId,则 UniqSubnetId 必填,请使用 [查询子网列表](/document/api/215/15784)。

  • ProjectId:

    项目 ID,不填为默认项目。

  • Zone:

    可用区信息,请使用 [获取云数据库可售卖规格](cloud.tencent.com/document/api/236/17229) 接口获取可创建的可用区。

  • MasterInstanceId:

    实例 ID,购买只读实例或者灾备实例时必填,该字段表示只读实例或者灾备实例的主实例 ID,请使用 [查询实例列表](cloud.tencent.com/document/api/236/15872) 接口查询云数据库实例 ID。

  • InstanceRole:

    实例类型,支持值包括:master - 表示主实例,dr - 表示灾备实例,ro - 表示只读实例。

  • MasterRegion:

    主实例地域信息,购买灾备、RO实例时,该字段必填。

  • Port:

    自定义端口,端口支持范围:[1024 - 65535]。

  • Password:

    设置 root 账号密码,密码规则:8 - 64 个字符,至少包含字母、数字、字符(支持的字符:_+-&=!@#$%^*())中的两种,购买主实例时可指定该参数,购买只读实例或者灾备实例时指定该参数无意义。

  • ParamList:

    参数列表,参数格式如 ParamList.0.Name=auto_increment&ParamList.0.Value=1。可通过 [查询默认的可设置参数列表](cloud.tencent.com/document/api/236/32662) 查询支持设置的参数。

  • ProtectMode:

    数据复制方式,默认为 0,支持值包括:0 - 表示异步复制,1 - 表示半同步复制,2 - 表示强同步复制,购买主实例时可指定该参数,购买只读实例或者灾备实例时指定该参数无意义。

  • DeployMode:

    多可用区域,默认为 0,支持值包括:0 - 表示单可用区,1 - 表示多可用区,购买主实例时可指定该参数,购买只读实例或者灾备实例时指定该参数无意义。

  • SlaveZone:

    备库 1 的可用区信息。

  • BackupZone:

    备库 2 的可用区信息,默认为空,购买三节点主实例时可指定该参数。

  • SecurityGroup:

    安全组参数,可使用 [查询项目安全组信息](cloud.tencent.com/document/api/236/15850) 接口查询某个项目的安全组详情。

  • RoGroup:

    只读实例信息。购买只读实例时,该参数必传。

  • AutoRenewFlag:

    购买按量计费实例该字段无意义。

  • InstanceName:

    实例名称。一次购买多个实例命名会用后缀数字区分,例instanceName=db,goodsNum=3,实例命名分别为db1,db2,db3。

  • ResourceTags:

    实例标签信息。

  • DeployGroupId:

    置放群组 ID。

  • ClientToken:

    用于保证请求幂等性的字符串。该字符串由客户生成,需保证不同请求之间在48小时内唯一,最大值不超过64个ASCII字符。若不指定该参数,则无法保证请求的幂等性。

  • DeviceType:

    实例隔离类型。支持值包括:“UNIVERSAL” - 通用型实例,“EXCLUSIVE” - 独享型实例,“BASIC_V2” - ONTKE 单节点实例,“CLOUD_NATIVE_CLUSTER” - 云盘版标准型,“CLOUD_NATIVE_CLUSTER_EXCLUSIVE” - 云盘版加强型。不指定则默认为通用型实例。

  • ParamTemplateId:

    参数模板 id。

  • AlarmPolicyList:

    告警策略id数组。腾讯云可观测平台DescribeAlarmPolicy接口返回的OriginId。

  • InstanceNodes:

    实例节点数。对于 RO 和 基础版实例, 该值默认为1。 如果需要购买三节点实例, 请将该值设置为3 或指定 BackupZone 参数。当购买主实例,且未指定该参数和 BackupZone 参数时,该值默认是 2, 即购买两节点实例。

  • Cpu:

    实例cpu核数, 如果不传将根据memory指定的内存值自动填充对应的cpu值。

  • AutoSyncFlag:

    是否自动发起灾备同步功能。该参数仅对购买灾备实例生效。 可选值为:0 - 不自动发起灾备同步;1 - 自动发起灾备同步。该值默认为0。

  • CageId:

    金融围拢 ID 。

  • ParamTemplateType:

    默认参数模板类型。支持值包括:“HIGH_STABILITY” - 高稳定模板,“HIGH_PERFORMANCE” - 高性能模板,默认值是:“HIGH_STABILITY”。

  • AlarmPolicyIdList:

    告警策略名数组,例如:,AlarmPolicyList不为空时该参数无效。

  • DryRun:

    是否只预检此次请求。true:发送检查请求,不会创建实例。检查项包括是否填写了必需参数,请求格式,业务限制等。如果检查不通过,则返回对应错误码;如果检查通过,则返回RequestId.默认为false:发送正常请求,通过检查后直接创建实例。

  • EngineType:

    实例引擎类型,默认为“InnoDB”,支持值包括:“InnoDB”,“RocksDB”。

  • Vips:

    指定实例的IP列表。仅支持主实例指定,按实例顺序,不足则按未指定处理。

  • DataProtectVolume:

    云盘版实例的数据保护空间大小,单位 GB,设置范围1 - 10。

  • ClusterTopology:

    云盘版节点拓扑配置。

  • DiskType:

    硬盘类型,单节点(云盘)或者云盘版实例可以指定此参数。CLOUD_SSD 表示 SSD 云硬盘,CLOUD_HSSD 表示增强型 SSD 云硬盘,CLOUD_PREMIUM 表示高性能云硬盘。

  • ClusterType:

    集群类型:cage——金融围拢,cdc——CDB ON CDC;dedicate——独享集群

  • DestroyProtect:

    开启或关闭实例销毁保护。on-开启,off-关闭



3169
3170
3171
# File 'lib/v20170320/models.rb', line 3169

def BackupZone
  @BackupZone
end

#CageIdObject

说明:创建非云盘版实例时,请根据需要指定实例版本(推荐5.7或8.0),若此参数不填,则默认值为8.0;若创建的是云盘版实例,则此参数仅能指定为5.7或8.0。说明:如果创建的是云盘版实例,此参数为必填且为私有网络类型。若此项不填,则系统会选择默认的 VPC。说明:若此项不填,则系统会选择默认 VPC 下的默认子网。说明:若您创建单节点、双节点、三节点实例,此参数为必填项,请指定可用区,若不指定可用区,则系统会自动选择一个可用区(可能不是您希望部署的可用区);若您创建云盘版实例,此参数不填,请通过参数 ClusterTopology 进行读写节点和只读节点的可用区配置。说明:请选择实例类型,不填会默认选择 master。说明:不填则默认为3306。说明:表名大小写敏感的开启和关闭可通过参数 lower_case_table_names 进行设置,参数值为0表示开启,参数值为1表示关闭,若不设置则此参数默认值为0。若您创建的是 MySQL 8.0 版本的实例,则需要在创建实例时通过设置 lower_case_table_names 参数来开启或关闭表名大小写敏感,创建实例后无法修改参数,即创建后无法修改表名大小写敏感。其他数据库版本的实例支持在创建实例后修改 lower_case_table_names 参数。创建实例时设置表名大小写敏感的 API 调用方法请参见本文中的示例2。说明:双节点、三节点实例请指定此参数值,若不指定,则默认为 Zone 的值;云盘版实例此参数可不填,请通过参数 ClusterTopology 进行读写节点和只读节点的可用区配置;单节点实例为单可用区,无需指定此参数。说明:如果创建的是云盘版实例,此参数为必填。备注:如您使用自定义参数模板 id,可传入自定义参数模板 id;如您计划使用默认参数模板,该参数模板 id 传入 id 无效,需设置 ParamTemplateType。备注:如您需使用云数据库 MySQL 默认参数模板,请设置 ParamTemplateType。说明:若购买的是云盘版实例,此参数为必填,需设置云盘版实例的 RW 和 RO 节点拓扑,RO 节点范围是1 - 5个,请至少设置1个 RO 节点。说明:单节点(云盘)、云盘版实例硬盘类型所支持的地域略有不同,具体支持情况请参考 [地域和可用区](cloud.tencent.com/document/product/236/8458)。

Parameters:

  • GoodsNum:

    实例数量,默认值为 1,最小值 1,最大值为 100。

  • Memory:

    实例内存大小,单位:MB,请使用 [获取云数据库可售卖规格](cloud.tencent.com/document/api/236/17229) 接口获取可创建的内存规格。

  • Volume:

    实例硬盘大小,单位:GB,请使用 [获取云数据库可售卖规格](cloud.tencent.com/document/api/236/17229) 接口获取可创建的硬盘范围。

  • EngineVersion:

    MySQL 版本,值包括:5.5、5.6、5.7和8.0,请使用 [获取云数据库可售卖规格](cloud.tencent.com/document/api/236/17229) 接口获取可创建的实例版本。

  • UniqVpcId:

    私有网络 ID,请使用 [查询私有网络列表](/document/api/215/15778)。

  • UniqSubnetId:

    私有网络下的子网 ID,如果设置了 UniqVpcId,则 UniqSubnetId 必填,请使用 [查询子网列表](/document/api/215/15784)。

  • ProjectId:

    项目 ID,不填为默认项目。

  • Zone:

    可用区信息,请使用 [获取云数据库可售卖规格](cloud.tencent.com/document/api/236/17229) 接口获取可创建的可用区。

  • MasterInstanceId:

    实例 ID,购买只读实例或者灾备实例时必填,该字段表示只读实例或者灾备实例的主实例 ID,请使用 [查询实例列表](cloud.tencent.com/document/api/236/15872) 接口查询云数据库实例 ID。

  • InstanceRole:

    实例类型,支持值包括:master - 表示主实例,dr - 表示灾备实例,ro - 表示只读实例。

  • MasterRegion:

    主实例地域信息,购买灾备、RO实例时,该字段必填。

  • Port:

    自定义端口,端口支持范围:[1024 - 65535]。

  • Password:

    设置 root 账号密码,密码规则:8 - 64 个字符,至少包含字母、数字、字符(支持的字符:_+-&=!@#$%^*())中的两种,购买主实例时可指定该参数,购买只读实例或者灾备实例时指定该参数无意义。

  • ParamList:

    参数列表,参数格式如 ParamList.0.Name=auto_increment&ParamList.0.Value=1。可通过 [查询默认的可设置参数列表](cloud.tencent.com/document/api/236/32662) 查询支持设置的参数。

  • ProtectMode:

    数据复制方式,默认为 0,支持值包括:0 - 表示异步复制,1 - 表示半同步复制,2 - 表示强同步复制,购买主实例时可指定该参数,购买只读实例或者灾备实例时指定该参数无意义。

  • DeployMode:

    多可用区域,默认为 0,支持值包括:0 - 表示单可用区,1 - 表示多可用区,购买主实例时可指定该参数,购买只读实例或者灾备实例时指定该参数无意义。

  • SlaveZone:

    备库 1 的可用区信息。

  • BackupZone:

    备库 2 的可用区信息,默认为空,购买三节点主实例时可指定该参数。

  • SecurityGroup:

    安全组参数,可使用 [查询项目安全组信息](cloud.tencent.com/document/api/236/15850) 接口查询某个项目的安全组详情。

  • RoGroup:

    只读实例信息。购买只读实例时,该参数必传。

  • AutoRenewFlag:

    购买按量计费实例该字段无意义。

  • InstanceName:

    实例名称。一次购买多个实例命名会用后缀数字区分,例instanceName=db,goodsNum=3,实例命名分别为db1,db2,db3。

  • ResourceTags:

    实例标签信息。

  • DeployGroupId:

    置放群组 ID。

  • ClientToken:

    用于保证请求幂等性的字符串。该字符串由客户生成,需保证不同请求之间在48小时内唯一,最大值不超过64个ASCII字符。若不指定该参数,则无法保证请求的幂等性。

  • DeviceType:

    实例隔离类型。支持值包括:“UNIVERSAL” - 通用型实例,“EXCLUSIVE” - 独享型实例,“BASIC_V2” - ONTKE 单节点实例,“CLOUD_NATIVE_CLUSTER” - 云盘版标准型,“CLOUD_NATIVE_CLUSTER_EXCLUSIVE” - 云盘版加强型。不指定则默认为通用型实例。

  • ParamTemplateId:

    参数模板 id。

  • AlarmPolicyList:

    告警策略id数组。腾讯云可观测平台DescribeAlarmPolicy接口返回的OriginId。

  • InstanceNodes:

    实例节点数。对于 RO 和 基础版实例, 该值默认为1。 如果需要购买三节点实例, 请将该值设置为3 或指定 BackupZone 参数。当购买主实例,且未指定该参数和 BackupZone 参数时,该值默认是 2, 即购买两节点实例。

  • Cpu:

    实例cpu核数, 如果不传将根据memory指定的内存值自动填充对应的cpu值。

  • AutoSyncFlag:

    是否自动发起灾备同步功能。该参数仅对购买灾备实例生效。 可选值为:0 - 不自动发起灾备同步;1 - 自动发起灾备同步。该值默认为0。

  • CageId:

    金融围拢 ID 。

  • ParamTemplateType:

    默认参数模板类型。支持值包括:“HIGH_STABILITY” - 高稳定模板,“HIGH_PERFORMANCE” - 高性能模板,默认值是:“HIGH_STABILITY”。

  • AlarmPolicyIdList:

    告警策略名数组,例如:,AlarmPolicyList不为空时该参数无效。

  • DryRun:

    是否只预检此次请求。true:发送检查请求,不会创建实例。检查项包括是否填写了必需参数,请求格式,业务限制等。如果检查不通过,则返回对应错误码;如果检查通过,则返回RequestId.默认为false:发送正常请求,通过检查后直接创建实例。

  • EngineType:

    实例引擎类型,默认为“InnoDB”,支持值包括:“InnoDB”,“RocksDB”。

  • Vips:

    指定实例的IP列表。仅支持主实例指定,按实例顺序,不足则按未指定处理。

  • DataProtectVolume:

    云盘版实例的数据保护空间大小,单位 GB,设置范围1 - 10。

  • ClusterTopology:

    云盘版节点拓扑配置。

  • DiskType:

    硬盘类型,单节点(云盘)或者云盘版实例可以指定此参数。CLOUD_SSD 表示 SSD 云硬盘,CLOUD_HSSD 表示增强型 SSD 云硬盘,CLOUD_PREMIUM 表示高性能云硬盘。

  • ClusterType:

    集群类型:cage——金融围拢,cdc——CDB ON CDC;dedicate——独享集群

  • DestroyProtect:

    开启或关闭实例销毁保护。on-开启,off-关闭



3169
3170
3171
# File 'lib/v20170320/models.rb', line 3169

def CageId
  @CageId
end

#ClientTokenObject

说明:创建非云盘版实例时,请根据需要指定实例版本(推荐5.7或8.0),若此参数不填,则默认值为8.0;若创建的是云盘版实例,则此参数仅能指定为5.7或8.0。说明:如果创建的是云盘版实例,此参数为必填且为私有网络类型。若此项不填,则系统会选择默认的 VPC。说明:若此项不填,则系统会选择默认 VPC 下的默认子网。说明:若您创建单节点、双节点、三节点实例,此参数为必填项,请指定可用区,若不指定可用区,则系统会自动选择一个可用区(可能不是您希望部署的可用区);若您创建云盘版实例,此参数不填,请通过参数 ClusterTopology 进行读写节点和只读节点的可用区配置。说明:请选择实例类型,不填会默认选择 master。说明:不填则默认为3306。说明:表名大小写敏感的开启和关闭可通过参数 lower_case_table_names 进行设置,参数值为0表示开启,参数值为1表示关闭,若不设置则此参数默认值为0。若您创建的是 MySQL 8.0 版本的实例,则需要在创建实例时通过设置 lower_case_table_names 参数来开启或关闭表名大小写敏感,创建实例后无法修改参数,即创建后无法修改表名大小写敏感。其他数据库版本的实例支持在创建实例后修改 lower_case_table_names 参数。创建实例时设置表名大小写敏感的 API 调用方法请参见本文中的示例2。说明:双节点、三节点实例请指定此参数值,若不指定,则默认为 Zone 的值;云盘版实例此参数可不填,请通过参数 ClusterTopology 进行读写节点和只读节点的可用区配置;单节点实例为单可用区,无需指定此参数。说明:如果创建的是云盘版实例,此参数为必填。备注:如您使用自定义参数模板 id,可传入自定义参数模板 id;如您计划使用默认参数模板,该参数模板 id 传入 id 无效,需设置 ParamTemplateType。备注:如您需使用云数据库 MySQL 默认参数模板,请设置 ParamTemplateType。说明:若购买的是云盘版实例,此参数为必填,需设置云盘版实例的 RW 和 RO 节点拓扑,RO 节点范围是1 - 5个,请至少设置1个 RO 节点。说明:单节点(云盘)、云盘版实例硬盘类型所支持的地域略有不同,具体支持情况请参考 [地域和可用区](cloud.tencent.com/document/product/236/8458)。

Parameters:

  • GoodsNum:

    实例数量,默认值为 1,最小值 1,最大值为 100。

  • Memory:

    实例内存大小,单位:MB,请使用 [获取云数据库可售卖规格](cloud.tencent.com/document/api/236/17229) 接口获取可创建的内存规格。

  • Volume:

    实例硬盘大小,单位:GB,请使用 [获取云数据库可售卖规格](cloud.tencent.com/document/api/236/17229) 接口获取可创建的硬盘范围。

  • EngineVersion:

    MySQL 版本,值包括:5.5、5.6、5.7和8.0,请使用 [获取云数据库可售卖规格](cloud.tencent.com/document/api/236/17229) 接口获取可创建的实例版本。

  • UniqVpcId:

    私有网络 ID,请使用 [查询私有网络列表](/document/api/215/15778)。

  • UniqSubnetId:

    私有网络下的子网 ID,如果设置了 UniqVpcId,则 UniqSubnetId 必填,请使用 [查询子网列表](/document/api/215/15784)。

  • ProjectId:

    项目 ID,不填为默认项目。

  • Zone:

    可用区信息,请使用 [获取云数据库可售卖规格](cloud.tencent.com/document/api/236/17229) 接口获取可创建的可用区。

  • MasterInstanceId:

    实例 ID,购买只读实例或者灾备实例时必填,该字段表示只读实例或者灾备实例的主实例 ID,请使用 [查询实例列表](cloud.tencent.com/document/api/236/15872) 接口查询云数据库实例 ID。

  • InstanceRole:

    实例类型,支持值包括:master - 表示主实例,dr - 表示灾备实例,ro - 表示只读实例。

  • MasterRegion:

    主实例地域信息,购买灾备、RO实例时,该字段必填。

  • Port:

    自定义端口,端口支持范围:[1024 - 65535]。

  • Password:

    设置 root 账号密码,密码规则:8 - 64 个字符,至少包含字母、数字、字符(支持的字符:_+-&=!@#$%^*())中的两种,购买主实例时可指定该参数,购买只读实例或者灾备实例时指定该参数无意义。

  • ParamList:

    参数列表,参数格式如 ParamList.0.Name=auto_increment&ParamList.0.Value=1。可通过 [查询默认的可设置参数列表](cloud.tencent.com/document/api/236/32662) 查询支持设置的参数。

  • ProtectMode:

    数据复制方式,默认为 0,支持值包括:0 - 表示异步复制,1 - 表示半同步复制,2 - 表示强同步复制,购买主实例时可指定该参数,购买只读实例或者灾备实例时指定该参数无意义。

  • DeployMode:

    多可用区域,默认为 0,支持值包括:0 - 表示单可用区,1 - 表示多可用区,购买主实例时可指定该参数,购买只读实例或者灾备实例时指定该参数无意义。

  • SlaveZone:

    备库 1 的可用区信息。

  • BackupZone:

    备库 2 的可用区信息,默认为空,购买三节点主实例时可指定该参数。

  • SecurityGroup:

    安全组参数,可使用 [查询项目安全组信息](cloud.tencent.com/document/api/236/15850) 接口查询某个项目的安全组详情。

  • RoGroup:

    只读实例信息。购买只读实例时,该参数必传。

  • AutoRenewFlag:

    购买按量计费实例该字段无意义。

  • InstanceName:

    实例名称。一次购买多个实例命名会用后缀数字区分,例instanceName=db,goodsNum=3,实例命名分别为db1,db2,db3。

  • ResourceTags:

    实例标签信息。

  • DeployGroupId:

    置放群组 ID。

  • ClientToken:

    用于保证请求幂等性的字符串。该字符串由客户生成,需保证不同请求之间在48小时内唯一,最大值不超过64个ASCII字符。若不指定该参数,则无法保证请求的幂等性。

  • DeviceType:

    实例隔离类型。支持值包括:“UNIVERSAL” - 通用型实例,“EXCLUSIVE” - 独享型实例,“BASIC_V2” - ONTKE 单节点实例,“CLOUD_NATIVE_CLUSTER” - 云盘版标准型,“CLOUD_NATIVE_CLUSTER_EXCLUSIVE” - 云盘版加强型。不指定则默认为通用型实例。

  • ParamTemplateId:

    参数模板 id。

  • AlarmPolicyList:

    告警策略id数组。腾讯云可观测平台DescribeAlarmPolicy接口返回的OriginId。

  • InstanceNodes:

    实例节点数。对于 RO 和 基础版实例, 该值默认为1。 如果需要购买三节点实例, 请将该值设置为3 或指定 BackupZone 参数。当购买主实例,且未指定该参数和 BackupZone 参数时,该值默认是 2, 即购买两节点实例。

  • Cpu:

    实例cpu核数, 如果不传将根据memory指定的内存值自动填充对应的cpu值。

  • AutoSyncFlag:

    是否自动发起灾备同步功能。该参数仅对购买灾备实例生效。 可选值为:0 - 不自动发起灾备同步;1 - 自动发起灾备同步。该值默认为0。

  • CageId:

    金融围拢 ID 。

  • ParamTemplateType:

    默认参数模板类型。支持值包括:“HIGH_STABILITY” - 高稳定模板,“HIGH_PERFORMANCE” - 高性能模板,默认值是:“HIGH_STABILITY”。

  • AlarmPolicyIdList:

    告警策略名数组,例如:,AlarmPolicyList不为空时该参数无效。

  • DryRun:

    是否只预检此次请求。true:发送检查请求,不会创建实例。检查项包括是否填写了必需参数,请求格式,业务限制等。如果检查不通过,则返回对应错误码;如果检查通过,则返回RequestId.默认为false:发送正常请求,通过检查后直接创建实例。

  • EngineType:

    实例引擎类型,默认为“InnoDB”,支持值包括:“InnoDB”,“RocksDB”。

  • Vips:

    指定实例的IP列表。仅支持主实例指定,按实例顺序,不足则按未指定处理。

  • DataProtectVolume:

    云盘版实例的数据保护空间大小,单位 GB,设置范围1 - 10。

  • ClusterTopology:

    云盘版节点拓扑配置。

  • DiskType:

    硬盘类型,单节点(云盘)或者云盘版实例可以指定此参数。CLOUD_SSD 表示 SSD 云硬盘,CLOUD_HSSD 表示增强型 SSD 云硬盘,CLOUD_PREMIUM 表示高性能云硬盘。

  • ClusterType:

    集群类型:cage——金融围拢,cdc——CDB ON CDC;dedicate——独享集群

  • DestroyProtect:

    开启或关闭实例销毁保护。on-开启,off-关闭



3169
3170
3171
# File 'lib/v20170320/models.rb', line 3169

def ClientToken
  @ClientToken
end

#ClusterTopologyObject

说明:创建非云盘版实例时,请根据需要指定实例版本(推荐5.7或8.0),若此参数不填,则默认值为8.0;若创建的是云盘版实例,则此参数仅能指定为5.7或8.0。说明:如果创建的是云盘版实例,此参数为必填且为私有网络类型。若此项不填,则系统会选择默认的 VPC。说明:若此项不填,则系统会选择默认 VPC 下的默认子网。说明:若您创建单节点、双节点、三节点实例,此参数为必填项,请指定可用区,若不指定可用区,则系统会自动选择一个可用区(可能不是您希望部署的可用区);若您创建云盘版实例,此参数不填,请通过参数 ClusterTopology 进行读写节点和只读节点的可用区配置。说明:请选择实例类型,不填会默认选择 master。说明:不填则默认为3306。说明:表名大小写敏感的开启和关闭可通过参数 lower_case_table_names 进行设置,参数值为0表示开启,参数值为1表示关闭,若不设置则此参数默认值为0。若您创建的是 MySQL 8.0 版本的实例,则需要在创建实例时通过设置 lower_case_table_names 参数来开启或关闭表名大小写敏感,创建实例后无法修改参数,即创建后无法修改表名大小写敏感。其他数据库版本的实例支持在创建实例后修改 lower_case_table_names 参数。创建实例时设置表名大小写敏感的 API 调用方法请参见本文中的示例2。说明:双节点、三节点实例请指定此参数值,若不指定,则默认为 Zone 的值;云盘版实例此参数可不填,请通过参数 ClusterTopology 进行读写节点和只读节点的可用区配置;单节点实例为单可用区,无需指定此参数。说明:如果创建的是云盘版实例,此参数为必填。备注:如您使用自定义参数模板 id,可传入自定义参数模板 id;如您计划使用默认参数模板,该参数模板 id 传入 id 无效,需设置 ParamTemplateType。备注:如您需使用云数据库 MySQL 默认参数模板,请设置 ParamTemplateType。说明:若购买的是云盘版实例,此参数为必填,需设置云盘版实例的 RW 和 RO 节点拓扑,RO 节点范围是1 - 5个,请至少设置1个 RO 节点。说明:单节点(云盘)、云盘版实例硬盘类型所支持的地域略有不同,具体支持情况请参考 [地域和可用区](cloud.tencent.com/document/product/236/8458)。

Parameters:

  • GoodsNum:

    实例数量,默认值为 1,最小值 1,最大值为 100。

  • Memory:

    实例内存大小,单位:MB,请使用 [获取云数据库可售卖规格](cloud.tencent.com/document/api/236/17229) 接口获取可创建的内存规格。

  • Volume:

    实例硬盘大小,单位:GB,请使用 [获取云数据库可售卖规格](cloud.tencent.com/document/api/236/17229) 接口获取可创建的硬盘范围。

  • EngineVersion:

    MySQL 版本,值包括:5.5、5.6、5.7和8.0,请使用 [获取云数据库可售卖规格](cloud.tencent.com/document/api/236/17229) 接口获取可创建的实例版本。

  • UniqVpcId:

    私有网络 ID,请使用 [查询私有网络列表](/document/api/215/15778)。

  • UniqSubnetId:

    私有网络下的子网 ID,如果设置了 UniqVpcId,则 UniqSubnetId 必填,请使用 [查询子网列表](/document/api/215/15784)。

  • ProjectId:

    项目 ID,不填为默认项目。

  • Zone:

    可用区信息,请使用 [获取云数据库可售卖规格](cloud.tencent.com/document/api/236/17229) 接口获取可创建的可用区。

  • MasterInstanceId:

    实例 ID,购买只读实例或者灾备实例时必填,该字段表示只读实例或者灾备实例的主实例 ID,请使用 [查询实例列表](cloud.tencent.com/document/api/236/15872) 接口查询云数据库实例 ID。

  • InstanceRole:

    实例类型,支持值包括:master - 表示主实例,dr - 表示灾备实例,ro - 表示只读实例。

  • MasterRegion:

    主实例地域信息,购买灾备、RO实例时,该字段必填。

  • Port:

    自定义端口,端口支持范围:[1024 - 65535]。

  • Password:

    设置 root 账号密码,密码规则:8 - 64 个字符,至少包含字母、数字、字符(支持的字符:_+-&=!@#$%^*())中的两种,购买主实例时可指定该参数,购买只读实例或者灾备实例时指定该参数无意义。

  • ParamList:

    参数列表,参数格式如 ParamList.0.Name=auto_increment&ParamList.0.Value=1。可通过 [查询默认的可设置参数列表](cloud.tencent.com/document/api/236/32662) 查询支持设置的参数。

  • ProtectMode:

    数据复制方式,默认为 0,支持值包括:0 - 表示异步复制,1 - 表示半同步复制,2 - 表示强同步复制,购买主实例时可指定该参数,购买只读实例或者灾备实例时指定该参数无意义。

  • DeployMode:

    多可用区域,默认为 0,支持值包括:0 - 表示单可用区,1 - 表示多可用区,购买主实例时可指定该参数,购买只读实例或者灾备实例时指定该参数无意义。

  • SlaveZone:

    备库 1 的可用区信息。

  • BackupZone:

    备库 2 的可用区信息,默认为空,购买三节点主实例时可指定该参数。

  • SecurityGroup:

    安全组参数,可使用 [查询项目安全组信息](cloud.tencent.com/document/api/236/15850) 接口查询某个项目的安全组详情。

  • RoGroup:

    只读实例信息。购买只读实例时,该参数必传。

  • AutoRenewFlag:

    购买按量计费实例该字段无意义。

  • InstanceName:

    实例名称。一次购买多个实例命名会用后缀数字区分,例instanceName=db,goodsNum=3,实例命名分别为db1,db2,db3。

  • ResourceTags:

    实例标签信息。

  • DeployGroupId:

    置放群组 ID。

  • ClientToken:

    用于保证请求幂等性的字符串。该字符串由客户生成,需保证不同请求之间在48小时内唯一,最大值不超过64个ASCII字符。若不指定该参数,则无法保证请求的幂等性。

  • DeviceType:

    实例隔离类型。支持值包括:“UNIVERSAL” - 通用型实例,“EXCLUSIVE” - 独享型实例,“BASIC_V2” - ONTKE 单节点实例,“CLOUD_NATIVE_CLUSTER” - 云盘版标准型,“CLOUD_NATIVE_CLUSTER_EXCLUSIVE” - 云盘版加强型。不指定则默认为通用型实例。

  • ParamTemplateId:

    参数模板 id。

  • AlarmPolicyList:

    告警策略id数组。腾讯云可观测平台DescribeAlarmPolicy接口返回的OriginId。

  • InstanceNodes:

    实例节点数。对于 RO 和 基础版实例, 该值默认为1。 如果需要购买三节点实例, 请将该值设置为3 或指定 BackupZone 参数。当购买主实例,且未指定该参数和 BackupZone 参数时,该值默认是 2, 即购买两节点实例。

  • Cpu:

    实例cpu核数, 如果不传将根据memory指定的内存值自动填充对应的cpu值。

  • AutoSyncFlag:

    是否自动发起灾备同步功能。该参数仅对购买灾备实例生效。 可选值为:0 - 不自动发起灾备同步;1 - 自动发起灾备同步。该值默认为0。

  • CageId:

    金融围拢 ID 。

  • ParamTemplateType:

    默认参数模板类型。支持值包括:“HIGH_STABILITY” - 高稳定模板,“HIGH_PERFORMANCE” - 高性能模板,默认值是:“HIGH_STABILITY”。

  • AlarmPolicyIdList:

    告警策略名数组,例如:,AlarmPolicyList不为空时该参数无效。

  • DryRun:

    是否只预检此次请求。true:发送检查请求,不会创建实例。检查项包括是否填写了必需参数,请求格式,业务限制等。如果检查不通过,则返回对应错误码;如果检查通过,则返回RequestId.默认为false:发送正常请求,通过检查后直接创建实例。

  • EngineType:

    实例引擎类型,默认为“InnoDB”,支持值包括:“InnoDB”,“RocksDB”。

  • Vips:

    指定实例的IP列表。仅支持主实例指定,按实例顺序,不足则按未指定处理。

  • DataProtectVolume:

    云盘版实例的数据保护空间大小,单位 GB,设置范围1 - 10。

  • ClusterTopology:

    云盘版节点拓扑配置。

  • DiskType:

    硬盘类型,单节点(云盘)或者云盘版实例可以指定此参数。CLOUD_SSD 表示 SSD 云硬盘,CLOUD_HSSD 表示增强型 SSD 云硬盘,CLOUD_PREMIUM 表示高性能云硬盘。

  • ClusterType:

    集群类型:cage——金融围拢,cdc——CDB ON CDC;dedicate——独享集群

  • DestroyProtect:

    开启或关闭实例销毁保护。on-开启,off-关闭



3169
3170
3171
# File 'lib/v20170320/models.rb', line 3169

def ClusterTopology
  @ClusterTopology
end

#ClusterTypeObject

说明:创建非云盘版实例时,请根据需要指定实例版本(推荐5.7或8.0),若此参数不填,则默认值为8.0;若创建的是云盘版实例,则此参数仅能指定为5.7或8.0。说明:如果创建的是云盘版实例,此参数为必填且为私有网络类型。若此项不填,则系统会选择默认的 VPC。说明:若此项不填,则系统会选择默认 VPC 下的默认子网。说明:若您创建单节点、双节点、三节点实例,此参数为必填项,请指定可用区,若不指定可用区,则系统会自动选择一个可用区(可能不是您希望部署的可用区);若您创建云盘版实例,此参数不填,请通过参数 ClusterTopology 进行读写节点和只读节点的可用区配置。说明:请选择实例类型,不填会默认选择 master。说明:不填则默认为3306。说明:表名大小写敏感的开启和关闭可通过参数 lower_case_table_names 进行设置,参数值为0表示开启,参数值为1表示关闭,若不设置则此参数默认值为0。若您创建的是 MySQL 8.0 版本的实例,则需要在创建实例时通过设置 lower_case_table_names 参数来开启或关闭表名大小写敏感,创建实例后无法修改参数,即创建后无法修改表名大小写敏感。其他数据库版本的实例支持在创建实例后修改 lower_case_table_names 参数。创建实例时设置表名大小写敏感的 API 调用方法请参见本文中的示例2。说明:双节点、三节点实例请指定此参数值,若不指定,则默认为 Zone 的值;云盘版实例此参数可不填,请通过参数 ClusterTopology 进行读写节点和只读节点的可用区配置;单节点实例为单可用区,无需指定此参数。说明:如果创建的是云盘版实例,此参数为必填。备注:如您使用自定义参数模板 id,可传入自定义参数模板 id;如您计划使用默认参数模板,该参数模板 id 传入 id 无效,需设置 ParamTemplateType。备注:如您需使用云数据库 MySQL 默认参数模板,请设置 ParamTemplateType。说明:若购买的是云盘版实例,此参数为必填,需设置云盘版实例的 RW 和 RO 节点拓扑,RO 节点范围是1 - 5个,请至少设置1个 RO 节点。说明:单节点(云盘)、云盘版实例硬盘类型所支持的地域略有不同,具体支持情况请参考 [地域和可用区](cloud.tencent.com/document/product/236/8458)。

Parameters:

  • GoodsNum:

    实例数量,默认值为 1,最小值 1,最大值为 100。

  • Memory:

    实例内存大小,单位:MB,请使用 [获取云数据库可售卖规格](cloud.tencent.com/document/api/236/17229) 接口获取可创建的内存规格。

  • Volume:

    实例硬盘大小,单位:GB,请使用 [获取云数据库可售卖规格](cloud.tencent.com/document/api/236/17229) 接口获取可创建的硬盘范围。

  • EngineVersion:

    MySQL 版本,值包括:5.5、5.6、5.7和8.0,请使用 [获取云数据库可售卖规格](cloud.tencent.com/document/api/236/17229) 接口获取可创建的实例版本。

  • UniqVpcId:

    私有网络 ID,请使用 [查询私有网络列表](/document/api/215/15778)。

  • UniqSubnetId:

    私有网络下的子网 ID,如果设置了 UniqVpcId,则 UniqSubnetId 必填,请使用 [查询子网列表](/document/api/215/15784)。

  • ProjectId:

    项目 ID,不填为默认项目。

  • Zone:

    可用区信息,请使用 [获取云数据库可售卖规格](cloud.tencent.com/document/api/236/17229) 接口获取可创建的可用区。

  • MasterInstanceId:

    实例 ID,购买只读实例或者灾备实例时必填,该字段表示只读实例或者灾备实例的主实例 ID,请使用 [查询实例列表](cloud.tencent.com/document/api/236/15872) 接口查询云数据库实例 ID。

  • InstanceRole:

    实例类型,支持值包括:master - 表示主实例,dr - 表示灾备实例,ro - 表示只读实例。

  • MasterRegion:

    主实例地域信息,购买灾备、RO实例时,该字段必填。

  • Port:

    自定义端口,端口支持范围:[1024 - 65535]。

  • Password:

    设置 root 账号密码,密码规则:8 - 64 个字符,至少包含字母、数字、字符(支持的字符:_+-&=!@#$%^*())中的两种,购买主实例时可指定该参数,购买只读实例或者灾备实例时指定该参数无意义。

  • ParamList:

    参数列表,参数格式如 ParamList.0.Name=auto_increment&ParamList.0.Value=1。可通过 [查询默认的可设置参数列表](cloud.tencent.com/document/api/236/32662) 查询支持设置的参数。

  • ProtectMode:

    数据复制方式,默认为 0,支持值包括:0 - 表示异步复制,1 - 表示半同步复制,2 - 表示强同步复制,购买主实例时可指定该参数,购买只读实例或者灾备实例时指定该参数无意义。

  • DeployMode:

    多可用区域,默认为 0,支持值包括:0 - 表示单可用区,1 - 表示多可用区,购买主实例时可指定该参数,购买只读实例或者灾备实例时指定该参数无意义。

  • SlaveZone:

    备库 1 的可用区信息。

  • BackupZone:

    备库 2 的可用区信息,默认为空,购买三节点主实例时可指定该参数。

  • SecurityGroup:

    安全组参数,可使用 [查询项目安全组信息](cloud.tencent.com/document/api/236/15850) 接口查询某个项目的安全组详情。

  • RoGroup:

    只读实例信息。购买只读实例时,该参数必传。

  • AutoRenewFlag:

    购买按量计费实例该字段无意义。

  • InstanceName:

    实例名称。一次购买多个实例命名会用后缀数字区分,例instanceName=db,goodsNum=3,实例命名分别为db1,db2,db3。

  • ResourceTags:

    实例标签信息。

  • DeployGroupId:

    置放群组 ID。

  • ClientToken:

    用于保证请求幂等性的字符串。该字符串由客户生成,需保证不同请求之间在48小时内唯一,最大值不超过64个ASCII字符。若不指定该参数,则无法保证请求的幂等性。

  • DeviceType:

    实例隔离类型。支持值包括:“UNIVERSAL” - 通用型实例,“EXCLUSIVE” - 独享型实例,“BASIC_V2” - ONTKE 单节点实例,“CLOUD_NATIVE_CLUSTER” - 云盘版标准型,“CLOUD_NATIVE_CLUSTER_EXCLUSIVE” - 云盘版加强型。不指定则默认为通用型实例。

  • ParamTemplateId:

    参数模板 id。

  • AlarmPolicyList:

    告警策略id数组。腾讯云可观测平台DescribeAlarmPolicy接口返回的OriginId。

  • InstanceNodes:

    实例节点数。对于 RO 和 基础版实例, 该值默认为1。 如果需要购买三节点实例, 请将该值设置为3 或指定 BackupZone 参数。当购买主实例,且未指定该参数和 BackupZone 参数时,该值默认是 2, 即购买两节点实例。

  • Cpu:

    实例cpu核数, 如果不传将根据memory指定的内存值自动填充对应的cpu值。

  • AutoSyncFlag:

    是否自动发起灾备同步功能。该参数仅对购买灾备实例生效。 可选值为:0 - 不自动发起灾备同步;1 - 自动发起灾备同步。该值默认为0。

  • CageId:

    金融围拢 ID 。

  • ParamTemplateType:

    默认参数模板类型。支持值包括:“HIGH_STABILITY” - 高稳定模板,“HIGH_PERFORMANCE” - 高性能模板,默认值是:“HIGH_STABILITY”。

  • AlarmPolicyIdList:

    告警策略名数组,例如:,AlarmPolicyList不为空时该参数无效。

  • DryRun:

    是否只预检此次请求。true:发送检查请求,不会创建实例。检查项包括是否填写了必需参数,请求格式,业务限制等。如果检查不通过,则返回对应错误码;如果检查通过,则返回RequestId.默认为false:发送正常请求,通过检查后直接创建实例。

  • EngineType:

    实例引擎类型,默认为“InnoDB”,支持值包括:“InnoDB”,“RocksDB”。

  • Vips:

    指定实例的IP列表。仅支持主实例指定,按实例顺序,不足则按未指定处理。

  • DataProtectVolume:

    云盘版实例的数据保护空间大小,单位 GB,设置范围1 - 10。

  • ClusterTopology:

    云盘版节点拓扑配置。

  • DiskType:

    硬盘类型,单节点(云盘)或者云盘版实例可以指定此参数。CLOUD_SSD 表示 SSD 云硬盘,CLOUD_HSSD 表示增强型 SSD 云硬盘,CLOUD_PREMIUM 表示高性能云硬盘。

  • ClusterType:

    集群类型:cage——金融围拢,cdc——CDB ON CDC;dedicate——独享集群

  • DestroyProtect:

    开启或关闭实例销毁保护。on-开启,off-关闭



3169
3170
3171
# File 'lib/v20170320/models.rb', line 3169

def ClusterType
  @ClusterType
end

#CpuObject

说明:创建非云盘版实例时,请根据需要指定实例版本(推荐5.7或8.0),若此参数不填,则默认值为8.0;若创建的是云盘版实例,则此参数仅能指定为5.7或8.0。说明:如果创建的是云盘版实例,此参数为必填且为私有网络类型。若此项不填,则系统会选择默认的 VPC。说明:若此项不填,则系统会选择默认 VPC 下的默认子网。说明:若您创建单节点、双节点、三节点实例,此参数为必填项,请指定可用区,若不指定可用区,则系统会自动选择一个可用区(可能不是您希望部署的可用区);若您创建云盘版实例,此参数不填,请通过参数 ClusterTopology 进行读写节点和只读节点的可用区配置。说明:请选择实例类型,不填会默认选择 master。说明:不填则默认为3306。说明:表名大小写敏感的开启和关闭可通过参数 lower_case_table_names 进行设置,参数值为0表示开启,参数值为1表示关闭,若不设置则此参数默认值为0。若您创建的是 MySQL 8.0 版本的实例,则需要在创建实例时通过设置 lower_case_table_names 参数来开启或关闭表名大小写敏感,创建实例后无法修改参数,即创建后无法修改表名大小写敏感。其他数据库版本的实例支持在创建实例后修改 lower_case_table_names 参数。创建实例时设置表名大小写敏感的 API 调用方法请参见本文中的示例2。说明:双节点、三节点实例请指定此参数值,若不指定,则默认为 Zone 的值;云盘版实例此参数可不填,请通过参数 ClusterTopology 进行读写节点和只读节点的可用区配置;单节点实例为单可用区,无需指定此参数。说明:如果创建的是云盘版实例,此参数为必填。备注:如您使用自定义参数模板 id,可传入自定义参数模板 id;如您计划使用默认参数模板,该参数模板 id 传入 id 无效,需设置 ParamTemplateType。备注:如您需使用云数据库 MySQL 默认参数模板,请设置 ParamTemplateType。说明:若购买的是云盘版实例,此参数为必填,需设置云盘版实例的 RW 和 RO 节点拓扑,RO 节点范围是1 - 5个,请至少设置1个 RO 节点。说明:单节点(云盘)、云盘版实例硬盘类型所支持的地域略有不同,具体支持情况请参考 [地域和可用区](cloud.tencent.com/document/product/236/8458)。

Parameters:

  • GoodsNum:

    实例数量,默认值为 1,最小值 1,最大值为 100。

  • Memory:

    实例内存大小,单位:MB,请使用 [获取云数据库可售卖规格](cloud.tencent.com/document/api/236/17229) 接口获取可创建的内存规格。

  • Volume:

    实例硬盘大小,单位:GB,请使用 [获取云数据库可售卖规格](cloud.tencent.com/document/api/236/17229) 接口获取可创建的硬盘范围。

  • EngineVersion:

    MySQL 版本,值包括:5.5、5.6、5.7和8.0,请使用 [获取云数据库可售卖规格](cloud.tencent.com/document/api/236/17229) 接口获取可创建的实例版本。

  • UniqVpcId:

    私有网络 ID,请使用 [查询私有网络列表](/document/api/215/15778)。

  • UniqSubnetId:

    私有网络下的子网 ID,如果设置了 UniqVpcId,则 UniqSubnetId 必填,请使用 [查询子网列表](/document/api/215/15784)。

  • ProjectId:

    项目 ID,不填为默认项目。

  • Zone:

    可用区信息,请使用 [获取云数据库可售卖规格](cloud.tencent.com/document/api/236/17229) 接口获取可创建的可用区。

  • MasterInstanceId:

    实例 ID,购买只读实例或者灾备实例时必填,该字段表示只读实例或者灾备实例的主实例 ID,请使用 [查询实例列表](cloud.tencent.com/document/api/236/15872) 接口查询云数据库实例 ID。

  • InstanceRole:

    实例类型,支持值包括:master - 表示主实例,dr - 表示灾备实例,ro - 表示只读实例。

  • MasterRegion:

    主实例地域信息,购买灾备、RO实例时,该字段必填。

  • Port:

    自定义端口,端口支持范围:[1024 - 65535]。

  • Password:

    设置 root 账号密码,密码规则:8 - 64 个字符,至少包含字母、数字、字符(支持的字符:_+-&=!@#$%^*())中的两种,购买主实例时可指定该参数,购买只读实例或者灾备实例时指定该参数无意义。

  • ParamList:

    参数列表,参数格式如 ParamList.0.Name=auto_increment&ParamList.0.Value=1。可通过 [查询默认的可设置参数列表](cloud.tencent.com/document/api/236/32662) 查询支持设置的参数。

  • ProtectMode:

    数据复制方式,默认为 0,支持值包括:0 - 表示异步复制,1 - 表示半同步复制,2 - 表示强同步复制,购买主实例时可指定该参数,购买只读实例或者灾备实例时指定该参数无意义。

  • DeployMode:

    多可用区域,默认为 0,支持值包括:0 - 表示单可用区,1 - 表示多可用区,购买主实例时可指定该参数,购买只读实例或者灾备实例时指定该参数无意义。

  • SlaveZone:

    备库 1 的可用区信息。

  • BackupZone:

    备库 2 的可用区信息,默认为空,购买三节点主实例时可指定该参数。

  • SecurityGroup:

    安全组参数,可使用 [查询项目安全组信息](cloud.tencent.com/document/api/236/15850) 接口查询某个项目的安全组详情。

  • RoGroup:

    只读实例信息。购买只读实例时,该参数必传。

  • AutoRenewFlag:

    购买按量计费实例该字段无意义。

  • InstanceName:

    实例名称。一次购买多个实例命名会用后缀数字区分,例instanceName=db,goodsNum=3,实例命名分别为db1,db2,db3。

  • ResourceTags:

    实例标签信息。

  • DeployGroupId:

    置放群组 ID。

  • ClientToken:

    用于保证请求幂等性的字符串。该字符串由客户生成,需保证不同请求之间在48小时内唯一,最大值不超过64个ASCII字符。若不指定该参数,则无法保证请求的幂等性。

  • DeviceType:

    实例隔离类型。支持值包括:“UNIVERSAL” - 通用型实例,“EXCLUSIVE” - 独享型实例,“BASIC_V2” - ONTKE 单节点实例,“CLOUD_NATIVE_CLUSTER” - 云盘版标准型,“CLOUD_NATIVE_CLUSTER_EXCLUSIVE” - 云盘版加强型。不指定则默认为通用型实例。

  • ParamTemplateId:

    参数模板 id。

  • AlarmPolicyList:

    告警策略id数组。腾讯云可观测平台DescribeAlarmPolicy接口返回的OriginId。

  • InstanceNodes:

    实例节点数。对于 RO 和 基础版实例, 该值默认为1。 如果需要购买三节点实例, 请将该值设置为3 或指定 BackupZone 参数。当购买主实例,且未指定该参数和 BackupZone 参数时,该值默认是 2, 即购买两节点实例。

  • Cpu:

    实例cpu核数, 如果不传将根据memory指定的内存值自动填充对应的cpu值。

  • AutoSyncFlag:

    是否自动发起灾备同步功能。该参数仅对购买灾备实例生效。 可选值为:0 - 不自动发起灾备同步;1 - 自动发起灾备同步。该值默认为0。

  • CageId:

    金融围拢 ID 。

  • ParamTemplateType:

    默认参数模板类型。支持值包括:“HIGH_STABILITY” - 高稳定模板,“HIGH_PERFORMANCE” - 高性能模板,默认值是:“HIGH_STABILITY”。

  • AlarmPolicyIdList:

    告警策略名数组,例如:,AlarmPolicyList不为空时该参数无效。

  • DryRun:

    是否只预检此次请求。true:发送检查请求,不会创建实例。检查项包括是否填写了必需参数,请求格式,业务限制等。如果检查不通过,则返回对应错误码;如果检查通过,则返回RequestId.默认为false:发送正常请求,通过检查后直接创建实例。

  • EngineType:

    实例引擎类型,默认为“InnoDB”,支持值包括:“InnoDB”,“RocksDB”。

  • Vips:

    指定实例的IP列表。仅支持主实例指定,按实例顺序,不足则按未指定处理。

  • DataProtectVolume:

    云盘版实例的数据保护空间大小,单位 GB,设置范围1 - 10。

  • ClusterTopology:

    云盘版节点拓扑配置。

  • DiskType:

    硬盘类型,单节点(云盘)或者云盘版实例可以指定此参数。CLOUD_SSD 表示 SSD 云硬盘,CLOUD_HSSD 表示增强型 SSD 云硬盘,CLOUD_PREMIUM 表示高性能云硬盘。

  • ClusterType:

    集群类型:cage——金融围拢,cdc——CDB ON CDC;dedicate——独享集群

  • DestroyProtect:

    开启或关闭实例销毁保护。on-开启,off-关闭



3169
3170
3171
# File 'lib/v20170320/models.rb', line 3169

def Cpu
  @Cpu
end

#DataProtectVolumeObject

说明:创建非云盘版实例时,请根据需要指定实例版本(推荐5.7或8.0),若此参数不填,则默认值为8.0;若创建的是云盘版实例,则此参数仅能指定为5.7或8.0。说明:如果创建的是云盘版实例,此参数为必填且为私有网络类型。若此项不填,则系统会选择默认的 VPC。说明:若此项不填,则系统会选择默认 VPC 下的默认子网。说明:若您创建单节点、双节点、三节点实例,此参数为必填项,请指定可用区,若不指定可用区,则系统会自动选择一个可用区(可能不是您希望部署的可用区);若您创建云盘版实例,此参数不填,请通过参数 ClusterTopology 进行读写节点和只读节点的可用区配置。说明:请选择实例类型,不填会默认选择 master。说明:不填则默认为3306。说明:表名大小写敏感的开启和关闭可通过参数 lower_case_table_names 进行设置,参数值为0表示开启,参数值为1表示关闭,若不设置则此参数默认值为0。若您创建的是 MySQL 8.0 版本的实例,则需要在创建实例时通过设置 lower_case_table_names 参数来开启或关闭表名大小写敏感,创建实例后无法修改参数,即创建后无法修改表名大小写敏感。其他数据库版本的实例支持在创建实例后修改 lower_case_table_names 参数。创建实例时设置表名大小写敏感的 API 调用方法请参见本文中的示例2。说明:双节点、三节点实例请指定此参数值,若不指定,则默认为 Zone 的值;云盘版实例此参数可不填,请通过参数 ClusterTopology 进行读写节点和只读节点的可用区配置;单节点实例为单可用区,无需指定此参数。说明:如果创建的是云盘版实例,此参数为必填。备注:如您使用自定义参数模板 id,可传入自定义参数模板 id;如您计划使用默认参数模板,该参数模板 id 传入 id 无效,需设置 ParamTemplateType。备注:如您需使用云数据库 MySQL 默认参数模板,请设置 ParamTemplateType。说明:若购买的是云盘版实例,此参数为必填,需设置云盘版实例的 RW 和 RO 节点拓扑,RO 节点范围是1 - 5个,请至少设置1个 RO 节点。说明:单节点(云盘)、云盘版实例硬盘类型所支持的地域略有不同,具体支持情况请参考 [地域和可用区](cloud.tencent.com/document/product/236/8458)。

Parameters:

  • GoodsNum:

    实例数量,默认值为 1,最小值 1,最大值为 100。

  • Memory:

    实例内存大小,单位:MB,请使用 [获取云数据库可售卖规格](cloud.tencent.com/document/api/236/17229) 接口获取可创建的内存规格。

  • Volume:

    实例硬盘大小,单位:GB,请使用 [获取云数据库可售卖规格](cloud.tencent.com/document/api/236/17229) 接口获取可创建的硬盘范围。

  • EngineVersion:

    MySQL 版本,值包括:5.5、5.6、5.7和8.0,请使用 [获取云数据库可售卖规格](cloud.tencent.com/document/api/236/17229) 接口获取可创建的实例版本。

  • UniqVpcId:

    私有网络 ID,请使用 [查询私有网络列表](/document/api/215/15778)。

  • UniqSubnetId:

    私有网络下的子网 ID,如果设置了 UniqVpcId,则 UniqSubnetId 必填,请使用 [查询子网列表](/document/api/215/15784)。

  • ProjectId:

    项目 ID,不填为默认项目。

  • Zone:

    可用区信息,请使用 [获取云数据库可售卖规格](cloud.tencent.com/document/api/236/17229) 接口获取可创建的可用区。

  • MasterInstanceId:

    实例 ID,购买只读实例或者灾备实例时必填,该字段表示只读实例或者灾备实例的主实例 ID,请使用 [查询实例列表](cloud.tencent.com/document/api/236/15872) 接口查询云数据库实例 ID。

  • InstanceRole:

    实例类型,支持值包括:master - 表示主实例,dr - 表示灾备实例,ro - 表示只读实例。

  • MasterRegion:

    主实例地域信息,购买灾备、RO实例时,该字段必填。

  • Port:

    自定义端口,端口支持范围:[1024 - 65535]。

  • Password:

    设置 root 账号密码,密码规则:8 - 64 个字符,至少包含字母、数字、字符(支持的字符:_+-&=!@#$%^*())中的两种,购买主实例时可指定该参数,购买只读实例或者灾备实例时指定该参数无意义。

  • ParamList:

    参数列表,参数格式如 ParamList.0.Name=auto_increment&ParamList.0.Value=1。可通过 [查询默认的可设置参数列表](cloud.tencent.com/document/api/236/32662) 查询支持设置的参数。

  • ProtectMode:

    数据复制方式,默认为 0,支持值包括:0 - 表示异步复制,1 - 表示半同步复制,2 - 表示强同步复制,购买主实例时可指定该参数,购买只读实例或者灾备实例时指定该参数无意义。

  • DeployMode:

    多可用区域,默认为 0,支持值包括:0 - 表示单可用区,1 - 表示多可用区,购买主实例时可指定该参数,购买只读实例或者灾备实例时指定该参数无意义。

  • SlaveZone:

    备库 1 的可用区信息。

  • BackupZone:

    备库 2 的可用区信息,默认为空,购买三节点主实例时可指定该参数。

  • SecurityGroup:

    安全组参数,可使用 [查询项目安全组信息](cloud.tencent.com/document/api/236/15850) 接口查询某个项目的安全组详情。

  • RoGroup:

    只读实例信息。购买只读实例时,该参数必传。

  • AutoRenewFlag:

    购买按量计费实例该字段无意义。

  • InstanceName:

    实例名称。一次购买多个实例命名会用后缀数字区分,例instanceName=db,goodsNum=3,实例命名分别为db1,db2,db3。

  • ResourceTags:

    实例标签信息。

  • DeployGroupId:

    置放群组 ID。

  • ClientToken:

    用于保证请求幂等性的字符串。该字符串由客户生成,需保证不同请求之间在48小时内唯一,最大值不超过64个ASCII字符。若不指定该参数,则无法保证请求的幂等性。

  • DeviceType:

    实例隔离类型。支持值包括:“UNIVERSAL” - 通用型实例,“EXCLUSIVE” - 独享型实例,“BASIC_V2” - ONTKE 单节点实例,“CLOUD_NATIVE_CLUSTER” - 云盘版标准型,“CLOUD_NATIVE_CLUSTER_EXCLUSIVE” - 云盘版加强型。不指定则默认为通用型实例。

  • ParamTemplateId:

    参数模板 id。

  • AlarmPolicyList:

    告警策略id数组。腾讯云可观测平台DescribeAlarmPolicy接口返回的OriginId。

  • InstanceNodes:

    实例节点数。对于 RO 和 基础版实例, 该值默认为1。 如果需要购买三节点实例, 请将该值设置为3 或指定 BackupZone 参数。当购买主实例,且未指定该参数和 BackupZone 参数时,该值默认是 2, 即购买两节点实例。

  • Cpu:

    实例cpu核数, 如果不传将根据memory指定的内存值自动填充对应的cpu值。

  • AutoSyncFlag:

    是否自动发起灾备同步功能。该参数仅对购买灾备实例生效。 可选值为:0 - 不自动发起灾备同步;1 - 自动发起灾备同步。该值默认为0。

  • CageId:

    金融围拢 ID 。

  • ParamTemplateType:

    默认参数模板类型。支持值包括:“HIGH_STABILITY” - 高稳定模板,“HIGH_PERFORMANCE” - 高性能模板,默认值是:“HIGH_STABILITY”。

  • AlarmPolicyIdList:

    告警策略名数组,例如:,AlarmPolicyList不为空时该参数无效。

  • DryRun:

    是否只预检此次请求。true:发送检查请求,不会创建实例。检查项包括是否填写了必需参数,请求格式,业务限制等。如果检查不通过,则返回对应错误码;如果检查通过,则返回RequestId.默认为false:发送正常请求,通过检查后直接创建实例。

  • EngineType:

    实例引擎类型,默认为“InnoDB”,支持值包括:“InnoDB”,“RocksDB”。

  • Vips:

    指定实例的IP列表。仅支持主实例指定,按实例顺序,不足则按未指定处理。

  • DataProtectVolume:

    云盘版实例的数据保护空间大小,单位 GB,设置范围1 - 10。

  • ClusterTopology:

    云盘版节点拓扑配置。

  • DiskType:

    硬盘类型,单节点(云盘)或者云盘版实例可以指定此参数。CLOUD_SSD 表示 SSD 云硬盘,CLOUD_HSSD 表示增强型 SSD 云硬盘,CLOUD_PREMIUM 表示高性能云硬盘。

  • ClusterType:

    集群类型:cage——金融围拢,cdc——CDB ON CDC;dedicate——独享集群

  • DestroyProtect:

    开启或关闭实例销毁保护。on-开启,off-关闭



3169
3170
3171
# File 'lib/v20170320/models.rb', line 3169

def DataProtectVolume
  @DataProtectVolume
end

#DeployGroupIdObject

说明:创建非云盘版实例时,请根据需要指定实例版本(推荐5.7或8.0),若此参数不填,则默认值为8.0;若创建的是云盘版实例,则此参数仅能指定为5.7或8.0。说明:如果创建的是云盘版实例,此参数为必填且为私有网络类型。若此项不填,则系统会选择默认的 VPC。说明:若此项不填,则系统会选择默认 VPC 下的默认子网。说明:若您创建单节点、双节点、三节点实例,此参数为必填项,请指定可用区,若不指定可用区,则系统会自动选择一个可用区(可能不是您希望部署的可用区);若您创建云盘版实例,此参数不填,请通过参数 ClusterTopology 进行读写节点和只读节点的可用区配置。说明:请选择实例类型,不填会默认选择 master。说明:不填则默认为3306。说明:表名大小写敏感的开启和关闭可通过参数 lower_case_table_names 进行设置,参数值为0表示开启,参数值为1表示关闭,若不设置则此参数默认值为0。若您创建的是 MySQL 8.0 版本的实例,则需要在创建实例时通过设置 lower_case_table_names 参数来开启或关闭表名大小写敏感,创建实例后无法修改参数,即创建后无法修改表名大小写敏感。其他数据库版本的实例支持在创建实例后修改 lower_case_table_names 参数。创建实例时设置表名大小写敏感的 API 调用方法请参见本文中的示例2。说明:双节点、三节点实例请指定此参数值,若不指定,则默认为 Zone 的值;云盘版实例此参数可不填,请通过参数 ClusterTopology 进行读写节点和只读节点的可用区配置;单节点实例为单可用区,无需指定此参数。说明:如果创建的是云盘版实例,此参数为必填。备注:如您使用自定义参数模板 id,可传入自定义参数模板 id;如您计划使用默认参数模板,该参数模板 id 传入 id 无效,需设置 ParamTemplateType。备注:如您需使用云数据库 MySQL 默认参数模板,请设置 ParamTemplateType。说明:若购买的是云盘版实例,此参数为必填,需设置云盘版实例的 RW 和 RO 节点拓扑,RO 节点范围是1 - 5个,请至少设置1个 RO 节点。说明:单节点(云盘)、云盘版实例硬盘类型所支持的地域略有不同,具体支持情况请参考 [地域和可用区](cloud.tencent.com/document/product/236/8458)。

Parameters:

  • GoodsNum:

    实例数量,默认值为 1,最小值 1,最大值为 100。

  • Memory:

    实例内存大小,单位:MB,请使用 [获取云数据库可售卖规格](cloud.tencent.com/document/api/236/17229) 接口获取可创建的内存规格。

  • Volume:

    实例硬盘大小,单位:GB,请使用 [获取云数据库可售卖规格](cloud.tencent.com/document/api/236/17229) 接口获取可创建的硬盘范围。

  • EngineVersion:

    MySQL 版本,值包括:5.5、5.6、5.7和8.0,请使用 [获取云数据库可售卖规格](cloud.tencent.com/document/api/236/17229) 接口获取可创建的实例版本。

  • UniqVpcId:

    私有网络 ID,请使用 [查询私有网络列表](/document/api/215/15778)。

  • UniqSubnetId:

    私有网络下的子网 ID,如果设置了 UniqVpcId,则 UniqSubnetId 必填,请使用 [查询子网列表](/document/api/215/15784)。

  • ProjectId:

    项目 ID,不填为默认项目。

  • Zone:

    可用区信息,请使用 [获取云数据库可售卖规格](cloud.tencent.com/document/api/236/17229) 接口获取可创建的可用区。

  • MasterInstanceId:

    实例 ID,购买只读实例或者灾备实例时必填,该字段表示只读实例或者灾备实例的主实例 ID,请使用 [查询实例列表](cloud.tencent.com/document/api/236/15872) 接口查询云数据库实例 ID。

  • InstanceRole:

    实例类型,支持值包括:master - 表示主实例,dr - 表示灾备实例,ro - 表示只读实例。

  • MasterRegion:

    主实例地域信息,购买灾备、RO实例时,该字段必填。

  • Port:

    自定义端口,端口支持范围:[1024 - 65535]。

  • Password:

    设置 root 账号密码,密码规则:8 - 64 个字符,至少包含字母、数字、字符(支持的字符:_+-&=!@#$%^*())中的两种,购买主实例时可指定该参数,购买只读实例或者灾备实例时指定该参数无意义。

  • ParamList:

    参数列表,参数格式如 ParamList.0.Name=auto_increment&ParamList.0.Value=1。可通过 [查询默认的可设置参数列表](cloud.tencent.com/document/api/236/32662) 查询支持设置的参数。

  • ProtectMode:

    数据复制方式,默认为 0,支持值包括:0 - 表示异步复制,1 - 表示半同步复制,2 - 表示强同步复制,购买主实例时可指定该参数,购买只读实例或者灾备实例时指定该参数无意义。

  • DeployMode:

    多可用区域,默认为 0,支持值包括:0 - 表示单可用区,1 - 表示多可用区,购买主实例时可指定该参数,购买只读实例或者灾备实例时指定该参数无意义。

  • SlaveZone:

    备库 1 的可用区信息。

  • BackupZone:

    备库 2 的可用区信息,默认为空,购买三节点主实例时可指定该参数。

  • SecurityGroup:

    安全组参数,可使用 [查询项目安全组信息](cloud.tencent.com/document/api/236/15850) 接口查询某个项目的安全组详情。

  • RoGroup:

    只读实例信息。购买只读实例时,该参数必传。

  • AutoRenewFlag:

    购买按量计费实例该字段无意义。

  • InstanceName:

    实例名称。一次购买多个实例命名会用后缀数字区分,例instanceName=db,goodsNum=3,实例命名分别为db1,db2,db3。

  • ResourceTags:

    实例标签信息。

  • DeployGroupId:

    置放群组 ID。

  • ClientToken:

    用于保证请求幂等性的字符串。该字符串由客户生成,需保证不同请求之间在48小时内唯一,最大值不超过64个ASCII字符。若不指定该参数,则无法保证请求的幂等性。

  • DeviceType:

    实例隔离类型。支持值包括:“UNIVERSAL” - 通用型实例,“EXCLUSIVE” - 独享型实例,“BASIC_V2” - ONTKE 单节点实例,“CLOUD_NATIVE_CLUSTER” - 云盘版标准型,“CLOUD_NATIVE_CLUSTER_EXCLUSIVE” - 云盘版加强型。不指定则默认为通用型实例。

  • ParamTemplateId:

    参数模板 id。

  • AlarmPolicyList:

    告警策略id数组。腾讯云可观测平台DescribeAlarmPolicy接口返回的OriginId。

  • InstanceNodes:

    实例节点数。对于 RO 和 基础版实例, 该值默认为1。 如果需要购买三节点实例, 请将该值设置为3 或指定 BackupZone 参数。当购买主实例,且未指定该参数和 BackupZone 参数时,该值默认是 2, 即购买两节点实例。

  • Cpu:

    实例cpu核数, 如果不传将根据memory指定的内存值自动填充对应的cpu值。

  • AutoSyncFlag:

    是否自动发起灾备同步功能。该参数仅对购买灾备实例生效。 可选值为:0 - 不自动发起灾备同步;1 - 自动发起灾备同步。该值默认为0。

  • CageId:

    金融围拢 ID 。

  • ParamTemplateType:

    默认参数模板类型。支持值包括:“HIGH_STABILITY” - 高稳定模板,“HIGH_PERFORMANCE” - 高性能模板,默认值是:“HIGH_STABILITY”。

  • AlarmPolicyIdList:

    告警策略名数组,例如:,AlarmPolicyList不为空时该参数无效。

  • DryRun:

    是否只预检此次请求。true:发送检查请求,不会创建实例。检查项包括是否填写了必需参数,请求格式,业务限制等。如果检查不通过,则返回对应错误码;如果检查通过,则返回RequestId.默认为false:发送正常请求,通过检查后直接创建实例。

  • EngineType:

    实例引擎类型,默认为“InnoDB”,支持值包括:“InnoDB”,“RocksDB”。

  • Vips:

    指定实例的IP列表。仅支持主实例指定,按实例顺序,不足则按未指定处理。

  • DataProtectVolume:

    云盘版实例的数据保护空间大小,单位 GB,设置范围1 - 10。

  • ClusterTopology:

    云盘版节点拓扑配置。

  • DiskType:

    硬盘类型,单节点(云盘)或者云盘版实例可以指定此参数。CLOUD_SSD 表示 SSD 云硬盘,CLOUD_HSSD 表示增强型 SSD 云硬盘,CLOUD_PREMIUM 表示高性能云硬盘。

  • ClusterType:

    集群类型:cage——金融围拢,cdc——CDB ON CDC;dedicate——独享集群

  • DestroyProtect:

    开启或关闭实例销毁保护。on-开启,off-关闭



3169
3170
3171
# File 'lib/v20170320/models.rb', line 3169

def DeployGroupId
  @DeployGroupId
end

#DeployModeObject

说明:创建非云盘版实例时,请根据需要指定实例版本(推荐5.7或8.0),若此参数不填,则默认值为8.0;若创建的是云盘版实例,则此参数仅能指定为5.7或8.0。说明:如果创建的是云盘版实例,此参数为必填且为私有网络类型。若此项不填,则系统会选择默认的 VPC。说明:若此项不填,则系统会选择默认 VPC 下的默认子网。说明:若您创建单节点、双节点、三节点实例,此参数为必填项,请指定可用区,若不指定可用区,则系统会自动选择一个可用区(可能不是您希望部署的可用区);若您创建云盘版实例,此参数不填,请通过参数 ClusterTopology 进行读写节点和只读节点的可用区配置。说明:请选择实例类型,不填会默认选择 master。说明:不填则默认为3306。说明:表名大小写敏感的开启和关闭可通过参数 lower_case_table_names 进行设置,参数值为0表示开启,参数值为1表示关闭,若不设置则此参数默认值为0。若您创建的是 MySQL 8.0 版本的实例,则需要在创建实例时通过设置 lower_case_table_names 参数来开启或关闭表名大小写敏感,创建实例后无法修改参数,即创建后无法修改表名大小写敏感。其他数据库版本的实例支持在创建实例后修改 lower_case_table_names 参数。创建实例时设置表名大小写敏感的 API 调用方法请参见本文中的示例2。说明:双节点、三节点实例请指定此参数值,若不指定,则默认为 Zone 的值;云盘版实例此参数可不填,请通过参数 ClusterTopology 进行读写节点和只读节点的可用区配置;单节点实例为单可用区,无需指定此参数。说明:如果创建的是云盘版实例,此参数为必填。备注:如您使用自定义参数模板 id,可传入自定义参数模板 id;如您计划使用默认参数模板,该参数模板 id 传入 id 无效,需设置 ParamTemplateType。备注:如您需使用云数据库 MySQL 默认参数模板,请设置 ParamTemplateType。说明:若购买的是云盘版实例,此参数为必填,需设置云盘版实例的 RW 和 RO 节点拓扑,RO 节点范围是1 - 5个,请至少设置1个 RO 节点。说明:单节点(云盘)、云盘版实例硬盘类型所支持的地域略有不同,具体支持情况请参考 [地域和可用区](cloud.tencent.com/document/product/236/8458)。

Parameters:

  • GoodsNum:

    实例数量,默认值为 1,最小值 1,最大值为 100。

  • Memory:

    实例内存大小,单位:MB,请使用 [获取云数据库可售卖规格](cloud.tencent.com/document/api/236/17229) 接口获取可创建的内存规格。

  • Volume:

    实例硬盘大小,单位:GB,请使用 [获取云数据库可售卖规格](cloud.tencent.com/document/api/236/17229) 接口获取可创建的硬盘范围。

  • EngineVersion:

    MySQL 版本,值包括:5.5、5.6、5.7和8.0,请使用 [获取云数据库可售卖规格](cloud.tencent.com/document/api/236/17229) 接口获取可创建的实例版本。

  • UniqVpcId:

    私有网络 ID,请使用 [查询私有网络列表](/document/api/215/15778)。

  • UniqSubnetId:

    私有网络下的子网 ID,如果设置了 UniqVpcId,则 UniqSubnetId 必填,请使用 [查询子网列表](/document/api/215/15784)。

  • ProjectId:

    项目 ID,不填为默认项目。

  • Zone:

    可用区信息,请使用 [获取云数据库可售卖规格](cloud.tencent.com/document/api/236/17229) 接口获取可创建的可用区。

  • MasterInstanceId:

    实例 ID,购买只读实例或者灾备实例时必填,该字段表示只读实例或者灾备实例的主实例 ID,请使用 [查询实例列表](cloud.tencent.com/document/api/236/15872) 接口查询云数据库实例 ID。

  • InstanceRole:

    实例类型,支持值包括:master - 表示主实例,dr - 表示灾备实例,ro - 表示只读实例。

  • MasterRegion:

    主实例地域信息,购买灾备、RO实例时,该字段必填。

  • Port:

    自定义端口,端口支持范围:[1024 - 65535]。

  • Password:

    设置 root 账号密码,密码规则:8 - 64 个字符,至少包含字母、数字、字符(支持的字符:_+-&=!@#$%^*())中的两种,购买主实例时可指定该参数,购买只读实例或者灾备实例时指定该参数无意义。

  • ParamList:

    参数列表,参数格式如 ParamList.0.Name=auto_increment&ParamList.0.Value=1。可通过 [查询默认的可设置参数列表](cloud.tencent.com/document/api/236/32662) 查询支持设置的参数。

  • ProtectMode:

    数据复制方式,默认为 0,支持值包括:0 - 表示异步复制,1 - 表示半同步复制,2 - 表示强同步复制,购买主实例时可指定该参数,购买只读实例或者灾备实例时指定该参数无意义。

  • DeployMode:

    多可用区域,默认为 0,支持值包括:0 - 表示单可用区,1 - 表示多可用区,购买主实例时可指定该参数,购买只读实例或者灾备实例时指定该参数无意义。

  • SlaveZone:

    备库 1 的可用区信息。

  • BackupZone:

    备库 2 的可用区信息,默认为空,购买三节点主实例时可指定该参数。

  • SecurityGroup:

    安全组参数,可使用 [查询项目安全组信息](cloud.tencent.com/document/api/236/15850) 接口查询某个项目的安全组详情。

  • RoGroup:

    只读实例信息。购买只读实例时,该参数必传。

  • AutoRenewFlag:

    购买按量计费实例该字段无意义。

  • InstanceName:

    实例名称。一次购买多个实例命名会用后缀数字区分,例instanceName=db,goodsNum=3,实例命名分别为db1,db2,db3。

  • ResourceTags:

    实例标签信息。

  • DeployGroupId:

    置放群组 ID。

  • ClientToken:

    用于保证请求幂等性的字符串。该字符串由客户生成,需保证不同请求之间在48小时内唯一,最大值不超过64个ASCII字符。若不指定该参数,则无法保证请求的幂等性。

  • DeviceType:

    实例隔离类型。支持值包括:“UNIVERSAL” - 通用型实例,“EXCLUSIVE” - 独享型实例,“BASIC_V2” - ONTKE 单节点实例,“CLOUD_NATIVE_CLUSTER” - 云盘版标准型,“CLOUD_NATIVE_CLUSTER_EXCLUSIVE” - 云盘版加强型。不指定则默认为通用型实例。

  • ParamTemplateId:

    参数模板 id。

  • AlarmPolicyList:

    告警策略id数组。腾讯云可观测平台DescribeAlarmPolicy接口返回的OriginId。

  • InstanceNodes:

    实例节点数。对于 RO 和 基础版实例, 该值默认为1。 如果需要购买三节点实例, 请将该值设置为3 或指定 BackupZone 参数。当购买主实例,且未指定该参数和 BackupZone 参数时,该值默认是 2, 即购买两节点实例。

  • Cpu:

    实例cpu核数, 如果不传将根据memory指定的内存值自动填充对应的cpu值。

  • AutoSyncFlag:

    是否自动发起灾备同步功能。该参数仅对购买灾备实例生效。 可选值为:0 - 不自动发起灾备同步;1 - 自动发起灾备同步。该值默认为0。

  • CageId:

    金融围拢 ID 。

  • ParamTemplateType:

    默认参数模板类型。支持值包括:“HIGH_STABILITY” - 高稳定模板,“HIGH_PERFORMANCE” - 高性能模板,默认值是:“HIGH_STABILITY”。

  • AlarmPolicyIdList:

    告警策略名数组,例如:,AlarmPolicyList不为空时该参数无效。

  • DryRun:

    是否只预检此次请求。true:发送检查请求,不会创建实例。检查项包括是否填写了必需参数,请求格式,业务限制等。如果检查不通过,则返回对应错误码;如果检查通过,则返回RequestId.默认为false:发送正常请求,通过检查后直接创建实例。

  • EngineType:

    实例引擎类型,默认为“InnoDB”,支持值包括:“InnoDB”,“RocksDB”。

  • Vips:

    指定实例的IP列表。仅支持主实例指定,按实例顺序,不足则按未指定处理。

  • DataProtectVolume:

    云盘版实例的数据保护空间大小,单位 GB,设置范围1 - 10。

  • ClusterTopology:

    云盘版节点拓扑配置。

  • DiskType:

    硬盘类型,单节点(云盘)或者云盘版实例可以指定此参数。CLOUD_SSD 表示 SSD 云硬盘,CLOUD_HSSD 表示增强型 SSD 云硬盘,CLOUD_PREMIUM 表示高性能云硬盘。

  • ClusterType:

    集群类型:cage——金融围拢,cdc——CDB ON CDC;dedicate——独享集群

  • DestroyProtect:

    开启或关闭实例销毁保护。on-开启,off-关闭



3169
3170
3171
# File 'lib/v20170320/models.rb', line 3169

def DeployMode
  @DeployMode
end

#DestroyProtectObject

说明:创建非云盘版实例时,请根据需要指定实例版本(推荐5.7或8.0),若此参数不填,则默认值为8.0;若创建的是云盘版实例,则此参数仅能指定为5.7或8.0。说明:如果创建的是云盘版实例,此参数为必填且为私有网络类型。若此项不填,则系统会选择默认的 VPC。说明:若此项不填,则系统会选择默认 VPC 下的默认子网。说明:若您创建单节点、双节点、三节点实例,此参数为必填项,请指定可用区,若不指定可用区,则系统会自动选择一个可用区(可能不是您希望部署的可用区);若您创建云盘版实例,此参数不填,请通过参数 ClusterTopology 进行读写节点和只读节点的可用区配置。说明:请选择实例类型,不填会默认选择 master。说明:不填则默认为3306。说明:表名大小写敏感的开启和关闭可通过参数 lower_case_table_names 进行设置,参数值为0表示开启,参数值为1表示关闭,若不设置则此参数默认值为0。若您创建的是 MySQL 8.0 版本的实例,则需要在创建实例时通过设置 lower_case_table_names 参数来开启或关闭表名大小写敏感,创建实例后无法修改参数,即创建后无法修改表名大小写敏感。其他数据库版本的实例支持在创建实例后修改 lower_case_table_names 参数。创建实例时设置表名大小写敏感的 API 调用方法请参见本文中的示例2。说明:双节点、三节点实例请指定此参数值,若不指定,则默认为 Zone 的值;云盘版实例此参数可不填,请通过参数 ClusterTopology 进行读写节点和只读节点的可用区配置;单节点实例为单可用区,无需指定此参数。说明:如果创建的是云盘版实例,此参数为必填。备注:如您使用自定义参数模板 id,可传入自定义参数模板 id;如您计划使用默认参数模板,该参数模板 id 传入 id 无效,需设置 ParamTemplateType。备注:如您需使用云数据库 MySQL 默认参数模板,请设置 ParamTemplateType。说明:若购买的是云盘版实例,此参数为必填,需设置云盘版实例的 RW 和 RO 节点拓扑,RO 节点范围是1 - 5个,请至少设置1个 RO 节点。说明:单节点(云盘)、云盘版实例硬盘类型所支持的地域略有不同,具体支持情况请参考 [地域和可用区](cloud.tencent.com/document/product/236/8458)。

Parameters:

  • GoodsNum:

    实例数量,默认值为 1,最小值 1,最大值为 100。

  • Memory:

    实例内存大小,单位:MB,请使用 [获取云数据库可售卖规格](cloud.tencent.com/document/api/236/17229) 接口获取可创建的内存规格。

  • Volume:

    实例硬盘大小,单位:GB,请使用 [获取云数据库可售卖规格](cloud.tencent.com/document/api/236/17229) 接口获取可创建的硬盘范围。

  • EngineVersion:

    MySQL 版本,值包括:5.5、5.6、5.7和8.0,请使用 [获取云数据库可售卖规格](cloud.tencent.com/document/api/236/17229) 接口获取可创建的实例版本。

  • UniqVpcId:

    私有网络 ID,请使用 [查询私有网络列表](/document/api/215/15778)。

  • UniqSubnetId:

    私有网络下的子网 ID,如果设置了 UniqVpcId,则 UniqSubnetId 必填,请使用 [查询子网列表](/document/api/215/15784)。

  • ProjectId:

    项目 ID,不填为默认项目。

  • Zone:

    可用区信息,请使用 [获取云数据库可售卖规格](cloud.tencent.com/document/api/236/17229) 接口获取可创建的可用区。

  • MasterInstanceId:

    实例 ID,购买只读实例或者灾备实例时必填,该字段表示只读实例或者灾备实例的主实例 ID,请使用 [查询实例列表](cloud.tencent.com/document/api/236/15872) 接口查询云数据库实例 ID。

  • InstanceRole:

    实例类型,支持值包括:master - 表示主实例,dr - 表示灾备实例,ro - 表示只读实例。

  • MasterRegion:

    主实例地域信息,购买灾备、RO实例时,该字段必填。

  • Port:

    自定义端口,端口支持范围:[1024 - 65535]。

  • Password:

    设置 root 账号密码,密码规则:8 - 64 个字符,至少包含字母、数字、字符(支持的字符:_+-&=!@#$%^*())中的两种,购买主实例时可指定该参数,购买只读实例或者灾备实例时指定该参数无意义。

  • ParamList:

    参数列表,参数格式如 ParamList.0.Name=auto_increment&ParamList.0.Value=1。可通过 [查询默认的可设置参数列表](cloud.tencent.com/document/api/236/32662) 查询支持设置的参数。

  • ProtectMode:

    数据复制方式,默认为 0,支持值包括:0 - 表示异步复制,1 - 表示半同步复制,2 - 表示强同步复制,购买主实例时可指定该参数,购买只读实例或者灾备实例时指定该参数无意义。

  • DeployMode:

    多可用区域,默认为 0,支持值包括:0 - 表示单可用区,1 - 表示多可用区,购买主实例时可指定该参数,购买只读实例或者灾备实例时指定该参数无意义。

  • SlaveZone:

    备库 1 的可用区信息。

  • BackupZone:

    备库 2 的可用区信息,默认为空,购买三节点主实例时可指定该参数。

  • SecurityGroup:

    安全组参数,可使用 [查询项目安全组信息](cloud.tencent.com/document/api/236/15850) 接口查询某个项目的安全组详情。

  • RoGroup:

    只读实例信息。购买只读实例时,该参数必传。

  • AutoRenewFlag:

    购买按量计费实例该字段无意义。

  • InstanceName:

    实例名称。一次购买多个实例命名会用后缀数字区分,例instanceName=db,goodsNum=3,实例命名分别为db1,db2,db3。

  • ResourceTags:

    实例标签信息。

  • DeployGroupId:

    置放群组 ID。

  • ClientToken:

    用于保证请求幂等性的字符串。该字符串由客户生成,需保证不同请求之间在48小时内唯一,最大值不超过64个ASCII字符。若不指定该参数,则无法保证请求的幂等性。

  • DeviceType:

    实例隔离类型。支持值包括:“UNIVERSAL” - 通用型实例,“EXCLUSIVE” - 独享型实例,“BASIC_V2” - ONTKE 单节点实例,“CLOUD_NATIVE_CLUSTER” - 云盘版标准型,“CLOUD_NATIVE_CLUSTER_EXCLUSIVE” - 云盘版加强型。不指定则默认为通用型实例。

  • ParamTemplateId:

    参数模板 id。

  • AlarmPolicyList:

    告警策略id数组。腾讯云可观测平台DescribeAlarmPolicy接口返回的OriginId。

  • InstanceNodes:

    实例节点数。对于 RO 和 基础版实例, 该值默认为1。 如果需要购买三节点实例, 请将该值设置为3 或指定 BackupZone 参数。当购买主实例,且未指定该参数和 BackupZone 参数时,该值默认是 2, 即购买两节点实例。

  • Cpu:

    实例cpu核数, 如果不传将根据memory指定的内存值自动填充对应的cpu值。

  • AutoSyncFlag:

    是否自动发起灾备同步功能。该参数仅对购买灾备实例生效。 可选值为:0 - 不自动发起灾备同步;1 - 自动发起灾备同步。该值默认为0。

  • CageId:

    金融围拢 ID 。

  • ParamTemplateType:

    默认参数模板类型。支持值包括:“HIGH_STABILITY” - 高稳定模板,“HIGH_PERFORMANCE” - 高性能模板,默认值是:“HIGH_STABILITY”。

  • AlarmPolicyIdList:

    告警策略名数组,例如:,AlarmPolicyList不为空时该参数无效。

  • DryRun:

    是否只预检此次请求。true:发送检查请求,不会创建实例。检查项包括是否填写了必需参数,请求格式,业务限制等。如果检查不通过,则返回对应错误码;如果检查通过,则返回RequestId.默认为false:发送正常请求,通过检查后直接创建实例。

  • EngineType:

    实例引擎类型,默认为“InnoDB”,支持值包括:“InnoDB”,“RocksDB”。

  • Vips:

    指定实例的IP列表。仅支持主实例指定,按实例顺序,不足则按未指定处理。

  • DataProtectVolume:

    云盘版实例的数据保护空间大小,单位 GB,设置范围1 - 10。

  • ClusterTopology:

    云盘版节点拓扑配置。

  • DiskType:

    硬盘类型,单节点(云盘)或者云盘版实例可以指定此参数。CLOUD_SSD 表示 SSD 云硬盘,CLOUD_HSSD 表示增强型 SSD 云硬盘,CLOUD_PREMIUM 表示高性能云硬盘。

  • ClusterType:

    集群类型:cage——金融围拢,cdc——CDB ON CDC;dedicate——独享集群

  • DestroyProtect:

    开启或关闭实例销毁保护。on-开启,off-关闭



3169
3170
3171
# File 'lib/v20170320/models.rb', line 3169

def DestroyProtect
  @DestroyProtect
end

#DeviceTypeObject

说明:创建非云盘版实例时,请根据需要指定实例版本(推荐5.7或8.0),若此参数不填,则默认值为8.0;若创建的是云盘版实例,则此参数仅能指定为5.7或8.0。说明:如果创建的是云盘版实例,此参数为必填且为私有网络类型。若此项不填,则系统会选择默认的 VPC。说明:若此项不填,则系统会选择默认 VPC 下的默认子网。说明:若您创建单节点、双节点、三节点实例,此参数为必填项,请指定可用区,若不指定可用区,则系统会自动选择一个可用区(可能不是您希望部署的可用区);若您创建云盘版实例,此参数不填,请通过参数 ClusterTopology 进行读写节点和只读节点的可用区配置。说明:请选择实例类型,不填会默认选择 master。说明:不填则默认为3306。说明:表名大小写敏感的开启和关闭可通过参数 lower_case_table_names 进行设置,参数值为0表示开启,参数值为1表示关闭,若不设置则此参数默认值为0。若您创建的是 MySQL 8.0 版本的实例,则需要在创建实例时通过设置 lower_case_table_names 参数来开启或关闭表名大小写敏感,创建实例后无法修改参数,即创建后无法修改表名大小写敏感。其他数据库版本的实例支持在创建实例后修改 lower_case_table_names 参数。创建实例时设置表名大小写敏感的 API 调用方法请参见本文中的示例2。说明:双节点、三节点实例请指定此参数值,若不指定,则默认为 Zone 的值;云盘版实例此参数可不填,请通过参数 ClusterTopology 进行读写节点和只读节点的可用区配置;单节点实例为单可用区,无需指定此参数。说明:如果创建的是云盘版实例,此参数为必填。备注:如您使用自定义参数模板 id,可传入自定义参数模板 id;如您计划使用默认参数模板,该参数模板 id 传入 id 无效,需设置 ParamTemplateType。备注:如您需使用云数据库 MySQL 默认参数模板,请设置 ParamTemplateType。说明:若购买的是云盘版实例,此参数为必填,需设置云盘版实例的 RW 和 RO 节点拓扑,RO 节点范围是1 - 5个,请至少设置1个 RO 节点。说明:单节点(云盘)、云盘版实例硬盘类型所支持的地域略有不同,具体支持情况请参考 [地域和可用区](cloud.tencent.com/document/product/236/8458)。

Parameters:

  • GoodsNum:

    实例数量,默认值为 1,最小值 1,最大值为 100。

  • Memory:

    实例内存大小,单位:MB,请使用 [获取云数据库可售卖规格](cloud.tencent.com/document/api/236/17229) 接口获取可创建的内存规格。

  • Volume:

    实例硬盘大小,单位:GB,请使用 [获取云数据库可售卖规格](cloud.tencent.com/document/api/236/17229) 接口获取可创建的硬盘范围。

  • EngineVersion:

    MySQL 版本,值包括:5.5、5.6、5.7和8.0,请使用 [获取云数据库可售卖规格](cloud.tencent.com/document/api/236/17229) 接口获取可创建的实例版本。

  • UniqVpcId:

    私有网络 ID,请使用 [查询私有网络列表](/document/api/215/15778)。

  • UniqSubnetId:

    私有网络下的子网 ID,如果设置了 UniqVpcId,则 UniqSubnetId 必填,请使用 [查询子网列表](/document/api/215/15784)。

  • ProjectId:

    项目 ID,不填为默认项目。

  • Zone:

    可用区信息,请使用 [获取云数据库可售卖规格](cloud.tencent.com/document/api/236/17229) 接口获取可创建的可用区。

  • MasterInstanceId:

    实例 ID,购买只读实例或者灾备实例时必填,该字段表示只读实例或者灾备实例的主实例 ID,请使用 [查询实例列表](cloud.tencent.com/document/api/236/15872) 接口查询云数据库实例 ID。

  • InstanceRole:

    实例类型,支持值包括:master - 表示主实例,dr - 表示灾备实例,ro - 表示只读实例。

  • MasterRegion:

    主实例地域信息,购买灾备、RO实例时,该字段必填。

  • Port:

    自定义端口,端口支持范围:[1024 - 65535]。

  • Password:

    设置 root 账号密码,密码规则:8 - 64 个字符,至少包含字母、数字、字符(支持的字符:_+-&=!@#$%^*())中的两种,购买主实例时可指定该参数,购买只读实例或者灾备实例时指定该参数无意义。

  • ParamList:

    参数列表,参数格式如 ParamList.0.Name=auto_increment&ParamList.0.Value=1。可通过 [查询默认的可设置参数列表](cloud.tencent.com/document/api/236/32662) 查询支持设置的参数。

  • ProtectMode:

    数据复制方式,默认为 0,支持值包括:0 - 表示异步复制,1 - 表示半同步复制,2 - 表示强同步复制,购买主实例时可指定该参数,购买只读实例或者灾备实例时指定该参数无意义。

  • DeployMode:

    多可用区域,默认为 0,支持值包括:0 - 表示单可用区,1 - 表示多可用区,购买主实例时可指定该参数,购买只读实例或者灾备实例时指定该参数无意义。

  • SlaveZone:

    备库 1 的可用区信息。

  • BackupZone:

    备库 2 的可用区信息,默认为空,购买三节点主实例时可指定该参数。

  • SecurityGroup:

    安全组参数,可使用 [查询项目安全组信息](cloud.tencent.com/document/api/236/15850) 接口查询某个项目的安全组详情。

  • RoGroup:

    只读实例信息。购买只读实例时,该参数必传。

  • AutoRenewFlag:

    购买按量计费实例该字段无意义。

  • InstanceName:

    实例名称。一次购买多个实例命名会用后缀数字区分,例instanceName=db,goodsNum=3,实例命名分别为db1,db2,db3。

  • ResourceTags:

    实例标签信息。

  • DeployGroupId:

    置放群组 ID。

  • ClientToken:

    用于保证请求幂等性的字符串。该字符串由客户生成,需保证不同请求之间在48小时内唯一,最大值不超过64个ASCII字符。若不指定该参数,则无法保证请求的幂等性。

  • DeviceType:

    实例隔离类型。支持值包括:“UNIVERSAL” - 通用型实例,“EXCLUSIVE” - 独享型实例,“BASIC_V2” - ONTKE 单节点实例,“CLOUD_NATIVE_CLUSTER” - 云盘版标准型,“CLOUD_NATIVE_CLUSTER_EXCLUSIVE” - 云盘版加强型。不指定则默认为通用型实例。

  • ParamTemplateId:

    参数模板 id。

  • AlarmPolicyList:

    告警策略id数组。腾讯云可观测平台DescribeAlarmPolicy接口返回的OriginId。

  • InstanceNodes:

    实例节点数。对于 RO 和 基础版实例, 该值默认为1。 如果需要购买三节点实例, 请将该值设置为3 或指定 BackupZone 参数。当购买主实例,且未指定该参数和 BackupZone 参数时,该值默认是 2, 即购买两节点实例。

  • Cpu:

    实例cpu核数, 如果不传将根据memory指定的内存值自动填充对应的cpu值。

  • AutoSyncFlag:

    是否自动发起灾备同步功能。该参数仅对购买灾备实例生效。 可选值为:0 - 不自动发起灾备同步;1 - 自动发起灾备同步。该值默认为0。

  • CageId:

    金融围拢 ID 。

  • ParamTemplateType:

    默认参数模板类型。支持值包括:“HIGH_STABILITY” - 高稳定模板,“HIGH_PERFORMANCE” - 高性能模板,默认值是:“HIGH_STABILITY”。

  • AlarmPolicyIdList:

    告警策略名数组,例如:,AlarmPolicyList不为空时该参数无效。

  • DryRun:

    是否只预检此次请求。true:发送检查请求,不会创建实例。检查项包括是否填写了必需参数,请求格式,业务限制等。如果检查不通过,则返回对应错误码;如果检查通过,则返回RequestId.默认为false:发送正常请求,通过检查后直接创建实例。

  • EngineType:

    实例引擎类型,默认为“InnoDB”,支持值包括:“InnoDB”,“RocksDB”。

  • Vips:

    指定实例的IP列表。仅支持主实例指定,按实例顺序,不足则按未指定处理。

  • DataProtectVolume:

    云盘版实例的数据保护空间大小,单位 GB,设置范围1 - 10。

  • ClusterTopology:

    云盘版节点拓扑配置。

  • DiskType:

    硬盘类型,单节点(云盘)或者云盘版实例可以指定此参数。CLOUD_SSD 表示 SSD 云硬盘,CLOUD_HSSD 表示增强型 SSD 云硬盘,CLOUD_PREMIUM 表示高性能云硬盘。

  • ClusterType:

    集群类型:cage——金融围拢,cdc——CDB ON CDC;dedicate——独享集群

  • DestroyProtect:

    开启或关闭实例销毁保护。on-开启,off-关闭



3169
3170
3171
# File 'lib/v20170320/models.rb', line 3169

def DeviceType
  @DeviceType
end

#DiskTypeObject

说明:创建非云盘版实例时,请根据需要指定实例版本(推荐5.7或8.0),若此参数不填,则默认值为8.0;若创建的是云盘版实例,则此参数仅能指定为5.7或8.0。说明:如果创建的是云盘版实例,此参数为必填且为私有网络类型。若此项不填,则系统会选择默认的 VPC。说明:若此项不填,则系统会选择默认 VPC 下的默认子网。说明:若您创建单节点、双节点、三节点实例,此参数为必填项,请指定可用区,若不指定可用区,则系统会自动选择一个可用区(可能不是您希望部署的可用区);若您创建云盘版实例,此参数不填,请通过参数 ClusterTopology 进行读写节点和只读节点的可用区配置。说明:请选择实例类型,不填会默认选择 master。说明:不填则默认为3306。说明:表名大小写敏感的开启和关闭可通过参数 lower_case_table_names 进行设置,参数值为0表示开启,参数值为1表示关闭,若不设置则此参数默认值为0。若您创建的是 MySQL 8.0 版本的实例,则需要在创建实例时通过设置 lower_case_table_names 参数来开启或关闭表名大小写敏感,创建实例后无法修改参数,即创建后无法修改表名大小写敏感。其他数据库版本的实例支持在创建实例后修改 lower_case_table_names 参数。创建实例时设置表名大小写敏感的 API 调用方法请参见本文中的示例2。说明:双节点、三节点实例请指定此参数值,若不指定,则默认为 Zone 的值;云盘版实例此参数可不填,请通过参数 ClusterTopology 进行读写节点和只读节点的可用区配置;单节点实例为单可用区,无需指定此参数。说明:如果创建的是云盘版实例,此参数为必填。备注:如您使用自定义参数模板 id,可传入自定义参数模板 id;如您计划使用默认参数模板,该参数模板 id 传入 id 无效,需设置 ParamTemplateType。备注:如您需使用云数据库 MySQL 默认参数模板,请设置 ParamTemplateType。说明:若购买的是云盘版实例,此参数为必填,需设置云盘版实例的 RW 和 RO 节点拓扑,RO 节点范围是1 - 5个,请至少设置1个 RO 节点。说明:单节点(云盘)、云盘版实例硬盘类型所支持的地域略有不同,具体支持情况请参考 [地域和可用区](cloud.tencent.com/document/product/236/8458)。

Parameters:

  • GoodsNum:

    实例数量,默认值为 1,最小值 1,最大值为 100。

  • Memory:

    实例内存大小,单位:MB,请使用 [获取云数据库可售卖规格](cloud.tencent.com/document/api/236/17229) 接口获取可创建的内存规格。

  • Volume:

    实例硬盘大小,单位:GB,请使用 [获取云数据库可售卖规格](cloud.tencent.com/document/api/236/17229) 接口获取可创建的硬盘范围。

  • EngineVersion:

    MySQL 版本,值包括:5.5、5.6、5.7和8.0,请使用 [获取云数据库可售卖规格](cloud.tencent.com/document/api/236/17229) 接口获取可创建的实例版本。

  • UniqVpcId:

    私有网络 ID,请使用 [查询私有网络列表](/document/api/215/15778)。

  • UniqSubnetId:

    私有网络下的子网 ID,如果设置了 UniqVpcId,则 UniqSubnetId 必填,请使用 [查询子网列表](/document/api/215/15784)。

  • ProjectId:

    项目 ID,不填为默认项目。

  • Zone:

    可用区信息,请使用 [获取云数据库可售卖规格](cloud.tencent.com/document/api/236/17229) 接口获取可创建的可用区。

  • MasterInstanceId:

    实例 ID,购买只读实例或者灾备实例时必填,该字段表示只读实例或者灾备实例的主实例 ID,请使用 [查询实例列表](cloud.tencent.com/document/api/236/15872) 接口查询云数据库实例 ID。

  • InstanceRole:

    实例类型,支持值包括:master - 表示主实例,dr - 表示灾备实例,ro - 表示只读实例。

  • MasterRegion:

    主实例地域信息,购买灾备、RO实例时,该字段必填。

  • Port:

    自定义端口,端口支持范围:[1024 - 65535]。

  • Password:

    设置 root 账号密码,密码规则:8 - 64 个字符,至少包含字母、数字、字符(支持的字符:_+-&=!@#$%^*())中的两种,购买主实例时可指定该参数,购买只读实例或者灾备实例时指定该参数无意义。

  • ParamList:

    参数列表,参数格式如 ParamList.0.Name=auto_increment&ParamList.0.Value=1。可通过 [查询默认的可设置参数列表](cloud.tencent.com/document/api/236/32662) 查询支持设置的参数。

  • ProtectMode:

    数据复制方式,默认为 0,支持值包括:0 - 表示异步复制,1 - 表示半同步复制,2 - 表示强同步复制,购买主实例时可指定该参数,购买只读实例或者灾备实例时指定该参数无意义。

  • DeployMode:

    多可用区域,默认为 0,支持值包括:0 - 表示单可用区,1 - 表示多可用区,购买主实例时可指定该参数,购买只读实例或者灾备实例时指定该参数无意义。

  • SlaveZone:

    备库 1 的可用区信息。

  • BackupZone:

    备库 2 的可用区信息,默认为空,购买三节点主实例时可指定该参数。

  • SecurityGroup:

    安全组参数,可使用 [查询项目安全组信息](cloud.tencent.com/document/api/236/15850) 接口查询某个项目的安全组详情。

  • RoGroup:

    只读实例信息。购买只读实例时,该参数必传。

  • AutoRenewFlag:

    购买按量计费实例该字段无意义。

  • InstanceName:

    实例名称。一次购买多个实例命名会用后缀数字区分,例instanceName=db,goodsNum=3,实例命名分别为db1,db2,db3。

  • ResourceTags:

    实例标签信息。

  • DeployGroupId:

    置放群组 ID。

  • ClientToken:

    用于保证请求幂等性的字符串。该字符串由客户生成,需保证不同请求之间在48小时内唯一,最大值不超过64个ASCII字符。若不指定该参数,则无法保证请求的幂等性。

  • DeviceType:

    实例隔离类型。支持值包括:“UNIVERSAL” - 通用型实例,“EXCLUSIVE” - 独享型实例,“BASIC_V2” - ONTKE 单节点实例,“CLOUD_NATIVE_CLUSTER” - 云盘版标准型,“CLOUD_NATIVE_CLUSTER_EXCLUSIVE” - 云盘版加强型。不指定则默认为通用型实例。

  • ParamTemplateId:

    参数模板 id。

  • AlarmPolicyList:

    告警策略id数组。腾讯云可观测平台DescribeAlarmPolicy接口返回的OriginId。

  • InstanceNodes:

    实例节点数。对于 RO 和 基础版实例, 该值默认为1。 如果需要购买三节点实例, 请将该值设置为3 或指定 BackupZone 参数。当购买主实例,且未指定该参数和 BackupZone 参数时,该值默认是 2, 即购买两节点实例。

  • Cpu:

    实例cpu核数, 如果不传将根据memory指定的内存值自动填充对应的cpu值。

  • AutoSyncFlag:

    是否自动发起灾备同步功能。该参数仅对购买灾备实例生效。 可选值为:0 - 不自动发起灾备同步;1 - 自动发起灾备同步。该值默认为0。

  • CageId:

    金融围拢 ID 。

  • ParamTemplateType:

    默认参数模板类型。支持值包括:“HIGH_STABILITY” - 高稳定模板,“HIGH_PERFORMANCE” - 高性能模板,默认值是:“HIGH_STABILITY”。

  • AlarmPolicyIdList:

    告警策略名数组,例如:,AlarmPolicyList不为空时该参数无效。

  • DryRun:

    是否只预检此次请求。true:发送检查请求,不会创建实例。检查项包括是否填写了必需参数,请求格式,业务限制等。如果检查不通过,则返回对应错误码;如果检查通过,则返回RequestId.默认为false:发送正常请求,通过检查后直接创建实例。

  • EngineType:

    实例引擎类型,默认为“InnoDB”,支持值包括:“InnoDB”,“RocksDB”。

  • Vips:

    指定实例的IP列表。仅支持主实例指定,按实例顺序,不足则按未指定处理。

  • DataProtectVolume:

    云盘版实例的数据保护空间大小,单位 GB,设置范围1 - 10。

  • ClusterTopology:

    云盘版节点拓扑配置。

  • DiskType:

    硬盘类型,单节点(云盘)或者云盘版实例可以指定此参数。CLOUD_SSD 表示 SSD 云硬盘,CLOUD_HSSD 表示增强型 SSD 云硬盘,CLOUD_PREMIUM 表示高性能云硬盘。

  • ClusterType:

    集群类型:cage——金融围拢,cdc——CDB ON CDC;dedicate——独享集群

  • DestroyProtect:

    开启或关闭实例销毁保护。on-开启,off-关闭



3169
3170
3171
# File 'lib/v20170320/models.rb', line 3169

def DiskType
  @DiskType
end

#DryRunObject

说明:创建非云盘版实例时,请根据需要指定实例版本(推荐5.7或8.0),若此参数不填,则默认值为8.0;若创建的是云盘版实例,则此参数仅能指定为5.7或8.0。说明:如果创建的是云盘版实例,此参数为必填且为私有网络类型。若此项不填,则系统会选择默认的 VPC。说明:若此项不填,则系统会选择默认 VPC 下的默认子网。说明:若您创建单节点、双节点、三节点实例,此参数为必填项,请指定可用区,若不指定可用区,则系统会自动选择一个可用区(可能不是您希望部署的可用区);若您创建云盘版实例,此参数不填,请通过参数 ClusterTopology 进行读写节点和只读节点的可用区配置。说明:请选择实例类型,不填会默认选择 master。说明:不填则默认为3306。说明:表名大小写敏感的开启和关闭可通过参数 lower_case_table_names 进行设置,参数值为0表示开启,参数值为1表示关闭,若不设置则此参数默认值为0。若您创建的是 MySQL 8.0 版本的实例,则需要在创建实例时通过设置 lower_case_table_names 参数来开启或关闭表名大小写敏感,创建实例后无法修改参数,即创建后无法修改表名大小写敏感。其他数据库版本的实例支持在创建实例后修改 lower_case_table_names 参数。创建实例时设置表名大小写敏感的 API 调用方法请参见本文中的示例2。说明:双节点、三节点实例请指定此参数值,若不指定,则默认为 Zone 的值;云盘版实例此参数可不填,请通过参数 ClusterTopology 进行读写节点和只读节点的可用区配置;单节点实例为单可用区,无需指定此参数。说明:如果创建的是云盘版实例,此参数为必填。备注:如您使用自定义参数模板 id,可传入自定义参数模板 id;如您计划使用默认参数模板,该参数模板 id 传入 id 无效,需设置 ParamTemplateType。备注:如您需使用云数据库 MySQL 默认参数模板,请设置 ParamTemplateType。说明:若购买的是云盘版实例,此参数为必填,需设置云盘版实例的 RW 和 RO 节点拓扑,RO 节点范围是1 - 5个,请至少设置1个 RO 节点。说明:单节点(云盘)、云盘版实例硬盘类型所支持的地域略有不同,具体支持情况请参考 [地域和可用区](cloud.tencent.com/document/product/236/8458)。

Parameters:

  • GoodsNum:

    实例数量,默认值为 1,最小值 1,最大值为 100。

  • Memory:

    实例内存大小,单位:MB,请使用 [获取云数据库可售卖规格](cloud.tencent.com/document/api/236/17229) 接口获取可创建的内存规格。

  • Volume:

    实例硬盘大小,单位:GB,请使用 [获取云数据库可售卖规格](cloud.tencent.com/document/api/236/17229) 接口获取可创建的硬盘范围。

  • EngineVersion:

    MySQL 版本,值包括:5.5、5.6、5.7和8.0,请使用 [获取云数据库可售卖规格](cloud.tencent.com/document/api/236/17229) 接口获取可创建的实例版本。

  • UniqVpcId:

    私有网络 ID,请使用 [查询私有网络列表](/document/api/215/15778)。

  • UniqSubnetId:

    私有网络下的子网 ID,如果设置了 UniqVpcId,则 UniqSubnetId 必填,请使用 [查询子网列表](/document/api/215/15784)。

  • ProjectId:

    项目 ID,不填为默认项目。

  • Zone:

    可用区信息,请使用 [获取云数据库可售卖规格](cloud.tencent.com/document/api/236/17229) 接口获取可创建的可用区。

  • MasterInstanceId:

    实例 ID,购买只读实例或者灾备实例时必填,该字段表示只读实例或者灾备实例的主实例 ID,请使用 [查询实例列表](cloud.tencent.com/document/api/236/15872) 接口查询云数据库实例 ID。

  • InstanceRole:

    实例类型,支持值包括:master - 表示主实例,dr - 表示灾备实例,ro - 表示只读实例。

  • MasterRegion:

    主实例地域信息,购买灾备、RO实例时,该字段必填。

  • Port:

    自定义端口,端口支持范围:[1024 - 65535]。

  • Password:

    设置 root 账号密码,密码规则:8 - 64 个字符,至少包含字母、数字、字符(支持的字符:_+-&=!@#$%^*())中的两种,购买主实例时可指定该参数,购买只读实例或者灾备实例时指定该参数无意义。

  • ParamList:

    参数列表,参数格式如 ParamList.0.Name=auto_increment&ParamList.0.Value=1。可通过 [查询默认的可设置参数列表](cloud.tencent.com/document/api/236/32662) 查询支持设置的参数。

  • ProtectMode:

    数据复制方式,默认为 0,支持值包括:0 - 表示异步复制,1 - 表示半同步复制,2 - 表示强同步复制,购买主实例时可指定该参数,购买只读实例或者灾备实例时指定该参数无意义。

  • DeployMode:

    多可用区域,默认为 0,支持值包括:0 - 表示单可用区,1 - 表示多可用区,购买主实例时可指定该参数,购买只读实例或者灾备实例时指定该参数无意义。

  • SlaveZone:

    备库 1 的可用区信息。

  • BackupZone:

    备库 2 的可用区信息,默认为空,购买三节点主实例时可指定该参数。

  • SecurityGroup:

    安全组参数,可使用 [查询项目安全组信息](cloud.tencent.com/document/api/236/15850) 接口查询某个项目的安全组详情。

  • RoGroup:

    只读实例信息。购买只读实例时,该参数必传。

  • AutoRenewFlag:

    购买按量计费实例该字段无意义。

  • InstanceName:

    实例名称。一次购买多个实例命名会用后缀数字区分,例instanceName=db,goodsNum=3,实例命名分别为db1,db2,db3。

  • ResourceTags:

    实例标签信息。

  • DeployGroupId:

    置放群组 ID。

  • ClientToken:

    用于保证请求幂等性的字符串。该字符串由客户生成,需保证不同请求之间在48小时内唯一,最大值不超过64个ASCII字符。若不指定该参数,则无法保证请求的幂等性。

  • DeviceType:

    实例隔离类型。支持值包括:“UNIVERSAL” - 通用型实例,“EXCLUSIVE” - 独享型实例,“BASIC_V2” - ONTKE 单节点实例,“CLOUD_NATIVE_CLUSTER” - 云盘版标准型,“CLOUD_NATIVE_CLUSTER_EXCLUSIVE” - 云盘版加强型。不指定则默认为通用型实例。

  • ParamTemplateId:

    参数模板 id。

  • AlarmPolicyList:

    告警策略id数组。腾讯云可观测平台DescribeAlarmPolicy接口返回的OriginId。

  • InstanceNodes:

    实例节点数。对于 RO 和 基础版实例, 该值默认为1。 如果需要购买三节点实例, 请将该值设置为3 或指定 BackupZone 参数。当购买主实例,且未指定该参数和 BackupZone 参数时,该值默认是 2, 即购买两节点实例。

  • Cpu:

    实例cpu核数, 如果不传将根据memory指定的内存值自动填充对应的cpu值。

  • AutoSyncFlag:

    是否自动发起灾备同步功能。该参数仅对购买灾备实例生效。 可选值为:0 - 不自动发起灾备同步;1 - 自动发起灾备同步。该值默认为0。

  • CageId:

    金融围拢 ID 。

  • ParamTemplateType:

    默认参数模板类型。支持值包括:“HIGH_STABILITY” - 高稳定模板,“HIGH_PERFORMANCE” - 高性能模板,默认值是:“HIGH_STABILITY”。

  • AlarmPolicyIdList:

    告警策略名数组,例如:,AlarmPolicyList不为空时该参数无效。

  • DryRun:

    是否只预检此次请求。true:发送检查请求,不会创建实例。检查项包括是否填写了必需参数,请求格式,业务限制等。如果检查不通过,则返回对应错误码;如果检查通过,则返回RequestId.默认为false:发送正常请求,通过检查后直接创建实例。

  • EngineType:

    实例引擎类型,默认为“InnoDB”,支持值包括:“InnoDB”,“RocksDB”。

  • Vips:

    指定实例的IP列表。仅支持主实例指定,按实例顺序,不足则按未指定处理。

  • DataProtectVolume:

    云盘版实例的数据保护空间大小,单位 GB,设置范围1 - 10。

  • ClusterTopology:

    云盘版节点拓扑配置。

  • DiskType:

    硬盘类型,单节点(云盘)或者云盘版实例可以指定此参数。CLOUD_SSD 表示 SSD 云硬盘,CLOUD_HSSD 表示增强型 SSD 云硬盘,CLOUD_PREMIUM 表示高性能云硬盘。

  • ClusterType:

    集群类型:cage——金融围拢,cdc——CDB ON CDC;dedicate——独享集群

  • DestroyProtect:

    开启或关闭实例销毁保护。on-开启,off-关闭



3169
3170
3171
# File 'lib/v20170320/models.rb', line 3169

def DryRun
  @DryRun
end

#EngineTypeObject

说明:创建非云盘版实例时,请根据需要指定实例版本(推荐5.7或8.0),若此参数不填,则默认值为8.0;若创建的是云盘版实例,则此参数仅能指定为5.7或8.0。说明:如果创建的是云盘版实例,此参数为必填且为私有网络类型。若此项不填,则系统会选择默认的 VPC。说明:若此项不填,则系统会选择默认 VPC 下的默认子网。说明:若您创建单节点、双节点、三节点实例,此参数为必填项,请指定可用区,若不指定可用区,则系统会自动选择一个可用区(可能不是您希望部署的可用区);若您创建云盘版实例,此参数不填,请通过参数 ClusterTopology 进行读写节点和只读节点的可用区配置。说明:请选择实例类型,不填会默认选择 master。说明:不填则默认为3306。说明:表名大小写敏感的开启和关闭可通过参数 lower_case_table_names 进行设置,参数值为0表示开启,参数值为1表示关闭,若不设置则此参数默认值为0。若您创建的是 MySQL 8.0 版本的实例,则需要在创建实例时通过设置 lower_case_table_names 参数来开启或关闭表名大小写敏感,创建实例后无法修改参数,即创建后无法修改表名大小写敏感。其他数据库版本的实例支持在创建实例后修改 lower_case_table_names 参数。创建实例时设置表名大小写敏感的 API 调用方法请参见本文中的示例2。说明:双节点、三节点实例请指定此参数值,若不指定,则默认为 Zone 的值;云盘版实例此参数可不填,请通过参数 ClusterTopology 进行读写节点和只读节点的可用区配置;单节点实例为单可用区,无需指定此参数。说明:如果创建的是云盘版实例,此参数为必填。备注:如您使用自定义参数模板 id,可传入自定义参数模板 id;如您计划使用默认参数模板,该参数模板 id 传入 id 无效,需设置 ParamTemplateType。备注:如您需使用云数据库 MySQL 默认参数模板,请设置 ParamTemplateType。说明:若购买的是云盘版实例,此参数为必填,需设置云盘版实例的 RW 和 RO 节点拓扑,RO 节点范围是1 - 5个,请至少设置1个 RO 节点。说明:单节点(云盘)、云盘版实例硬盘类型所支持的地域略有不同,具体支持情况请参考 [地域和可用区](cloud.tencent.com/document/product/236/8458)。

Parameters:

  • GoodsNum:

    实例数量,默认值为 1,最小值 1,最大值为 100。

  • Memory:

    实例内存大小,单位:MB,请使用 [获取云数据库可售卖规格](cloud.tencent.com/document/api/236/17229) 接口获取可创建的内存规格。

  • Volume:

    实例硬盘大小,单位:GB,请使用 [获取云数据库可售卖规格](cloud.tencent.com/document/api/236/17229) 接口获取可创建的硬盘范围。

  • EngineVersion:

    MySQL 版本,值包括:5.5、5.6、5.7和8.0,请使用 [获取云数据库可售卖规格](cloud.tencent.com/document/api/236/17229) 接口获取可创建的实例版本。

  • UniqVpcId:

    私有网络 ID,请使用 [查询私有网络列表](/document/api/215/15778)。

  • UniqSubnetId:

    私有网络下的子网 ID,如果设置了 UniqVpcId,则 UniqSubnetId 必填,请使用 [查询子网列表](/document/api/215/15784)。

  • ProjectId:

    项目 ID,不填为默认项目。

  • Zone:

    可用区信息,请使用 [获取云数据库可售卖规格](cloud.tencent.com/document/api/236/17229) 接口获取可创建的可用区。

  • MasterInstanceId:

    实例 ID,购买只读实例或者灾备实例时必填,该字段表示只读实例或者灾备实例的主实例 ID,请使用 [查询实例列表](cloud.tencent.com/document/api/236/15872) 接口查询云数据库实例 ID。

  • InstanceRole:

    实例类型,支持值包括:master - 表示主实例,dr - 表示灾备实例,ro - 表示只读实例。

  • MasterRegion:

    主实例地域信息,购买灾备、RO实例时,该字段必填。

  • Port:

    自定义端口,端口支持范围:[1024 - 65535]。

  • Password:

    设置 root 账号密码,密码规则:8 - 64 个字符,至少包含字母、数字、字符(支持的字符:_+-&=!@#$%^*())中的两种,购买主实例时可指定该参数,购买只读实例或者灾备实例时指定该参数无意义。

  • ParamList:

    参数列表,参数格式如 ParamList.0.Name=auto_increment&ParamList.0.Value=1。可通过 [查询默认的可设置参数列表](cloud.tencent.com/document/api/236/32662) 查询支持设置的参数。

  • ProtectMode:

    数据复制方式,默认为 0,支持值包括:0 - 表示异步复制,1 - 表示半同步复制,2 - 表示强同步复制,购买主实例时可指定该参数,购买只读实例或者灾备实例时指定该参数无意义。

  • DeployMode:

    多可用区域,默认为 0,支持值包括:0 - 表示单可用区,1 - 表示多可用区,购买主实例时可指定该参数,购买只读实例或者灾备实例时指定该参数无意义。

  • SlaveZone:

    备库 1 的可用区信息。

  • BackupZone:

    备库 2 的可用区信息,默认为空,购买三节点主实例时可指定该参数。

  • SecurityGroup:

    安全组参数,可使用 [查询项目安全组信息](cloud.tencent.com/document/api/236/15850) 接口查询某个项目的安全组详情。

  • RoGroup:

    只读实例信息。购买只读实例时,该参数必传。

  • AutoRenewFlag:

    购买按量计费实例该字段无意义。

  • InstanceName:

    实例名称。一次购买多个实例命名会用后缀数字区分,例instanceName=db,goodsNum=3,实例命名分别为db1,db2,db3。

  • ResourceTags:

    实例标签信息。

  • DeployGroupId:

    置放群组 ID。

  • ClientToken:

    用于保证请求幂等性的字符串。该字符串由客户生成,需保证不同请求之间在48小时内唯一,最大值不超过64个ASCII字符。若不指定该参数,则无法保证请求的幂等性。

  • DeviceType:

    实例隔离类型。支持值包括:“UNIVERSAL” - 通用型实例,“EXCLUSIVE” - 独享型实例,“BASIC_V2” - ONTKE 单节点实例,“CLOUD_NATIVE_CLUSTER” - 云盘版标准型,“CLOUD_NATIVE_CLUSTER_EXCLUSIVE” - 云盘版加强型。不指定则默认为通用型实例。

  • ParamTemplateId:

    参数模板 id。

  • AlarmPolicyList:

    告警策略id数组。腾讯云可观测平台DescribeAlarmPolicy接口返回的OriginId。

  • InstanceNodes:

    实例节点数。对于 RO 和 基础版实例, 该值默认为1。 如果需要购买三节点实例, 请将该值设置为3 或指定 BackupZone 参数。当购买主实例,且未指定该参数和 BackupZone 参数时,该值默认是 2, 即购买两节点实例。

  • Cpu:

    实例cpu核数, 如果不传将根据memory指定的内存值自动填充对应的cpu值。

  • AutoSyncFlag:

    是否自动发起灾备同步功能。该参数仅对购买灾备实例生效。 可选值为:0 - 不自动发起灾备同步;1 - 自动发起灾备同步。该值默认为0。

  • CageId:

    金融围拢 ID 。

  • ParamTemplateType:

    默认参数模板类型。支持值包括:“HIGH_STABILITY” - 高稳定模板,“HIGH_PERFORMANCE” - 高性能模板,默认值是:“HIGH_STABILITY”。

  • AlarmPolicyIdList:

    告警策略名数组,例如:,AlarmPolicyList不为空时该参数无效。

  • DryRun:

    是否只预检此次请求。true:发送检查请求,不会创建实例。检查项包括是否填写了必需参数,请求格式,业务限制等。如果检查不通过,则返回对应错误码;如果检查通过,则返回RequestId.默认为false:发送正常请求,通过检查后直接创建实例。

  • EngineType:

    实例引擎类型,默认为“InnoDB”,支持值包括:“InnoDB”,“RocksDB”。

  • Vips:

    指定实例的IP列表。仅支持主实例指定,按实例顺序,不足则按未指定处理。

  • DataProtectVolume:

    云盘版实例的数据保护空间大小,单位 GB,设置范围1 - 10。

  • ClusterTopology:

    云盘版节点拓扑配置。

  • DiskType:

    硬盘类型,单节点(云盘)或者云盘版实例可以指定此参数。CLOUD_SSD 表示 SSD 云硬盘,CLOUD_HSSD 表示增强型 SSD 云硬盘,CLOUD_PREMIUM 表示高性能云硬盘。

  • ClusterType:

    集群类型:cage——金融围拢,cdc——CDB ON CDC;dedicate——独享集群

  • DestroyProtect:

    开启或关闭实例销毁保护。on-开启,off-关闭



3169
3170
3171
# File 'lib/v20170320/models.rb', line 3169

def EngineType
  @EngineType
end

#EngineVersionObject

说明:创建非云盘版实例时,请根据需要指定实例版本(推荐5.7或8.0),若此参数不填,则默认值为8.0;若创建的是云盘版实例,则此参数仅能指定为5.7或8.0。说明:如果创建的是云盘版实例,此参数为必填且为私有网络类型。若此项不填,则系统会选择默认的 VPC。说明:若此项不填,则系统会选择默认 VPC 下的默认子网。说明:若您创建单节点、双节点、三节点实例,此参数为必填项,请指定可用区,若不指定可用区,则系统会自动选择一个可用区(可能不是您希望部署的可用区);若您创建云盘版实例,此参数不填,请通过参数 ClusterTopology 进行读写节点和只读节点的可用区配置。说明:请选择实例类型,不填会默认选择 master。说明:不填则默认为3306。说明:表名大小写敏感的开启和关闭可通过参数 lower_case_table_names 进行设置,参数值为0表示开启,参数值为1表示关闭,若不设置则此参数默认值为0。若您创建的是 MySQL 8.0 版本的实例,则需要在创建实例时通过设置 lower_case_table_names 参数来开启或关闭表名大小写敏感,创建实例后无法修改参数,即创建后无法修改表名大小写敏感。其他数据库版本的实例支持在创建实例后修改 lower_case_table_names 参数。创建实例时设置表名大小写敏感的 API 调用方法请参见本文中的示例2。说明:双节点、三节点实例请指定此参数值,若不指定,则默认为 Zone 的值;云盘版实例此参数可不填,请通过参数 ClusterTopology 进行读写节点和只读节点的可用区配置;单节点实例为单可用区,无需指定此参数。说明:如果创建的是云盘版实例,此参数为必填。备注:如您使用自定义参数模板 id,可传入自定义参数模板 id;如您计划使用默认参数模板,该参数模板 id 传入 id 无效,需设置 ParamTemplateType。备注:如您需使用云数据库 MySQL 默认参数模板,请设置 ParamTemplateType。说明:若购买的是云盘版实例,此参数为必填,需设置云盘版实例的 RW 和 RO 节点拓扑,RO 节点范围是1 - 5个,请至少设置1个 RO 节点。说明:单节点(云盘)、云盘版实例硬盘类型所支持的地域略有不同,具体支持情况请参考 [地域和可用区](cloud.tencent.com/document/product/236/8458)。

Parameters:

  • GoodsNum:

    实例数量,默认值为 1,最小值 1,最大值为 100。

  • Memory:

    实例内存大小,单位:MB,请使用 [获取云数据库可售卖规格](cloud.tencent.com/document/api/236/17229) 接口获取可创建的内存规格。

  • Volume:

    实例硬盘大小,单位:GB,请使用 [获取云数据库可售卖规格](cloud.tencent.com/document/api/236/17229) 接口获取可创建的硬盘范围。

  • EngineVersion:

    MySQL 版本,值包括:5.5、5.6、5.7和8.0,请使用 [获取云数据库可售卖规格](cloud.tencent.com/document/api/236/17229) 接口获取可创建的实例版本。

  • UniqVpcId:

    私有网络 ID,请使用 [查询私有网络列表](/document/api/215/15778)。

  • UniqSubnetId:

    私有网络下的子网 ID,如果设置了 UniqVpcId,则 UniqSubnetId 必填,请使用 [查询子网列表](/document/api/215/15784)。

  • ProjectId:

    项目 ID,不填为默认项目。

  • Zone:

    可用区信息,请使用 [获取云数据库可售卖规格](cloud.tencent.com/document/api/236/17229) 接口获取可创建的可用区。

  • MasterInstanceId:

    实例 ID,购买只读实例或者灾备实例时必填,该字段表示只读实例或者灾备实例的主实例 ID,请使用 [查询实例列表](cloud.tencent.com/document/api/236/15872) 接口查询云数据库实例 ID。

  • InstanceRole:

    实例类型,支持值包括:master - 表示主实例,dr - 表示灾备实例,ro - 表示只读实例。

  • MasterRegion:

    主实例地域信息,购买灾备、RO实例时,该字段必填。

  • Port:

    自定义端口,端口支持范围:[1024 - 65535]。

  • Password:

    设置 root 账号密码,密码规则:8 - 64 个字符,至少包含字母、数字、字符(支持的字符:_+-&=!@#$%^*())中的两种,购买主实例时可指定该参数,购买只读实例或者灾备实例时指定该参数无意义。

  • ParamList:

    参数列表,参数格式如 ParamList.0.Name=auto_increment&ParamList.0.Value=1。可通过 [查询默认的可设置参数列表](cloud.tencent.com/document/api/236/32662) 查询支持设置的参数。

  • ProtectMode:

    数据复制方式,默认为 0,支持值包括:0 - 表示异步复制,1 - 表示半同步复制,2 - 表示强同步复制,购买主实例时可指定该参数,购买只读实例或者灾备实例时指定该参数无意义。

  • DeployMode:

    多可用区域,默认为 0,支持值包括:0 - 表示单可用区,1 - 表示多可用区,购买主实例时可指定该参数,购买只读实例或者灾备实例时指定该参数无意义。

  • SlaveZone:

    备库 1 的可用区信息。

  • BackupZone:

    备库 2 的可用区信息,默认为空,购买三节点主实例时可指定该参数。

  • SecurityGroup:

    安全组参数,可使用 [查询项目安全组信息](cloud.tencent.com/document/api/236/15850) 接口查询某个项目的安全组详情。

  • RoGroup:

    只读实例信息。购买只读实例时,该参数必传。

  • AutoRenewFlag:

    购买按量计费实例该字段无意义。

  • InstanceName:

    实例名称。一次购买多个实例命名会用后缀数字区分,例instanceName=db,goodsNum=3,实例命名分别为db1,db2,db3。

  • ResourceTags:

    实例标签信息。

  • DeployGroupId:

    置放群组 ID。

  • ClientToken:

    用于保证请求幂等性的字符串。该字符串由客户生成,需保证不同请求之间在48小时内唯一,最大值不超过64个ASCII字符。若不指定该参数,则无法保证请求的幂等性。

  • DeviceType:

    实例隔离类型。支持值包括:“UNIVERSAL” - 通用型实例,“EXCLUSIVE” - 独享型实例,“BASIC_V2” - ONTKE 单节点实例,“CLOUD_NATIVE_CLUSTER” - 云盘版标准型,“CLOUD_NATIVE_CLUSTER_EXCLUSIVE” - 云盘版加强型。不指定则默认为通用型实例。

  • ParamTemplateId:

    参数模板 id。

  • AlarmPolicyList:

    告警策略id数组。腾讯云可观测平台DescribeAlarmPolicy接口返回的OriginId。

  • InstanceNodes:

    实例节点数。对于 RO 和 基础版实例, 该值默认为1。 如果需要购买三节点实例, 请将该值设置为3 或指定 BackupZone 参数。当购买主实例,且未指定该参数和 BackupZone 参数时,该值默认是 2, 即购买两节点实例。

  • Cpu:

    实例cpu核数, 如果不传将根据memory指定的内存值自动填充对应的cpu值。

  • AutoSyncFlag:

    是否自动发起灾备同步功能。该参数仅对购买灾备实例生效。 可选值为:0 - 不自动发起灾备同步;1 - 自动发起灾备同步。该值默认为0。

  • CageId:

    金融围拢 ID 。

  • ParamTemplateType:

    默认参数模板类型。支持值包括:“HIGH_STABILITY” - 高稳定模板,“HIGH_PERFORMANCE” - 高性能模板,默认值是:“HIGH_STABILITY”。

  • AlarmPolicyIdList:

    告警策略名数组,例如:,AlarmPolicyList不为空时该参数无效。

  • DryRun:

    是否只预检此次请求。true:发送检查请求,不会创建实例。检查项包括是否填写了必需参数,请求格式,业务限制等。如果检查不通过,则返回对应错误码;如果检查通过,则返回RequestId.默认为false:发送正常请求,通过检查后直接创建实例。

  • EngineType:

    实例引擎类型,默认为“InnoDB”,支持值包括:“InnoDB”,“RocksDB”。

  • Vips:

    指定实例的IP列表。仅支持主实例指定,按实例顺序,不足则按未指定处理。

  • DataProtectVolume:

    云盘版实例的数据保护空间大小,单位 GB,设置范围1 - 10。

  • ClusterTopology:

    云盘版节点拓扑配置。

  • DiskType:

    硬盘类型,单节点(云盘)或者云盘版实例可以指定此参数。CLOUD_SSD 表示 SSD 云硬盘,CLOUD_HSSD 表示增强型 SSD 云硬盘,CLOUD_PREMIUM 表示高性能云硬盘。

  • ClusterType:

    集群类型:cage——金融围拢,cdc——CDB ON CDC;dedicate——独享集群

  • DestroyProtect:

    开启或关闭实例销毁保护。on-开启,off-关闭



3169
3170
3171
# File 'lib/v20170320/models.rb', line 3169

def EngineVersion
  @EngineVersion
end

#GoodsNumObject

说明:创建非云盘版实例时,请根据需要指定实例版本(推荐5.7或8.0),若此参数不填,则默认值为8.0;若创建的是云盘版实例,则此参数仅能指定为5.7或8.0。说明:如果创建的是云盘版实例,此参数为必填且为私有网络类型。若此项不填,则系统会选择默认的 VPC。说明:若此项不填,则系统会选择默认 VPC 下的默认子网。说明:若您创建单节点、双节点、三节点实例,此参数为必填项,请指定可用区,若不指定可用区,则系统会自动选择一个可用区(可能不是您希望部署的可用区);若您创建云盘版实例,此参数不填,请通过参数 ClusterTopology 进行读写节点和只读节点的可用区配置。说明:请选择实例类型,不填会默认选择 master。说明:不填则默认为3306。说明:表名大小写敏感的开启和关闭可通过参数 lower_case_table_names 进行设置,参数值为0表示开启,参数值为1表示关闭,若不设置则此参数默认值为0。若您创建的是 MySQL 8.0 版本的实例,则需要在创建实例时通过设置 lower_case_table_names 参数来开启或关闭表名大小写敏感,创建实例后无法修改参数,即创建后无法修改表名大小写敏感。其他数据库版本的实例支持在创建实例后修改 lower_case_table_names 参数。创建实例时设置表名大小写敏感的 API 调用方法请参见本文中的示例2。说明:双节点、三节点实例请指定此参数值,若不指定,则默认为 Zone 的值;云盘版实例此参数可不填,请通过参数 ClusterTopology 进行读写节点和只读节点的可用区配置;单节点实例为单可用区,无需指定此参数。说明:如果创建的是云盘版实例,此参数为必填。备注:如您使用自定义参数模板 id,可传入自定义参数模板 id;如您计划使用默认参数模板,该参数模板 id 传入 id 无效,需设置 ParamTemplateType。备注:如您需使用云数据库 MySQL 默认参数模板,请设置 ParamTemplateType。说明:若购买的是云盘版实例,此参数为必填,需设置云盘版实例的 RW 和 RO 节点拓扑,RO 节点范围是1 - 5个,请至少设置1个 RO 节点。说明:单节点(云盘)、云盘版实例硬盘类型所支持的地域略有不同,具体支持情况请参考 [地域和可用区](cloud.tencent.com/document/product/236/8458)。

Parameters:

  • GoodsNum:

    实例数量,默认值为 1,最小值 1,最大值为 100。

  • Memory:

    实例内存大小,单位:MB,请使用 [获取云数据库可售卖规格](cloud.tencent.com/document/api/236/17229) 接口获取可创建的内存规格。

  • Volume:

    实例硬盘大小,单位:GB,请使用 [获取云数据库可售卖规格](cloud.tencent.com/document/api/236/17229) 接口获取可创建的硬盘范围。

  • EngineVersion:

    MySQL 版本,值包括:5.5、5.6、5.7和8.0,请使用 [获取云数据库可售卖规格](cloud.tencent.com/document/api/236/17229) 接口获取可创建的实例版本。

  • UniqVpcId:

    私有网络 ID,请使用 [查询私有网络列表](/document/api/215/15778)。

  • UniqSubnetId:

    私有网络下的子网 ID,如果设置了 UniqVpcId,则 UniqSubnetId 必填,请使用 [查询子网列表](/document/api/215/15784)。

  • ProjectId:

    项目 ID,不填为默认项目。

  • Zone:

    可用区信息,请使用 [获取云数据库可售卖规格](cloud.tencent.com/document/api/236/17229) 接口获取可创建的可用区。

  • MasterInstanceId:

    实例 ID,购买只读实例或者灾备实例时必填,该字段表示只读实例或者灾备实例的主实例 ID,请使用 [查询实例列表](cloud.tencent.com/document/api/236/15872) 接口查询云数据库实例 ID。

  • InstanceRole:

    实例类型,支持值包括:master - 表示主实例,dr - 表示灾备实例,ro - 表示只读实例。

  • MasterRegion:

    主实例地域信息,购买灾备、RO实例时,该字段必填。

  • Port:

    自定义端口,端口支持范围:[1024 - 65535]。

  • Password:

    设置 root 账号密码,密码规则:8 - 64 个字符,至少包含字母、数字、字符(支持的字符:_+-&=!@#$%^*())中的两种,购买主实例时可指定该参数,购买只读实例或者灾备实例时指定该参数无意义。

  • ParamList:

    参数列表,参数格式如 ParamList.0.Name=auto_increment&ParamList.0.Value=1。可通过 [查询默认的可设置参数列表](cloud.tencent.com/document/api/236/32662) 查询支持设置的参数。

  • ProtectMode:

    数据复制方式,默认为 0,支持值包括:0 - 表示异步复制,1 - 表示半同步复制,2 - 表示强同步复制,购买主实例时可指定该参数,购买只读实例或者灾备实例时指定该参数无意义。

  • DeployMode:

    多可用区域,默认为 0,支持值包括:0 - 表示单可用区,1 - 表示多可用区,购买主实例时可指定该参数,购买只读实例或者灾备实例时指定该参数无意义。

  • SlaveZone:

    备库 1 的可用区信息。

  • BackupZone:

    备库 2 的可用区信息,默认为空,购买三节点主实例时可指定该参数。

  • SecurityGroup:

    安全组参数,可使用 [查询项目安全组信息](cloud.tencent.com/document/api/236/15850) 接口查询某个项目的安全组详情。

  • RoGroup:

    只读实例信息。购买只读实例时,该参数必传。

  • AutoRenewFlag:

    购买按量计费实例该字段无意义。

  • InstanceName:

    实例名称。一次购买多个实例命名会用后缀数字区分,例instanceName=db,goodsNum=3,实例命名分别为db1,db2,db3。

  • ResourceTags:

    实例标签信息。

  • DeployGroupId:

    置放群组 ID。

  • ClientToken:

    用于保证请求幂等性的字符串。该字符串由客户生成,需保证不同请求之间在48小时内唯一,最大值不超过64个ASCII字符。若不指定该参数,则无法保证请求的幂等性。

  • DeviceType:

    实例隔离类型。支持值包括:“UNIVERSAL” - 通用型实例,“EXCLUSIVE” - 独享型实例,“BASIC_V2” - ONTKE 单节点实例,“CLOUD_NATIVE_CLUSTER” - 云盘版标准型,“CLOUD_NATIVE_CLUSTER_EXCLUSIVE” - 云盘版加强型。不指定则默认为通用型实例。

  • ParamTemplateId:

    参数模板 id。

  • AlarmPolicyList:

    告警策略id数组。腾讯云可观测平台DescribeAlarmPolicy接口返回的OriginId。

  • InstanceNodes:

    实例节点数。对于 RO 和 基础版实例, 该值默认为1。 如果需要购买三节点实例, 请将该值设置为3 或指定 BackupZone 参数。当购买主实例,且未指定该参数和 BackupZone 参数时,该值默认是 2, 即购买两节点实例。

  • Cpu:

    实例cpu核数, 如果不传将根据memory指定的内存值自动填充对应的cpu值。

  • AutoSyncFlag:

    是否自动发起灾备同步功能。该参数仅对购买灾备实例生效。 可选值为:0 - 不自动发起灾备同步;1 - 自动发起灾备同步。该值默认为0。

  • CageId:

    金融围拢 ID 。

  • ParamTemplateType:

    默认参数模板类型。支持值包括:“HIGH_STABILITY” - 高稳定模板,“HIGH_PERFORMANCE” - 高性能模板,默认值是:“HIGH_STABILITY”。

  • AlarmPolicyIdList:

    告警策略名数组,例如:,AlarmPolicyList不为空时该参数无效。

  • DryRun:

    是否只预检此次请求。true:发送检查请求,不会创建实例。检查项包括是否填写了必需参数,请求格式,业务限制等。如果检查不通过,则返回对应错误码;如果检查通过,则返回RequestId.默认为false:发送正常请求,通过检查后直接创建实例。

  • EngineType:

    实例引擎类型,默认为“InnoDB”,支持值包括:“InnoDB”,“RocksDB”。

  • Vips:

    指定实例的IP列表。仅支持主实例指定,按实例顺序,不足则按未指定处理。

  • DataProtectVolume:

    云盘版实例的数据保护空间大小,单位 GB,设置范围1 - 10。

  • ClusterTopology:

    云盘版节点拓扑配置。

  • DiskType:

    硬盘类型,单节点(云盘)或者云盘版实例可以指定此参数。CLOUD_SSD 表示 SSD 云硬盘,CLOUD_HSSD 表示增强型 SSD 云硬盘,CLOUD_PREMIUM 表示高性能云硬盘。

  • ClusterType:

    集群类型:cage——金融围拢,cdc——CDB ON CDC;dedicate——独享集群

  • DestroyProtect:

    开启或关闭实例销毁保护。on-开启,off-关闭



3169
3170
3171
# File 'lib/v20170320/models.rb', line 3169

def GoodsNum
  @GoodsNum
end

#InstanceNameObject

说明:创建非云盘版实例时,请根据需要指定实例版本(推荐5.7或8.0),若此参数不填,则默认值为8.0;若创建的是云盘版实例,则此参数仅能指定为5.7或8.0。说明:如果创建的是云盘版实例,此参数为必填且为私有网络类型。若此项不填,则系统会选择默认的 VPC。说明:若此项不填,则系统会选择默认 VPC 下的默认子网。说明:若您创建单节点、双节点、三节点实例,此参数为必填项,请指定可用区,若不指定可用区,则系统会自动选择一个可用区(可能不是您希望部署的可用区);若您创建云盘版实例,此参数不填,请通过参数 ClusterTopology 进行读写节点和只读节点的可用区配置。说明:请选择实例类型,不填会默认选择 master。说明:不填则默认为3306。说明:表名大小写敏感的开启和关闭可通过参数 lower_case_table_names 进行设置,参数值为0表示开启,参数值为1表示关闭,若不设置则此参数默认值为0。若您创建的是 MySQL 8.0 版本的实例,则需要在创建实例时通过设置 lower_case_table_names 参数来开启或关闭表名大小写敏感,创建实例后无法修改参数,即创建后无法修改表名大小写敏感。其他数据库版本的实例支持在创建实例后修改 lower_case_table_names 参数。创建实例时设置表名大小写敏感的 API 调用方法请参见本文中的示例2。说明:双节点、三节点实例请指定此参数值,若不指定,则默认为 Zone 的值;云盘版实例此参数可不填,请通过参数 ClusterTopology 进行读写节点和只读节点的可用区配置;单节点实例为单可用区,无需指定此参数。说明:如果创建的是云盘版实例,此参数为必填。备注:如您使用自定义参数模板 id,可传入自定义参数模板 id;如您计划使用默认参数模板,该参数模板 id 传入 id 无效,需设置 ParamTemplateType。备注:如您需使用云数据库 MySQL 默认参数模板,请设置 ParamTemplateType。说明:若购买的是云盘版实例,此参数为必填,需设置云盘版实例的 RW 和 RO 节点拓扑,RO 节点范围是1 - 5个,请至少设置1个 RO 节点。说明:单节点(云盘)、云盘版实例硬盘类型所支持的地域略有不同,具体支持情况请参考 [地域和可用区](cloud.tencent.com/document/product/236/8458)。

Parameters:

  • GoodsNum:

    实例数量,默认值为 1,最小值 1,最大值为 100。

  • Memory:

    实例内存大小,单位:MB,请使用 [获取云数据库可售卖规格](cloud.tencent.com/document/api/236/17229) 接口获取可创建的内存规格。

  • Volume:

    实例硬盘大小,单位:GB,请使用 [获取云数据库可售卖规格](cloud.tencent.com/document/api/236/17229) 接口获取可创建的硬盘范围。

  • EngineVersion:

    MySQL 版本,值包括:5.5、5.6、5.7和8.0,请使用 [获取云数据库可售卖规格](cloud.tencent.com/document/api/236/17229) 接口获取可创建的实例版本。

  • UniqVpcId:

    私有网络 ID,请使用 [查询私有网络列表](/document/api/215/15778)。

  • UniqSubnetId:

    私有网络下的子网 ID,如果设置了 UniqVpcId,则 UniqSubnetId 必填,请使用 [查询子网列表](/document/api/215/15784)。

  • ProjectId:

    项目 ID,不填为默认项目。

  • Zone:

    可用区信息,请使用 [获取云数据库可售卖规格](cloud.tencent.com/document/api/236/17229) 接口获取可创建的可用区。

  • MasterInstanceId:

    实例 ID,购买只读实例或者灾备实例时必填,该字段表示只读实例或者灾备实例的主实例 ID,请使用 [查询实例列表](cloud.tencent.com/document/api/236/15872) 接口查询云数据库实例 ID。

  • InstanceRole:

    实例类型,支持值包括:master - 表示主实例,dr - 表示灾备实例,ro - 表示只读实例。

  • MasterRegion:

    主实例地域信息,购买灾备、RO实例时,该字段必填。

  • Port:

    自定义端口,端口支持范围:[1024 - 65535]。

  • Password:

    设置 root 账号密码,密码规则:8 - 64 个字符,至少包含字母、数字、字符(支持的字符:_+-&=!@#$%^*())中的两种,购买主实例时可指定该参数,购买只读实例或者灾备实例时指定该参数无意义。

  • ParamList:

    参数列表,参数格式如 ParamList.0.Name=auto_increment&ParamList.0.Value=1。可通过 [查询默认的可设置参数列表](cloud.tencent.com/document/api/236/32662) 查询支持设置的参数。

  • ProtectMode:

    数据复制方式,默认为 0,支持值包括:0 - 表示异步复制,1 - 表示半同步复制,2 - 表示强同步复制,购买主实例时可指定该参数,购买只读实例或者灾备实例时指定该参数无意义。

  • DeployMode:

    多可用区域,默认为 0,支持值包括:0 - 表示单可用区,1 - 表示多可用区,购买主实例时可指定该参数,购买只读实例或者灾备实例时指定该参数无意义。

  • SlaveZone:

    备库 1 的可用区信息。

  • BackupZone:

    备库 2 的可用区信息,默认为空,购买三节点主实例时可指定该参数。

  • SecurityGroup:

    安全组参数,可使用 [查询项目安全组信息](cloud.tencent.com/document/api/236/15850) 接口查询某个项目的安全组详情。

  • RoGroup:

    只读实例信息。购买只读实例时,该参数必传。

  • AutoRenewFlag:

    购买按量计费实例该字段无意义。

  • InstanceName:

    实例名称。一次购买多个实例命名会用后缀数字区分,例instanceName=db,goodsNum=3,实例命名分别为db1,db2,db3。

  • ResourceTags:

    实例标签信息。

  • DeployGroupId:

    置放群组 ID。

  • ClientToken:

    用于保证请求幂等性的字符串。该字符串由客户生成,需保证不同请求之间在48小时内唯一,最大值不超过64个ASCII字符。若不指定该参数,则无法保证请求的幂等性。

  • DeviceType:

    实例隔离类型。支持值包括:“UNIVERSAL” - 通用型实例,“EXCLUSIVE” - 独享型实例,“BASIC_V2” - ONTKE 单节点实例,“CLOUD_NATIVE_CLUSTER” - 云盘版标准型,“CLOUD_NATIVE_CLUSTER_EXCLUSIVE” - 云盘版加强型。不指定则默认为通用型实例。

  • ParamTemplateId:

    参数模板 id。

  • AlarmPolicyList:

    告警策略id数组。腾讯云可观测平台DescribeAlarmPolicy接口返回的OriginId。

  • InstanceNodes:

    实例节点数。对于 RO 和 基础版实例, 该值默认为1。 如果需要购买三节点实例, 请将该值设置为3 或指定 BackupZone 参数。当购买主实例,且未指定该参数和 BackupZone 参数时,该值默认是 2, 即购买两节点实例。

  • Cpu:

    实例cpu核数, 如果不传将根据memory指定的内存值自动填充对应的cpu值。

  • AutoSyncFlag:

    是否自动发起灾备同步功能。该参数仅对购买灾备实例生效。 可选值为:0 - 不自动发起灾备同步;1 - 自动发起灾备同步。该值默认为0。

  • CageId:

    金融围拢 ID 。

  • ParamTemplateType:

    默认参数模板类型。支持值包括:“HIGH_STABILITY” - 高稳定模板,“HIGH_PERFORMANCE” - 高性能模板,默认值是:“HIGH_STABILITY”。

  • AlarmPolicyIdList:

    告警策略名数组,例如:,AlarmPolicyList不为空时该参数无效。

  • DryRun:

    是否只预检此次请求。true:发送检查请求,不会创建实例。检查项包括是否填写了必需参数,请求格式,业务限制等。如果检查不通过,则返回对应错误码;如果检查通过,则返回RequestId.默认为false:发送正常请求,通过检查后直接创建实例。

  • EngineType:

    实例引擎类型,默认为“InnoDB”,支持值包括:“InnoDB”,“RocksDB”。

  • Vips:

    指定实例的IP列表。仅支持主实例指定,按实例顺序,不足则按未指定处理。

  • DataProtectVolume:

    云盘版实例的数据保护空间大小,单位 GB,设置范围1 - 10。

  • ClusterTopology:

    云盘版节点拓扑配置。

  • DiskType:

    硬盘类型,单节点(云盘)或者云盘版实例可以指定此参数。CLOUD_SSD 表示 SSD 云硬盘,CLOUD_HSSD 表示增强型 SSD 云硬盘,CLOUD_PREMIUM 表示高性能云硬盘。

  • ClusterType:

    集群类型:cage——金融围拢,cdc——CDB ON CDC;dedicate——独享集群

  • DestroyProtect:

    开启或关闭实例销毁保护。on-开启,off-关闭



3169
3170
3171
# File 'lib/v20170320/models.rb', line 3169

def InstanceName
  @InstanceName
end

#InstanceNodesObject

说明:创建非云盘版实例时,请根据需要指定实例版本(推荐5.7或8.0),若此参数不填,则默认值为8.0;若创建的是云盘版实例,则此参数仅能指定为5.7或8.0。说明:如果创建的是云盘版实例,此参数为必填且为私有网络类型。若此项不填,则系统会选择默认的 VPC。说明:若此项不填,则系统会选择默认 VPC 下的默认子网。说明:若您创建单节点、双节点、三节点实例,此参数为必填项,请指定可用区,若不指定可用区,则系统会自动选择一个可用区(可能不是您希望部署的可用区);若您创建云盘版实例,此参数不填,请通过参数 ClusterTopology 进行读写节点和只读节点的可用区配置。说明:请选择实例类型,不填会默认选择 master。说明:不填则默认为3306。说明:表名大小写敏感的开启和关闭可通过参数 lower_case_table_names 进行设置,参数值为0表示开启,参数值为1表示关闭,若不设置则此参数默认值为0。若您创建的是 MySQL 8.0 版本的实例,则需要在创建实例时通过设置 lower_case_table_names 参数来开启或关闭表名大小写敏感,创建实例后无法修改参数,即创建后无法修改表名大小写敏感。其他数据库版本的实例支持在创建实例后修改 lower_case_table_names 参数。创建实例时设置表名大小写敏感的 API 调用方法请参见本文中的示例2。说明:双节点、三节点实例请指定此参数值,若不指定,则默认为 Zone 的值;云盘版实例此参数可不填,请通过参数 ClusterTopology 进行读写节点和只读节点的可用区配置;单节点实例为单可用区,无需指定此参数。说明:如果创建的是云盘版实例,此参数为必填。备注:如您使用自定义参数模板 id,可传入自定义参数模板 id;如您计划使用默认参数模板,该参数模板 id 传入 id 无效,需设置 ParamTemplateType。备注:如您需使用云数据库 MySQL 默认参数模板,请设置 ParamTemplateType。说明:若购买的是云盘版实例,此参数为必填,需设置云盘版实例的 RW 和 RO 节点拓扑,RO 节点范围是1 - 5个,请至少设置1个 RO 节点。说明:单节点(云盘)、云盘版实例硬盘类型所支持的地域略有不同,具体支持情况请参考 [地域和可用区](cloud.tencent.com/document/product/236/8458)。

Parameters:

  • GoodsNum:

    实例数量,默认值为 1,最小值 1,最大值为 100。

  • Memory:

    实例内存大小,单位:MB,请使用 [获取云数据库可售卖规格](cloud.tencent.com/document/api/236/17229) 接口获取可创建的内存规格。

  • Volume:

    实例硬盘大小,单位:GB,请使用 [获取云数据库可售卖规格](cloud.tencent.com/document/api/236/17229) 接口获取可创建的硬盘范围。

  • EngineVersion:

    MySQL 版本,值包括:5.5、5.6、5.7和8.0,请使用 [获取云数据库可售卖规格](cloud.tencent.com/document/api/236/17229) 接口获取可创建的实例版本。

  • UniqVpcId:

    私有网络 ID,请使用 [查询私有网络列表](/document/api/215/15778)。

  • UniqSubnetId:

    私有网络下的子网 ID,如果设置了 UniqVpcId,则 UniqSubnetId 必填,请使用 [查询子网列表](/document/api/215/15784)。

  • ProjectId:

    项目 ID,不填为默认项目。

  • Zone:

    可用区信息,请使用 [获取云数据库可售卖规格](cloud.tencent.com/document/api/236/17229) 接口获取可创建的可用区。

  • MasterInstanceId:

    实例 ID,购买只读实例或者灾备实例时必填,该字段表示只读实例或者灾备实例的主实例 ID,请使用 [查询实例列表](cloud.tencent.com/document/api/236/15872) 接口查询云数据库实例 ID。

  • InstanceRole:

    实例类型,支持值包括:master - 表示主实例,dr - 表示灾备实例,ro - 表示只读实例。

  • MasterRegion:

    主实例地域信息,购买灾备、RO实例时,该字段必填。

  • Port:

    自定义端口,端口支持范围:[1024 - 65535]。

  • Password:

    设置 root 账号密码,密码规则:8 - 64 个字符,至少包含字母、数字、字符(支持的字符:_+-&=!@#$%^*())中的两种,购买主实例时可指定该参数,购买只读实例或者灾备实例时指定该参数无意义。

  • ParamList:

    参数列表,参数格式如 ParamList.0.Name=auto_increment&ParamList.0.Value=1。可通过 [查询默认的可设置参数列表](cloud.tencent.com/document/api/236/32662) 查询支持设置的参数。

  • ProtectMode:

    数据复制方式,默认为 0,支持值包括:0 - 表示异步复制,1 - 表示半同步复制,2 - 表示强同步复制,购买主实例时可指定该参数,购买只读实例或者灾备实例时指定该参数无意义。

  • DeployMode:

    多可用区域,默认为 0,支持值包括:0 - 表示单可用区,1 - 表示多可用区,购买主实例时可指定该参数,购买只读实例或者灾备实例时指定该参数无意义。

  • SlaveZone:

    备库 1 的可用区信息。

  • BackupZone:

    备库 2 的可用区信息,默认为空,购买三节点主实例时可指定该参数。

  • SecurityGroup:

    安全组参数,可使用 [查询项目安全组信息](cloud.tencent.com/document/api/236/15850) 接口查询某个项目的安全组详情。

  • RoGroup:

    只读实例信息。购买只读实例时,该参数必传。

  • AutoRenewFlag:

    购买按量计费实例该字段无意义。

  • InstanceName:

    实例名称。一次购买多个实例命名会用后缀数字区分,例instanceName=db,goodsNum=3,实例命名分别为db1,db2,db3。

  • ResourceTags:

    实例标签信息。

  • DeployGroupId:

    置放群组 ID。

  • ClientToken:

    用于保证请求幂等性的字符串。该字符串由客户生成,需保证不同请求之间在48小时内唯一,最大值不超过64个ASCII字符。若不指定该参数,则无法保证请求的幂等性。

  • DeviceType:

    实例隔离类型。支持值包括:“UNIVERSAL” - 通用型实例,“EXCLUSIVE” - 独享型实例,“BASIC_V2” - ONTKE 单节点实例,“CLOUD_NATIVE_CLUSTER” - 云盘版标准型,“CLOUD_NATIVE_CLUSTER_EXCLUSIVE” - 云盘版加强型。不指定则默认为通用型实例。

  • ParamTemplateId:

    参数模板 id。

  • AlarmPolicyList:

    告警策略id数组。腾讯云可观测平台DescribeAlarmPolicy接口返回的OriginId。

  • InstanceNodes:

    实例节点数。对于 RO 和 基础版实例, 该值默认为1。 如果需要购买三节点实例, 请将该值设置为3 或指定 BackupZone 参数。当购买主实例,且未指定该参数和 BackupZone 参数时,该值默认是 2, 即购买两节点实例。

  • Cpu:

    实例cpu核数, 如果不传将根据memory指定的内存值自动填充对应的cpu值。

  • AutoSyncFlag:

    是否自动发起灾备同步功能。该参数仅对购买灾备实例生效。 可选值为:0 - 不自动发起灾备同步;1 - 自动发起灾备同步。该值默认为0。

  • CageId:

    金融围拢 ID 。

  • ParamTemplateType:

    默认参数模板类型。支持值包括:“HIGH_STABILITY” - 高稳定模板,“HIGH_PERFORMANCE” - 高性能模板,默认值是:“HIGH_STABILITY”。

  • AlarmPolicyIdList:

    告警策略名数组,例如:,AlarmPolicyList不为空时该参数无效。

  • DryRun:

    是否只预检此次请求。true:发送检查请求,不会创建实例。检查项包括是否填写了必需参数,请求格式,业务限制等。如果检查不通过,则返回对应错误码;如果检查通过,则返回RequestId.默认为false:发送正常请求,通过检查后直接创建实例。

  • EngineType:

    实例引擎类型,默认为“InnoDB”,支持值包括:“InnoDB”,“RocksDB”。

  • Vips:

    指定实例的IP列表。仅支持主实例指定,按实例顺序,不足则按未指定处理。

  • DataProtectVolume:

    云盘版实例的数据保护空间大小,单位 GB,设置范围1 - 10。

  • ClusterTopology:

    云盘版节点拓扑配置。

  • DiskType:

    硬盘类型,单节点(云盘)或者云盘版实例可以指定此参数。CLOUD_SSD 表示 SSD 云硬盘,CLOUD_HSSD 表示增强型 SSD 云硬盘,CLOUD_PREMIUM 表示高性能云硬盘。

  • ClusterType:

    集群类型:cage——金融围拢,cdc——CDB ON CDC;dedicate——独享集群

  • DestroyProtect:

    开启或关闭实例销毁保护。on-开启,off-关闭



3169
3170
3171
# File 'lib/v20170320/models.rb', line 3169

def InstanceNodes
  @InstanceNodes
end

#InstanceRoleObject

说明:创建非云盘版实例时,请根据需要指定实例版本(推荐5.7或8.0),若此参数不填,则默认值为8.0;若创建的是云盘版实例,则此参数仅能指定为5.7或8.0。说明:如果创建的是云盘版实例,此参数为必填且为私有网络类型。若此项不填,则系统会选择默认的 VPC。说明:若此项不填,则系统会选择默认 VPC 下的默认子网。说明:若您创建单节点、双节点、三节点实例,此参数为必填项,请指定可用区,若不指定可用区,则系统会自动选择一个可用区(可能不是您希望部署的可用区);若您创建云盘版实例,此参数不填,请通过参数 ClusterTopology 进行读写节点和只读节点的可用区配置。说明:请选择实例类型,不填会默认选择 master。说明:不填则默认为3306。说明:表名大小写敏感的开启和关闭可通过参数 lower_case_table_names 进行设置,参数值为0表示开启,参数值为1表示关闭,若不设置则此参数默认值为0。若您创建的是 MySQL 8.0 版本的实例,则需要在创建实例时通过设置 lower_case_table_names 参数来开启或关闭表名大小写敏感,创建实例后无法修改参数,即创建后无法修改表名大小写敏感。其他数据库版本的实例支持在创建实例后修改 lower_case_table_names 参数。创建实例时设置表名大小写敏感的 API 调用方法请参见本文中的示例2。说明:双节点、三节点实例请指定此参数值,若不指定,则默认为 Zone 的值;云盘版实例此参数可不填,请通过参数 ClusterTopology 进行读写节点和只读节点的可用区配置;单节点实例为单可用区,无需指定此参数。说明:如果创建的是云盘版实例,此参数为必填。备注:如您使用自定义参数模板 id,可传入自定义参数模板 id;如您计划使用默认参数模板,该参数模板 id 传入 id 无效,需设置 ParamTemplateType。备注:如您需使用云数据库 MySQL 默认参数模板,请设置 ParamTemplateType。说明:若购买的是云盘版实例,此参数为必填,需设置云盘版实例的 RW 和 RO 节点拓扑,RO 节点范围是1 - 5个,请至少设置1个 RO 节点。说明:单节点(云盘)、云盘版实例硬盘类型所支持的地域略有不同,具体支持情况请参考 [地域和可用区](cloud.tencent.com/document/product/236/8458)。

Parameters:

  • GoodsNum:

    实例数量,默认值为 1,最小值 1,最大值为 100。

  • Memory:

    实例内存大小,单位:MB,请使用 [获取云数据库可售卖规格](cloud.tencent.com/document/api/236/17229) 接口获取可创建的内存规格。

  • Volume:

    实例硬盘大小,单位:GB,请使用 [获取云数据库可售卖规格](cloud.tencent.com/document/api/236/17229) 接口获取可创建的硬盘范围。

  • EngineVersion:

    MySQL 版本,值包括:5.5、5.6、5.7和8.0,请使用 [获取云数据库可售卖规格](cloud.tencent.com/document/api/236/17229) 接口获取可创建的实例版本。

  • UniqVpcId:

    私有网络 ID,请使用 [查询私有网络列表](/document/api/215/15778)。

  • UniqSubnetId:

    私有网络下的子网 ID,如果设置了 UniqVpcId,则 UniqSubnetId 必填,请使用 [查询子网列表](/document/api/215/15784)。

  • ProjectId:

    项目 ID,不填为默认项目。

  • Zone:

    可用区信息,请使用 [获取云数据库可售卖规格](cloud.tencent.com/document/api/236/17229) 接口获取可创建的可用区。

  • MasterInstanceId:

    实例 ID,购买只读实例或者灾备实例时必填,该字段表示只读实例或者灾备实例的主实例 ID,请使用 [查询实例列表](cloud.tencent.com/document/api/236/15872) 接口查询云数据库实例 ID。

  • InstanceRole:

    实例类型,支持值包括:master - 表示主实例,dr - 表示灾备实例,ro - 表示只读实例。

  • MasterRegion:

    主实例地域信息,购买灾备、RO实例时,该字段必填。

  • Port:

    自定义端口,端口支持范围:[1024 - 65535]。

  • Password:

    设置 root 账号密码,密码规则:8 - 64 个字符,至少包含字母、数字、字符(支持的字符:_+-&=!@#$%^*())中的两种,购买主实例时可指定该参数,购买只读实例或者灾备实例时指定该参数无意义。

  • ParamList:

    参数列表,参数格式如 ParamList.0.Name=auto_increment&ParamList.0.Value=1。可通过 [查询默认的可设置参数列表](cloud.tencent.com/document/api/236/32662) 查询支持设置的参数。

  • ProtectMode:

    数据复制方式,默认为 0,支持值包括:0 - 表示异步复制,1 - 表示半同步复制,2 - 表示强同步复制,购买主实例时可指定该参数,购买只读实例或者灾备实例时指定该参数无意义。

  • DeployMode:

    多可用区域,默认为 0,支持值包括:0 - 表示单可用区,1 - 表示多可用区,购买主实例时可指定该参数,购买只读实例或者灾备实例时指定该参数无意义。

  • SlaveZone:

    备库 1 的可用区信息。

  • BackupZone:

    备库 2 的可用区信息,默认为空,购买三节点主实例时可指定该参数。

  • SecurityGroup:

    安全组参数,可使用 [查询项目安全组信息](cloud.tencent.com/document/api/236/15850) 接口查询某个项目的安全组详情。

  • RoGroup:

    只读实例信息。购买只读实例时,该参数必传。

  • AutoRenewFlag:

    购买按量计费实例该字段无意义。

  • InstanceName:

    实例名称。一次购买多个实例命名会用后缀数字区分,例instanceName=db,goodsNum=3,实例命名分别为db1,db2,db3。

  • ResourceTags:

    实例标签信息。

  • DeployGroupId:

    置放群组 ID。

  • ClientToken:

    用于保证请求幂等性的字符串。该字符串由客户生成,需保证不同请求之间在48小时内唯一,最大值不超过64个ASCII字符。若不指定该参数,则无法保证请求的幂等性。

  • DeviceType:

    实例隔离类型。支持值包括:“UNIVERSAL” - 通用型实例,“EXCLUSIVE” - 独享型实例,“BASIC_V2” - ONTKE 单节点实例,“CLOUD_NATIVE_CLUSTER” - 云盘版标准型,“CLOUD_NATIVE_CLUSTER_EXCLUSIVE” - 云盘版加强型。不指定则默认为通用型实例。

  • ParamTemplateId:

    参数模板 id。

  • AlarmPolicyList:

    告警策略id数组。腾讯云可观测平台DescribeAlarmPolicy接口返回的OriginId。

  • InstanceNodes:

    实例节点数。对于 RO 和 基础版实例, 该值默认为1。 如果需要购买三节点实例, 请将该值设置为3 或指定 BackupZone 参数。当购买主实例,且未指定该参数和 BackupZone 参数时,该值默认是 2, 即购买两节点实例。

  • Cpu:

    实例cpu核数, 如果不传将根据memory指定的内存值自动填充对应的cpu值。

  • AutoSyncFlag:

    是否自动发起灾备同步功能。该参数仅对购买灾备实例生效。 可选值为:0 - 不自动发起灾备同步;1 - 自动发起灾备同步。该值默认为0。

  • CageId:

    金融围拢 ID 。

  • ParamTemplateType:

    默认参数模板类型。支持值包括:“HIGH_STABILITY” - 高稳定模板,“HIGH_PERFORMANCE” - 高性能模板,默认值是:“HIGH_STABILITY”。

  • AlarmPolicyIdList:

    告警策略名数组,例如:,AlarmPolicyList不为空时该参数无效。

  • DryRun:

    是否只预检此次请求。true:发送检查请求,不会创建实例。检查项包括是否填写了必需参数,请求格式,业务限制等。如果检查不通过,则返回对应错误码;如果检查通过,则返回RequestId.默认为false:发送正常请求,通过检查后直接创建实例。

  • EngineType:

    实例引擎类型,默认为“InnoDB”,支持值包括:“InnoDB”,“RocksDB”。

  • Vips:

    指定实例的IP列表。仅支持主实例指定,按实例顺序,不足则按未指定处理。

  • DataProtectVolume:

    云盘版实例的数据保护空间大小,单位 GB,设置范围1 - 10。

  • ClusterTopology:

    云盘版节点拓扑配置。

  • DiskType:

    硬盘类型,单节点(云盘)或者云盘版实例可以指定此参数。CLOUD_SSD 表示 SSD 云硬盘,CLOUD_HSSD 表示增强型 SSD 云硬盘,CLOUD_PREMIUM 表示高性能云硬盘。

  • ClusterType:

    集群类型:cage——金融围拢,cdc——CDB ON CDC;dedicate——独享集群

  • DestroyProtect:

    开启或关闭实例销毁保护。on-开启,off-关闭



3169
3170
3171
# File 'lib/v20170320/models.rb', line 3169

def InstanceRole
  @InstanceRole
end

#MasterInstanceIdObject

说明:创建非云盘版实例时,请根据需要指定实例版本(推荐5.7或8.0),若此参数不填,则默认值为8.0;若创建的是云盘版实例,则此参数仅能指定为5.7或8.0。说明:如果创建的是云盘版实例,此参数为必填且为私有网络类型。若此项不填,则系统会选择默认的 VPC。说明:若此项不填,则系统会选择默认 VPC 下的默认子网。说明:若您创建单节点、双节点、三节点实例,此参数为必填项,请指定可用区,若不指定可用区,则系统会自动选择一个可用区(可能不是您希望部署的可用区);若您创建云盘版实例,此参数不填,请通过参数 ClusterTopology 进行读写节点和只读节点的可用区配置。说明:请选择实例类型,不填会默认选择 master。说明:不填则默认为3306。说明:表名大小写敏感的开启和关闭可通过参数 lower_case_table_names 进行设置,参数值为0表示开启,参数值为1表示关闭,若不设置则此参数默认值为0。若您创建的是 MySQL 8.0 版本的实例,则需要在创建实例时通过设置 lower_case_table_names 参数来开启或关闭表名大小写敏感,创建实例后无法修改参数,即创建后无法修改表名大小写敏感。其他数据库版本的实例支持在创建实例后修改 lower_case_table_names 参数。创建实例时设置表名大小写敏感的 API 调用方法请参见本文中的示例2。说明:双节点、三节点实例请指定此参数值,若不指定,则默认为 Zone 的值;云盘版实例此参数可不填,请通过参数 ClusterTopology 进行读写节点和只读节点的可用区配置;单节点实例为单可用区,无需指定此参数。说明:如果创建的是云盘版实例,此参数为必填。备注:如您使用自定义参数模板 id,可传入自定义参数模板 id;如您计划使用默认参数模板,该参数模板 id 传入 id 无效,需设置 ParamTemplateType。备注:如您需使用云数据库 MySQL 默认参数模板,请设置 ParamTemplateType。说明:若购买的是云盘版实例,此参数为必填,需设置云盘版实例的 RW 和 RO 节点拓扑,RO 节点范围是1 - 5个,请至少设置1个 RO 节点。说明:单节点(云盘)、云盘版实例硬盘类型所支持的地域略有不同,具体支持情况请参考 [地域和可用区](cloud.tencent.com/document/product/236/8458)。

Parameters:

  • GoodsNum:

    实例数量,默认值为 1,最小值 1,最大值为 100。

  • Memory:

    实例内存大小,单位:MB,请使用 [获取云数据库可售卖规格](cloud.tencent.com/document/api/236/17229) 接口获取可创建的内存规格。

  • Volume:

    实例硬盘大小,单位:GB,请使用 [获取云数据库可售卖规格](cloud.tencent.com/document/api/236/17229) 接口获取可创建的硬盘范围。

  • EngineVersion:

    MySQL 版本,值包括:5.5、5.6、5.7和8.0,请使用 [获取云数据库可售卖规格](cloud.tencent.com/document/api/236/17229) 接口获取可创建的实例版本。

  • UniqVpcId:

    私有网络 ID,请使用 [查询私有网络列表](/document/api/215/15778)。

  • UniqSubnetId:

    私有网络下的子网 ID,如果设置了 UniqVpcId,则 UniqSubnetId 必填,请使用 [查询子网列表](/document/api/215/15784)。

  • ProjectId:

    项目 ID,不填为默认项目。

  • Zone:

    可用区信息,请使用 [获取云数据库可售卖规格](cloud.tencent.com/document/api/236/17229) 接口获取可创建的可用区。

  • MasterInstanceId:

    实例 ID,购买只读实例或者灾备实例时必填,该字段表示只读实例或者灾备实例的主实例 ID,请使用 [查询实例列表](cloud.tencent.com/document/api/236/15872) 接口查询云数据库实例 ID。

  • InstanceRole:

    实例类型,支持值包括:master - 表示主实例,dr - 表示灾备实例,ro - 表示只读实例。

  • MasterRegion:

    主实例地域信息,购买灾备、RO实例时,该字段必填。

  • Port:

    自定义端口,端口支持范围:[1024 - 65535]。

  • Password:

    设置 root 账号密码,密码规则:8 - 64 个字符,至少包含字母、数字、字符(支持的字符:_+-&=!@#$%^*())中的两种,购买主实例时可指定该参数,购买只读实例或者灾备实例时指定该参数无意义。

  • ParamList:

    参数列表,参数格式如 ParamList.0.Name=auto_increment&ParamList.0.Value=1。可通过 [查询默认的可设置参数列表](cloud.tencent.com/document/api/236/32662) 查询支持设置的参数。

  • ProtectMode:

    数据复制方式,默认为 0,支持值包括:0 - 表示异步复制,1 - 表示半同步复制,2 - 表示强同步复制,购买主实例时可指定该参数,购买只读实例或者灾备实例时指定该参数无意义。

  • DeployMode:

    多可用区域,默认为 0,支持值包括:0 - 表示单可用区,1 - 表示多可用区,购买主实例时可指定该参数,购买只读实例或者灾备实例时指定该参数无意义。

  • SlaveZone:

    备库 1 的可用区信息。

  • BackupZone:

    备库 2 的可用区信息,默认为空,购买三节点主实例时可指定该参数。

  • SecurityGroup:

    安全组参数,可使用 [查询项目安全组信息](cloud.tencent.com/document/api/236/15850) 接口查询某个项目的安全组详情。

  • RoGroup:

    只读实例信息。购买只读实例时,该参数必传。

  • AutoRenewFlag:

    购买按量计费实例该字段无意义。

  • InstanceName:

    实例名称。一次购买多个实例命名会用后缀数字区分,例instanceName=db,goodsNum=3,实例命名分别为db1,db2,db3。

  • ResourceTags:

    实例标签信息。

  • DeployGroupId:

    置放群组 ID。

  • ClientToken:

    用于保证请求幂等性的字符串。该字符串由客户生成,需保证不同请求之间在48小时内唯一,最大值不超过64个ASCII字符。若不指定该参数,则无法保证请求的幂等性。

  • DeviceType:

    实例隔离类型。支持值包括:“UNIVERSAL” - 通用型实例,“EXCLUSIVE” - 独享型实例,“BASIC_V2” - ONTKE 单节点实例,“CLOUD_NATIVE_CLUSTER” - 云盘版标准型,“CLOUD_NATIVE_CLUSTER_EXCLUSIVE” - 云盘版加强型。不指定则默认为通用型实例。

  • ParamTemplateId:

    参数模板 id。

  • AlarmPolicyList:

    告警策略id数组。腾讯云可观测平台DescribeAlarmPolicy接口返回的OriginId。

  • InstanceNodes:

    实例节点数。对于 RO 和 基础版实例, 该值默认为1。 如果需要购买三节点实例, 请将该值设置为3 或指定 BackupZone 参数。当购买主实例,且未指定该参数和 BackupZone 参数时,该值默认是 2, 即购买两节点实例。

  • Cpu:

    实例cpu核数, 如果不传将根据memory指定的内存值自动填充对应的cpu值。

  • AutoSyncFlag:

    是否自动发起灾备同步功能。该参数仅对购买灾备实例生效。 可选值为:0 - 不自动发起灾备同步;1 - 自动发起灾备同步。该值默认为0。

  • CageId:

    金融围拢 ID 。

  • ParamTemplateType:

    默认参数模板类型。支持值包括:“HIGH_STABILITY” - 高稳定模板,“HIGH_PERFORMANCE” - 高性能模板,默认值是:“HIGH_STABILITY”。

  • AlarmPolicyIdList:

    告警策略名数组,例如:,AlarmPolicyList不为空时该参数无效。

  • DryRun:

    是否只预检此次请求。true:发送检查请求,不会创建实例。检查项包括是否填写了必需参数,请求格式,业务限制等。如果检查不通过,则返回对应错误码;如果检查通过,则返回RequestId.默认为false:发送正常请求,通过检查后直接创建实例。

  • EngineType:

    实例引擎类型,默认为“InnoDB”,支持值包括:“InnoDB”,“RocksDB”。

  • Vips:

    指定实例的IP列表。仅支持主实例指定,按实例顺序,不足则按未指定处理。

  • DataProtectVolume:

    云盘版实例的数据保护空间大小,单位 GB,设置范围1 - 10。

  • ClusterTopology:

    云盘版节点拓扑配置。

  • DiskType:

    硬盘类型,单节点(云盘)或者云盘版实例可以指定此参数。CLOUD_SSD 表示 SSD 云硬盘,CLOUD_HSSD 表示增强型 SSD 云硬盘,CLOUD_PREMIUM 表示高性能云硬盘。

  • ClusterType:

    集群类型:cage——金融围拢,cdc——CDB ON CDC;dedicate——独享集群

  • DestroyProtect:

    开启或关闭实例销毁保护。on-开启,off-关闭



3169
3170
3171
# File 'lib/v20170320/models.rb', line 3169

def MasterInstanceId
  @MasterInstanceId
end

#MasterRegionObject

说明:创建非云盘版实例时,请根据需要指定实例版本(推荐5.7或8.0),若此参数不填,则默认值为8.0;若创建的是云盘版实例,则此参数仅能指定为5.7或8.0。说明:如果创建的是云盘版实例,此参数为必填且为私有网络类型。若此项不填,则系统会选择默认的 VPC。说明:若此项不填,则系统会选择默认 VPC 下的默认子网。说明:若您创建单节点、双节点、三节点实例,此参数为必填项,请指定可用区,若不指定可用区,则系统会自动选择一个可用区(可能不是您希望部署的可用区);若您创建云盘版实例,此参数不填,请通过参数 ClusterTopology 进行读写节点和只读节点的可用区配置。说明:请选择实例类型,不填会默认选择 master。说明:不填则默认为3306。说明:表名大小写敏感的开启和关闭可通过参数 lower_case_table_names 进行设置,参数值为0表示开启,参数值为1表示关闭,若不设置则此参数默认值为0。若您创建的是 MySQL 8.0 版本的实例,则需要在创建实例时通过设置 lower_case_table_names 参数来开启或关闭表名大小写敏感,创建实例后无法修改参数,即创建后无法修改表名大小写敏感。其他数据库版本的实例支持在创建实例后修改 lower_case_table_names 参数。创建实例时设置表名大小写敏感的 API 调用方法请参见本文中的示例2。说明:双节点、三节点实例请指定此参数值,若不指定,则默认为 Zone 的值;云盘版实例此参数可不填,请通过参数 ClusterTopology 进行读写节点和只读节点的可用区配置;单节点实例为单可用区,无需指定此参数。说明:如果创建的是云盘版实例,此参数为必填。备注:如您使用自定义参数模板 id,可传入自定义参数模板 id;如您计划使用默认参数模板,该参数模板 id 传入 id 无效,需设置 ParamTemplateType。备注:如您需使用云数据库 MySQL 默认参数模板,请设置 ParamTemplateType。说明:若购买的是云盘版实例,此参数为必填,需设置云盘版实例的 RW 和 RO 节点拓扑,RO 节点范围是1 - 5个,请至少设置1个 RO 节点。说明:单节点(云盘)、云盘版实例硬盘类型所支持的地域略有不同,具体支持情况请参考 [地域和可用区](cloud.tencent.com/document/product/236/8458)。

Parameters:

  • GoodsNum:

    实例数量,默认值为 1,最小值 1,最大值为 100。

  • Memory:

    实例内存大小,单位:MB,请使用 [获取云数据库可售卖规格](cloud.tencent.com/document/api/236/17229) 接口获取可创建的内存规格。

  • Volume:

    实例硬盘大小,单位:GB,请使用 [获取云数据库可售卖规格](cloud.tencent.com/document/api/236/17229) 接口获取可创建的硬盘范围。

  • EngineVersion:

    MySQL 版本,值包括:5.5、5.6、5.7和8.0,请使用 [获取云数据库可售卖规格](cloud.tencent.com/document/api/236/17229) 接口获取可创建的实例版本。

  • UniqVpcId:

    私有网络 ID,请使用 [查询私有网络列表](/document/api/215/15778)。

  • UniqSubnetId:

    私有网络下的子网 ID,如果设置了 UniqVpcId,则 UniqSubnetId 必填,请使用 [查询子网列表](/document/api/215/15784)。

  • ProjectId:

    项目 ID,不填为默认项目。

  • Zone:

    可用区信息,请使用 [获取云数据库可售卖规格](cloud.tencent.com/document/api/236/17229) 接口获取可创建的可用区。

  • MasterInstanceId:

    实例 ID,购买只读实例或者灾备实例时必填,该字段表示只读实例或者灾备实例的主实例 ID,请使用 [查询实例列表](cloud.tencent.com/document/api/236/15872) 接口查询云数据库实例 ID。

  • InstanceRole:

    实例类型,支持值包括:master - 表示主实例,dr - 表示灾备实例,ro - 表示只读实例。

  • MasterRegion:

    主实例地域信息,购买灾备、RO实例时,该字段必填。

  • Port:

    自定义端口,端口支持范围:[1024 - 65535]。

  • Password:

    设置 root 账号密码,密码规则:8 - 64 个字符,至少包含字母、数字、字符(支持的字符:_+-&=!@#$%^*())中的两种,购买主实例时可指定该参数,购买只读实例或者灾备实例时指定该参数无意义。

  • ParamList:

    参数列表,参数格式如 ParamList.0.Name=auto_increment&ParamList.0.Value=1。可通过 [查询默认的可设置参数列表](cloud.tencent.com/document/api/236/32662) 查询支持设置的参数。

  • ProtectMode:

    数据复制方式,默认为 0,支持值包括:0 - 表示异步复制,1 - 表示半同步复制,2 - 表示强同步复制,购买主实例时可指定该参数,购买只读实例或者灾备实例时指定该参数无意义。

  • DeployMode:

    多可用区域,默认为 0,支持值包括:0 - 表示单可用区,1 - 表示多可用区,购买主实例时可指定该参数,购买只读实例或者灾备实例时指定该参数无意义。

  • SlaveZone:

    备库 1 的可用区信息。

  • BackupZone:

    备库 2 的可用区信息,默认为空,购买三节点主实例时可指定该参数。

  • SecurityGroup:

    安全组参数,可使用 [查询项目安全组信息](cloud.tencent.com/document/api/236/15850) 接口查询某个项目的安全组详情。

  • RoGroup:

    只读实例信息。购买只读实例时,该参数必传。

  • AutoRenewFlag:

    购买按量计费实例该字段无意义。

  • InstanceName:

    实例名称。一次购买多个实例命名会用后缀数字区分,例instanceName=db,goodsNum=3,实例命名分别为db1,db2,db3。

  • ResourceTags:

    实例标签信息。

  • DeployGroupId:

    置放群组 ID。

  • ClientToken:

    用于保证请求幂等性的字符串。该字符串由客户生成,需保证不同请求之间在48小时内唯一,最大值不超过64个ASCII字符。若不指定该参数,则无法保证请求的幂等性。

  • DeviceType:

    实例隔离类型。支持值包括:“UNIVERSAL” - 通用型实例,“EXCLUSIVE” - 独享型实例,“BASIC_V2” - ONTKE 单节点实例,“CLOUD_NATIVE_CLUSTER” - 云盘版标准型,“CLOUD_NATIVE_CLUSTER_EXCLUSIVE” - 云盘版加强型。不指定则默认为通用型实例。

  • ParamTemplateId:

    参数模板 id。

  • AlarmPolicyList:

    告警策略id数组。腾讯云可观测平台DescribeAlarmPolicy接口返回的OriginId。

  • InstanceNodes:

    实例节点数。对于 RO 和 基础版实例, 该值默认为1。 如果需要购买三节点实例, 请将该值设置为3 或指定 BackupZone 参数。当购买主实例,且未指定该参数和 BackupZone 参数时,该值默认是 2, 即购买两节点实例。

  • Cpu:

    实例cpu核数, 如果不传将根据memory指定的内存值自动填充对应的cpu值。

  • AutoSyncFlag:

    是否自动发起灾备同步功能。该参数仅对购买灾备实例生效。 可选值为:0 - 不自动发起灾备同步;1 - 自动发起灾备同步。该值默认为0。

  • CageId:

    金融围拢 ID 。

  • ParamTemplateType:

    默认参数模板类型。支持值包括:“HIGH_STABILITY” - 高稳定模板,“HIGH_PERFORMANCE” - 高性能模板,默认值是:“HIGH_STABILITY”。

  • AlarmPolicyIdList:

    告警策略名数组,例如:,AlarmPolicyList不为空时该参数无效。

  • DryRun:

    是否只预检此次请求。true:发送检查请求,不会创建实例。检查项包括是否填写了必需参数,请求格式,业务限制等。如果检查不通过,则返回对应错误码;如果检查通过,则返回RequestId.默认为false:发送正常请求,通过检查后直接创建实例。

  • EngineType:

    实例引擎类型,默认为“InnoDB”,支持值包括:“InnoDB”,“RocksDB”。

  • Vips:

    指定实例的IP列表。仅支持主实例指定,按实例顺序,不足则按未指定处理。

  • DataProtectVolume:

    云盘版实例的数据保护空间大小,单位 GB,设置范围1 - 10。

  • ClusterTopology:

    云盘版节点拓扑配置。

  • DiskType:

    硬盘类型,单节点(云盘)或者云盘版实例可以指定此参数。CLOUD_SSD 表示 SSD 云硬盘,CLOUD_HSSD 表示增强型 SSD 云硬盘,CLOUD_PREMIUM 表示高性能云硬盘。

  • ClusterType:

    集群类型:cage——金融围拢,cdc——CDB ON CDC;dedicate——独享集群

  • DestroyProtect:

    开启或关闭实例销毁保护。on-开启,off-关闭



3169
3170
3171
# File 'lib/v20170320/models.rb', line 3169

def MasterRegion
  @MasterRegion
end

#MemoryObject

说明:创建非云盘版实例时,请根据需要指定实例版本(推荐5.7或8.0),若此参数不填,则默认值为8.0;若创建的是云盘版实例,则此参数仅能指定为5.7或8.0。说明:如果创建的是云盘版实例,此参数为必填且为私有网络类型。若此项不填,则系统会选择默认的 VPC。说明:若此项不填,则系统会选择默认 VPC 下的默认子网。说明:若您创建单节点、双节点、三节点实例,此参数为必填项,请指定可用区,若不指定可用区,则系统会自动选择一个可用区(可能不是您希望部署的可用区);若您创建云盘版实例,此参数不填,请通过参数 ClusterTopology 进行读写节点和只读节点的可用区配置。说明:请选择实例类型,不填会默认选择 master。说明:不填则默认为3306。说明:表名大小写敏感的开启和关闭可通过参数 lower_case_table_names 进行设置,参数值为0表示开启,参数值为1表示关闭,若不设置则此参数默认值为0。若您创建的是 MySQL 8.0 版本的实例,则需要在创建实例时通过设置 lower_case_table_names 参数来开启或关闭表名大小写敏感,创建实例后无法修改参数,即创建后无法修改表名大小写敏感。其他数据库版本的实例支持在创建实例后修改 lower_case_table_names 参数。创建实例时设置表名大小写敏感的 API 调用方法请参见本文中的示例2。说明:双节点、三节点实例请指定此参数值,若不指定,则默认为 Zone 的值;云盘版实例此参数可不填,请通过参数 ClusterTopology 进行读写节点和只读节点的可用区配置;单节点实例为单可用区,无需指定此参数。说明:如果创建的是云盘版实例,此参数为必填。备注:如您使用自定义参数模板 id,可传入自定义参数模板 id;如您计划使用默认参数模板,该参数模板 id 传入 id 无效,需设置 ParamTemplateType。备注:如您需使用云数据库 MySQL 默认参数模板,请设置 ParamTemplateType。说明:若购买的是云盘版实例,此参数为必填,需设置云盘版实例的 RW 和 RO 节点拓扑,RO 节点范围是1 - 5个,请至少设置1个 RO 节点。说明:单节点(云盘)、云盘版实例硬盘类型所支持的地域略有不同,具体支持情况请参考 [地域和可用区](cloud.tencent.com/document/product/236/8458)。

Parameters:

  • GoodsNum:

    实例数量,默认值为 1,最小值 1,最大值为 100。

  • Memory:

    实例内存大小,单位:MB,请使用 [获取云数据库可售卖规格](cloud.tencent.com/document/api/236/17229) 接口获取可创建的内存规格。

  • Volume:

    实例硬盘大小,单位:GB,请使用 [获取云数据库可售卖规格](cloud.tencent.com/document/api/236/17229) 接口获取可创建的硬盘范围。

  • EngineVersion:

    MySQL 版本,值包括:5.5、5.6、5.7和8.0,请使用 [获取云数据库可售卖规格](cloud.tencent.com/document/api/236/17229) 接口获取可创建的实例版本。

  • UniqVpcId:

    私有网络 ID,请使用 [查询私有网络列表](/document/api/215/15778)。

  • UniqSubnetId:

    私有网络下的子网 ID,如果设置了 UniqVpcId,则 UniqSubnetId 必填,请使用 [查询子网列表](/document/api/215/15784)。

  • ProjectId:

    项目 ID,不填为默认项目。

  • Zone:

    可用区信息,请使用 [获取云数据库可售卖规格](cloud.tencent.com/document/api/236/17229) 接口获取可创建的可用区。

  • MasterInstanceId:

    实例 ID,购买只读实例或者灾备实例时必填,该字段表示只读实例或者灾备实例的主实例 ID,请使用 [查询实例列表](cloud.tencent.com/document/api/236/15872) 接口查询云数据库实例 ID。

  • InstanceRole:

    实例类型,支持值包括:master - 表示主实例,dr - 表示灾备实例,ro - 表示只读实例。

  • MasterRegion:

    主实例地域信息,购买灾备、RO实例时,该字段必填。

  • Port:

    自定义端口,端口支持范围:[1024 - 65535]。

  • Password:

    设置 root 账号密码,密码规则:8 - 64 个字符,至少包含字母、数字、字符(支持的字符:_+-&=!@#$%^*())中的两种,购买主实例时可指定该参数,购买只读实例或者灾备实例时指定该参数无意义。

  • ParamList:

    参数列表,参数格式如 ParamList.0.Name=auto_increment&ParamList.0.Value=1。可通过 [查询默认的可设置参数列表](cloud.tencent.com/document/api/236/32662) 查询支持设置的参数。

  • ProtectMode:

    数据复制方式,默认为 0,支持值包括:0 - 表示异步复制,1 - 表示半同步复制,2 - 表示强同步复制,购买主实例时可指定该参数,购买只读实例或者灾备实例时指定该参数无意义。

  • DeployMode:

    多可用区域,默认为 0,支持值包括:0 - 表示单可用区,1 - 表示多可用区,购买主实例时可指定该参数,购买只读实例或者灾备实例时指定该参数无意义。

  • SlaveZone:

    备库 1 的可用区信息。

  • BackupZone:

    备库 2 的可用区信息,默认为空,购买三节点主实例时可指定该参数。

  • SecurityGroup:

    安全组参数,可使用 [查询项目安全组信息](cloud.tencent.com/document/api/236/15850) 接口查询某个项目的安全组详情。

  • RoGroup:

    只读实例信息。购买只读实例时,该参数必传。

  • AutoRenewFlag:

    购买按量计费实例该字段无意义。

  • InstanceName:

    实例名称。一次购买多个实例命名会用后缀数字区分,例instanceName=db,goodsNum=3,实例命名分别为db1,db2,db3。

  • ResourceTags:

    实例标签信息。

  • DeployGroupId:

    置放群组 ID。

  • ClientToken:

    用于保证请求幂等性的字符串。该字符串由客户生成,需保证不同请求之间在48小时内唯一,最大值不超过64个ASCII字符。若不指定该参数,则无法保证请求的幂等性。

  • DeviceType:

    实例隔离类型。支持值包括:“UNIVERSAL” - 通用型实例,“EXCLUSIVE” - 独享型实例,“BASIC_V2” - ONTKE 单节点实例,“CLOUD_NATIVE_CLUSTER” - 云盘版标准型,“CLOUD_NATIVE_CLUSTER_EXCLUSIVE” - 云盘版加强型。不指定则默认为通用型实例。

  • ParamTemplateId:

    参数模板 id。

  • AlarmPolicyList:

    告警策略id数组。腾讯云可观测平台DescribeAlarmPolicy接口返回的OriginId。

  • InstanceNodes:

    实例节点数。对于 RO 和 基础版实例, 该值默认为1。 如果需要购买三节点实例, 请将该值设置为3 或指定 BackupZone 参数。当购买主实例,且未指定该参数和 BackupZone 参数时,该值默认是 2, 即购买两节点实例。

  • Cpu:

    实例cpu核数, 如果不传将根据memory指定的内存值自动填充对应的cpu值。

  • AutoSyncFlag:

    是否自动发起灾备同步功能。该参数仅对购买灾备实例生效。 可选值为:0 - 不自动发起灾备同步;1 - 自动发起灾备同步。该值默认为0。

  • CageId:

    金融围拢 ID 。

  • ParamTemplateType:

    默认参数模板类型。支持值包括:“HIGH_STABILITY” - 高稳定模板,“HIGH_PERFORMANCE” - 高性能模板,默认值是:“HIGH_STABILITY”。

  • AlarmPolicyIdList:

    告警策略名数组,例如:,AlarmPolicyList不为空时该参数无效。

  • DryRun:

    是否只预检此次请求。true:发送检查请求,不会创建实例。检查项包括是否填写了必需参数,请求格式,业务限制等。如果检查不通过,则返回对应错误码;如果检查通过,则返回RequestId.默认为false:发送正常请求,通过检查后直接创建实例。

  • EngineType:

    实例引擎类型,默认为“InnoDB”,支持值包括:“InnoDB”,“RocksDB”。

  • Vips:

    指定实例的IP列表。仅支持主实例指定,按实例顺序,不足则按未指定处理。

  • DataProtectVolume:

    云盘版实例的数据保护空间大小,单位 GB,设置范围1 - 10。

  • ClusterTopology:

    云盘版节点拓扑配置。

  • DiskType:

    硬盘类型,单节点(云盘)或者云盘版实例可以指定此参数。CLOUD_SSD 表示 SSD 云硬盘,CLOUD_HSSD 表示增强型 SSD 云硬盘,CLOUD_PREMIUM 表示高性能云硬盘。

  • ClusterType:

    集群类型:cage——金融围拢,cdc——CDB ON CDC;dedicate——独享集群

  • DestroyProtect:

    开启或关闭实例销毁保护。on-开启,off-关闭



3169
3170
3171
# File 'lib/v20170320/models.rb', line 3169

def Memory
  @Memory
end

#ParamListObject

说明:创建非云盘版实例时,请根据需要指定实例版本(推荐5.7或8.0),若此参数不填,则默认值为8.0;若创建的是云盘版实例,则此参数仅能指定为5.7或8.0。说明:如果创建的是云盘版实例,此参数为必填且为私有网络类型。若此项不填,则系统会选择默认的 VPC。说明:若此项不填,则系统会选择默认 VPC 下的默认子网。说明:若您创建单节点、双节点、三节点实例,此参数为必填项,请指定可用区,若不指定可用区,则系统会自动选择一个可用区(可能不是您希望部署的可用区);若您创建云盘版实例,此参数不填,请通过参数 ClusterTopology 进行读写节点和只读节点的可用区配置。说明:请选择实例类型,不填会默认选择 master。说明:不填则默认为3306。说明:表名大小写敏感的开启和关闭可通过参数 lower_case_table_names 进行设置,参数值为0表示开启,参数值为1表示关闭,若不设置则此参数默认值为0。若您创建的是 MySQL 8.0 版本的实例,则需要在创建实例时通过设置 lower_case_table_names 参数来开启或关闭表名大小写敏感,创建实例后无法修改参数,即创建后无法修改表名大小写敏感。其他数据库版本的实例支持在创建实例后修改 lower_case_table_names 参数。创建实例时设置表名大小写敏感的 API 调用方法请参见本文中的示例2。说明:双节点、三节点实例请指定此参数值,若不指定,则默认为 Zone 的值;云盘版实例此参数可不填,请通过参数 ClusterTopology 进行读写节点和只读节点的可用区配置;单节点实例为单可用区,无需指定此参数。说明:如果创建的是云盘版实例,此参数为必填。备注:如您使用自定义参数模板 id,可传入自定义参数模板 id;如您计划使用默认参数模板,该参数模板 id 传入 id 无效,需设置 ParamTemplateType。备注:如您需使用云数据库 MySQL 默认参数模板,请设置 ParamTemplateType。说明:若购买的是云盘版实例,此参数为必填,需设置云盘版实例的 RW 和 RO 节点拓扑,RO 节点范围是1 - 5个,请至少设置1个 RO 节点。说明:单节点(云盘)、云盘版实例硬盘类型所支持的地域略有不同,具体支持情况请参考 [地域和可用区](cloud.tencent.com/document/product/236/8458)。

Parameters:

  • GoodsNum:

    实例数量,默认值为 1,最小值 1,最大值为 100。

  • Memory:

    实例内存大小,单位:MB,请使用 [获取云数据库可售卖规格](cloud.tencent.com/document/api/236/17229) 接口获取可创建的内存规格。

  • Volume:

    实例硬盘大小,单位:GB,请使用 [获取云数据库可售卖规格](cloud.tencent.com/document/api/236/17229) 接口获取可创建的硬盘范围。

  • EngineVersion:

    MySQL 版本,值包括:5.5、5.6、5.7和8.0,请使用 [获取云数据库可售卖规格](cloud.tencent.com/document/api/236/17229) 接口获取可创建的实例版本。

  • UniqVpcId:

    私有网络 ID,请使用 [查询私有网络列表](/document/api/215/15778)。

  • UniqSubnetId:

    私有网络下的子网 ID,如果设置了 UniqVpcId,则 UniqSubnetId 必填,请使用 [查询子网列表](/document/api/215/15784)。

  • ProjectId:

    项目 ID,不填为默认项目。

  • Zone:

    可用区信息,请使用 [获取云数据库可售卖规格](cloud.tencent.com/document/api/236/17229) 接口获取可创建的可用区。

  • MasterInstanceId:

    实例 ID,购买只读实例或者灾备实例时必填,该字段表示只读实例或者灾备实例的主实例 ID,请使用 [查询实例列表](cloud.tencent.com/document/api/236/15872) 接口查询云数据库实例 ID。

  • InstanceRole:

    实例类型,支持值包括:master - 表示主实例,dr - 表示灾备实例,ro - 表示只读实例。

  • MasterRegion:

    主实例地域信息,购买灾备、RO实例时,该字段必填。

  • Port:

    自定义端口,端口支持范围:[1024 - 65535]。

  • Password:

    设置 root 账号密码,密码规则:8 - 64 个字符,至少包含字母、数字、字符(支持的字符:_+-&=!@#$%^*())中的两种,购买主实例时可指定该参数,购买只读实例或者灾备实例时指定该参数无意义。

  • ParamList:

    参数列表,参数格式如 ParamList.0.Name=auto_increment&ParamList.0.Value=1。可通过 [查询默认的可设置参数列表](cloud.tencent.com/document/api/236/32662) 查询支持设置的参数。

  • ProtectMode:

    数据复制方式,默认为 0,支持值包括:0 - 表示异步复制,1 - 表示半同步复制,2 - 表示强同步复制,购买主实例时可指定该参数,购买只读实例或者灾备实例时指定该参数无意义。

  • DeployMode:

    多可用区域,默认为 0,支持值包括:0 - 表示单可用区,1 - 表示多可用区,购买主实例时可指定该参数,购买只读实例或者灾备实例时指定该参数无意义。

  • SlaveZone:

    备库 1 的可用区信息。

  • BackupZone:

    备库 2 的可用区信息,默认为空,购买三节点主实例时可指定该参数。

  • SecurityGroup:

    安全组参数,可使用 [查询项目安全组信息](cloud.tencent.com/document/api/236/15850) 接口查询某个项目的安全组详情。

  • RoGroup:

    只读实例信息。购买只读实例时,该参数必传。

  • AutoRenewFlag:

    购买按量计费实例该字段无意义。

  • InstanceName:

    实例名称。一次购买多个实例命名会用后缀数字区分,例instanceName=db,goodsNum=3,实例命名分别为db1,db2,db3。

  • ResourceTags:

    实例标签信息。

  • DeployGroupId:

    置放群组 ID。

  • ClientToken:

    用于保证请求幂等性的字符串。该字符串由客户生成,需保证不同请求之间在48小时内唯一,最大值不超过64个ASCII字符。若不指定该参数,则无法保证请求的幂等性。

  • DeviceType:

    实例隔离类型。支持值包括:“UNIVERSAL” - 通用型实例,“EXCLUSIVE” - 独享型实例,“BASIC_V2” - ONTKE 单节点实例,“CLOUD_NATIVE_CLUSTER” - 云盘版标准型,“CLOUD_NATIVE_CLUSTER_EXCLUSIVE” - 云盘版加强型。不指定则默认为通用型实例。

  • ParamTemplateId:

    参数模板 id。

  • AlarmPolicyList:

    告警策略id数组。腾讯云可观测平台DescribeAlarmPolicy接口返回的OriginId。

  • InstanceNodes:

    实例节点数。对于 RO 和 基础版实例, 该值默认为1。 如果需要购买三节点实例, 请将该值设置为3 或指定 BackupZone 参数。当购买主实例,且未指定该参数和 BackupZone 参数时,该值默认是 2, 即购买两节点实例。

  • Cpu:

    实例cpu核数, 如果不传将根据memory指定的内存值自动填充对应的cpu值。

  • AutoSyncFlag:

    是否自动发起灾备同步功能。该参数仅对购买灾备实例生效。 可选值为:0 - 不自动发起灾备同步;1 - 自动发起灾备同步。该值默认为0。

  • CageId:

    金融围拢 ID 。

  • ParamTemplateType:

    默认参数模板类型。支持值包括:“HIGH_STABILITY” - 高稳定模板,“HIGH_PERFORMANCE” - 高性能模板,默认值是:“HIGH_STABILITY”。

  • AlarmPolicyIdList:

    告警策略名数组,例如:,AlarmPolicyList不为空时该参数无效。

  • DryRun:

    是否只预检此次请求。true:发送检查请求,不会创建实例。检查项包括是否填写了必需参数,请求格式,业务限制等。如果检查不通过,则返回对应错误码;如果检查通过,则返回RequestId.默认为false:发送正常请求,通过检查后直接创建实例。

  • EngineType:

    实例引擎类型,默认为“InnoDB”,支持值包括:“InnoDB”,“RocksDB”。

  • Vips:

    指定实例的IP列表。仅支持主实例指定,按实例顺序,不足则按未指定处理。

  • DataProtectVolume:

    云盘版实例的数据保护空间大小,单位 GB,设置范围1 - 10。

  • ClusterTopology:

    云盘版节点拓扑配置。

  • DiskType:

    硬盘类型,单节点(云盘)或者云盘版实例可以指定此参数。CLOUD_SSD 表示 SSD 云硬盘,CLOUD_HSSD 表示增强型 SSD 云硬盘,CLOUD_PREMIUM 表示高性能云硬盘。

  • ClusterType:

    集群类型:cage——金融围拢,cdc——CDB ON CDC;dedicate——独享集群

  • DestroyProtect:

    开启或关闭实例销毁保护。on-开启,off-关闭



3169
3170
3171
# File 'lib/v20170320/models.rb', line 3169

def ParamList
  @ParamList
end

#ParamTemplateIdObject

说明:创建非云盘版实例时,请根据需要指定实例版本(推荐5.7或8.0),若此参数不填,则默认值为8.0;若创建的是云盘版实例,则此参数仅能指定为5.7或8.0。说明:如果创建的是云盘版实例,此参数为必填且为私有网络类型。若此项不填,则系统会选择默认的 VPC。说明:若此项不填,则系统会选择默认 VPC 下的默认子网。说明:若您创建单节点、双节点、三节点实例,此参数为必填项,请指定可用区,若不指定可用区,则系统会自动选择一个可用区(可能不是您希望部署的可用区);若您创建云盘版实例,此参数不填,请通过参数 ClusterTopology 进行读写节点和只读节点的可用区配置。说明:请选择实例类型,不填会默认选择 master。说明:不填则默认为3306。说明:表名大小写敏感的开启和关闭可通过参数 lower_case_table_names 进行设置,参数值为0表示开启,参数值为1表示关闭,若不设置则此参数默认值为0。若您创建的是 MySQL 8.0 版本的实例,则需要在创建实例时通过设置 lower_case_table_names 参数来开启或关闭表名大小写敏感,创建实例后无法修改参数,即创建后无法修改表名大小写敏感。其他数据库版本的实例支持在创建实例后修改 lower_case_table_names 参数。创建实例时设置表名大小写敏感的 API 调用方法请参见本文中的示例2。说明:双节点、三节点实例请指定此参数值,若不指定,则默认为 Zone 的值;云盘版实例此参数可不填,请通过参数 ClusterTopology 进行读写节点和只读节点的可用区配置;单节点实例为单可用区,无需指定此参数。说明:如果创建的是云盘版实例,此参数为必填。备注:如您使用自定义参数模板 id,可传入自定义参数模板 id;如您计划使用默认参数模板,该参数模板 id 传入 id 无效,需设置 ParamTemplateType。备注:如您需使用云数据库 MySQL 默认参数模板,请设置 ParamTemplateType。说明:若购买的是云盘版实例,此参数为必填,需设置云盘版实例的 RW 和 RO 节点拓扑,RO 节点范围是1 - 5个,请至少设置1个 RO 节点。说明:单节点(云盘)、云盘版实例硬盘类型所支持的地域略有不同,具体支持情况请参考 [地域和可用区](cloud.tencent.com/document/product/236/8458)。

Parameters:

  • GoodsNum:

    实例数量,默认值为 1,最小值 1,最大值为 100。

  • Memory:

    实例内存大小,单位:MB,请使用 [获取云数据库可售卖规格](cloud.tencent.com/document/api/236/17229) 接口获取可创建的内存规格。

  • Volume:

    实例硬盘大小,单位:GB,请使用 [获取云数据库可售卖规格](cloud.tencent.com/document/api/236/17229) 接口获取可创建的硬盘范围。

  • EngineVersion:

    MySQL 版本,值包括:5.5、5.6、5.7和8.0,请使用 [获取云数据库可售卖规格](cloud.tencent.com/document/api/236/17229) 接口获取可创建的实例版本。

  • UniqVpcId:

    私有网络 ID,请使用 [查询私有网络列表](/document/api/215/15778)。

  • UniqSubnetId:

    私有网络下的子网 ID,如果设置了 UniqVpcId,则 UniqSubnetId 必填,请使用 [查询子网列表](/document/api/215/15784)。

  • ProjectId:

    项目 ID,不填为默认项目。

  • Zone:

    可用区信息,请使用 [获取云数据库可售卖规格](cloud.tencent.com/document/api/236/17229) 接口获取可创建的可用区。

  • MasterInstanceId:

    实例 ID,购买只读实例或者灾备实例时必填,该字段表示只读实例或者灾备实例的主实例 ID,请使用 [查询实例列表](cloud.tencent.com/document/api/236/15872) 接口查询云数据库实例 ID。

  • InstanceRole:

    实例类型,支持值包括:master - 表示主实例,dr - 表示灾备实例,ro - 表示只读实例。

  • MasterRegion:

    主实例地域信息,购买灾备、RO实例时,该字段必填。

  • Port:

    自定义端口,端口支持范围:[1024 - 65535]。

  • Password:

    设置 root 账号密码,密码规则:8 - 64 个字符,至少包含字母、数字、字符(支持的字符:_+-&=!@#$%^*())中的两种,购买主实例时可指定该参数,购买只读实例或者灾备实例时指定该参数无意义。

  • ParamList:

    参数列表,参数格式如 ParamList.0.Name=auto_increment&ParamList.0.Value=1。可通过 [查询默认的可设置参数列表](cloud.tencent.com/document/api/236/32662) 查询支持设置的参数。

  • ProtectMode:

    数据复制方式,默认为 0,支持值包括:0 - 表示异步复制,1 - 表示半同步复制,2 - 表示强同步复制,购买主实例时可指定该参数,购买只读实例或者灾备实例时指定该参数无意义。

  • DeployMode:

    多可用区域,默认为 0,支持值包括:0 - 表示单可用区,1 - 表示多可用区,购买主实例时可指定该参数,购买只读实例或者灾备实例时指定该参数无意义。

  • SlaveZone:

    备库 1 的可用区信息。

  • BackupZone:

    备库 2 的可用区信息,默认为空,购买三节点主实例时可指定该参数。

  • SecurityGroup:

    安全组参数,可使用 [查询项目安全组信息](cloud.tencent.com/document/api/236/15850) 接口查询某个项目的安全组详情。

  • RoGroup:

    只读实例信息。购买只读实例时,该参数必传。

  • AutoRenewFlag:

    购买按量计费实例该字段无意义。

  • InstanceName:

    实例名称。一次购买多个实例命名会用后缀数字区分,例instanceName=db,goodsNum=3,实例命名分别为db1,db2,db3。

  • ResourceTags:

    实例标签信息。

  • DeployGroupId:

    置放群组 ID。

  • ClientToken:

    用于保证请求幂等性的字符串。该字符串由客户生成,需保证不同请求之间在48小时内唯一,最大值不超过64个ASCII字符。若不指定该参数,则无法保证请求的幂等性。

  • DeviceType:

    实例隔离类型。支持值包括:“UNIVERSAL” - 通用型实例,“EXCLUSIVE” - 独享型实例,“BASIC_V2” - ONTKE 单节点实例,“CLOUD_NATIVE_CLUSTER” - 云盘版标准型,“CLOUD_NATIVE_CLUSTER_EXCLUSIVE” - 云盘版加强型。不指定则默认为通用型实例。

  • ParamTemplateId:

    参数模板 id。

  • AlarmPolicyList:

    告警策略id数组。腾讯云可观测平台DescribeAlarmPolicy接口返回的OriginId。

  • InstanceNodes:

    实例节点数。对于 RO 和 基础版实例, 该值默认为1。 如果需要购买三节点实例, 请将该值设置为3 或指定 BackupZone 参数。当购买主实例,且未指定该参数和 BackupZone 参数时,该值默认是 2, 即购买两节点实例。

  • Cpu:

    实例cpu核数, 如果不传将根据memory指定的内存值自动填充对应的cpu值。

  • AutoSyncFlag:

    是否自动发起灾备同步功能。该参数仅对购买灾备实例生效。 可选值为:0 - 不自动发起灾备同步;1 - 自动发起灾备同步。该值默认为0。

  • CageId:

    金融围拢 ID 。

  • ParamTemplateType:

    默认参数模板类型。支持值包括:“HIGH_STABILITY” - 高稳定模板,“HIGH_PERFORMANCE” - 高性能模板,默认值是:“HIGH_STABILITY”。

  • AlarmPolicyIdList:

    告警策略名数组,例如:,AlarmPolicyList不为空时该参数无效。

  • DryRun:

    是否只预检此次请求。true:发送检查请求,不会创建实例。检查项包括是否填写了必需参数,请求格式,业务限制等。如果检查不通过,则返回对应错误码;如果检查通过,则返回RequestId.默认为false:发送正常请求,通过检查后直接创建实例。

  • EngineType:

    实例引擎类型,默认为“InnoDB”,支持值包括:“InnoDB”,“RocksDB”。

  • Vips:

    指定实例的IP列表。仅支持主实例指定,按实例顺序,不足则按未指定处理。

  • DataProtectVolume:

    云盘版实例的数据保护空间大小,单位 GB,设置范围1 - 10。

  • ClusterTopology:

    云盘版节点拓扑配置。

  • DiskType:

    硬盘类型,单节点(云盘)或者云盘版实例可以指定此参数。CLOUD_SSD 表示 SSD 云硬盘,CLOUD_HSSD 表示增强型 SSD 云硬盘,CLOUD_PREMIUM 表示高性能云硬盘。

  • ClusterType:

    集群类型:cage——金融围拢,cdc——CDB ON CDC;dedicate——独享集群

  • DestroyProtect:

    开启或关闭实例销毁保护。on-开启,off-关闭



3169
3170
3171
# File 'lib/v20170320/models.rb', line 3169

def ParamTemplateId
  @ParamTemplateId
end

#ParamTemplateTypeObject

说明:创建非云盘版实例时,请根据需要指定实例版本(推荐5.7或8.0),若此参数不填,则默认值为8.0;若创建的是云盘版实例,则此参数仅能指定为5.7或8.0。说明:如果创建的是云盘版实例,此参数为必填且为私有网络类型。若此项不填,则系统会选择默认的 VPC。说明:若此项不填,则系统会选择默认 VPC 下的默认子网。说明:若您创建单节点、双节点、三节点实例,此参数为必填项,请指定可用区,若不指定可用区,则系统会自动选择一个可用区(可能不是您希望部署的可用区);若您创建云盘版实例,此参数不填,请通过参数 ClusterTopology 进行读写节点和只读节点的可用区配置。说明:请选择实例类型,不填会默认选择 master。说明:不填则默认为3306。说明:表名大小写敏感的开启和关闭可通过参数 lower_case_table_names 进行设置,参数值为0表示开启,参数值为1表示关闭,若不设置则此参数默认值为0。若您创建的是 MySQL 8.0 版本的实例,则需要在创建实例时通过设置 lower_case_table_names 参数来开启或关闭表名大小写敏感,创建实例后无法修改参数,即创建后无法修改表名大小写敏感。其他数据库版本的实例支持在创建实例后修改 lower_case_table_names 参数。创建实例时设置表名大小写敏感的 API 调用方法请参见本文中的示例2。说明:双节点、三节点实例请指定此参数值,若不指定,则默认为 Zone 的值;云盘版实例此参数可不填,请通过参数 ClusterTopology 进行读写节点和只读节点的可用区配置;单节点实例为单可用区,无需指定此参数。说明:如果创建的是云盘版实例,此参数为必填。备注:如您使用自定义参数模板 id,可传入自定义参数模板 id;如您计划使用默认参数模板,该参数模板 id 传入 id 无效,需设置 ParamTemplateType。备注:如您需使用云数据库 MySQL 默认参数模板,请设置 ParamTemplateType。说明:若购买的是云盘版实例,此参数为必填,需设置云盘版实例的 RW 和 RO 节点拓扑,RO 节点范围是1 - 5个,请至少设置1个 RO 节点。说明:单节点(云盘)、云盘版实例硬盘类型所支持的地域略有不同,具体支持情况请参考 [地域和可用区](cloud.tencent.com/document/product/236/8458)。

Parameters:

  • GoodsNum:

    实例数量,默认值为 1,最小值 1,最大值为 100。

  • Memory:

    实例内存大小,单位:MB,请使用 [获取云数据库可售卖规格](cloud.tencent.com/document/api/236/17229) 接口获取可创建的内存规格。

  • Volume:

    实例硬盘大小,单位:GB,请使用 [获取云数据库可售卖规格](cloud.tencent.com/document/api/236/17229) 接口获取可创建的硬盘范围。

  • EngineVersion:

    MySQL 版本,值包括:5.5、5.6、5.7和8.0,请使用 [获取云数据库可售卖规格](cloud.tencent.com/document/api/236/17229) 接口获取可创建的实例版本。

  • UniqVpcId:

    私有网络 ID,请使用 [查询私有网络列表](/document/api/215/15778)。

  • UniqSubnetId:

    私有网络下的子网 ID,如果设置了 UniqVpcId,则 UniqSubnetId 必填,请使用 [查询子网列表](/document/api/215/15784)。

  • ProjectId:

    项目 ID,不填为默认项目。

  • Zone:

    可用区信息,请使用 [获取云数据库可售卖规格](cloud.tencent.com/document/api/236/17229) 接口获取可创建的可用区。

  • MasterInstanceId:

    实例 ID,购买只读实例或者灾备实例时必填,该字段表示只读实例或者灾备实例的主实例 ID,请使用 [查询实例列表](cloud.tencent.com/document/api/236/15872) 接口查询云数据库实例 ID。

  • InstanceRole:

    实例类型,支持值包括:master - 表示主实例,dr - 表示灾备实例,ro - 表示只读实例。

  • MasterRegion:

    主实例地域信息,购买灾备、RO实例时,该字段必填。

  • Port:

    自定义端口,端口支持范围:[1024 - 65535]。

  • Password:

    设置 root 账号密码,密码规则:8 - 64 个字符,至少包含字母、数字、字符(支持的字符:_+-&=!@#$%^*())中的两种,购买主实例时可指定该参数,购买只读实例或者灾备实例时指定该参数无意义。

  • ParamList:

    参数列表,参数格式如 ParamList.0.Name=auto_increment&ParamList.0.Value=1。可通过 [查询默认的可设置参数列表](cloud.tencent.com/document/api/236/32662) 查询支持设置的参数。

  • ProtectMode:

    数据复制方式,默认为 0,支持值包括:0 - 表示异步复制,1 - 表示半同步复制,2 - 表示强同步复制,购买主实例时可指定该参数,购买只读实例或者灾备实例时指定该参数无意义。

  • DeployMode:

    多可用区域,默认为 0,支持值包括:0 - 表示单可用区,1 - 表示多可用区,购买主实例时可指定该参数,购买只读实例或者灾备实例时指定该参数无意义。

  • SlaveZone:

    备库 1 的可用区信息。

  • BackupZone:

    备库 2 的可用区信息,默认为空,购买三节点主实例时可指定该参数。

  • SecurityGroup:

    安全组参数,可使用 [查询项目安全组信息](cloud.tencent.com/document/api/236/15850) 接口查询某个项目的安全组详情。

  • RoGroup:

    只读实例信息。购买只读实例时,该参数必传。

  • AutoRenewFlag:

    购买按量计费实例该字段无意义。

  • InstanceName:

    实例名称。一次购买多个实例命名会用后缀数字区分,例instanceName=db,goodsNum=3,实例命名分别为db1,db2,db3。

  • ResourceTags:

    实例标签信息。

  • DeployGroupId:

    置放群组 ID。

  • ClientToken:

    用于保证请求幂等性的字符串。该字符串由客户生成,需保证不同请求之间在48小时内唯一,最大值不超过64个ASCII字符。若不指定该参数,则无法保证请求的幂等性。

  • DeviceType:

    实例隔离类型。支持值包括:“UNIVERSAL” - 通用型实例,“EXCLUSIVE” - 独享型实例,“BASIC_V2” - ONTKE 单节点实例,“CLOUD_NATIVE_CLUSTER” - 云盘版标准型,“CLOUD_NATIVE_CLUSTER_EXCLUSIVE” - 云盘版加强型。不指定则默认为通用型实例。

  • ParamTemplateId:

    参数模板 id。

  • AlarmPolicyList:

    告警策略id数组。腾讯云可观测平台DescribeAlarmPolicy接口返回的OriginId。

  • InstanceNodes:

    实例节点数。对于 RO 和 基础版实例, 该值默认为1。 如果需要购买三节点实例, 请将该值设置为3 或指定 BackupZone 参数。当购买主实例,且未指定该参数和 BackupZone 参数时,该值默认是 2, 即购买两节点实例。

  • Cpu:

    实例cpu核数, 如果不传将根据memory指定的内存值自动填充对应的cpu值。

  • AutoSyncFlag:

    是否自动发起灾备同步功能。该参数仅对购买灾备实例生效。 可选值为:0 - 不自动发起灾备同步;1 - 自动发起灾备同步。该值默认为0。

  • CageId:

    金融围拢 ID 。

  • ParamTemplateType:

    默认参数模板类型。支持值包括:“HIGH_STABILITY” - 高稳定模板,“HIGH_PERFORMANCE” - 高性能模板,默认值是:“HIGH_STABILITY”。

  • AlarmPolicyIdList:

    告警策略名数组,例如:,AlarmPolicyList不为空时该参数无效。

  • DryRun:

    是否只预检此次请求。true:发送检查请求,不会创建实例。检查项包括是否填写了必需参数,请求格式,业务限制等。如果检查不通过,则返回对应错误码;如果检查通过,则返回RequestId.默认为false:发送正常请求,通过检查后直接创建实例。

  • EngineType:

    实例引擎类型,默认为“InnoDB”,支持值包括:“InnoDB”,“RocksDB”。

  • Vips:

    指定实例的IP列表。仅支持主实例指定,按实例顺序,不足则按未指定处理。

  • DataProtectVolume:

    云盘版实例的数据保护空间大小,单位 GB,设置范围1 - 10。

  • ClusterTopology:

    云盘版节点拓扑配置。

  • DiskType:

    硬盘类型,单节点(云盘)或者云盘版实例可以指定此参数。CLOUD_SSD 表示 SSD 云硬盘,CLOUD_HSSD 表示增强型 SSD 云硬盘,CLOUD_PREMIUM 表示高性能云硬盘。

  • ClusterType:

    集群类型:cage——金融围拢,cdc——CDB ON CDC;dedicate——独享集群

  • DestroyProtect:

    开启或关闭实例销毁保护。on-开启,off-关闭



3169
3170
3171
# File 'lib/v20170320/models.rb', line 3169

def ParamTemplateType
  @ParamTemplateType
end

#PasswordObject

说明:创建非云盘版实例时,请根据需要指定实例版本(推荐5.7或8.0),若此参数不填,则默认值为8.0;若创建的是云盘版实例,则此参数仅能指定为5.7或8.0。说明:如果创建的是云盘版实例,此参数为必填且为私有网络类型。若此项不填,则系统会选择默认的 VPC。说明:若此项不填,则系统会选择默认 VPC 下的默认子网。说明:若您创建单节点、双节点、三节点实例,此参数为必填项,请指定可用区,若不指定可用区,则系统会自动选择一个可用区(可能不是您希望部署的可用区);若您创建云盘版实例,此参数不填,请通过参数 ClusterTopology 进行读写节点和只读节点的可用区配置。说明:请选择实例类型,不填会默认选择 master。说明:不填则默认为3306。说明:表名大小写敏感的开启和关闭可通过参数 lower_case_table_names 进行设置,参数值为0表示开启,参数值为1表示关闭,若不设置则此参数默认值为0。若您创建的是 MySQL 8.0 版本的实例,则需要在创建实例时通过设置 lower_case_table_names 参数来开启或关闭表名大小写敏感,创建实例后无法修改参数,即创建后无法修改表名大小写敏感。其他数据库版本的实例支持在创建实例后修改 lower_case_table_names 参数。创建实例时设置表名大小写敏感的 API 调用方法请参见本文中的示例2。说明:双节点、三节点实例请指定此参数值,若不指定,则默认为 Zone 的值;云盘版实例此参数可不填,请通过参数 ClusterTopology 进行读写节点和只读节点的可用区配置;单节点实例为单可用区,无需指定此参数。说明:如果创建的是云盘版实例,此参数为必填。备注:如您使用自定义参数模板 id,可传入自定义参数模板 id;如您计划使用默认参数模板,该参数模板 id 传入 id 无效,需设置 ParamTemplateType。备注:如您需使用云数据库 MySQL 默认参数模板,请设置 ParamTemplateType。说明:若购买的是云盘版实例,此参数为必填,需设置云盘版实例的 RW 和 RO 节点拓扑,RO 节点范围是1 - 5个,请至少设置1个 RO 节点。说明:单节点(云盘)、云盘版实例硬盘类型所支持的地域略有不同,具体支持情况请参考 [地域和可用区](cloud.tencent.com/document/product/236/8458)。

Parameters:

  • GoodsNum:

    实例数量,默认值为 1,最小值 1,最大值为 100。

  • Memory:

    实例内存大小,单位:MB,请使用 [获取云数据库可售卖规格](cloud.tencent.com/document/api/236/17229) 接口获取可创建的内存规格。

  • Volume:

    实例硬盘大小,单位:GB,请使用 [获取云数据库可售卖规格](cloud.tencent.com/document/api/236/17229) 接口获取可创建的硬盘范围。

  • EngineVersion:

    MySQL 版本,值包括:5.5、5.6、5.7和8.0,请使用 [获取云数据库可售卖规格](cloud.tencent.com/document/api/236/17229) 接口获取可创建的实例版本。

  • UniqVpcId:

    私有网络 ID,请使用 [查询私有网络列表](/document/api/215/15778)。

  • UniqSubnetId:

    私有网络下的子网 ID,如果设置了 UniqVpcId,则 UniqSubnetId 必填,请使用 [查询子网列表](/document/api/215/15784)。

  • ProjectId:

    项目 ID,不填为默认项目。

  • Zone:

    可用区信息,请使用 [获取云数据库可售卖规格](cloud.tencent.com/document/api/236/17229) 接口获取可创建的可用区。

  • MasterInstanceId:

    实例 ID,购买只读实例或者灾备实例时必填,该字段表示只读实例或者灾备实例的主实例 ID,请使用 [查询实例列表](cloud.tencent.com/document/api/236/15872) 接口查询云数据库实例 ID。

  • InstanceRole:

    实例类型,支持值包括:master - 表示主实例,dr - 表示灾备实例,ro - 表示只读实例。

  • MasterRegion:

    主实例地域信息,购买灾备、RO实例时,该字段必填。

  • Port:

    自定义端口,端口支持范围:[1024 - 65535]。

  • Password:

    设置 root 账号密码,密码规则:8 - 64 个字符,至少包含字母、数字、字符(支持的字符:_+-&=!@#$%^*())中的两种,购买主实例时可指定该参数,购买只读实例或者灾备实例时指定该参数无意义。

  • ParamList:

    参数列表,参数格式如 ParamList.0.Name=auto_increment&ParamList.0.Value=1。可通过 [查询默认的可设置参数列表](cloud.tencent.com/document/api/236/32662) 查询支持设置的参数。

  • ProtectMode:

    数据复制方式,默认为 0,支持值包括:0 - 表示异步复制,1 - 表示半同步复制,2 - 表示强同步复制,购买主实例时可指定该参数,购买只读实例或者灾备实例时指定该参数无意义。

  • DeployMode:

    多可用区域,默认为 0,支持值包括:0 - 表示单可用区,1 - 表示多可用区,购买主实例时可指定该参数,购买只读实例或者灾备实例时指定该参数无意义。

  • SlaveZone:

    备库 1 的可用区信息。

  • BackupZone:

    备库 2 的可用区信息,默认为空,购买三节点主实例时可指定该参数。

  • SecurityGroup:

    安全组参数,可使用 [查询项目安全组信息](cloud.tencent.com/document/api/236/15850) 接口查询某个项目的安全组详情。

  • RoGroup:

    只读实例信息。购买只读实例时,该参数必传。

  • AutoRenewFlag:

    购买按量计费实例该字段无意义。

  • InstanceName:

    实例名称。一次购买多个实例命名会用后缀数字区分,例instanceName=db,goodsNum=3,实例命名分别为db1,db2,db3。

  • ResourceTags:

    实例标签信息。

  • DeployGroupId:

    置放群组 ID。

  • ClientToken:

    用于保证请求幂等性的字符串。该字符串由客户生成,需保证不同请求之间在48小时内唯一,最大值不超过64个ASCII字符。若不指定该参数,则无法保证请求的幂等性。

  • DeviceType:

    实例隔离类型。支持值包括:“UNIVERSAL” - 通用型实例,“EXCLUSIVE” - 独享型实例,“BASIC_V2” - ONTKE 单节点实例,“CLOUD_NATIVE_CLUSTER” - 云盘版标准型,“CLOUD_NATIVE_CLUSTER_EXCLUSIVE” - 云盘版加强型。不指定则默认为通用型实例。

  • ParamTemplateId:

    参数模板 id。

  • AlarmPolicyList:

    告警策略id数组。腾讯云可观测平台DescribeAlarmPolicy接口返回的OriginId。

  • InstanceNodes:

    实例节点数。对于 RO 和 基础版实例, 该值默认为1。 如果需要购买三节点实例, 请将该值设置为3 或指定 BackupZone 参数。当购买主实例,且未指定该参数和 BackupZone 参数时,该值默认是 2, 即购买两节点实例。

  • Cpu:

    实例cpu核数, 如果不传将根据memory指定的内存值自动填充对应的cpu值。

  • AutoSyncFlag:

    是否自动发起灾备同步功能。该参数仅对购买灾备实例生效。 可选值为:0 - 不自动发起灾备同步;1 - 自动发起灾备同步。该值默认为0。

  • CageId:

    金融围拢 ID 。

  • ParamTemplateType:

    默认参数模板类型。支持值包括:“HIGH_STABILITY” - 高稳定模板,“HIGH_PERFORMANCE” - 高性能模板,默认值是:“HIGH_STABILITY”。

  • AlarmPolicyIdList:

    告警策略名数组,例如:,AlarmPolicyList不为空时该参数无效。

  • DryRun:

    是否只预检此次请求。true:发送检查请求,不会创建实例。检查项包括是否填写了必需参数,请求格式,业务限制等。如果检查不通过,则返回对应错误码;如果检查通过,则返回RequestId.默认为false:发送正常请求,通过检查后直接创建实例。

  • EngineType:

    实例引擎类型,默认为“InnoDB”,支持值包括:“InnoDB”,“RocksDB”。

  • Vips:

    指定实例的IP列表。仅支持主实例指定,按实例顺序,不足则按未指定处理。

  • DataProtectVolume:

    云盘版实例的数据保护空间大小,单位 GB,设置范围1 - 10。

  • ClusterTopology:

    云盘版节点拓扑配置。

  • DiskType:

    硬盘类型,单节点(云盘)或者云盘版实例可以指定此参数。CLOUD_SSD 表示 SSD 云硬盘,CLOUD_HSSD 表示增强型 SSD 云硬盘,CLOUD_PREMIUM 表示高性能云硬盘。

  • ClusterType:

    集群类型:cage——金融围拢,cdc——CDB ON CDC;dedicate——独享集群

  • DestroyProtect:

    开启或关闭实例销毁保护。on-开启,off-关闭



3169
3170
3171
# File 'lib/v20170320/models.rb', line 3169

def Password
  @Password
end

#PortObject

说明:创建非云盘版实例时,请根据需要指定实例版本(推荐5.7或8.0),若此参数不填,则默认值为8.0;若创建的是云盘版实例,则此参数仅能指定为5.7或8.0。说明:如果创建的是云盘版实例,此参数为必填且为私有网络类型。若此项不填,则系统会选择默认的 VPC。说明:若此项不填,则系统会选择默认 VPC 下的默认子网。说明:若您创建单节点、双节点、三节点实例,此参数为必填项,请指定可用区,若不指定可用区,则系统会自动选择一个可用区(可能不是您希望部署的可用区);若您创建云盘版实例,此参数不填,请通过参数 ClusterTopology 进行读写节点和只读节点的可用区配置。说明:请选择实例类型,不填会默认选择 master。说明:不填则默认为3306。说明:表名大小写敏感的开启和关闭可通过参数 lower_case_table_names 进行设置,参数值为0表示开启,参数值为1表示关闭,若不设置则此参数默认值为0。若您创建的是 MySQL 8.0 版本的实例,则需要在创建实例时通过设置 lower_case_table_names 参数来开启或关闭表名大小写敏感,创建实例后无法修改参数,即创建后无法修改表名大小写敏感。其他数据库版本的实例支持在创建实例后修改 lower_case_table_names 参数。创建实例时设置表名大小写敏感的 API 调用方法请参见本文中的示例2。说明:双节点、三节点实例请指定此参数值,若不指定,则默认为 Zone 的值;云盘版实例此参数可不填,请通过参数 ClusterTopology 进行读写节点和只读节点的可用区配置;单节点实例为单可用区,无需指定此参数。说明:如果创建的是云盘版实例,此参数为必填。备注:如您使用自定义参数模板 id,可传入自定义参数模板 id;如您计划使用默认参数模板,该参数模板 id 传入 id 无效,需设置 ParamTemplateType。备注:如您需使用云数据库 MySQL 默认参数模板,请设置 ParamTemplateType。说明:若购买的是云盘版实例,此参数为必填,需设置云盘版实例的 RW 和 RO 节点拓扑,RO 节点范围是1 - 5个,请至少设置1个 RO 节点。说明:单节点(云盘)、云盘版实例硬盘类型所支持的地域略有不同,具体支持情况请参考 [地域和可用区](cloud.tencent.com/document/product/236/8458)。

Parameters:

  • GoodsNum:

    实例数量,默认值为 1,最小值 1,最大值为 100。

  • Memory:

    实例内存大小,单位:MB,请使用 [获取云数据库可售卖规格](cloud.tencent.com/document/api/236/17229) 接口获取可创建的内存规格。

  • Volume:

    实例硬盘大小,单位:GB,请使用 [获取云数据库可售卖规格](cloud.tencent.com/document/api/236/17229) 接口获取可创建的硬盘范围。

  • EngineVersion:

    MySQL 版本,值包括:5.5、5.6、5.7和8.0,请使用 [获取云数据库可售卖规格](cloud.tencent.com/document/api/236/17229) 接口获取可创建的实例版本。

  • UniqVpcId:

    私有网络 ID,请使用 [查询私有网络列表](/document/api/215/15778)。

  • UniqSubnetId:

    私有网络下的子网 ID,如果设置了 UniqVpcId,则 UniqSubnetId 必填,请使用 [查询子网列表](/document/api/215/15784)。

  • ProjectId:

    项目 ID,不填为默认项目。

  • Zone:

    可用区信息,请使用 [获取云数据库可售卖规格](cloud.tencent.com/document/api/236/17229) 接口获取可创建的可用区。

  • MasterInstanceId:

    实例 ID,购买只读实例或者灾备实例时必填,该字段表示只读实例或者灾备实例的主实例 ID,请使用 [查询实例列表](cloud.tencent.com/document/api/236/15872) 接口查询云数据库实例 ID。

  • InstanceRole:

    实例类型,支持值包括:master - 表示主实例,dr - 表示灾备实例,ro - 表示只读实例。

  • MasterRegion:

    主实例地域信息,购买灾备、RO实例时,该字段必填。

  • Port:

    自定义端口,端口支持范围:[1024 - 65535]。

  • Password:

    设置 root 账号密码,密码规则:8 - 64 个字符,至少包含字母、数字、字符(支持的字符:_+-&=!@#$%^*())中的两种,购买主实例时可指定该参数,购买只读实例或者灾备实例时指定该参数无意义。

  • ParamList:

    参数列表,参数格式如 ParamList.0.Name=auto_increment&ParamList.0.Value=1。可通过 [查询默认的可设置参数列表](cloud.tencent.com/document/api/236/32662) 查询支持设置的参数。

  • ProtectMode:

    数据复制方式,默认为 0,支持值包括:0 - 表示异步复制,1 - 表示半同步复制,2 - 表示强同步复制,购买主实例时可指定该参数,购买只读实例或者灾备实例时指定该参数无意义。

  • DeployMode:

    多可用区域,默认为 0,支持值包括:0 - 表示单可用区,1 - 表示多可用区,购买主实例时可指定该参数,购买只读实例或者灾备实例时指定该参数无意义。

  • SlaveZone:

    备库 1 的可用区信息。

  • BackupZone:

    备库 2 的可用区信息,默认为空,购买三节点主实例时可指定该参数。

  • SecurityGroup:

    安全组参数,可使用 [查询项目安全组信息](cloud.tencent.com/document/api/236/15850) 接口查询某个项目的安全组详情。

  • RoGroup:

    只读实例信息。购买只读实例时,该参数必传。

  • AutoRenewFlag:

    购买按量计费实例该字段无意义。

  • InstanceName:

    实例名称。一次购买多个实例命名会用后缀数字区分,例instanceName=db,goodsNum=3,实例命名分别为db1,db2,db3。

  • ResourceTags:

    实例标签信息。

  • DeployGroupId:

    置放群组 ID。

  • ClientToken:

    用于保证请求幂等性的字符串。该字符串由客户生成,需保证不同请求之间在48小时内唯一,最大值不超过64个ASCII字符。若不指定该参数,则无法保证请求的幂等性。

  • DeviceType:

    实例隔离类型。支持值包括:“UNIVERSAL” - 通用型实例,“EXCLUSIVE” - 独享型实例,“BASIC_V2” - ONTKE 单节点实例,“CLOUD_NATIVE_CLUSTER” - 云盘版标准型,“CLOUD_NATIVE_CLUSTER_EXCLUSIVE” - 云盘版加强型。不指定则默认为通用型实例。

  • ParamTemplateId:

    参数模板 id。

  • AlarmPolicyList:

    告警策略id数组。腾讯云可观测平台DescribeAlarmPolicy接口返回的OriginId。

  • InstanceNodes:

    实例节点数。对于 RO 和 基础版实例, 该值默认为1。 如果需要购买三节点实例, 请将该值设置为3 或指定 BackupZone 参数。当购买主实例,且未指定该参数和 BackupZone 参数时,该值默认是 2, 即购买两节点实例。

  • Cpu:

    实例cpu核数, 如果不传将根据memory指定的内存值自动填充对应的cpu值。

  • AutoSyncFlag:

    是否自动发起灾备同步功能。该参数仅对购买灾备实例生效。 可选值为:0 - 不自动发起灾备同步;1 - 自动发起灾备同步。该值默认为0。

  • CageId:

    金融围拢 ID 。

  • ParamTemplateType:

    默认参数模板类型。支持值包括:“HIGH_STABILITY” - 高稳定模板,“HIGH_PERFORMANCE” - 高性能模板,默认值是:“HIGH_STABILITY”。

  • AlarmPolicyIdList:

    告警策略名数组,例如:,AlarmPolicyList不为空时该参数无效。

  • DryRun:

    是否只预检此次请求。true:发送检查请求,不会创建实例。检查项包括是否填写了必需参数,请求格式,业务限制等。如果检查不通过,则返回对应错误码;如果检查通过,则返回RequestId.默认为false:发送正常请求,通过检查后直接创建实例。

  • EngineType:

    实例引擎类型,默认为“InnoDB”,支持值包括:“InnoDB”,“RocksDB”。

  • Vips:

    指定实例的IP列表。仅支持主实例指定,按实例顺序,不足则按未指定处理。

  • DataProtectVolume:

    云盘版实例的数据保护空间大小,单位 GB,设置范围1 - 10。

  • ClusterTopology:

    云盘版节点拓扑配置。

  • DiskType:

    硬盘类型,单节点(云盘)或者云盘版实例可以指定此参数。CLOUD_SSD 表示 SSD 云硬盘,CLOUD_HSSD 表示增强型 SSD 云硬盘,CLOUD_PREMIUM 表示高性能云硬盘。

  • ClusterType:

    集群类型:cage——金融围拢,cdc——CDB ON CDC;dedicate——独享集群

  • DestroyProtect:

    开启或关闭实例销毁保护。on-开启,off-关闭



3169
3170
3171
# File 'lib/v20170320/models.rb', line 3169

def Port
  @Port
end

#ProjectIdObject

说明:创建非云盘版实例时,请根据需要指定实例版本(推荐5.7或8.0),若此参数不填,则默认值为8.0;若创建的是云盘版实例,则此参数仅能指定为5.7或8.0。说明:如果创建的是云盘版实例,此参数为必填且为私有网络类型。若此项不填,则系统会选择默认的 VPC。说明:若此项不填,则系统会选择默认 VPC 下的默认子网。说明:若您创建单节点、双节点、三节点实例,此参数为必填项,请指定可用区,若不指定可用区,则系统会自动选择一个可用区(可能不是您希望部署的可用区);若您创建云盘版实例,此参数不填,请通过参数 ClusterTopology 进行读写节点和只读节点的可用区配置。说明:请选择实例类型,不填会默认选择 master。说明:不填则默认为3306。说明:表名大小写敏感的开启和关闭可通过参数 lower_case_table_names 进行设置,参数值为0表示开启,参数值为1表示关闭,若不设置则此参数默认值为0。若您创建的是 MySQL 8.0 版本的实例,则需要在创建实例时通过设置 lower_case_table_names 参数来开启或关闭表名大小写敏感,创建实例后无法修改参数,即创建后无法修改表名大小写敏感。其他数据库版本的实例支持在创建实例后修改 lower_case_table_names 参数。创建实例时设置表名大小写敏感的 API 调用方法请参见本文中的示例2。说明:双节点、三节点实例请指定此参数值,若不指定,则默认为 Zone 的值;云盘版实例此参数可不填,请通过参数 ClusterTopology 进行读写节点和只读节点的可用区配置;单节点实例为单可用区,无需指定此参数。说明:如果创建的是云盘版实例,此参数为必填。备注:如您使用自定义参数模板 id,可传入自定义参数模板 id;如您计划使用默认参数模板,该参数模板 id 传入 id 无效,需设置 ParamTemplateType。备注:如您需使用云数据库 MySQL 默认参数模板,请设置 ParamTemplateType。说明:若购买的是云盘版实例,此参数为必填,需设置云盘版实例的 RW 和 RO 节点拓扑,RO 节点范围是1 - 5个,请至少设置1个 RO 节点。说明:单节点(云盘)、云盘版实例硬盘类型所支持的地域略有不同,具体支持情况请参考 [地域和可用区](cloud.tencent.com/document/product/236/8458)。

Parameters:

  • GoodsNum:

    实例数量,默认值为 1,最小值 1,最大值为 100。

  • Memory:

    实例内存大小,单位:MB,请使用 [获取云数据库可售卖规格](cloud.tencent.com/document/api/236/17229) 接口获取可创建的内存规格。

  • Volume:

    实例硬盘大小,单位:GB,请使用 [获取云数据库可售卖规格](cloud.tencent.com/document/api/236/17229) 接口获取可创建的硬盘范围。

  • EngineVersion:

    MySQL 版本,值包括:5.5、5.6、5.7和8.0,请使用 [获取云数据库可售卖规格](cloud.tencent.com/document/api/236/17229) 接口获取可创建的实例版本。

  • UniqVpcId:

    私有网络 ID,请使用 [查询私有网络列表](/document/api/215/15778)。

  • UniqSubnetId:

    私有网络下的子网 ID,如果设置了 UniqVpcId,则 UniqSubnetId 必填,请使用 [查询子网列表](/document/api/215/15784)。

  • ProjectId:

    项目 ID,不填为默认项目。

  • Zone:

    可用区信息,请使用 [获取云数据库可售卖规格](cloud.tencent.com/document/api/236/17229) 接口获取可创建的可用区。

  • MasterInstanceId:

    实例 ID,购买只读实例或者灾备实例时必填,该字段表示只读实例或者灾备实例的主实例 ID,请使用 [查询实例列表](cloud.tencent.com/document/api/236/15872) 接口查询云数据库实例 ID。

  • InstanceRole:

    实例类型,支持值包括:master - 表示主实例,dr - 表示灾备实例,ro - 表示只读实例。

  • MasterRegion:

    主实例地域信息,购买灾备、RO实例时,该字段必填。

  • Port:

    自定义端口,端口支持范围:[1024 - 65535]。

  • Password:

    设置 root 账号密码,密码规则:8 - 64 个字符,至少包含字母、数字、字符(支持的字符:_+-&=!@#$%^*())中的两种,购买主实例时可指定该参数,购买只读实例或者灾备实例时指定该参数无意义。

  • ParamList:

    参数列表,参数格式如 ParamList.0.Name=auto_increment&ParamList.0.Value=1。可通过 [查询默认的可设置参数列表](cloud.tencent.com/document/api/236/32662) 查询支持设置的参数。

  • ProtectMode:

    数据复制方式,默认为 0,支持值包括:0 - 表示异步复制,1 - 表示半同步复制,2 - 表示强同步复制,购买主实例时可指定该参数,购买只读实例或者灾备实例时指定该参数无意义。

  • DeployMode:

    多可用区域,默认为 0,支持值包括:0 - 表示单可用区,1 - 表示多可用区,购买主实例时可指定该参数,购买只读实例或者灾备实例时指定该参数无意义。

  • SlaveZone:

    备库 1 的可用区信息。

  • BackupZone:

    备库 2 的可用区信息,默认为空,购买三节点主实例时可指定该参数。

  • SecurityGroup:

    安全组参数,可使用 [查询项目安全组信息](cloud.tencent.com/document/api/236/15850) 接口查询某个项目的安全组详情。

  • RoGroup:

    只读实例信息。购买只读实例时,该参数必传。

  • AutoRenewFlag:

    购买按量计费实例该字段无意义。

  • InstanceName:

    实例名称。一次购买多个实例命名会用后缀数字区分,例instanceName=db,goodsNum=3,实例命名分别为db1,db2,db3。

  • ResourceTags:

    实例标签信息。

  • DeployGroupId:

    置放群组 ID。

  • ClientToken:

    用于保证请求幂等性的字符串。该字符串由客户生成,需保证不同请求之间在48小时内唯一,最大值不超过64个ASCII字符。若不指定该参数,则无法保证请求的幂等性。

  • DeviceType:

    实例隔离类型。支持值包括:“UNIVERSAL” - 通用型实例,“EXCLUSIVE” - 独享型实例,“BASIC_V2” - ONTKE 单节点实例,“CLOUD_NATIVE_CLUSTER” - 云盘版标准型,“CLOUD_NATIVE_CLUSTER_EXCLUSIVE” - 云盘版加强型。不指定则默认为通用型实例。

  • ParamTemplateId:

    参数模板 id。

  • AlarmPolicyList:

    告警策略id数组。腾讯云可观测平台DescribeAlarmPolicy接口返回的OriginId。

  • InstanceNodes:

    实例节点数。对于 RO 和 基础版实例, 该值默认为1。 如果需要购买三节点实例, 请将该值设置为3 或指定 BackupZone 参数。当购买主实例,且未指定该参数和 BackupZone 参数时,该值默认是 2, 即购买两节点实例。

  • Cpu:

    实例cpu核数, 如果不传将根据memory指定的内存值自动填充对应的cpu值。

  • AutoSyncFlag:

    是否自动发起灾备同步功能。该参数仅对购买灾备实例生效。 可选值为:0 - 不自动发起灾备同步;1 - 自动发起灾备同步。该值默认为0。

  • CageId:

    金融围拢 ID 。

  • ParamTemplateType:

    默认参数模板类型。支持值包括:“HIGH_STABILITY” - 高稳定模板,“HIGH_PERFORMANCE” - 高性能模板,默认值是:“HIGH_STABILITY”。

  • AlarmPolicyIdList:

    告警策略名数组,例如:,AlarmPolicyList不为空时该参数无效。

  • DryRun:

    是否只预检此次请求。true:发送检查请求,不会创建实例。检查项包括是否填写了必需参数,请求格式,业务限制等。如果检查不通过,则返回对应错误码;如果检查通过,则返回RequestId.默认为false:发送正常请求,通过检查后直接创建实例。

  • EngineType:

    实例引擎类型,默认为“InnoDB”,支持值包括:“InnoDB”,“RocksDB”。

  • Vips:

    指定实例的IP列表。仅支持主实例指定,按实例顺序,不足则按未指定处理。

  • DataProtectVolume:

    云盘版实例的数据保护空间大小,单位 GB,设置范围1 - 10。

  • ClusterTopology:

    云盘版节点拓扑配置。

  • DiskType:

    硬盘类型,单节点(云盘)或者云盘版实例可以指定此参数。CLOUD_SSD 表示 SSD 云硬盘,CLOUD_HSSD 表示增强型 SSD 云硬盘,CLOUD_PREMIUM 表示高性能云硬盘。

  • ClusterType:

    集群类型:cage——金融围拢,cdc——CDB ON CDC;dedicate——独享集群

  • DestroyProtect:

    开启或关闭实例销毁保护。on-开启,off-关闭



3169
3170
3171
# File 'lib/v20170320/models.rb', line 3169

def ProjectId
  @ProjectId
end

#ProtectModeObject

说明:创建非云盘版实例时,请根据需要指定实例版本(推荐5.7或8.0),若此参数不填,则默认值为8.0;若创建的是云盘版实例,则此参数仅能指定为5.7或8.0。说明:如果创建的是云盘版实例,此参数为必填且为私有网络类型。若此项不填,则系统会选择默认的 VPC。说明:若此项不填,则系统会选择默认 VPC 下的默认子网。说明:若您创建单节点、双节点、三节点实例,此参数为必填项,请指定可用区,若不指定可用区,则系统会自动选择一个可用区(可能不是您希望部署的可用区);若您创建云盘版实例,此参数不填,请通过参数 ClusterTopology 进行读写节点和只读节点的可用区配置。说明:请选择实例类型,不填会默认选择 master。说明:不填则默认为3306。说明:表名大小写敏感的开启和关闭可通过参数 lower_case_table_names 进行设置,参数值为0表示开启,参数值为1表示关闭,若不设置则此参数默认值为0。若您创建的是 MySQL 8.0 版本的实例,则需要在创建实例时通过设置 lower_case_table_names 参数来开启或关闭表名大小写敏感,创建实例后无法修改参数,即创建后无法修改表名大小写敏感。其他数据库版本的实例支持在创建实例后修改 lower_case_table_names 参数。创建实例时设置表名大小写敏感的 API 调用方法请参见本文中的示例2。说明:双节点、三节点实例请指定此参数值,若不指定,则默认为 Zone 的值;云盘版实例此参数可不填,请通过参数 ClusterTopology 进行读写节点和只读节点的可用区配置;单节点实例为单可用区,无需指定此参数。说明:如果创建的是云盘版实例,此参数为必填。备注:如您使用自定义参数模板 id,可传入自定义参数模板 id;如您计划使用默认参数模板,该参数模板 id 传入 id 无效,需设置 ParamTemplateType。备注:如您需使用云数据库 MySQL 默认参数模板,请设置 ParamTemplateType。说明:若购买的是云盘版实例,此参数为必填,需设置云盘版实例的 RW 和 RO 节点拓扑,RO 节点范围是1 - 5个,请至少设置1个 RO 节点。说明:单节点(云盘)、云盘版实例硬盘类型所支持的地域略有不同,具体支持情况请参考 [地域和可用区](cloud.tencent.com/document/product/236/8458)。

Parameters:

  • GoodsNum:

    实例数量,默认值为 1,最小值 1,最大值为 100。

  • Memory:

    实例内存大小,单位:MB,请使用 [获取云数据库可售卖规格](cloud.tencent.com/document/api/236/17229) 接口获取可创建的内存规格。

  • Volume:

    实例硬盘大小,单位:GB,请使用 [获取云数据库可售卖规格](cloud.tencent.com/document/api/236/17229) 接口获取可创建的硬盘范围。

  • EngineVersion:

    MySQL 版本,值包括:5.5、5.6、5.7和8.0,请使用 [获取云数据库可售卖规格](cloud.tencent.com/document/api/236/17229) 接口获取可创建的实例版本。

  • UniqVpcId:

    私有网络 ID,请使用 [查询私有网络列表](/document/api/215/15778)。

  • UniqSubnetId:

    私有网络下的子网 ID,如果设置了 UniqVpcId,则 UniqSubnetId 必填,请使用 [查询子网列表](/document/api/215/15784)。

  • ProjectId:

    项目 ID,不填为默认项目。

  • Zone:

    可用区信息,请使用 [获取云数据库可售卖规格](cloud.tencent.com/document/api/236/17229) 接口获取可创建的可用区。

  • MasterInstanceId:

    实例 ID,购买只读实例或者灾备实例时必填,该字段表示只读实例或者灾备实例的主实例 ID,请使用 [查询实例列表](cloud.tencent.com/document/api/236/15872) 接口查询云数据库实例 ID。

  • InstanceRole:

    实例类型,支持值包括:master - 表示主实例,dr - 表示灾备实例,ro - 表示只读实例。

  • MasterRegion:

    主实例地域信息,购买灾备、RO实例时,该字段必填。

  • Port:

    自定义端口,端口支持范围:[1024 - 65535]。

  • Password:

    设置 root 账号密码,密码规则:8 - 64 个字符,至少包含字母、数字、字符(支持的字符:_+-&=!@#$%^*())中的两种,购买主实例时可指定该参数,购买只读实例或者灾备实例时指定该参数无意义。

  • ParamList:

    参数列表,参数格式如 ParamList.0.Name=auto_increment&ParamList.0.Value=1。可通过 [查询默认的可设置参数列表](cloud.tencent.com/document/api/236/32662) 查询支持设置的参数。

  • ProtectMode:

    数据复制方式,默认为 0,支持值包括:0 - 表示异步复制,1 - 表示半同步复制,2 - 表示强同步复制,购买主实例时可指定该参数,购买只读实例或者灾备实例时指定该参数无意义。

  • DeployMode:

    多可用区域,默认为 0,支持值包括:0 - 表示单可用区,1 - 表示多可用区,购买主实例时可指定该参数,购买只读实例或者灾备实例时指定该参数无意义。

  • SlaveZone:

    备库 1 的可用区信息。

  • BackupZone:

    备库 2 的可用区信息,默认为空,购买三节点主实例时可指定该参数。

  • SecurityGroup:

    安全组参数,可使用 [查询项目安全组信息](cloud.tencent.com/document/api/236/15850) 接口查询某个项目的安全组详情。

  • RoGroup:

    只读实例信息。购买只读实例时,该参数必传。

  • AutoRenewFlag:

    购买按量计费实例该字段无意义。

  • InstanceName:

    实例名称。一次购买多个实例命名会用后缀数字区分,例instanceName=db,goodsNum=3,实例命名分别为db1,db2,db3。

  • ResourceTags:

    实例标签信息。

  • DeployGroupId:

    置放群组 ID。

  • ClientToken:

    用于保证请求幂等性的字符串。该字符串由客户生成,需保证不同请求之间在48小时内唯一,最大值不超过64个ASCII字符。若不指定该参数,则无法保证请求的幂等性。

  • DeviceType:

    实例隔离类型。支持值包括:“UNIVERSAL” - 通用型实例,“EXCLUSIVE” - 独享型实例,“BASIC_V2” - ONTKE 单节点实例,“CLOUD_NATIVE_CLUSTER” - 云盘版标准型,“CLOUD_NATIVE_CLUSTER_EXCLUSIVE” - 云盘版加强型。不指定则默认为通用型实例。

  • ParamTemplateId:

    参数模板 id。

  • AlarmPolicyList:

    告警策略id数组。腾讯云可观测平台DescribeAlarmPolicy接口返回的OriginId。

  • InstanceNodes:

    实例节点数。对于 RO 和 基础版实例, 该值默认为1。 如果需要购买三节点实例, 请将该值设置为3 或指定 BackupZone 参数。当购买主实例,且未指定该参数和 BackupZone 参数时,该值默认是 2, 即购买两节点实例。

  • Cpu:

    实例cpu核数, 如果不传将根据memory指定的内存值自动填充对应的cpu值。

  • AutoSyncFlag:

    是否自动发起灾备同步功能。该参数仅对购买灾备实例生效。 可选值为:0 - 不自动发起灾备同步;1 - 自动发起灾备同步。该值默认为0。

  • CageId:

    金融围拢 ID 。

  • ParamTemplateType:

    默认参数模板类型。支持值包括:“HIGH_STABILITY” - 高稳定模板,“HIGH_PERFORMANCE” - 高性能模板,默认值是:“HIGH_STABILITY”。

  • AlarmPolicyIdList:

    告警策略名数组,例如:,AlarmPolicyList不为空时该参数无效。

  • DryRun:

    是否只预检此次请求。true:发送检查请求,不会创建实例。检查项包括是否填写了必需参数,请求格式,业务限制等。如果检查不通过,则返回对应错误码;如果检查通过,则返回RequestId.默认为false:发送正常请求,通过检查后直接创建实例。

  • EngineType:

    实例引擎类型,默认为“InnoDB”,支持值包括:“InnoDB”,“RocksDB”。

  • Vips:

    指定实例的IP列表。仅支持主实例指定,按实例顺序,不足则按未指定处理。

  • DataProtectVolume:

    云盘版实例的数据保护空间大小,单位 GB,设置范围1 - 10。

  • ClusterTopology:

    云盘版节点拓扑配置。

  • DiskType:

    硬盘类型,单节点(云盘)或者云盘版实例可以指定此参数。CLOUD_SSD 表示 SSD 云硬盘,CLOUD_HSSD 表示增强型 SSD 云硬盘,CLOUD_PREMIUM 表示高性能云硬盘。

  • ClusterType:

    集群类型:cage——金融围拢,cdc——CDB ON CDC;dedicate——独享集群

  • DestroyProtect:

    开启或关闭实例销毁保护。on-开启,off-关闭



3169
3170
3171
# File 'lib/v20170320/models.rb', line 3169

def ProtectMode
  @ProtectMode
end

#ResourceTagsObject

说明:创建非云盘版实例时,请根据需要指定实例版本(推荐5.7或8.0),若此参数不填,则默认值为8.0;若创建的是云盘版实例,则此参数仅能指定为5.7或8.0。说明:如果创建的是云盘版实例,此参数为必填且为私有网络类型。若此项不填,则系统会选择默认的 VPC。说明:若此项不填,则系统会选择默认 VPC 下的默认子网。说明:若您创建单节点、双节点、三节点实例,此参数为必填项,请指定可用区,若不指定可用区,则系统会自动选择一个可用区(可能不是您希望部署的可用区);若您创建云盘版实例,此参数不填,请通过参数 ClusterTopology 进行读写节点和只读节点的可用区配置。说明:请选择实例类型,不填会默认选择 master。说明:不填则默认为3306。说明:表名大小写敏感的开启和关闭可通过参数 lower_case_table_names 进行设置,参数值为0表示开启,参数值为1表示关闭,若不设置则此参数默认值为0。若您创建的是 MySQL 8.0 版本的实例,则需要在创建实例时通过设置 lower_case_table_names 参数来开启或关闭表名大小写敏感,创建实例后无法修改参数,即创建后无法修改表名大小写敏感。其他数据库版本的实例支持在创建实例后修改 lower_case_table_names 参数。创建实例时设置表名大小写敏感的 API 调用方法请参见本文中的示例2。说明:双节点、三节点实例请指定此参数值,若不指定,则默认为 Zone 的值;云盘版实例此参数可不填,请通过参数 ClusterTopology 进行读写节点和只读节点的可用区配置;单节点实例为单可用区,无需指定此参数。说明:如果创建的是云盘版实例,此参数为必填。备注:如您使用自定义参数模板 id,可传入自定义参数模板 id;如您计划使用默认参数模板,该参数模板 id 传入 id 无效,需设置 ParamTemplateType。备注:如您需使用云数据库 MySQL 默认参数模板,请设置 ParamTemplateType。说明:若购买的是云盘版实例,此参数为必填,需设置云盘版实例的 RW 和 RO 节点拓扑,RO 节点范围是1 - 5个,请至少设置1个 RO 节点。说明:单节点(云盘)、云盘版实例硬盘类型所支持的地域略有不同,具体支持情况请参考 [地域和可用区](cloud.tencent.com/document/product/236/8458)。

Parameters:

  • GoodsNum:

    实例数量,默认值为 1,最小值 1,最大值为 100。

  • Memory:

    实例内存大小,单位:MB,请使用 [获取云数据库可售卖规格](cloud.tencent.com/document/api/236/17229) 接口获取可创建的内存规格。

  • Volume:

    实例硬盘大小,单位:GB,请使用 [获取云数据库可售卖规格](cloud.tencent.com/document/api/236/17229) 接口获取可创建的硬盘范围。

  • EngineVersion:

    MySQL 版本,值包括:5.5、5.6、5.7和8.0,请使用 [获取云数据库可售卖规格](cloud.tencent.com/document/api/236/17229) 接口获取可创建的实例版本。

  • UniqVpcId:

    私有网络 ID,请使用 [查询私有网络列表](/document/api/215/15778)。

  • UniqSubnetId:

    私有网络下的子网 ID,如果设置了 UniqVpcId,则 UniqSubnetId 必填,请使用 [查询子网列表](/document/api/215/15784)。

  • ProjectId:

    项目 ID,不填为默认项目。

  • Zone:

    可用区信息,请使用 [获取云数据库可售卖规格](cloud.tencent.com/document/api/236/17229) 接口获取可创建的可用区。

  • MasterInstanceId:

    实例 ID,购买只读实例或者灾备实例时必填,该字段表示只读实例或者灾备实例的主实例 ID,请使用 [查询实例列表](cloud.tencent.com/document/api/236/15872) 接口查询云数据库实例 ID。

  • InstanceRole:

    实例类型,支持值包括:master - 表示主实例,dr - 表示灾备实例,ro - 表示只读实例。

  • MasterRegion:

    主实例地域信息,购买灾备、RO实例时,该字段必填。

  • Port:

    自定义端口,端口支持范围:[1024 - 65535]。

  • Password:

    设置 root 账号密码,密码规则:8 - 64 个字符,至少包含字母、数字、字符(支持的字符:_+-&=!@#$%^*())中的两种,购买主实例时可指定该参数,购买只读实例或者灾备实例时指定该参数无意义。

  • ParamList:

    参数列表,参数格式如 ParamList.0.Name=auto_increment&ParamList.0.Value=1。可通过 [查询默认的可设置参数列表](cloud.tencent.com/document/api/236/32662) 查询支持设置的参数。

  • ProtectMode:

    数据复制方式,默认为 0,支持值包括:0 - 表示异步复制,1 - 表示半同步复制,2 - 表示强同步复制,购买主实例时可指定该参数,购买只读实例或者灾备实例时指定该参数无意义。

  • DeployMode:

    多可用区域,默认为 0,支持值包括:0 - 表示单可用区,1 - 表示多可用区,购买主实例时可指定该参数,购买只读实例或者灾备实例时指定该参数无意义。

  • SlaveZone:

    备库 1 的可用区信息。

  • BackupZone:

    备库 2 的可用区信息,默认为空,购买三节点主实例时可指定该参数。

  • SecurityGroup:

    安全组参数,可使用 [查询项目安全组信息](cloud.tencent.com/document/api/236/15850) 接口查询某个项目的安全组详情。

  • RoGroup:

    只读实例信息。购买只读实例时,该参数必传。

  • AutoRenewFlag:

    购买按量计费实例该字段无意义。

  • InstanceName:

    实例名称。一次购买多个实例命名会用后缀数字区分,例instanceName=db,goodsNum=3,实例命名分别为db1,db2,db3。

  • ResourceTags:

    实例标签信息。

  • DeployGroupId:

    置放群组 ID。

  • ClientToken:

    用于保证请求幂等性的字符串。该字符串由客户生成,需保证不同请求之间在48小时内唯一,最大值不超过64个ASCII字符。若不指定该参数,则无法保证请求的幂等性。

  • DeviceType:

    实例隔离类型。支持值包括:“UNIVERSAL” - 通用型实例,“EXCLUSIVE” - 独享型实例,“BASIC_V2” - ONTKE 单节点实例,“CLOUD_NATIVE_CLUSTER” - 云盘版标准型,“CLOUD_NATIVE_CLUSTER_EXCLUSIVE” - 云盘版加强型。不指定则默认为通用型实例。

  • ParamTemplateId:

    参数模板 id。

  • AlarmPolicyList:

    告警策略id数组。腾讯云可观测平台DescribeAlarmPolicy接口返回的OriginId。

  • InstanceNodes:

    实例节点数。对于 RO 和 基础版实例, 该值默认为1。 如果需要购买三节点实例, 请将该值设置为3 或指定 BackupZone 参数。当购买主实例,且未指定该参数和 BackupZone 参数时,该值默认是 2, 即购买两节点实例。

  • Cpu:

    实例cpu核数, 如果不传将根据memory指定的内存值自动填充对应的cpu值。

  • AutoSyncFlag:

    是否自动发起灾备同步功能。该参数仅对购买灾备实例生效。 可选值为:0 - 不自动发起灾备同步;1 - 自动发起灾备同步。该值默认为0。

  • CageId:

    金融围拢 ID 。

  • ParamTemplateType:

    默认参数模板类型。支持值包括:“HIGH_STABILITY” - 高稳定模板,“HIGH_PERFORMANCE” - 高性能模板,默认值是:“HIGH_STABILITY”。

  • AlarmPolicyIdList:

    告警策略名数组,例如:,AlarmPolicyList不为空时该参数无效。

  • DryRun:

    是否只预检此次请求。true:发送检查请求,不会创建实例。检查项包括是否填写了必需参数,请求格式,业务限制等。如果检查不通过,则返回对应错误码;如果检查通过,则返回RequestId.默认为false:发送正常请求,通过检查后直接创建实例。

  • EngineType:

    实例引擎类型,默认为“InnoDB”,支持值包括:“InnoDB”,“RocksDB”。

  • Vips:

    指定实例的IP列表。仅支持主实例指定,按实例顺序,不足则按未指定处理。

  • DataProtectVolume:

    云盘版实例的数据保护空间大小,单位 GB,设置范围1 - 10。

  • ClusterTopology:

    云盘版节点拓扑配置。

  • DiskType:

    硬盘类型,单节点(云盘)或者云盘版实例可以指定此参数。CLOUD_SSD 表示 SSD 云硬盘,CLOUD_HSSD 表示增强型 SSD 云硬盘,CLOUD_PREMIUM 表示高性能云硬盘。

  • ClusterType:

    集群类型:cage——金融围拢,cdc——CDB ON CDC;dedicate——独享集群

  • DestroyProtect:

    开启或关闭实例销毁保护。on-开启,off-关闭



3169
3170
3171
# File 'lib/v20170320/models.rb', line 3169

def ResourceTags
  @ResourceTags
end

#RoGroupObject

说明:创建非云盘版实例时,请根据需要指定实例版本(推荐5.7或8.0),若此参数不填,则默认值为8.0;若创建的是云盘版实例,则此参数仅能指定为5.7或8.0。说明:如果创建的是云盘版实例,此参数为必填且为私有网络类型。若此项不填,则系统会选择默认的 VPC。说明:若此项不填,则系统会选择默认 VPC 下的默认子网。说明:若您创建单节点、双节点、三节点实例,此参数为必填项,请指定可用区,若不指定可用区,则系统会自动选择一个可用区(可能不是您希望部署的可用区);若您创建云盘版实例,此参数不填,请通过参数 ClusterTopology 进行读写节点和只读节点的可用区配置。说明:请选择实例类型,不填会默认选择 master。说明:不填则默认为3306。说明:表名大小写敏感的开启和关闭可通过参数 lower_case_table_names 进行设置,参数值为0表示开启,参数值为1表示关闭,若不设置则此参数默认值为0。若您创建的是 MySQL 8.0 版本的实例,则需要在创建实例时通过设置 lower_case_table_names 参数来开启或关闭表名大小写敏感,创建实例后无法修改参数,即创建后无法修改表名大小写敏感。其他数据库版本的实例支持在创建实例后修改 lower_case_table_names 参数。创建实例时设置表名大小写敏感的 API 调用方法请参见本文中的示例2。说明:双节点、三节点实例请指定此参数值,若不指定,则默认为 Zone 的值;云盘版实例此参数可不填,请通过参数 ClusterTopology 进行读写节点和只读节点的可用区配置;单节点实例为单可用区,无需指定此参数。说明:如果创建的是云盘版实例,此参数为必填。备注:如您使用自定义参数模板 id,可传入自定义参数模板 id;如您计划使用默认参数模板,该参数模板 id 传入 id 无效,需设置 ParamTemplateType。备注:如您需使用云数据库 MySQL 默认参数模板,请设置 ParamTemplateType。说明:若购买的是云盘版实例,此参数为必填,需设置云盘版实例的 RW 和 RO 节点拓扑,RO 节点范围是1 - 5个,请至少设置1个 RO 节点。说明:单节点(云盘)、云盘版实例硬盘类型所支持的地域略有不同,具体支持情况请参考 [地域和可用区](cloud.tencent.com/document/product/236/8458)。

Parameters:

  • GoodsNum:

    实例数量,默认值为 1,最小值 1,最大值为 100。

  • Memory:

    实例内存大小,单位:MB,请使用 [获取云数据库可售卖规格](cloud.tencent.com/document/api/236/17229) 接口获取可创建的内存规格。

  • Volume:

    实例硬盘大小,单位:GB,请使用 [获取云数据库可售卖规格](cloud.tencent.com/document/api/236/17229) 接口获取可创建的硬盘范围。

  • EngineVersion:

    MySQL 版本,值包括:5.5、5.6、5.7和8.0,请使用 [获取云数据库可售卖规格](cloud.tencent.com/document/api/236/17229) 接口获取可创建的实例版本。

  • UniqVpcId:

    私有网络 ID,请使用 [查询私有网络列表](/document/api/215/15778)。

  • UniqSubnetId:

    私有网络下的子网 ID,如果设置了 UniqVpcId,则 UniqSubnetId 必填,请使用 [查询子网列表](/document/api/215/15784)。

  • ProjectId:

    项目 ID,不填为默认项目。

  • Zone:

    可用区信息,请使用 [获取云数据库可售卖规格](cloud.tencent.com/document/api/236/17229) 接口获取可创建的可用区。

  • MasterInstanceId:

    实例 ID,购买只读实例或者灾备实例时必填,该字段表示只读实例或者灾备实例的主实例 ID,请使用 [查询实例列表](cloud.tencent.com/document/api/236/15872) 接口查询云数据库实例 ID。

  • InstanceRole:

    实例类型,支持值包括:master - 表示主实例,dr - 表示灾备实例,ro - 表示只读实例。

  • MasterRegion:

    主实例地域信息,购买灾备、RO实例时,该字段必填。

  • Port:

    自定义端口,端口支持范围:[1024 - 65535]。

  • Password:

    设置 root 账号密码,密码规则:8 - 64 个字符,至少包含字母、数字、字符(支持的字符:_+-&=!@#$%^*())中的两种,购买主实例时可指定该参数,购买只读实例或者灾备实例时指定该参数无意义。

  • ParamList:

    参数列表,参数格式如 ParamList.0.Name=auto_increment&ParamList.0.Value=1。可通过 [查询默认的可设置参数列表](cloud.tencent.com/document/api/236/32662) 查询支持设置的参数。

  • ProtectMode:

    数据复制方式,默认为 0,支持值包括:0 - 表示异步复制,1 - 表示半同步复制,2 - 表示强同步复制,购买主实例时可指定该参数,购买只读实例或者灾备实例时指定该参数无意义。

  • DeployMode:

    多可用区域,默认为 0,支持值包括:0 - 表示单可用区,1 - 表示多可用区,购买主实例时可指定该参数,购买只读实例或者灾备实例时指定该参数无意义。

  • SlaveZone:

    备库 1 的可用区信息。

  • BackupZone:

    备库 2 的可用区信息,默认为空,购买三节点主实例时可指定该参数。

  • SecurityGroup:

    安全组参数,可使用 [查询项目安全组信息](cloud.tencent.com/document/api/236/15850) 接口查询某个项目的安全组详情。

  • RoGroup:

    只读实例信息。购买只读实例时,该参数必传。

  • AutoRenewFlag:

    购买按量计费实例该字段无意义。

  • InstanceName:

    实例名称。一次购买多个实例命名会用后缀数字区分,例instanceName=db,goodsNum=3,实例命名分别为db1,db2,db3。

  • ResourceTags:

    实例标签信息。

  • DeployGroupId:

    置放群组 ID。

  • ClientToken:

    用于保证请求幂等性的字符串。该字符串由客户生成,需保证不同请求之间在48小时内唯一,最大值不超过64个ASCII字符。若不指定该参数,则无法保证请求的幂等性。

  • DeviceType:

    实例隔离类型。支持值包括:“UNIVERSAL” - 通用型实例,“EXCLUSIVE” - 独享型实例,“BASIC_V2” - ONTKE 单节点实例,“CLOUD_NATIVE_CLUSTER” - 云盘版标准型,“CLOUD_NATIVE_CLUSTER_EXCLUSIVE” - 云盘版加强型。不指定则默认为通用型实例。

  • ParamTemplateId:

    参数模板 id。

  • AlarmPolicyList:

    告警策略id数组。腾讯云可观测平台DescribeAlarmPolicy接口返回的OriginId。

  • InstanceNodes:

    实例节点数。对于 RO 和 基础版实例, 该值默认为1。 如果需要购买三节点实例, 请将该值设置为3 或指定 BackupZone 参数。当购买主实例,且未指定该参数和 BackupZone 参数时,该值默认是 2, 即购买两节点实例。

  • Cpu:

    实例cpu核数, 如果不传将根据memory指定的内存值自动填充对应的cpu值。

  • AutoSyncFlag:

    是否自动发起灾备同步功能。该参数仅对购买灾备实例生效。 可选值为:0 - 不自动发起灾备同步;1 - 自动发起灾备同步。该值默认为0。

  • CageId:

    金融围拢 ID 。

  • ParamTemplateType:

    默认参数模板类型。支持值包括:“HIGH_STABILITY” - 高稳定模板,“HIGH_PERFORMANCE” - 高性能模板,默认值是:“HIGH_STABILITY”。

  • AlarmPolicyIdList:

    告警策略名数组,例如:,AlarmPolicyList不为空时该参数无效。

  • DryRun:

    是否只预检此次请求。true:发送检查请求,不会创建实例。检查项包括是否填写了必需参数,请求格式,业务限制等。如果检查不通过,则返回对应错误码;如果检查通过,则返回RequestId.默认为false:发送正常请求,通过检查后直接创建实例。

  • EngineType:

    实例引擎类型,默认为“InnoDB”,支持值包括:“InnoDB”,“RocksDB”。

  • Vips:

    指定实例的IP列表。仅支持主实例指定,按实例顺序,不足则按未指定处理。

  • DataProtectVolume:

    云盘版实例的数据保护空间大小,单位 GB,设置范围1 - 10。

  • ClusterTopology:

    云盘版节点拓扑配置。

  • DiskType:

    硬盘类型,单节点(云盘)或者云盘版实例可以指定此参数。CLOUD_SSD 表示 SSD 云硬盘,CLOUD_HSSD 表示增强型 SSD 云硬盘,CLOUD_PREMIUM 表示高性能云硬盘。

  • ClusterType:

    集群类型:cage——金融围拢,cdc——CDB ON CDC;dedicate——独享集群

  • DestroyProtect:

    开启或关闭实例销毁保护。on-开启,off-关闭



3169
3170
3171
# File 'lib/v20170320/models.rb', line 3169

def RoGroup
  @RoGroup
end

#SecurityGroupObject

说明:创建非云盘版实例时,请根据需要指定实例版本(推荐5.7或8.0),若此参数不填,则默认值为8.0;若创建的是云盘版实例,则此参数仅能指定为5.7或8.0。说明:如果创建的是云盘版实例,此参数为必填且为私有网络类型。若此项不填,则系统会选择默认的 VPC。说明:若此项不填,则系统会选择默认 VPC 下的默认子网。说明:若您创建单节点、双节点、三节点实例,此参数为必填项,请指定可用区,若不指定可用区,则系统会自动选择一个可用区(可能不是您希望部署的可用区);若您创建云盘版实例,此参数不填,请通过参数 ClusterTopology 进行读写节点和只读节点的可用区配置。说明:请选择实例类型,不填会默认选择 master。说明:不填则默认为3306。说明:表名大小写敏感的开启和关闭可通过参数 lower_case_table_names 进行设置,参数值为0表示开启,参数值为1表示关闭,若不设置则此参数默认值为0。若您创建的是 MySQL 8.0 版本的实例,则需要在创建实例时通过设置 lower_case_table_names 参数来开启或关闭表名大小写敏感,创建实例后无法修改参数,即创建后无法修改表名大小写敏感。其他数据库版本的实例支持在创建实例后修改 lower_case_table_names 参数。创建实例时设置表名大小写敏感的 API 调用方法请参见本文中的示例2。说明:双节点、三节点实例请指定此参数值,若不指定,则默认为 Zone 的值;云盘版实例此参数可不填,请通过参数 ClusterTopology 进行读写节点和只读节点的可用区配置;单节点实例为单可用区,无需指定此参数。说明:如果创建的是云盘版实例,此参数为必填。备注:如您使用自定义参数模板 id,可传入自定义参数模板 id;如您计划使用默认参数模板,该参数模板 id 传入 id 无效,需设置 ParamTemplateType。备注:如您需使用云数据库 MySQL 默认参数模板,请设置 ParamTemplateType。说明:若购买的是云盘版实例,此参数为必填,需设置云盘版实例的 RW 和 RO 节点拓扑,RO 节点范围是1 - 5个,请至少设置1个 RO 节点。说明:单节点(云盘)、云盘版实例硬盘类型所支持的地域略有不同,具体支持情况请参考 [地域和可用区](cloud.tencent.com/document/product/236/8458)。

Parameters:

  • GoodsNum:

    实例数量,默认值为 1,最小值 1,最大值为 100。

  • Memory:

    实例内存大小,单位:MB,请使用 [获取云数据库可售卖规格](cloud.tencent.com/document/api/236/17229) 接口获取可创建的内存规格。

  • Volume:

    实例硬盘大小,单位:GB,请使用 [获取云数据库可售卖规格](cloud.tencent.com/document/api/236/17229) 接口获取可创建的硬盘范围。

  • EngineVersion:

    MySQL 版本,值包括:5.5、5.6、5.7和8.0,请使用 [获取云数据库可售卖规格](cloud.tencent.com/document/api/236/17229) 接口获取可创建的实例版本。

  • UniqVpcId:

    私有网络 ID,请使用 [查询私有网络列表](/document/api/215/15778)。

  • UniqSubnetId:

    私有网络下的子网 ID,如果设置了 UniqVpcId,则 UniqSubnetId 必填,请使用 [查询子网列表](/document/api/215/15784)。

  • ProjectId:

    项目 ID,不填为默认项目。

  • Zone:

    可用区信息,请使用 [获取云数据库可售卖规格](cloud.tencent.com/document/api/236/17229) 接口获取可创建的可用区。

  • MasterInstanceId:

    实例 ID,购买只读实例或者灾备实例时必填,该字段表示只读实例或者灾备实例的主实例 ID,请使用 [查询实例列表](cloud.tencent.com/document/api/236/15872) 接口查询云数据库实例 ID。

  • InstanceRole:

    实例类型,支持值包括:master - 表示主实例,dr - 表示灾备实例,ro - 表示只读实例。

  • MasterRegion:

    主实例地域信息,购买灾备、RO实例时,该字段必填。

  • Port:

    自定义端口,端口支持范围:[1024 - 65535]。

  • Password:

    设置 root 账号密码,密码规则:8 - 64 个字符,至少包含字母、数字、字符(支持的字符:_+-&=!@#$%^*())中的两种,购买主实例时可指定该参数,购买只读实例或者灾备实例时指定该参数无意义。

  • ParamList:

    参数列表,参数格式如 ParamList.0.Name=auto_increment&ParamList.0.Value=1。可通过 [查询默认的可设置参数列表](cloud.tencent.com/document/api/236/32662) 查询支持设置的参数。

  • ProtectMode:

    数据复制方式,默认为 0,支持值包括:0 - 表示异步复制,1 - 表示半同步复制,2 - 表示强同步复制,购买主实例时可指定该参数,购买只读实例或者灾备实例时指定该参数无意义。

  • DeployMode:

    多可用区域,默认为 0,支持值包括:0 - 表示单可用区,1 - 表示多可用区,购买主实例时可指定该参数,购买只读实例或者灾备实例时指定该参数无意义。

  • SlaveZone:

    备库 1 的可用区信息。

  • BackupZone:

    备库 2 的可用区信息,默认为空,购买三节点主实例时可指定该参数。

  • SecurityGroup:

    安全组参数,可使用 [查询项目安全组信息](cloud.tencent.com/document/api/236/15850) 接口查询某个项目的安全组详情。

  • RoGroup:

    只读实例信息。购买只读实例时,该参数必传。

  • AutoRenewFlag:

    购买按量计费实例该字段无意义。

  • InstanceName:

    实例名称。一次购买多个实例命名会用后缀数字区分,例instanceName=db,goodsNum=3,实例命名分别为db1,db2,db3。

  • ResourceTags:

    实例标签信息。

  • DeployGroupId:

    置放群组 ID。

  • ClientToken:

    用于保证请求幂等性的字符串。该字符串由客户生成,需保证不同请求之间在48小时内唯一,最大值不超过64个ASCII字符。若不指定该参数,则无法保证请求的幂等性。

  • DeviceType:

    实例隔离类型。支持值包括:“UNIVERSAL” - 通用型实例,“EXCLUSIVE” - 独享型实例,“BASIC_V2” - ONTKE 单节点实例,“CLOUD_NATIVE_CLUSTER” - 云盘版标准型,“CLOUD_NATIVE_CLUSTER_EXCLUSIVE” - 云盘版加强型。不指定则默认为通用型实例。

  • ParamTemplateId:

    参数模板 id。

  • AlarmPolicyList:

    告警策略id数组。腾讯云可观测平台DescribeAlarmPolicy接口返回的OriginId。

  • InstanceNodes:

    实例节点数。对于 RO 和 基础版实例, 该值默认为1。 如果需要购买三节点实例, 请将该值设置为3 或指定 BackupZone 参数。当购买主实例,且未指定该参数和 BackupZone 参数时,该值默认是 2, 即购买两节点实例。

  • Cpu:

    实例cpu核数, 如果不传将根据memory指定的内存值自动填充对应的cpu值。

  • AutoSyncFlag:

    是否自动发起灾备同步功能。该参数仅对购买灾备实例生效。 可选值为:0 - 不自动发起灾备同步;1 - 自动发起灾备同步。该值默认为0。

  • CageId:

    金融围拢 ID 。

  • ParamTemplateType:

    默认参数模板类型。支持值包括:“HIGH_STABILITY” - 高稳定模板,“HIGH_PERFORMANCE” - 高性能模板,默认值是:“HIGH_STABILITY”。

  • AlarmPolicyIdList:

    告警策略名数组,例如:,AlarmPolicyList不为空时该参数无效。

  • DryRun:

    是否只预检此次请求。true:发送检查请求,不会创建实例。检查项包括是否填写了必需参数,请求格式,业务限制等。如果检查不通过,则返回对应错误码;如果检查通过,则返回RequestId.默认为false:发送正常请求,通过检查后直接创建实例。

  • EngineType:

    实例引擎类型,默认为“InnoDB”,支持值包括:“InnoDB”,“RocksDB”。

  • Vips:

    指定实例的IP列表。仅支持主实例指定,按实例顺序,不足则按未指定处理。

  • DataProtectVolume:

    云盘版实例的数据保护空间大小,单位 GB,设置范围1 - 10。

  • ClusterTopology:

    云盘版节点拓扑配置。

  • DiskType:

    硬盘类型,单节点(云盘)或者云盘版实例可以指定此参数。CLOUD_SSD 表示 SSD 云硬盘,CLOUD_HSSD 表示增强型 SSD 云硬盘,CLOUD_PREMIUM 表示高性能云硬盘。

  • ClusterType:

    集群类型:cage——金融围拢,cdc——CDB ON CDC;dedicate——独享集群

  • DestroyProtect:

    开启或关闭实例销毁保护。on-开启,off-关闭



3169
3170
3171
# File 'lib/v20170320/models.rb', line 3169

def SecurityGroup
  @SecurityGroup
end

#SlaveZoneObject

说明:创建非云盘版实例时,请根据需要指定实例版本(推荐5.7或8.0),若此参数不填,则默认值为8.0;若创建的是云盘版实例,则此参数仅能指定为5.7或8.0。说明:如果创建的是云盘版实例,此参数为必填且为私有网络类型。若此项不填,则系统会选择默认的 VPC。说明:若此项不填,则系统会选择默认 VPC 下的默认子网。说明:若您创建单节点、双节点、三节点实例,此参数为必填项,请指定可用区,若不指定可用区,则系统会自动选择一个可用区(可能不是您希望部署的可用区);若您创建云盘版实例,此参数不填,请通过参数 ClusterTopology 进行读写节点和只读节点的可用区配置。说明:请选择实例类型,不填会默认选择 master。说明:不填则默认为3306。说明:表名大小写敏感的开启和关闭可通过参数 lower_case_table_names 进行设置,参数值为0表示开启,参数值为1表示关闭,若不设置则此参数默认值为0。若您创建的是 MySQL 8.0 版本的实例,则需要在创建实例时通过设置 lower_case_table_names 参数来开启或关闭表名大小写敏感,创建实例后无法修改参数,即创建后无法修改表名大小写敏感。其他数据库版本的实例支持在创建实例后修改 lower_case_table_names 参数。创建实例时设置表名大小写敏感的 API 调用方法请参见本文中的示例2。说明:双节点、三节点实例请指定此参数值,若不指定,则默认为 Zone 的值;云盘版实例此参数可不填,请通过参数 ClusterTopology 进行读写节点和只读节点的可用区配置;单节点实例为单可用区,无需指定此参数。说明:如果创建的是云盘版实例,此参数为必填。备注:如您使用自定义参数模板 id,可传入自定义参数模板 id;如您计划使用默认参数模板,该参数模板 id 传入 id 无效,需设置 ParamTemplateType。备注:如您需使用云数据库 MySQL 默认参数模板,请设置 ParamTemplateType。说明:若购买的是云盘版实例,此参数为必填,需设置云盘版实例的 RW 和 RO 节点拓扑,RO 节点范围是1 - 5个,请至少设置1个 RO 节点。说明:单节点(云盘)、云盘版实例硬盘类型所支持的地域略有不同,具体支持情况请参考 [地域和可用区](cloud.tencent.com/document/product/236/8458)。

Parameters:

  • GoodsNum:

    实例数量,默认值为 1,最小值 1,最大值为 100。

  • Memory:

    实例内存大小,单位:MB,请使用 [获取云数据库可售卖规格](cloud.tencent.com/document/api/236/17229) 接口获取可创建的内存规格。

  • Volume:

    实例硬盘大小,单位:GB,请使用 [获取云数据库可售卖规格](cloud.tencent.com/document/api/236/17229) 接口获取可创建的硬盘范围。

  • EngineVersion:

    MySQL 版本,值包括:5.5、5.6、5.7和8.0,请使用 [获取云数据库可售卖规格](cloud.tencent.com/document/api/236/17229) 接口获取可创建的实例版本。

  • UniqVpcId:

    私有网络 ID,请使用 [查询私有网络列表](/document/api/215/15778)。

  • UniqSubnetId:

    私有网络下的子网 ID,如果设置了 UniqVpcId,则 UniqSubnetId 必填,请使用 [查询子网列表](/document/api/215/15784)。

  • ProjectId:

    项目 ID,不填为默认项目。

  • Zone:

    可用区信息,请使用 [获取云数据库可售卖规格](cloud.tencent.com/document/api/236/17229) 接口获取可创建的可用区。

  • MasterInstanceId:

    实例 ID,购买只读实例或者灾备实例时必填,该字段表示只读实例或者灾备实例的主实例 ID,请使用 [查询实例列表](cloud.tencent.com/document/api/236/15872) 接口查询云数据库实例 ID。

  • InstanceRole:

    实例类型,支持值包括:master - 表示主实例,dr - 表示灾备实例,ro - 表示只读实例。

  • MasterRegion:

    主实例地域信息,购买灾备、RO实例时,该字段必填。

  • Port:

    自定义端口,端口支持范围:[1024 - 65535]。

  • Password:

    设置 root 账号密码,密码规则:8 - 64 个字符,至少包含字母、数字、字符(支持的字符:_+-&=!@#$%^*())中的两种,购买主实例时可指定该参数,购买只读实例或者灾备实例时指定该参数无意义。

  • ParamList:

    参数列表,参数格式如 ParamList.0.Name=auto_increment&ParamList.0.Value=1。可通过 [查询默认的可设置参数列表](cloud.tencent.com/document/api/236/32662) 查询支持设置的参数。

  • ProtectMode:

    数据复制方式,默认为 0,支持值包括:0 - 表示异步复制,1 - 表示半同步复制,2 - 表示强同步复制,购买主实例时可指定该参数,购买只读实例或者灾备实例时指定该参数无意义。

  • DeployMode:

    多可用区域,默认为 0,支持值包括:0 - 表示单可用区,1 - 表示多可用区,购买主实例时可指定该参数,购买只读实例或者灾备实例时指定该参数无意义。

  • SlaveZone:

    备库 1 的可用区信息。

  • BackupZone:

    备库 2 的可用区信息,默认为空,购买三节点主实例时可指定该参数。

  • SecurityGroup:

    安全组参数,可使用 [查询项目安全组信息](cloud.tencent.com/document/api/236/15850) 接口查询某个项目的安全组详情。

  • RoGroup:

    只读实例信息。购买只读实例时,该参数必传。

  • AutoRenewFlag:

    购买按量计费实例该字段无意义。

  • InstanceName:

    实例名称。一次购买多个实例命名会用后缀数字区分,例instanceName=db,goodsNum=3,实例命名分别为db1,db2,db3。

  • ResourceTags:

    实例标签信息。

  • DeployGroupId:

    置放群组 ID。

  • ClientToken:

    用于保证请求幂等性的字符串。该字符串由客户生成,需保证不同请求之间在48小时内唯一,最大值不超过64个ASCII字符。若不指定该参数,则无法保证请求的幂等性。

  • DeviceType:

    实例隔离类型。支持值包括:“UNIVERSAL” - 通用型实例,“EXCLUSIVE” - 独享型实例,“BASIC_V2” - ONTKE 单节点实例,“CLOUD_NATIVE_CLUSTER” - 云盘版标准型,“CLOUD_NATIVE_CLUSTER_EXCLUSIVE” - 云盘版加强型。不指定则默认为通用型实例。

  • ParamTemplateId:

    参数模板 id。

  • AlarmPolicyList:

    告警策略id数组。腾讯云可观测平台DescribeAlarmPolicy接口返回的OriginId。

  • InstanceNodes:

    实例节点数。对于 RO 和 基础版实例, 该值默认为1。 如果需要购买三节点实例, 请将该值设置为3 或指定 BackupZone 参数。当购买主实例,且未指定该参数和 BackupZone 参数时,该值默认是 2, 即购买两节点实例。

  • Cpu:

    实例cpu核数, 如果不传将根据memory指定的内存值自动填充对应的cpu值。

  • AutoSyncFlag:

    是否自动发起灾备同步功能。该参数仅对购买灾备实例生效。 可选值为:0 - 不自动发起灾备同步;1 - 自动发起灾备同步。该值默认为0。

  • CageId:

    金融围拢 ID 。

  • ParamTemplateType:

    默认参数模板类型。支持值包括:“HIGH_STABILITY” - 高稳定模板,“HIGH_PERFORMANCE” - 高性能模板,默认值是:“HIGH_STABILITY”。

  • AlarmPolicyIdList:

    告警策略名数组,例如:,AlarmPolicyList不为空时该参数无效。

  • DryRun:

    是否只预检此次请求。true:发送检查请求,不会创建实例。检查项包括是否填写了必需参数,请求格式,业务限制等。如果检查不通过,则返回对应错误码;如果检查通过,则返回RequestId.默认为false:发送正常请求,通过检查后直接创建实例。

  • EngineType:

    实例引擎类型,默认为“InnoDB”,支持值包括:“InnoDB”,“RocksDB”。

  • Vips:

    指定实例的IP列表。仅支持主实例指定,按实例顺序,不足则按未指定处理。

  • DataProtectVolume:

    云盘版实例的数据保护空间大小,单位 GB,设置范围1 - 10。

  • ClusterTopology:

    云盘版节点拓扑配置。

  • DiskType:

    硬盘类型,单节点(云盘)或者云盘版实例可以指定此参数。CLOUD_SSD 表示 SSD 云硬盘,CLOUD_HSSD 表示增强型 SSD 云硬盘,CLOUD_PREMIUM 表示高性能云硬盘。

  • ClusterType:

    集群类型:cage——金融围拢,cdc——CDB ON CDC;dedicate——独享集群

  • DestroyProtect:

    开启或关闭实例销毁保护。on-开启,off-关闭



3169
3170
3171
# File 'lib/v20170320/models.rb', line 3169

def SlaveZone
  @SlaveZone
end

#UniqSubnetIdObject

说明:创建非云盘版实例时,请根据需要指定实例版本(推荐5.7或8.0),若此参数不填,则默认值为8.0;若创建的是云盘版实例,则此参数仅能指定为5.7或8.0。说明:如果创建的是云盘版实例,此参数为必填且为私有网络类型。若此项不填,则系统会选择默认的 VPC。说明:若此项不填,则系统会选择默认 VPC 下的默认子网。说明:若您创建单节点、双节点、三节点实例,此参数为必填项,请指定可用区,若不指定可用区,则系统会自动选择一个可用区(可能不是您希望部署的可用区);若您创建云盘版实例,此参数不填,请通过参数 ClusterTopology 进行读写节点和只读节点的可用区配置。说明:请选择实例类型,不填会默认选择 master。说明:不填则默认为3306。说明:表名大小写敏感的开启和关闭可通过参数 lower_case_table_names 进行设置,参数值为0表示开启,参数值为1表示关闭,若不设置则此参数默认值为0。若您创建的是 MySQL 8.0 版本的实例,则需要在创建实例时通过设置 lower_case_table_names 参数来开启或关闭表名大小写敏感,创建实例后无法修改参数,即创建后无法修改表名大小写敏感。其他数据库版本的实例支持在创建实例后修改 lower_case_table_names 参数。创建实例时设置表名大小写敏感的 API 调用方法请参见本文中的示例2。说明:双节点、三节点实例请指定此参数值,若不指定,则默认为 Zone 的值;云盘版实例此参数可不填,请通过参数 ClusterTopology 进行读写节点和只读节点的可用区配置;单节点实例为单可用区,无需指定此参数。说明:如果创建的是云盘版实例,此参数为必填。备注:如您使用自定义参数模板 id,可传入自定义参数模板 id;如您计划使用默认参数模板,该参数模板 id 传入 id 无效,需设置 ParamTemplateType。备注:如您需使用云数据库 MySQL 默认参数模板,请设置 ParamTemplateType。说明:若购买的是云盘版实例,此参数为必填,需设置云盘版实例的 RW 和 RO 节点拓扑,RO 节点范围是1 - 5个,请至少设置1个 RO 节点。说明:单节点(云盘)、云盘版实例硬盘类型所支持的地域略有不同,具体支持情况请参考 [地域和可用区](cloud.tencent.com/document/product/236/8458)。

Parameters:

  • GoodsNum:

    实例数量,默认值为 1,最小值 1,最大值为 100。

  • Memory:

    实例内存大小,单位:MB,请使用 [获取云数据库可售卖规格](cloud.tencent.com/document/api/236/17229) 接口获取可创建的内存规格。

  • Volume:

    实例硬盘大小,单位:GB,请使用 [获取云数据库可售卖规格](cloud.tencent.com/document/api/236/17229) 接口获取可创建的硬盘范围。

  • EngineVersion:

    MySQL 版本,值包括:5.5、5.6、5.7和8.0,请使用 [获取云数据库可售卖规格](cloud.tencent.com/document/api/236/17229) 接口获取可创建的实例版本。

  • UniqVpcId:

    私有网络 ID,请使用 [查询私有网络列表](/document/api/215/15778)。

  • UniqSubnetId:

    私有网络下的子网 ID,如果设置了 UniqVpcId,则 UniqSubnetId 必填,请使用 [查询子网列表](/document/api/215/15784)。

  • ProjectId:

    项目 ID,不填为默认项目。

  • Zone:

    可用区信息,请使用 [获取云数据库可售卖规格](cloud.tencent.com/document/api/236/17229) 接口获取可创建的可用区。

  • MasterInstanceId:

    实例 ID,购买只读实例或者灾备实例时必填,该字段表示只读实例或者灾备实例的主实例 ID,请使用 [查询实例列表](cloud.tencent.com/document/api/236/15872) 接口查询云数据库实例 ID。

  • InstanceRole:

    实例类型,支持值包括:master - 表示主实例,dr - 表示灾备实例,ro - 表示只读实例。

  • MasterRegion:

    主实例地域信息,购买灾备、RO实例时,该字段必填。

  • Port:

    自定义端口,端口支持范围:[1024 - 65535]。

  • Password:

    设置 root 账号密码,密码规则:8 - 64 个字符,至少包含字母、数字、字符(支持的字符:_+-&=!@#$%^*())中的两种,购买主实例时可指定该参数,购买只读实例或者灾备实例时指定该参数无意义。

  • ParamList:

    参数列表,参数格式如 ParamList.0.Name=auto_increment&ParamList.0.Value=1。可通过 [查询默认的可设置参数列表](cloud.tencent.com/document/api/236/32662) 查询支持设置的参数。

  • ProtectMode:

    数据复制方式,默认为 0,支持值包括:0 - 表示异步复制,1 - 表示半同步复制,2 - 表示强同步复制,购买主实例时可指定该参数,购买只读实例或者灾备实例时指定该参数无意义。

  • DeployMode:

    多可用区域,默认为 0,支持值包括:0 - 表示单可用区,1 - 表示多可用区,购买主实例时可指定该参数,购买只读实例或者灾备实例时指定该参数无意义。

  • SlaveZone:

    备库 1 的可用区信息。

  • BackupZone:

    备库 2 的可用区信息,默认为空,购买三节点主实例时可指定该参数。

  • SecurityGroup:

    安全组参数,可使用 [查询项目安全组信息](cloud.tencent.com/document/api/236/15850) 接口查询某个项目的安全组详情。

  • RoGroup:

    只读实例信息。购买只读实例时,该参数必传。

  • AutoRenewFlag:

    购买按量计费实例该字段无意义。

  • InstanceName:

    实例名称。一次购买多个实例命名会用后缀数字区分,例instanceName=db,goodsNum=3,实例命名分别为db1,db2,db3。

  • ResourceTags:

    实例标签信息。

  • DeployGroupId:

    置放群组 ID。

  • ClientToken:

    用于保证请求幂等性的字符串。该字符串由客户生成,需保证不同请求之间在48小时内唯一,最大值不超过64个ASCII字符。若不指定该参数,则无法保证请求的幂等性。

  • DeviceType:

    实例隔离类型。支持值包括:“UNIVERSAL” - 通用型实例,“EXCLUSIVE” - 独享型实例,“BASIC_V2” - ONTKE 单节点实例,“CLOUD_NATIVE_CLUSTER” - 云盘版标准型,“CLOUD_NATIVE_CLUSTER_EXCLUSIVE” - 云盘版加强型。不指定则默认为通用型实例。

  • ParamTemplateId:

    参数模板 id。

  • AlarmPolicyList:

    告警策略id数组。腾讯云可观测平台DescribeAlarmPolicy接口返回的OriginId。

  • InstanceNodes:

    实例节点数。对于 RO 和 基础版实例, 该值默认为1。 如果需要购买三节点实例, 请将该值设置为3 或指定 BackupZone 参数。当购买主实例,且未指定该参数和 BackupZone 参数时,该值默认是 2, 即购买两节点实例。

  • Cpu:

    实例cpu核数, 如果不传将根据memory指定的内存值自动填充对应的cpu值。

  • AutoSyncFlag:

    是否自动发起灾备同步功能。该参数仅对购买灾备实例生效。 可选值为:0 - 不自动发起灾备同步;1 - 自动发起灾备同步。该值默认为0。

  • CageId:

    金融围拢 ID 。

  • ParamTemplateType:

    默认参数模板类型。支持值包括:“HIGH_STABILITY” - 高稳定模板,“HIGH_PERFORMANCE” - 高性能模板,默认值是:“HIGH_STABILITY”。

  • AlarmPolicyIdList:

    告警策略名数组,例如:,AlarmPolicyList不为空时该参数无效。

  • DryRun:

    是否只预检此次请求。true:发送检查请求,不会创建实例。检查项包括是否填写了必需参数,请求格式,业务限制等。如果检查不通过,则返回对应错误码;如果检查通过,则返回RequestId.默认为false:发送正常请求,通过检查后直接创建实例。

  • EngineType:

    实例引擎类型,默认为“InnoDB”,支持值包括:“InnoDB”,“RocksDB”。

  • Vips:

    指定实例的IP列表。仅支持主实例指定,按实例顺序,不足则按未指定处理。

  • DataProtectVolume:

    云盘版实例的数据保护空间大小,单位 GB,设置范围1 - 10。

  • ClusterTopology:

    云盘版节点拓扑配置。

  • DiskType:

    硬盘类型,单节点(云盘)或者云盘版实例可以指定此参数。CLOUD_SSD 表示 SSD 云硬盘,CLOUD_HSSD 表示增强型 SSD 云硬盘,CLOUD_PREMIUM 表示高性能云硬盘。

  • ClusterType:

    集群类型:cage——金融围拢,cdc——CDB ON CDC;dedicate——独享集群

  • DestroyProtect:

    开启或关闭实例销毁保护。on-开启,off-关闭



3169
3170
3171
# File 'lib/v20170320/models.rb', line 3169

def UniqSubnetId
  @UniqSubnetId
end

#UniqVpcIdObject

说明:创建非云盘版实例时,请根据需要指定实例版本(推荐5.7或8.0),若此参数不填,则默认值为8.0;若创建的是云盘版实例,则此参数仅能指定为5.7或8.0。说明:如果创建的是云盘版实例,此参数为必填且为私有网络类型。若此项不填,则系统会选择默认的 VPC。说明:若此项不填,则系统会选择默认 VPC 下的默认子网。说明:若您创建单节点、双节点、三节点实例,此参数为必填项,请指定可用区,若不指定可用区,则系统会自动选择一个可用区(可能不是您希望部署的可用区);若您创建云盘版实例,此参数不填,请通过参数 ClusterTopology 进行读写节点和只读节点的可用区配置。说明:请选择实例类型,不填会默认选择 master。说明:不填则默认为3306。说明:表名大小写敏感的开启和关闭可通过参数 lower_case_table_names 进行设置,参数值为0表示开启,参数值为1表示关闭,若不设置则此参数默认值为0。若您创建的是 MySQL 8.0 版本的实例,则需要在创建实例时通过设置 lower_case_table_names 参数来开启或关闭表名大小写敏感,创建实例后无法修改参数,即创建后无法修改表名大小写敏感。其他数据库版本的实例支持在创建实例后修改 lower_case_table_names 参数。创建实例时设置表名大小写敏感的 API 调用方法请参见本文中的示例2。说明:双节点、三节点实例请指定此参数值,若不指定,则默认为 Zone 的值;云盘版实例此参数可不填,请通过参数 ClusterTopology 进行读写节点和只读节点的可用区配置;单节点实例为单可用区,无需指定此参数。说明:如果创建的是云盘版实例,此参数为必填。备注:如您使用自定义参数模板 id,可传入自定义参数模板 id;如您计划使用默认参数模板,该参数模板 id 传入 id 无效,需设置 ParamTemplateType。备注:如您需使用云数据库 MySQL 默认参数模板,请设置 ParamTemplateType。说明:若购买的是云盘版实例,此参数为必填,需设置云盘版实例的 RW 和 RO 节点拓扑,RO 节点范围是1 - 5个,请至少设置1个 RO 节点。说明:单节点(云盘)、云盘版实例硬盘类型所支持的地域略有不同,具体支持情况请参考 [地域和可用区](cloud.tencent.com/document/product/236/8458)。

Parameters:

  • GoodsNum:

    实例数量,默认值为 1,最小值 1,最大值为 100。

  • Memory:

    实例内存大小,单位:MB,请使用 [获取云数据库可售卖规格](cloud.tencent.com/document/api/236/17229) 接口获取可创建的内存规格。

  • Volume:

    实例硬盘大小,单位:GB,请使用 [获取云数据库可售卖规格](cloud.tencent.com/document/api/236/17229) 接口获取可创建的硬盘范围。

  • EngineVersion:

    MySQL 版本,值包括:5.5、5.6、5.7和8.0,请使用 [获取云数据库可售卖规格](cloud.tencent.com/document/api/236/17229) 接口获取可创建的实例版本。

  • UniqVpcId:

    私有网络 ID,请使用 [查询私有网络列表](/document/api/215/15778)。

  • UniqSubnetId:

    私有网络下的子网 ID,如果设置了 UniqVpcId,则 UniqSubnetId 必填,请使用 [查询子网列表](/document/api/215/15784)。

  • ProjectId:

    项目 ID,不填为默认项目。

  • Zone:

    可用区信息,请使用 [获取云数据库可售卖规格](cloud.tencent.com/document/api/236/17229) 接口获取可创建的可用区。

  • MasterInstanceId:

    实例 ID,购买只读实例或者灾备实例时必填,该字段表示只读实例或者灾备实例的主实例 ID,请使用 [查询实例列表](cloud.tencent.com/document/api/236/15872) 接口查询云数据库实例 ID。

  • InstanceRole:

    实例类型,支持值包括:master - 表示主实例,dr - 表示灾备实例,ro - 表示只读实例。

  • MasterRegion:

    主实例地域信息,购买灾备、RO实例时,该字段必填。

  • Port:

    自定义端口,端口支持范围:[1024 - 65535]。

  • Password:

    设置 root 账号密码,密码规则:8 - 64 个字符,至少包含字母、数字、字符(支持的字符:_+-&=!@#$%^*())中的两种,购买主实例时可指定该参数,购买只读实例或者灾备实例时指定该参数无意义。

  • ParamList:

    参数列表,参数格式如 ParamList.0.Name=auto_increment&ParamList.0.Value=1。可通过 [查询默认的可设置参数列表](cloud.tencent.com/document/api/236/32662) 查询支持设置的参数。

  • ProtectMode:

    数据复制方式,默认为 0,支持值包括:0 - 表示异步复制,1 - 表示半同步复制,2 - 表示强同步复制,购买主实例时可指定该参数,购买只读实例或者灾备实例时指定该参数无意义。

  • DeployMode:

    多可用区域,默认为 0,支持值包括:0 - 表示单可用区,1 - 表示多可用区,购买主实例时可指定该参数,购买只读实例或者灾备实例时指定该参数无意义。

  • SlaveZone:

    备库 1 的可用区信息。

  • BackupZone:

    备库 2 的可用区信息,默认为空,购买三节点主实例时可指定该参数。

  • SecurityGroup:

    安全组参数,可使用 [查询项目安全组信息](cloud.tencent.com/document/api/236/15850) 接口查询某个项目的安全组详情。

  • RoGroup:

    只读实例信息。购买只读实例时,该参数必传。

  • AutoRenewFlag:

    购买按量计费实例该字段无意义。

  • InstanceName:

    实例名称。一次购买多个实例命名会用后缀数字区分,例instanceName=db,goodsNum=3,实例命名分别为db1,db2,db3。

  • ResourceTags:

    实例标签信息。

  • DeployGroupId:

    置放群组 ID。

  • ClientToken:

    用于保证请求幂等性的字符串。该字符串由客户生成,需保证不同请求之间在48小时内唯一,最大值不超过64个ASCII字符。若不指定该参数,则无法保证请求的幂等性。

  • DeviceType:

    实例隔离类型。支持值包括:“UNIVERSAL” - 通用型实例,“EXCLUSIVE” - 独享型实例,“BASIC_V2” - ONTKE 单节点实例,“CLOUD_NATIVE_CLUSTER” - 云盘版标准型,“CLOUD_NATIVE_CLUSTER_EXCLUSIVE” - 云盘版加强型。不指定则默认为通用型实例。

  • ParamTemplateId:

    参数模板 id。

  • AlarmPolicyList:

    告警策略id数组。腾讯云可观测平台DescribeAlarmPolicy接口返回的OriginId。

  • InstanceNodes:

    实例节点数。对于 RO 和 基础版实例, 该值默认为1。 如果需要购买三节点实例, 请将该值设置为3 或指定 BackupZone 参数。当购买主实例,且未指定该参数和 BackupZone 参数时,该值默认是 2, 即购买两节点实例。

  • Cpu:

    实例cpu核数, 如果不传将根据memory指定的内存值自动填充对应的cpu值。

  • AutoSyncFlag:

    是否自动发起灾备同步功能。该参数仅对购买灾备实例生效。 可选值为:0 - 不自动发起灾备同步;1 - 自动发起灾备同步。该值默认为0。

  • CageId:

    金融围拢 ID 。

  • ParamTemplateType:

    默认参数模板类型。支持值包括:“HIGH_STABILITY” - 高稳定模板,“HIGH_PERFORMANCE” - 高性能模板,默认值是:“HIGH_STABILITY”。

  • AlarmPolicyIdList:

    告警策略名数组,例如:,AlarmPolicyList不为空时该参数无效。

  • DryRun:

    是否只预检此次请求。true:发送检查请求,不会创建实例。检查项包括是否填写了必需参数,请求格式,业务限制等。如果检查不通过,则返回对应错误码;如果检查通过,则返回RequestId.默认为false:发送正常请求,通过检查后直接创建实例。

  • EngineType:

    实例引擎类型,默认为“InnoDB”,支持值包括:“InnoDB”,“RocksDB”。

  • Vips:

    指定实例的IP列表。仅支持主实例指定,按实例顺序,不足则按未指定处理。

  • DataProtectVolume:

    云盘版实例的数据保护空间大小,单位 GB,设置范围1 - 10。

  • ClusterTopology:

    云盘版节点拓扑配置。

  • DiskType:

    硬盘类型,单节点(云盘)或者云盘版实例可以指定此参数。CLOUD_SSD 表示 SSD 云硬盘,CLOUD_HSSD 表示增强型 SSD 云硬盘,CLOUD_PREMIUM 表示高性能云硬盘。

  • ClusterType:

    集群类型:cage——金融围拢,cdc——CDB ON CDC;dedicate——独享集群

  • DestroyProtect:

    开启或关闭实例销毁保护。on-开启,off-关闭



3169
3170
3171
# File 'lib/v20170320/models.rb', line 3169

def UniqVpcId
  @UniqVpcId
end

#VipsObject

说明:创建非云盘版实例时,请根据需要指定实例版本(推荐5.7或8.0),若此参数不填,则默认值为8.0;若创建的是云盘版实例,则此参数仅能指定为5.7或8.0。说明:如果创建的是云盘版实例,此参数为必填且为私有网络类型。若此项不填,则系统会选择默认的 VPC。说明:若此项不填,则系统会选择默认 VPC 下的默认子网。说明:若您创建单节点、双节点、三节点实例,此参数为必填项,请指定可用区,若不指定可用区,则系统会自动选择一个可用区(可能不是您希望部署的可用区);若您创建云盘版实例,此参数不填,请通过参数 ClusterTopology 进行读写节点和只读节点的可用区配置。说明:请选择实例类型,不填会默认选择 master。说明:不填则默认为3306。说明:表名大小写敏感的开启和关闭可通过参数 lower_case_table_names 进行设置,参数值为0表示开启,参数值为1表示关闭,若不设置则此参数默认值为0。若您创建的是 MySQL 8.0 版本的实例,则需要在创建实例时通过设置 lower_case_table_names 参数来开启或关闭表名大小写敏感,创建实例后无法修改参数,即创建后无法修改表名大小写敏感。其他数据库版本的实例支持在创建实例后修改 lower_case_table_names 参数。创建实例时设置表名大小写敏感的 API 调用方法请参见本文中的示例2。说明:双节点、三节点实例请指定此参数值,若不指定,则默认为 Zone 的值;云盘版实例此参数可不填,请通过参数 ClusterTopology 进行读写节点和只读节点的可用区配置;单节点实例为单可用区,无需指定此参数。说明:如果创建的是云盘版实例,此参数为必填。备注:如您使用自定义参数模板 id,可传入自定义参数模板 id;如您计划使用默认参数模板,该参数模板 id 传入 id 无效,需设置 ParamTemplateType。备注:如您需使用云数据库 MySQL 默认参数模板,请设置 ParamTemplateType。说明:若购买的是云盘版实例,此参数为必填,需设置云盘版实例的 RW 和 RO 节点拓扑,RO 节点范围是1 - 5个,请至少设置1个 RO 节点。说明:单节点(云盘)、云盘版实例硬盘类型所支持的地域略有不同,具体支持情况请参考 [地域和可用区](cloud.tencent.com/document/product/236/8458)。

Parameters:

  • GoodsNum:

    实例数量,默认值为 1,最小值 1,最大值为 100。

  • Memory:

    实例内存大小,单位:MB,请使用 [获取云数据库可售卖规格](cloud.tencent.com/document/api/236/17229) 接口获取可创建的内存规格。

  • Volume:

    实例硬盘大小,单位:GB,请使用 [获取云数据库可售卖规格](cloud.tencent.com/document/api/236/17229) 接口获取可创建的硬盘范围。

  • EngineVersion:

    MySQL 版本,值包括:5.5、5.6、5.7和8.0,请使用 [获取云数据库可售卖规格](cloud.tencent.com/document/api/236/17229) 接口获取可创建的实例版本。

  • UniqVpcId:

    私有网络 ID,请使用 [查询私有网络列表](/document/api/215/15778)。

  • UniqSubnetId:

    私有网络下的子网 ID,如果设置了 UniqVpcId,则 UniqSubnetId 必填,请使用 [查询子网列表](/document/api/215/15784)。

  • ProjectId:

    项目 ID,不填为默认项目。

  • Zone:

    可用区信息,请使用 [获取云数据库可售卖规格](cloud.tencent.com/document/api/236/17229) 接口获取可创建的可用区。

  • MasterInstanceId:

    实例 ID,购买只读实例或者灾备实例时必填,该字段表示只读实例或者灾备实例的主实例 ID,请使用 [查询实例列表](cloud.tencent.com/document/api/236/15872) 接口查询云数据库实例 ID。

  • InstanceRole:

    实例类型,支持值包括:master - 表示主实例,dr - 表示灾备实例,ro - 表示只读实例。

  • MasterRegion:

    主实例地域信息,购买灾备、RO实例时,该字段必填。

  • Port:

    自定义端口,端口支持范围:[1024 - 65535]。

  • Password:

    设置 root 账号密码,密码规则:8 - 64 个字符,至少包含字母、数字、字符(支持的字符:_+-&=!@#$%^*())中的两种,购买主实例时可指定该参数,购买只读实例或者灾备实例时指定该参数无意义。

  • ParamList:

    参数列表,参数格式如 ParamList.0.Name=auto_increment&ParamList.0.Value=1。可通过 [查询默认的可设置参数列表](cloud.tencent.com/document/api/236/32662) 查询支持设置的参数。

  • ProtectMode:

    数据复制方式,默认为 0,支持值包括:0 - 表示异步复制,1 - 表示半同步复制,2 - 表示强同步复制,购买主实例时可指定该参数,购买只读实例或者灾备实例时指定该参数无意义。

  • DeployMode:

    多可用区域,默认为 0,支持值包括:0 - 表示单可用区,1 - 表示多可用区,购买主实例时可指定该参数,购买只读实例或者灾备实例时指定该参数无意义。

  • SlaveZone:

    备库 1 的可用区信息。

  • BackupZone:

    备库 2 的可用区信息,默认为空,购买三节点主实例时可指定该参数。

  • SecurityGroup:

    安全组参数,可使用 [查询项目安全组信息](cloud.tencent.com/document/api/236/15850) 接口查询某个项目的安全组详情。

  • RoGroup:

    只读实例信息。购买只读实例时,该参数必传。

  • AutoRenewFlag:

    购买按量计费实例该字段无意义。

  • InstanceName:

    实例名称。一次购买多个实例命名会用后缀数字区分,例instanceName=db,goodsNum=3,实例命名分别为db1,db2,db3。

  • ResourceTags:

    实例标签信息。

  • DeployGroupId:

    置放群组 ID。

  • ClientToken:

    用于保证请求幂等性的字符串。该字符串由客户生成,需保证不同请求之间在48小时内唯一,最大值不超过64个ASCII字符。若不指定该参数,则无法保证请求的幂等性。

  • DeviceType:

    实例隔离类型。支持值包括:“UNIVERSAL” - 通用型实例,“EXCLUSIVE” - 独享型实例,“BASIC_V2” - ONTKE 单节点实例,“CLOUD_NATIVE_CLUSTER” - 云盘版标准型,“CLOUD_NATIVE_CLUSTER_EXCLUSIVE” - 云盘版加强型。不指定则默认为通用型实例。

  • ParamTemplateId:

    参数模板 id。

  • AlarmPolicyList:

    告警策略id数组。腾讯云可观测平台DescribeAlarmPolicy接口返回的OriginId。

  • InstanceNodes:

    实例节点数。对于 RO 和 基础版实例, 该值默认为1。 如果需要购买三节点实例, 请将该值设置为3 或指定 BackupZone 参数。当购买主实例,且未指定该参数和 BackupZone 参数时,该值默认是 2, 即购买两节点实例。

  • Cpu:

    实例cpu核数, 如果不传将根据memory指定的内存值自动填充对应的cpu值。

  • AutoSyncFlag:

    是否自动发起灾备同步功能。该参数仅对购买灾备实例生效。 可选值为:0 - 不自动发起灾备同步;1 - 自动发起灾备同步。该值默认为0。

  • CageId:

    金融围拢 ID 。

  • ParamTemplateType:

    默认参数模板类型。支持值包括:“HIGH_STABILITY” - 高稳定模板,“HIGH_PERFORMANCE” - 高性能模板,默认值是:“HIGH_STABILITY”。

  • AlarmPolicyIdList:

    告警策略名数组,例如:,AlarmPolicyList不为空时该参数无效。

  • DryRun:

    是否只预检此次请求。true:发送检查请求,不会创建实例。检查项包括是否填写了必需参数,请求格式,业务限制等。如果检查不通过,则返回对应错误码;如果检查通过,则返回RequestId.默认为false:发送正常请求,通过检查后直接创建实例。

  • EngineType:

    实例引擎类型,默认为“InnoDB”,支持值包括:“InnoDB”,“RocksDB”。

  • Vips:

    指定实例的IP列表。仅支持主实例指定,按实例顺序,不足则按未指定处理。

  • DataProtectVolume:

    云盘版实例的数据保护空间大小,单位 GB,设置范围1 - 10。

  • ClusterTopology:

    云盘版节点拓扑配置。

  • DiskType:

    硬盘类型,单节点(云盘)或者云盘版实例可以指定此参数。CLOUD_SSD 表示 SSD 云硬盘,CLOUD_HSSD 表示增强型 SSD 云硬盘,CLOUD_PREMIUM 表示高性能云硬盘。

  • ClusterType:

    集群类型:cage——金融围拢,cdc——CDB ON CDC;dedicate——独享集群

  • DestroyProtect:

    开启或关闭实例销毁保护。on-开启,off-关闭



3169
3170
3171
# File 'lib/v20170320/models.rb', line 3169

def Vips
  @Vips
end

#VolumeObject

说明:创建非云盘版实例时,请根据需要指定实例版本(推荐5.7或8.0),若此参数不填,则默认值为8.0;若创建的是云盘版实例,则此参数仅能指定为5.7或8.0。说明:如果创建的是云盘版实例,此参数为必填且为私有网络类型。若此项不填,则系统会选择默认的 VPC。说明:若此项不填,则系统会选择默认 VPC 下的默认子网。说明:若您创建单节点、双节点、三节点实例,此参数为必填项,请指定可用区,若不指定可用区,则系统会自动选择一个可用区(可能不是您希望部署的可用区);若您创建云盘版实例,此参数不填,请通过参数 ClusterTopology 进行读写节点和只读节点的可用区配置。说明:请选择实例类型,不填会默认选择 master。说明:不填则默认为3306。说明:表名大小写敏感的开启和关闭可通过参数 lower_case_table_names 进行设置,参数值为0表示开启,参数值为1表示关闭,若不设置则此参数默认值为0。若您创建的是 MySQL 8.0 版本的实例,则需要在创建实例时通过设置 lower_case_table_names 参数来开启或关闭表名大小写敏感,创建实例后无法修改参数,即创建后无法修改表名大小写敏感。其他数据库版本的实例支持在创建实例后修改 lower_case_table_names 参数。创建实例时设置表名大小写敏感的 API 调用方法请参见本文中的示例2。说明:双节点、三节点实例请指定此参数值,若不指定,则默认为 Zone 的值;云盘版实例此参数可不填,请通过参数 ClusterTopology 进行读写节点和只读节点的可用区配置;单节点实例为单可用区,无需指定此参数。说明:如果创建的是云盘版实例,此参数为必填。备注:如您使用自定义参数模板 id,可传入自定义参数模板 id;如您计划使用默认参数模板,该参数模板 id 传入 id 无效,需设置 ParamTemplateType。备注:如您需使用云数据库 MySQL 默认参数模板,请设置 ParamTemplateType。说明:若购买的是云盘版实例,此参数为必填,需设置云盘版实例的 RW 和 RO 节点拓扑,RO 节点范围是1 - 5个,请至少设置1个 RO 节点。说明:单节点(云盘)、云盘版实例硬盘类型所支持的地域略有不同,具体支持情况请参考 [地域和可用区](cloud.tencent.com/document/product/236/8458)。

Parameters:

  • GoodsNum:

    实例数量,默认值为 1,最小值 1,最大值为 100。

  • Memory:

    实例内存大小,单位:MB,请使用 [获取云数据库可售卖规格](cloud.tencent.com/document/api/236/17229) 接口获取可创建的内存规格。

  • Volume:

    实例硬盘大小,单位:GB,请使用 [获取云数据库可售卖规格](cloud.tencent.com/document/api/236/17229) 接口获取可创建的硬盘范围。

  • EngineVersion:

    MySQL 版本,值包括:5.5、5.6、5.7和8.0,请使用 [获取云数据库可售卖规格](cloud.tencent.com/document/api/236/17229) 接口获取可创建的实例版本。

  • UniqVpcId:

    私有网络 ID,请使用 [查询私有网络列表](/document/api/215/15778)。

  • UniqSubnetId:

    私有网络下的子网 ID,如果设置了 UniqVpcId,则 UniqSubnetId 必填,请使用 [查询子网列表](/document/api/215/15784)。

  • ProjectId:

    项目 ID,不填为默认项目。

  • Zone:

    可用区信息,请使用 [获取云数据库可售卖规格](cloud.tencent.com/document/api/236/17229) 接口获取可创建的可用区。

  • MasterInstanceId:

    实例 ID,购买只读实例或者灾备实例时必填,该字段表示只读实例或者灾备实例的主实例 ID,请使用 [查询实例列表](cloud.tencent.com/document/api/236/15872) 接口查询云数据库实例 ID。

  • InstanceRole:

    实例类型,支持值包括:master - 表示主实例,dr - 表示灾备实例,ro - 表示只读实例。

  • MasterRegion:

    主实例地域信息,购买灾备、RO实例时,该字段必填。

  • Port:

    自定义端口,端口支持范围:[1024 - 65535]。

  • Password:

    设置 root 账号密码,密码规则:8 - 64 个字符,至少包含字母、数字、字符(支持的字符:_+-&=!@#$%^*())中的两种,购买主实例时可指定该参数,购买只读实例或者灾备实例时指定该参数无意义。

  • ParamList:

    参数列表,参数格式如 ParamList.0.Name=auto_increment&ParamList.0.Value=1。可通过 [查询默认的可设置参数列表](cloud.tencent.com/document/api/236/32662) 查询支持设置的参数。

  • ProtectMode:

    数据复制方式,默认为 0,支持值包括:0 - 表示异步复制,1 - 表示半同步复制,2 - 表示强同步复制,购买主实例时可指定该参数,购买只读实例或者灾备实例时指定该参数无意义。

  • DeployMode:

    多可用区域,默认为 0,支持值包括:0 - 表示单可用区,1 - 表示多可用区,购买主实例时可指定该参数,购买只读实例或者灾备实例时指定该参数无意义。

  • SlaveZone:

    备库 1 的可用区信息。

  • BackupZone:

    备库 2 的可用区信息,默认为空,购买三节点主实例时可指定该参数。

  • SecurityGroup:

    安全组参数,可使用 [查询项目安全组信息](cloud.tencent.com/document/api/236/15850) 接口查询某个项目的安全组详情。

  • RoGroup:

    只读实例信息。购买只读实例时,该参数必传。

  • AutoRenewFlag:

    购买按量计费实例该字段无意义。

  • InstanceName:

    实例名称。一次购买多个实例命名会用后缀数字区分,例instanceName=db,goodsNum=3,实例命名分别为db1,db2,db3。

  • ResourceTags:

    实例标签信息。

  • DeployGroupId:

    置放群组 ID。

  • ClientToken:

    用于保证请求幂等性的字符串。该字符串由客户生成,需保证不同请求之间在48小时内唯一,最大值不超过64个ASCII字符。若不指定该参数,则无法保证请求的幂等性。

  • DeviceType:

    实例隔离类型。支持值包括:“UNIVERSAL” - 通用型实例,“EXCLUSIVE” - 独享型实例,“BASIC_V2” - ONTKE 单节点实例,“CLOUD_NATIVE_CLUSTER” - 云盘版标准型,“CLOUD_NATIVE_CLUSTER_EXCLUSIVE” - 云盘版加强型。不指定则默认为通用型实例。

  • ParamTemplateId:

    参数模板 id。

  • AlarmPolicyList:

    告警策略id数组。腾讯云可观测平台DescribeAlarmPolicy接口返回的OriginId。

  • InstanceNodes:

    实例节点数。对于 RO 和 基础版实例, 该值默认为1。 如果需要购买三节点实例, 请将该值设置为3 或指定 BackupZone 参数。当购买主实例,且未指定该参数和 BackupZone 参数时,该值默认是 2, 即购买两节点实例。

  • Cpu:

    实例cpu核数, 如果不传将根据memory指定的内存值自动填充对应的cpu值。

  • AutoSyncFlag:

    是否自动发起灾备同步功能。该参数仅对购买灾备实例生效。 可选值为:0 - 不自动发起灾备同步;1 - 自动发起灾备同步。该值默认为0。

  • CageId:

    金融围拢 ID 。

  • ParamTemplateType:

    默认参数模板类型。支持值包括:“HIGH_STABILITY” - 高稳定模板,“HIGH_PERFORMANCE” - 高性能模板,默认值是:“HIGH_STABILITY”。

  • AlarmPolicyIdList:

    告警策略名数组,例如:,AlarmPolicyList不为空时该参数无效。

  • DryRun:

    是否只预检此次请求。true:发送检查请求,不会创建实例。检查项包括是否填写了必需参数,请求格式,业务限制等。如果检查不通过,则返回对应错误码;如果检查通过,则返回RequestId.默认为false:发送正常请求,通过检查后直接创建实例。

  • EngineType:

    实例引擎类型,默认为“InnoDB”,支持值包括:“InnoDB”,“RocksDB”。

  • Vips:

    指定实例的IP列表。仅支持主实例指定,按实例顺序,不足则按未指定处理。

  • DataProtectVolume:

    云盘版实例的数据保护空间大小,单位 GB,设置范围1 - 10。

  • ClusterTopology:

    云盘版节点拓扑配置。

  • DiskType:

    硬盘类型,单节点(云盘)或者云盘版实例可以指定此参数。CLOUD_SSD 表示 SSD 云硬盘,CLOUD_HSSD 表示增强型 SSD 云硬盘,CLOUD_PREMIUM 表示高性能云硬盘。

  • ClusterType:

    集群类型:cage——金融围拢,cdc——CDB ON CDC;dedicate——独享集群

  • DestroyProtect:

    开启或关闭实例销毁保护。on-开启,off-关闭



3169
3170
3171
# File 'lib/v20170320/models.rb', line 3169

def Volume
  @Volume
end

#ZoneObject

说明:创建非云盘版实例时,请根据需要指定实例版本(推荐5.7或8.0),若此参数不填,则默认值为8.0;若创建的是云盘版实例,则此参数仅能指定为5.7或8.0。说明:如果创建的是云盘版实例,此参数为必填且为私有网络类型。若此项不填,则系统会选择默认的 VPC。说明:若此项不填,则系统会选择默认 VPC 下的默认子网。说明:若您创建单节点、双节点、三节点实例,此参数为必填项,请指定可用区,若不指定可用区,则系统会自动选择一个可用区(可能不是您希望部署的可用区);若您创建云盘版实例,此参数不填,请通过参数 ClusterTopology 进行读写节点和只读节点的可用区配置。说明:请选择实例类型,不填会默认选择 master。说明:不填则默认为3306。说明:表名大小写敏感的开启和关闭可通过参数 lower_case_table_names 进行设置,参数值为0表示开启,参数值为1表示关闭,若不设置则此参数默认值为0。若您创建的是 MySQL 8.0 版本的实例,则需要在创建实例时通过设置 lower_case_table_names 参数来开启或关闭表名大小写敏感,创建实例后无法修改参数,即创建后无法修改表名大小写敏感。其他数据库版本的实例支持在创建实例后修改 lower_case_table_names 参数。创建实例时设置表名大小写敏感的 API 调用方法请参见本文中的示例2。说明:双节点、三节点实例请指定此参数值,若不指定,则默认为 Zone 的值;云盘版实例此参数可不填,请通过参数 ClusterTopology 进行读写节点和只读节点的可用区配置;单节点实例为单可用区,无需指定此参数。说明:如果创建的是云盘版实例,此参数为必填。备注:如您使用自定义参数模板 id,可传入自定义参数模板 id;如您计划使用默认参数模板,该参数模板 id 传入 id 无效,需设置 ParamTemplateType。备注:如您需使用云数据库 MySQL 默认参数模板,请设置 ParamTemplateType。说明:若购买的是云盘版实例,此参数为必填,需设置云盘版实例的 RW 和 RO 节点拓扑,RO 节点范围是1 - 5个,请至少设置1个 RO 节点。说明:单节点(云盘)、云盘版实例硬盘类型所支持的地域略有不同,具体支持情况请参考 [地域和可用区](cloud.tencent.com/document/product/236/8458)。

Parameters:

  • GoodsNum:

    实例数量,默认值为 1,最小值 1,最大值为 100。

  • Memory:

    实例内存大小,单位:MB,请使用 [获取云数据库可售卖规格](cloud.tencent.com/document/api/236/17229) 接口获取可创建的内存规格。

  • Volume:

    实例硬盘大小,单位:GB,请使用 [获取云数据库可售卖规格](cloud.tencent.com/document/api/236/17229) 接口获取可创建的硬盘范围。

  • EngineVersion:

    MySQL 版本,值包括:5.5、5.6、5.7和8.0,请使用 [获取云数据库可售卖规格](cloud.tencent.com/document/api/236/17229) 接口获取可创建的实例版本。

  • UniqVpcId:

    私有网络 ID,请使用 [查询私有网络列表](/document/api/215/15778)。

  • UniqSubnetId:

    私有网络下的子网 ID,如果设置了 UniqVpcId,则 UniqSubnetId 必填,请使用 [查询子网列表](/document/api/215/15784)。

  • ProjectId:

    项目 ID,不填为默认项目。

  • Zone:

    可用区信息,请使用 [获取云数据库可售卖规格](cloud.tencent.com/document/api/236/17229) 接口获取可创建的可用区。

  • MasterInstanceId:

    实例 ID,购买只读实例或者灾备实例时必填,该字段表示只读实例或者灾备实例的主实例 ID,请使用 [查询实例列表](cloud.tencent.com/document/api/236/15872) 接口查询云数据库实例 ID。

  • InstanceRole:

    实例类型,支持值包括:master - 表示主实例,dr - 表示灾备实例,ro - 表示只读实例。

  • MasterRegion:

    主实例地域信息,购买灾备、RO实例时,该字段必填。

  • Port:

    自定义端口,端口支持范围:[1024 - 65535]。

  • Password:

    设置 root 账号密码,密码规则:8 - 64 个字符,至少包含字母、数字、字符(支持的字符:_+-&=!@#$%^*())中的两种,购买主实例时可指定该参数,购买只读实例或者灾备实例时指定该参数无意义。

  • ParamList:

    参数列表,参数格式如 ParamList.0.Name=auto_increment&ParamList.0.Value=1。可通过 [查询默认的可设置参数列表](cloud.tencent.com/document/api/236/32662) 查询支持设置的参数。

  • ProtectMode:

    数据复制方式,默认为 0,支持值包括:0 - 表示异步复制,1 - 表示半同步复制,2 - 表示强同步复制,购买主实例时可指定该参数,购买只读实例或者灾备实例时指定该参数无意义。

  • DeployMode:

    多可用区域,默认为 0,支持值包括:0 - 表示单可用区,1 - 表示多可用区,购买主实例时可指定该参数,购买只读实例或者灾备实例时指定该参数无意义。

  • SlaveZone:

    备库 1 的可用区信息。

  • BackupZone:

    备库 2 的可用区信息,默认为空,购买三节点主实例时可指定该参数。

  • SecurityGroup:

    安全组参数,可使用 [查询项目安全组信息](cloud.tencent.com/document/api/236/15850) 接口查询某个项目的安全组详情。

  • RoGroup:

    只读实例信息。购买只读实例时,该参数必传。

  • AutoRenewFlag:

    购买按量计费实例该字段无意义。

  • InstanceName:

    实例名称。一次购买多个实例命名会用后缀数字区分,例instanceName=db,goodsNum=3,实例命名分别为db1,db2,db3。

  • ResourceTags:

    实例标签信息。

  • DeployGroupId:

    置放群组 ID。

  • ClientToken:

    用于保证请求幂等性的字符串。该字符串由客户生成,需保证不同请求之间在48小时内唯一,最大值不超过64个ASCII字符。若不指定该参数,则无法保证请求的幂等性。

  • DeviceType:

    实例隔离类型。支持值包括:“UNIVERSAL” - 通用型实例,“EXCLUSIVE” - 独享型实例,“BASIC_V2” - ONTKE 单节点实例,“CLOUD_NATIVE_CLUSTER” - 云盘版标准型,“CLOUD_NATIVE_CLUSTER_EXCLUSIVE” - 云盘版加强型。不指定则默认为通用型实例。

  • ParamTemplateId:

    参数模板 id。

  • AlarmPolicyList:

    告警策略id数组。腾讯云可观测平台DescribeAlarmPolicy接口返回的OriginId。

  • InstanceNodes:

    实例节点数。对于 RO 和 基础版实例, 该值默认为1。 如果需要购买三节点实例, 请将该值设置为3 或指定 BackupZone 参数。当购买主实例,且未指定该参数和 BackupZone 参数时,该值默认是 2, 即购买两节点实例。

  • Cpu:

    实例cpu核数, 如果不传将根据memory指定的内存值自动填充对应的cpu值。

  • AutoSyncFlag:

    是否自动发起灾备同步功能。该参数仅对购买灾备实例生效。 可选值为:0 - 不自动发起灾备同步;1 - 自动发起灾备同步。该值默认为0。

  • CageId:

    金融围拢 ID 。

  • ParamTemplateType:

    默认参数模板类型。支持值包括:“HIGH_STABILITY” - 高稳定模板,“HIGH_PERFORMANCE” - 高性能模板,默认值是:“HIGH_STABILITY”。

  • AlarmPolicyIdList:

    告警策略名数组,例如:,AlarmPolicyList不为空时该参数无效。

  • DryRun:

    是否只预检此次请求。true:发送检查请求,不会创建实例。检查项包括是否填写了必需参数,请求格式,业务限制等。如果检查不通过,则返回对应错误码;如果检查通过,则返回RequestId.默认为false:发送正常请求,通过检查后直接创建实例。

  • EngineType:

    实例引擎类型,默认为“InnoDB”,支持值包括:“InnoDB”,“RocksDB”。

  • Vips:

    指定实例的IP列表。仅支持主实例指定,按实例顺序,不足则按未指定处理。

  • DataProtectVolume:

    云盘版实例的数据保护空间大小,单位 GB,设置范围1 - 10。

  • ClusterTopology:

    云盘版节点拓扑配置。

  • DiskType:

    硬盘类型,单节点(云盘)或者云盘版实例可以指定此参数。CLOUD_SSD 表示 SSD 云硬盘,CLOUD_HSSD 表示增强型 SSD 云硬盘,CLOUD_PREMIUM 表示高性能云硬盘。

  • ClusterType:

    集群类型:cage——金融围拢,cdc——CDB ON CDC;dedicate——独享集群

  • DestroyProtect:

    开启或关闭实例销毁保护。on-开启,off-关闭



3169
3170
3171
# File 'lib/v20170320/models.rb', line 3169

def Zone
  @Zone
end

Instance Method Details

#deserialize(params) ⇒ Object



3216
3217
3218
3219
3220
3221
3222
3223
3224
3225
3226
3227
3228
3229
3230
3231
3232
3233
3234
3235
3236
3237
3238
3239
3240
3241
3242
3243
3244
3245
3246
3247
3248
3249
3250
3251
3252
3253
3254
3255
3256
3257
3258
3259
3260
3261
3262
3263
3264
3265
3266
3267
3268
3269
3270
3271
3272
3273
3274
3275
3276
3277
3278
3279
# File 'lib/v20170320/models.rb', line 3216

def deserialize(params)
  @GoodsNum = params['GoodsNum']
  @Memory = params['Memory']
  @Volume = params['Volume']
  @EngineVersion = params['EngineVersion']
  @UniqVpcId = params['UniqVpcId']
  @UniqSubnetId = params['UniqSubnetId']
  @ProjectId = params['ProjectId']
  @Zone = params['Zone']
  @MasterInstanceId = params['MasterInstanceId']
  @InstanceRole = params['InstanceRole']
  @MasterRegion = params['MasterRegion']
  @Port = params['Port']
  @Password = params['Password']
  unless params['ParamList'].nil?
    @ParamList = []
    params['ParamList'].each do |i|
      paraminfo_tmp = ParamInfo.new
      paraminfo_tmp.deserialize(i)
      @ParamList << paraminfo_tmp
    end
  end
  @ProtectMode = params['ProtectMode']
  @DeployMode = params['DeployMode']
  @SlaveZone = params['SlaveZone']
  @BackupZone = params['BackupZone']
  @SecurityGroup = params['SecurityGroup']
  unless params['RoGroup'].nil?
    @RoGroup = RoGroup.new
    @RoGroup.deserialize(params['RoGroup'])
  end
  @AutoRenewFlag = params['AutoRenewFlag']
  @InstanceName = params['InstanceName']
  unless params['ResourceTags'].nil?
    @ResourceTags = []
    params['ResourceTags'].each do |i|
      taginfo_tmp = TagInfo.new
      taginfo_tmp.deserialize(i)
      @ResourceTags << taginfo_tmp
    end
  end
  @DeployGroupId = params['DeployGroupId']
  @ClientToken = params['ClientToken']
  @DeviceType = params['DeviceType']
  @ParamTemplateId = params['ParamTemplateId']
  @AlarmPolicyList = params['AlarmPolicyList']
  @InstanceNodes = params['InstanceNodes']
  @Cpu = params['Cpu']
  @AutoSyncFlag = params['AutoSyncFlag']
  @CageId = params['CageId']
  @ParamTemplateType = params['ParamTemplateType']
  @AlarmPolicyIdList = params['AlarmPolicyIdList']
  @DryRun = params['DryRun']
  @EngineType = params['EngineType']
  @Vips = params['Vips']
  @DataProtectVolume = params['DataProtectVolume']
  unless params['ClusterTopology'].nil?
    @ClusterTopology = ClusterTopology.new
    @ClusterTopology.deserialize(params['ClusterTopology'])
  end
  @DiskType = params['DiskType']
  @ClusterType = params['ClusterType']
  @DestroyProtect = params['DestroyProtect']
end