Help Center/ Scalable File Service Turbo/ API Reference/ API/ Storage Interworking Management/ Deleting a Backend Target
Updated on 2024-11-13 GMT+08:00
View PDF
Share

Deleting a Backend Target

Function

This API is used to delete a backend target.

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.

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

Project ID

share_id

Yes

String

File system ID

target_id

Yes

String

Target ID
Table 2 Query Parameters

Parameter

Mandatory

Type

Description

delete_data_in_file_system

No

Boolean

Whether to delete the corresponding file system interworking directory and data files in it. 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

Account token

Content-Type

Yes

String

MIME type

Response Parameters

Status code: 202

Table 4 Response header parameters

Parameter

Type

Description

X-request-id

String

Request ID
Table 5 Response body parameters

Parameter

Type

Description

target_id

String

Target ID

delete_data_in_file_system

Boolean

Whether to delete the corresponding file system interworking directory and data files in it.

lifecycle

String

Target status returned. Only DELETING and FAILED are supported.

Status code: 404

Table 6 Response body parameters

Parameter

Type

Description

errCode

String

Error code

errMsg

String

Error description

Status code: 500

Table 7 Response body parameters

Parameter

Type

Description

errCode

String

Error code

errMsg

String

Error description

Example Requests

Deleting the backend target 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 submitted

{
  "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 submitted

404

Error response

500

Error response

Error Codes

See Error Codes.