tencent cloud

Feedback

DescribeFileSystem

Last updated: 2022-03-30 09:36:05

    1. API Description

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

    This API is used to view the details of 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 parameter. The value used for this API: DescribeFileSystem.
    Version Yes String Common parameter. The value used for this API: 2020-11-12.
    Region Yes String Common parameter. For more information, please see the list of regions supported by the product.
    FileSystemId Yes String File system ID

    3. Output Parameters

    Parameter Name Type Description
    FileSystem FileSystem File system
    CapacityUsed Integer Used capacity (in bytes), including STANDARD storage and ARCHIVE storage
    Note: this field may return null, indicating that no valid values can be obtained.
    ArchiveCapacityUsed Integer Used ARCHIVE storage capacity (in bytes)
    Note: this field may return null, indicating that no valid values can be obtained.
    RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

    4. Example

    Example1 Viewing file system details

    This example shows how to view the details of a file system.

    Input Example

    https://chdfs.tencentcloudapi.com/?Action=DescribeFileSystem
    &FileSystemId=f4mhaqkciq0
    &<Common request parameters>
    

    Output Example

    {
    "Response": {
      "FileSystem": {
        "AppId": 1251006373,
        "FileSystemName": "test",
        "Description": "",
        "Region": "ap-guangzhou",
        "FileSystemId": "f4mhaqkciq0",
        "CreateTime": "2019-07-30T17:03:20+08:00",
        "BlockSize": 4194304,
        "CapacityQuota": 1073741824,
        "SuperUsers": [
          "hadoop"
        ],
        "PosixAcl": true,
        "Status": 2
      },
      "CapacityUsed": 0,
      "ArchiveCapacityUsed": 0,
      "RequestId": "22e36f95-9295-4132-a75e-09a08d2e13fc"
    }
    }
    

    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 Operation failed.
    InternalError Internal error.
    InvalidParameter Incorrect parameter.
    InvalidParameterValue Incorrect parameter value.
    InvalidParameterValue.InvalidFileSystemId Incorrect parameter value: FileSystemId.
    MissingParameter Missing parameter.
    ResourceNotFound.FileSystemNotExists The file system does not exist.
    ResourceUnavailable The resource is unavailable.
    UnauthorizedOperation Unauthorized operation.
    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