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

文档中心

立即注册

导航

云服务器

CalculatePrice

最近更新时间：2024.11.01 18:49:26首次发布时间：2024.04.22 18:01:05

调用CalculatePrice接口查询云盘价格。

说明

您可以在执行创建云盘、扩容云盘、更改云盘计费模式、变更云盘规格、续费、退订操作前，调用CalculatePrice接口查询执行这些操作后云盘的价格。

请求参数

名称	类型	是否必填	示例值	描述
Action	String	是	CalculatePrice	要执行的操作，取值：CalculatePrice。
Version	String	是	2020-04-01	API的版本，取值：2020-04-01。
AccountID	Int	否	210000****	账号ID。默认从Cookie获取。
CalculatePriceInfos	Array of Struct	是	-	具体请参见下表“CalculatePriceInfos结构”。

CalculatePriceInfos结构

名称	类型	是否必填	示例值	描述
Count	Int	否	1	云盘个数，默认值为1。
ChargeType	String	是	PrePaid	云盘的付费模式，取值说明如下： PostPaid：按量计费 PrePaid：包年包月
Action	String	是	extend	询价执行的操作，大小写不敏感，取值说明如下： create：创建云盘前询价。 extend：扩容云盘前询价。 modifyChargeType：更改计费模式，例如包年包月云盘改为按量计费云盘。 modifyType：更改云盘规格前询价，例如ESSD PL0改为ESSD FlexPL。 renew：续费前询价。 terminate：退订前询价。注意按量计费云盘不支持`renew`（续费询价）和`terminate`（退订询价）。
Size	Float	否	40	云盘容量，单位GiB。注意在执行创建云盘、扩容云盘、更改云盘计费模式、变更云盘规格操作前询价时，Size参数必填。
VolumeType	String	是	ESSD_FlexPL	云盘规格，取值说明如下： ESSD_PL0：极速型SSD云盘，PL0规格。 ESSD_FlexPL: 极速型SSD云盘，FlexPL规格。
Period	String	否	monthly	云盘购买周期类型，取值说明如下： monthly：按月购买。包年包月仅支持`monthly`。 hourly：按小时购买。按量计费仅支持`hourly`。说明 `Period`和`Times`参数必须一起传入。
Times	Int	否	2	云盘购买时长。例如`Period`设置为`monthly`，`Time`设置为2，表示购买2个月云盘。说明 `Times`和`Period`参数必须一起传入。
EndTime	Int	否	1748361599	云盘到期截止时间，根据时间戳进行转换。注意仅包年包月云盘支持设置`EndTime`参数。退订场景不支持`EndTime`参数。如果同时设置了`EndTime`和`Times`，优先使用`EndTime`。
InstanceID	String	否	i-yci7p7t660awmay7****	ECS实例ID。设置`InstanceID`后，会使用ECS实例的过期时间作为云盘的到期截止时间，无需再设置`EndTime`。注意仅包年包月云盘支持设置`InstanceID`参数。 `InstanceID`和`EndTime`参数只能二选一，同时传入`InstanceID`和`EndTime`参数，会报错。若同时传入`InstanceID`和`Times`，优先使用`InstanceID`对应的实例过期时间。
VolumeKind	String	否	system	云盘类型。取值说明如下： data：数据盘 system：系统盘默认为数据盘。
VolumeID	String	否	vol-ikbsisshogcrntuo****	云盘ID。注意创建云盘前询价无需传入该参数，其他场景必须传入。
Region	String	否	cn-beijing	地域。默认为请求的地域。
ExtraPerformances	Array of Struct	否	-	额外性能包列表。具体请参见下表“ExtraPerformance结构”。

ExtraPerformance结构

名称	类型	是否必填	示例值	描述
ExtraPerformanceType	String	是	IOPS	额外性能的类型。取值如下： Balance：均衡型。 IOPS：IOPS型。 Throughput：吞吐量型。更多信息，请参见配置ESSD FlexPL额外性能。
ExtraPerformanceValue	Int	是	20	额外性能包的性能大小。

