Executing an Algorithm

Function

This API is used to run specified algorithms based on entered parameters.

URI

POST /ges/v1.0/{project_id}/graphs/{graph_name}/action?action_id=execute-algorithm

**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_name	Yes	String	Graph name

Example Request

Run the shortest_path algorithm to find the shortest route between vertices 46 and 138, taking into account the direction of the edges.

POST http://{SERVER_URL}/ges/v1.0/{project_id}/graphs/{graph_name}/action?action_id=execute-algorithm
{
   ""algorithmName"":""shortest_path"", 
   ""executionMode"": ""sync"",
   ""parameters"":{  
       ""source"":""46"",
       ""target"":""138"",
       ""directed"":true      
    }
}

SERVER_URL: Address for accessing a graph. For details about its value, see Using Service Plane APIs.

Request Parameters

For details about the parameters, see Common algorithm parameters.

Response Parameters

**Table 2** Response body parameters
Parameter	Type	Description
errorMessage	String	System prompt. If execution succeeds, this parameter may be left blank. If execution fails, this parameter is used to display the error message.
errorCode	String	System prompt. If execution succeeds, this parameter may be left blank. If execution fails, this parameter is used to display the error code.
jobId	String	ID of the algorithm execution 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 Job Management APIs.
jobType	Integer	Job type. This parameter is left blank when the request fails.

Example Response

Status code: 200

Example response (successful request)

Http Status Code: 200
{ 
"jobId": "4448c9fb-0b16-4a78-8d89-2a137c53454a001679122",
"jobType": 1
}

Status code: 4200

Example response (failed request)

Http Status Code: 400
{
"errorMessage":"graph [demo] is not found",
"errorCode":"GES.8402"
}

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.