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

Querying the Graph List

Function

This API is used to query all graphs owned by the current tenant.

URI

GET /v1.0/{project_id}/graphs

Table 1 URI parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID, which is used for resource isolation.

Table 2 Query parameters

Parameter

Mandatory

Type

Description

offset

No

Integer

Start position of the request. The default value is 0.

limit

No

Integer

Maximum number of resources displayed on a single page. The default value is 10.

Request Parameters

Table 3 Parameters in the request header

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token. The token can be obtained by calling the IAM API. (The token is the value of X-Subject-Token in the response header.)

Response Parameters

Status code: 200

Table 4 Response body parameter

Parameter

Type

Description

graphCount

Integer

Total number of graphs. This parameter is left blank when the request fails.

graphs

Array of graph_1 objects

Graph list. This parameter is left blank when the request fails.

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.

Table 5 graph_1

Parameter

Type

Description

id

String

Graph ID

name

String

Graph name

createdBy

String

Account of the graph creator

isMultiAz

String

Whether to enable cross-AZ HA

regionCode

String

Region code

azCode

String

AZ code

schemaPath

Array of schemaPath_1 objects

Path for storing the metadata file

edgesetPath

Array of edgesetPath_1 objects

OBS path for storing the edge data set

edgesetFormat

String

Format of the edge data file

edgesetDefaultLabel

String

Default label of the edge data file

vertexsetPath

Array of vertexsetPath_1 objects

OBS path for storing the vertex data set

vertexsetFormat

String

Format of the vertex data file

vertexsetDefaultLabel

String

Default label of the vertex data file

dataStoreVersion

String

Graph version

sys_tags

Array of SysTagsRes objects

Enterprise project information. If this parameter is not specified, this function is disabled (default).

status

String

Status code of a graph:

  • 100: Indicates that a graph is being prepared.
  • 200: indicates that a graph is running.
  • 201: indicates that a graph is upgrading.
  • 202: indicates that a graph is being imported.
  • 203: indicates that a graph is being rolled back.
  • 204: indicates that a graph is being exported.
  • 205: indicates that a graph is being cleared.
  • 206: indicates that the system is preparing for resize.
  • 207: indicates that the resize is in progress.
  • 208: Indicates that the resize is being rolled back.
  • 300: indicates that a graph is faulty.
  • 303: indicates that a graph fails to be created.
  • 400: indicates that a graph is deleted.
  • 900: indicates that a graph is stopped.
  • 901: indicates that a graph is being stopped.
  • 920: indicates that a graph is being started.

actionProgress

String

Progress of graph creation in percentage

graphSizeTypeIndex

String

Graph size type index:

  • 0: indicates 10 thousand edges.
  • 1: indicates 1 million edges.
  • 2: indicates 10 million edges.
  • 3: indicates 100 million edges.
  • 4: indicates 1 billion edges.
  • 5: indicates 10 billion edges.
  • 6: indicates 100 billion edges.
  • 401: indicates 1 billion enhanced edges.

vpcId

String

VPC ID

subnetId

String

Subnet ID in the VPC

securityGroupId

String

Security group ID

replication

Integer

Number of replicas. The default value is 1.

created

String

Time when a graph is created

updated

String

Time when a graph is updated

privateIp

String

Floating IP address of a graph instance. Users can access the instance using the IP address through the ECS deployed on a private network.

trafficIpList

List<String>

Physical addresses of a graph instance for access from private networks. To prevent service interruption caused by floating IP address switchover, poll the physical IP addresses to access the graph instance.

cryptAlgorithm

String

Graph instance cryptography algorithm. Available values are as follows:

  • generalCipher: International algorithm
  • SMcompatible: Commercial cryptography algorithm (compatible with international ones)

enableHttps

Boolean

Whether to enable the security mode. This mode may damage GES performance greatly.

tags

JsonArray

Tag list. Each tag is in <key,value> format.

Table 6 schemaPath_1

Parameter

Type

Description

jobId

String

Job ID corresponding to OBS file import

path

String

OBS storage path, excluding OBS endpoint

status

String

OBS file import status:

  • success: Imported successfully.
  • partiallyFailed: Partially failed.
  • failed: Failed to import the file.
Table 7 edgesetPath_1

Parameter

Type

Description

jobId

String

Job ID corresponding to OBS file import

path

String

OBS storage path, excluding OBS endpoint

status

String

OBS file import status:

  • success: Imported successfully.
  • partiallyFailed: Partially failed.
  • failed: Failed to import the file.
Table 8 vertexsetPath_1

Parameter

Type

Description

jobId

String

Job ID corresponding to OBS file import

path

String

OBS storage path, excluding OBS endpoint

status

String

OBS file import status:

  • success: Imported successfully.
  • partiallyFailed: Partially failed.
  • failed: Failed to import the file.
Table 9 SysTagsRes

Parameter

Type

Description

key

String

Key of the enterprise project. The value is _sys_enterprise_project_id.

value

String

Enterprise project ID. You can obtain it from the enterprise project.

Example Request

GET https://Endpoint/v1.0/{project_id}/graphs?offset=0&limit=10

Example Response

Status code: 200

OK

{
    "graphCount": 2,
    "graphs": [
        {
            "id": "f1529b88-c958-493e-8452-fccfe932cde1",
            "name": "demo",
            "regionCode": "az1-dc1",
            "azCode": "az1-dc1a",
            "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",
            "updated": "2018-07-23T04:09:44",
            "privateIp": "192.168.0.4",
            
            "dataStoreVersion": "1.0.5",
            "arch": "x86_64",
        },
        {
            "id": "53205529-026b-455a-9e07-228fae4b12b9",
            "name": "ges_c5de",
            "regionCode": "az1-dc1",
            "azCode": "az1-dc1a",

            "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": "2",
            "vpcId": "2d8af840-fd57-4e3b-a8f1-cda0f55ccd99",
            "subnetId": "dc018ec3-67d1-46c9-b2fc-19d83367f4e2",
            "securityGroupId": "11d27338-8649-4076-8579-5ebc1a60f79e",
            "created": "2018-07-18T13:30:16",
            "updated": "2018-07-18T13:30:16",
            "privateIp": "192.168.0.168",
            "dataStoreVersion": "1.0.5",
            "arch": "aarch64",
        }
    ]
}

Status Code

Status Code

Description

200

OK