tencent cloud

Feedback

DeleteCfsFileSystem

Last updated: 2023-07-04 17:30:00

1. API Description

Domain name for API request: cfs.tencentcloudapi.com.

This API is used to delete a file system.

A maximum of 20 requests can be initiated per second for this API.

We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

Parameter Name Required Type Description
Action Yes String Common Params. The value used for this API: DeleteCfsFileSystem.
Version Yes String Common Params. The value used for this API: 2019-07-19.
Region No String Common Params. This parameter is not required for this API.
FileSystemId Yes String File system ID. Note: please call the DeleteMountTarget API to delete the mount target first before deleting a file system; otherwise, the delete operation will fail.

3. Output Parameters

Parameter Name Type Description
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Deleting a file system

Input Example

POST / HTTP/1.1
Host: cfs.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DeleteCfsFileSystem
<Common request parameters>

{
    "FileSystemId": "cfs-12345"
}

Output Example

{
    "Response": {
        "RequestId": "xxxx"
    }
}

5. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

6. Error Code

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

Error Code Description
FailedOperation.MountTargetExists There are mount targets on the file system.
FailedOperation.UntagResourceFailed Failed to unbind the resource tag.
InternalError Internal error.
InternalError.GetAccountStatusFailed Failed to get the payment status of the user.
InvalidParameter Invalid parameter.
InvalidParameterValue.InvalidFileSystemId FileSystemId is invalid.
InvalidParameterValue.InvalidFsStatus Invalid file system status.
InvalidParameterValue.InvalidRegionZoneInfo Either ZoneName or ZoneId, Region must be selected.
InvalidParameterValue.MissingFsParameter FileSystem is missing.
ResourceNotFound.FileSystemNotFound The file system does not exist.
UnsupportedOperation Unsupported operation.
UnsupportedOperation.OutOfService Your account is in arrears. Please top up and try again.
UnsupportedOperation.UnverifiedUser Unverified user.