ListFs--大数据文件存储-火山引擎

文档中心

导航

ListFs

最近更新时间：2023.05.18 15:33:39首次发布时间：2022.05.26 14:18:33

调用 ListFs 接口，查询文件存储实例列表。

请求参数

Query

参数	类型	是否必填	示例值	说明
FsName	String	否	doc-test-cfs-1	单个文件存储实例的名称。不填，则表示查询所有实例。
MetaStatus	String	否	UP	根据文件存储实例的状态进行查询，支持的状态如下： REGISTERED：创建中 INIT：创建中 CREATING：创建中 UP：运行中 TO_ENABLE_CACHE：开启缓存加速中 ENABLING_CACHE：开启缓存加速中 TO_SCALE_UP_CACHE：扩容中 SCALING_UP_CACHE：扩容中 TO_UPDATE：更新中 UPDATING：更新中 TO_MINOR_UPDATE：更新中 MINOR_UPDATING：更新中 TO_DELETE 删除中 DELETING 删除中 CREATE_FAILED：创建失败 ENABLE_CACHE_FAILED：开启缓存加速失败 SCALE_UP_CACHE_FAILED：扩容失败 UPDATE_FAILED：更新失败 DELETE_FAILED：删除失败 ERROR：异常 DOWN：异常
StatusOrder	String	否	DESC	根据文件存储实例状态进行排序： DESC：降序排列 ASC：升序排列
FsNameOrder	String	否	DESC	根据文件存储实例名称进行排序： DESC：降序排列 ASC：升序排列
CreateTimeOrder	String	否	DESC	根据文件存储实例创建时间进行排序： DESC：降序排列 ASC：升序排列
PageNumber	Integer	否	0	页数，从 0 开始。
PageSize	Integer	否	10	每页展示文件存储实例的数量。

返回参数

参数	类型	示例值	说明
Items	List	[fs1, fs2]	文件存储实例列表。详情请参见 Filesystem 数据结构。
TotalSize	String	1	满足查询条件的文件存储实例的总数。
PageNumber	Integer	0	当前页码。
PageSize	Integer	10	每页能展示的文件存储实例数量。

Filesystem 数据结构

参数	类型	示例值	说明
Name	String	doc-test-cfs-1	文件存储实例的名称。
Id	String	180143**9482812	文件存储实例的 ID。
Status	String	UP	文件存储实例的状态： REGISTERED：创建中 INIT：创建中 CREATING：创建中 UP：运行中 TO_ENABLE_CACHE：开启缓存加速中 ENABLING_CACHE：开启缓存加速中 TO_SCALE_UP_CACHE：扩容中 SCALING_UP_CACHE：扩容中 TO_UPDATE：更新中 UPDATING：更新中 TO_MINOR_UPDATE：更新中 MINOR_UPDATING：更新中 TO_DELETE 删除中 DELETING 删除中 CREATE_FAILED：创建失败 ENABLE_CACHE_FAILED：开启缓存加速失败 SCALE_UP_CACHE_FAILED：扩容失败 UPDATE_FAILED：更新失败 DELETE_FAILED：删除失败 ERROR：异常 DOWN：异常
RegionId	String	cn-beijing	文件存储实例所属地域。
ZoneId	String	cn-beijing-a	文件存储实例的可用区。
CachePlan	String	T2	缓存加速基线。 DISABLED：禁用缓存加速 T2：使用 200MB/s/TiB 基线 T4：使用 400MB/s/TiB 基线
CacheCapacityTiB	Integer	10	缓存加速容量，单位为 TiB。如需扩容缓存加速容量，请参见UpdateFs。
VpcId	String	vpc-id123	私有网络 ID。当未启用缓存加速功能时，不返回值。
SubnetId	String	subnet-123	子网 ID。当未启用缓存加速功能时，不返回值。
SecurityGroupId	String	sg-123	安全组 ID。当未启用缓存加速功能时，不返回值。
Mode	String	HDFS_MODE	文件存储实例的应用场景： HDFS_MODE：文件存储场景 ACC_MODE：数据湖场景
TosBucket	String	Bucket-name	文件存储实例使用的对象存储桶。
TosPrefix	String	prefix/	对象存储桶的文件前缀。
CreatedTime	String	2023-04-21T15:30:25	文件存储实例的创建时间。
MountPoint	String	doc-test-cfs-1.cfs-cn-beijing.ivolces.com	文件存储实例的挂载点地址。

请求示例

GET https://open.volcengineapi.com?Action=ListFs&Version=2022-02-02&FsName=doc-test-cfs-1
Content-Type: application/json
Region: cn-beijing
ServiceName: cfs

返回示例

{
    "Result": {
        "Items": [
            {
                "Name": "doc-test-cfs-1",
                "Id": "180143***482812",
                "Status": "CREATING",
                "RegionId": "cn-beijing",
                "ZoneId": "cn-beijing-b",
                "Mode": "HDFS_MODE",
                "TosBucket": null,
                "TosPrefix": null,
                "CacheMode": null,
                "CachePlan": "DISABLED",
                "CacheCapacity": 0,
                "CacheCapacityTiB": 0,
                "CreatedTime": "2023-04-21T15:30:25",
                "NsQuota": 50,
                "NsCount": 1,
                "VpcId": null,
                "SecurityGroupId": null,
                "SubnetId": null,
                "MountPoint": null
            }
        ],
        "TotalSize": "1",
        "PageNumber": 0,
        "PageSize": 10
    },
    "ResponseMetadata": {
        "RequestId": "202304211531311A96B08746BE3D3BED43",
        "Action": "ListFs",
        "Version": "2022-02-02",
        "Service": "cfs",
        "Region": "cn-beijing",
        "Error": null
    }
}

错误码

下表列举了本接口的错误码信息。公共错误码信息，请参考公共错误码。

HttpCode	错误码	错误信息
400	InvalidFsName	输入 FsName 时，文件存储实例名称不合法。文件存储实例名称仅支持字母、数字、英文，且以字母开头。文件存储实例名称字符长度在 2-63 内。
404	FsNameNotFound	输入 FsName 参数时，FsName 不属于本账户。
500	InternalError	服务故障，无法列出。
400	EmptyRegionId	可用地域不应为空。
400	InvalidRegionId	可用区域不存在或者与 cfs 服务注册的 region 不符。