API 中心

数字工厂底座

地市云

查询商品价格

最近更新时间：11/9/2023, 4:18:16 PM作者：andrewren(任豪)

本页目录：

接口描述

接口请求域名：http://product-mgmt-api.{工业环境域名}

接口类型：OpenAPI

接口请求方式：POST

接口名：DescribeProductPriceInfo

本接口用于查询商品价格。

输入参数

参数名称 必选 类型 描述
Action 是 String openapi公共参数，本接口取值：DescribeProductPriceInfo
ProductUuid 是 string 商品uuid
InstanceUuid 是 string 实例uuid
SpecUuid 是 string 规格uuid
TimeSpan 是 Integer 时长
TimeUnit 是 string 时间单位，支持y/m/d/t
CustomSaleSpecs 否 Array of CustomSaleSpecs 自定义计费项，v5.4之后使用

CustomSaleSpecs

参数名称 必选 类型 描述
CustomUuid 否 String 自定义计费项uuid
Type 否 String 自定义计费项类型
Value 否 String 自定义计费项值,数量型的数量，枚举型的名称
UintType 否 String 数量型范围 min：最小限制，greater:大于等于

输出参数

Response

参数名称 类型 描述
RequestId String 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId
SurplusPrice Integer 剩余价值
TargetPrice Integer 目标价值
RenewMonthPrice Integer 续费月价格
RenewYearPrice Integer 续费年价格
TotalPrice Integer 总价值

示例

示例1 请求例子

输入示例

{
          "Action":"DescribeProductPriceInfo",
        "ProductUuid":"iop_third",
        "InstanceUuid":"",
        "SpecUuid":"iop_third",
        "TimeSpan":1,
        "TimeUnit":""
}

输出示例

{
  "Response": {
    "RequestId": "string",
    "SurplusPrice": 3,
    "TargetPrice": 3,
    "RenewMonthPrice": 3,
    "RenewYearPrice": 3,
    "TotalPrice": 3
  }
}

错误码

以下仅列出了接口业务逻辑相关的错误码

错误码 描述