GetApiPrice - 根据 OpenAPI 入参查询价格

更新时间:
复制 MD 格式

根据目标 OpenAPI 及其调用参数查询价格

调试

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

调试

授权信息

当前API暂无授权信息透出。

请求语法

POST /api/v1/price/quote HTTP/1.1

请求参数

名称

类型

必填

描述

示例值

body

object

否

询价请求体,使用 JSON 对象提交,包含以下字段:

  • popCode(必填):目标 OpenAPI 所属产品的代码,例如 Ecs。

  • popVersion(必填):目标 OpenAPI 的 API 版本,例如 2014-05-26。

  • apiName(必填):目标 OpenAPI 的名称,例如 CreateDisk。以上三项共同确定要询价的目标 API。

  • parameters(必填,JSON 对象):目标 API 的请求参数组合,即希望估算费用的那次 API 调用所使用的业务参数。参数名称、类型和组织格式应参照目标 API 的文档填写。应提供本次报价所需的配置,例如地域、资源规格、容量、数量、购买时长和付费方式等;具体参数取决于目标 API。缺少计价所需参数可能导致无法报价。

  • language(可选):结果消息的语言,zh 表示中文,en 表示英文,默认值为 zh。

例如,popCode=Ecs、popVersion=2014-05-26、apiName=CreateDisk 时,parameters 应填写 ECS CreateDisk 的参数组合。本页示例中的 RegionId、ZoneId、DiskCategory 和 Size 分别指定待询价云盘的地域、可用区、类型和容量。这些业务参数放在 parameters 对象中,popCode、popVersion、apiName 和 language 放在请求体顶层。

GetApiPrice 根据这些配置查询价格,不执行目标 API 的创建、修改等资源操作;上述示例不会实际创建云盘。

{"popCode":"Ecs","popVersion":"2014-05-26","apiName":"CreateDisk","parameters":{"RegionId":"cn-hangzhou","ZoneId":"cn-hangzhou-i","DiskCategory":"cloud_essd","Size":40},"language":"zh"}

返回参数

名称

类型

描述

示例值

object

本次询价的返回结果,包含结果码、结果说明、报价数据和请求 ID。

code

string

询价结果码。Success 表示询价成功;PricingNotRequired 表示该 API 调用不产生费用、无需询价;PricingNotSupported 表示该 API 或本次参数组合暂不支持询价。其他值可结合 message 查看失败原因。

Success

message

string

本次询价的结果说明。消息语言由请求体中的 language 指定,默认使用中文。

询价成功。

price

object

报价数据。先检查 price.success;为 true 时,可读取 totalAmount、billingUnit 和 usageCharges 展示报价,读取 priceSummary 或 components 查看费用明细。无需询价或不支持询价时,本字段不返回。

billingUnit

string

固定费用的计费单位,适用于 totalAmount、originalAmount 和 discountAmount,例如 Hour(每小时)、1 Month(每月)。本次报价未提供计费单位时为空。本字段仅描述固定费用的单位;按实际用量计费的费用单位见 usageCharges[].unit。

1 Month

calculatedAmount

number

组合计价或差额计价得到的固定费用金额。返回有效金额时,与 totalAmount 相等;调用方可统一读取 totalAmount 作为最终报价。

28.89

chargeComposition

string

整次询价的费用构成:recurring_only 表示仅有固定费用;usage_only 表示仅有按实际用量计费的费用;mixed 表示两者都有。usage_only 时,totalAmount 为 0 表示没有固定费用,使用仍按实际用量计费,单价见 usageCharges。mixed 时,应分别展示固定费用和用量单价。

recurring_only

components

object

组合计价或差额计价所涉及的各份报价,例如实例与存储的报价,或原配置与新配置的报价。对象中的名称用于区分不同报价,具体名称以实际返回结果为准。本字段用于查看费用构成,整次询价的最终报价见 totalAmount,用量单价可统一从外层 usageCharges 读取。普通单次报价时,本字段为空或不返回。

