Creating an Index
Function
This API is used to create indexes based on the specified information such as indexName and IndexType. Currently, composite indexes and full-text indexes are supported.
- Composite indexes include GlobalCompositeVertexIndex, GlobalCompositeEdgeIndex, CompositeVertexIndex, and CompositeEdgeIndex. A composite index is created for a fixed combination of properties. A local index can be created on a specified label. You do not need to specify a label for a global composite index. As long as a label contains a specified property, an index is automatically created on the label. Indexes can be used to accelerate queries.
- Full-text indexes (FullTextIndex) can implement functions such as full-text search and fuzzy search. If you search data immediately after an update, you may get the old data. You are advised to query the data 1 second after the update. For details about how to use full-text indexes, see Querying Vertices That Meet Filter Criteria and Querying Edges That Meet Filter Criteria. You can also use full-text indexes in Cypher statements. For details, see Performing Cypher Queries.
- Currently, the full-text indexing feature is supported only in the ECS/BMS+MRS deployment mode.
- After an index is created, wait for 30 seconds for index synchronization. After the synchronization is complete, Cypher queries can be accelerated using the index.
Indexes
Feature |
Fuzzy Search |
Speed |
Flexibility |
---|---|---|---|
Composite indexes |
No |
Fast |
Fixed composite property keys only |
URI
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Project ID. For details about how to obtain the project ID, see Obtaining a Project ID. |
graph_name |
Yes |
String |
Graph name |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
indexName |
Yes |
String |
Index name. Only letters, digits, hyphens (-), and underscores (_) are allowed. Other characters are not allowed. The index name can contain a maximum of 63 characters. |
indexType |
Yes |
String |
Index type, which is case sensitive
|
indexLabel |
No |
List |
Labels on which indexes are created. This parameter is available only when indexType is set to CompositeVertexIndex or CompositeEdgeIndex. This parameter is mandatory. |
indexProperty |
No (If hasLabel is false or null, this parameter is mandatory.) |
String |
Index property list. The property types that can be used to create indexes include integer, float, double, long, enum, char array, string, and date. |

- If a property is of the string or char array type, the value must be no more than 40 bytes. The excess part will be deleted.
- Cypher queries can be accelerated with indexes whose hasLabel is True.
- If indexProperty is left blank, the created index is a label index, which accelerates label filtering.
- If indexProperty is specified, the created index is a property index, which accelerates property filtering.
Response Parameters
Parameter |
Type |
Description |
---|---|---|
errorMessage |
String |
System prompt.
|
errorCode |
String |
System prompt.
|
jobId |
String |
ID of an asynchronous job
NOTE:
|
jobType |
Integer |
Type of an asynchronous job |
result |
String |
If the execution is successful, the value of result is success. |
Example Request
POST http://{SERVER_URL}/ges/v1.0/{project_id}/graphs/{graph_name}/indices { "indexName": "ageIndex", "indexType": "GlobalCompositeVertexIndex", "hasLabel": true, "indexProperty": [] }

SERVER_URL: Address for accessing a graph. For details about its value, see Using Service Plane APIs.
Example Response
Status code: 200
Example response (successful request)
Http Status Code: 200 { "jobId": "f99f60f1-bba6-4cde-bd1a-ff4bdd1fd500000168232", "jobType": 8 }
Status code: 400
Example response (failed request)
Http Status Code: 400 { "errorMessage": "graph [demo] is not found", "errorCode": "GES.8603" }
Status Codes
Return Value |
Description |
---|---|
400 Bad Request |
Request error. |
401 Unauthorized |
Authorization failed. |
403 Forbidden |
No operation permissions. |
404 Not Found |
No resources found. |
500 Internal Server Error |
Internal server error. |
503 Service Unavailable |
Service unavailable. |
Error Codes
See Error Codes.
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