文档首页/ 推荐系统 RES/ API参考/ API/ 场景/ 查询场景列表
更新时间：2022-05-13 GMT+08:00
查看PDF
分享

查询场景列表

功能介绍

查询当前工作空间下的场景列表。

调试

您可以在API Explorer中调试该接口。

URI

GET /v2.0/{project_id}/workspaces/{workspace_id}/scenes

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目id，获取方式请参见获取项目ID。

workspace_id

是

String

工作空间id。
表2 Query参数

参数

是否必选

参数类型

描述

category

是

String

场景类型：

  • customize，自定义推荐

  • intelligent，智能场景

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

Content-Type

是

String

内容类型，取值为application/json。

X-Auth-Token

是

String

用户token，获取方式请参见获取用户Token。

响应参数

状态码： 200

表4 响应Body参数

参数

参数类型

描述

is_success

Boolean

是否成功。

res_scenes

Array of res_scene objects

场景列表信息。

message

String

返回消息（请求成功时，不返回此字段）。

error_code

String

错误码（请求成功时，不返回此字段）。
表5 res_scene

参数

参数类型

描述

category

String

类型。

datasource_id

String

数据源id。

ds_config

DataConfig object

数据源配置。

scene_id

String

场景id。

scene_name

String

场景名称。

type

String

场景类型。

service_type

String

服务类型。

status

String

状态。

workspace_id

String

工作空间id。

created_at

Integer

创建时间。

update_at

Integer

更新时间。

specs_config

SpecsConfig object

计算规格。
表6 DataConfig

参数

参数类型

描述

offline

Offline object

离线计算规格。

nearline

Nearline object

近线数据源。
表7 Offline

参数

参数类型

描述

user_url

String

用户数据url。

item_url

String

物品数据url。

behavior_url

String

行为数据url。
表8 Nearline

参数

参数类型

描述

item_topic

Topic object

物品topic。

user_topic

Topic object

用户topic。

behavior_topic

Topic object

行为topic。
表9 Topic

参数

参数类型

描述

name

String

名称。

id

String

id。
表10 SpecsConfig

参数

参数类型

描述

offline

String

离线计算规格。

nearline

String

实时计算规格。

rank

String

深度学习计算规格。

online_tps

Integer

在线服务最大并发数。

请求示例

查询当前工作空间下的场景列表

/v2.0/testuuidxxxxxxxxxxxxxxxxxxxxxxxx/workspaces/testuuidxxxxxxxxxxxxxxxxxxxxxxxx/scenes?category=customize

-

响应示例

状态码： 200

OK

{
  "res_scenes" : [ {
    "type" : "UI",
    "service_type" : "rec",
    "ds_config" : {
      "time_interval" : 300
    },
    "specs_config" : {
      "offline" : "4CU",
      "nearline" : "2CU",
      "rank" : "16CU",
      "online_tps" : 10
    },
    "scene_name" : "cyd-scene",
    "category" : "customize",
    "scene_id" : "01040139fde2434eb7f0dfab597a3614",
    "datasource_id" : "1f0affe98a7844ca920f47a2b7e7abae",
    "status" : "PRE_START",
    "created_at" : 0,
    "update_at" : 0,
    "workspace_id" : "68887f2a855f45e7ab4850ecc7ca28c2"
  }, {
    "type" : "UI",
    "service_type" : "rank",
    "ds_config" : {
      "time_interval" : 30
    },
    "specs_config" : {
      "offline" : "4CU",
      "nearline" : "2CU",
      "rank" : "16CU",
      "online_tps" : 10
    },
    "scene_name" : "jby-test-0102",
    "category" : "customize",
    "scene_id" : "159a4b7ea15a43abb469ef2a7739bae4",
    "datasource_id" : "6a3475a7dd11492e8d14f73a3719333b",
    "status" : "INITIALIZED",
    "created_at" : 0,
    "update_at" : 0,
    "workspace_id" : "68887f2a855f45e7ab4850ecc7ca28c2"
  } ],
  "is_success" : true
}

状态码

状态码

描述

200

OK

错误码

请参见错误码。

父主题： 场景

相关文档