tencent cloud



Last updated: 2022-02-21 10:00:22

1. API Description

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

This API is used to query file systems.

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.
This document describes the parameters for Signature V1. It's recommended to use the V3 signature, which provides higher security. Note that for Signature V3, the common parameters need to be placed in the HTTP Header. See details.

Parameter Name Required Type Description
Action Yes String Common parameter. The value used for this API: DescribeCfsFileSystems.
Version Yes String Common parameter. The value used for this API: 2019-07-19.
Region Yes String Common parameter. For more information, please see the list of regions supported by the product.
FileSystemId No String File system ID
VpcId No String VPC ID
SubnetId No String Subnet ID

3. Output Parameters

Parameter Name Type Description
FileSystems Array of FileSystemInfo File system information
TotalCount Integer Total number of file systems
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Querying file systems

Input Example

&<Common request parameters>

Output Example

  "Response": {
    "RequestId": "fjo8aejo-fjei-32eu-2je9-fhue83nd81",
    "TotalCount": 1,
    "FileSystems": [
        "Protocol": "NFS",
        "Zone": "ap-guangzhou-3",
        "CreationToken": "test_fs",
        "StorageType": "SD",
        "Encrypted": false,
        "CreationTime": "2019-07-29 18:57:17",
        "StorageResourcePkg": "",
        "ZoneId": 100003,
        "SizeByte": 0,
        "FileSystemId": "cfs-12345",
        "KmsKeyId": "",
        "LifeCycleState": "mounting",
        "Capacity": 1000,
        "PGroup": {
          "PGroupId": "pgroupbasic",
          "Name": "Default permission group"
        "SizeLimit": 0,
        "BandwidthResourcePkg": "",
        "FsName": "test_fs",
        "AppId": 12700000,
        "BandwidthLimit": 200

5. Developer Resources


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
AuthFailure.UnauthorizedOperation Request unauthorized.
InternalError Internal error.
InternalError.GetAccountStatusFailed Failed to get the payment status of the user.
InvalidParameter Invalid parameter.
InvalidParameterValue.InvalidFileSystemId FileSystemId is invalid.
InvalidParameterValue.MissingFileSystemIdOrRegion Either FileSystemId or Region must be selected.
InvalidParameterValue.MissingFsParameter FileSystem is missing.
InvalidParameterValue.TagKeyFilterLimitExceeded Invalid parameter value: the number of tag keys exceeds the upper limit (6).
InvalidParameterValue.TagKeyLimitExceeded The length of the tag key exceeds the upper limit of 127 bytes.
InvalidParameterValue.UnavailableRegion Services are unavailable in this AZ.
UnsupportedOperation.OutOfService Your account is in arrears. Please top up and try again.
UnsupportedOperation.UnverifiedUser Unverified user.
Contact Us

Contact our sales team or business advisors to help your business.

Technical Support

Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

7x24 Phone Support