Updated on 2024-12-03 GMT+08:00

Stopping a Graph (1.0.0)

Function

This API is used to stop a graph. After the graph is created, you can disable it if it is not used temporarily.

  • Instances of stopped graphs are not charged.
  • You can stop a graph instance for a maximum of seven days. If you do not restart the instance manually within that time frame, it will automatically restart.

URI

POST /v1.0/{project_id}/graphs/{graph_id}/action

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

Table 2 Query parameters

Parameter

Mandatory

Type

Description

action_id

Yes

String

Graph action ID

The value can be:

  • stop

Request Parameters

Table 3 Parameters in the request header

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.

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

errorMessage

String

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.

errorCode

String

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.

jobId

String

ID of the graph stopping job. This parameter is left blank when the request fails.

NOTE:

You can view the job execution status and obtain the return result by querying the job ID. For details, see Task Center APIs.

Example Request

POST https://Endpoint//v1.0/{project_id}/graphs/{graph_id}/action?action_id=stop

Example Response

Status code: 200

OK

{
  "jobId" : "ff8080816025a0a1016025a5a2700007"
}

Status code: 400

Bad Request

{
  "errorCode" : "GES.7001",
  "errorMessage" : "The graph is not running."
}

Status Codes

Status Code

Description

200

Request sent.

400

Request error.

401

Authentication failed.

403

No operation permissions.

404

No resources found.

500

Internal server error.

503

Service unavailable.