PurchaseStorageCapacityUnit - 购买存储容量单位包 - 云服务器 ECS

本接口用于购买一个或多个存储容量单位包SCU（Storage Capacity Unit）。

接口说明

请确保在使用该接口前，已充分了解存储容量单位包的计费方式和价格。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
ecs:PurchaseStorageCapacityUnit	create	StorageCapacityUnit `acs:ecs:{#regionId}:{#accountId}:scu/`	无	无

请求参数

名称	类型	必填	描述	示例值
RegionId	string	是	SCU 所属的地域 ID。确定地域后，SCU 只能抵扣该地域下云盘的按量付费账单。您可以调用 DescribeRegions 查看最新的阿里云地域列表。	cn-hangzhou
Name	string	否	SCU 的名称，长度为 2~128 个英文或中文字符。必须以大小写字母或中文开头，不能以`http://`或`https://`开头。可以包含数字、半角冒号（:）、下划线（_）或者短划线（-）。	ScuPurchaseDemo
Capacity	integer	是	SCU 容量大小，单位为 GiB。取值范围：20、40、100、200、500、1024、2048、5210、10240、20480、52100。	20
Description	string	否	SCU 的描述信息，长度为 2~256 个英文或中文字符，不能以`http://`或`https://`开头。	ScuPurchaseDemo
StartTime	string	否	SCU 的生效时间。生效时间不能超过创建时间开始的 180 天。按照ISO 8601标准表示，并使用 UTC +0 时间，格式为 yyyy-MM-ddTHHZ。默认值：无，表示从创建时间开始生效。	2020-09-09T02Z
Period	integer	否	SCU 的有效期时长。取值范围：当 PeriodUnit=Month 时，Period 参数的有效取值为 1、2、3、6。当 PeriodUnit=Year 时，Period 参数的有效取值为 1、3、5。默认值：1。	1
PeriodUnit	string	否	SCU 的有效期时长单位。取值范围： Month：月。 Year：年。默认值：Month。	Month
FromApp	string	否	用于备注请求来源，默认值为 OpenAPI，无需手动设置。	OpenAPI
ClientToken	string	否	保证请求幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。`ClientToken`只支持 ASCII 字符，且不能超过 64 个字符。更多信息，请参见如何保证幂等性。	123e4567-e89b-12d3-a456-426655440000
Amount	integer	否	购买的 SCU 的数量。取值范围：1~20。默认值：1。	1
Tag	array<object>	否	标签数组。数组长度：1~20。
	object	否	标签列表。
Key	string	否	SCU 的标签键。一旦传入该值，则不允许为空字符串。最多支持 128 个字符，不能以`aliyun`或`acs:`开头，不能包含`http://`或`https://`。	TestKey
Value	string	否	SCU 的标签值。一旦传入该值，可以为空字符串。最多支持 128 个字符，不能以`acs:`开头，不能包含`http://`或`https://`。	TestValue

返回参数

名称	类型	描述	示例值
	object
OrderId	string	订单 ID。	204135153880****
RequestId	string	请求 ID。	473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
StorageCapacityUnitIds	array	SCU ID。
StorageCapacityUnitId	string	SCU ID。	scu-bp67acfmxazb4p****

示例

正常返回示例

JSON格式

{
  "OrderId": "204135153880****",
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
  "StorageCapacityUnitIds": {
    "StorageCapacityUnitId": [
      "scu-bp67acfmxazb4p****"
    ]
  }
}

错误码

HTTP status code	错误码	错误信息	描述
400	InvalidParameter.Period	The specified Period is not valid.	指定的生效日期无效。
400	MissingParameter.RegionId	The specified RegionId should not be null.	RegionId是必选参数。
400	InvalidParameter.Name	The specified Name is invalid.	指定的 Name 参数无效。
400	InvalidParameter.Capacity	The specified Capacity is invalid.	指定的 Capacity 参数不在有效取值范围内。
400	MissingParameter.Capacity	The specified Capacity should be not null.	Capacity 为必选参数。
400	InvalidParameter.PeriodUnit	The specified PeriodUnit is not supported.	指定的 PeriodUnit 参数不在有效的取值范围内。
400	InvalidParameter.CapacityExceed	The specified Capacity exceeds the limitation of quota.	指定的 Capacity 参数超出了最大有效取值。
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 参数不在有效取值范围内。
400	InvalidStartTime.MalFormed	The specified StartTime is out of the permitted range.	指定的 StartTime 参数超出了最大有效取值。
500	InternalError	The request processing has failed due to some unknown error.	内部错误，请重试。

访问错误中心查看更多错误码。

变更历史

变更时间	变更内容概要	操作
2023-07-28	OpenAPI 描述信息更新、OpenAPI 错误码发生变更	查看变更详情