Creates a Hologres instance.
Operation description
- 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
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 Resourcesis 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.
| Operation | Access level | Resource type | Condition key | Associated operation |
|---|---|---|---|---|
| hologram:CreateInstance | create |
|
| none |
Request syntax
POST /api/v1/instances/create HTTP/1.1
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 |
| cpu | long | No | The instance specifications. Valid values:
Note
| 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:
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:
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:
Note
| 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:
| 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:
| hgpostcn-cn-lbj3aworq112 |
Response parameters
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 |
|---|---|---|
| 2024-04-10 | The internal configuration of the API is changed, but the call is not affected | View Change Details |
| 2023-10-18 | The internal configuration of the API is changed, but the call is not affected | View Change Details |
| 2023-07-19 | The internal configuration of the API is changed, but the call is not affected | View Change Details |