object

一份分项报价的详细信息,可查看该份报价的金额、费用构成及用量单价。

chargeComposition

string

本份报价的费用构成:recurring_only 表示仅有固定费用;usage_only 表示仅有按实际用量计费的费用;mixed 表示两者都有。仅有用量费用时,固定费用为 0,使用仍按实际用量计费。本字段只描述当前这份报价,整次询价的费用构成见 price.chargeComposition。

recurring_only

currency

string

本份报价的币种,例如 CNY 表示人民币。

CNY

effectiveModuleSum

number

按 quantity 计算后的固定费用折后合计金额,即 moduleSum × quantity。不包含按实际用量计费的费用。最终报价请读取 price.totalAmount。

59.86

moduleSum

number

本份报价的固定费用折后合计金额,尚未乘以 quantity。不包含按实际用量计费的费用。

59.86

modules

array<object>

本份报价中各费用项目的明细列表,例如实例、磁盘和网络费用。

object

billingMode

string

本项费用的计费方式:recurring 表示按时间周期计费,计入固定费用;usage 表示按实际用量计费,不计入固定费用,单价见 usageCharges[].pricePerUnit。

recurring

costAfterDiscount

number

本项费用的折后金额。周期计费项表示本次报价对应的周期费用。用量计费项中,quantityUsedForQuote 有值时,表示该数量的合计费用;每单位用量的价格请读取对应的 usageCharges[].pricePerUnit。

19.86

invoiceDiscount

number

本项费用的优惠金额。未提供时为空;字段为空不表示没有优惠。

25.28

moduleCode

string

费用项目的编码,例如 InstanceType。可通过此编码对应 modules 与 usageCharges 中的费用项目。

InstanceType

originalCost

number

本项费用的折前金额,与 costAfterDiscount 对应。

45.14

quantityUsedForQuote

number

本项费用报价所对应的用量数量。有值时,costAfterDiscount 表示该数量的合计费用。该数量用于解释报价金额,实际费用取决于实际用量;每单位用量的价格见 usageCharges[].pricePerUnit。

1000

unitPrice

number

本项费用的单价。未提供时为空;字段为空不表示免费。按实际用量计费的单价请读取 usageCharges[].pricePerUnit。

usageUnit

string

按实际用量计费时的用量单位,例如 GB、CU,与对应 usageCharges[].unit 一致。每单位用量的价格见 usageCharges[].pricePerUnit。

CU

originalPrice

number

本份报价的折前金额。比较优惠时,应使用币种、计费周期、数量和费用范围一致的折后金额。未提供原价信息时为空。

176.0

pricingUnit

string

计费单位,例如 Hour(每小时)、1 Month(每月)、12 Month(每 12 个月)或 GB·Month(GB·月),用于说明 moduleSum 对应的计费单位。本次报价未提供该单位时为空。

1 Month

quantity

number

计算本份报价固定费用所用的数量,默认值为 1。effectiveModuleSum = moduleSum × quantity。报价金额已包含所需数量时,本字段为 1,调用方无需再乘资源数量。

1

tradePrice

number

本份报价的折后交易金额,未提供时为空。整次询价的最终报价请读取 price.totalAmount。

176.0

usageCharges

array<object>

本份报价中按实际用量计费的单价列表。每条记录说明费用项目、用量单位及单价;对应费用不计入 moduleSum 或 effectiveModuleSum。没有用量计费项目时为空或不返回。

object

assumedQuantity

number

本条费用估算采用的预计用量,单位见 unit。有值时同时返回 assumedQuantityCost;该数量用于估算,实际费用取决于实际用量。

1000

assumedQuantityCost

number

按预计用量计算的费用,即 pricePerUnit × assumedQuantity。该金额仅供估算,不计入 totalAmount;实际费用取决于实际用量。

195.5

moduleCode

string

