创建一个 OceanBase 数据库集群。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
oceanbase:CreateInstance | Write |
|
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
ChargeType | string | 是 | 实例的付费方式。取值范围:
| PrePay |
Series | string | 是 | 实例的系列。
| Normal |
Zones | string | 是 | 实例所属的可用区 ID。 | cn-hangzhou-h,cn-hangzhou-i,cn-hangzhou-j |
InstanceClass | string | 是 | 集群规格信息。 当前支持四种套餐:
| 14C70GB |
DiskSize | long | 是 | 存储空间大小,单位 GB。 存储空间的限制根据集群规格不同而不同,具体如下:
各套餐的存储空间默认值为其最小值。 | 200 |
Period | long | 否 | 购买资源的时长,单位由 PeriodUnit 指定。
| 1 |
PeriodUnit | string | 否 | 购买资源的时长。 包年包月取值范围:Month。 默认值:包年包月为 Month,按量计费,默认周期为 Hour。 | Month |
AutoRenew | boolean | 否 | 是否要自动续费。 当参数 ChargeType 取值 PrePaid 时生效。取值范围:
| true |
AutoRenewPeriod | long | 否 | 每次自动续费的时长,当参数 AutoRenew 取值 True 时,该参数为必填参数。
| 2 |
ResourceGroupId | string | 否 | 实例所在的企业资源组 ID。 | rg-bp67acfmxazb4p**** |
InstanceName | string | 否 | OceanBase 集群名称。 长度为 1~20 个英文或中文字符。 如未指定该参数,默认值为集群的 InstanceId。 | amap_aos_tx_ob |
ObVersion | string | 否 | OceanBase Server 版本号。 | 2.2.77 |
DiskType | string | 否 | 集群的存储类型。仅在标准集群版(云盘)下生效。
| cloud_essd_pl1 |
返回参数
示例
正常返回示例
JSON
格式
{
"RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
"Data": {
"InstanceId": "i-bp67acfmxazb4p****",
"OrderId": "1234567890",
"ResourceGroupId": "rg-***************"
}
}
错误码
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 | ||||||
---|---|---|---|---|---|---|---|---|
2022-09-28 | OpenAPI 入参发生变更 | |||||||
| ||||||||
2022-02-10 | OpenAPI 入参发生变更,OpenAPI 返回结构发生变更 | |||||||
|