All Products
Search
Document Center

Elastic Compute Service:ModifyInstanceAttribute

Last Updated:Mar 26, 2024

Modifies attributes of an Elastic Compute Service (ECS) instance, such as the password, name, description, hostname, security groups, and user data. If the instance is a burstable instance, you can also change its performance mode.

Operation description

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.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
InstanceIdstringYes

The instance ID.

i-bp67acfmxazb4ph****
PasswordstringNo

The password of the instance. The password must be 8 to 30 characters in length and contain at least three of the following character types: uppercase letters, lowercase letters, digits, and special characters. Special characters include:


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

For Windows instances, passwords cannot start with a forward slash (/).

Note For security reasons, we recommend that you use HTTPS to send requests if Password is specified.
Test123456
HostNamestringNo

The hostname of the instance. Take note of the following items:

  • When you modify the hostname of an instance, the instance must not be in the Creating (Pending) or Starting (Starting) state. Otherwise, the new hostname and the configurations in /etc/hosts cannot take effect. You can call the DescribeInstances operation to query the state of the instance.
  • After you modify the hostname, you must call the RebootInstance operation for the new hostname to take effect.

The following limits apply to the hostnames of instances that run different operating systems:

  • For Windows Server, the hostname must be 2 to 15 characters in length and can contain letters, digits, and hyphens (-). It cannot start or end with a hyphen (-), contain consecutive hyphens (-), or contain only digits.
  • For other operating systems such as Linux, the hostname must be 2 to 64 characters in length. You can use periods (.) to separate a hostname into multiple segments. Each segment can contain letters, digits, and hyphens (-). The hostname cannot contain consecutive periods (.) or hyphens (-). It cannot start or end with a period (.) or a hyphen (-).
testHostName
InstanceNamestringNo

The name of the instance. The name must be 2 to 128 characters in length. It must start with a letter but cannot start with http:// or https://. It can contain letters, digits, colons (:), underscores (_), and hyphens (-).

testInstanceName
DescriptionstringNo

The instance description. The description must be 2 to 256 characters in length, and cannot start with http:// or https://.

This parameter is empty by default.

testInstanceDescription
UserDatastringNo

The user data of the instance. User data must be encoded in Base64.

The size of the user data cannot exceed 16 KB before it is encoded in Base64. We recommend that you do not pass in confidential information such as passwords and private keys in plaintext. If you must pass in confidential information, we recommend that you encrypt and Base64-encode the information before you pass it in. Then, you can decode and decrypt the information in the same way within the instance.

ZWNobyBoZWxsbyBlY3Mh
RecyclablebooleanNo
Note This parameter is in invitational preview and is not publicly available.
hide
CreditSpecificationstringNo

The performance mode of the burstable instance. Valid values:

  • Standard
  • Unlimited

For more information about the performance modes of burstable instances, see Overview .

Standard
DeletionProtectionbooleanNo

The release protection attribute of the instance. This parameter specifies whether you can use the ECS console or call the DeleteInstance operation to release the instance.

Note This parameter is applicable only to pay-as-you-go instances. The release protection attribute can protect instances against manual releases, but not against automatic releases.
false
NetworkInterfaceQueueNumberintegerNo

The number of queues supported by the primary ENI.

8
SecurityGroupIdsarrayNo

The IDs of replacement security groups.

  • All security group IDs must be unique.
  • The instance is moved from the current security groups to the replacement security groups. If you want the instance to remain in the current security groups, you must add the IDs of the current security groups to the list.
  • You can move the instance to security groups of a different type. However, the list cannot contain the IDs of both basic and advanced security groups.
  • The specified security groups and instance must belong to the same virtual private cloud (VPC).
  • The valid values of N are based on the maximum number of security groups to which the instance can belong. For more information, see Limits .
  • New security groups become valid for the instance after a short latency.
stringNo

The IDs of replacement security groups.

  • The security group ID must be unique.
  • The instance is moved from the current security groups to the replacement security groups. If you want the instance to remain in the current security groups, you must add the IDs of the current security groups to the list.
  • You can move the instance to security groups of a different type. However, the list cannot contain the IDs of both basic and advanced security groups.
  • The specified security group and instance must belong to the same VPC.
  • The valid values of N are based on the maximum number of security groups to which the instance can belong. For more information, see the "Security group limits" section in Limits .
  • New security groups become valid for the instance after a short latency.
