该接口用于获取指定实例的推荐结果。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| airec:Recommend | get | *Instance acs:airec:{#regionId}:{#accountId}:instance/{#InstanceId} |
| 无 |
请求语法
GET /v2/openapi/instances/{instanceId}/actions/recommend HTTP/1.1
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| instanceId | string | 是 | 实例 ID | airec-test001 |
| sceneId | string | 否 | 物品被投放的场景 ID | test |
| userId | string | 是 | 用户唯一 ID | 123 |
| ip | string | 否 | 用户最后登录的 IP | 192.168.1.1 |
| imei | string | 否 | 设备 ID | 06e1565409c9fc4887036b974421**** |
| returnCount | integer | 是 | 返回结果条数（0-50 之间） | 10 |
| items | string | 否 | 用于相关推荐的 item（限于相关推荐场景使用） | 1001 |
| serviceType | string | 否 | 略 | 1 |
| userInfo | string | 否 | 略 | 1 |
| rankOpen | boolean | 否 | 召回排序阶段是否根据用户 ID 个性化排序 | true |
| recType | string | 否 | 推荐服务类型 | gul |
| filter | string | 否 | 推荐过滤字符串 | eyJqb2luIjoiYW5kIiwiZmlsdGVycyI6W3siY29uZCI6ImNvbnRhaW4iLCJmaWVsZCI6InRhZ3MiLCJ2YWx1ZSI6IuWPjOS6uiJ9XX0. |
| strategy | string | 否 | 如果需要使用坑位策略，请求参数内新增 strategy="fixedSlot"，此时系统将按照坑位配置返回推荐结果 | fixedSlot |
返回参数
示例
正常返回示例
JSON格式
{
"result": [
{
"matchInfo": "xxx",
"traceId": "ali",
"position": 1,
"itemId": 123,
"itemType": "item",
"traceInfo": "1007.62381.131491.100200300000000:bcb946ed-3f09-4e9b-bf4a-c19862f42231:792783::0:s101:::15:content___130788_stall:item:i2i_common_common:0.0205279946753756:null:null:1673258031504::context__recall_index=156,context__hour=17,context__trigger_num=2::C7EF99C9-6C55-5D45-A8D5-0754082E9DCF:hot_common,i2i_common_common,i2i_swing_common,hot_full:::::",
"weight": 1,
"flowWeight": 0,
"message": "Successful"
}
],
"code": 200,
"requestId": "04707E49-642A-4649-827A-F8EEB07D4C27",
"message": "i2i_common_common;NotFound;1673254401;similar product/content of clicked ones;2023-01-09 16:53:21"
}错误码
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 |
|---|---|---|
| 2023-03-20 | OpenAPI 入参发生变更 | 查看变更详情 |