文档

CreateInstance - 创建集群

更新时间:

创建一个 OceanBase 数据库集群。

调试

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

授权信息

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

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

请求参数

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

实例的付费方式。取值范围:

  • PrePay:包年包月。选择该类付费方式时,必须确认自己的账号支持余额支付 / 信用支付,否则将返回 InvalidPayMethod 的错误提示。
  • PostPay(默认):按量付费(默认按小时计费)。
PrePay
Seriesstring

实例的系列。

  • normal(默认):标准集群版(云盘)。
  • normal_ssd:标准集群版(本地盘)。
  • history:历史库集群版。
  • normal_kv:obkv 集群。
  • normal_hg:信创集群(需要添加白名单开放)。
normal
Zonesstring

实例所属的可用区 ID。
输入多个可用区时注意以逗号分隔。 更多详情,请参见 DescribeZones 获取可用区列表。

cn-hangzhou-h,cn-hangzhou-i,cn-hangzhou-j
InstanceClassstring

集群规格信息。
当前支持以下套餐:

  • 4C16GB:4 核 16GB。
  • 8C32GB:8 核 32GB。
  • 14C70GB:14 核 70GB。
  • 24C120GB:24 核 120GB。
  • 30C180GB:30 核 180GB。
  • 62C400GB:62 核 400GB。
  • 104C600GB:104 核 600GB。
  • 16C70GB:16 核 70GB。
  • 32C160GB:32 核 160GB。
  • 64C380GB:64 核 380GB。
  • 20C32GB:20 核 32GB。
  • 40C64GB:40 核 64GB。
  • 16C32GB:16 核 32GB。
  • 32C70GB:32 核 70GB。
  • 64C180GB:64 核 180GB。
  • 32C180GB:32 核 180GB。
  • 64C400GB:64 核 400GB。
14C70GB
DiskSizelong

存储空间大小,单位 GB。 存储空间的限制根据集群规格不同而不同,具体如下:

  • 8C32GB:100GB~10000GB。
  • 14C70GB:200GB~10000GB。
  • 30C180GB:400GB~10000GB。
  • 62C400G:800GB-10000GB。 各套餐的存储空间默认值为其最小值。
200
Periodlong

购买资源的时长,单位由 PeriodUnit 指定。
当参数 InstanceChargeType 取值为 PrePaid 时才生效且为必选值。 取值范围:

  • PeriodUnit=Month 时,Period 取值:{“1”, “2”, “3”, “4”, “5”, “6”, “7”, “8”, “9”}。
  • PeriodUnit=Year 时,Period 取值:{“1”, “2”, “3”}。
1
PeriodUnitstring

购买资源的时长。
包年包月取值范围:Month 或者 Year。
默认值:包年包月为 Month,按量计费,默认周期为 Hour。

Month
AutoRenewboolean

是否要自动续费。 当参数 ChargeType 取值 PrePaid 时生效。取值范围:

  • true:自动续费。
  • false(默认):不自动续费。
true
AutoRenewPeriodlong

每次自动续费的时长,当参数 AutoRenew 取值 True 时,该参数为必填参数。

  • PeriodUnit 为 Year 时,AutoRenewPeriod 取值范围为 {"1", "2", "3"}。
  • PeriodUnit 为 Month 时,AutoRenewPeriod 取值范围为 {"1", "2", "3", "6", "12"}。
2
ResourceGroupIdstring

实例所在的企业资源组 ID。

rg-bp67acfmxazb4p****
InstanceNamestring

OceanBase 集群名称。 长度为 1~20 个英文或中文字符。 如未指定该参数,默认值为集群的 InstanceId。

amap_aos_tx_ob
ObVersionstring

OceanBase Server 版本号。

2.2.77
DiskTypestring

集群的存储类型。仅在标准集群版(云盘)下生效。
当前支持两种类型:

  • cloud_essd_pl1:云盘 ESSD PL1。
  • cloud_essd_pl0:云盘 ESSD PL0。默认值为 cloud_essd_pl1。
cloud_essd_pl1
DryRunboolean

是否只预检此次请求, 默认为 false。取值范围:

  • true:发送检查请求,不会创建实例。如果检查通过,则返回 DryRunResult=true, 如果检查不通过,则返回相应错误的错误码。
  • false(默认):发送正常请求,通过检查后直接创建实例。如为 false, 则表示不进行预检查, DryRunResult 默认返回 false。
false
ReplicaModestring

全功能型副本数。返回值仅包含 3 和 2。

  • 3:表示 3 个全功能型副本。
  • 2:表示 2 个全功能型副本。 三可用区部署时,只支持 3 个全功能型副本,双可用区部署时,仅支持 2 个全功能型副本,单可用区部署时,可以支持 2 个或者 3 个全功能型副本。
3
IsolationOptimizationstring

是否开启 Cgroup。

true
PrimaryInstancestring

主实例 ID。

ob3h8ytroxxxxx
PrimaryRegionstring

主实例 Region。

cn-hangzhou
CpuArchstring

cpu 架构

x86

返回参数

名称类型描述示例值
object

请求结果。

RequestIdstring

请求 ID。

EE205C00-30E4-****-****-87E3A8A2AA0C
Dataobject

返回数据。

InstanceIdstring

实例 ID。

i-bp67acfmxazb4p****
OrderIdstring

订单 ID。
该参数在创建预付费和后付费集群时包含返回值。

1234567890
ResourceGroupIdstring

资源组 ID。

rg-***************
DryRunResultboolean

预检查请求的结果。

  • 如果 DryRun 填写为 true,当预检查请求通过,则 DryRunResult 返回 true,否则返回相应的错误码信息。
  • 如果 DryRun 填写为 false, 则表示不进行预检查, DryRunResult 默认返回 false。
