cvm · 2017-03-12

StartInstances

POST

Start instances.

Wire call

Converge Cloud is RPC over HTTP. There is one path — / — and the action travels in the X-TC-Action header. The /cvm/StartInstances 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: StartInstances' \
  -H 'X-TC-Version: 2017-03-12' \
  -H 'X-TC-Timestamp: <unix-seconds>' \
  -H 'X-TC-Region: luzon' \
  -d '{"InstanceIds":["<InstanceId>"]}'

Request parameters

Field	Type	Required	Description
InstanceIds	string[]	Yes	Instance ID(s). To obtain the instance IDs, you can call `DescribeInstances` and look for `InstanceId` in the response. The maximum number of instances in each request is 100.

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
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": {
    // action-specific fields,
    "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.

SecretIdSecretKey

Request bodyvalid JSONPOST cvm.api3.convergecloud.com · StartInstances

{
  "InstanceIds": [
    "<InstanceId>"
  ]
}

This action changes resources in my own account and may create a charge. I understand.

Recorded example response — captured 2026-09-16

{
  "Response": {
    "RequestId": "dfbcacd1-75af-ff2c-f435-37aeeabdaa1f"
  }
}

What failure looks like

Example error responses for this action. Match on Code.

Recorded error 1

{
  "Response": {
    "Error": {
      "Code": "UnsupportedOperation.InstanceStateRunning",
      "Message": "The request does not support the instance `ins-6l9ee4b2` which is in the state of `RUNNING`."
    },
    "RequestId": "e99255fa-689f-5faf-94c6-d6bd36e48c34"
  }
}

Behaviour

Rejected with UnsupportedOperation.InstanceStateRunning if the instance is already running.