All Products
Search
Document Center

:CreateInstance

Last Updated:Nov 18, 2024

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

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
hologram:CreateInstancecreate
*All Resources
*
    none
none

Request syntax

POST /api/v1/instances/create HTTP/1.1

Request parameters

ParameterTypeRequiredDescriptionExample
bodyobjectNo

The request body.

regionIdstringYes

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
zoneIdstringYes

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
vpcIdstringYes

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
vSwitchIdstringYes

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
resourceGroupIdstringNo

The resource group. If you do not specify this parameter, the default resource group of the account is used.

""
instanceNamestringYes

The name of the Hologres instance that you want to purchase. The name must be 2 to 64 characters in length.

my_holo
instanceTypestringYes

The type of the instance. Valid values:

  • Standard: general-purpose instance
  • Follower: read-only secondary instance
  • Warehouse: virtual warehouse instance
  • Shared: shared instance
Standard
cpulongNo

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
storageSizelongNo

The standard storage space of the instance. Unit: GB.

Note This parameter is invalid for pay-as-you-go instances.
500
coldStorageSizelongNo

The infrequent access (IA) storage space of the instance. Unit: GB.

Note This parameter is invalid for pay-as-you-go instances.
500
gatewayCountlongNo

The number of gateways. Valid values: 2 to 50.

Note This parameter is required only for virtual warehouse instances.
4
chargeTypestringYes

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
autoPaybooleanNo

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
pricingCyclestringNo

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
durationlongNo

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
autoRenewbooleanNo

Specifies whether to enable monthly auto-renewal. Default value: false. Valid values:

  • true
  • false
false
leaderInstanceIdstringNo

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

ParameterTypeDescriptionExample
object

The schema of the response.

RequestIdstring

The ID of the request.

9CC37B9F-F4B4-5FF1-939B-AEE78DC70130
Dataobject

The returned data.

InstanceIdstring

The instance ID.

hgpostcn-cn-xxxxxx
OrderIdstring

The order ID.

217523224780172
Codestring

The error code returned.

InvalidVpcOrVSwitch.NotAvailable
Messagestring

The error details.

Successstring

Indicates whether the instance was created.

  • true
  • false
true
HttpStatusCodestring

The HTTP status code.

200
ErrorMessagestring

The error message returned.

null
ErrorCodestring

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 timeSummary of changesOperation
2024-04-10The internal configuration of the API is changed, but the call is not affectedView Change Details
2023-10-18The internal configuration of the API is changed, but the call is not affectedView Change Details
2023-07-19The internal configuration of the API is changed, but the call is not affectedView Change Details