cvm · 2017-03-12

DescribeInstancesOperationLimit

POST

Query limitations on operations on an instance.

Wire call

Converge Cloud is RPC over HTTP. There is one path — / — and the action travels in the X-TC-Action header. The /cvm/DescribeInstancesOperationLimit 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: DescribeInstancesOperationLimit' \
  -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	Query by instance ID(s). You can obtain the instance IDs from the value of `InstanceId` returned by the DescribeInstances API. For example, instance ID: ins-xxxxxxxx. (For the specific format, refer to section `ids.N` of the API Introduction.) You can query up to 100 instances in each request.
Operation	string	Yes	Operation on the instance(s).

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
InstanceOperationLimitSet	OperationCountLimit[]	The maximum number of times you can modify the instance configurations (degrading the configurations)
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": {
    "InstanceOperationLimitSet": …,
    "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 · DescribeInstancesOperationLimit

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

Read-only. Creates nothing.

Recorded example response — captured 2026-09-16

{
  "Response": {
    "InstanceOperationLimitSet": [
      {
        "Operation": "INSTANCE_DEGRADE",
        "InstanceId": "ins-6l9ee4b2",
        "CurrentCount": -1,
        "LimitCount": -1
      }
    ],
    "RequestId": "f6725837-3317-7575-a819-51842b1f0ba8"
  }
}