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

创建商品

功能介绍

Create product

调用方法

请参见如何调用API。

URI

POST /v1/{project_id}/products

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID，获取方法请参考获取项目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。不允许输入中文。
表3 请求Body参数

参数

是否必选

参数类型

描述

name

是

String

商品名称

description

否

String

商品描述

tags

否

Array of strings

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

cover

否

ProductCoverInfo object

商品封面信息

text_list

否

Array of ProductTextInfo objects

文本列表

asset_list

否

Array of ProductMediaInfo objects

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

auto_active

否

Boolean

参数解释：

自动激活商品

默认取值：

true
表4 ProductCoverInfo

参数

是否必选

参数类型

描述

asset_id

否

String

资产ID
表5 ProductTextInfo

参数

是否必选

参数类型

描述

title

否

String

文本标题

text

否

String

文本
表6 ProductMediaInfo

参数

是否必选

参数类型

描述

asset_id

否

String

资产ID

asset_type

否

String

资产类型

  • IMAGE：图片

  • VIDEO：视频

  • AUDIO：音频

order

否

Integer

参数解释：

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

取值范围：

0-300

默认取值：

0

响应参数

状态码： 200

表7 响应Header参数

参数

参数类型

描述

X-Request-Id

String

请求ID
表8 响应Body参数

参数

参数类型

描述

product_id

String

商品ID

状态码： 400

表9 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

状态码： 500

表10 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

请求示例

POST https://{endpoint}/v1/6a6a1f8354f64dd9b9a614def7b59d83/products

{
  "name" : "卡通写实",
  "description" : "卡通写实商品",
  "tags" : [ "华为" ]
}

响应示例

状态码： 200

服务开通成功

{
  "product_id" : "24bad716-87b1-45e5-8912-6102f7693265"
}

状态码： 400

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

状态码： 500

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

状态码

状态码

描述

200

服务开通成功

400

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

500

内部服务错误。

错误码

请参见错误码。

父主题： 直播商品管理