📣
TiDB Cloud Premium is now in public preview. Unlimited growth, instant elasticity, advanced security for enterprise workloads. Try it out →
​
Sign InStart for Free
AI
Developer
Best Practices
API
​
Sign InStart for Free

ti fs describe-file-system

Describes one remote Filesystem by its server-assigned ID. The response includes its authoritative display name, labels, placement, status, quota and usage, and the non-secret has_local_token hint. The command requires TiDB Cloud API credentials and does not use an FS token for authorization.

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?