本接口用于購(gòu)買一個(gè)或多個(gè)存儲(chǔ)容量單位包SCU(Storage Capacity Unit)。
接口說(shuō)明
請(qǐng)確保在使用該接口前,已充分了解存儲(chǔ)容量單位包的計(jì)費(fèi)方式和價(jià)格。
調(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)限策略語(yǔ)句的Action
元素中使用,用來(lái)給RAM用戶或RAM角色授予調(diào)用此API的權(quán)限。具體說(shuō)明如下:
- 操作:是指具體的權(quán)限點(diǎn)。
- 訪問(wèn)級(jí)別:是指每個(gè)操作的訪問(wèn)級(jí)別,取值為寫入(Write)、讀取(Read)或列出(List)。
- 資源類型:是指操作中支持授權(quán)的資源類型。具體說(shuō)明如下:
- 對(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)限,操作才能成功。
操作 | 訪問(wèn)級(jí)別 | 資源類型 | 條件關(guān)鍵字 | 關(guān)聯(lián)操作 |
---|---|---|---|---|
ecs:PurchaseStorageCapacityUnit | create | *StorageCapacityUnit acs:ecs:{#regionId}:{#accountId}:scu/* |
| 無(wú) |
請(qǐng)求參數(shù)
名稱 | 類型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
RegionId | string | 是 | SCU 所屬的地域 ID。確定地域后,SCU 只能抵扣該地域下云盤的按量付費(fèi)賬單。您可以調(diào)用 DescribeRegions 查看最新的阿里云地域列表。 | cn-hangzhou |
Name | string | 否 | SCU 的名稱,長(zhǎng)度為 2~128 個(gè)英文或中文字符。必須以大小寫字母或中文開(kāi)頭,不能以 | ScuPurchaseDemo |
Capacity | integer | 是 | SCU 容量大小,單位為 GiB。取值范圍:20、40、100、200、500、1024、2048、5210、10240、20480、52100。 | 20 |
Description | string | 否 | SCU 的描述信息,長(zhǎng)度為 2~256 個(gè)英文或中文字符,不能以 | ScuPurchaseDemo |
StartTime | string | 否 | SCU 的生效時(shí)間。生效時(shí)間不能超過(guò)創(chuàng)建時(shí)間開(kāi)始的 180 天。按照ISO 8601標(biāo)準(zhǔn)表示,并使用 UTC +0 時(shí)間,格式為 yyyy-MM-ddTHHZ。 默認(rèn)值:無(wú),表示從創(chuàng)建時(shí)間開(kāi)始生效。 | 2020-09-09T02Z |
Period | integer | 否 | SCU 的有效期時(shí)長(zhǎng)。取值范圍:
默認(rèn)值:1。 | 1 |
PeriodUnit | string | 否 | SCU 的有效期時(shí)長(zhǎng)單位。取值范圍:
默認(rèn)值:Month。 | Month |
FromApp | string | 否 | 用于備注請(qǐng)求來(lái)源,默認(rèn)值為 OpenAPI,無(wú)需手動(dòng)設(shè)置。 | OpenAPI |
ClientToken | string | 否 | 保證請(qǐng)求冪等性。從您的客戶端生成一個(gè)參數(shù)值,確保不同請(qǐng)求間該參數(shù)值唯一。 | 123e4567-e89b-12d3-a456-426655440000 |
Amount | integer | 否 | 購(gòu)買的 SCU 的數(shù)量。取值范圍:1~20。 默認(rèn)值:1。 | 1 |
Tag | array<object> | 否 | 標(biāo)簽數(shù)組。數(shù)組長(zhǎng)度:1~20。 | |
object | 否 | 標(biāo)簽列表。 | ||
Key | string | 否 | SCU 的標(biāo)簽鍵。一旦傳入該值,則不允許為空字符串。最多支持 128 個(gè)字符,不能以 | TestKey |
Value | string | 否 | SCU 的標(biāo)簽值。一旦傳入該值,可以為空字符串。最多支持 128 個(gè)字符,不能以 | TestValue |
返回參數(shù)
示例
正常返回示例
JSON
格式
{
"OrderId": "204135153880****",
"RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
"StorageCapacityUnitIds": {
"StorageCapacityUnitId": [
"scu-bp67acfmxazb4p****"
]
}
}
錯(cuò)誤碼
HTTP status code | 錯(cuò)誤碼 | 錯(cuò)誤信息 | 描述 |
---|---|---|---|
400 | InvalidParameter.Period | The specified Period is not valid. | 指定的生效日期無(wú)效。 |
400 | MissingParameter.RegionId | The specified RegionId should not be null. | RegionId是必選參數(shù)。 |
400 | InvalidParameter.Name | The specified Name is invalid. | 指定的 Name 參數(shù)無(wú)效。 |
400 | InvalidParameter.Capacity | The specified Capacity is invalid. | 指定的 Capacity 參數(shù)不在有效取值范圍內(nèi)。 |
400 | MissingParameter.Capacity | The specified Capacity should be not null. | Capacity 為必選參數(shù)。 |
400 | InvalidParameter.PeriodUnit | The specified PeriodUnit is not supported. | 指定的 PeriodUnit 參數(shù)不在有效的取值范圍內(nèi)。 |
400 | InvalidParameter.CapacityExceed | The specified Capacity exceeds the limitation of quota. | 指定的 Capacity 參數(shù)超出了最大有效取值。 |
400 | InvalidStartTime.NotSupported | The specified StartTime should be within 180 calendar days from the current date, and you must specify a precision to hour. | 指定的 StartTime 參數(shù)不在有效取值范圍內(nèi)。 |
400 | InvalidStartTime.MalFormed | The specified StartTime is out of the permitted range. | 指定的 StartTime 參數(shù)超出了最大有效取值。 |
500 | InternalError | The request processing has failed due to some unknown error. | 內(nèi)部錯(cuò)誤,請(qǐng)重試。 |
訪問(wèn)錯(cuò)誤中心查看更多錯(cuò)誤碼。
變更歷史
變更時(shí)間 | 變更內(nèi)容概要 | 操作 |
---|---|---|
2023-07-28 | OpenAPI 描述信息更新、OpenAPI 錯(cuò)誤碼發(fā)生變更 | 查看變更詳情 |