文档

GetSubscriptionPrice - 预付费产品询价服务

更新时间:
一键部署

查询预付费产品价格。

接口说明

  1. 调用 QueryProductList 获取产品 code,参见查询产品信息
  2. 调用 DescribePricingModule 接口获取产品的配置参数,参见查询产品模块信息
  3. 根据查询到的产品配置参数调用本接口获取预付费产品的价格。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
bssapi:GetSubscriptionPriceREAD
  • 全部资源
    *
  • bssapi:ProductCode
  • bssapi:ProductType

请求参数

名称类型必填描述示例值
ServicePeriodUnitstring

服务时长单位。取值范围:

  • Year:年。
  • Month:月。
Year
SubscriptionTypestring

订阅类型。取值类型:Subscription(预付费)。

Subscription
ProductCodestring

产品代码。

ecs
OrderTypestring

订单类型。取值范围:

  • NewOrder:新购。
  • Renewal:续费。
  • Upgrade:升级。
NewOrder
ServicePeriodQuantityinteger

服务时长。

1
ProductTypestring

产品类型,是否必输以具体产品的询价文档为准。

ecs
Regionstring

实例所属的 Region ID(地域 ID)。

cn-hangzhou
InstanceIdstring

指定询价的实例 ID,升级场景必须设置,用于获取实例升级前配置。

i-khkjhxxxxxxxxx
Quantityinteger

数量。

1
ModuleListobject []

计价模块列表。

ModuleStatusinteger

仅在订单类型为 Upgrade(升级)时需要,表示此次询价模块变更状态。 取值范围:

  • 1:新增。
  • 2:变更,升级场景如果计价模块的配置发生变化需要显示指定此状态值。

默认值:1。

1
ModuleCodestring

第 n 个计价模块的模块标识。

PackageCode
Tagstring

仅在某些产品的升级变配中需要,代表指定资源的标识。例如:对于磁盘的变配,用 Tag 标识具体磁盘对应的 Id。

213213123
Configstring

第 n 个计价模块的配置,n 的取值范围为(1~50),格式:“AA:aa,BB:bb”,其中 AA,BB 分别为计价模块属性标识,aa,bb 分别为计价模块属性的属性值。

PackageCode:version_1

返回参数

名称类型描述示例值
object
Codestring

状态码。

InvalidConfigCod
Messagestring

错误信息。

Successful
RequestIdstring

请求 ID。

30E7066E-AE6F-4E59-AFE6-11386CE3AFA7
Successboolean

是否成功。

true
Dataobject

产品价格信息。

OriginalPricefloat

原价。

900
DiscountPricefloat

折扣。

100
Currencystring

币种。取值范围:

  • CNY:人民币。
  • USD:美元。
  • JPY:日元。
CNY
Quantityinteger

数量。

1
TradePricefloat

优惠价。

0
ModuleDetailsobject []

计价模块价格详情。

CostAfterDiscountfloat

优惠价。

0
InvoiceDiscountfloat

折扣。

100
UnitPricefloat

单价。

0
OriginalCostfloat

原价。

200
ModuleCodestring

计价模块标识。

PackageCode
PromotionDetailsobject []

优惠详情。

PromotionDescstring

优惠描述。

test
PromotionIdlong

优惠标识。

1021199213
PromotionNamestring

优惠名称。

test

示例

正常返回示例

JSON格式

{
  "Code": "InvalidConfigCod",
  "Message": "Successful",
  "RequestId": "30E7066E-AE6F-4E59-AFE6-11386CE3AFA7",
  "Success": true,
  "Data": {
    "OriginalPrice": 900,
    "DiscountPrice": 100,
    "Currency": "CNY",
    "Quantity": 1,
    "TradePrice": 0,
    "ModuleDetails": {
      "ModuleDetail": [
        {
          "CostAfterDiscount": 0,
          "InvoiceDiscount": 100,
          "UnitPrice": 0,
          "OriginalCost": 200,
          "ModuleCode": "PackageCode"
        }
      ]
    },
    "PromotionDetails": {
      "PromotionDetail": [
        {
          "PromotionDesc": "test",
          "PromotionId": 1021199213,
          "PromotionName": "test"
        }
      ]
    }
  }
}

错误码

访问错误中心查看更多错误码。

  • 本页导读 (0)
文档反馈