cvm — Cloud Virtual Machine
cvm · 2017-03-12
AllocateHosts
POST
Create CDH instances with specified configuration.
Wire call
Converge Cloud is RPC over HTTP. There is one path — / — and the action travels in the X-TC-Action header. The /cvm/AllocateHosts path used in the OpenAPI document is a documentation convenience so each action is addressable; it is not a route on the server.
curl
curl -sS https://cvm.api3.convergecloud.com/ \
-H 'Authorization: TC3-HMAC-SHA256 Credential=<SecretId>/<YYYY-MM-DD>/cvm/tc3_request, SignedHeaders=content-type;host;x-tc-action, Signature=<sig>' \
-H 'Content-Type: application/json; charset=utf-8' \
-H 'Host: cvm.api3.convergecloud.com' \
-H 'X-TC-Action: AllocateHosts' \
-H 'X-TC-Version: 2017-03-12' \
-H 'X-TC-Timestamp: <unix-seconds>' \
-H 'X-TC-Region: luzon' \
-d '{"Placement":"<Placement>","HostType":"<HostType>","HostChargePrepaid":"<HostChargePrepaid>"}'Request parameters
| Field | Type | Required | Description |
|---|---|---|---|
| Placement | Placement | Yes | Instance location. This parameter is used to specify the attributes of an instance, such as its availability zone and project. |
| ClientToken | string | No | A string used to ensure the idempotency of the request. |
| HostChargePrepaid | ChargePrepaid | Yes | Not supported. Configuration of prepaid instances. You can use the parameter to specify the attributes of prepaid instances, such as the subscription period and the auto-renewal plan. This parameter is required for prepaid instances. |
| HostChargeType | string | No | Instance billing type. `POSTPAID_BY_HOUR`: Hourly-based pay-as-you-go |
| HostType | string | Yes | CDH instance model. Default value: `HS1`. |
| HostCount | integer | No | Quantity of CDH instances purchased. Default value: 1. |
| TagSpecification | TagSpecification[] | No | Tag description. You can specify the parameter to associate a tag with an instance. |
Response
Fields are returned inside the Response envelope. Converge Cloud answers HTTP 200 for errors as well as successes, so read Response.Error rather than the status code — and test for the presence of that object, because Code is occasionally the empty string.
| Field | Type | Description |
|---|---|---|
| HostIdSet | string[] | IDs of created instances |
| RequestId | string | The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem. |
Success
{
"Response": {
"HostIdSet": …,
"RequestId": "…"
}
}Error
{
"Response": {
"Error": { "Code": "…", "Message": "…" },
"RequestId": "…"
}
}Try it
CredentialThe key never leaves this tab — it signs the request here. The signed request goes to /api-relay/cvm.
Request bodyvalid JSONPOST cvm.api3.convergecloud.com · AllocateHosts