Updated on 2024-05-20 GMT+08:00

Deleting a HyG Graph

Function

This API is used to delete a HyG graph.

URI

DELETE /ges/v1.0/{project_id}/hyg/{graph_name}
Table 1 URI parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID. For how to obtain the project ID, see Obtaining a Project ID.

graph_name

Yes

String

Graph name

Request Parameters

None

Response Parameters

Table 2 Response body parameters

Parameter

Type

Description

errorMessage

String

System prompt

  • If the execution succeeds, this parameter may be left blank.
  • If the execution fails, this parameter is used to display the error message.

errorCode

String

System prompt code

  • If the execution succeeds, this parameter may be left blank.
  • If the 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.

status

String

Job status returned for a successful query. Possible values are waiting, running, and complete. This parameter is left blank when the query fails.

result

String

Execution results

  • If the execution is successful, the value is success.
  • If the execution fails, the value is failed.

Example Request

Delete a HyG graph.

DELETE http://{SERVER_URL}/ges/v1.0/{project_id}/hyg/{graph_name}

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"
}

Status code: 400

Example response for a failed request

Http Status Code: 400
{
     "status": "complete",
     "errorCode": "GES.8011",
     "errorMessage": "graph [movie2] is not found",
     "result": "failed"
}

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.