Clearing a Graph
URI
POST /ges/v1.0/{project_id}/graphs/{graph_name}/action?action_id=clear-graph
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 |
---|---|---|---|
clearMetadata | No | Boolean | Whether to clear schema data. The default value is false. |
Response Parameters
Parameter | Mandatory | Description |
---|---|---|
errorMessage | No | System prompt.
|
errorCode | No | System prompt code.
|
jobId | No | ID of an asynchronous job You can view the job execution status and obtain the return result by querying the job ID. For details, see Job Management APIs. |
Example Request
Clear a graph by deleting its schema data.
POST http://{SERVER_URL}/ges/v1.0/{project_id}/graphs/{graph_name}/action?action_id=clear-graph{"clearMetadata": true}
Example Response
Status code: 200
Example response (successful request)
Http Status Code: 200{"jobId": "b4f2e9a0-0439-4edd-a3ad-199bb523b613"}
Status code: 400
Example response for a failed request
Http Status Code: 400{"errorCode": "GES.8012","errorMessage": "graph [movie2] is not found"}
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.
- URI
- Request Parameters
- Response Parameters
- Example Request
- Example Response
- Status Codes
- Error Codes