响应示例
4.2 图管理 API
4.2.2 查询图详情(1.0.0)
功能介绍
根据图ID查询某个图详情。
调试
您可以在API Explorer中调试该接口。
URI
GET /v1.0/{project_id}/graphs/{graph_id}
表4-15 路径参数
参数 是否必选 参数类型 描述
project_id 是 String 项目编号，用于资源隔离。请参 考获取项目ID。
graph_id 是 String 图ID。
请求参数
表4-16 请求 Header 参数
参数 是否必选 参数类型 描述
X-Auth-Token 是 String 用户Token。 通过调用IAM服务 获取用户Token接口获取（响应 消息头中X-Subject-Token的 值）。
响应参数
状态码： 200
表4-17 响应 Body 参数
参数 参数类型 描述
graph graph_1
object 请求失败时为空。
errorMessage String 系统提示信息，执行成功时，字段可能为空。执 行失败时，用于显示错误信息。
参数 参数类型 描述
errorCode String 系统提示信息，执行成功时，字段可能为空。执 行失败时，用于显示错误码。
表4-18 graph_1
参数 参数类型 描述
id String 图ID。
name String 图名称。
createdBy String 图的创建人账号。
isMultiAz String 是否支持跨AZ高可用。
regionCode String 域编码。
azCode String 可用区编码。
schemaPath Array of schemaPath _1 objects
元数据文件路径。
edgesetPath Array of edgesetPath _1 objects
边数据集OBS路径。
edgesetFormat String 边数据集文件格式。
edgesetDefaul
tLabel String 边数据集文件默认Label。
vertexsetPath Array of vertexsetPat h_1 objects
点数据集OBS路径。
vertexsetForm
at String 点数据集文件格式。
vertexsetDefau
ltLabel String 点数据集文件默认Label。
dataStoreVersi
on String 图版本。
sys_tags Array of SysTagsRes objects
企业项目信息，如果未指定则不开启，默认不开 启。
参数 参数类型 描述
status String 图的状态码。
● 100：准备中
● 200：运行中
● 201：升级中
● 202：导入中
● 203：回滚中
● 204：导出中
● 205：清空中
● 206：扩容准备中
● 207：扩容中
● 208：扩容回退中
● 300：故障
● 303：创建失败
● 400：被删除
● 800：已冻结
● 900：停止
● 901：停止中
● 920：启动中 actionProgress String 图创建进度百分比。
说明只有图状态码为100时返回该字段。
graphSizeTypeI
ndex String 图规模类型索引。
● 0：一万边
● 1：百万边
● 2：千万边
● 3：一亿边
● 4：十亿边
● 5：百亿边 vpcId String 虚拟私有云ID。
subnetId String 指定虚拟私有云下的子网ID。
securityGroupI
d String 安全组ID。
replication Integer 副本个数，默认为1。
created String 图创建时间。
updated String 图更新时间。
参数 参数类型 描述
privateIp String 图实例私有网络访问地址，通过该IP用户可以通 过私有网络中已部署的弹性云服务器对图实例进 行访问。
publicIp String 图实例公网访问地址，通过该IP用户可以从互联 网对图实例进行访问。
arch String 图实例CPU架构类型，取值为x86_64和 aarch64。
encrypted Boolean 是否加密。默认值为“false”，默认不加密。
masterKeyId String 用户主密钥ID。
masterKeyNa
me String 用户主密钥名称。
enableRBAC Boolean 是否启用细粒度权限控制。
enableFulltextI
ndex Boolean 是否启用全文索引。
enableHyG Boolean 是否启用HyG，该参数只对千亿规格图生效
表4-19 schemaPath_1
参数 参数类型 描述
jobId String 导入OBS文件对应的jobId。
path String OBS存储路径，不包含OBS Endpoint。
status String OBS文件导入状态。
● success：完全导入成功
● partiallyFailed：部分失败
● failed：完全导入失败
表4-20 edgesetPath_1
参数 参数类型 描述
jobId String 导入OBS文件对应的jobId。
path String OBS存储路径，不包含OBS Endpoint。
status String OBS文件导入状态。
● success：完全导入成功
● partiallyFailed：部分失败
● failed：完全导入失败
表4-21 vertexsetPath_1
参数 参数类型 描述
jobId String 导入OBS文件对应的jobId。
path String OBS存储路径，不包含OBS Endpoint。
status String OBS文件导入状态。
● success：完全导入成功
● partiallyFailed：部分失败
● failed：完全导入失败
表4-22 SysTagsRes
参数 参数类型 描述
key String 企业项目的key填：_sys_enterprise_project_id。
value String 企业项目的id。可以从企业项目获取。
请求示例
GET https://Endpoint/v1.0/{project_id}/graphs/{graph_id}
响应示例
状态码： 200 OK
{ "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",
"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",
"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"
}}