调用CreateInstance创建实例_实时数仓 Hologres(Hologres)-阿里云帮助中心

该接口用于创建Hologres实例。

接口说明

警告该 API 操作涉及费用，请确保在使用该接口前，已充分了解实时数仓 Hologres 的收费方式和价格。

Hologres 计费详情请参见计费概述。
创建 Hologres 实例时，您需要指定实例所在地域和可用区。一个地域可能对应多个可用区，具体如下：

   cn-hangzhou(杭州)：cn-hangzhou-h, cn-hangzhou-j, cn-hangzhou-k
   cn-shanghai(上海): cn-shanghai-e, cn-shanghai-f, cn-shanghai-l
   cn-beijing(北京): cn-beijing-i, cn-beijing-g, cn-beijing-l
   cn-zhangjiakou(张家口): cn-zhangjiakou-b
   cn-shenzhen(深圳): cn-shenzhen-d, cn-shenzhen-f, cn-shenzhen-e
   cn-wulanchabu(乌兰察布): cn-wulanchabu-a
   cn-hongkong(香港): cn-hongkong-b, cn-hongkong-d
   cn-shanghai-finance-1(上海金融云): cn-shanghai-finance-1z, cn-shanghai-finance-1f
   cn-hangzhou-finance(杭州金融云): cn-hangzhou-finance-k
   cn-shenzhen-finance-1(深圳金融云): cn-shenzhen-finance-1d
   ap-northeast-1(日本): ap-northeast-1a
   ap-southeast-1(新加坡): ap-southeast-1c, ap-southeast-1a
   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. 可前往服务接入点。	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：通用型。 Follower：只读从实例。 Warehouse：计算组型。 Shared：共享型。 Severless：Serverless 型枚举值： Warehouse : Warehouse Follower : Follower Standard : Standard Serverless : Serverless Shared : Shared	Standard
cpu	integer	否	实例规格。取值： 32 核 128 GB（计算节点数量：2） 64 核 256 GB（计算节点数量：4） 96 核 384 GB（计算节点数量：6） 128 核 512 GB（计算节点数量：8）等说明填写核数即可。购买 1024 以上规格实例请提交工单申请。 Shared 实例类型无需指定规格。	64
storageSize	integer	否	实例标准存储空间。单位：GB。说明按量付费实例（PostPaid）会忽略此参数。	500
coldStorageSize	integer	否	实例低频存储空间。单位：GB。说明按量付费（PostPaid）实例会忽略此参数。	500
gatewayCount	integer	否	网关数量，取值[2, 50]。说明只有 Warehouse 类型需要指定该参数。	4
chargeType	string	是	付费类型。取值： PrePaid：包年包月。 PostPaid: 按量付费。说明 Shared 实例类型会忽略该参数。Shared 是一种固定规格类型，收费类型默认为 PostPaid。枚举值： PostPaid : PostPaid PrePaid : PrePaid	PostPaid
autoPay	boolean	否	是否自动支付，默认为 true。取值： true：自动支付。 false：只生成订单，不支付。说明默认值为 true。如果您的支付方式余额不足，可以将参数 AutoPay 设置为 false，此时会生成未支付订单，您可以登录费用与成本自行支付。	true
pricingCycle	string	否	计费周期。取值： Month：按月计费。 Hour：按小时计费。说明 PrePaid 只支持 Month PostPaid 只支持 Hour Shared 类型自动设为 Hour，无需指定。枚举值： Month : Month Hour : Hour	Month
duration	integer	否	购买周期。比如购买 2 个月。说明若付费类型为 PostPaid，则无需指定。	2
autoRenew	boolean	否	是否开启按月自动续费，默认值为 false。取值： true：开启。 false：不开启。	false
leaderInstanceId	string	否	主实例 Id，Follower 类型必填。说明主从实例必须满足以下条件：主实例"运行正常"(Running)状态主从实例 regionId 一致主从实例 zoneId 一致主实例已绑定的从实例数少于 10 个主从实例属于同一个主账号	hgpostcn-cn-lbj3aworq112
initialDatabases	string	否	初始数据库。	chatbot
enableServerlessComputing	boolean	否	是否开启 ServerlessComputing 枚举值： true : 开启 false : 不开启	true
storageType	string	否	存储类型枚举值： local : 本地冗余类型 redundant : 同城冗余(多 AZ)	redundant

返回参数

名称	类型	描述	示例值
	object	返回参数详情。
RequestId	string	请求 ID。	9CC37B9F-F4B4-5FF1-939B-AEE78DC70130
Data	object	返回结果。
InstanceId	string	实例 ID。	hgpostcn-cn-xxxxxx
OrderId	string	订单 ID。	217523224780172
Code	string	错误码。	InvalidVpcOrVSwitch.NotAvailable
Message	string	错误详细信息。	InvalidVpcOrVSwitch.NotAvailable
Success	string	创建是否成功。 true：创建成功。 false：创建失败。	true
HttpStatusCode	string	http 状态码	200
ErrorMessage	string	错误信息。	null
ErrorCode	string	错误码。	null

说明

参数校验错误，仍然会返回正常的 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": "InvalidVpcOrVSwitch.NotAvailable\n",
    "Success": "true"
  },
  "HttpStatusCode": "200",
  "ErrorMessage": "null",
  "ErrorCode": "null"
}

错误码

访问错误中心查看更多错误码。

变更历史

更多信息，参考变更详情。