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
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Project ID, which is used for resource isolation. |
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
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
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. |
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:
|
actionProgress |
String |
Progress of graph creation in percentage |
graphSizeTypeIndex |
String |
Graph size type index:
|
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:
|
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. |
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:
|
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:
|
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 |
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot