Query Integration List
Use the tcb integration list command to query all integration configurations in the current environment.
tcb integration list [options]
Command Parameters
| Parameter | Description | Required |
|---|---|---|
-e, --env-id <envId> | Environment ID (interactive selection if not specified) | No |
--name <name> | Filter by name (fuzzy search) | No |
--auth-type-code <code> | Filter by auth type code (e.g., custom, wechat) | No |
--limit <n> | Maximum number of results to return, default 20 | No |
--offset <n> | Number of results to skip, default 0 | No |
--json | Output results in JSON format | No |
Output Format
Table Format (Default)
By default, results are displayed in a table with the following columns:
| Column | Description |
|---|---|
| Name | Integration instance name |
| Identifier | Integration instance KeyID |
| Integration Type | Auth type name (e.g., "Custom Auth") |
| Bound Cloud Function | Associated cloud function name, - if not bound |
| Update Time | Last update time (YYYY-MM-DD HH:mm) |
| Description | Integration description, - if not filled |
JSON Format (--json)
When using the --json option, output is a JSON array with each element containing the following fields:
| Field | Type | Description |
|---|---|---|
keyId | string | Integration unique identifier (KeyID) |
name | string | Integration name |
authTypeName | string | Auth type name |
authTypeCode | string | Auth type code |
description | string | Integration description |
boundFunction | string | Bound cloud function name, null if not bound |
updateTime | string | Update time (YYYY-MM-DD HH:mm) |
JSON output also includes metadata (via the second parameter of outputJson):
{
"data": [ ... ],
"meta": {
"total": 42,
"limit": 20,
"offset": 0
}
}
Usage Examples
Basic Query
# Query first 20 integration records (default)
tcb integration list
# Specify environment
tcb integration list -e env-abc123
# Query first 50 records
tcb integration list --limit 50
# Skip first 10 records, query next 20 records
tcb integration list --offset 10 --limit 20
Filter Query
# Filter by name
tcb integration list --name my-integration
# Filter by auth type
tcb integration list --auth-type-code custom
# Combined filter
tcb integration list --name my-integration --auth-type-code custom
JSON Format Output
# Output all integrations in JSON format
tcb integration list --json
# Output in JSON format after filtering
tcb integration list --name my-integration --json
JSON output example:
{
"data": [
{
"keyId": "key-721a6e232e169382d3cbc5faa3dc2cd6",
"name": "my-integration",
"authTypeName": "Custom Auth",
"authTypeCode": "custom",
"description": "My integration",
"boundFunction": "my-function",
"updateTime": "2024-01-01 12:00"
}
],
"meta": {
"total": 1,
"limit": 20,
"offset": 0
}
}
Empty Result Handling
When there are no integration instances in the current environment:
- Table mode: Output prompt
No integration instances in the current environment, please create an integration in the console first - JSON mode: Output empty array
[]
Pagination Query
When there are many integrations, you can use --limit and --offset parameters for pagination:
# First page (records 1-20)
tcb integration list --limit 20 --offset 0
# Second page (records 21-40)
tcb integration list --limit 20 --offset 20
# Third page (records 41-60)
tcb integration list --limit 20 --offset 40