本接口用于對一張或多張預留實例券進行續費,支持您在續費時設置購買時長和自動續費屬性。
接口說明
請確保在使用該接口前,已充分了解預留實例券的收費方式和價格。
- 預留實例券支持手動續費和自動續費兩種續費方式,詳細信息請參見預留實例券續費說明。
- 您可以調用 DescribeReservedInstances 查詢已購買的預留實例券。
- 該接口支持開啟自動續費,但不支持取消自動續費,您可以通過 ModifyReservedInstanceAutoRenewAttribute 取消自動續費。
調試
您可以在OpenAPI Explorer中直接運行該接口,免去您計算簽名的困擾。運行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息,可以在RAM權限策略語句的Action
元素中使用,用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下:
- 操作:是指具體的權限點。
- 訪問級別:是指每個操作的訪問級別,取值為寫入(Write)、讀?。≧ead)或列出(List)。
- 資源類型:是指操作中支持授權的資源類型。具體說明如下:
- 對于必選的資源類型,用背景高亮的方式表示。
- 對于不支持資源級授權的操作,用
全部資源
表示。
- 條件關鍵字:是指云產品自身定義的條件關鍵字。
- 關聯操作:是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限,操作才能成功。
操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
---|---|---|---|---|
ecs:RenewReservedInstances | create | *ReservedInstance acs:ecs:{#regionId}:{#accountId}:reservedinstance/{#ReservedInstanceId} |
| 無 |
請求參數
名稱 | 類型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
ReservedInstanceId | array | 否 | 預留實例券 ID。 | |
string | 否 | 預留實例券 ID。您可以調用 DescribeReservedInstances 查看已購買的預留實例券。 單次續費的預留實例券數量最多不超過 10 個。 | ecsri-2ze53qonjqxg7r**** | |
RegionId | string | 否 | 實例所屬的地域 ID。您可以調用 DescribeRegions 查看最新的阿里云地域列表。 | cn-hangzhou |
Period | integer | 否 | 購買預留實例券的時長。
默認值:1。 | 1 |
PeriodUnit | string | 否 | 購買預留實例券的時長單位。 取值范圍:Year、Month。 默認值:Month。 | Year |
ClientToken | string | 否 | 保證請求冪等性。從您的客戶端生成一個參數值,確保不同請求間該參數值唯一。ClientToken 只支持 ASCII 字符,且不能超過 64 個字符。更多信息,請參見如何保證冪等性。 | 123e4567-e89b-12d3-a456-426655440000 |
AutoRenew | boolean | 否 | 是否要自動續費。
默認值:false。 | true |
AutoRenewPeriod | integer | 否 | 每次自動續費的時長,單位為月。當參數 AutoRenew 取值為 true 時,該參數才生效。
| 1 |
返回參數
示例
正常返回示例
JSON
格式
{
"RequestId": "8C314443-AF0D-4766-9562-C83B7F1****",
"ReservedInstanceIdSets": {
"ReservedInstanceId": [
"ecsri-2ze53qonjqxg7r****"
]
},
"OrderId": "2023912123****"
}
錯誤碼
HTTP status code | 錯誤碼 | 錯誤信息 | 描述 |
---|---|---|---|
400 | InvalidInstanceType.ValueUnauthorized | The specified InstanceType is not authorized. | 指定的實例規格未授權使用。 |
400 | InvalidParameter.Conflict | The specified region and cluster do not match. | 指定的地域與指定的集群不匹配。 |
400 | InvalidTagKey.Malformed | The specified Tag.n.Key is not valid. | 指定的標簽鍵參數有誤。 |
400 | RegionUnauthorized | %s | 該地域未被授權。%s為變量,將根據調用API的實際情況動態返回錯誤信息。 |
400 | Zone.NotOnSale | %s | 該可用區暫時關閉了售賣。%s為變量,將根據調用API的實際情況動態返回錯誤信息。 |
400 | InvalidPeriodUnit.ValueNotSupported | The specified parameter PeriodUnit is not valid. | 參數 PeriodUnit 無效。 |
400 | InvalidTagValue.Malformed | The specified Tag.n.Value is not valid. | 指定的標簽值參數有誤。 |
400 | InvalidChargeType.ValueNotSupported | ChargeType is not valid. | 該計費方式不支持,請您重新選擇計費方式。 |
400 | OperationDenied | The specified InstanceType or Zone is not authorized for current user. | - |
400 | InvalidPeriod | The specified Period or PeriodUnit is not correct. | - |
400 | MissingParameter.ReservedInstanceIds | The specified ReservedInstanceIds does not exist. | - |
400 | InvalidParameter.PeriodUnit | The specified PeriodUnit is invalid. | - |
400 | InvalidParameter.Period | The specified Period is invalid. | - |
400 | InvalidParameter.ReservedInstanceIds | The specified ReservedInstanceIds is invalid. | - |
400 | InvalidPeriod.ExceededMaximumExpiration | The specified renewal period cannot exceed the maximum expiration date. We recommend you try shortening the renewal period at next attempt. | - |
403 | OperationDenied.NoStock | The requested resource is sold out in the specified zone; try other types of resources or other regions and zones. | 庫存不足。 |
403 | OperationDenied | Sales of this resource are temporarily suspended in the specified region; please try again later. | 指定的地域暫時關閉了此資源的售賣,請稍后重試。 |
403 | NodeControllerUnavailable | The Node Controller is temporarily unavailable. | 節點控制器暫不可用。 |
403 | OperationDenied | The resource is out of usage. | 該實例不在運行狀態,請您啟動實例或檢查操作是否合理。 |
403 | InvalidParameter.ResourceOwnerAccount | ResourceOwnerAccount is Invalid. | 指定的 ResourceOwnerAccount 不合法。 |
403 | Zone.NotOpen | The specified zone is not granted to you to buy resources yet. | 用戶未被授權購買指定的可用區的資源。 |
403 | Zone.NotOnSale | The specified zone is not available for purchase. | 指定可用區已經售罄,請您更換實例規格或者更換地域創建。 |
403 | InvalidResourceType.NotSupported | %s | - |
403 | InvalidParameter.NotMatch | %s | 您輸入的參數無效,請檢查參數之間是否沖突。 |
403 | Account.Arrearage | Your account has been in arrears. | 賬戶余額不足,請先充值再操作。 |
403 | InvalidReservedInstanceName.Malformed | The specified parameter ReservedInstanceName is invalid. | - |
403 | InvalidParameter.Scope | The specified parameter 'Scope' is invalid. | - |
403 | InvalidReservedInstanceStatus.ValueNotSupported | ReservedInstance status is not supported. | - |
403 | InvalidReservedInstanceOfferingType.ValueNotSupported | The OfferingType is not supported. | - |
403 | InvalidReservedInstanceOfferingClass.ValueNotSupported | The OfferingClass is not supported. | - |
403 | MissingParameter.ZoneId | The specified zoneId should be not empty. | - |
403 | MissingParameter.InstanceType | The instanceType should be not empty. | - |
403 | MissingParameter.ReservedInstanceId | The ids of reservedInstance can not be empty. | - |
403 | MissingParameter.ReservedInstanceConfiguration | The configurations of reservedInstance can not be empty. | - |
403 | InvalidParameter.SplitOrMerge | The Many-to-many of modification is not supported. | - |
403 | MissingParameter.InstanceTypeAndAmountBothEmpty | The instanceType and amount can not be both empty. | - |
403 | InvalidReservedInstancePlatform.ValueNotSupported | The Platform is not supported. | - |
403 | InvalidParameter.ReservedInstanceName | The reservedInstanceName is invalid. | reservedInstanceName字段值不合法 |
403 | InvalidReservedInstanceZone.ValueNotSupported | The zoneId is not exist. | - |
403 | InvalidParameter.ValueNotSupported | The instanceTypeFamily of the instance to be changed must be consistent. | - |
403 | InvalidParameter.ValueNotSupported | The expiration time of the instance to be changed must be consistent. | - |
403 | InvalidParameter.ValueNotSupported | The factor of instanceType is not equal. | - |
403 | InvalidParameter.ValueNotSupported | The offeringClass of instance is not same. | - |
403 | InvalidParameter.ValueNotSupported | The offeringType of instance is not same. | - |
403 | IncorrectInstanceStatus | The status of specified reservedInstance must be active. | 預留實例券狀態不正確導致續費失敗 |
403 | IncorrectInstanceStatus | The current status of the resource does not support this operation. | 該資源目前的狀態不支持此操作。 |
403 | InvalidPlatform.ValueNotSupported | The platform of reservedInstance is invalid. | - |
403 | InvalidScope.ValueNotSupported | The scope of reservedInstance is invalid, The valid value is Zone or Region. | - |
403 | InvalidConfiguration.ValueNotSupported | The modification Configuration should not be empty. | - |
403 | InvalidZoneId.ValueNotSupported | The specified zoneId should be same. | - |
403 | InvalidParameter | The parameter is invalid.Please check it. | - |
403 | InvalidInstanceAmount.ValueNotSupported | The instanceAmount is invalid. | - |
403 | OperationDenied.OnlyModifyName | It is not allowed to modify the ReservedInstanceName only. | 不允許只修改預留實例券的名稱。 |
403 | InvalidReservedInstanceId.NotFound | The specified parameter ReservedInstanceId is invalid. | - |
403 | ChargeTypeViolation | The operation is not permitted due to charge type of the instance. | 付費方式不支持該操作,請您檢查實例的付費類型是否與該操作沖突。 |
404 | InvalidZoneId.NotFound | The ZoneId provided does not exist in our records. | 指定的可用區 ID 不存在。 |
404 | InvalidZoneId.NotFound | The specified ZoneId does not exist. | 指定的可用區 ID 不存在。 |
500 | InternalError | The request processing has failed due to some unknown error. | 內部錯誤,請重試。 |
500 | InternalError | %s | 內部錯誤。 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
變更時間 | 變更內容概要 | 操作 |
---|---|---|
2022-11-02 | OpenAPI 錯誤碼發生變更、OpenAPI 入參發生變更 | 查看變更詳情 |
2022-08-12 | 新增 OpenAPI | 查看變更詳情 |