创建一个 OceanBase 数据库集群。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
oceanbase:CreateInstance | create |
|
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
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 |
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 |
DryRun | boolean | 否 | 是否只预检此次请求, 默认为 false。取值范围:
| false |
ReplicaMode | string | 否 | 全功能型副本数。返回值仅包含 3 和 2。
| 3 |
IsolationOptimization | string | 否 | 是否开启 Cgroup。 | true |
PrimaryInstance | string | 否 | 主实例 ID。 | ob3h8ytroxxxxx |
PrimaryRegion | string | 否 | 主实例 Region。 | cn-hangzhou |
CpuArch | string | 否 | cpu 架构 | x86 |
返回参数
示例
正常返回示例
JSON
格式
{
"RequestId": "EE205C00-30E4-****-****-87E3A8A2AA0C",
"Data": {
"InstanceId": "i-bp67acfmxazb4p****",
"OrderId": "1234567890",
"ResourceGroupId": "rg-***************",
"DryRunResult": false
}
}
错误码
HTTP status code | 错误码 | 错误信息 |
---|---|---|
400 | Instance.Order.CreateFailed | Instance.Order.CreateFailed |
400 | InstanceName.ModifyFailed | InstanceName.ModifyFailed |
400 | InstanceClass.InvalidValue | InstanceClass.InvalidValue |
400 | InstanceType.Unsupport | InstanceType.Unsupport |
400 | ZoneList.Unsupport | ZoneList.Unsupport |
400 | InstanceId.Invalid | InstanceId.Invalid |
400 | InstanceId.Missing | InstanceId.Missing |
400 | Instance.Name.Missing | Instance.Name.Missing |
400 | ListCluster.Fail | ListCluster.Fail |
400 | GetCluster.Fail | GetCluster.Fail |
400 | ListClusterGroup.Fail | ListClusterGroup.Fail |
400 | GetClusterGroup.Fail | GetClusterGroup.Fail |
400 | ListInstance.Fail | ListInstance.Fail |
400 | GetInstance.Fail | GetInstance.Fail |
400 | ListTenant.Fail | ListTenant.Fail |
400 | GetTenant.Fail | GetTenant.Fail |
400 | Instance.ListAliyunInstance.Fail | Instance.ListAliyunInstance.Fail |
400 | Instance.GetAliyunInstance.Fail | Instance.GetAliyunInstance.Fail |
400 | ListZone.Fail | ListZone.Fail |
400 | ListObServer.Fail | ListObServer.Fail |
400 | GetObServer.Fail | GetObServer.Fail |
400 | CreateInstanceParameters.Error | CreateInstanceParameters.Error |
400 | CreateInstance.Fail | CreateInstance.Fail |
400 | InstanceClassSpecification.Invalid | InstanceClassSpecification.Invalid |
400 | InstanceOrder.NotAvailable | InstanceOrder.NotAvailable |
400 | InstanceNodeNum.Invalid | InstanceNodeNum.Invalid |
400 | InstanceLogSize.Invalid | InstanceLogSize.Invalid |
400 | Instance.ExpandLogDisk.NotSupport | Instance.ExpandLogDisk.NotSupport |
400 | InstanceStatus.Invalid | InstanceStatus.Invalid |
400 | InstanceDataSize.Invalid | InstanceDataSize.Invalid |
400 | StandbyInstance.StillOnline | StandbyInstance.StillOnline |
400 | InstanceServiceName.Missing | InstanceServiceName.Missing |
400 | PrimaryInstanceStatus.Invalid | PrimaryInstanceStatus.Invalid |
400 | StandbyInstanceStatus.Invalid | StandbyInstanceStatus.Invalid |
400 | StandbyInstance.NotSupport | StandbyInstance.NotSupport |
400 | StandbyInstance.Disconnect.NotAllowed | StandbyInstance.Disconnect.NotAllowed |
400 | InstanceDiskSize.Invalid | InstanceDiskSize.Invalid |
400 | CreateInstance.Spec.NotSupport | CreateInstance.Spec.NotSupport |
400 | MissingParameterDiskSize | MissingParameterDiskSize |
400 | CreateInstance.ReplicaMode.InvalidValue | CreateInstance.ReplicaMode.InvalidValue |
400 | CreateInstance.DeployType.InvalidValue | CreateInstance.DeployType.InvalidValue |
400 | ConfigError | ConfigError |
500 | UnknownError | UnknownError |
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 |
---|---|---|
2024-08-15 | OpenAPI 错误码发生变更 | 查看变更详情 |
2024-07-16 | OpenAPI 错误码发生变更 | 查看变更详情 |
2024-06-06 | OpenAPI 错误码发生变更 | 查看变更详情 |
2024-04-15 | OpenAPI 错误码发生变更、OpenAPI 入参发生变更 | 查看变更详情 |
2024-02-02 | OpenAPI 错误码发生变更 | 查看变更详情 |
2023-12-26 | OpenAPI 错误码发生变更、OpenAPI 入参发生变更 | 查看变更详情 |
2023-12-07 | OpenAPI 错误码发生变更 | 查看变更详情 |
2023-11-20 | OpenAPI 错误码发生变更 | 查看变更详情 |
2023-10-30 | OpenAPI 错误码发生变更、OpenAPI 入参发生变更、OpenAPI 返回结构发生变更 | 查看变更详情 |
2023-08-22 | OpenAPI 错误码发生变更、OpenAPI 入参发生变更 | 查看变更详情 |
2023-07-13 | OpenAPI 错误码发生变更 | 查看变更详情 |
2023-07-04 | OpenAPI 错误码发生变更、OpenAPI 入参发生变更 | 查看变更详情 |
2023-05-09 | API 内部配置变更,不影响调用 | 查看变更详情 |
2023-04-11 | API 内部配置变更,不影响调用 | 查看变更详情 |
2023-04-06 | API 内部配置变更,不影响调用 | 查看变更详情 |
2023-03-08 | API 内部配置变更,不影响调用 | 查看变更详情 |
2022-09-28 | OpenAPI 入参发生变更 | 查看变更详情 |
2022-02-10 | OpenAPI 入参发生变更、OpenAPI 返回结构发生变更 | 查看变更详情 |