Elastic Compute Service:ModifyInstanceAttribute

Usage notes

If the response contains {"OperationLocks": {"LockReason" : "security"}} when you query the information of an instance, the instance is locked for security reasons. No operations are allowed on the instance.

Take note of the following items:

• Modify the hostname (HostName): After you modify the hostname, restart the instance in the ECS console or by calling the RebootInstance operation for the new hostname to take effect. For information about how to restart an instance in the ECS console, see Restart instances. The new hostname does not take effect if you restart the instance from within the operating system.
• Reset the password (Password):
  • The instance cannot be in the Starting (Starting) state.
  • After you reset the password, restart the instance in the ECS console or by calling the RebootInstance operation for the new password to take effect. For information about how to restart an instance in the ECS console, see Restart instances. The new password does not take effect if you restart the instance from within the operating system.
• Modify user data (UserData):
  • The instance must be in the Stopped (Stopped) state.
  • The instance must meet the limits for user data. For more information, see Prepare user data.

    Note After you restart the instance, the new user data is displayed but not run as scripts.
• Change the security groups (SecurityGroupIds.N):

  • You can move an instance to a security group of a different type.

    If you want to move an instance to a security group of a different type, you must familiarize yourself with the differences between the rule configurations of the two security group types to prevent impacts on the instance network.

  • Security groups of instances in the classic network cannot be changed.

    For more information, see the description of SecurityGroupIds.N.

• Modify the number of queues supported by the primary elastic network interface (ENI) (NetworkInterfaceQueueNumber):
  • The instance must be in the Stopped (Stopped) state.
  • The value of this parameter cannot exceed the maximum number of queues allowed per ENI. The maximum number of queues varies based on the instance type.
  • The total number of queues for all ENIs on the instance cannot exceed the queue quota for the instance type. To obtain the maximum number of queues per ENI and the queue quota for an instance type, you can call the DescribeInstanceTypes operation to query the MaximumQueueNumberPerEni and TotalEniQueueQuantity values.
  • If you set this parameter to -1, the value is reset to the default value for the instance type. To obtain the default number of queues supported by the primary ENI for an instance type, you can call the DescribeInstanceTypes operation to query the PrimaryEniQueueNumber value.
• Enable or disable the Jumbo Frame feature (EnableJumboFrame):
  • The instance must be in the Running (Running) or Stopped (Stopped) state.
  • The instance must reside in a virtual private cloud (VPC).
  • After the Jumbo Frame feature is enabled, the MTU value of the instance is set to 8500. After the Jumbo Frame feature is disabled, the MTU value of the instance is set to 1500.

Request parameters

()`~!@#$%^&*-_+=|{}[]:;'<>,.?/
                                

Response parameters

Examples

Sample requests

https://ecs.aliyuncs.com/?Action=ModifyInstanceAttribute
&InstanceId=i-bp67acfmxazb4ph****
&Action=ModifyInstanceAttribute
&CreditSpecification=Standard
&DeletionProtection=false
&Description=testInstanceDescription
&HostName=testHostName
&InstanceName=testInstanceName
&Password=Test123456
&SecurityGroupIds.1=sg-bp15ed6xe1yxeycg7o****
&SecurityGroupIds.2=sg-bp15ed6xe1yxeycg7p****
&SecurityGroupIds.3=sg-bp15ed6xe1yxeycg7q****
&<Common request parameters>

Sample success responses

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

<ModifyInstanceAttributeResponse>
    <RequestId>473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E</RequestId>
</ModifyInstanceAttributeResponse>

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E"
}

Error codes

For a list of error codes, see Service error codes.