文档首页/ 数字内容生产线 MetaStudio/ API参考/ 分身视频直播/ 直播商品管理/ 查询商品详情
更新时间：2024-12-12 GMT+08:00
在线调试
CLI示例
查看PDF
分享

查询商品详情

功能介绍

Show product

调用方法

请参见如何调用API。

URI

GET /v1/{project_id}/products/{product_id}

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID，获取方法请参考获取项目ID。

product_id

是

String

商品ID。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

否

String

用户Token。使用Token鉴权方式时必选。

通过调用IAM服务获取用户Token接口获取。

响应消息头中X-Subject-Token的值。

Authorization

否

String

使用AK/SK方式认证时必选，携带的鉴权信息。

X-Sdk-Date

否

String

使用AK/SK方式认证时必选，请求的发生时间。

格式为(YYYYMMDD'T'HHMMSS'Z')。

X-Project-Id

否

String

使用AK/SK方式认证时必选，携带项目ID信息。

X-App-UserId

否

String

第三方用户ID。不允许输入中文。

响应参数

状态码： 200

表3 响应Header参数

参数

参数类型

描述

X-Request-Id

String

请求ID
表4 响应Body参数

参数

参数类型

描述

product_id

String

商品ID

name

String

商品名称

description

String

商品描述

tags

Array of strings

标签。单个标签16字节，多个用逗号分隔，最多50个。

cover

ProductCoverDetailInfo object

商品封面信息

text_list

Array of ProductTextInfo objects

文本列表

asset_list

Array of ProductMediaDetailInfo objects

资产列表,仅支持图片、视频、音频资产

create_time

String

商品创建时间，格式遵循：RFC 3339。 例 “2020-07-30T10:43:17Z”。

update_time

String

商品更新时间，格式遵循：RFC 3339。 例 “2020-07-30T10:43:17Z”。

state

String

商品状态枚举

  • ACTIVED：已激活

  • UNACTIVED：未激活

  • BLOCK: 被冻结，商品不可用

  • DELETED：已删除
表5 ProductCoverDetailInfo

参数

参数类型

描述

asset_id

String

资产ID

cover_url

String

封面图片路径。

thumbnail_url

String

缩略图路径。
表6 ProductTextInfo

参数

参数类型

描述

title

String

文本标题

text

String

文本
表7 ProductMediaDetailInfo

参数

参数类型

描述

asset_id

String

资产ID

asset_type

String

资产类型

  • IMAGE：图片

  • VIDEO：视频

  • AUDIO：音频

order

Integer

参数解释：

资产次序。不设置或者0表示按照加入时间先后排序。业务上将次序最靠前的图片设置为商品封面。

取值范围：

0-300

默认取值：

0

asset_name

String

资产名称。

asset_state

String

资产状态。

cover_url

String

封面图片路径。

thumbnail_url

String

缩略图路径。

main_url

String

缩略图路径。

状态码： 400

表8 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

状态码： 500

表9 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

请求示例

GET https://{endpoint}/v1/6a6a1f8354f64dd9b9a614def7b59d83/products/24bad716-87b1-45e5-8912-6102f7693265

响应示例

状态码： 200

查询商品详情成功

{
  "product_id" : "24bad716-87b1-45e5-8912-6102f7693265",
  "name" : "会议",
  "description" : "会议产品",
  "tags" : [ "华为" ],
  "create_time" : "2021-09-30T10:43:17Z",
  "update_time" : "2021-10-30T12:30:35Z",
  "state" : "CREATING"
}

状态码： 400

{
  "error_code" : "MSS.00000003",
  "error_msg" : "Invalid parameter"
}

状态码： 500

{
  "error_code" : "MSS.00000004",
  "error_msg" : "Internal Error"
}

状态码

状态码

描述

200

查询商品详情成功

400

请求传参异常，包含错误码及对应描述。

500

内部服务错误。

错误码

请参见错误码。

父主题： 直播商品管理