Deleting a Label
Function
This API is used to delete a label as well as the vertices and edges associated with the label.
URI
DELETE /ges/v1.0/{project_id}/graphs/{graph_name}/schema/labels/{labelName}
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 |
label_name | Yes | String | Name of a label |
Response Parameters
Parameter | Type | Description |
---|---|---|
errorMessage | String | System prompt.
|
errorCode | String | System prompt code.
|
data | Object | Query results. This parameter is left blank when the request fails. |
Parameter | Type | Description |
---|---|---|
outputs | Integer | Number of deleted vertices or edges when a label is deleted. |
Example Request
Delete a label as well as the vertices and edges associated with the label.
DELETE http://{SERVER_URL}/ges/v1.0/{project_id}/graphs/{graph_name}/schema/labels/{labelName}
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{"data": {"outputs": 3},"status": "success"}
Status code: 400
Example response for a failed request
Http Status Code: 400{"errorMessage": "graph [demo] is not found","errorCode": "GES.8003"}
Status Code
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 Code
See Error Code.
- Function
- URI
- Response Parameters
- Example Request
- Example Response
- Status Code
- Error Code