调用GetSubscriptionPrice查询预付费产品价格。
API描述
1. 调用QueryProductList获取产品code,参见查询产品信息。
2. 调用DescribePricingModule接口获取产品的配置参数,参见查询产品模块信息。
3. 根据查询到的产品配置参数调用本接口获取预付费产品的价格。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
| 名称 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
| Action | String | 是 | GetSubscriptionPrice |
系统规定参数。取值:GetSubscriptionPrice。 |
| ModuleList.N.Config | String | 是 | PackageCode:version_1 |
第n个计价模块的配置,N的取值范围为(1~50),格式:“AA:aa,BB:bb”,其中AA,BB分别为计价模块属性标识(ModuleCode),aa,bb分别为计价模块属性的属性值(ModuleValue)。 说明 可通过DescribePricingModule接口获取Module参数。
说明 AA/BB(ModuleCode)取值参考ModuleList[N].Module.ConfigList
说明 aa/bb(ModuleValue)取值参考AttributeList中,Attribute.code等于对应moduleCode的Attribute.Values
|
| ModuleList.N.ModuleCode | String | 是 | PackageCode |
第N个计价模块的模块标识(ModuleCode)。 说明 可通过DescribePricingModule接口获取Module参数。
说明 ModuleCode取值参考ModuleList[N].Module.ModuleCode
|
| OrderType | String | 是 | NewOrder |
订单类型。取值范围:
|
| ProductCode | String | 是 | ecs |
产品编码(ProductCode)。 说明 可通过QueryProductList接口获取。
说明 ProductCode取值参考Product.ProductCode
|
| SubscriptionType | String | 是 | Subscription |
订阅类型。取值类型:Subscription(预付费)。 |
| ModuleList.N.ModuleStatus | Integer | 否 | 1 |
仅在订单类型为Upgrade(升级)时需要,表示此次询价模块变更状态。 取值范围:
默认值:1。 |
| ModuleList.N.Tag | String | 否 | 213213123 |
仅在某些产品的的升级变配中需要,代表指定资源的标识。例如:对于磁盘的变配,用Tag标识具体磁盘对应的Id。 |
| ServicePeriodQuantity | Integer | 否 | 1 |
服务时长。 说明 新购、续费必填
|
| ServicePeriodUnit | String | 否 | Year |
服务时长单位。取值范围:
|
| Region | String | 否 | cn-hangzhou |
实例所属的 Region ID。不是API的服务地址(region) 说明 可通过DescribePricingModule接口获取Module参数。可能不存在
|
| InstanceId | String | 否 | i-khkjhxxxxxxxxx |
指定询价的实例 ID,升级场景必须设置,用于获取实例升级前配置。 |
| ProductType | String | 否 | ecs |
产品类型(ProductType)。 说明 可通过QueryProductList接口获取。
说明 ProductType取值参考Product.ProductType
|
| Quantity | Integer | 否 | 1 |
数量。 |
返回数据
| 名称 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| Code | String | InvalidConfigCod |
状态码。 |
| Data | Struct |
产品价格信息。 |
|
| Currency | String | CNY |
币种。取值范围:
|
| DiscountPrice | Float | 100 |
折扣。 |
| ModuleDetails | Array of ModuleDetail |
计价模块价格详情。 |
|
| ModuleDetail | |||
| CostAfterDiscount | Float | 0 |
优惠价。 |
| InvoiceDiscount | Float | 100 |
折扣。 |
| ModuleCode | String | PackageCode |
计价模块标识。 |
| OriginalCost | Float | 200 |
当前模块原价。 |
| UnitPrice | Float | 0 |
单价。 |
| OriginalPrice | Float | 900 |
本次请求总原价。 |
| PromotionDetails | Array of PromotionDetail |
优惠详情。 |
|
| PromotionDetail | |||
| PromotionDesc | String | test |
优惠描述。 |
| PromotionId | Long | 1021199213 |
优惠标识。 |
| PromotionName | String | test |
优惠名称。 |
| Quantity | Integer | 1 |
数量。 |
| TradePrice | Float | 0 |
优惠价。 |
| Message | String | Successful |
错误信息。 |
| RequestId | String | 30E7066E-AE6F-4E59-AFE6-11386CE3AFA7 |
请求ID。 |
| Success | Boolean | true |
是否成功。 |
示例
请求示例
http(s)://[Endpoint]/?Action=GetSubscriptionPrice
&ModuleList.1.Config=PackageCode:version_1
&ModuleList.1.ModuleCode=PackageCode
&OrderType=NewOrder
&ProductCode=ecs
&SubscriptionType=Subscription
&<公共请求参数>
正常返回示例
XML格式
<GetSubscriptionPriceResponse>
<Data>
<Quantity>1</Quantity>
<DiscountPrice>900</DiscountPrice>
<ModuleDetails>
<ModuleDetail>
<ModuleCode>ExtBandwidth</ModuleCode>
<UnitPrice>0</UnitPrice>
<CostAfterDiscount>0</CostAfterDiscount>
<OriginalCost>800</OriginalCost>
<InvoiceDiscount>800</InvoiceDiscount>
</ModuleDetail>
<ModuleDetail>
<ModuleCode>PackageCode</ModuleCode>
<UnitPrice>0</UnitPrice>
<CostAfterDiscount>0</CostAfterDiscount>
<OriginalCost>100</OriginalCost>
<InvoiceDiscount>100</InvoiceDiscount>
</ModuleDetail>
</ModuleDetails>
<PromotionDetails>
<PromotionDetail>
<PromotionId>1021199213</PromotionId>
<PromotionName></PromotionName>
</PromotionDetail>
</PromotionDetails>
<OriginalPrice>900</OriginalPrice>
<TradePrice>0</TradePrice>
<Currency>CNY</Currency>
</Data>
<RequestId>D6E068C3-25BC-455A-85FE-45F0B22ECB1F</RequestId>
<Success>true</Success>
<Code>Success</Code>
<Message>Successful!</Message>
</GetSubscriptionPriceResponse>
JSON格式
{
"Data": {
"Quantity": 1,
"DiscountPrice": 900,
"ModuleDetails": {
"ModuleDetail": [
{
"ModuleCode": "ExtBandwidth",
"UnitPrice": 0,
"CostAfterDiscount": 0,
"OriginalCost": 800,
"InvoiceDiscount": 800
},
{
"ModuleCode": "PackageCode",
"UnitPrice": 0,
"CostAfterDiscount": 0,
"OriginalCost": 100,
"InvoiceDiscount": 100
}
]
},
"PromotionDetails": {
"PromotionDetail": [
{
"PromotionId": 1021199213,
"PromotionName": ""
}
]
},
"OriginalPrice": 900,
"TradePrice": 0,
"Currency": "CNY"
},
"RequestId": "D6E068C3-25BC-455A-85FE-45F0B22ECB1F",
"Success": true,
"Code": "Success",
"Message": "Successful!"
}
错误码
访问错误中心查看更多错误码。