> ## Documentation Index
> Fetch the complete documentation index at: https://composio-preview.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# TiDB Cloud

> Manage TiDB Cloud Starter, Essential, Dedicated, IAM, billing, and Data Service control-plane resources.

![TiDB Cloud logo](https://mintcdn.com/composio-preview/IA0_SoMcsWt17HEC/images/toolkits/tidb_cloud.svg?fit=max\&auto=format\&n=IA0_SoMcsWt17HEC\&q=85\&s=9448941863ad41c8f0f53e7061fa6d16)

* **Category:** databases
* **Auth:** API\_KEY
* **Composio-managed OAuth available?** N/A
* **Tools:** 10
* **Triggers:** 0
* **Slug:** `TIDB_CLOUD`
* **Version:** 20261101\_00

## Tools

> [accordion] Get Cluster
>
> **Slug:** `TIDB_CLOUD_GET_CLUSTER`
>
> Get details for one Starter/Essential instance or Dedicated cluster by ID.
>
> #### Input Parameters
>
> **view** `string ("BASIC" | "FULL")`
>
> Starter/Essential detail level; unavailable for Dedicated.
>
> **cluster\_id** `string` *required*
>
> TiDB Cloud cluster or instance ID.
>
> **service\_tier** `string ("starter_essential" | "dedicated")` *required*
>
> Cluster product surface to query; controls the fixed TiDB API host.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Monthly Bill
>
> **Slug:** `TIDB_CLOUD_GET_MONTHLY_BILL`
>
> Return the TiDB Cloud organization bill for one calendar month.
>
> #### Input Parameters
>
> **billed\_month** `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
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Audit Logs
>
> **Slug:** `TIDB_CLOUD_LIST_AUDIT_LOGS`
>
> Search TiDB Cloud organization audit logs by time range, event type, or keyword and return one page of results.
>
> #### Input Parameters
>
> **keyword** `string`
>
> Search term that must occur in matching audit logs.
>
> **end\_time** `string`
>
> Include audit events created at or before this ISO 8601 timestamp, including a timezone.
>
> **page\_size** `integer`
>
> Maximum audit events in this page (1-100).
>
> **start\_time** `string`
>
> Include audit events created at or after this ISO 8601 timestamp, including a timezone.
>
> **next\_cursor** `string`
>
> Opaque continuation cursor returned by a previous call; keep all filters unchanged.
>
> **audit\_event\_types** `string`
>
> Provider event-type filter, such as CreateCluster.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Branches
>
> **Slug:** `TIDB_CLOUD_LIST_BRANCHES`
>
> List database branches for a TiDB Cloud Starter or Essential instance. Returns one page and a continuation cursor.
>
> #### Input Parameters
>
> **page\_size** `integer`
>
> Maximum branches in this page (1-100).
>
> **cluster\_id** `string` *required*
>
> Starter or Essential instance ID.
>
> **next\_cursor** `string`
>
> Continuation cursor returned by a previous call.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Clusters
>
> **Slug:** `TIDB_CLOUD_LIST_CLUSTERS`
>
> List TiDB Cloud Starter/Essential instances or Dedicated clusters, with product-specific filters. Returns one page and a continuation cursor.
>
> #### Input Parameters
>
> **skip** `integer`
>
> Number of matching clusters to skip before this page.
>
> **filter** `string`
>
> Starter/Essential AIP filter, for example state="ACTIVE" AND region.provider="aws"; unavailable for Dedicated.
>
> **page\_size** `integer`
>
> Maximum clusters in this page (1-100).
>
> **project\_id** `string`
>
> Dedicated project ID; omit to use the default project. For Starter/Essential use the filter expression instead.
>
> **region\_ids** `array`
>
> Dedicated region IDs to include; unavailable for Starter/Essential.
>
> **cluster\_ids** `array`
>
> Dedicated cluster IDs to include; unavailable for Starter/Essential.
>
> **next\_cursor** `string`
>
> Opaque continuation cursor returned by a previous call; omit for the first page.
>
> **service\_tier** `string ("starter_essential" | "dedicated")` *required*
>
> Cluster product surface to query; selects a fixed TiDB Cloud API host.
>
> **cluster\_states** `array`
>
> Dedicated cluster states to include; unavailable for Starter/Essential.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Data App Deployments
>
> **Slug:** `TIDB_CLOUD_LIST_DATA_APP_DEPLOYMENTS`
>
> List one page of deployments and deployment status for a TiDB Cloud Data Service application, plus a continuation cursor.
>
> #### Input Parameters
>
> **page\_size** `integer`
>
> Maximum deployments in this page (1-100).
>
> **data\_app\_id** `string` *required*
>
> Data App ID returned by List Data Apps.
>
> **next\_cursor** `string`
>
> Continuation cursor returned by a previous call; omit for the first page.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Data Apps
>
> **Slug:** `TIDB_CLOUD_LIST_DATA_APPS`
>
> List TiDB Cloud Data Service applications in a project, returning one page and a continuation cursor.
>
> #### Input Parameters
>
> **page\_size** `integer`
>
> Maximum Data Apps in this page (1-100).
>
> **project\_id** `string` *required*
>
> Project ID whose Data Apps should be listed.
>
> **next\_cursor** `string`
>
> Opaque continuation cursor returned by a previous call; omit for the first page.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Import Tasks
>
> **Slug:** `TIDB_CLOUD_LIST_IMPORT_TASKS`
>
> List 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
>
> **order\_by** `string`
>
> Provider sort expression. The supported example is createTime desc.
>
> **page\_size** `integer`
>
> Maximum import tasks in this page (1-100).
>
> **cluster\_id** `string` *required*
>
> Cluster or instance ID whose import tasks should be listed.
>
> **next\_cursor** `string`
>
> Continuation cursor returned by a previous call. Keep the other parameters unchanged.
>
> **service\_tier** `string ("starter_essential" | "dedicated")` *required*
>
> Cluster product surface to query: starter\_essential or dedicated.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Organization Members
>
> **Slug:** `TIDB_CLOUD_LIST_ORGANIZATION_MEMBERS`
>
> List one page of TiDB Cloud organization members with optional identity, assignment, role, and status filters, plus a continuation cursor.
>
> #### Input Parameters
>
> **email** `string`
>
> Return members matching this email address.
>
> **roles** `array`
>
> Return members with any of these roles. Values are sent as repeated query parameters.
>
> **order\_by** `string ("email asc" | "email desc" | "invite_time asc" | "invite_time desc" | "login_time asc" | "login_time desc")`
>
> Member sort field and direction.
>
> **statuses** `array`
>
> Return members in any of these statuses. Values are sent as repeated query parameters.
>
> **page\_size** `integer`
>
> Maximum members in this page (1-100).
>
> **project\_id** `string`
>
> Return members assigned to this project.
>
> **instance\_id** `string`
>
> Return members assigned to this TiDB Cloud instance.
>
> **next\_cursor** `string`
>
> Continuation cursor returned by a previous call; omit for the first page.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Regions
>
> **Slug:** `TIDB_CLOUD_LIST_REGIONS`
>
> List regions available for Starter/Essential or Dedicated clusters, optionally filtering Dedicated regions. Dedicated results support pagination with a continuation cursor.
>
> #### Input Parameters
>
> **skip** `integer`
>
> Number of Dedicated regions to skip; unavailable for Starter/Essential.
>
> **page\_size** `integer`
>
> Maximum Dedicated regions in this page (1-100); unavailable for Starter/Essential.
>
> **project\_id** `string`
>
> Dedicated project ID; omit to use the default project. Unavailable for Starter/Essential.
>
> **next\_cursor** `string`
>
> Dedicated continuation cursor returned by a previous call; unavailable for Starter/Essential.
>
> **service\_tier** `string ("starter_essential" | "dedicated")` *required*
>
> Cluster product surface to query; selects the fixed TiDB Cloud API host.
>
> **cloud\_provider** `string`
>
> Dedicated cloud-provider filter, such as aws or gcp; unavailable for Starter/Essential.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not
