PurchaseReservedStorageCapacity--云服务器-火山引擎

文档中心

立即注册

导航

云服务器

PurchaseReservedStorageCapacity

最近更新时间：2024.08.15 10:37:02首次发布时间：2024.08.15 10:37:02

调用PurchaseReservedStorageCapacity接口创建预留存储容量包。

调试

API Explorer

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

去调试

使用限制

类别	限制
计费方式	预留存储容量包只能抵扣按量计费的云盘。
地域	只能抵扣与预留存储容量包在同一地域同一可用区的云盘。
云盘规格	只能抵扣与预留存储容量包规格相同的云盘，例如ESSD PL0规格的预留存储容量包不能抵扣ESSD FlexPL规格的云盘账单。

请求参数

名称	类型	是否必填	示例值	描述
Action	String	是	PurchaseReservedStorageCapacity	要执行的操作，取值：PurchaseReservedStorageCapacity
ZoneId	String	是	cn-beijing-a	预留存储容量包所在的可用区。说明预留存储容量包所在地域默认为请求的Region，即Header中的Region。
Period	Integer	是	1	预留存储容量包的购买月数，取值范围为1~36。
PeriodUnit	String	是	Month	预留存储容量包的购买时长单位，仅支持取值为monthly，表示购买时长以月为单位。
ReservedStorageCapacityName	String	是	RSC01	预留存储容量包的名称。命名规则如下：不支持以数字、中划线（-）、下划线（_）开头只能包含中文、字母、数字、下划线（_）和中划线（-）。长度限制为1 ~ 128个字符。暂不支持特殊字符。
VolumeType	String	是	ESSD_PL0	预留存储容量包预留的云盘规格，取值说明如下： ESSD_PL0：极速型SSD云盘，PL0规格 ESSD_FlexPL: 极速型SSD云盘，FlexPL规格
ReservedCapacity	Integer	是	50	预留存储容量包的容量，单位为GiB/小时。说明关于预留存储容量包的抵扣规则详细介绍，请参见预留存储容量包。
ClientToken	String	否	333456899ff****	保证请求幂等性。由客户端自动生成一个参数值，确保不同请求间该参数值唯一，避免当调用API超时或服务器内部错误时，客户端多次重试导致重复性操作。说明仅支持ASCII字符，且不能超过64个字符。

返回数据

名称	类型	示例值	描述
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": "2024062414514515A257978E3A55320CEF-11****",
        "Action": "PurchaseReservedStorageCapacity",
        "Version": "2020-04-01",
        "Service": "storage_ebs",
        "Region": "cn-beijing"
    },
    "Result": {
        "OrderNumber": "Order738395864274233****",
        "ReservedStorageCapacityId": "rsc-3vpnts78dk3x35cj****"
    }
}

错误码

HttpCode	错误码	错误信息
400	ErrorRscZoneInvalid	ZoneID不合法。
400	ErrorRscNameInvalid	RSC名称不合法。
400	ErrorRscVolumeTypeNoSupport	云盘类型不支持。
400	ErrorRscSizeInvalid	RSC容量范围不合法。
400	ErrorRscCheckQuotaFailed	超过quota上限。
400	ErrorRscInvalidPeriodUnit	购买周期单元不合法。
400	ErrorRscInvalidPeriod	购买周期不合法。