Deleting an Index
Function
This API is used to delete an index based on the specified indexName.
URI
DELETE /ges/v1.0/{project_id}/graphs/{graph_name}/indices/{indexName}
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 |
indexName | Yes | String | Index name |
Response Parameters
Parameter | Type | Description |
---|---|---|
errorMessage | String | System prompt.
|
errorCode | String | System prompt 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 | String | Type of an asynchronous job |
Example Request
Delete an index by name. The index name is ageIndex.
DELETE http://{SERVER_URL}/ges/v1.0/{project_id}/graphs/{graph_name}/indices/ageIndex
SERVER_URL: Address for accessing a graph. For details about its value, see Using Service Plane APIs.
Example Response
Status code: 200
Example response for a successful request
Http Status Code: 200{"jobId": "fb74314e-a82d-41b2-8900-96e2559fa0d9000168232","jobType": 9}
Status code: 400
Example response for a failed request
Http Status Code: 400{"errorMessage": "graph [demo] is not found","errorCode": "GES.8604 "}
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.
- Function
- URI
- Response Parameters
- Example Request
- Example Response
- Status Codes
- Error Codes