修改实例属性
描述
修改实例密码、实例名称、安全组等属性信息。
此操作只修改参数中显式指定了的属性,没有指定的属性将不会发生改变。
重置实例的密码,状态为 Deleted 或 Starting 的实例不可以进行此操作。重置密码需要重启实例后才能生效。
被安全控制在实例的 OperationLocks 中标记了 "LockReason" : "security"的锁定状态时,不能修改密码。
请求参数
名称 |
类型 |
是否必须 |
描述 |
Action
String
是
系统规定参数,取值:ModifyInstanceAttribute
InstanceId
String
是
指定的实例 ID
InstanceName
String
否
实例的显示名称,[2, 128] 英文或中文字符,必须以大小字母或中文开头,可包含数字,".","_"或"-"。不能以 // 和 https:// 开头。
Description
String
否
实例的描述,[2, 256] 个字符。实例描述会显示在控制台。默认为空。不能以 // 和 https:// 开头。
Password
String
否
重置为用户指定的密。8-30个字符,必须同时包含三项(大、小写字母,数字和特殊符号)。支持以下特殊字符:( ) ` ~ ! @ # $ % ^ & * - + = | { } [ ] : ; " < > , . ? /
如果传入 Password 参数,请务必使用 HTTPS 协议调用 API 以避免可能发生的密码泄露。
HostName
String
否
表示操作系统内部的计算机名,最少 2 字符,"."和"-"是不能作为 hostname 的首尾字符,不能连续使用。
Windows 平台最长为 15 字符,允许字母(不限制大小写)、数字和"-"组成,不支持点号("."),不能全是数字。
其他(Linux 等)平台最长为 30 字符,允许支持多个点号,点之间为一段,每段允许字母(不限制大小写)、数字和"-"组成。
返回参数
全是公共返回参数,详见公共返回参数
错误码
错误代码 |
描述 |
Http 状态码 |
语义 |
InvalidInstanceId.NotFound
The InstanceId provided does not exist in our records.
404
指定的 InstanceId 不存在
MissingParameter
The input parameter "InstanceId" that is mandatory for processing this request is not supplied.
400
缺少 InstanceId 值
InvalidInstanceName.Malformed
The specified parameter "InstanceName" is not valid.
400
指定的 InstanceName 格式不合法
InvalidDescription.Malformed
The specified parameter "Description" is not valid.
400
指定的 Description 格式不合法
InvalidHostPassword.Malformed
The specified parameter "Password" is not valid.
400
指定的 Password 格式不合法
InvalidHostName.Malformed
The specified parameter "HostName" is not valid.
400
指定的 HostName 格式不合法
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
该资源目前被安全锁定被拒绝操作
示例
请求示例
https://ecs.aliyuncs.com/?Action=ModifyInstanceAttribute
&InstanceId=i-instance1
&Password=pwd
&<公共请求参数>
返回示例
XML格式
473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
JSON格式
{
"RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E"
}
所属专题: