该接口用于创建Hologres实例。
接口说明
警告 该 API 操作涉及费用，请确保在使用该接口前，已充分了解实时数仓 Hologres 的收费方式和价格。
-
Hologres 计费详情请参见计费概述。
-
创建 Hologres 实例时，您需要指定实例所在地域和可用区。一个地域可能对应多个可用区，具体如下：
cn-hangzhou(杭州)：cn-hangzhou-h, cn-hangzhou-j
cn-shanghai(上海): cn-shanghai-e, cn-shanghai-f
cn-beijing(北京): cn-beijing-i, cn-beijing-g
cn-zhangjiakou(张家口): cn-zhangjiakou-b
cn-shenzhen(深圳): cn-shenzhen-d, cn-shenzhen-f, cn-shenzhen-e
cn-hongkong(香港): cn-hongkong-b
cn-shanghai-finance-1(上海金融云): cn-shanghai-finance-1z
ap-northeast-1(日本): ap-northeast-1a
ap-southeast-1(新加坡): ap-southeast-1c
ap-southeast-3(吉隆坡): ap-southeast-3b
ap-southeast-5(雅加达): ap-southeast-5b
eu-central-1(法兰克福): eu-central-1a
us-east-1(硅谷): us-east-1a
us-west-1(弗吉尼亚): us-west-1b
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| hologram:CreateInstance | create | *全部资源 * |
| 无 |
请求语法
POST /api/v1/instances/create HTTP/1.1
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| body | object | 否 | 请求体。 | |
| regionId | string | 是 | 地域 Id. 可前往 API 门户或“使用说明”查看。 | cn-hangzhou |
| zoneId | string | 是 | 可用区 Id。参考“使用说明“ | cn-hangzhou-h |
| vpcId | string | 是 | 虚拟专有网络，其所在 regionId 必须与实例一致。 | vpc-t4netc3y5xxxx |
| vSwitchId | string | 是 | 虚拟专有交换机，其所在 zoneId 必须与实例一致。 | vsw-2vccsiymtxxxxxx |
| resourceGroupId | string | 否 | 资源组。若为空，则为账号默认资源组。 | "" |
| instanceName | string | 是 | 实例名称(2-64 个字符，一个中文/字母算一个字符)。 | my_holo |
| instanceType | string | 是 | 实例类型。取值：
| Standard |
| cpu | long | 否 | 实例规格。取值：
说明
| 64 |
| storageSize | long | 否 | 实例标准存储空间。单位：GB。 说明
按量付费实例（PostPaid）会忽略此参数。
| 500 |
| coldStorageSize | long | 否 | 实例低频存储空间。单位：GB。 说明
按量付费（PostPaid）实例会忽略此参数。
| 500 |
| gatewayCount | long | 否 | 网关数量，取值[2, 50]。 说明
只有 Warehouse 类型需要指定该参数。
| 4 |
| chargeType | string | 是 | 付费类型。取值：
说明
Shared 实例类型会忽略该参数。Shared 是一种固定规格类型，收费类型默认为 PostPaid。
| PostPaid |
| autoPay | boolean | 否 | 是否自动支付，默认为 true。取值：
说明
默认值为 true。如果您的支付方式余额不足，可以将参数 AutoPay 设置为 false，此时会生成未支付订单，您可以登录费用与成本自行支付。
| true |
| pricingCycle | string | 否 | 计费周期。取值：
说明
| Month |
| duration | long | 否 | 购买周期。比如购买 2 个月。 说明
若付费类型为 PostPaid，则无需指定。
| 2 |
| autoRenew | boolean | 否 | 是否开启按月自动续费，默认值为 false。取值：
| false |
| leaderInstanceId | string | 否 | 主实例 Id，Follower 类型必填。 说明
主从实例必须满足以下条件：
| hgpostcn-cn-lbj3aworq112 |
| initialDatabases | string | 否 | 初始数据库。 | chatbot |
| enableServerlessComputing | boolean | 否 | 是否开启 ServerlessComputing 枚举值：
| true |
返回参数
说明
参数校验错误，仍然会返回正常的 Data，Success 为 false，并包含 Code 和 Message。除非抛出异常，否则成功与否由 Data.Success 来判断。
使用新版 SDK 包调用本接口时，由于 SDK 内部的客户端默认超时时间和服务端的不一致，因此可能返回请求超时的错误，但实际上接口已调用成功。如需避免这个问题，您可以在调用前设置 ReadTimeout 参数为 20000。
示例
正常返回示例
JSON格式
{
"RequestId": "9CC37B9F-F4B4-5FF1-939B-AEE78DC70130",
"Data": {
"InstanceId": "hgpostcn-cn-xxxxxx",
"OrderId": "217523224780172",
"Code": "InvalidVpcOrVSwitch.NotAvailable",
"Message": "专有网络或交换机不可用",
"Success": "true"
},
"HttpStatusCode": "200",
"ErrorMessage": "null",
"ErrorCode": "null"
}错误码
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 |
|---|---|---|
| 2024-04-10 | API 内部配置变更，不影响调用 | 查看变更详情 |
| 2023-10-18 | API 内部配置变更，不影响调用 | 查看变更详情 |
| 2023-07-19 | API 内部配置变更，不影响调用 | 查看变更详情 |