修改一台執行個體的部分資訊，包括執行個體密碼、名稱、描述、主機名稱和自訂資料等。

描述

調用該介面時，您需要注意：

  • 執行個體狀態為 已釋放（Deleted）或 啟動中（Starting）時，無法重設執行個體密碼。

  • 被 安全控制 的執行個體的 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] 個字元，支援字母、數字和連字號（-），不支援點號（.），不能全是數字。
  • Unix 類執行個體：長度為 [2, 30] 個字元，允許支援多個點號，點與點之間為一段，每段允許字母、數字和連字號（-）。
UserData String 否 執行個體自訂資料，需要以 Base 64 編碼。編碼前，未經處理資料不能超過 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 Base 64 編碼 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 不存在。