ModifyInstancesAttribute

Last updated: 2020-06-15 09:58:09

    1. API Description

    Domain name for API request: cvm.tencentcloudapi.com.

    This API is used to modify the attributes of an instance. Currently you can only use the API to modify the name and the associated security groups of the instance.

    • Instance names are used only for users’ convenience. Tencent Cloud does not use the name for ticket submission or instance management.
    • Batch operations are supported. The maximum number of instances in each request is 100.
    • When you change the security groups associated with an instance, the original security groups will be disassociated.

    A maximum of 10 requests can be initiated per second for this API.

    Note: This API supports Finance regions. If the common parameter Region is a Finance region, a domain name with the Finance region needs to be specified, for example: cvm.ap-shanghai-fsi.tencentcloudapi.com

    2. Input Parameters

    The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

    Parameter Name Required Type Description
    Action Yes String Common parameter. The value used for this API: ModifyInstancesAttribute.
    Version Yes String Common parameter. The value used for this API: 2017-03-12.
    Region Yes String Common parameter. For more information, please see the list of regions supported by the product.
    InstanceIds.N Yes Array of String 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.
    InstanceName No String Instance name. You can specify any name you like, but its length cannot exceed 60 characters.
    SecurityGroups.N No Array of String ID list of security groups of the instance. The instance will be associated with the specified security groups and will be disassociated from the original security groups.

    3. Output Parameters

    Parameter Name Type Description
    RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

    4. Example

    Example1 Modifying instance names

    This example shows you how to modify the names of two instances.

    Input Example

    GET https://cvm.tencentcloudapi.com/?Action=ModifyInstancesAttribute
    &InstanceIds.0=ins-r8hr2upy
    &InstanceIds.1=ins-5d8a23rs
    &InstanceName=Mysql_Server
    &<common request parameters>

    Output Example

    {
      "Response": {
        "RequestId": "6ef60bec-0242-43af-bb20-270359fb54a7"
      }
    }

    5. Developer Resources

    API Explorer

    This tool allows online call, signature authentication, SDK code generation and quick search of APIs to greatly improve the efficiency of using TencentCloud APIs.

    SDK

    TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

    Command Line Interface

    6. Error Code

    The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

    Error Code Description
    InternalServerError Internal error.
    InvalidInstance.NotSupported This instance is not supported.
    InvalidInstanceId.Malformed Invalid instance ID. The specified instance ID has an invalid format. For example, ins-1122 has an invalid ID length.
    InvalidInstanceId.NotFound No instance found.
    InvalidInstanceName.TooLong The specified InstanceName exceeds the maximum length of 60 bytes.
    InvalidParameterValue Invalid parameter value: parameter value is in the wrong format or is not supported.
    InvalidParameterValue.LimitExceeded The number of parameter values exceeds the limit.
    MissingParameter Missing parameter: a required parameter is missing.

    Was this page helpful?

    Was this page helpful?

    • Not at all
    • Not very helpful
    • Somewhat helpful
    • Very helpful
    • Extremely helpful
    Send Feedback
    Help