查询商品列表
功能介绍
查询商品列表
调用方法
请参见如何调用API。
URI
GET /v1/{project_id}/products
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
project_id |
是 |
String |
项目ID，获取方法请参考获取项目ID。 |
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
offset |
否 |
Integer |
偏移量，表示从此偏移量开始查询。 |
limit |
否 |
Integer |
每页显示的条目数量。 |
sort_key |
否 |
String |
排序字段，目前只支持create_time。 |
sort_dir |
否 |
String |
排序方式。
默认asc升序。 |
create_until |
否 |
String |
过滤创建时间<=输入时间的记录。 |
create_since |
否 |
String |
过滤创建时间>=输入时间的记录。 |
name |
否 |
String |
按名称模糊查询。 |
tag |
否 |
String |
按标签模糊查询。 |
state |
否 |
String |
按状态查询，多状态使用英文逗号分割。 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
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
参数 |
参数类型 |
描述 |
|---|---|---|
X-Request-Id |
String |
请求ID |
参数 |
参数类型 |
描述 |
|---|---|---|
count |
Integer |
商品信息总数 |
products |
Array of ProductDetailInfo objects |
商品信息列表 |
参数 |
参数类型 |
描述 |
|---|---|---|
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 |
商品状态枚举
|
参数 |
参数类型 |
描述 |
|---|---|---|
asset_id |
String |
资产ID |
cover_url |
String |
封面图片路径。 |
thumbnail_url |
String |
缩略图路径。 |
参数 |
参数类型 |
描述 |
|---|---|---|
asset_id |
String |
资产ID |
asset_type |
String |
资产类型
|
order |
Integer |
资产次序。不设置或者0表示按照加入时间先后排序。业务上将次序最靠前的图片设置为商品封面。 |
asset_name |
String |
资产名称。 |
asset_state |
String |
资产状态。 |
cover_url |
String |
封面图片路径。 |
thumbnail_url |
String |
缩略图路径。 |
main_url |
String |
缩略图路径。 |
状态码： 400
参数 |
参数类型 |
描述 |
|---|---|---|
error_code |
String |
错误码。 |
error_msg |
String |
错误描述。 |
状态码： 500
参数 |
参数类型 |
描述 |
|---|---|---|
error_code |
String |
错误码。 |
error_msg |
String |
错误描述。 |
请求示例
GET https://{endpoint}/v1/6a6a1f8354f64dd9b9a614def7b59d83/products
响应示例
状态码： 200
查询商品列表请求成功
{
"count" : 1,
"products" : [ {
"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 |
内部服务错误。 |
错误码
请参见错误码。
