Converge Studios
cvm — Cloud Virtual Machine
cvm · 2017-03-12

ModifyInstancesAttribute

POST

Modify instance attributes.

Wire call

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

Request parameters

FieldTypeRequiredDescription
InstanceIdsstring[]YesInstance 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.
InstanceNamestringNoModified instance name. can be named as required but should not exceed 128 characters.
UserDatastringNoUser data provided to an instance, which needs to be encoded in Base64 format with a maximum size of 16 KB. For details on obtaining this parameter, refer to the startup commands for Windows and Linux.
SecurityGroupsstring[]NoSpecifies the security group Id list of the specified instance after modification. the instance will reassociate with the security groups in the specified list, and the associated security group will be unbound.
CamRoleNamestringNoThe role bound with the instance. If it is not specified, it indicates to unbind the current role of the CVM.
HostNamestringNoModified hostname of an instance. Period (.) and hyphen (-) should not be used as the first or last character of the hostname, and should not be used consecutively. Windows instances: The hostname should contain 2 to 15 characters, including letters (case insensitive), digits, and hyphens (-), does not support periods (.), and should not be all digits. Instances of other types (such as Linux in…
DisableApiTerminationbooleanNoInstance termination protection flag, indicating whether an instance is allowed to be deleted through an API. Valid values: true: Instance protection is enabled, and the instance is not allowed to be deleted through the API. false: Instance protection is disabled, and the instance is allowed to be deleted through the API. Default value: false.
CamRoleTypestringNoRole type, used in conjunction with CamRoleName. this value can be obtained from the RoleType field in the API response of CAM DescribeRoleList or GetRole. currently, only user, system, and service_linked types are accepted.
AutoRebootbooleanNoWhether to automatically restart an instance when modifying a hostname. If not specified, the instance will automatically restart by default.

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.

FieldTypeDescription
RequestIdstringThe 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.
Request bodyvalid JSONPOST cvm.api3.convergecloud.com · ModifyInstancesAttribute
Recorded example response — captured 2026-09-16
{
  "Response": {
    "RequestId": "5ea47dd2-caa3-260f-25ed-d506554a288c"
  }
}