創建一個 OceanBase 數據庫集群。
調試
您可以在OpenAPI Explorer中直接運行該接口,免去您計算簽名的困擾。運行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息,可以在RAM權限策略語句的Action
元素中使用,用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下:
- 操作:是指具體的權限點。
- 訪問級別:是指每個操作的訪問級別,取值為寫入(Write)、讀取(Read)或列出(List)。
- 資源類型:是指操作中支持授權的資源類型。具體說明如下:
- 對于必選的資源類型,用背景高亮的方式表示。
- 對于不支持資源級授權的操作,用
全部資源
表示。
- 條件關鍵字:是指云產品自身定義的條件關鍵字。
- 關聯操作:是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限,操作才能成功。
操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
---|---|---|---|---|
oceanbase:CreateInstance | create | *Instance acs:oceanbase:{#regionId}:{#accountId}:instance/* |
| 無 |
請求參數
名稱 | 類型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
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 返回結構發生變更 | 查看變更詳情 |