Call the ListFs API to query the list of file storage instances.

Request parameters

Query

Parameter	Category	Required or not	Example value	Note
FsName	String	Not supported	doc-test-cfs-1	Name of a single file storage instance. If not specified, all instances are queried.
MetaStatus	String	Not supported	UP	Query by file storage instance status. Supported statuses are as follows: REGISTERED: Creating INIT: Creating CREATING: Creating UP: Running TO_ENABLE_CACHE: Enabling cache acceleration ENABLING_CACHE: Enabling cache acceleration TO_SCALE_UP_CACHE: Scaling up SCALING_UP_CACHE: Scaling up TO_UPDATE: Updating UPDATING: Updating TO_MINOR_UPDATE: Updating MINOR_UPDATING: Updating TO_DELETE Deleting DELETING Deleting CREATE_FAILED: Creation failed ENABLE_CACHE_FAILED: Failed to enable cache acceleration SCALE_UP_CACHE_FAILED: Scaling up failed UPDATE_FAILED: Update failed DELETE_FAILED: Deletion failed ERROR: Exception DOWN: Exception
StatusOrder	String	Not supported	DESC	Sort by the status of the file storage instance: DESC: Descending order ASC: Ascending order
FsNameOrder	String	Not supported	DESC	Sort by file storage instance name: DESC: Descending order ASC: Ascending order
CreateTimeOrder	String	Not supported	DESC	Sort by file storage instance creation time: DESC: Descending order ASC: Ascending order
PageNumber	Integer	Not supported	0	Page number, starting from 0.
PageSize	Integer	Not supported	10	The number of file storage instances displayed per page.

Response parameters

Parameter	Category	Example value	Note
Items	List	[fs1, fs2]	List of file storage instances. For details, see Filesystem data structure.
TotalSize	String	1	Total number of file storage instances that meet the query criteria.
PageNumber	Integer	0	Current page number.
PageSize	Integer	10	Number of file storage instances displayed per page.

Filesystem data structure

Parameter	Category	Example value	Note
Name	String	doc-test-cfs-1	Name of the file storage instance.
Id	String	180143**9482812	ID of the file storage instance.
Status	String	UP	Status of the file storage instance: REGISTERED: Creating INIT: Creating CREATING: Creating UP: Running TO_ENABLE_CACHE: Enabling cache acceleration ENABLING_CACHE: Enabling cache acceleration TO_SCALE_UP_CACHE: Scaling up SCALING_UP_CACHE: Scaling up TO_UPDATE: Updating UPDATING: Updating TO_MINOR_UPDATE: Updating MINOR_UPDATING: Updating TO_DELETE Deleting DELETING Deleting CREATE_FAILED: Creation failed ENABLE_CACHE_FAILED: Failed to enable cache acceleration SCALE_UP_CACHE_FAILED: Scaling up failed UPDATE_FAILED: Update failed DELETE_FAILED: Deletion failed ERROR: Exception DOWN: Exception
RegionId	String	cn-beijing	The Region to which the file storage instance belongs.
ZoneId	String	cn-beijing-a	Availability Zone of the file storage instance.
CachePlan	String	T2	Cache acceleration baseline. DISABLED: Cache acceleration disabled T2: 200MB/s/TiB baseline T4: 400MB/s/TiB baseline
CacheCapacityTiB	Integer	10	Cache acceleration capacity, in TiB. To expand cache acceleration capacity, see UpdateFs.
VpcId	String	vpc-id123	Private network ID. No value is returned when cache acceleration is not enabled.
SubnetId	String	subnet-123	Subnet ID. No value is returned when cache acceleration is not enabled.
SecurityGroupId	String	sg-123	Security group ID. No value is returned when cache acceleration is not enabled.
Mode	String	HDFS_MODE	Application scenarios for file storage instances: HDFS_MODE: File storage scenario ACC_MODE: Data lake scenario
TosBucket	String	Bucket-name	The object storage bucket used by the file storage instance.
TosPrefix	String	prefix/	File prefix of the object storage bucket.
CreatedTime	String	2023-04-21T15:30:25	Creation time of the file storage instance.
MountPoint	String	doc-test-cfs-1.cfs-cn-beijing.ivolces.com	Mount target address of the file storage instance.

Request example

Response example

Error codes

The following table lists the error codes for this API. For public error codes, please refer to Public error codes.

HttpCode	Error code	Error message
400	InvalidFsName	When entering FsName, the file storage instance name is invalid. The file storage instance name supports only letters and numbers, and must start with a letter. The file storage instance name must be between 2 and 63 characters in length.
404	FsNameNotFound	When entering the FsName parameter, the FsName does not belong to this account.
500	InternalError	Service failure, unable to list.
400	EmptyRegionId	The Region must not be empty.
400	InvalidRegionId	The specified Availability Zone does not exist or does not match the Availability Zone registered with the CFS service.

Big Data File Storage