sg-bp15ed6xe1yxeycg7o****
RemoteConnectionOptionsobjectNo
Note This parameter is in invitational preview and is not publicly available.
PasswordstringNo
Note This parameter is in invitational preview and is not publicly available.
hide
TypestringNo
Note This parameter is in invitational preview and is not publicly available.
hide
EnableJumboFramebooleanNo

Specifies whether to enable the Jumbo Frame feature for the MTU of the instance.

  • true

  • false

You can enable the Jumbo Frame feature for only specific instance types. For more information, see MTUs .

false
CpuOptions.TopologyTypestringNo

The CPU topology type of the instance. Valid values:

  • ContinuousCoreToHTMapping: The Hyper-Threading (HT) technology allows continuous threads to run on the same core in the CPU topology of the instance.

  • DiscreteCoreToHTMapping: The HT technology allows discrete threads to run on the same core in the CPU topology of the instance.

This parameter is empty by default.

Note
  • This parameter is supported only by specific instance families. For more information about the supported instance families, see View and modify the CPU topology.
  • Before you specify this parameter, make sure that the instance is in the Stopped state.
  • DiscreteCoreToHTMapping

    Response parameters

    ParameterTypeDescriptionExample
    object
    RequestIdstring

    The request ID.

    473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E

    Examples

    Sample success responses

    JSONformat

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

    Error codes

    HTTP status codeError codeError messageDescription
    400InvalidInstanceName.MalformedThe specified parameter "InstanceName" is not valid.The specified InstanceName parameter is invalid.
    400InvalidDescription.MalformedThe specified parameter "Description" is not valid.The source description can be 2 to 256 characters in length. It cannot start with http:// and https://.
    400InvalidRemoteConnectionOptions.PasswordThe remote connection password is invalid.-
    400InvalidRemoteConnectionOptions.TypeThe remote connection type is invalid.-
    400InstanceType.ValueNotSupportedThe instance type not supported.-
    400OSType.ValueNotSupportedThe OS type is not supported.-
    400InvalidHostPassword.MalformedThe specified parameter "Password" is not valid.-
    400InvalidHostName.MalformedThe specified parameter "HostName" is not valid.-
    400InvalidPassword.MalformedThe specified parameter "Password" is not valid.-
    400InvalidUserData.SizeExceededThe specified parameter "UserData" exceeds the size.-
    400InvalidUserData.NotSupportedTThe specified parameter "UserData" only support the vpc and IoOptimized Instance.-
    400InvalidUserData.NotSupportedThe specified parameter "UserData" only support the vpc and IoOptimized Instance.-
    400ImageNotSupportCloudInitThe specified image does not support cloud-init.-
    400ChargeTypeViolationPay-As-You-Go instances do not support this operation.The operation is not supported by pay-as-you-go instances. Check the billing method of the instance.
    400InvalidParameter.RecycleBinYou do not have permission to set recyclable properties.You are not authorized to perform the operation.
    400InvalidParameter.CreditSpecificationThe specified CreditSpecification is not supported in this region.The specified credit specification is not supported in this region.
    400InvalidInstanceStatus.CreditSpecRestrictedThe current status of the resource does not support this operation.The resource is in a state that does not support the current operation.
    400InvalidInstanceStatus.NotRunningThe current status of the resource is invalid, you can only do this operation when instance is running.The resource is in a state that does not support the operation. Perform the operation when the instance is in the Running state.
    400InvalidNetworkType.NotSupportedThe classic networkType does not support to modify security group-
    400InvalidOperation.EniCountExceeded=The maximum number of eni in a enterprise security group is exceeded.-
    400JoinedGroupLimitExceed%sThe maximum number of security groups to which the specified resource can be added has been reached. For more information, see the return value of the %s placeholder in the error message.
    400InvalidParameterThe specified parameter is not valid.A specified parameter is invalid.
    400InvalidOperation.InvalidEcsState%s-
    400InvalidParam.NotSupportJumboFrameNot support jumbo frame.-
    400InvalidOperation.InstanceStatusNotSupportThe instance status is not support modify mtu config.-
    400InvalidOperation.InstanceStatusUnsupportedThe specified instance status does not support modification of cpu topology type.The specified instance status does not support modification of cpu topology type.
    400InvalidParameter.CpuOptionsTopologyTypeThe specified parameter CpuOptions.TopologyType: %s is not valid.Illegal enumeration value for current CPU topology type
    400InvalidInstanceType.NotSupportCpuOptionsTopologyTypeThe specified instance type does not support CpuOptions.TopologyType: %s.The current specification does not support the specified CPU topology type
    403IncorrectInstanceStatusThe current status of the resource does not support this operation.The resource is in a state that does not support the current operation.
    403InstanceLockedForSecurityThe specified operation is denied as your instance is locked for security reasons.-
    403OperationDeniedThe instance amount in the specified SecurityGroup reach its limit.The maximum number of instances in the specified security group has been reached.
    403OperationDeniedThe current status of the resource does not support this operation.The resource is in a state that does not support the current operation.
    403InvalidUserData.ForbiddenUser not authorized to input the parameter "UserData"please apply for permission "UserData"-
    403InvalidUserData.Base64FormatInvalidThe specified UserData is not validAn error occurred when the specified UserData parameter is encoded.
    403InvalidChargeType.ValueNotSupportedDeletion protection is only valid for postPaid instance, not for prePaid or spot instance.Release protection can be enabled only for pay-as-you-go instances.
    403InvalidUser.UnauthorizedThe user is not authorizedYou are not authorized to perform this operation.
    403EnterpriseGroupLimited.MutliGroupTypeThe specified instance can not join multi SecurityGroup types.The specified instance cannot belong to both a basic and an advanced security group. You can call the DescribeSecurityGroups operation to query the type of security groups.
    403SecurityGroupInstanceLimitExceed%s-
    403InstanceNotInSecurityGroupThe instance not in the group.The specified instance does not belong to the security group.
    403InvalidOperation.InvalidRegion%sThe specified RegionId parameter is invalid.
    403OperationDeniedThe specified Image is disabled or is deleted.The specified image is disabled or deleted.
    403InvalidOperation.ResourceManagedByCloudProduct%sYou cannot modify security groups managed by cloud services.
    403InvalidParameter.InvalidEniQueueNumber%s-
    403InvalidOperation.MaxEniQueueNumberExceeded%s-
    403InvalidOperation.ExceedInstanceTypeQueueNumber%sThe maximum number of queues for all ENIs on an instance has been exceeded. For more information, see the return value of the %s placeholder in the error message.
    403InvalidOperation.InstanceTypeNotSupportHighPerformanceTrafficMode%s-
    403InvalidParameter.InvalidQueuePairNumber%s-
    403InvalidOperation.MaxEniQueuePairNumberExceed%s-
    403InvalidOperation.EniQueuePairNumberOverflow%s-
    404InvalidInstanceId.NotFoundThe specified InstanceId does not exist.The specified instance does not exist.
    404InvalidSecurityGroupId.NotFoundThe specified SecurityGroupId does not exist.The specified security group does not exist in this account. Check whether the security group ID is correct.
    404Credit.NotFoundThe specified credit information does not exist.The specified credit information does not exist.
    404InvalidInstanceStatus.NeedRestartThe current status of the resource is invalid, you can only do this operation after instance is restarted.-
    404InvalidParameter.SecurityGroupIdRepeatedThe specified security group ids has repeated.Duplicate security group IDs are specified. Check whether the specified SecurityGroupIds.N parameter is valid.
    404InvalidSecurityGroupType.NotSupportClassicThe specified SecurityGroupIds have classic group type.The specified security group is in the classic network. Check whether the specified SecurityGroupIds.N parameter is valid.
    404InvalidSecurityGroupVpc.NotBelongToOneVpcThe specified SecurityGroupIds are belong to different vpc.The specified security groups belong to different VPCs. Check whether the specified SecurityGroupIds.N parameter is valid. You can call the DescribeSecurityGroups operation to query the VPCs to which the security groups belong.
    500InternalErrorThe request processing has failed due to some unknown error.An internal error has occurred. Try again later.
    500InternalErrorThe request processing has failed due to some unknown error, exception or failure.An internal error has occurred. Try again later.

    For a list of error codes, visit the Service error codes.

    Change history

    Change timeSummary of changesOperation
    2023-12-14The Error code has changed. The request parameters of the API has changedsee changesets
    Change itemChange content
    Error CodesThe Error code has changed.
      Error Codes 400 change
      delete Error Codes: 403
      delete Error Codes: 404
      delete Error Codes: 500
    Input ParametersThe request parameters of the API has changed.
      Added Input Parameters: CpuOptions.TopologyType
    2023-07-17The Error code has changedsee changesets
    Change itemChange content
    Error CodesThe Error code has changed.
      delete Error Codes: 400
      delete Error Codes: 403
      delete Error Codes: 404
      delete Error Codes: 500