费用项目的编码,例如 TrafficOut、NatCu,可与报价明细 modules 中的 moduleCode 对应。

NatCu

originalPricePerUnit

number

每单位用量的折前价格,用量单位见 unit,币种见 price.currency。未提供时为空;与 pricePerUnit 的差额为每单位用量的优惠金额。

0.23

pricePerUnit

number

每单位用量的折后价格,用量单位见 unit,币种见 price.currency。可按 pricePerUnit × 预计用量估算费用;这部分费用不计入 totalAmount。

0.1955

unit

string

用量单位,例如 GB、CU、万次。pricePerUnit 表示每单位用量的价格。

CU

currency

string

本次报价的币种,例如 CNY 表示人民币。

CNY

discountAmount

number

固定费用的优惠金额,即 originalAmount - totalAmount,仅在两者都有值时返回。为 0 表示两者金额相等;为空时不能据此判断是否有优惠。按实际用量计费的费用优惠不计入本字段。

25.28

errorCode

string

报价失败的错误码,例如 InvalidParameter。price.success 为 true 时,本字段为空。

InvalidParameter

errorMessage

string

报价失败的原因说明,可结合 errorCode 检查参数或定位问题。price.success 为 true 时,本字段为空。

参数值不符合要求,请检查请求参数。

originalAmount

number

本次普通单次报价中固定费用的折前金额,币种见 currency,计费单位见 billingUnit。报价成功且提供原价信息时返回;组合计价、差额计价或无法提供原价时为空。按实际用量计费的折前单价见 usageCharges[].originalPricePerUnit。

85.14

priceSummary

object

普通单次询价的报价明细,包含本份报价的金额、计费单位、费用构成及用量单价。组合计价或差额计价时,本字段不返回,请查看 components。整次询价的最终报价见 totalAmount,用量单价也可统一从外层 usageCharges 读取。

chargeComposition

string

本份报价的费用构成:recurring_only 表示仅有固定费用;usage_only 表示仅有按实际用量计费的费用;mixed 表示两者都有。仅有用量费用时,固定费用为 0,使用仍按实际用量计费。本字段只描述当前这份报价,整次询价的费用构成见 price.chargeComposition。

recurring_only

currency

string

本份报价的币种,例如 CNY 表示人民币。

CNY

effectiveModuleSum

number

按 quantity 计算后的固定费用折后合计金额,即 moduleSum × quantity。不包含按实际用量计费的费用。最终报价请读取 price.totalAmount。

59.86

moduleSum

number

本份报价的固定费用折后合计金额,尚未乘以 quantity。不包含按实际用量计费的费用。

59.86

modules

array<object>

本份报价中各费用项目的明细列表,例如实例、磁盘和网络费用。

object

billingMode

string

本项费用的计费方式:recurring 表示按时间周期计费,计入固定费用;usage 表示按实际用量计费,不计入固定费用,单价见 usageCharges[].pricePerUnit。

recurring

costAfterDiscount

number

本项费用的折后金额。周期计费项表示本次报价对应的周期费用。用量计费项中,quantityUsedForQuote 有值时,表示该数量的合计费用;每单位用量的价格请读取对应的 usageCharges[].pricePerUnit。

19.86

invoiceDiscount

number

本项费用的优惠金额。未提供时为空;字段为空不表示没有优惠。

25.28

moduleCode

string

费用项目的编码,例如 InstanceType。可通过此编码对应 modules 与 usageCharges 中的费用项目。

InstanceType

originalCost

number

本项费用的折前金额,与 costAfterDiscount 对应。

45.14

quantityUsedForQuote

number

本项费用报价所对应的用量数量。有值时,costAfterDiscount 表示该数量的合计费用。该数量用于解释报价金额,实际费用取决于实际用量;每单位用量的价格见 usageCharges[].pricePerUnit。

1000

unitPrice

number

本项费用的单价。未提供时为空;字段为空不表示免费。按实际用量计费的单价请读取 usageCharges[].pricePerUnit。

