Query Integration Details
Use the tcb integration get command to query detailed information of a specified integration.
tcb integration get [options]
Command Parameters
| Parameter | Description | Required |
|---|---|---|
--key-id <keyId> | Integration Key ID | No (either this or --name) |
--name <name> | Integration name | No (either this or --key-id) |
--json | Output results in JSON format | No |
Usage Examples
Query by Key ID
tcb integration get --key-id key-721a6e232e169382d3cbc5faa3dc2cd6
Query by Name
tcb integration get --name my-integration
JSON Format Output
tcb integration get --key-id key-721a6e232e169382d3cbc5faa3dc2cd6 --json
Output example:
{
"UserKeyInfo": {
"KeyId": "key-721a6e232e169382d3cbc5faa3dc2cd6",
"Name": "my-integration",
"AuthTypeCode": "custom",
"Description": "My integration",
"DemoCodeFunctionName": "my-function",
"Ext": {
"AppId": "wx1234567890",
"AppSecret": "***"
},
"CreateTime": "2024-01-01T00:00:00Z",
"UpdateTime": "2024-01-01T00:00:00Z"
}
}
Output Field Description
| Field | Description |
|---|---|
KeyId | Integration unique identifier |
Name | Integration name |
AuthTypeCode | Authentication type |
Description | Integration description |
DemoCodeFunctionName | Bound cloud function name |
Ext | Extended configuration information (such as AppId, AppSecret, etc.) |
CreateTime | Creation time |
UpdateTime | Update time |
Query Method Selection
- Query by Key ID: Precise query, recommended for use in scripts
- Query by name: Easy to remember, suitable for interactive operations
Note
If names are duplicated, querying by name will return the first matching integration. It is recommended to use Key ID for precise queries.