更新时间:2024-07-15 GMT+08:00
分享

图片列表

功能介绍

图片列表

URI

POST /v1/{project_id}/trace/trace-sweepcode/product-image/list

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

租户从IAM申请到的projectid,一般为32位字符串

最小长度:32

最大长度:64

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token

最小长度:1

最大长度:65535

表3 请求Body参数

参数

是否必选

参数类型

描述

elementName

String

图片名称

最小长度:1

最大长度:255

isDisplay

String

是否展示:0 展示,1 不展示

imageType

String

图片类型:1 品宣,2 banner

枚举值:

  • 1

  • 2

merchant

String

商户ID

最小长度:1

最大长度:100

query

Query object

分页信息

表4 Query

参数

是否必选

参数类型

描述

current

Integer

当前页

最小值:1

最大值:2147483647

缺省值:1

size

Integer

每页的数量

最小值:1

最大值:2147483647

缺省值:10

响应参数

状态码: 200

表5 响应Body参数

参数

参数类型

描述

code

String

返回码

message

String

响应消息

data

data object

图片列表数据

表6 data

参数

参数类型

描述

pageNum

Integer

页数

pageSize

Integer

每页的数量

total

Integer

总数

pages

Integer

总页数

record

Array of record objects

图片详情

表7 record

参数

参数类型

描述

id

String

图片ID

elementName

String

图片名称

elementUrl

String

图片url

imageType

String

图片类型

isDisplay

String

是否展示

merchant

String

商户ID

状态码: 500

表8 响应Body参数

参数

参数类型

描述

error_code

String

错误码

最小长度:1

最大长度:100

error_msg

String

错误描述

最小长度:1

最大长度:100

请求示例

{
  "elementName" : 6666,
  "isDisplay" : "1",
  "imageType" : "2",
  "merchant" : "1759540612045058049",
  "query" : {
    "current" : 1,
    "size" : 2
  }
}

响应示例

状态码: 200

Success

{
  "code" : 200,
  "message" : "操作成功!",
  "data" : {
    "pageNum" : 1,
    "pageSize" : 2,
    "total" : 1,
    "pages" : 1,
    "record" : [ {
      "id" : 1496736284843344000,
      "elementName" : 666666999,
      "elementUrl" : "https://xxx.xxx.xxx.xxx/petaltrace/6BF050A8AA19BB2F0BFA9F2F0529991C.jpg",
      "imageType" : "2",
      "isDisplay" : "1",
      "merchant" : "1759540612045058049"
    } ]
  }
}

状态码: 500

Error response

{
  "code" : "500",
  "message" : "系统异常"
}

状态码

状态码

描述

200

Success

500

Error response

相关文档