usageUnit

string

按实际用量计费时的用量单位,例如 GB、CU,与对应 usageCharges[].unit 一致。每单位用量的价格见 usageCharges[].pricePerUnit。

CU

originalPrice

number

本份报价的折前金额。比较优惠时,应使用币种、计费周期、数量和费用范围一致的折后金额。未提供原价信息时为空。

176.0

pricingUnit

string

计费单位,例如 Hour(每小时)、1 Month(每月)、12 Month(每 12 个月)或 GB·Month(GB·月),用于说明 moduleSum 对应的计费单位。本次报价未提供该单位时为空。

1 Month

quantity

number

计算本份报价固定费用所用的数量,默认值为 1。effectiveModuleSum = moduleSum × quantity。报价金额已包含所需数量时,本字段为 1,调用方无需再乘资源数量。

1

tradePrice

number

本份报价的折后交易金额,未提供时为空。整次询价的最终报价请读取 price.totalAmount。

176.0

usageCharges

array<object>

本份报价中按实际用量计费的单价列表。每条记录说明费用项目、用量单位及单价;对应费用不计入 moduleSum 或 effectiveModuleSum。没有用量计费项目时为空或不返回。

object

assumedQuantity

number

本条费用估算采用的预计用量,单位见 unit。有值时同时返回 assumedQuantityCost;该数量用于估算,实际费用取决于实际用量。

1000

assumedQuantityCost

number

按预计用量计算的费用,即 pricePerUnit × assumedQuantity。该金额仅供估算,不计入 totalAmount;实际费用取决于实际用量。

195.5

moduleCode

string

费用项目的编码,例如 TrafficOut、NatCu,可与报价明细 modules 中的 moduleCode 对应。

NatCu

originalPricePerUnit

number

每单位用量的折前价格,用量单位见 unit,币种见 price.currency。未提供时为空;与 pricePerUnit 的差额为每单位用量的优惠金额。

0.23

pricePerUnit

number

每单位用量的折后价格,用量单位见 unit,币种见 price.currency。可按 pricePerUnit × 预计用量估算费用;这部分费用不计入 totalAmount。

0.1955

unit

string

用量单位,例如 GB、CU、万次。pricePerUnit 表示每单位用量的价格。

CU

pricingMode

string

本次询价的计价方式:single 表示普通单次报价,明细见 priceSummary;composite 表示组合多份报价计算费用;delta 表示计算配置变更前后的费用差额。后两种方式的明细见 components。

single

success

boolean

是否成功取得可用报价。仅为 true 时,才应使用本字段所在 price 对象中的报价金额。

totalAmount

number

本次询价的固定费用最终金额,币种见 currency,计费单位见 billingUnit。仅在 price.success 为 true 时使用。按实际用量计费的费用不计入本字段,其单价见 usageCharges,费用构成见 chargeComposition。调用方应直接读取本字段作为整次询价的最终报价。

59.86

upstreamRequestId

string

本次报价请求的标识,可用于对账及问题排查。报价成功或失败时均可能返回。GetApiPrice 调用本身的请求 ID 见响应顶层 requestId。

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

usageCharges

array<object>

整次询价的用量单价列表,例如每 GB 流量、每 CU 的价格。这部分费用按实际用量另行计算,不计入 totalAmount。普通单次报价时,与 priceSummary.usageCharges 内容相同;有多份分项报价时,汇集 components 中各份报价的用量单价。外层与明细中的同一条费用应避免重复计算。没有用量计费项目时为空或不返回。

object

assumedQuantity

number

本条费用估算采用的预计用量,单位见 unit。有值时同时返回 assumedQuantityCost;该数量用于估算,实际费用取决于实际用量。

1000

assumedQuantityCost

number

按预计用量计算的费用,即 pricePerUnit × assumedQuantity。该金额仅供估算,不计入 totalAmount;实际费用取决于实际用量。

195.5

moduleCode

