tcb integration get
Query detailed information of a specified integration.
Usage
tcb integration get <keyId> [options]
Parameters
| Parameter | Description | Required |
|---|---|---|
<keyId> | Integration instance unique identifier (Key ID), or the instance name | Yes |
--json | Output results in JSON format | No |
Query by Name
The positional argument also accepts the instance name. The name fallback runs only when a direct keyId lookup returns nothing:
| Case | Behavior |
|---|---|
| keyId matches | Returns that instance |
| keyId misses, exactly one name match | Returns that instance |
| keyId misses, multiple name matches | Fails and lists candidate keyIds; use a keyId instead |
| Neither matched | Suggests running tcb integration list |
| Network or auth error | Thrown as-is, no silent fallback |
tcb integration get stripe-test
Examples
Query integration details
tcb integration get key-721a6e232e169382d3cbc5faa3dc2cd6
JSON format output
tcb integration get key-721a6e232e169382d3cbc5faa3dc2cd6 --json
Output example:
{
"data": {
"keyId": "key-721a6e232e169382d3cbc5faa3dc2cd6",
"name": "my-integration",
"authTypeCode": "custom",
"authTypeName": "custom integration",
"description": "My integration",
"boundFunction": "my-function",
"updateTime": "2024-01-01 12:00",
"envVariables": {
"AppId": "wx1234567890",
"AppSecret": "******"
}
}
}
Output Fields
| Field | Description |
|---|---|
keyId | Integration unique identifier |
name | Integration name |
authTypeCode | Authentication type code |
authTypeName | Authentication type name |
description | Integration description |
boundFunction | Bound Cloud Function name |
updateTime | Update time |
envVariables | Environment variables (sensitive fields masked) |
Sensitive Field Masking
Sensitive fields such as api_key and AppSecret are automatically masked as ****** in the query result.