本接口用于修改一臺ECS實例的部分屬性信息,支持修改密碼、實例名稱、主機名、所屬安全組、實例的MTU以及用戶自定義數據等。
接口說明
被安全鎖定的實例不支持調用該接口。更多信息,請參見資源安全鎖定對調用 API 的影響。
調試
您可以在OpenAPI Explorer中直接運行該接口,免去您計算簽名的困擾。運行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息,可以在RAM權限策略語句的Action
元素中使用,用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下:
- 操作:是指具體的權限點。
- 訪問級別:是指每個操作的訪問級別,取值為寫入(Write)、讀取(Read)或列出(List)。
- 資源類型:是指操作中支持授權的資源類型。具體說明如下:
- 對于必選的資源類型,用背景高亮的方式表示。
- 對于不支持資源級授權的操作,用
全部資源
表示。
- 條件關鍵字:是指云產品自身定義的條件關鍵字。
- 關聯操作:是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限,操作才能成功。
操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
---|---|---|---|---|
ecs:ModifyInstanceAttribute | update | *Instance acs:ecs:{#regionId}:{#accountId}:instance/{#instanceId} *SecurityGroup acs:ecs:{#regionId}:{#accountId}:securitygroup/{#SecurityGroupId} |
| 無 |
請求參數
名稱 | 類型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
InstanceId | string | 是 | 實例 ID。 | i-bp67acfmxazb4ph**** |
Password | string | 否 | 實例的密碼。支持長度為 8~30 個字符,必須同時包含大小寫英文字母、數字和特殊符號中的三類字符。特殊符號可以是:()`~!@#$%^&*-_+=|{}[]:;'<>,.?/ 。Windows 實例不能以斜線號(/)為密碼首字符。使用該參數時請注意:
說明
如果傳入 Password 參數,建議您使用 HTTPS 協議發送請求,避免密碼泄露。
| Test123456&$ |
HostName | string | 否 | 操作系統的主機名。使用該參數時請注意:
不同操作系統主機名存在以下限制:
| testHostName |
InstanceName | string | 否 | 實例名稱。長度為 2~128 個英文或中文字符。必須以大小寫字母或中文開頭,不能以 | testInstanceName |
Description | string | 否 | 實例描述。長度為 2~256 個英文或中文字符,不能以 | testInstanceDescription |
UserData | string | 否 | 實例自定義數據,建議 Base64 編碼后傳入。使用該參數時請注意:
說明
編碼前,原始數據不能超過 32 KB。建議不要明文傳入敏感信息,例如密碼和私鑰等。如果必須傳入敏感信息,建議您加密后再以 Base64 編碼傳入,在實例內部以同樣的方式解密。
| ZWNobyBoZWxsbyBlY3Mh |
Recyclable | boolean | 否 | 說明
該參數正在邀測中,暫不開放使用。
| true |
CreditSpecification | string | 否 | Standard | |
DeletionProtection | boolean | 否 | 實例釋放保護屬性。指定是否支持通過控制臺或 API( DeleteInstance )釋放實例。 說明
該屬性僅適用于按量付費實例,且只能限制手動釋放操作,對系統釋放操作不生效。
| false |
NetworkInterfaceQueueNumber | integer | 否 | 主網卡隊列數。使用該參數時請注意:
| 8 |
SecurityGroupIds | array | 否 | 實例重新加入的安全組 ID 數組。使用該參數時請注意:
說明
修改安全組后很快會生效于對應的實例,但可能有較小的延遲。
| |
string | 否 | 安全組 ID。 | sg-bp15ed6xe1yxeycg7o**** | |
RemoteConnectionOptions | object | 否 | 說明
該參數正在邀測中,暫不開放使用。
| |
Password | string | 否 | 說明
該參數正在邀測中,暫不開放使用。
| hide |
Type | string | 否 | 說明
該參數正在邀測中,暫不開放使用。
| hide |
EnableJumboFrame | boolean | 否 | 實例 MTU 是否開啟 Jumbo frame 通信模式,取值范圍:
使用該參數時請注意:
| false |
CpuOptions.TopologyType | string | 否 | 實例的 Cpu 拓撲類型。取值范圍:
默認值:無。 使用該參數時請注意:
說明
僅部分實例規格族支持使用本參數,具體支持實例規格族請參見查看和修改 CPU 拓撲結構。
| DiscreteCoreToHTMapping |
PrivateDnsNameOptions | object | 否 | 說明
該參數正在邀測中,暫不開放使用。
| |
EnableInstanceIdDnsARecord | boolean | 否 | 說明
該參數正在邀測中,暫不開放使用。
| false |
EnableInstanceIdDnsAAAARecord | boolean | 否 | 說明
該參數正在邀測中,暫不開放使用。
| false |
EnableIpDnsARecord | boolean | 否 | 說明
該參數正在邀測中,暫不開放使用。
| false |
EnableIpDnsPtrRecord | boolean | 否 | 說明
該參數正在邀測中,暫不開放使用。
| false |
HostnameType | string | 否 | 說明
該參數正在邀測中,暫不開放使用。
| Custom |
返回參數
示例
正常返回示例
JSON
格式
{
"RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E"
}
錯誤碼
HTTP status code | 錯誤碼 | 錯誤信息 | 描述 |
---|---|---|---|
400 | InvalidInstanceName.Malformed | The specified parameter "InstanceName" is not valid. | InstanceName參數不符合規則。 |
400 | InvalidDescription.Malformed | The specified parameter "Description" is not valid. | 指定的資源描述格式不合法。長度為2-256個字符,不能以http://和https://開頭。 |
400 | InvalidRemoteConnectionOptions.Password | The remote connection password is invalid. | - |
400 | InvalidRemoteConnectionOptions.Type | The remote connection type is invalid. | - |
400 | InstanceType.ValueNotSupported | The instance type not supported. | - |
400 | OSType.ValueNotSupported | The OS type is not supported. | - |
400 | InvalidHostPassword.Malformed | The specified parameter "Password" is not valid. | - |
400 | InvalidHostName.Malformed | The specified parameter "HostName" is not valid. | 指定的參數 HostName 不合法 |
400 | InvalidPassword.Malformed | The specified parameter "Password" is not valid. | 指定的參數 Password 不合法 |
400 | InvalidUserData.SizeExceeded | The specified parameter "UserData" exceeds the size. | - |
400 | InvalidUserData.NotSupported | TThe specified parameter "UserData" only support the vpc and IoOptimized Instance. | - |
400 | InvalidUserData.NotSupported | The specified parameter "UserData" only support the vpc and IoOptimized Instance. | - |
400 | ImageNotSupportCloudInit | The specified image does not support cloud-init. | 該鏡像不支持CloudInit。 |
400 | ChargeTypeViolation | Pay-As-You-Go instances do not support this operation. | 按量付費實例不支持該操作,檢查實例的付費類型是否與該操作沖突。 |
400 | InvalidParameter.RecycleBin | You do not have permission to set recyclable properties. | 您未被授權執行該操作。 |
400 | InvalidParameter.CreditSpecification | The specified CreditSpecification is not supported in this region. | 該地區不支持指定的突發性能實例的運行模式。 |
400 | InvalidInstanceStatus.CreditSpecRestricted | The current status of the resource does not support this operation. | 當前資源的狀態不支持此操作。 |
400 | InvalidInstanceStatus.NotRunning | The current status of the resource is invalid, you can only do this operation when instance is running. | 當前實例的狀態不支持此操作,當實例狀態為 Running 時再進行此操作。 |
400 | InvalidNetworkType.NotSupported | The classic networkType does not support to modify security group | - |
400 | InvalidOperation.EniCountExceeded | =The maximum number of eni in a enterprise security group is exceeded. | - |
400 | JoinedGroupLimitExceed | %s | 指定資源所能加入的安全組數量達到上限。具體信息請參見錯誤信息%s占位符的實際返回結果。 |
400 | InvalidParameter | The specified parameter is not valid. | 無效的參數,請檢查該參數是否正確。 |
400 | InvalidOperation.InvalidEcsState | %s | 實例當前的狀態不支持此操作。 |
400 | InvalidParam.NotSupportJumboFrame | Not support jumbo frame. | - |
400 | InvalidOperation.InstanceStatusNotSupport | The instance status is not support modify mtu config. | - |
400 | InvalidOperation.InstanceStatusUnsupported | The specified instance status does not support modification of cpu topology type. | 當前實例狀態不支持修改CPU拓撲類型 |
400 | InvalidParameter.CpuOptionsTopologyType | The specified parameter CpuOptions.TopologyType: %s is not valid. | 當前CPU拓撲類型的枚舉值不合法 |
400 | InvalidInstanceType.NotSupportCpuOptionsTopologyType | The specified instance type does not support CpuOptions.TopologyType: %s. | 當前規格不支持指定的CPU拓撲類型 |
400 | InvalidAdditionalInfoPvdConfig.SizeExceeded | The specified parameter AdditionalInfo.PvdConfig exceeds the size. | 指定的 AdditionalInfo.PvdConfig 超過大小限制。 |
400 | InvalidInstanceType.NotSupportHighDensityMode | The specified instance type does not support the use of the high density mode. | 當前實例規格不支持使用云盤高密模式 |
400 | InvalidStatus.StoppedRequired | The current state of the resource does not support this operation, it can only be operated in a stopped state. | 資源的當前狀態不支持此操作,只有停機狀態才能操作 |
403 | 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 instance amount in the specified SecurityGroup reach its limit. | 指定安全組的實例數已達最大值。 |
403 | OperationDenied | The current status of the resource does not support this operation. | 該資源狀態不支持此類操作。 |
403 | InvalidUserData.Forbidden | User not authorized to input the parameter "UserData"please apply for permission "UserData" | - |
403 | InvalidUserData.Base64FormatInvalid | The specified UserData is not valid | 指定的UserData參數編碼出錯 |
403 | InvalidChargeType.ValueNotSupported | Deletion protection is only valid for postPaid instance, not for prePaid or spot instance. | 刪除保護功能只能使用在按量付費資源上 |
403 | InvalidUser.Unauthorized | The user is not authorized | 您當前使用的賬號無權限。 |
403 | EnterpriseGroupLimited.MutliGroupType | The specified instance can not join multi SecurityGroup types. | 指定的實例不能同時加入普通安全組和企業安全組。您可以調用 DescribeSecurityGroups 查詢指定安全組的類型。 |
403 | SecurityGroupInstanceLimitExceed | %s | 該安全組內已有的實例數量已達到最大限制。 |
403 | InstanceNotInSecurityGroup | The instance not in the group. | 指定的實例不在安全組內。 |
403 | InvalidOperation.InvalidRegion | %s | 指定的參數 RegionId 無效。 |
403 | OperationDenied | The specified Image is disabled or is deleted. | 指定的鏡像被禁用或被刪除。 |
403 | InvalidOperation.ResourceManagedByCloudProduct | %s | 云產品托管的安全組不支持修改操作。 |
403 | InvalidParameter.InvalidEniQueueNumber | %s | 彈性網卡隊列數有誤,具體信息請參見錯誤信息%s占位符的實際返回結果。 |
403 | InvalidOperation.MaxEniQueueNumberExceeded | %s | 彈性網卡隊列數超過上限,具體信息請參見錯誤信息%s占位符的實際返回結果。 |
403 | InvalidOperation.ExceedInstanceTypeQueueNumber | %s | 彈性網卡隊列總數超過上限,具體信息請參見錯誤信息%s占位符的實際返回結果。 |
403 | InvalidOperation.InstanceTypeNotSupportHighPerformanceTrafficMode | %s | - |
403 | InvalidParameter.InvalidQueuePairNumber | %s | - |
403 | InvalidOperation.MaxEniQueuePairNumberExceed | %s | - |
403 | InvalidOperation.EniQueuePairNumberOverflow | %s | - |
403 | AclLimitExceed | %s | 網卡或實例的安全組規則數量超過限額值。 |
404 | InvalidInstanceId.NotFound | The specified InstanceId does not exist. | 指定的InstanceId不存在。 |
404 | InvalidSecurityGroupId.NotFound | The specified SecurityGroupId does not exist. | 指定的安全組在該用戶賬號下不存在,請您檢查安全組 ID 是否正確。 |
404 | Credit.NotFound | The specified credit information does not exist. | 指定的突發性能實例積分信息不存在。 |
404 | InvalidInstanceStatus.NeedRestart | The current status of the resource is invalid, you can only do this operation after instance is restarted. | - |
404 | InvalidParameter.SecurityGroupIdRepeated | The specified security group ids has repeated. | 指定的安全組已重復添加。請檢查 SecurityGroupIds 參數值是否正確。 |
404 | InvalidSecurityGroupType.NotSupportClassic | The specified SecurityGroupIds have classic group type. | 指定的安全組的網絡類型為經典網絡。請檢查 SecurityGroupIds 參數值是否正確。 |
404 | InvalidSecurityGroupVpc.NotBelongToOneVpc | The specified SecurityGroupIds are belong to different vpc. | 指定的安全組ID屬于不同的VPC。請檢查 SecurityGroupIds 參數值是否正確。您可以調用 DescribeSecurityGroups 查詢指定安全組所屬的VPC。 |
500 | InternalError | The request processing has failed due to some unknown error. | 內部錯誤,請重試。 |
500 | InternalError | The request processing has failed due to some unknown error, exception or failure. | 內部錯誤,請重試。 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
變更時間 | 變更內容概要 | 操作 |
---|---|---|
2024-08-29 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |
2024-08-08 | OpenAPI 錯誤碼發生變更、OpenAPI 入參發生變更 | 查看變更詳情 |
2024-07-03 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |
2024-05-11 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |
2023-12-14 | OpenAPI 錯誤碼發生變更、OpenAPI 入參發生變更 | 查看變更詳情 |
2023-07-17 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |