Skip to main content

tcb integration get

Query detailed information of a specified integration.

Usage​

tcb integration get <keyId> [options]

Parameters​

ParameterDescriptionRequired
<keyId>Integration instance unique identifier (Key ID), or the instance nameYes
--jsonOutput results in JSON formatNo

Query by Name​

The positional argument also accepts the instance name. The name fallback runs only when a direct keyId lookup returns nothing:

CaseBehavior
keyId matchesReturns that instance
keyId misses, exactly one name matchReturns that instance
keyId misses, multiple name matchesFails and lists candidate keyIds; use a keyId instead
Neither matchedSuggests running tcb integration list
Network or auth errorThrown 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​

FieldDescription
keyIdIntegration unique identifier
nameIntegration name
authTypeCodeAuthentication type code
authTypeNameAuthentication type name
descriptionIntegration description
boundFunctionBound Cloud Function name
updateTimeUpdate time
envVariablesEnvironment variables (sensitive fields masked)

Sensitive Field Masking​

Sensitive fields such as api_key and AppSecret are automatically masked as ****** in the query result.