CreateInstance - 创建集群

创建一个 OceanBase 数据库集群。

调试

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

调试

授权信息

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

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

请求参数

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

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

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

实例的系列。

  • normal(默认):标准集群版(云盘)。
  • normal_ssd:标准集群版(本地盘)。
  • history:历史库集群版。
Normal
Zonesstring

实例所属的可用区 ID。
更多详情,请参见 DescribeZones 获取可用区列表。

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

集群规格信息。 当前支持四种套餐:

  • 8C32GB:8 核 32GB。
  • 14C70GB(默认):14 核 70GB。
  • 30C180GB:30 核 180GB。
  • 62C400GB:62 核 400GB。
14C70GB
DiskSizelong

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

  • 8C32GB:100GB~10000GB。
  • 14C70GB:200GB~10000GB。
  • 30C180GB:400GB~10000GB。
  • 62C400G:800GB-10000GB。

各套餐的存储空间默认值为其最小值。

200
Periodlong

购买资源的时长,单位由 PeriodUnit 指定。
当参数 InstanceChargeType 取值为 PrePaid 时才生效且为必选值。
一旦指定了 DedicatedHostId,则取值范围不能超过专有宿主机的订阅时长。
取值范围:

  • PeriodUnit=Week 时,Period 取值:{“1”, “2”, “3”, “4”}。
  • PeriodUnit=Month 时,Period 取值:{“1”, “2”, “3”, “4”, “5”, “6”, “7”, “8”, “9”, “12”, “24”, “36”, ”48”, ”60”}。
1
PeriodUnitstring

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

Month
AutoRenewboolean

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

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

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

  • PeriodUnit 为 Week 时,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

返回参数

名称类型描述示例值
object

请求结果。

RequestIdstring

请求 ID。

473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
Dataobject

返回数据。

InstanceIdstring

实例 ID。

i-bp67acfmxazb4p****
OrderIdstring

订单 ID。
该参数只有创建包年包月 ECS 实例(请求参数 InstanceChargeType=PrePaid)时有返回值。

1234567890
ResourceGroupIdstring

资源组 ID。

rg-***************

示例

正常返回示例

JSON格式

{
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
  "Data": {
    "InstanceId": "i-bp67acfmxazb4p****",
    "OrderId": "1234567890",
    "ResourceGroupId": "rg-***************"
  }
}

错误码

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

变更历史

变更时间变更内容概要操作
2022-09-28OpenAPI 入参发生变更
变更项变更内容
入参OpenAPI 入参发生变更
    新增入参:ObVersion
    新增入参:DiskType
2022-02-10OpenAPI 入参发生变更,OpenAPI 返回结构发生变更
变更项变更内容
入参OpenAPI 入参发生变更
    新增入参:InstanceName
出参OpenAPI 返回结构发生变更
阿里云首页 云数据库 OceanBase 版 相关技术圈