本接口用于購買一張預(yù)留實(shí)例券，支持您購買一張地域級(jí)或者可用區(qū)級(jí)的預(yù)留實(shí)例券來抵扣對(duì)應(yīng)規(guī)格的按量付費(fèi)實(shí)例賬單。
接口說明
請(qǐng)確保在使用該接口前，已充分了解預(yù)留實(shí)例券的收費(fèi)方式和價(jià)格。
- 請(qǐng)確保在使用該接口前，您已充分了解預(yù)留實(shí)例券的計(jì)費(fèi)規(guī)則。詳情請(qǐng)參見預(yù)留實(shí)例券。
- 在所有地域下，您最多可以持有 20 張地域級(jí)預(yù)留實(shí)例券。
- 單個(gè)可用區(qū)下，您最多可以持有 20 張可用區(qū)級(jí)預(yù)留實(shí)例券。
請(qǐng)求示例
- 在杭州地域下購買一張時(shí)長 1 年的地域級(jí)預(yù)留實(shí)例券，用來抵扣 3 臺(tái)實(shí)例規(guī)格為 ecs.g5.large、操作系統(tǒng)為 Linux 的按量付費(fèi)實(shí)例賬單。
"RegionId":"cn-hangzhou", //設(shè)置地域?yàn)楹贾?"InstanceType":"ecs.g5.large", //設(shè)置實(shí)例規(guī)格
"Scope":"Region", //設(shè)置預(yù)留實(shí)例券的范圍為地域級(jí)
"InstanceAmount":3, //表示預(yù)留實(shí)例券可以同時(shí)匹配同規(guī)格按量付費(fèi)實(shí)例的數(shù)量為 3 臺(tái)
"OfferingType":"All Upfront", //默認(rèn)值，表示付款類型為全預(yù)付
"Platform":"Linux", //實(shí)例使用的鏡像的操作系統(tǒng)類型為 Linux 或者類 Unix 類型的操作系統(tǒng)
"Period":1, //購買預(yù)留實(shí)例券的時(shí)長為 1 年
"PeriodUnit":"Year", //設(shè)置時(shí)長單位為年
- 在杭州地域的可用區(qū) H 下購買一張時(shí)長 2 年的可用區(qū)級(jí)預(yù)留實(shí)例券，用來抵扣 5 臺(tái)實(shí)例規(guī)格為 ecs.g5.large、操作系統(tǒng)為 Windows 的按量付費(fèi)實(shí)例賬單。
"RegionId":"cn-hangzhou",
"ZoneId":"cn-hangzhou-h", //設(shè)置可用區(qū)為可用區(qū) H
"InstanceType":"ecs.g5.large",
"Scope":"Zone", //設(shè)置預(yù)留實(shí)例券的范圍為可用區(qū)級(jí)
"InstanceAmount":5, //表示預(yù)留實(shí)例券可以同時(shí)匹配同規(guī)格按量付費(fèi)實(shí)例的數(shù)量為 5 臺(tái)
"OfferingType":"All Upfront",
"Platform":"Windows", //實(shí)例使用的鏡像的操作系統(tǒng)類型為 Windows
"Period":2, //購買預(yù)留實(shí)例券的時(shí)長為 2 年
"PeriodUnit":"Year", //設(shè)置時(shí)長單位為年
調(diào)試
您可以在OpenAPI Explorer中直接運(yùn)行該接口，免去您計(jì)算簽名的困擾。運(yùn)行成功后，OpenAPI Explorer可以自動(dòng)生成SDK代碼示例。
授權(quán)信息
下表是API對(duì)應(yīng)的授權(quán)信息，可以在RAM權(quán)限策略語句的Action元素中使用，用來給RAM用戶或RAM角色授予調(diào)用此API的權(quán)限。具體說明如下：
- 操作：是指具體的權(quán)限點(diǎn)。
- 訪問級(jí)別：是指每個(gè)操作的訪問級(jí)別，取值為寫入（Write）、讀取（Read）或列出（List）。
- 資源類型：是指操作中支持授權(quán)的資源類型。具體說明如下：
- 對(duì)于必選的資源類型，用背景高亮的方式表示。
- 對(duì)于不支持資源級(jí)授權(quán)的操作，用
全部資源表示。
- 條件關(guān)鍵字：是指云產(chǎn)品自身定義的條件關(guān)鍵字。
- 關(guān)聯(lián)操作：是指成功執(zhí)行操作所需要的其他權(quán)限。操作者必須同時(shí)具備關(guān)聯(lián)操作的權(quán)限，操作才能成功。
| 操作 | 訪問級(jí)別 | 資源類型 | 條件關(guān)鍵字 | 關(guān)聯(lián)操作 |
|---|---|---|---|---|
| ecs:PurchaseReservedInstancesOffering | create | *ReservedInstance acs:ecs:{#regionId}:{#accountId}:reservedinstance/* |
| 無 |
請(qǐng)求參數(shù)
| 名稱 | 類型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| RegionId | string | 是 | 實(shí)例所屬的地域 ID。您可以調(diào)用 DescribeRegions 查看最新的阿里云地域列表。 | cn-hangzhou |
| Tag | array<object> | 否 | 標(biāo)簽數(shù)組。數(shù)組長度：0~20。 | |
| object | 否 | |||
| Key | string | 否 | 預(yù)留實(shí)例券的標(biāo)簽鍵。不允許為空字符串，最多支持 128 個(gè)字符，不能以 | TestKey |
| Value | string | 否 | 預(yù)留實(shí)例券的標(biāo)簽值。則不允許為空字符串，最多支持 128 個(gè)字符，不能以 | TestValue |
| ResourceGroupId | string | 否 | 資源組 ID。 | rg-bp199lyny9b3**** |
| ZoneId | string | 否 | 實(shí)例所屬的可用區(qū)編號(hào)，當(dāng) | cn-hangzhou-g |
| ReservedInstanceName | string | 否 | 預(yù)留實(shí)例券的名稱。長度為 2~128 個(gè)英文或中文字符，必須以大小寫字母或中文開頭，不能以 http:// 和 https:// 開頭。可以包含數(shù)字、半角冒號(hào)（:）、下劃線（_）或者短劃線（-）。 | testReservedInstanceName |
| InstanceType | string | 是 | 預(yù)留實(shí)例券可以匹配的實(shí)例規(guī)格。 說明
適用的實(shí)例規(guī)格持續(xù)更新，詳情請(qǐng)參見預(yù)留實(shí)例券概述。
| ecs.g5.large |
| Scope | string | 否 | 預(yù)留實(shí)例券的范圍。取值范圍：
默認(rèn)值：Region。 | Zone |
| InstanceAmount | integer | 否 | 預(yù)留實(shí)例券可以同時(shí)匹配同規(guī)格按量付費(fèi)實(shí)例的數(shù)量。取值范圍：1~50。 默認(rèn)值：1。 | 3 |
| OfferingType | string | 否 | 預(yù)留實(shí)例券的付款類型。取值范圍：
默認(rèn)值：All Upfront。 | All Upfront |
| Description | string | 否 | 預(yù)留實(shí)例券的描述。長度為 2~256 個(gè)英文或中文字符，不能以 http://和 https://開頭。 默認(rèn)值：空。 | testDescription |
| Platform | string | 否 | 實(shí)例使用的鏡像的操作系統(tǒng)類型。取值范圍：
默認(rèn)值：Linux。 | Linux |
| Period | integer | 否 | 購買預(yù)留實(shí)例券的時(shí)長。
默認(rèn)值：1。 | 1 |
| PeriodUnit | string | 否 | 購買預(yù)留實(shí)例券的時(shí)長單位。 取值范圍：Year、Month。 默認(rèn)值：Month。 | Year |
| ClientToken | string | 否 | 保證請(qǐng)求冪等性。從您的客戶端生成一個(gè)參數(shù)值，確保不同請(qǐng)求間該參數(shù)值唯一。ClientToken 只支持 ASCII 字符，且不能超過 64 個(gè)字符。更多信息，請(qǐng)參見如何保證冪等性。 | 123e4567-e89b-12d3-a456-426655440000 |
| AutoRenew | boolean | 否 | 是否要自動(dòng)續(xù)費(fèi)。可選值：
| true |
| AutoRenewPeriod | integer | 否 | 每次自動(dòng)續(xù)費(fèi)的時(shí)長，單位為月。當(dāng)參數(shù) AutoRenew 取值 True 時(shí)，該參數(shù)才生效。 AutoRenewPeriod 取值范圍：1，12，36，60。 當(dāng) PeriodUnit=Month， 默認(rèn)值為 1。 當(dāng) PeriodUnit=Year，默認(rèn)值為 12。 | 1 |
| StartTime | string | 否 | 預(yù)留實(shí)例券的指定生效時(shí)間。按照ISO 8601標(biāo)準(zhǔn)表示，使用 UTC+0 時(shí)間。格式為： 說明
生效時(shí)間不填寫時(shí)，默認(rèn)從當(dāng)前時(shí)間的正點(diǎn)時(shí)間開始生效。例如，你在 2024-11-01 13:45:35 成功購買，生效時(shí)間則為 2024-11-01 13:00:00。
| 2024-07-04T15Z |
返回參數(shù)
示例
正常返回示例
JSON格式
{
"RequestId": "8C314443-AF0D-4766-9562-C83B7F1A3C8B",
"ReservedInstanceIdSets": {
"ReservedInstanceId": [
"ecsri-2ze53qonjqxg7r****"
]
}
}錯(cuò)誤碼
| HTTP status code | 錯(cuò)誤碼 | 錯(cuò)誤信息 | 描述 |
|---|---|---|---|
| 400 | InvalidStartTime.ScopeNotMatch | Zonal reservedInstance not supported for scheduled creating. | - |
| 400 | InvalidInstanceType.ValueUnauthorized | The specified InstanceType is not authorized. | 指定的實(shí)例規(guī)格未授權(quán)使用。 |
| 400 | InvalidDescription.Malformed | The specified parameter "Description" is not valid. | 指定的資源描述格式不合法。長度為2-256個(gè)字符，不能以http://和https://開頭。 |
| 400 | InvalidParameter.Conflict | The specified region and cluster do not match. | 指定的地域與指定的集群不匹配。 |
| 400 | InvalidTagKey.Malformed | The specified Tag.n.Key is not valid. | 指定的標(biāo)簽鍵參數(shù)有誤。 |
| 400 | RegionUnauthorized | %s | 該地域未被授權(quán)。%s為變量，將根據(jù)調(diào)用API的實(shí)際情況動(dòng)態(tài)返回錯(cuò)誤信息。 |
| 400 | Zone.NotOnSale | %s | 該可用區(qū)暫時(shí)關(guān)閉了售賣。%s為變量，將根據(jù)調(diào)用API的實(shí)際情況動(dòng)態(tài)返回錯(cuò)誤信息。 |
| 400 | InvalidPeriodUnit.ValueNotSupported | The specified parameter PeriodUnit is not valid. | 參數(shù) PeriodUnit 無效。 |
| 400 | InvalidTagValue.Malformed | The specified Tag.n.Value is not valid. | 指定的標(biāo)簽值參數(shù)有誤。 |
| 400 | InvalidChargeType.ValueNotSupported | ChargeType is not valid. | 該計(jì)費(fèi)方式不支持，請(qǐng)您重新選擇計(jì)費(fèi)方式。 |
| 400 | InvalidParameter.Scope | The specified parameter 'Scope' is invalid. | - |
| 400 | InvalidReservedInstanceStatus.ValueNotSupported | ReservedInstance status is not supported. | - |
| 400 | InvalidReservedInstanceOfferingType.ValueNotSupported | The OfferingType is not supported. | - |
| 400 | InvalidReservedInstanceOfferingClass.ValueNotSupported | The OfferingClass is not supported. | - |
| 400 | MissingParameter.ZoneId | The specified zoneId should be not empty. | - |
| 400 | MissingParameter.InstanceType | The instanceType should be not empty. | - |
| 400 | MissingParameter.ReservedInstanceId | The ids of reservedInstance can not be empty. | - |
| 400 | MissingParameter.ReservedInstanceConfiguration | The configurations of reservedInstance can not be empty. | - |
| 400 | InvalidParameter.SplitOrMerge | The Many-to-many of modification is not supported. | - |
| 400 | MissingParameter.InstanceTypeAndAmountBothEmpty | The instanceType and amount can not be both empty. | - |
| 400 | InvalidReservedInstancePlatform.ValueNotSupported | The Platform is not supported. | - |
| 400 | InvalidParameter.ReservedInstanceName | ReservedInstanceName is invalid. | - |
| 400 | InvalidReservedInstanceZone.ValueNotSupported | The zoneId is not exist. | - |
| 400 | OperationDenied | The specified InstanceType or Zone is not authorized for current user. | - |
| 400 | InvalidInstanceType.ValueNotSupported | The specified InstanceType beyond the permitted range. | 指定的實(shí)例規(guī)格不合法（超出可選范圍）。 |
| 400 | InvalidInstanceType.ValueNotSupported | The specified InstanceType does not exist or beyond the permitted range. | 您指定的實(shí)例規(guī)格不存在，或者您沒有權(quán)限操作此規(guī)格的實(shí)例。 |
| 403 | OperationDenied | The creation of Host to the specified Zone is not allowed. | 無法在指定可用區(qū)創(chuàng)建專用宿主機(jī)。 |
| 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. | 指定的地域暫時(shí)關(guān)閉了此資源的售賣，請(qǐng)稍后重試。 |
| 403 | NodeControllerUnavailable | The Node Controller is temporarily unavailable. | 節(jié)點(diǎn)控制器暫不可用。 |
| 403 | OperationDenied | The resource is out of usage. | 該實(shí)例不在運(yùn)行狀態(tài)，請(qǐng)您啟動(dòng)實(shí)例或檢查操作是否合理。 |
| 403 | InvalidParameter.ResourceOwnerAccount | ResourceOwnerAccount is Invalid. | 指定的 ResourceOwnerAccount 不合法。 |
| 403 | Zone.NotOpen | The specified zone is not granted to you to buy resources yet. | 用戶未被授權(quán)購買指定的可用區(qū)的資源。 |
| 403 | Zone.NotOnSale | The specified zone is not available for purchase. | 指定可用區(qū)已經(jīng)售罄，請(qǐng)您更換實(shí)例規(guī)格或者更換地域創(chuàng)建。 |
| 403 | InvalidResourceType.NotSupported | %s | - |
| 403 | InvalidParameter.NotMatch | %s | 您輸入的參數(shù)無效，請(qǐng)檢查參數(shù)之間是否沖突。 |
| 403 | Account.Arrearage | Your account has been in arrears. | 賬戶余額不足，請(qǐng)先充值再操作。 |
| 403 | InvalidStartTime.MalFormed | The specified StartTime is not valid. | - |
| 403 | InvalidStartTime.NotSupported | The specified startTime is not supported. | - |
| 404 | InvalidZoneId.NotFound | The ZoneId provided does not exist in our records. | 指定的可用區(qū) ID 不存在。 |
| 404 | PaymentMethodNotFound | No payment method has been registered on the account. | 賬戶尚未注冊(cè)支付方式。 |
| 404 | InvalidZoneId.NotFound | The specified ZoneId does not exist. | 指定的可用區(qū) ID 不存在。 |
| 500 | InternalError | The request processing has failed due to some unknown error. | 內(nèi)部錯(cuò)誤，請(qǐng)重試。 |
| 500 | InternalError | %s | 內(nèi)部錯(cuò)誤。 |
| 500 | InternalError | The request processing has failed due to some unknown error, exception or failure. | 內(nèi)部錯(cuò)誤，請(qǐng)重試。 |
訪問錯(cuò)誤中心查看更多錯(cuò)誤碼。
變更歷史
| 變更時(shí)間 | 變更內(nèi)容概要 | 操作 |
|---|---|---|
| 2024-08-21 | OpenAPI 錯(cuò)誤碼發(fā)生變更、OpenAPI 入?yún)l(fā)生變更 | 查看變更詳情 |
| 2022-11-02 | OpenAPI 錯(cuò)誤碼發(fā)生變更、OpenAPI 入?yún)l(fā)生變更 | 查看變更詳情 |