ListItems - 获取列表项

查询实例物品池。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

当前API暂无授权信息透出。

请求语法

POST /v2/openapi/instances/{instanceId}/items/actions/list HTTP/1.1

请求参数

名称

类型

必填

描述

示例值

instanceId

string

实例 ID

airec-test

strategyUsed

boolean

默认 false,传入 true 则使用置顶/定坑侧逻辑,但是必须在 body 中传入 sceneId

false

withInvalidDetail

boolean

置顶/定坑侧控制返回值中是否包含 InvalidDetail�, 用于 itemId:itemType 查询类型使用

false

page

integer

页数,默认 1

1

size

integer

每页数量,默认 10

10

返回参数

名称

类型

描述

示例值

object

result

object

结果

total

object

统计

sceneWeightItem

integer

场景加权物品数量

10

totalCount

integer

全部数量

5000

queryCount

integer

列出数量

3000

sceneRecommendItem

integer

场景可推荐物品数量

200

weightItem

integer

加权物品

10

instanceRecommendItem

integer

实例可推荐物品数量

200

detail

array<object>

详细信息

object

title

string

标题

test

categoryPath

string

类目路径

1_2

itemId

string

itemId,同数据规范同字段

123

itemType

string

itemType,同数据规范同字段

item

status

string

是否可推荐

1

brandId

string

品牌 ID

1

shopId

string

店铺 ID

1

pubTime

string

发布时间

1647998107012

channel

string

频道

news

duration

string

持续时间

30

author

string

作者

abc

expireTime

string

过期时间

1647998107012

requestId

string

当前请求的 RequestID

6839AE7C-A984-48C1-AC17-331BAC6D97BC

示例

正常返回示例

JSON格式

{
  "result": {
    "total": {
      "sceneWeightItem": 10,
      "totalCount": 5000,
      "queryCount": 3000,
      "sceneRecommendItem": 200,
      "weightItem": 10,
      "instanceRecommendItem": 200
    },
    "detail": [
      {
        "title": "test",
        "categoryPath": "1_2",
        "itemId": "123",
        "itemType": "item",
        "status": "1",
        "brandId": "1",
        "shopId": "1",
        "pubTime": "1647998107012",
        "channel": "news",
        "duration": "30",
        "author": "abc",
        "expireTime": "1647998107012"
      }
    ]
  },
  "requestId": "6839AE7C-A984-48C1-AC17-331BAC6D97BC"
}

错误码

访问错误中心查看更多错误码。

变更历史

更多信息,参考变更详情