Skip to main content
TiDB Cloud logo
  • Category: databases
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 10
  • Triggers: 0
  • Slug: TIDB_CLOUD
  • Version: 20261101_00

Tools

Slug: TIDB_CLOUD_GET_CLUSTERGet details for one Starter/Essential instance or Dedicated cluster by ID.

Input Parameters

string ("BASIC" | "FULL")
Starter/Essential detail level; unavailable for Dedicated.
string
required
TiDB Cloud cluster or instance ID.
string ("starter_essential" | "dedicated")
required
Cluster product surface to query; controls the fixed TiDB API host.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIDB_CLOUD_GET_MONTHLY_BILLReturn the TiDB Cloud organization bill for one calendar month.

Input Parameters

string
required
Billing month in YYYY-MM format, for example 2026-07. TiDB Cloud supports bills up to six months before the current month.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIDB_CLOUD_LIST_AUDIT_LOGSSearch TiDB Cloud organization audit logs by time range, event type, or keyword and return one page of results.

Input Parameters

string
Search term that must occur in matching audit logs.
string
Include audit events created at or before this ISO 8601 timestamp, including a timezone.
integer
Maximum audit events in this page (1-100).
string
Include audit events created at or after this ISO 8601 timestamp, including a timezone.
string
Opaque continuation cursor returned by a previous call; keep all filters unchanged.
string
Provider event-type filter, such as CreateCluster.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIDB_CLOUD_LIST_BRANCHESList database branches for a TiDB Cloud Starter or Essential instance. Returns one page and a continuation cursor.

Input Parameters

integer
Maximum branches in this page (1-100).
string
required
Starter or Essential instance ID.
string
Continuation cursor returned by a previous call.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIDB_CLOUD_LIST_CLUSTERSList TiDB Cloud Starter/Essential instances or Dedicated clusters, with product-specific filters. Returns one page and a continuation cursor.

Input Parameters

integer
Number of matching clusters to skip before this page.
string
Starter/Essential AIP filter, for example state=“ACTIVE” AND region.provider=“aws”; unavailable for Dedicated.
integer
Maximum clusters in this page (1-100).
string
Dedicated project ID; omit to use the default project. For Starter/Essential use the filter expression instead.
array
Dedicated region IDs to include; unavailable for Starter/Essential.
array
Dedicated cluster IDs to include; unavailable for Starter/Essential.
string
Opaque continuation cursor returned by a previous call; omit for the first page.
string ("starter_essential" | "dedicated")
required
Cluster product surface to query; selects a fixed TiDB Cloud API host.
array
Dedicated cluster states to include; unavailable for Starter/Essential.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIDB_CLOUD_LIST_DATA_APP_DEPLOYMENTSList one page of deployments and deployment status for a TiDB Cloud Data Service application, plus a continuation cursor.

Input Parameters

integer
Maximum deployments in this page (1-100).
string
required
Data App ID returned by List Data Apps.
string
Continuation cursor returned by a previous call; omit for the first page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIDB_CLOUD_LIST_DATA_APPSList TiDB Cloud Data Service applications in a project, returning one page and a continuation cursor.

Input Parameters

integer
Maximum Data Apps in this page (1-100).
string
required
Project ID whose Data Apps should be listed.
string
Opaque continuation cursor returned by a previous call; omit for the first page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIDB_CLOUD_LIST_IMPORT_TASKSList one page of import tasks for a TiDB Cloud Starter/Essential instance or Dedicated cluster, including status, progress, source, timestamps, errors, and a continuation cursor.

Input Parameters

string
Provider sort expression. The supported example is createTime desc.
integer
Maximum import tasks in this page (1-100).
string
required
Cluster or instance ID whose import tasks should be listed.
string
Continuation cursor returned by a previous call. Keep the other parameters unchanged.
string ("starter_essential" | "dedicated")
required
Cluster product surface to query: starter_essential or dedicated.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIDB_CLOUD_LIST_ORGANIZATION_MEMBERSList one page of TiDB Cloud organization members with optional identity, assignment, role, and status filters, plus a continuation cursor.

Input Parameters

string
Return members matching this email address.
array
Return members with any of these roles. Values are sent as repeated query parameters.
string ("email asc" | "email desc" | "invite_time asc" | "invite_time desc" | "login_time asc" | "login_time desc")
Member sort field and direction.
array
Return members in any of these statuses. Values are sent as repeated query parameters.
integer
Maximum members in this page (1-100).
string
Return members assigned to this project.
string
Return members assigned to this TiDB Cloud instance.
string
Continuation cursor returned by a previous call; omit for the first page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIDB_CLOUD_LIST_REGIONSList regions available for Starter/Essential or Dedicated clusters, optionally filtering Dedicated regions. Dedicated results support pagination with a continuation cursor.

Input Parameters

integer
Number of Dedicated regions to skip; unavailable for Starter/Essential.
integer
Maximum Dedicated regions in this page (1-100); unavailable for Starter/Essential.
string
Dedicated project ID; omit to use the default project. Unavailable for Starter/Essential.
string
Dedicated continuation cursor returned by a previous call; unavailable for Starter/Essential.
string ("starter_essential" | "dedicated")
required
Cluster product surface to query; selects the fixed TiDB Cloud API host.
string
Dedicated cloud-provider filter, such as aws or gcp; unavailable for Starter/Essential.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not