文档中心

云服务器

请输入

预留存储容量包

PurchaseReservedStorageCapacity - 购买预留存储容量包

调用PurchaseReservedStorageCapacity接口购买预留存储容量包。

使用说明

预留存储容量包只能抵扣按量计费的云盘。

只能抵扣与预留存储容量包在同一地域同一可用区的云盘。

只能抵扣与预留存储容量包规格相同的云盘，例如ESSD PL0规格的预留存储容量包不能抵扣ESSD FlexPL规格的云盘账单。

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

下方仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

Action string 必选示例值：PurchaseReservedStorageCapacity

要执行的操作，取值：PurchaseReservedStorageCapacity。

Version string 必选示例值：2020-04-01

API的版本，取值：2020-04-01。

ProjectName string 可选示例值：default

RSC 所属项目名称。

ReservedStorageCapacityName string 可选示例值：RSC

预留存储容量包的名称。

ZoneId string 可选示例值：cn-beijing-a

预留存储容量包所在的可用区。

说明

预留存储容量包所在地域默认为请求的Region，即Header中的Region。

VolumeType string 可选示例值：ESSD_PL0

预留存储容量包预留的云盘规格，取值说明如下：

ESSD_PL0：极速型SSD云盘，PL0规格

ESSD_FlexPL: 极速型SSD云盘，FlexPL规格

PeriodUnit string 可选示例值：monthly

预留存储容量包的购买时长单位，仅支持取值为monthly，表示购买时长以月为单位。

ClientToken string 可选示例值：333456899ff****

保证请求幂等性。由客户端自动生成一个参数值，确保不同请求间该参数值唯一，避免当调用API超时或服务器内部错误时，客户端多次重试导致重复性操作。

说明

仅支持ASCII字符，且不能超过64个字符。

Period integer 可选示例值：1

预留存储容量包的购买月数，取值范围为1~36。

ReservedCapacity integer 可选示例值：50

预留存储容量包的容量，单位为GiB/小时。

说明

关于预留存储容量包的抵扣规则详细介绍，请参见预留存储容量包。

EffectiveAt string 可选示例值：2025-11-26 21:44:05

预留存储容量包的生效时间，日期格式遵循ISO 8601标准格式。默认为空，即立即生效。如果指定的生效时间非整点时，则在指定时间的整点生效，例如指定时间为2024-11-25 21:50:05，则实际生效时间为2024-11-25 21:00:00。

返回参数

下方仅列出本接口特有的返回参数。更多信息请参见返回结构。

OrderNumber string 示例值：Order738395864274233****

订单号。

ReservedStorageCapacityId string 示例值：rsc-3vpnts78dk3x35cj****

预留存储容量包ID。

请求示例

GET /?Action=PurchaseReservedStorageCapacity&Version=2020-04-01&Period=1&PeriodUnit=monthly&ZoneId=cn-beijing-a&ReservedStorageCapacityName=RSC01&VolumeType=ESSD_PL0&ReservedCapacity=20 HTTP/1.1​
Host: open.volcengineapi.com​
Region: cn-beijing​
ServiceName: storage_ebs​

返回示例

{​
  "ResponseMetadata": {​
    "RequestId": "202511251604150541181320966C****",​
    "Action": "PurchaseReservedStorageCapacity",​
    "Version": "2020-04-01",​
    "Service": "storage_ebs",​
    "Region": "cn-beijing"​
  },​
  "Result": {​
    "OrderNumber": "Order738395864274233****",​
    "ReservedStorageCapacityId": "rsc-3vpnts78dk3x35cj****"​
  }​
}​

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。

状态码	错误码	错误信息	说明
400	ErrorRscVolumeTypeNoSupport	This volume type does not support creating RSC (additional performance package).	该云盘类型不支持创建RSC。
400	ErrorRscSizeInvalid	The RSC capacity is not within the allowed range.	RSC容量不在允许范围内。
400	ErrorRscZoneInvalid	Please provide a correct zone ID.	请提供正确的可用区ID。
400	ErrorRscNameInvalid	Please provide a correct RSC name.	请提供正确的RSC名字。
400	ErrorRscCheckQuotaFailed	The total capacity of the created RSC exceeds the quota limit.	购买的RSC总容量超过了该云盘规格的Quota限制。
400	ErrorRscInvalidPeriodUnit	The RSC billing cycle unit is invalid, please provide a valid billing cycle unit.	该RSC购买周期不合法，请提供有效的购买周期。
400	ErrorRscInvalidPeriod	The RSC billing cycle is invalid, only 1-36 months are supported.	该RSC购买周期不合法，仅支持购买周期为1-36个月。

最近更新时间：2026.07.13 17:35:41

这个页面对您有帮助吗？

有用

无用