修改一台实例的部分信息,包括实例密码、名称、描述、主机名和自定义数据等。

描述

调用该接口时,您需要注意:

  • 实例状态为启动中Starting)时,无法重置实例密码。
  • 安全控制 的ECS实例的OperationLocks不能标记为"LockReason" : "security"
  • 重置密码后,您需要在控制台重启实例或者调用RebootInstance使更改生效,在实例内部重启将不会生效。
  • 实例状态为已停止Stopped)且满足实例自定义数据使用限制时,支持修改自定义数据。

请求参数

名称 类型 是否必需 描述
Action String 系统规定参数。取值:ModifyInstanceAttribute
InstanceId String 实例ID。
InstanceName String 实例名称。长度为[2, 128]个英文或中文字符。必须以大小字母或中文开头,不能以http://和https://开头。可以包含数字、半角冒号(:)、下划线(_)或者连字符(-)。
Description String 实例描述。长度为[2, 256]个英文或中文字符,不能以http://和https://开头。

默认值:空。

Password String 实例密码。的密码。长度为8至30个字符,必须同时包含大小写英文字母、数字和特殊符号。特殊符号可以是()`~!@#$%^&*-+=|{}[]:;‘<>,.?/
说明

如果传入Password参数,您需要使用HTTPS调用方式,避免密码泄露。

HostName String 操作系统的计算机名。
  • 点号(.)和短横线(-)不能作为首尾字符,更不能连续使用。
  • Windows实例:字符长度为[2, 15],不支持点号(.),不能全是数字。允许大小写英文字母、数字和短横线(-)。
  • 其他类型实例(Linux等):字符长度为[2, 64],支持多个点号(.),点之间为一段,每段允许大小写英文字母、数字和短横线(-)。
UserData String 实例自定义数据,需要以Base64编码。编码前,原始数据不能超过16 KB。建议不要明文传入敏感信息,例如密码和私钥等。如果必须传入敏感信息,建议您加密后再以Base64编码传入,在实例内部以同样的方式反解密。

返回参数

全是公共返回参数。参阅 公共返回参数

示例

请求示例
https://ecs.aliyuncs.com/?Action=ModifyInstanceAttribute
&InstanceId=i-instance1
&Password=pwd
&<公共请求参数>
返回示例

XML格式

<ModifyInstanceAttributeResponse>
    <RequestId>473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E</RequestId>
</ModifyInstanceAttributeResponse>
JSON格式
{
    "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E"
}

错误码

以下为本接口特有的错误码。更多错误码,请访问 API错误中心

错误代码 错误信息 HTTP状态码 说明
InvalidDescription.Malformed The specified parameter “Description” is not valid. 400 指定的Description格式不正确。
InvalidDescription.Malformed The specified destination image description is wrongly formed. 400 指定的Description不合法。
InvalidHostPassword.Malformed The specified parameter “Password” is not valid. 400 指定的Password不合法。
InvalidInstanceName.Malformed The specified parameter “InstanceName” is not valid. 400 指定的InstanceName不合法。
InvalidHostName.Malformed The specified parameter “HostName” is not valid. 400 指定的HostName不合法。
InvalidPassword.Malformed The specified parameter “Password” is not valid. 400 指定的Password不合法。
InvalidUserData.SizeExceeded The specified parameter “UserData” exceeds the size. 400 Base64编码UserData前,原始数据不能超过16 KB。
InvalidUserData.NotSupported The specified parameter “UserData” only support the vpc and IoOptimized Instance. 400 UserData只适用于VPC类型实例和I/O优化实例。
IncorrectInstanceStatus The current status of the resource does not support this operation. 403 该资源目前的状态不支持此操作。
InstanceLockedForSecurity The specified operation is denied as your instance is locked for security reasons. 403 实例目前被安全锁定,拒绝操作。
OperationDenied The Specified operation is denied as your instance is locked for security reasons. 403 实例已经被锁定。
OperationDenied The current status of the resource does not support this operation. 403 实例状态不支持该操作。
HOSTNAME_ILLEGAL hostname is not valid. 404 指定的HostName不合法。
InvalidInstanceId.NotFound The specified InstanceId does not exist. 404 指定的InstanceId不存在。
InvalidSecurityGroupId.NotFound The specified SecurityGroupId does not exist. 404 指定的SecurityGroupId不存在。