Updated on 2025-02-14 GMT+08:00

Deleting an Environment

Function

This API is used to delete an environment.

URI

DELETE /v1/{project_id}/cae/environments/{environment_id}

Table 1 Path parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID. See Obtaining a Project ID.

environment_id

Yes

String

Environment ID.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token.

Maximum characters: 16,384

X-Enterprise-Project-ID

No

String

Enterprise project ID.

  • When an environment is created, it will be bound with an enterprise project ID.
  • Enter 0 or up to 36 characters in UUID format with hyphens (-).
  • If this parameter is not specified or set to 0, resources in the default enterprise project are queried.
NOTE:

For more information about enterprise projects and how to obtain enterprise project IDs, see Enterprise Management User Guide.

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

job_id

String

Job ID.

Example Request

Delete an environment.

DELETE https://{endpoint}/v1/{project_id}/cae/environments/{environment_id}

Example Response

Status code: 200

The request is successful.

{
  "job_id" : "xxx"
}

Status Code

Status Code

Description

200

The request is successful.

Error Code

For details, see Error Codes.