Unsubscribing from a Scene Analysis Plugin

Function

This API is used to unsubscribe from a scene analysis plugin. After the subscription is canceled, you cannot use the function through application service plane APIs.

URI

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

**Table 1** URI parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Definition Project ID. For details about how to obtain a project ID, see Obtaining a Project ID. Constraints N/A Range The value can contain up to 64 characters. Only letters and digits are allowed. Default Value N/A
graph_id	Yes	String	Definition Graph ID. Constraints N/A Range N/A Default Value N/A

Request Parameters

**Table 2** Request header parameter
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Definition User token. It is used to obtain the permission to call APIs. For how to obtain the token, see Authentication. (The token is the value of X-Subject-Token in the response header.) Constraints N/A Range N/A Default Value N/A

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
scenes	No	Array of scenes objects	Definition List of scenes you want to unsubscribe from. Constraints N/A Range N/A Default Value N/A

**Table 4** scenes
Parameter	Mandatory	Type	Description
name	No	String	Definition Scene name. Constraints N/A Range N/A Default Value N/A
applications	No	Array of strings	Definition List of applications you want to unsubscribe from. Constraints N/A Range N/A Default Value N/A

Response Parameters

Status code: 200

**Table 5** Response body parameters
Parameter	Type	Description
success	Array of strings	Definition Scene application that is successfully unsubscribed from. Range N/A
failure	Array of strings	Definition Scene application that fails to be unsubscribed from. Range N/A

Status code: 400

**Table 6** Response body parameters
Parameter	Type	Description
error_code	String	Definition System prompt. If the execution succeeds, this parameter may be left blank. If the execution fails, this parameter is used to display the error code. Range N/A
error_msg	String	Definition System prompt. If the execution succeeds, this parameter may be left blank. If the execution fails, this parameter is used to display the error message. Range N/A

Example Request

Unsubscribe from a 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/unregister

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

{
  "success" : [ "testCase" ],
  "failure" : [ "xxx" ]
}

Status code: 400

Example response for a failed request

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

Status Codes

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.