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

Unbinding Cloud Storage

Function

This API is used to unbind cloud storage.

URI

DELETE /v1/{project_id}/cae/volumes/{id}

Table 1 Path parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID. See Obtaining a Project ID.

id

Yes

String

Cloud storage 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.

X-Environment-ID

Yes

String

Environment ID.

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

api_version

String

API version. Fixed value: v1.

Enumerated value:

  • v1

kind

String

API type. Fixed value: Component.

Enumerated value:

  • Component

items

Array of MountComponent objects

List of mounted components.

Table 4 MountComponent

Parameter

Type

Description

env_id

String

Environment ID.

env_name

String

Environment name.

app_id

String

Application ID.

app_name

String

Application name.

component_id

String

Component ID.

component_name

String

Component name.

Example Request

Unbind cloud storage.

DELETE https://{endpoint}/v1/{project_id}/cae/volumes/{id}

Example Response

Status code: 200

If {} is returned, the cloud storage is successfully unbound. If components are returned, the cloud storage is mounted to them and cannot be unbound.

{
  "api_version" : "v1",
  "kind" : "Component",
  "items" : [ {
    "env_id" : "5d3d1e90-2f5d-4ef1-958b-3fc1ed0b0898",
    "env_name" : "test",
    "app_id" : "c904781d-aea0-49d4-b756-9b847a10a437",
    "app_name" : "test",
    "component_id" : "f5de88cc-64be-4f70-ac17-db745eb76e67",
    "component_name" : "test-config"
  } ]
}

Status Code

Status Code

Description

200

If {} is returned, the cloud storage is successfully unbound. If components are returned, the cloud storage is mounted to them and cannot be unbound.

Error Code

For details, see Error Codes.