false

示例

正常返回示例

JSON格式

{
  "RequestId": "EE205C00-30E4-****-****-87E3A8A2AA0C",
  "Data": {
    "InstanceId": "i-bp67acfmxazb4p****",
    "OrderId": "1234567890",
    "ResourceGroupId": "rg-***************",
    "DryRunResult": false
  }
}

错误码

HTTP status code错误码错误信息
400Instance.Order.CreateFailedInstance.Order.CreateFailed
400InstanceName.ModifyFailedInstanceName.ModifyFailed
400InstanceClass.InvalidValueInstanceClass.InvalidValue
400InstanceType.UnsupportInstanceType.Unsupport
400ZoneList.UnsupportZoneList.Unsupport
400InstanceId.InvalidInstanceId.Invalid
400InstanceId.MissingInstanceId.Missing
400Instance.Name.MissingInstance.Name.Missing
400ListCluster.FailListCluster.Fail
400GetCluster.FailGetCluster.Fail
400ListClusterGroup.FailListClusterGroup.Fail
400GetClusterGroup.FailGetClusterGroup.Fail
400ListInstance.FailListInstance.Fail
400GetInstance.FailGetInstance.Fail
400ListTenant.FailListTenant.Fail
400GetTenant.FailGetTenant.Fail
400Instance.ListAliyunInstance.FailInstance.ListAliyunInstance.Fail
400Instance.GetAliyunInstance.FailInstance.GetAliyunInstance.Fail
400ListZone.FailListZone.Fail
400ListObServer.FailListObServer.Fail
400GetObServer.FailGetObServer.Fail
400CreateInstanceParameters.ErrorCreateInstanceParameters.Error
400CreateInstance.FailCreateInstance.Fail
400InstanceClassSpecification.InvalidInstanceClassSpecification.Invalid
400InstanceOrder.NotAvailableInstanceOrder.NotAvailable
400InstanceNodeNum.InvalidInstanceNodeNum.Invalid
400InstanceLogSize.InvalidInstanceLogSize.Invalid
400Instance.ExpandLogDisk.NotSupportInstance.ExpandLogDisk.NotSupport
400InstanceStatus.InvalidInstanceStatus.Invalid
400InstanceDataSize.InvalidInstanceDataSize.Invalid
400StandbyInstance.StillOnlineStandbyInstance.StillOnline
400InstanceServiceName.MissingInstanceServiceName.Missing
400PrimaryInstanceStatus.InvalidPrimaryInstanceStatus.Invalid
400StandbyInstanceStatus.InvalidStandbyInstanceStatus.Invalid
400StandbyInstance.NotSupportStandbyInstance.NotSupport
400StandbyInstance.Disconnect.NotAllowedStandbyInstance.Disconnect.NotAllowed
400InstanceDiskSize.InvalidInstanceDiskSize.Invalid
400CreateInstance.Spec.NotSupportCreateInstance.Spec.NotSupport
400MissingParameterDiskSizeMissingParameterDiskSize
400CreateInstance.ReplicaMode.InvalidValueCreateInstance.ReplicaMode.InvalidValue
400CreateInstance.DeployType.InvalidValueCreateInstance.DeployType.InvalidValue
400ConfigErrorConfigError
500UnknownErrorUnknownError

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

变更历史

变更时间变更内容概要操作
2024-04-15OpenAPI 错误码发生变更、OpenAPI 入参发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
    删除错误码:500
入参OpenAPI 入参发生变更
    新增入参:CpuArch
2024-02-02OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
    删除错误码:500
2023-12-26OpenAPI 错误码发生变更、OpenAPI 入参发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
    删除错误码:500
入参OpenAPI 入参发生变更
    新增入参:PrimaryInstance
    新增入参:PrimaryRegion
2023-12-07OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
    删除错误码:500
2023-11-20OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
    删除错误码:500
2023-10-30OpenAPI 错误码发生变更、OpenAPI 入参发生变更、OpenAPI 返回结构发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
    删除错误码:500
入参OpenAPI 入参发生变更
    新增入参:DryRun
    新增入参:ReplicaMode
    新增入参:IsolationOptimization
出参OpenAPI 返回结构发生变更
2023-08-22OpenAPI 错误码发生变更、OpenAPI 入参发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
    删除错误码:500
入参OpenAPI 入参发生变更
    删除入参:ReplicaMode
2023-07-13OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
    删除错误码:500
2023-07-04OpenAPI 错误码发生变更、OpenAPI 入参发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    新增错误码:400
    新增错误码:500
入参OpenAPI 入参发生变更
    新增入参:ReplicaMode
2023-05-09API 内部配置变更,不影响调用看变更集
变更项变更内容
API 内部配置变更,不影响调用
2023-04-11API 内部配置变更,不影响调用看变更集
变更项变更内容
API 内部配置变更,不影响调用
2023-04-06API 内部配置变更,不影响调用看变更集
变更项变更内容
API 内部配置变更,不影响调用
2023-03-08API 内部配置变更,不影响调用看变更集
变更项变更内容
API 内部配置变更,不影响调用
2022-09-28OpenAPI 入参发生变更看变更集
变更项变更内容
入参OpenAPI 入参发生变更
    新增入参:ObVersion
    新增入参:DiskType
2022-02-10OpenAPI 入参发生变更、OpenAPI 返回结构发生变更看变更集
变更项变更内容
入参OpenAPI 入参发生变更
    新增入参:InstanceName
出参OpenAPI 返回结构发生变更
  • 本页导读 (0)