Updated on 2023-11-23 GMT+08:00

Deleting a Deployment

Function

This API is used to delete a Deployment.

URI

DELETE /v3/{project_id}/edgemgr/deployments/{deployment_id}

Table 1 Path parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

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

deployment_id

Yes

String

Deployment ID.

Table 2 Deletion parameter

Parameter

Mandatory

Type

Description

force_delete

No

String

Whether the Deployment is forcibly deleted. The default value is false.

Request

Table 3 Parameters in the request header

Parameter

Mandatory

Type

Description

Content-Type

Yes

String

Message body type (format).

The default value application/json is recommended.

X-Auth-Token

Yes

String

User token. The token can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token.

Response

When the status code is 400, the response parameters are as follows:

Table 4 Parameters in the response body

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error description.

When the status code is 500, the response parameters are as follows:

Table 5 Parameters in the response body

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error description.

Example Request

None

Example Response

Example response with status code 400:

{
	"error_code" : "IEF.100001",
	"error_msg" : "PROJECT_ID not found"
}

Example response with status code 500:

{
	"error_code" : "IEF.100158",
	"error_msg" : "Fail to extract gpu information"
}

Error Codes

For details, see Error Codes.