string

费用项目的编码,例如 TrafficOut、NatCu,可与报价明细 modules 中的 moduleCode 对应。

NatCu

originalPricePerUnit

number

每单位用量的折前价格,用量单位见 unit,币种见 price.currency。未提供时为空;与 pricePerUnit 的差额为每单位用量的优惠金额。

0.23

pricePerUnit

number

每单位用量的折后价格,用量单位见 unit,币种见 price.currency。可按 pricePerUnit × 预计用量估算费用;这部分费用不计入 totalAmount。

0.1955

unit

string

用量单位,例如 GB、CU、万次。pricePerUnit 表示每单位用量的价格。

CU

requestId

string

本次 GetApiPrice 调用的请求 ID,可用于问题排查。

473469C7-AA6F-4DC5-B3DB-A3DC0DE3****

success

boolean

是否取得有效的费用结论。成功报价或确认无需询价时为 true;不支持询价或报价失败时为 false。使用具体报价金额前,还应检查 price.success。

示例

正常返回示例

JSON格式

{
  "code": "Success",
  "message": "询价成功。",
  "price": {
    "billingUnit": "1 Month",
    "calculatedAmount": 28.89,
    "chargeComposition": "recurring_only",
    "components": {
      "key": {
        "chargeComposition": "recurring_only",
        "currency": "CNY",
        "effectiveModuleSum": 59.86,
        "moduleSum": 59.86,
        "modules": [
          {
            "billingMode": "recurring",
            "costAfterDiscount": 19.86,
            "invoiceDiscount": 25.28,
            "moduleCode": "InstanceType",
            "originalCost": 45.14,
            "quantityUsedForQuote": 1000,
            "unitPrice": 0,
            "usageUnit": "CU"
          }
        ],
        "originalPrice": 176,
        "pricingUnit": "1 Month",
        "quantity": 1,
        "tradePrice": 176,
        "usageCharges": [
          {
            "assumedQuantity": 1000,
            "assumedQuantityCost": 195.5,
            "moduleCode": "NatCu",
            "originalPricePerUnit": 0.23,
            "pricePerUnit": 0.1955,
            "unit": "CU"
          }
        ]
      }
    },
    "currency": "CNY",
    "discountAmount": 25.28,
    "errorCode": "InvalidParameter",
    "errorMessage": "参数值不符合要求,请检查请求参数。",
    "originalAmount": 85.14,
    "priceSummary": {
      "chargeComposition": "recurring_only",
      "currency": "CNY",
      "effectiveModuleSum": 59.86,
      "moduleSum": 59.86,
      "modules": [
        {
          "billingMode": "recurring",
          "costAfterDiscount": 19.86,
          "invoiceDiscount": 25.28,
          "moduleCode": "InstanceType",
          "originalCost": 45.14,
          "quantityUsedForQuote": 1000,
          "unitPrice": 0,
          "usageUnit": "CU"
        }
      ],
      "originalPrice": 176,
      "pricingUnit": "1 Month",
      "quantity": 1,
      "tradePrice": 176,
      "usageCharges": [
        {
          "assumedQuantity": 1000,
          "assumedQuantityCost": 195.5,
          "moduleCode": "NatCu",
          "originalPricePerUnit": 0.23,
          "pricePerUnit": 0.1955,
          "unit": "CU"
        }
      ]
    },
    "pricingMode": "single",
    "success": true,
    "totalAmount": 59.86,
    "upstreamRequestId": "30E7066E-AE6F-4E59-AFE6-11386CE3AFA7",
    "usageCharges": [
      {
        "assumedQuantity": 1000,
        "assumedQuantityCost": 195.5,
        "moduleCode": "NatCu",
        "originalPricePerUnit": 0.23,
        "pricePerUnit": 0.1955,
        "unit": "CU"
      }
    ]
  },
  "requestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3****",
  "success": true
}

错误码

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

变更历史

更多信息,参考变更详情。