查询图列表(1.0.0)
功能介绍
查询当前租户所有的图。
URI
- URI格式
GET /v1.0/{project_id}/graphs?offset={offset}&limit={limit}
- 参数说明
表1 URI参数说明 参数
是否必选
类型
说明
project_id
是
String
项目编号，用于资源隔离。请参考获取项目ID。
offset
否
Integer
本次请求的起始位置，默认为0。
limit
否
Integer
每页资源数量的最大值，默认为10。
请求
- 请求样例
GET https://Endpoint/v1.0/{project_id}/graphs?offset=0&limit=10
响应
名称 |
是否必选 |
参数类型 |
说明 |
|---|---|---|---|
errorMessage |
否 |
String |
系统提示信息，执行成功时，字段可能为空。执行失败时，用于显示错误信息。 |
errorCode |
否 |
String |
系统提示信息，执行成功时，字段可能为空。执行失败时，用于显示错误码。 |
graphCount |
否 |
Integer |
图总个数。请求失败时为空。 |
graphs |
否 |
List结构，参见Graph类型数据结构说明。 |
Graph类型列表。请求失败时为空。 |
名称 |
是否必选 |
参数类型 |
说明 |
|---|---|---|---|
id |
是 |
String |
图ID。 |
name |
是 |
String |
图名称。 |
createdBy |
是 |
String |
图的创建人账号。 |
isMultiAz |
否 |
Boolean |
是否支持跨AZ高可用。 |
regionCode |
是 |
String |
域编码。 |
azCode |
是 |
String |
可用区编码。 |
schemaPath |
否 |
JsonArray |
元数据文件OBS路径。 |
edgesetPath |
否 |
JsonArray |
边数据集OBS路径。 |
edgesetFormat |
否 |
String |
边数据集文件格式。 |
edgesetDefaultLabel |
否 |
String |
边数据集文件默认Label。 |
vertexsetPath |
否 |
JsonArray |
点数据集OBS路径。 |
vertexsetFormat |
否 |
String |
点数据集文件格式。 |
vertexsetDefaultLabel |
否 |
String |
点数据集文件默认Label。 |
dataStoreVersion |
是 |
String |
图版本。 |
status |
是 |
String |
图的状态码。
|
actionProgress |
否 |
String |
图创建进度百分比。 说明：
只有图状态码为100时返回该字段。 |
graphSizeTypeIndex |
是 |
String |
图规模类型索引。
|
vpcId |
是 |
String |
虚拟私有云ID。 |
subnetId |
是 |
String |
指定虚拟私有云下的网络ID。 |
securityGroupId |
是 |
String |
安全组ID。 |
created |
否 |
String |
图创建时间。 |
updated |
否 |
String |
图更新时间。 |
privateIp |
否 |
String |
图实例私有网络访问地址，通过该IP用户可以通过私有网络中已部署的弹性云服务器对图实例进行访问。 |
publicIp |
否 |
String |
图实例公网访问地址，通过该IP用户可以从互联网对图实例进行访问。 |
名称 |
是否必选 |
参数类型 |
说明 |
|---|---|---|---|
path |
是 |
String |
OBS存储路径，不包含OBS Endpoint。 |
jobId |
是 |
String |
导入OBS文件对应的jobId。 |
status |
是 |
String |
OBS文件导入状态。
|
- 请求成功样例
Http Status Code: 200 { "graphCount": 2, "graphs": [ { "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", "updated": "2018-07-23T04:09:44", "privateIp": "192.168.0.4", "publicIp": "49.4.81.183", "dataStoreVersion": "1.0.5" }, { "id": "53205529-026b-455a-9e07-228fae4b12b9", "name": "ges_c5de", "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": "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" } ] } - 请求失败样例
Http Status: 400 { "errorCode": "GES.7006", "errorMessage": "The underlying graph engine has internal error." }
