DeleteFileset

更新时间:
复制 MD 格式

Deletes a fileset.

Operation description

  • Only CPFS 2.2.0 and later and CPFS for Lingjun 2.7.0 and later support fileset deletion. After a fileset is deleted, all data in the directory is permanently deleted and cannot be recovered. Proceed with caution.

  • If deletion protection is enabled, disable it before you delete the fileset.

  • All filesets on the destination file system must be in the CREATED desired state before you can perform the delete operation.

  • Deleting a CPFS fileset immediately releases disk space. Deleting a CPFS for Lingjun fileset gradually releases disk space. Deleted data cannot be recovered. Proceed with caution.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

  • Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.

  • API: The API that you can call to perform the action.

  • Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.

  • Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.

    • For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.

    • For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.

  • Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.

  • Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

nas:DeleteFileset

delete

*Fileset

acs:nas:{#regionId}:{#accountId}:filesystem/{#filesystemId}

None None

Request parameters

Parameter

Type

Required

Description

Example

FileSystemId

string

Yes

The file system ID.

  • CPFS: The ID must start with cpfs-, such as cpfs-099394bd928c****.

  • CPFS for Lingjun: The ID must start with bmcpfs-, such as bmcpfs-290w65p03ok64ya****.

bmcpfs-290w65p03ok64ya****

FsetId

string

Yes

The fileset ID.

fset-1902718ea0ae****

DryRun

boolean

No

Specifies whether to perform a dry run for this delete request.

A dry run checks parameter validity and resource availability without actually deleting the instance.

Valid values:

  • true: Sends a dry run request without deleting the instance. The system checks whether the required parameters are specified, whether the request format is valid, and whether business requirements are met. If the check fails, the corresponding error is returned. If the check succeeds, HTTP status code 200 is returned.

  • false (default): Sends a regular request. After the check succeeds, the instance is directly deleted.

false

ClientToken

string

No

The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but make sure that the token is unique among different requests.

The token can contain only ASCII characters and cannot exceed 64 characters in length. For more information, see How to ensure idempotence.

Note

If you do not specify this parameter, the system automatically uses the RequestId of the API request as the ClientToken. The RequestId may differ for each API request.

123e4567-e89b-12d3-a456-42665544****

Response elements

Element

Type

Description

Example

object

RequestId

string

The request ID.

2D69A58F-345C-4FDE-88E4-BF518948****

Examples

Success response

JSON format

{
  "RequestId": "2D69A58F-345C-4FDE-88E4-BF518948****"
}

Error codes

HTTP status code

Error code

Error message

Description

400 IllegalCharacters The parameter contains illegal characters. The parameter contains illegal characters.
400 MissingFileSystemId FileSystemId is mandatory for this action.
400 MissingFsetId FsetId is mandatory for this action.
400 InvalidFilesetId.NotFound Invalid FilesetId. Fileset does not exist
403 OperationDenied.DependencyViolation The operation is denied due to dependancy violation.
403 OperationDenied.FilesetNotSupported The operation is not supported.
403 InvalidOperation.DeletionProtection The operation is not allowed due to resource is protected by deletion protection.
404 InvalidFileSystem.NotFound The specified file system does not exist. The specified file system does not exist.
404 InvalidFsetId.NotFound The specified Fileset ID does not exist.
429 Throttling.Api Request was denied due to api flow control. The request is throttled.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.