Tenant Cloud Compute Cloud Virtual Machine Instance APIs ModifyInstancesAttribute

ModifyInstancesAttribute

Last Updated At: 2026-08-02 00:05:21

1. Interface Description

Interface request domain name: cvm.api3.convergecloud.com.

This API is used to modify the attributes of instances. Currently, only the instance name can be modified.

  • The instance name is used only for management by users. The cloud platform does not use this name for submitting tickets or performing instance management operations.

  • Batch operations are supported. Each request can involve up to 100 instances.

Default interface request rate limit: 10 times per second.

Interface update time: 2020-05-19 04:12:48.

The interface only verifies the signature but does not authenticate.

2. Input Parameters

The following list of request parameters only lists interface request parameters and some public parameters, For a complete list of public parameters see public request parameters.

Parameter name Required Allow NULL Type Description
Action Yes No String Public parameter, The value of this interface: ModifyInstancesAttribute
Version Yes No String Public parameter, The value of this interface: 2017-03-12
Region No No String Public parameter,Regional information A list of supported geographies is available through the DescribeRegions interface
InstanceIds Yes No Array of String One or more instance IDs to be operated. You can obtain the instance ID through the InstanceId in the returned value from the API DescribeInstances. A maximum of 100 batch instances per request are allowed.
Example: ["ins-rf6ogz49"]
InstanceName No No String Instance display name. It can be named as required, but should not exceed 60 characters.
Example: MyInsName
UserData No No String Internal parameters, user data.
Example: TXlVc2VyRGF0YQo
SecurityGroups No No Array of String Internal parameters, list of security group IDs.
Example: ["sg-rf6ogz49"]
ResetNewCreationIdentify No No Bool Internal parameters, unknown.
Example: false
DisableApiTermination No No Bool Instance destruction protection flag, indicating whether deletion through APIs is allowed. Valid values:
  •  TRUE: instance protection is enabled and deletion through APIs is not allowed
  •  FALSE: instance protection is disabled and deletion through APIs is allowed
     Default value: FALSE.
    Example: false
    		•

    3. Output Parameters

    Parameter name Type Description
    RequestId String Unique request id, Each request will return. The RequestId of the request needs to be provided when locating the problem.

    4. Error Code

    The following lists only the error codes related to the interface business logic, For other error codes, see public ErrorCode.

    Error Code Description
    InvalidParameterValue.LimitExceeded The parameter value is out of range
    InternalServerError Internal operation error.
    InvalidInstanceName.TooLong The string length of the specified InstanceName exceeds the limit. It should be less than or equal to 60 bytes.
    InvalidInstance.NotSupported Unsupported instance.
    InvalidInstanceId.NotFound No corresponding instance was found.
    MissingParameter Parameters are missing. The request did not include mandatory parameters.
    InvalidInstanceId.Malformed Invalid Instance ID. The format of the specified instance ID is incorrect, for example, an instance ID length error ins-1122.
    InvalidParameterValue Invalid parameter value. The format of the parameter value is incorrect or not supported, etc.