📣
TiDB Cloud Premium is now in public preview. Unlimited growth, instant elasticity, advanced security for enterprise workloads. Try it out →

ti fs describe-file-system



Shows detailed information about a Filesystem, including its display name, labels, placement, status, quota, and usage. This command requires TiDB Cloud API credentials and does not use a Filesystem token.

The output includes has_local_token, which indicates whether this machine has a matching local token. When available, quota data includes media and video extraction limits and usage.

Syntax

ti fs describe-file-system --file-system-id <string> [--help] [--version]

Options

  • --file-system-id <string>: Set the immutable Filesystem ID. [required]
  • --help: Display help information.
  • --version: Display version information.

For options shared by all commands, see Global options.

Examples

  • Describe a Filesystem:

    # Return remote status and whether this machine has a matching local token. ti fs describe-file-system --file-system-id <file-system-id>

Was this page helpful?