CreateInstance_云数据库 OceanBase 版_API文档

插件下载了解更多
VS Code 插件
安装插件之前,确保已安装 VS Code安装插件之前,确保已安装 VS Code
Alibaba Cloud Developer Toolkit is a collection of extensions that can help access Alibaba Cloud services in Visual Studio Code.
JetBrains 插件
安装插件之前,确保已安装 JetBrains IDE安装插件之前,确保已安装 JetBrains IDE
The Alibaba Cloud Developer Toolkit for JetBrains makes it easier to access Alibaba Cloud services.

流控信息

当前云产品API请求速率暂未透出。

授权信息

如下是此API对应的授权信息,用于RAM权限策略语句的Action元素中,为RAM用户或RAM角色授予调用此API的权限。请通过 RAM 访问控制设置,使用方法可参考访问控制帮助文档

具体说明如下:展开详情

操作访问级别资源类型条件关键字关联操作
oceanbase:CreateInstance
Create
Instance
acs:oceanbase:{#regionId}:{#accountId}:instance/*

请求参数

字段名称字段详情
ChargeTypestring

实例的付费方式。取值范围: 展开详情

示例值:PrePay枚举值:PrePayPostPay
Seriesstring

实例的系列。展开详情

示例值:normal枚举值:normalnormal_ssdhistorynormal_kvnormal_hg
Zonesstring

实例所属的可用区 ID。 展开详情

示例值:cn-hangzhou-h,cn-hangzhou-i,cn-hangzhou-j参考取值来源:
    DescribeZones
InstanceClassstring

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

示例值:14C70GB枚举值:64C380GB64C400GB32C70GB14C70GB16C32GB4C16GB32C160GB8C32GB16C70GB24C120GB32C180GB30C180GB40C64GB62C400GB20C32GB104C600GB64C180GB参考取值来源:
    DescribeInstances
DiskSizeinteger<int64>

存储空间大小,单位 GB。展开详情

注意 该字段类型为 Long,在序列化/反序列化的过程中可能导致精度丢失,请注意数值不得大于 9007199254740991。
示例值:200
Periodinteger<int64>

购买资源的时长,单位由 PeriodUnit 指定。 展开详情

注意 该字段类型为 Long,在序列化/反序列化的过程中可能导致精度丢失,请注意数值不得大于 9007199254740991。
示例值:1
PeriodUnitstring

购买资源的时长。 展开详情

示例值:Month
AutoRenewboolean

是否要自动续费。展开详情

示例值:true
AutoRenewPeriodinteger<int64>

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

注意 该字段类型为 Long,在序列化/反序列化的过程中可能导致精度丢失,请注意数值不得大于 9007199254740991。
示例值:2
ResourceGroupIdstring

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

示例值:rg-bp67acfmxazb4p****
InstanceNamestring

OceanBase 集群名称。展开详情

示例值:amap_aos_tx_ob参考取值来源:
    DescribeInstance
字符长度 <= 64字符长度 >= 0
ObVersionstring

OceanBase Server 版本号。

示例值:2.2.77
DiskTypestring

集群的存储类型。仅在标准集群版(云盘)下生效。 展开详情

示例值:cloud_essd_pl1枚举值:cloud_essd_pl1cloud_essd_pl0
DryRunboolean

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

示例值:false
ReplicaModestring

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

示例值:3枚举值:32
IsolationOptimizationstring

是否开启 Cgroup。

示例值:true枚举值:truefalse
PrimaryInstancestring

主实例 ID。

示例值:ob3h8ytroxxxxx参考取值来源:
    DescribeInstance
PrimaryRegionstring

主实例 Region。

示例值:cn-hangzhou
CpuArchstring

cpu 架构

示例值:x86

返回参数

字段名称字段详情
RequestIdstring

请求 ID。

示例值:EE205C00-30E4-****-****-87E3A8A2AA0C
Dataobject

返回数据。

返回示例

错误码

全局错误码
HTTP 状态码错误码错误信息操作
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
Instance.Order.CreateFailed
Instance.Order.CreateFailed诊断
500
UnknownError
UnknownError诊断

变更历史

变更时间变更内容概要操作
2024-08-15
变更请求参数InstanceName
2024-07-16
变更请求参数InstanceClass
2024-06-06
变更请求参数InstanceClass
2024-04-15
变更请求参数InstanceClass
新增请求参数CpuArch
2024-02-02
变更请求参数InstanceClass
2023-12-26
变更请求参数InstanceClass
新增请求参数PrimaryInstance
新增请求参数PrimaryRegion
2023-12-07
变更请求参数InstanceClass
2023-11-20
变更请求参数Series
变更请求参数InstanceClass
2023-10-30
变更请求参数Series
变更请求参数InstanceClass
新增请求参数DryRun
新增请求参数ReplicaMode
新增请求参数IsolationOptimization
变更返回参数

相关示例