Updated on 2022-08-09 GMT+08:00

Querying Vertex Details

Function

This API is used to query the vertex information (such as the label and property) based on the vertex ID.

URI

  • URI format
    GET /ges/v1.0/{project_id}/graphs/{graph_name}/vertices/detail?vertexIds={vertex_ids}
  • 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

    vertexIds

    Yes

    String

    IDs of the vertices to be queried. When multiple IDs are specified by vertexIds, separate the IDs with commas (,) in the URL.

    NOTE:

    For graphs of the 100-billion-edge type, only one vertex ID is supported.

Request

  • Request example
    GET http://{SERVER_URL}/ges/v1.0/{project_id}/graphs/{graph_name}/vertices/detail?vertexIds=Ray

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

Response

Table 2 Parameter description

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.

data

Json

Query results

Table 3 data parameter description

Parameter

Type

Description

vertices

List

Vertex result set. If no corresponding vertices are found, the value of vertices is empty.

  • Response example (successful request)
    Http Status Code: 200
    {
        "data": {
            "vertices": [
                {
                    "id": "Ray",
                    "label": "user",
                    "properties": {
                        "Occupation": [
                            "college/grad student"
                        ],
                        "Name": [
                           "Lei"
                        ],
                        "Zip-code": [
                            "90241"
                        ],
                        "Gender": [
                            "M"
                        ],
                        "Age": [
                            "18-24"
                        ]
                    }
                }
            ]
        }
    }
  • Response example (failed request)
    Http Status Code: 400
     {
      "errorMessage":"graph [demo] is not found",
      "errorCode":"GES.8204"
     }

Return Value

  • Normal

    200

  • Abnormal
    Table 4 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.