更新时间:2025-12-19 GMT+08:00

查询获取场景应用分析插件

功能介绍

查询scenes场景下的应用分析能力详情,可以获得对应场景下的application、参数和功能介绍详情。

URI

GET /v2/{project_id}/graphs/scenes

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释:

项目编号。获取方法,请参见获取项目ID。

约束限制:

不涉及。

取值范围:

只能由英文字母和数字组成,且长度为[1-64]个字符。

默认取值:

不涉及。

表2 Query参数

参数

是否必选

参数类型

描述

scene_name

否

String

参数解释:

场景名称。

约束限制:

  • 当有且只有scene_name有值时,返回对应scene_name下的所有application详情。
  • 当有且只有scene_name、application_name有值时,返回与application_name对应的application详情。
  • 当scene_name、application_name、graph_id均无值时,返回所有SceneApplication。

取值范围:

不涉及。

默认取值:

不涉及。

application_name

否

String

参数解释:

应用程序名字。

约束限制:

  • 当有且只有scene_name、application_name有值时,返回与application_name对应的application详情。
  • 当scene_name、application_name、graph_id均无值时,返回所有SceneApplication。

取值范围:

不涉及。

默认取值:

不涉及。

graph_id

否

String

参数解释:

图ID。

约束限制:

  • 当有且只有graph_id有值时,返回对应图id下所订阅的application详情。
  • 当scene_name、application_name、graph_id均无值时,返回所有SceneApplication。

取值范围:

不涉及。

默认取值:

不涉及。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释:

用户Token。用于获取操作API的权限。获取方法请参见获取Token接口,响应消息头中X-Subject-Token的值即为Token。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

响应参数

状态码: 200

表4 响应Body参数

参数

参数类型

描述

results

Array of results objects

参数解释:

scene场景分析插件信息。

取值范围:

不涉及。

表5 results

参数

参数类型

描述

scene

String

参数解释:

场景名。

取值范围:

不涉及。

name

String

参数解释:

application名称。

取值范围:

不涉及。

params

Array of params objects

参数解释:

参数列表。

取值范围:

不涉及。

description

String

参数解释:

场景下应用的描述。

取值范围:

不涉及。

表6 params

参数

参数类型

描述

name

String

参数解释:

参数名称。

取值范围:

不涉及。

type

String

参数解释:

参数类型。取值范围["string","int"],目前仅支持"string"。

取值范围:

不涉及。

default_value

String

参数解释:

取值范围为空,或参数默认值,当为空时表示客户使用时必须传入此参数。

取值范围:

不涉及。

状态码: 400

表7 响应Body参数

参数

参数类型

描述

error_code

String

参数解释:

系统提示信息。

  • 执行成功时,字段可能为空。
  • 执行失败时,用于显示错误码。

取值范围:

不涉及。

error_msg

String

参数解释:

系统提示信息。

  • 执行成功时,字段可能为空。
  • 执行失败时,用于显示错误信息。

取值范围:

不涉及。

请求示例

查询scenes场景下的应用分析能力详情。

GET /v2/{project_id}/graphs/scenes?scene_name=xxx&application_name=xxx&graph_id=xxx

响应示例

状态码: 200

成功响应示例

{
  "results" : [ {
    "name" : "movie_recommendation",
    "description" : "采用好友感兴趣的电影进行推荐。图谱约束:(user)-[friends]->(user), (user)-[rates]->(movie)",
    "params" : [ {
      "name" : "user",
      "default_value" : "",
      "type" : "string"
    } ],
    "scene" : "MovieSocialNetwork_V2"
  }, {
    "name" : "friend_recommendation",
    "description" : "推荐可能感兴趣的人(同时考虑潜在人之间的关系和电影爱好)。图谱约束:(user)-[friends]->(user),(user)-[rates]->(movie)",
    "params" : [ {
      "name" : "user",
      "default_value" : "",
      "type" : "string"
    } ],
    "scene" : "MovieSocialNetwork_V2"
  } ]
}

状态码: 404

失败响应示例

{
    "error_msg": "The graph does not exist or has been deleted.",
    "error_code": "GES.7000"
}

状态码

返回值

说明

400 Bad Request

请求错误

401 Unauthorized

鉴权失败

403 Forbidden

没有操作权限

404 Not Found

找不到资源

500 Internal Server Error

服务内部错误

503 Service Unavailable

服务不可用

错误码

请参见错误码。