API 中心

数字工厂底座

地市云

查询商品列表

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

本页目录：

接口描述

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

接口类型：OpenAPI

接口请求方式：POST

接口名：DescribeProducts

本接口用于查询商品列表。

输入参数

参数名称 必选 类型 描述
Action 是 String openapi公共参数，本接口取值：DescribeProducts
Offset 否 Integer 偏移量，默认为0
Limit 否 Integer 限制数目，默认为20
SortSet 否 Array of Object 排序，SortSet.Key string排序字段，SortSet.Direction string排序支持desc、asc
ProductSourceSet 否 Array of String 商品来源, 取值: yun: 腾讯云市场 sp: 地市运营商 iop_third: 第三方服务商
ProductTypes 否 Array of String 商品类型，取值: cvm: 云主机 cbs: 云硬盘 ip: 公网ip
CategoryUuid 否 String 商品类目uuid，查询该类目及其子类目商品，v5.4之前使用
CategoryUuids 否 Array of String 商品类目筛选，查询多个类目及其子类目商品，v5.4新增，返回CategoryUuid和CategoryUuids全部类目及其子类目
DeliverTypes 否 Array of String 交付方式：SAAS，MANUAL
Historical 否 Boolean 是否包含已删除商品
ProductName 否 String 商品名，模糊匹配，%name%
BidSet 否 Array of Integer 万应:1001 WESHAPE:1002
TagSet 否 Array of String 商品标签
IsvUins 否 Array of String 服务商uin

输出参数

Response

参数名称 类型 描述
RequestId String 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId
Total Integer 总记录数
ProductInfos Array of ProductInfos 商品列表

ProductInfos

参数名称 类型 描述
ProductUuid String 商品uuid
CategoryName String 类目名称
Logo String logo
CreateTime Integer 创建时间戳(s)
LocalPublishState String 地市侧发布状态： 上下架 default/published/offline
PublishTime Integer 最新发布时间戳
Price Integer 价格，单位分
Disprice Integer 折后价格，单位分
MinPrice Integer 最小价格
OwnerUin Integer 服务商uin
IsvName String 服务商名称
DeleteFlag boolean 是否已删除
NeedStock boolean 是否需要库存
StockCount Integer 总库存
SurplusStock Integer 剩余库存
SpPriceFlag boolean 是否允许修改价格
ProductSource String 商品来源, 取值: yun: 腾讯云市场 sp: 地市运营商 iop_third: 第三方服务商
Bid Integer bid值 -服务商ID
ProductName String 商品名称
CategoryUuid String 商品类目uuid
Categories Array of Categories 商品类目列表
TagSet Array of String 商品标签列表
ProtocolId Integer 服务协议id
Optional Optional 业务侧扩展信息
SaleSpecs Array of SaleSpecs 售卖规格及价格
LocalSaleSpecs Array of LocalSaleSpecs 售卖规格及价格
Illustrations Array of String 商品配图
Summary String 商品简介
Documents Array of Documents 商品文档
Detail String 详情
DeliverType String 交付方式：SAAS，MANUAL
DeliveryTime Integer 交付时长
DeliverConfig DeliverConfig SAAS发货配置
LoginType String 可选值：idaas , password , none

Categories

参数名称 类型 描述
CategoryUuid String 类目uuid
CategoryName String 类目名称

Optional

参数名称 类型 描述
Optional1 String 扩展信息1
Optional2 Array of String 扩展信息2

SaleSpecs

参数名称 类型 描述
SpecUuid String 规格uuid
Name String 规格名称
RenewPrice RenewPrice 续费价格
OnTry boolean 是否允许试用
TrialDays Integer 试用天数
OnOffer boolean 上架状态
Order Integer 排序序号
ExtendInfo String 额外信息
PriceCycles Array of PriceCycles 售卖周期
CustomSaleSpecs Array of CustomSaleSpecs 额外计费项

RenewPrice

参数名称 类型 描述
RenewMonthPrice Integer 续费一个月价格, 单位分
RenewYearPrice Integer 续费一年价格, 单位分

PriceCycles

参数名称 类型 描述
CycleValue CycleValue 周期
Price Integer 价格，单位分
Disprice Integer 折后价格，单位分

CustomSaleSpecs

参数名称 类型 描述
CustomUuid String 自定义计费项uuid
Name String 自定义计费项名称
NameEn String 自定义计费项英文名称
Uint String 自定义计费项单位
CustomSaleSpecTypes Array of CustomSaleSpecTypes 额外计费项

CycleValue

参数名称 类型 描述
TimeSpan Integer 时长
TimeUnit String 时间单位，支持y/m/d/t

CustomSaleSpecTypes

