cvm · 2017-03-12

TerminateInstances

POST

Return 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/TerminateInstances 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: TerminateInstances' \
  -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	One or more instance IDs to be operated. You can obtain the instance ID through the `InstanceId` in the return value from the API DescribeInstances. The maximum number of instances per request is 100.
ReleaseAddress	boolean	No	Release an Elastic IP. Under EIP 2.0, only the first EIP on the primary network interface can be released, and currently supported release types are limited to HighQualityEIP, AntiDDoSEIP, EIPv6, and HighQualityEIPv6.
ReleasePrepaidDataDisks	boolean	No	Whether to release a monthly subscription data disk mounted on an instance. true: Release the data disk along with termination of the instance. false: Only terminate the 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
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 · TerminateInstances

{
  "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": "935bd5d6-2088-7f33-1263-fdf1c2dbbca2"
  }
}

What failure looks like

Example error responses for this action. Match on Code.

Recorded error 1

{
  "Response": {
    "Error": {
      "Code": "InvalidInstanceId.NotFound",
      "Message": "The specified instance ID `['ins-00000000']` is not found."
    },
    "RequestId": "9f03054d-3430-7088-0d60-1698faae9216"
  }
}

Recorded error 2

{
  "Response": {
    "Error": {
      "Code": "UnsupportedOperation.InstanceStateRebooting",
      "Message": "The request does not support the instance `ins-6l9ee4b2` which is in the state of `REBOOTING`."
    },
    "RequestId": "d47b3760-6deb-b5d2-6162-1a01d7018a3f"
  }
}

Behaviour

Returns only a RequestId. The instance disappears from DescribeInstances within a few seconds; there is no TERMINATED state to observe. The system disk is deleted with the instance. Rejected with UnsupportedOperation.InstanceStateRebooting while the instance is rebooting.