Help Center> Graph Engine Service> API Reference (Kuala Lumpur Region)> Service Plane APIs> Algorithm APIs> Algorithm API Parameter References> K-hop
Updated on 2022-08-09 GMT+08:00
View PDF

K-hop

Table 1 parameters parameter description

Parameter

Mandatory

Description

Type

Value Range

Default Value

k

Yes

Number of hops

Integer

1 to 100

-

source

Yes

Vertex ID

String

-

-

mode

No

Direction

  • OUT: Hop from the outgoing edges
  • IN: Hop from the incoming edges
  • All: Hop from edges in both directions

String

OUT, IN, or ALL

OUT
Table 2 response_data parameter description

Parameter

Type

Description

vertices

List

ID of the vertex within k hops. The format is as follows:

[vertexId,...],

where vertexId is of the string type.

source

String

Source vertex ID

k

Integer

Number of hops

k_hop_neighbors

Integer

Number of vertices within k hops (excluding the source vertex)