帮你快速理解、总结文档立即下载

查询文件系统

最近更新时间:2026-09-18 01:18:13
我的收藏

1. 接口描述

接口请求域名: cfs.tencentcloudapi.com 。

本接口(DescribeCfsFileSystems)用于查询文件系统

默认接口请求频率限制:20次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeCfsFileSystems。
Version String 公共参数,本接口取值:2019-07-19。
Region String 公共参数,详见产品支持的 地域列表
FileSystemId String

文件系统 ID


示例值:cfs-12345
VpcId String

私有网络(VPC) ID


示例值:vpc-12345
SubnetId String

子网 ID


示例值:subnet-12345
Offset Integer

Offset 分页码,默认0


示例值:10
Limit Integer

Limit 页面大小,默认10


示例值:10
CreationToken String

用户自定义名称


示例值:test_fs
Filters.N Array of Filter

过滤条件。

  • Protocol - Array of String - 是否必填:否 -(过滤条件)按协议过滤。(NFS | CIFS | TURBO)


  • StorageType - Array of String - 是否必填:否 -(过滤条件)按存储类型过滤。(SD | HP | TB | TP | THP)


  • LifeCycleState - Array of String - 是否必填:否 -(过滤条件)按生命周期过滤。(creating | create_failed | available | deleting | delete_failed | upgrading | unserviced | expanding)


  • Zone - Array of String - 是否必填:否 -(过滤条件)按可用区过滤。(例如:ap-guangzhou-3)


  • IpAddress - Array of String - 是否必填:否 -(过滤条件)按导出点IP地址过滤。(例如:10.0.0.3)


  • PGroupId - Array of String - 是否必填:否 -(过滤条件)按权限组ID过滤。(例如:pgroup-xxxxxrxt)


  • PGroupName - Array of String - 是否必填:否 -(过滤条件)按权限组名称过滤。(例如:默认权限组)


  • Scenario- Array of String - 是否必填:否 -(过滤条件)按权限组名称过滤。(例如:AgentSandbox)
  • Tags.N Array of TagInfo

    标签

    3. 输出参数

    参数名称 类型 描述
    FileSystems Array of FileSystemInfo

    文件系统信息

    TotalCount Integer

    文件系统总数


    示例值:1
    RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

    4. 示例

    示例1 查询文件系统

    查询文件系统

    输入示例

    POST / HTTP/1.1
    Host: cfs.tencentcloudapi.com
    Content-Type: application/json
    X-TC-Action: DescribeCfsFileSystems
    <公共请求参数>
    
    {
        "FileSystemId": "cfs-318f2b7ba"
    }

    输出示例

    {
        "Response": {
            "FileSystems": [
                {
                    "AppId": 1300275735,
                    "AutoScaleUpRule": {
                        "ScaleThreshold": 80,
                        "TargetThreshold": 70,
                        "Status": "open"
                    },
                    "AutoSnapshotPolicyId": "",
                    "BandwidthLimit": 100,
                    "BandwidthResourcePkg": "",
                    "Capacity": 2097152,
                    "CreationTime": "2024-07-09 10:52:35",
                    "CreationToken": "denny-test-003",
                    "Encrypted": false,
                    "FileSystemId": "cfs-318f2b7ba",
                    "FsName": "denny-test-003",
                    "KmsKeyId": "",
                    "LifeCycleState": "available",
                    "PGroup": {
                        "Name": "默认权限组",
                        "PGroupId": "pgroupbasic"
                    },
                    "Protocol": "NFS",
                    "SizeByte": 0,
                    "SizeLimit": 1000000,
                    "SnapStatus": "normal",
                    "StorageResourcePkg": "",
                    "StorageType": "SD",
                    "Tags": [],
                    "TieringDetail": {
                        "SecondaryTieringSizeInBytes": -1,
                        "TieringSizeInBytes": -1
                    },
                    "TieringState": "NotAvailable",
                    "Zone": "ap-guangzhou-2",
                    "ZoneId": 100002
                }
            ],
            "RequestId": "8edb5b83-6bd2-4f0a-8ee9-d8ee96fff8dc",
            "TotalCount": 1
        }
    }

    5. 开发者资源

    腾讯云 API 平台

    腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

    API Inspector

    用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

    SDK

    云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

    命令行工具

    6. 错误码

    以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

    错误码 描述
    AuthFailure.TokenFailure 鉴权token超时
    AuthFailure.UnauthorizedOperation 请求未CAM授权。
    InternalError 内部错误。
    InternalError.GetAccountStatusFailed 获取用户费用状态失败。
    InvalidParameter 参数错误。
    InvalidParameterValue.InvalidFileSystemId FileSystemId无效。
    InvalidParameterValue.MissingFileSystemIdOrRegion 用户参数选择错误 (FileSystemId) 或 (Region)二者必选一。
    InvalidParameterValue.MissingFsParameter FileSystem参数缺失。
    InvalidParameterValue.TagKeyFilterLimitExceeded 参数值错误: 标签键个数超过上限(6个)。
    InvalidParameterValue.TagKeyLimitExceeded 标签键长度超过限制(不能超过127字节)。
    InvalidParameterValue.UnavailableRegion 该可用区无法提供服务。
    UnsupportedOperation 操作不支持。
    UnsupportedOperation.OutOfService 用户已欠费, 请充值后重试。
    UnsupportedOperation.UnverifiedUser 用户未经过实名认证。