Help Center/ Scalable File Service/ API Reference/ SFS Turbo APIs/ Storage Interworking Management/ Removing a Storage Backend
Updated on 2025-07-22 GMT+08:00
View PDF
Share

Removing a Storage Backend

Function

This API is used to remove a storage backend.

Constraints

  • This API is only supported for SFS Turbo 1,000 MB/s/TiB, 500 MB/s/TiB, 250 MB/s/TiB, 125 MB/s/TiB, 40 MB/s/TiB, and 20 MB/s/TiB file systems.

  • This API is only supported for NFS file systems.

URI

DELETE /v1/{project_id}/sfs-turbo/shares/{share_id}/targets/{target_id}

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

The project ID.

share_id

Yes

String

The file system ID.

target_id

Yes

String

The storage backend ID.
Table 2 Query Parameters

Parameter

Mandatory

Type

Description

delete_data_in_file_system

No

Boolean

Whether to delete the corresponding interworking directory and data files in that directory. The default value is false. Deleted data cannot be recovered.

Request Parameters

Table 3 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

The account token.

Content-Type

Yes

String

The MIME type.

Response Parameters

Status code: 202

Table 4 Response header parameters

Parameter

Type

Description

X-request-id

String

The request ID.
Table 5 Response body parameters

Parameter

Type

Description

target_id

String

The storage backend ID.

delete_data_in_file_system

Boolean

Whether to delete the corresponding interworking directory and data files in that directory.

lifecycle

String

The association status. Only DELETING and FAILED are supported.

Enumeration values:

  • DELETING

  • FAILED

Status code: 404

Table 6 Response body parameters

Parameter

Type

Description

errCode

String

The error code.

errMsg

String

The error message.

Status code: 500

Table 7 Response body parameters

Parameter

Type

Description

errCode

String

The error code.

errMsg

String

The error message.

Example Requests

Deleting the storage backend whose ID is 11abef677ac40f46644d1d5cfc2424a4 for the file system whose ID is 77ba6f4b-6365-4895-8dda-bc7142af4dde

DELETE HTTPS://{endpoint}/v1/{project_id}/sfs-turbo/shares/77ba6f4b-6365-4895-8dda-bc7142af4dde/targets/11abef677ac40f46644d1d5cfc2424a4

Example Responses

Status code: 202

Task delivered

{
  "target_id" : "00000334-xxxx-402d-a5d4-bxxxxx87b939",
  "delete_data_in_file_system" : false,
  "life_cycle" : "DELETING"
}

Status code: 404

Error response

{
  "errCode" : "SFS.TURBO.0126",
  "errMsg" : "target not found, not bound yet"
}

Status code: 500

Error response

{
  "errCode" : "SFS.TURBO.0005",
  "errMsg" : "internal server error"
}

Status Codes

Status Code

Description

202

Task delivered

404

Error response

500

Error response

Error Codes

See Error Codes.