文档首页/图引擎服务 GES/API参考/管理面API（V2）/GraphPlugins管理API/订阅场景分析插件
更新时间：2025-12-19 GMT+08:00
查看PDF
分享

订阅场景分析插件

功能介绍

订阅scenes应用场景分析能力，便于业务面API使用对应功能。

已订阅的不可以重复订阅，需要更新请先取消原有订购，重新订购。

URI

POST /v2/{project_id}/graphs/{graph_id}/scenes/register

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释：

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

约束限制：

不涉及。

取值范围：

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

默认取值：

不涉及。

graph_id

是

String

参数解释：

图ID。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释：

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

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

表3 请求Body参数

参数

是否必选

参数类型

描述

scenes

否

Array of scenes objects

要订阅的具体场景。

表4 scenes

参数

是否必选

参数类型

描述

name

否

String

场景名称。

applications

否

Array of strings

要订阅的application名字列表。

响应参数

状态码： 200

表5 响应Body参数

参数

参数类型

描述

result

String

参数解释：

订阅scenes结果。

取值范围：

不涉及。

状态码： 400

表6 响应Body参数

参数

参数类型

描述

error_code

String

参数解释：

系统提示信息。

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

取值范围：

不涉及。

error_msg

String

参数解释：

系统提示信息。

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

取值范围：

不涉及。

请求示例

订阅scenes应用场景分析能力，订阅的具体场景名称为12345工单关联分析，要订阅的application名字列表为“动态高纬关系深度分析”。

POST /v2/{project_id}/graphs/{graph_id}/scenes/register

{
  "scenes" : [ {
    "name" : "12345工单关联分析",
    "applications" : [ "动态高纬关系深度分析" ]
  } ]
}

响应示例

状态码： 200

成功响应示例

{
  "result" : "success"
}

状态码： 400

失败响应示例

{
    "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

服务不可用

错误码

请参见错误码。