Help & DocumentationAPIsCloud File StorageFile System APIsDescribeCfsFileSystems

DescribeCfsFileSystems

Last updated: 2020-03-16 10:07:00

Contents：

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.

Note: This API supports Finance regions. If the common parameter Region is a Finance region, a domain name with the Finance region needs to be specified, for example: cfs.ap-shanghai-fsi.tencentcloudapi.com

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 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 Describe File Systems

Input Example

https://cfs.tencentcloudapi.com/?Action=DescribeCfsFileSystems
&FileSystemId=cfs-12345
&<common request parameters>

Output Example

{
  "Response": {
    "RequestId": "fjo8aejo-fjei-32eu-2je9-fhue83nd81",
    "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",
        "PGroup": {
          "PGroupId": "pgroupbasic",
          "Name": "Default permission group"
        },
        "SizeLimit": 0,
        "BandwidthResourcePkg": "",
        "FsName": "test_fs"
      }
    ]
  }
}

5. Developer Resources

API Explorer

This tool allows online call, signature authentication, SDK code generation and quick search of APIs to greatly improve the efficiency of using TencentCloud APIs.

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
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.UnavailableRegion Services are unavailable in this AZ.
UnsupportedOperation.OutOfService Your account is in arrears. Please top up and try again.
UnsupportedOperation.UnverifiedUser Unverified user.