CreateInstance - Hologres - Alibaba Cloud Documentation Center

Creates a Hologres instance.

Operation description

Note Before you call this operation, make sure that you understand the billing method and pricing of Hologres because this operation is charged.

For more information about the billing details of Hologres, see Pricing .
When you purchase a Hologres instance, you must specify the region and zone in which the Hologres instance resides. A region may correspond to multiple zones. Example:

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-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
   ap-south-1: ap-south-1b
   eu-central-1: eu-central-1a
   us-east-1: us-east-1a
   us-west-1: us-west-1b

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

Request syntax

POST /api/v1/instances/create

Request parameters

Parameter	Type	Required	Description	Example
body	object	No	The request body.
regionId	string	Yes	The ID of the region. You can go to the OpenAPI Explorer or the Usage notes section to view the ID of the region.	cn-hangzhou
zoneId	string	Yes	The ID of the zone. For more information about how to obtain the ID of the zone, see the Usage notes section.	cn-hangzhou-h
vpcId	string	Yes	The ID of the virtual private cloud (VPC). The region in which the VPC resides must be the same as the region in which the Hologres instance resides.	vpc-t4netc3y5xxxx
vSwitchId	string	Yes	The ID of the vSwitch. The zone in which the vSwitch resides must be the same as the zone in which the instance resides.	vsw-2vccsiymtxxxxxx
resourceGroupId	string	No	The resource group. If you do not specify this parameter, the default resource group of the account is used.	""
instanceName	string	Yes	The name of the Hologres instance that you want to purchase. The name must be 2 to 64 characters in length.	my_holo
instanceType	string	Yes	The type of the instance. Valid values: Standard: general-purpose instance Follower: read-only secondary instance Warehouse: virtual warehouse instance Shared: shared instance	Standard
cpu	long	No	The instance specifications. Valid values: 8-core 32 GB (number of compute nodes: 1) 16-core 64 GB (number of compute nodes: 1) 32-core 128 GB (number of compute nodes: 2) 64-core 256 GB (number of compute nodes: 4) 96-core 384 GB (number of compute nodes: 6) 128-core 512 GB (number of compute nodes: 8) Others Note Set this parameter to the number of cores. If you want to set this parameter to specifications with more than 1,024 compute units (CUs), you must submit a ticket. If you want to purchase a shared instance, you do not need to configure this parameter. The specifications of 8-core 32 GB (number of compute nodes: 1) are for trial use only and cannot be used for production.	64
storageSize	long	No	The standard storage space of the instance. Unit: GB. Note This parameter is invalid for pay-as-you-go instances.	500
coldStorageSize	long	No	The infrequent access (IA) storage space of the instance. Unit: GB. Note This parameter is invalid for pay-as-you-go instances.	500
gatewayCount	long	No	The number of gateways. Valid values: 2 to 50. Note This parameter is required only for virtual warehouse instances.	4
chargeType	string	Yes	The billing method of the instance. Valid values: PrePaid: subscription PostPaid: pay-as-you-go Note This parameter is invalid for shared instances. Shared instances have fixed specifications and are pay-as-you-go instances.	PostPaid
autoPay	boolean	No	Specifies whether to enable auto-payment. Default value: true. Valid values: true false Note The default value is true. If the balance of your account is insufficient, you can set this parameter to false. In this case, an unpaid order is generated. You can log on to the User Center to pay for the order.	true
pricingCycle	string	No	The billing cycle. Valid values: Month Hour Note This parameter can only be set to Month for subscription instances. This parameter can only be set to Hour for pay-as-you-go instances. By default, this parameter is set to Hour for shared instances.	Month
duration	long	No	The validity period of the instance that you want to purchase. For example, you can specify a validity period of two months. Note You do not need to configure this parameter for pay-as-you-go instances.	2
autoRenew	boolean	No	Specifies whether to enable monthly auto-renewal. Default value: false. Valid values: true false	false
leaderInstanceId	string	No	The ID of the primary instance. This parameter is required for read-only secondary instances. Note The primary instance and secondary instances must meet the following requirements: The primary instance is in the Running state. The primary instance and secondary instances are deployed in the same region. The primary instance and secondary instances are deployed in the same zone. Less than 10 secondary instances are associated with the primary instance. The primary and secondary instances belong to the same Alibaba Cloud account.	hgpostcn-cn-lbj3aworq112

Response parameters

Parameter	Type	Description	Example
	object	The schema of the response.
RequestId	string	The ID of the request.	9CC37B9F-F4B4-5FF1-939B-AEE78DC70130
Data	object	The returned data.
InstanceId	string	The instance ID.	hgpostcn-cn-xxxxxx
OrderId	string	The order ID.	217523224780172
Code	string	The error code returned.	InvalidVpcOrVSwitch.NotAvailable
Message	string	The error details.
Success	string	Indicates whether the instance was created. true false	true
HttpStatusCode	string	The HTTP status code.	200
ErrorMessage	string	The error message returned.	null
ErrorCode	string	The error code returned.	null

If parameter verification fails, data is returned. In the returned data, Success is set to false, and the Code and Message parameters are included. The value of HttpStatusCode is 200.

Examples

Sample success responses

JSONformat

{
  "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"
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change time

Summary of changes

Operation

2023-10-18

The internal configuration of the API is changed, but the call is not affected

see changesets

Change item	Change content
	The internal configuration of the API is changed, but the call is not affected.

2023-07-19

The internal configuration of the API is changed, but the call is not affected

see changesets

Change item	Change content
	The internal configuration of the API is changed, but the call is not affected.