Help Center> Graph Engine Service> API Reference> Management Plane APIs> Graph Management APIs> Querying Graph Details (1.0.0)
View PDF

Querying Graph Details (1.0.0)

Function

This API is used to query the details about a graph based on the graph ID.

URI

  • URI format 
    GET /v1.0/{project_id}/graphs/{graph_id}
  • 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_id

    Yes

    String

    Graph ID

Request

  • Request example 
    GET https://Endpoint/v1.0/{project_id}/graphs/{graph_id}

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.

graph

No

Graph data structure

This parameter is left blank when the request fails. For details, see Table 3 Graph data structure.
  • Response example (successful request) 
    Http Status Code: 200
{
    "graph": {
        "id": "f1529b88-c958-493e-8452-fccfe932cde1",
        "name": "demo",
        "regionCode": "cn-north-1",
        "azCode": "cn-north-1a",
             "schemaPath": [
              {
              "path": "ges-graphs/demo_movie/schema.xml",
              "jobId": "ff80808167bb90340167bc7445670428",
               "status": "success"
              }
             ],
             "edgesetPath": [
              {
               "path": "ges-graphs/demo_movie/edge.csv",
               "jobId": "ff80808167bb90340167bc7445670428",
               "status": "success"
              }
            ],
             "vertexsetPath": [
             {
              "path": "",
              "jobId": "ff80808167bb90340167bc7445670428",
              "status": "success"
             }
           ],
        "status": "200",
        "graphSizeTypeIndex": "1",
        "vpcId": "2d8af840-fd57-4e3b-a8f1-cda0f55ccd99",
        "subnetId": "dc018ec3-67d1-46c9-b2fc-19d83367f4e2",
        "securityGroupId": "11d27338-8649-4076-8579-5ebc1a60f79e",
        "created": "2018-07-23T04:09:44",
        "privateIp": "192.168.0.4",
        "publicIp": "49.4.81.183",
        "dataStoreVersion": "1.0.5",
        "arch": "x86_64"
    }
}
  • Response example (failed request) 
     Http Status: 400
{
    "errorCode": "GES.7000",
    "errorMessage": "The graph does not exist or has been deleted."
}

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.
Parent topic: Graph Management APIs