调用GetPayAsYouGoPrice查询后付费产品价格。
API描述
1. 调用QueryProductList获取产品code,参见查询产品信息。
2. 调用DescribePricingModule接口获取产品的配置参数,参见查询产品模块信息。
3. 根据查询到的产品配置参数调用本接口获取后付费产品的价格。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
| 名称 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
| Action | String | 是 | GetPayAsYouGoPrice |
系统规定参数。取值:GetPayAsYouGoPrice。 |
| ModuleList.N.Config | String | 是 | InstanceType:ecs.g5.xlarge,IoOptimized:IoOptimized,ImageOs:linux |
第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 | 是 | InstanceType |
第N个计价模块的模块标识(ModuleCode)。 说明 可通过DescribePricingModule接口获取Module参数。
说明 ModuleCode取值参考ModuleList[N].Module.ModuleCode
|
| ModuleList.N.PriceType | String | 是 | Hour |
第n个计价模块的价格类型,取值范围:
说明 可通过DescribePricingModule接口获取Module参数。
说明 ModuleCode取值参考ModuleList[N].Module.PriceType
|
| ProductCode | String | 是 | ecs |
产品编码(ProductCode)。 说明 可通过QueryProductList接口获取。
说明 ProductCode取值参考Product.ProductCode
|
| SubscriptionType | String | 是 | PayAsYouGo |
订阅类型。取值类型:PayAsYouGo(后付费)。 |
| ProductType | String | 否 | ecs |
产品类型(ProductType)。 说明 可通过QueryProductList接口获取。
说明 ProductType取值参考Product.ProductType
|
| Region | String | 否 | cn-hangzhou |
实例所属的 Region ID。不是API的服务地址(region) 说明 可通过DescribePricingModule接口获取Module参数。可能不存在
|
返回数据
| 名称 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| Code | String | Success |
状态码。 |
| Data | Struct |
返回数据。 |
|
| Currency | String | CNY |
币种。取值范围:
|
| ModuleDetails | Array of ModuleDetail |
计价模块价格详情。 |
|
| ModuleDetail | |||
| CostAfterDiscount | Float | 100 |
优惠价。 |
| InvoiceDiscount | Float | 20 |
折扣。 |
| ModuleCode | String | InstanceType |
计价模块标识。 |
| OriginalCost | Float | 1.77 |
原价。 |
| UnitPrice | Float | 0 |
单价。 |
| PromotionDetails | Array of PromotionDetail |
优惠详情。 |
|
| PromotionDetail | |||
| PromotionDesc | String | 仅提供测试使用的1分钱活动 |
优惠描述。 |
| PromotionId | Long | 10200210 |
优惠标识。 |
| PromotionName | String | 仅提供测试使用的1分钱活动 |
优惠名称。 |
| Message | String | Successful |
错误信息。 |
| RequestId | String | 1537A007-72D7-4165-8A26-8694A38E219A |
请求ID。 |
| Success | Boolean | true |
是否成功。 |
示例
请求示例
http(s)://[Endpoint]/?Action=GetPayAsYouGoPrice
&ModuleList.1.Config=InstanceType:ecs.g5.xlarge,IoOptimized:IoOptimized,ImageOs:linux
&ModuleList.1.ModuleCode=InstanceType
&ModuleList.1.PriceType=Hour
&ProductCode=ecs
&SubscriptionType=PayAsYouGo
&<公共请求参数>
正常返回示例
XML格式
<GetPayAsYouGoPriceResponse>
<Message>Successful!</Message>
<RequestId>1537A007-72D7-4165-8A26-8694A38E219A</RequestId>
<Data>
<Currency>CNY</Currency>
<ModuleDetails>
<ModuleDetail>
<UnitPrice>0</UnitPrice>
<ModuleCode>InstanceType</ModuleCode>
<CostAfterDiscount>0.01</CostAfterDiscount>
<OriginalCost>1.77</OriginalCost>
<InvoiceDiscount>1.76</InvoiceDiscount>
</ModuleDetail>
</ModuleDetails>
<PromotionDetails>
<PromotionDetail>
<PromotionName>仅提供测试使用的1分钱活动</PromotionName>
<PromotionId>10200210</PromotionId>
</PromotionDetail>
</PromotionDetails>
</Data>
<Code>Success</Code>
<Success>true</Success>
</GetPayAsYouGoPriceResponse>
JSON格式
{
"Message": "Successful!",
"RequestId": "1537A007-72D7-4165-8A26-8694A38E219A",
"Data": {
"Currency": "CNY",
"ModuleDetails": {
"ModuleDetail": [
{
"UnitPrice": 0,
"ModuleCode": "InstanceType",
"CostAfterDiscount": 0.01,
"OriginalCost": 1.77,
"InvoiceDiscount": 1.76
}
]
},
"PromotionDetails": {
"PromotionDetail": [
{
"PromotionName": "仅提供测试使用的1分钱活动",
"PromotionId": "10200210"
}
]
}
},
"Code": "Success",
"Success": true
}
错误码
访问错误中心查看更多错误码。