tencent cloud



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

1. API Description

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

This API is used to query clients on which this file system is mounted. To do so, the client needs to have the CFS monitoring plugin installed.

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: DescribeCfsFileSystemClients.
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

3. Output Parameters

Parameter Name Type Description
ClientList Array of FileSystemClient Client list
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Querying file system clients

Input Example

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

    "FileSystemId": "cfs-12345"

Output Example

    "Response": {
        "RequestId": "aaaa-bbbb-cccc-dddd",
        "ClientList": [
                "MountDirectory": "/mnt",
                "ZoneName": "Guangzhou Zone 1",
                "Zone": "ap-guangzhou-1",
                "VpcId": "vpc-gvem39gr",
                "ClientIp": "",
                "CfsVip": ""

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
InternalError Internal error.
InvalidParameterValue.InvalidFileSystemId FileSystemId is invalid.
InvalidParameterValue.MissingFileSystemId FileSystemId is missing.
ResourceNotFound.FileSystemNotFound The file system does not exist.
ResourceNotFound.MountTargetNotFound The mount target does not exist.
ResourceNotFound.PgroupNotFound The permission group does not exist.
UnsupportedOperation Unsupported operation.
UnsupportedOperation.OutOfService Your account is in arrears. Please top up and try again.
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