Instance pricing model .
PREPAID :subscription
POSTPAID :pay-as-you-go
Only PREPAID is supported currently.If you need POSTPAID ,contact us.
| | instanceTypeId | Yes | String |Instance model ID.
To view specific values,you can call DescribeInstanceTypes .
| | internetChargeType | Yes | [InternetChargeType](/api-reference/compute/bmc/datastructure.md#internetchargetype) | Network pricing model. | | instanceChargePrepaid | No | [ChargePrepaid](/api-reference/compute/bmc/datastructure.md#chargeprepaid) | Details of the monthly subscription,including the purchase period,auto-renewal.It is required if the instanceChargeType is PREPAID . | | imageId | No | String |Valid image ID.
To obtain valid image ID,you can call DescribeImages ,pass in instanceTypeId to retrieve the list of images supported by the current model,and then find the imageId in the response.
You can also not specify an image and install it later through IPMI.
When using iPXE to install OS,pass the value of ipxeUrl ,and leave imageId empty.
| | resourceGroupId | No | String | Resource group ID where the instances reside | | instanceName | No | String |Instance name to be displayed.
Default value:instance.
This parameter can contain up to 64 characters.Only letters,numbers,-and periods(.)are supported.
If you purchase multiple instances at the same time,you can specify a pattern string \[begin\_number,bits] .
begin\_number :the starting value of an ordered number,value range:\[0,99999],default value:0.
bits :the number of digits occupied by an ordered value,value range:\[1,6],default value:6.
For example,if you purchase 1 instance and the instance name body is server\_\[3,3] ,the instance name will be server003 ;if you purchase 2 instances,the instance names will be server003 , server004 .
Note:
Spaces are not supported in the pattern string. Multiple pattern strings are supported,such as server\_\[3,3]\_\[1,1] .
| | hostname | No | String |Instance hostname.
Default value:hostname.
This parameter can contain up to 64 . characters.Only letters,numbers,-and periods(.)are supported.
If you purchase multiple instances at the same time,you can specify a pattern string \[begin\_number,bits] .
begin\_number :the starting value of an ordered number,value range:\[0,99999],default value:0.
bits :the number of digits occupied by an ordered value,value range:\[1,6],default value:6.
For example,if you purchase 1 instance and the instance name body is server\_\[3,3] ,the instance name will be server003 ;if you purchase 2 instances,the instance names will be server003 , server004 .
Note:
Spaces are not supported in the pattern string. Multiple pattern strings are supported,such as server\_\[3,3]\_\[1,1] .
| | amount | No | Integer |The number of instances to be purchased.
Value range:\[1,100].Default value:1.
Value range: \[1, 100]
Default value: 1
| | password | No | String |Instance password.
The parameter must be 8-16 characters,including uppercase letters,lowercase letters,numbers and special characters like 1\~!@$^\*-\_=+ .This password is also used as the password for IPMI login.Please keep it safe.
You must and can only pass the value of either password or keyId .
| | keyId | No | String |SSH key pair ID.
Your SSH key pair contains several public keys that can be placed on your server.You can access your instance with the private key.Call DescribeKeyPairs to obtain key pair information.
SSH key pairs and passwords cannot to set at the same time.SSH key pairs are not supported for Windows operating system.
For example: key-YWD2QFOl
You must and can only pass the value of either password or keyId .
| | internetMaxBandwidthOut | No | Integer |Public network bandwidth cap(Mbps).
Default value:1 Mbps.
The parameter value differs with different instance models.
Value range: \[1, +)
Default value: 1
| | trafficPackageSize | No | Float |Traffic package size(TB).
The parameter is valid only when internetChargeType is ByTrafficPackage .
If not passed in,the default value will be the size of the free traffic package.
Value range: \[0.0, +)
| | subnetId | No | String |Subnet ID.
Call DescribeVpcSubnets to check information on subnets created.
| | raidConfig | No | [RaidConfig](/api-reference/compute/bmc/datastructure.md#raidconfig) | Disk array configuration. | | partitions | No | Array of [Partition](/api-reference/compute/bmc/datastructure.md#partition) |Disk partition configuration.
If the operating system is not installed,the partition cannot be set.
| | nic | No | [Nic](/api-reference/compute/bmc/datastructure.md#nic) | NIC configuration. | | ipxeUrl | No | String |iPXE URL.
Pass in the value and install your OS via IPMI.
You can choose to install OS using Netboot.See Deploy a Custom Image Using iPXE for more details.
| | userData | No | String |User Data.
You can specify user data during instance installation. When the instance is launched for the first time, the user data is passed to the server as text and executed. The maximum supported data size is 32 KB.
| | enablePrimaryIPv6 | No | Boolean |Enable primary IPv6 or not.
If the value is false ,the primary IPv6 is not enabled and the elastic IPv6 cannot be configured.
The default value is true .
Default value: true
| | clusterId | No | String | Bandwidth cluster ID. | | marketingOptions | No | [MarketingInfo](/api-reference/compute/bmc/datastructure.md#marketinginfo) | Information on marketing campaigns. | | tags | No | [TagAssociation](/api-reference/compute/bmc/datastructure.md#tagassociation) |Bound tags when creating resources.
Tag keys must be unique.
| | enableGatewayMode | No | Boolean |Whether to enable Gateway Mode.
Enables the host-bound IPs to act as a gateway for downstream traffic. Only elastic IPs are supported. Additional configuration on the host is required; when disabled, standard routing mode applies.
Note: Gateway mode is not supported by default. Please contact Console Support if you need to enable this feature.
| ## 3. Output Parameters | Parameter Name | Type | Description | | -------------- | --------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | requestId | String |The unique request ID, which is returned for each request.
RequestId is required for locating a problem.
| | instanceIdSet | Array of String |List of instance IDs.
The returned instance ID list does not mean the creation has been completed. The status of the instance will be PENDING or CREATING during the creation.uery the status of the instance according to dataSet . If the status changes from PENDING or Creating to Running , it means that the instance has been created successfully; CREATE\_FAILED means the instance has been created failed.
| | orderNumber | String | Number of order. | ## 4. Code Example {% tabs %} {% tab title="Example" %} **Create a pay-as-you -go instance with the simplest parameters**\ Assuming to create a pay-as-you-go instance in Seoul A with the model of M6C, 1 Mbps flat rate bandwidth billing method, random system-generated password, and no images installed.POST /api/v2/bmc HTTP/1.1
Host: console.zenlayer.com
Content-Type: application/json
X-ZC-Action: CreateInstances
Request:
{
"instanceChargeType": "POSTPAID",
"instanceTypeId": "M6C",
"internetChargeType": "ByBandwidth",
"zoneId": "SEL-A"
}
Response:
{
"requestId": "T05992D0C-7E8B-4047-B0C0-780F2CD549D3",
"response": {
"requestId": "T05992D0C-7E8B-4047-B0C0-780F2CD549D3",
"instanceIdSet": ["instanceId1"],
"orderNumber" : "orderNumber1"
}
}