Starting a Graph (1.0.0)
Function
This API is used to start a graph. You can disable a graph if it is not used temporarily.
URI
POST /v1.0/{project_id}/graphs/{graph_id}/action
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 |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
action_id |
Yes |
String |
Graph action ID Set this parameter to the enumeration value start, which means the graph will be started. |
Request Parameters
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. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
graph_backup_id |
No |
String |
Backup ID associated during graph startup. If this parameter is configured, the graph starts from the backup. If this parameter is left blank, the graph starts from the status when it was closed last time. For details about how to back up a graph, see section Adding a Backup(1.0.0). |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
errorMessage |
String |
System prompt.
|
errorCode |
String |
System prompt.
|
jobId |
String |
ID of the graph startup 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
https://Endpoint/v1.0/{project_id}/graphs/{graph_id}/action?action_id=start { "graph_backup_id" : "08a898ae-3ff8-40e8-a7ed-03afe05aedbb" }
Example Response
Status code: 200
OK
{ "jobId" : "ff8080816025a0a1016025a5a2700007" }
Status code: 400
Bad Request
{ "errorCode" : "GES.7015", "errorMessage" : "The graph is not running or stopped." }
Status Code
Status Code |
Description |
---|---|
200 |
Request sent. |
400 |
Request error. |
401 |
Authentication failed. |
403 |
No operation permission. |
404 |
No resources found. |
500 |
Internal service error. |
503 |
Service unavailable. |
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot