📣
TiDB Cloud Premium 开放公测中。为企业级工作负载提供无限扩展、即时弹性伸缩和高级安全保障。此页面由 AI 自动翻译，英文原文请见此处。
​
AI
应用开发
最佳实践
API
​

ti db describe-db-cluster

获取 TiDB Cloud Starter 实例的信息。默认的 BASIC 视图会返回基本实例信息。使用 --view FULL 可请求 TiDB Cloud API 提供的完整详细信息。如果集群的 API 元信息无法将其验证为 Starter，则该命令会拒绝该集群。

语法

ti db describe-db-cluster
  --db-cluster-id <string>
  [--help]
  [--version]
  [--view <string>]

选项

  • --db-cluster-id <string>：Starter DB 集群 ID。[必需]
  • --help：显示帮助信息。
  • --version：显示版本信息。
  • --view <string>：详细级别：BASIC 或 FULL。如果省略，TiDB Cloud API 使用 BASIC。

有关所有命令共享的选项，请参见全局选项。

示例

  • 获取 TiDB Cloud Starter 实例的信息：

    # Return the instance state, placement, and connection metadata.
ti db describe-db-cluster --db-cluster-id "<cluster-id>" --view FULL

文档内容是否有帮助？