文档首页/ 图引擎服务 GES/ API参考/ 管理面API（V2）/ GraphPlugins管理API/ 查询获取场景应用分析插件
更新时间：2024-07-26 GMT+08:00
查看PDF
分享

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

功能介绍

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

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

URI

GET /v2/{project_id}/graphs/scenes

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID。获取方法请参见获取项目ID。
表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"
  } ]
}

状态码： 400

失败响应示例

{
  "error_msg" : "The request body or header is invalid.",
  "error_code" : "GES.7016"
}

状态码

返回值

说明

400 Bad Request

请求错误

401 Unauthorized

鉴权失败

403 Forbidden

没有操作权限

404 Not Found

找不到资源

500 Internal Server Error

服务内部错误

503 Service Unavailable

服务不可用

错误码

请参见错误码。

父主题： GraphPlugins管理API

相关文档