文档首页/ 推荐系统 RES/ API参考/ API（V1不推荐）/ 全局配置API/ 查询场景
更新时间：2023-05-24 GMT+08:00
查看PDF
分享

查询场景

功能介绍

该接口用于查询场景信息。

URI

GET /v1/{project_id}/scene

参数说明请参见表1-URI参数说明。
表1 URI参数说明

名称

是否必选

类型

说明

project_id

是

String

项目编号，用于资源隔离。获取方法请参见获取项目ID。

请求消息

暂不涉及。

响应消息

响应参数请参见表2。

表2 响应参数说明

参数名称

参数类型

说明

is_success

boolean

请求是否成功。

scenes

object []

请参见表3，场景信息。

  • 最小数量：1
  • 最大数量：10

error_code

String

请求失败时的错误码，请求成功时无此字段。

error_msg

String

请求失败时的错误信息，请求成功时无此字段。

message

String

返回消息。
表3 scenes参数说明

参数名称

参数类型

说明

project_id

String

项目编号，用于资源隔离。

user_id

String

来自公有云的user ID，用于用户隔离。

scene_id

String

场景ID。

scene_name

String

场景名称。

示例

  • 成功响应示例 
    {
    "is_success": true,
    "message": "Succeed to query the scene information.",
    "scenes": [
        {
            "scene_id": "0",
            "scene_name": "默认场景"
        },
        {
            "project_id": "07f125793ba7497d887cb112dc917e87",
            "user_id": "07f125793ba7497d887cb112dc917e87",
            "scene_id": "51192cc3cecc4bcd854a6c40dc7941db",
            "scene_name": "10"
        }
    ]
}
  • 失败响应示例 
    {
    "error_code": "res.2301",
    "error_msg": "Failed to resolve the token from the request."
}

状态码

状态码请参见状态码。

父主题： 全局配置API

相关文档