Updated on 2024-05-20 GMT+08:00

All Shortest Paths

Function

This API is used to execute the All Shortest Paths algorithm based on input parameters.

The All Shortest Paths algorithm is used to find all shortest paths between two nodes in a graph.

URI

POST /ges/v1.0/{project_id}/hyg/{graph_name}/algorithm
Table 1 URI parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID. For how to obtain the project ID, see Obtaining a Project ID.

graph_name

Yes

String

Graph name

Request Parameters

Table 2 Request body parameters

Parameter

Mandatory

Type

Description

algorithmName

Yes

String

Algorithm name

parameters

Yes

parameters Object

Algorithm parameters

Table 3 parameters

Parameter

Mandatory

Type

Description

source

Yes

String

Source vertex ID of a path

target

Yes

String

Target vertex ID of a path, which is not the same as the source vertex ID

directed

No

Boolean

Whether to consider the edge direction The value can be true or false. The default value is false.

NOTE:
  • false: The current version does not support this function on weighted graphs.
  • When the dataset does not contain incoming edges, if this parameter is set to true and an algorithm that does not depend on incoming edges is selected to calculate the output, the performance deteriorates. If this parameter is set to false, an error is reported.

weight

No

String

Weight of an edge. The value can be empty or a string. The default value is empty.

  • Empty: The default weight and distance of edges are 1.
  • String: The property of the edge is the weight. If the edge does not have a property, the weight is 1 by default.

Response Parameters

Parameter

Type

Description

errorMessage

String

System prompt. If 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 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 algorithm execution job. This parameter is left blank when the request fails.

NOTE:

You can use the returned job ID to view the task execution status and obtain the algorithm return result. For details, see Querying Job Status on the Service Plane (1.0.0).

jobType

Integer

Job type. This parameter is left blank when the request fails.

Example Request

POST /ges/v1.0/{project_id}/hyg/{graph_name}/algorithm
{
 "algorithmName":"all_shortest_paths",
 "data_id":"0-91494cd9-e7da-4fb9-ba56-b2301967688d0000000019090",
 "parameters":{
        "source":"1",
"target":"5",
        "directed":true,
"weight":"",
        "num_thread":4
 }
}

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

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: 400

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.