---
canonical_url: "https://docs.composio.dev/toolkits/tidb_cloud"
markdown_url: "https://docs.composio.dev/toolkits/tidb_cloud.md"
product: "platform"
version: null
last_updated: null
---

# TiDB Cloud

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

- **Category:** databases
- **Auth:** API_KEY
- **Composio-managed OAuth available?** N/A
- **Tools:** 10
- **Triggers:** 0
- **Slug:** `TIDB_CLOUD`
- **Version:** 20260815_00

## Tools

### Get Cluster

**Slug:** `TIDB_CLOUD_GET_CLUSTER`

Get details for one Starter/Essential instance or Dedicated cluster by ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `view` | string ("BASIC" | "FULL") | No | Starter/Essential detail level; unavailable for Dedicated. |
| `cluster_id` | string | Yes | TiDB Cloud cluster or instance ID. |
| `service_tier` | string ("starter_essential" | "dedicated") | Yes | Cluster product surface to query; controls the fixed TiDB API host. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Monthly Bill

**Slug:** `TIDB_CLOUD_GET_MONTHLY_BILL`

Return the TiDB Cloud organization bill for one calendar month.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `billed_month` | string | Yes | Billing month in YYYY-MM format, for example 2026-07. TiDB Cloud supports bills up to six months before the current month. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page_size` | integer | No | Maximum branches in this page (1-100). |
| `cluster_id` | string | Yes | Starter or Essential instance ID. |
| `next_cursor` | string | No | Continuation cursor returned by a previous call. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page_size` | integer | No | Maximum deployments in this page (1-100). |
| `data_app_id` | string | Yes | Data App ID returned by List Data Apps. |
| `next_cursor` | string | No | Continuation cursor returned by a previous call; omit for the first page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page_size` | integer | No | Maximum Data Apps in this page (1-100). |
| `project_id` | string | Yes | Project ID whose Data Apps should be listed. |
| `next_cursor` | string | No | Opaque continuation cursor returned by a previous call; omit for the first page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `email` | string | No | Return members matching this email address. |
| `roles` | array | No | 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") | No | Member sort field and direction. |
| `statuses` | array | No | Return members in any of these statuses. Values are sent as repeated query parameters. |
| `page_size` | integer | No | Maximum members in this page (1-100). |
| `project_id` | string | No | Return members assigned to this project. |
| `instance_id` | string | No | Return members assigned to this TiDB Cloud instance. |
| `next_cursor` | string | No | Continuation cursor returned by a previous call; omit for the first page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Regions

**Slug:** `TIDB_CLOUD_LIST_REGIONS`

List regions available for Starter/Essential or Dedicated clusters, optionally filtering Dedicated regions. Returns one page and a continuation cursor.

#### Input Parameters

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |