tencent cloud

Feedback

ModifyInstancesAttribute

Last updated: 2022-06-01 18:41:34

1. API Description

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

This API is used to modify the attributes of an instance.

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

We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

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 Params. The value used for this API: ModifyInstancesAttribute.
Version Yes String Common Params. The value used for this API: 2019-07-19.
Region No String Common Params. This parameter is not required for this API.
InstanceIdSet.N Yes Array of String List of IDs of the instances to be modified. You can request up to 100 instances at a time.
InstanceName No String Instance name displayed after successful modification, which can contain up to 60 characters. If this parameter is not specified, an empty value will be displayed.
SecurityGroups.N No Array of String List of IDs of the security groups of the instance. The instance will be associated with the specified security groups and will be disassociated from the original security groups. The maximum quantity is 5.

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 attributes

This example shows you how to modify the attributes of an instance.

Input Example

https://ecm.tencentcloudapi.com/?Action=ModifyInstancesAttribute
&InstanceIdSet.0=ein-353568gt
&InstanceName=zhibodanmu
&<Common request parameters>

Output Example

{
  "Response": {
    "RequestId": "0f092f2e-0ea2-4c20-9f22-ef4b629c99fa"
  }
}

5. Developer Resources

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
FailedOperation.InstanceOwnerCheckFailed The instance does not belong to the current module.
FailedOperation.InternalOperationFailure Internal error.
FailedOperation.OperationNotAllow The current operation is not allowed.
InvalidParameter.InvalidDataFormat The data format is incorrect.
InvalidParameterValue.InvalidInstanceID The instance ID is invalid.
InvalidParameterValue.LimitExceeded The parameter value exceeds the limit.
InvalidParameterValue.ParameterValueTooLarge The parameter value exceeds the limit.
LimitExceeded.SecurityGroupInstanceLimitExceeded The number of instances bound to the security group exceeds the limit.
UnauthorizedOperation.ForbiddenOperation You don't have the permission to perform this operation.
Contact Us

Contact our sales team or business advisors to help your business.

Technical Support

Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

7x24 Phone Support