名称

类型

是否必填

示例值

描述

ExtraPerformanceType

String

是

IOPS

额外性能的类型。取值如下：

Balance：均衡型。
IOPS：IOPS型。
Throughput：吞吐量型。

更多信息，请参见配置ESSD FlexPL额外性能。

ExtraPerformanceValue

Int

是

额外性能包的性能大小。

返回数据

名称	类型	示例值	说明
OriginalAmount	Float	0.3864	所有云盘总的原价。
DiscountAmount	Float	0.3864	所有云盘总的折扣价。
PayableAmount	Float	0	所有云盘总的应付价。说明查询按量计费云盘的价格时，`PayableAmount`返回为`0`。如果为退订场景，且该场景支持退订退款、云盘规格更配退款或额外性能包降配退款，此时`PayableAmount`显示负余额，则该负余额表示退款金额。
ConfigItems	Array of Struct	-	具体请参见下表“ConfigItems结构”。

ConfigItems结构

名称	类型	示例值	说明
OriginalAmount	Float	0.3864	一个CalculatePriceInfo结构的操作对应云盘总的原价。
DiscountAmount	Float	0.3864	一个CalculatePriceInfo结构的操作对应云盘总的折扣价。
PayableAmount	Float	0	一个CalculatePriceInfo结构的操作对应云盘总的应付价。说明查询按量计费云盘的价格时，`PayableAmount`返回为`0`。
Product	String	volume	云盘对应的商品名，只返回`volume`。
ChargeItems	Array of Struct	-	具体请参见下表“ChargeItems结构”。

ChargeItems结构

名称	类型	示例值	说明
ChargeItemCode	String	EBS_ESSD_FlexPL_cn-beijing	计费项编码。
DiscountAmount	Float	0.3864	每个计费项的折扣价。
OriginalAmount	Float	0.3864	每个计费项的原价。
PayableAmount	Float	0	每个计费项的应付价。说明查询按量计费云盘的价格时，`PayableAmount`返回为`0`。

请求示例

POST /?Action=CalculatePrice&Version=2020-04-01 HTTP/1.1
Host: open.volcengineapi.com
Region: cn-beijing
ServiceName: storage_ebs

"CalculatePriceInfos": [
    {
        "count": 2,
        "size": 92,
        "volumeType": "ESSD_FlexPL",
        "Action": "create",
        "Period": "hourly",
        "times": 1,
        "volumeKind": "data",
        "ChargeType": "PostPaid"
    }
]

返回示例

{
    "ResponseMetadata": {
        "RequestId": "ca91f7ab-3094-44c7-864f-25cb0320****",
        "Action": "CalculatePrice",
        "Version": "2020-04-01",
        "Service": "EBS",
        "Region": "cn-beijing"
    },
    "Result": {
        "ConfigItems": [
            {
                "ChargeItems": [
                    {
                        "ChargeItemCode": "EBS_ESSD_FlexPL_cn-beijing-sdv",
                        "DiscountAmount": 0.3864,
                        "OriginalAmount": 0.3864,
                        "PayableAmount": 0
                    }
                ],
                "DiscountAmount": 0.3864,
                "OriginalAmount": 0.3864,
                "PayableAmount": 0,
                "Product": "volume"
            }
        ],
        "DiscountAmount": 0.3864,
        "OriginalAmount": 0.3864,
        "PayableAmount": 0
    }
}

错误码

HttpCode	错误码	错误信息
400	ChargeTypeNotMatchPeriod	付费模式和付费周期不匹配。
400	InvalidInstanceIDAndEndTime	同时传入了`InstanceID`和`EndTime`，这两个参数只能二选一。
412	InvalidInstanceExpireTime	未查询到实例过期时间或该实例已到期。
412	EmptyRequestList	请求列表为空。
412	PeriodAndTimesNotMatched	只传入了`Period`或`times`参数，这两个参数必须同时传入。
412	InvalidAction	该Action不合法。
412	InvalidActionPostPaid	按量计费云盘不支持该Action。