📣
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 list-file-system-tokens

Lists tokens for a file system. Token values are never included in the output.

Syntax

ti fs list-file-system-tokens
  [--file-system-id <string>]
  [--fs-token <string>]
  [--include-expired]
  [--help]
  [--limit <int32>]
  [--offset <int32>]
  [--version]

Options

  • --file-system-id <string>: Specify the file system whose tokens are listed. Required when using TiDB Cloud API credentials; optional when --fs-token or TI_FS_TOKEN supplies an owner token, because ti derives the ID from that token.
  • --fs-token <string>: Authorize the request with a file system owner token. If omitted, the command uses the TI_FS_TOKEN environment variable. If neither is provided, the command requires TiDB Cloud API credentials and --file-system-id. It does not automatically use a locally stored owner token. Scoped tokens cannot list token metadata.
  • --include-expired: Include expired token metadata. Revoked tokens are not returned by the service.
  • --help: Display help information.
  • --offset <int32>: Set the zero-based token offset [default: 0].
  • --limit <int32>: Set the maximum number of tokens to return, from 1 through 200 [default: 50].
  • --version: Display version information.

For options shared by all commands, see Global options.

Examples

  • List current token metadata as text:

    # Use token_id, not the non-unique token name, for later mutations.
ti fs list-file-system-tokens \
  --file-system-id "<file-system-id>" \
  --output text

  • Inspect expired token metadata with pagination:

    # Request up to 100 rows starting at offset 0.
ti fs list-file-system-tokens \
  --file-system-id "<file-system-id>" \
  --include-expired \
  --offset 0 \
  --limit 100

  • List token metadata with an owner token:

    # The owner token identifies the file system, so --file-system-id is not needed.
TI_FS_TOKEN="<owner-fs-token>" ti fs list-file-system-tokens --output text

Was this page helpful?