Running Algorithms
Function
This API is used to run specified algorithms based on entered parameters.
URI
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
Execute a specified algorithm. The algorithm name is pagerank, the weight coefficient is 0.85, the convergence precision is 0.00001, the maximum number of iterations is 1000, and traversal is performed along edge directions.
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 } }
![](https://support.huaweicloud.com/eu/api-ges/public_sys-resources/note_3.0-en-us.png)
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
Parameter |
Type |
Description |
---|---|---|
errorMessage |
String |
System prompt.
|
errorCode |
String |
System prompt 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 for a successful request
Http Status Code: 200 { "jobId": "4448c9fb-0b16-4a78-8d89-2a137c53454a001679122", "jobType": 1 }
Status code: 4200
Example response for a 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. |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.