tencent cloud

Data Accelerator Goose FileSystem

Release Notes and Announcements
Release Notes
Product Selection Guide
GooseFSx
Product Introduction
Quick Start
Purchase Guide
Console Guide
Tool Guide
Practical Tutorial
Service Level Agreement
Glossary
GooseFS
Product Introduction
Billing Overview
Quick Start
Core Features
Console Guide
Developer Guide
Client Tools
Cluster Configuration Practice
Data Security
Service Level Agreement
GooseFS-Lite
GooseFS-Lite Tool
Practical Tutorial
Use GooseFS in Kubernetes to Speed Up Spark Data
Access Bucket Natively with POSIX Semantics Using GooseFS
GooseFS Distributedload Tuning Practice
FAQs
GooseFS Policy
Privacy Policy
Data Processing And Security Agreement

Introduction to File System Instructions

PDF
Focus Mode
Font Size
Last updated: 2025-07-17 17:42:53
The GooseFS command line interface provides users with basic file system operations. You can use the following command to obtain all subcommands:
goosefs fs [generic options]
The command list for the file system is as follows:
Command Operation
Instruction Description
cat <path>
Print the content of files in the specified GooseFS path.
checkConsistency [-r][-t|--threads ] <GooseFS path>
Check metadata consistency between GooseFS and underlying storage.
checksum <GooseFS path>
Calculate the md5 checksum of the specified GooseFS file path.
chgrp [-R]<group><path>
Modify the affiliated user groups of the specified GooseFS file or folder, supporting recursive modification of the affiliated user groups of all files in the specified directory via -R.
chmod [-R]<mode><path>
Modify the access permissions of the specified GooseFS file or folder, supporting recursive modification of the access permissions of all files in the specified directory via -R.
chown [-R]<owner>[:<group>]<path>
Modify the owner information of the specified GooseFS file or folder, supporting recursive modification of the owners of all files in the specified directory via -R.
copyFromLocal [--thread <num>] [--buffersize <bytes>] <src> <remoteDst>
Copy the specified local path to the specified GooseFS file path. The concurrency and buffer size of this command can be configured, and the copy rate can be adjusted.
copyToLocal [--buffersize <bytes>] <src> <localDst>
Copy the specified GooseFS file path to the specified local path. The buffer size can be set.
count [-h]<path>
Statistics the total number of files and folders in the specified GooseFS path.
cp [-R][--buffersize ] <src> <dst>
Copy the specified GooseFS path to another specified GooseFS path. Supports recursive copy and buffer size adjustment.
decompress [-a]<path>[-C <targetDir>]
Decompress the files in the specified GooseFS path to the target directory.
distributedCp [--active-jobs <num>] [--batch-size <num>] <src> <dst>
Distributed copy data. Copy the specified GooseFS path to another specified GooseFS path concurrently. Supports setting the number of jobs and the copy quantity per batch.
distributedLoad [-ignoreCap][-dryrun][-A][--replication ][--active-jobs <num>] [--batch-size <num>] [--expire-time] <path>
Distributedly preheat data. Preheat the data from the specified GooseFS path in the underlying storage to the cache cluster. Supports setting parameters such as the number of cache replicas, the number of jobs, and the copy quantity per batch.
distributedMv <src><dst>
Distributedly move data. Move the specified GooseFS path to another specified GooseFS path concurrently.
du [-h|-s|-g|-m]<path>
Output the size of the specified GooseFS file/folder.
free [-f]<path>
Release the cached data of the specified GooseFS file/folder. The operation will not delete the data in the underlying storage.
getCapacityBytes
Retrieve the total capacity of the GooseFS cluster.
getSyncPathList
Retrieve the list of currently active automatic synchronization processes.
getUsedBytes
Retrieve the cached capacity of GooseFS.
getfacl <path>
Retrieve the Posix acl of the specified GooseFS file path.
head [-c <bytes>]<path>
Output the specified length of content from the beginning of the specified GooseFS file, defaulting to the first 1KB of content.
help [<command>]
Retrieve the help information for the designated file system command.
leader
Retrieve the information of the Master node of the current GooseFS cluster.
listDecompressJobs <namespace>[-f <Running|Success|Failed|Pending>][-s <asc|desc>][-n <resultNums>][-p <pageIndex>]
List the ongoing decompression tasks under the specified GooseFS namespace, supporting parameters such as status, ascending and descending order, number of items per page, and task index.
load [--local] <path>
Preheat data. Load the data from the specified GooseFS path into the cluster from the underlying storage.
loadMetadata [-R][-F]<path>
Preheat metadata. Load the metadata information from the specified GooseFS path into the cluster. If the path is a directory, recursive loading is supported.
location <path>
Output the node list containing the specified GooseFS file.
ls [-d|-f|-p|-R|-h|--sort=option|--timestamp=option|-r|-a] <path> ...
Output all file and directory information under the specified GooseFS path, supporting operations such as recursive listing.
masterInfo
Output the disaster recovery information of GooseFS Master nodes, such as leader node information, all Master node lists, and configured zookeeper addresses (if configured).
mkdir <path1>[path2]...[pathn]
Create a folder in the specified path. Multiple paths are separated by spaces or tabs. If any of the paths already exists, the operation will throw an exception.
mount [--readonly] [--shared] [--option <key=val>] <goosefsPath> <ufsURI>
Mount the specified underlying storage path to the designated path in the GooseFS namespace. If the specified path already exists, the mounting operation will throw an exception. Upon successful mounting, file operations on the mount point will act on the corresponding path in the underlying storage.
mv <src><dst>
Concurrently move the specified GooseFS path to another specified GooseFS path. If the target path already exists, the operation will throw an exception.
persist [-p|--parallelism <#>] [-t|--timeout <milliseconds>] [-w|--wait <milliseconds>] <path> [<path> ...]
Persist files or folders that exist only in GooseFS to the underlying storage, supporting settings such as concurrency level and timeout period.
pin <path> media1 media2 media3 ...
Lock the specified files or folders in GooseFS to the GooseFS cluster to avoid elimination. If the specified path is a folder, it will recursively lock all files under the folder by default.
queryDecompress <path>[<jobId>]
Query the decompression task for the specified GooseFS file path and specified task id.
rm [-R][-U][--goosefsOnly] <path>
Delete files at the specified GooseFS file path, supporting recursive deletion and allowing setting whether to delete only files in cache.
setReplication [--max <num> | --min <num>] <path>
Set the specified replica quantity for the file path in GooseFS, supporting setting the maximum value and minimum value of the replica quantity.
setTtl [--action delete_only_goosefs|delete|free] <path> <time to live>
Set the TTL for the specified file path in GooseFS, supporting setting the expiration deletion operation type, including deleting underlying storage files, deleting local files, and releasing cache.
setfacl [-d][-R][--set | -m | -x <acl_entries> <path>] | [-b | -k <path>]
Set the permission information for the specified file path in GooseFS, supporting recursive setting.
startSync <path>
Start the automatic synchronization process for the specified file path in GooseFS.
stat [-f <format>]<path>
Statistics the file information in the specified GooseFS path.
stopSync <path>
Stop the automatic synchronization process for the specified file path in GooseFS.
tail [-c <bytes>]<path>
Output the specified length of content from the end of the specified GooseFS file, defaulting to the last 1KB of content.
test [-d|-f|-e|-s|-z]<path>
Test the attributes of the specified GooseFS path. Return 0 if the attributes are correct; otherwise return 1.
touch <path>
Create an empty file at the specified GooseFS path.
unmount <goosefsPath>
Unbind the designated file mount point.
unpin <path>
Unlock the specified files or folders in GooseFS. The unlocked items can be eliminated by the cluster. If the specified path is a folder, it will recursively unlock all files under the folder by default. This operation is the reverse operation of the pin operation.
unsetTtl <path>
Delete the TTL information of the specified GooseFS file path.
updateMount [--readonly] [--shared] [--option <key=val>] <goosefsPath>
Update the mount information of the specified GooseFS file path.

Help and Support

Was this page helpful?

Help us improve! Rate your documentation experience in 5 mins.

Feedback