Running Algorithms

Function

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

URI

URI format

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

Parameter description

**Table 1** URI parameter description
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID, which is used for resource isolation. For details, see Obtaining a Project ID.
graph_name	Yes	String	Graph name

Request

Request example

POST http://{SERVER_URL}/ges/v1.0/{project_id}/graphs/{graph_name}/action?action_id=execute-algorithm
{
 "algorithmName":"pagerank",
 "parameters":{
        "alpha":0.85,
        "convergence":0.00001,
        "max_iterations":1000,
        "directed":true
 }
}

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

Request body parameter description
For details about the parameters, see Table 1.

Response

**Table 2** Parameter description
Parameter	Mandatory	Type	Description
errorMessage	No	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	No	String	System prompt. If execution succeeds, this parameter may be left blank. If execution fails, this parameter is used to display the error code.
job_id	No	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	No	Integer	Job type. This parameter is left blank when the request fails.

Response example (successful request)

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

Response example (failed request)

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

Return Value

Normal
200

Abnormal

**Table 3** Return code for failed requests
Return Value	Description
400 Bad Request	Request error.
401 Unauthorized	Authentication failed.
403 Forbidden	No operation permission.
404 Not Found	The requested resource was not found.
500 Internal Server Error	Internal service error.
503 Service Unavailable	Service unavailable.