Updated on 2023-08-04 GMT+08:00

Subscribing to a Scene Analysis Plugin

Function

This API is used to subscribe to a scene analysis plugin so that you can use the function through the service plane APIs.

A subscribed plugin cannot be subscribed repeatedly. To update the plugin, cancel the subscription and subscribe to it again after update.

URI

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

Table 1 URI parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID. For details about how to obtain the project ID, see Obtaining a Project ID.

graph_id

Yes

String

Graph ID

Request Parameters

Table 2 Request header parameter

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token

It is used to obtain the permission to call APIs. For details about how to obtain the token, see Authentication. The value of X-Subject-Token in the response header is the token.

Table 3 Request body parameters

Parameter

Mandatory

Type

Description

scenes

No

Array of scenes objects

Scene you want to subscribe to

Table 4 scenes

Parameter

Mandatory

Type

Description

name

No

String

Scene name

applications

No

Array of strings

List of applications you want to subscribe to (not supported currently).

Response Parameters

Status code: 200

Table 5 Response body parameters

Parameter

Type

Description

result

String

Subscription result

Status code: 400

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

System prompt code.

  • If execution succeeds, this parameter may be left blank.
  • If execution fails, this parameter is used to display the error code.

error_msg

String

System prompt.

  • If execution succeeds, this parameter may be left blank.
  • If execution fails, this parameter is used to display the error message.

Example Request

Subscribe to an application scenario analysis plugin. The scenario name is Service ticket association analysis, and the list of applications is In-depth analysis of dynamic high-dimension relationships.

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

{
  "scenes" : [ {
    "name": "Service ticket association analysis",
    "applications": ["In-depth analysis of dynamic high-dimension relationships"]
  } ]
}

Example Response

Status code: 200

Example response for a successful request

{
  "result" : "success"
}

Status code: 400

Example response for a failed request

{
  "error_msg" : "graph [demo] is not found",
  "error_code" : "GES.8402"
}

Status Code

Return Value

Description

400 Bad Request

Request error

401 Unauthorized

Authorization failed

403 Forbidden

No operation permissions

404 Not Found

No resources found

500 Internal Server Error

Internal server error

503 Service Unavailable

Service unavailable

Error Code

See Error Code.