文档首页 > > API参考> 历史API> 管理面API> 图管理API>

查询图列表(1.0.0)

查询图列表(1.0.0)

分享
更新时间:2021/05/08 GMT+08:00

功能介绍

查询当前租户所有的图。

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

响应

表2 要素说明

名称

是否必选

参数类型

说明

errorMessage

String

系统提示信息,执行成功时,字段可能为空。执行失败时,用于显示错误信息。

errorCode

String

系统提示信息,执行成功时,字段可能为空。执行失败时,用于显示错误码。

graphCount

Integer

图总个数。请求失败时为空。

graphs

List结构,参见Graph类型数据结构说明。

Graph类型列表。请求失败时为空。

表3 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

图的状态码。

  • 100:准备中
  • 200:运行中
  • 201:升级中
  • 202:导入中
  • 203:回滚中
  • 204:导出中
  • 205:清空中
  • 300:故障
  • 303:创建失败
  • 400:被删除
  • 800:已冻结
  • 900:停止
  • 901:停止中
  • 920:启动中

actionProgress

String

图创建进度百分比。

说明:

只有图状态码为100时返回该字段。

graphSizeTypeIndex

String

图规模类型索引。

  • 0:一万边
  • 1:百万边
  • 2:千万边
  • 3:一亿边
  • 4:十亿边
  • 5:百亿边
  • 6:千亿边

vpcId

String

虚拟私有云ID。

subnetId

String

指定虚拟私有云下的网络ID。

securityGroupId

String

安全组ID。

created

String

图创建时间。

updated

String

图更新时间。

privateIp

String

图实例私有网络访问地址,通过该IP用户可以通过私有网络中已部署的弹性云服务器对图实例进行访问。

publicIp

String

图实例公网访问地址,通过该IP用户可以从互联网对图实例进行访问。

表4 schemaPath、edgesetPath和vertexsetPath属性列表

名称

是否必选

参数类型

说明

path

String

OBS存储路径,不包含OBS Endpoint。

jobId

String

导入OBS文件对应的jobId。

status

String

OBS文件导入状态。

  • success:完全导入成功
  • partiallyFailed:部分失败
  • failed:完全导入失败
  • 请求成功样例
    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."
    }

返回值

  • 正常

    200

  • 异常
    表5 异常返回值说明

    返回值

    说明

    400 Bad Request

    请求错误。

    401 Unauthorized

    鉴权失败。

    403 Forbidden

    没有操作权限。

    404 Not Found

    找不到资源。

    500 Internal Server Error

    服务内部错误。

    503 Service Unavailable

    服务不可用。

分享:

    相关文档

    相关产品