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 global vertex indexes (GlobalCompositeVertexIndex) and global edge indexes (GlobalCompositeEdgeIndex). Composite indexes can be used to create indexes on labels and properties. Indexes can accelerate the query speed.
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 Based on Filter Criteria and Querying Edges Based on Filter Criteria. You can also use full-text indexes in Cypher statements. For details, see Cypher Operation APIs.
- 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.

Index Feature

Feature	Fuzzy Search	Speed	Flexibility
Composite indexes	No	Fast	Fixed composite property keys only

URI

POST /ges/v1.0/{project_id}/graphs/{graph_name}/indices

**Table 1** URI parameters
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

Example Request

Create a composite index. The index name is ageIndex and the index type is global vertex index.

POST http://{SERVER_URL}/ges/v1.0/{project_id}/graphs/{graph_name}/indices
{
    "indexName":"ageIndex",
    "indexType": "GlobalCompositeVertexIndex",

    "hasLabel": "true",
    "indexProperty": ["age"]
}

SERVER_URL: Address for accessing a graph. For details about its value, see Using Service Plane APIs.

Request Parameters

**Table 2** Request body 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. The value is case-sensitive. GlobalCompositeVertexIndex is a global composite vertex index.
hasLabel	No	Boolean	Whether labels exist. The default value is false. true false
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.

Response Parameters

**Table 3** Response body parameters
Parameter	Type	Description
errorMessage	String	System prompt. If execution succeeds, this parameter may be left blank. If execution fails, this parameter is used to display the error message.
errorCode	String	System prompt code. If execution succeeds, this parameter may be left blank. If execution fails, this parameter is used to display the error code.
jobId	String	ID of an asynchronous job NOTE: You can view the job execution status and obtain the return result by querying the job ID. For details, see Job Management APIs.
jobType	Integer	Type of an asynchronous job
result	String	If the execution is successful, the value of result is success.

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.