特性 模糊查
询
速度 灵活度 支持谓语
复合索 引
不支持 快速 仅限于固定组合属
性键
不支持
全文索 引
支持 比复合
慢
可以任意组合属性 键
支持
URI
● URI 格式
POST /ges/v1.0/{project_id}/graphs/{graph_name}/indices
● 参数说明
表5-128 URI 参数说明
参数 是否必选 类型 说明
project_i
d 是 String 项目编号，用于资源隔离。请参考
获取项目ID。
graph_na
me 是 String 图名称。
请求
● 请求样例（复合索引）
POST http://{SERVER_URL}/ges/v1.0/{project_id}/graphs/{graph_name}/indices { "indexName":"ageIndex",
"indexType": "GlobalCompositeVertexIndex", "hasLabel": "true",
"indexProperty": ["age"]
}
说明
SERVER_URL：图的访问地址，取值请参考业务面API使用限制。
– Body参数说明
表5-129 Body 参数说明
参数 是否必
选
类型 说明
indexNam
e 是 String 索引名称。只能包含字母,数字,-和_。不 能包含其他字符。索引名称的长度需在 63字符以内。
indexType 是 String 索引的类型。区分大小写。
“GlobalCompositeVertexIndex”为全 局的Composite类型的点索引。
hasLabel 否 String 是否有label，默认为false。
● true
● false hasLabel
（一千亿 边（公测 版））
否 Boolea
n 是否有label，默认为false。
● true
● false
参数 是否必
float、 double、 long、 enum、 char array、 string、 date。
● 请求样例（全文索引）
POST http://{SERVER_URL}/ges/v1.0/{project_id}/graphs/{graph_name}/indices { "indexName":"fullText",
"indexType": "FullTextIndex", "indexProperty": ["age"]
}
indexType 是 String 索引的类型为“FullTextIndex”。区分 大小写。
integer、 float、 double、 long、
enum、 char array、 string、 date。
响应
参数 是否必选 类型 说明 job_id 否 Stri
ng 执行该异步任务的jobId。
说明
● 可以查询jobId查看任务执行状态、获取返回结 果，详情参考Job管理API。
jobType 否 Stri
ng 执行该异步任务的jobType。
result 否 Stri
ng 成功时result值为success。
● 请求成功样例
Http Status Code: 200
{"jobId": "f99f60f1-bba6-4cde-bd1a-ff4bdd1fd500000168232",
"jobType": 8 }
● 请求失败样例
Http Status Code: 400
{ "errorMessage": "graph [demo] is not found", "errorCode": "GES.8603"
}
返回值
● 正常 200
● 异常
表5-131 异常返回值说明
返回值 说明
400 Bad Request 请求错误。
401 Unauthorized 鉴权失败。
403 Forbidden 没有操作权限。
404 Not Found 找不到资源。
500 Internal Server Error 服务内部错误。
503 Service Unavailable 服务不可用
5.4.2 删除索引(1.1.6)
功能介绍
根据给定的 indexName 删除索引。
URI
sage 否 Strin
g 系统提示信息，执行成功时，字段可能为空。执行
job_id 否 Strin
g 执行该异步任务的jobId。
说明
● 可以查询jobId查看任务执行状态、获取返回结果，详 情参考Job管理API。
● 图规格为一千亿（公测版）的图，暂不支持该参数。
jobType 否 Strin
g 执行该异步任务的jobType。
● 请求成功样例
Http Status Code: 200
{ "jobId": "fb74314e-a82d-41b2-8900-96e2559fa0d9000168232", "jobType": 9
}
● 请求失败样例
Http Status Code: 400
{ "errorMessage": "graph [demo] is not found", "errorCode": "GES.8604 "
}
返回值
● 正常 200
● 异常
表5-134 异常返回值说明
返回值 说明
400 Bad Request 请求错误。
401 Unauthorized 鉴权失败。
403 Forbidden 没有操作权限。
404 Not Found 找不到资源。
500 Internal Server Error 服务内部错误。
503 Service Unavailable 服务不可用。
5.4.3 查询索引(1.1.6)
功能介绍
查询在图上创建的所有索引。
URI
● URI 格式
GET /ges/v1.0/{project_id}/graphs/{graph_name}/indices
● 参数说明
表5-135 URI 参数说明
参数 是否必
选
类型 说明
project_id 是 String 项目编号，用于资源隔离。请参考获取项目 ID。
参数 是否必
result 否 String 查询结果，成功时为success。
indices 否 List 查询结果，索引列表。
hasLabel 否 String 查询结果，索引中是否包含label。
说明全文索引该参数默认值为false。
hasLabel
（一千亿 边（公测 版））
否 Boolean 查询结果，索引中是否包含label。
说明全文索引该参数默认值为false。
● 请求成功样例
Http Status Code: 200 {
"data": {
"result": "success", "indices": [ {
"indexType": "GlobalCompositeVertexIndex", "indexName": "ageIndx",
Http Status Code: 200 { "data": {
"indices": [ {
"indexType": "GlobalCompositeVertexIndex", "indexName": "ageIndx",
Http Status Code: 400
{ "errorMessage": "graph [demo] is not found", "errorCode": "GES.8605"
}
400 Bad Request 请求错误。
401 Unauthorized 鉴权失败。
403 Forbidden 没有操作权限。
404 Not Found 找不到资源。
500 Internal Server Error 服务内部错误。
503 Service Unavailable 服务不可用。