参数名称 类型 描述
Value String 额外计费项值，数量型的数量，枚举型的名称
Type String 额外计费项类型，数量型：number，枚举型：enum
UintType String 数量型范围 min：最小限制，greater:大于等于
RenewMonthPrice Integer 续费一月价格, 单位分
RenewYearPrice Integer 续费一年价格, 单位分
NewPriceCycles Array of NewPriceCycles 额外计费项

NewPriceCycles

参数名称 类型 描述
Disprice Integer 价格，单位分
CycleValue CycleValue 周期

CycleValue

参数名称 类型 描述
TimeSpan Integer 时长
TimeUnit String 时间单位，支持y/m/d/t

Documents

参数名称 类型 描述
Name String 文档名称
Url String 文档地址

LocalSaleSpecs

参数名称 类型 描述
SpecUuid String 规格uuid
Name String 规格名称
RenewMonthPrice Integer 续费一个月价格, 单位分
RenewYearPrice Integer 续费一年价格, 单位分
OnTrial bool 是否允许试用
TrialDays Integer 试用天数
OnOffer boolean 上架状态
MaxQuota Integer 规格数
Order Integer 排序序号
ExtendInfo String 额外信息
PriceCycles Array of PriceCycles 售卖周期

示例

示例1 请求例子

输入示例

{
        "Action":"DescribeProducts",                
        "Offset":0,
        "Limit":10,
        "CategoryUuid": "ewwdd4434-fefre"
}

输出示例

{
   "Response": {
     "RequestId": "string",
     "Total": 3,
     "ProductInfos": [
       {
         "ProductUuid": "string",
         "CategoryName": "string",
         "Logo": "string",
         "CreateTime": 3,
         "LocalPublishState": "string",
         "PublishState": "string",
         "PublishTime": 3,
         "Price": 3,
         "Disprice": 3,
         "MinPrice": 3,
         "OwnerUin": 3,
         "IsvName": "string",
         "DeleteFlag": true,
         "NeedStock": true,
         "StockCount": 3,
         "SurplusStock": 3,
         "SpPriceFlag": true,
         "ProductSource": "string",
         "Bid": 3,
         "ProductName": "string",
         "CategoryUuid": "string",
         "Categories": [
           {
             "CategoryUuid": "string",
             "CategoryName": "string"
           }
         ],
         "TagSet": [
           "string"
         ],
         "ProtocolId": 3,
         "Optional": {
           "Optional1": "string",
           "Optional2": [
             "string"
           ]
         },
         "SaleSpecs": [
           {
             "SpecUuid": "string",
             "Name": "string",
             "RenewPrice": {
               "RenewMonthPrice": 3,
               "RenewYearPrice": 3
             },
             "OnTry": true,
             "TrialDays": 3,
             "OnOffer": true,
             "Order": 3,
             "ExtendInfo": "string",
             "PriceCycles": [
               {
                 "CycleValue": {
                   "TimeSpan": 3,
                   "TimeUnit": "string"
                 },
                 "Price": 3,
                 "Disprice": 3
               }
             ],
             "CustomSaleSpecs": [
               {
                 "CustomUuid": "string",
                 "Name": "string",
                 "NameEn": "string",
                 "Uint": "string",
                 "CustomSaleSpecTypes": [
                   {
                     "Value": "string",
                     "Type": "string",
                     "UintType": "string",
                     "RenewMonthPrice": 3,
                     "RenewYearPrice": 3,
                     "NewPriceCycles": [
                       {
                         "Disprice": 3,
                         "CycleValue": {
                           "TimeSpan": 3,
                           "TimeUnit": "string"
                         }
                       }
                     ]
                   }
                 ]
               }
             ]
           }
         ],
         "LocalSaleSpecs": [
           {
             "SpecUuid": "string",
             "Name": "string",
             "RenewPrice": {
               "RenewMonthPrice": 3,
               "RenewYearPrice": 3
             },
             "OnTry": true,
             "TrialDays": 3,
             "OnOffer": true,
             "Order": 3,
             "PriceCycles": [
               {
                 "CycleValue": {
                   "TimeSpan": 3,
                   "TimeUnit": "string"
                 },
                 "Price": 3,
                 "Disprice": 3
               }
             ]
           }
         ],
         "Illustrations": [
           "string"
         ],
         "Summary": "string",
         "Documents": [
           {
             "Name": "string",
             "Url": "string"
           }
         ],
         "Detail": "string",
         "DeliverType": "string",
         "DeliveryTime": 3,
         "DeliverConfig": {
           "DeliverUrl": "string",
           "DeliverToken": "string"
         },
         "LoginType": "idaas"
       }
     ]
   }
 }

错误码

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

错误码 描述