Domain name for API request: databuddy.intl.tencentcloudapi.com.
Query catalog description
A maximum of 20 requests can be initiated per second for this API.
The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| Action | Yes | String | Common Params. The value used for this API: GetCatalog. |
| Version | Yes | String | Common Params. The value used for this API: 2026-07-15. |
| Region | Yes | String | Common Params. For more information, please see the list of regions supported by the product. |
| CatalogName | Yes | String | Data catalog name. |
| WorkspaceId | Yes | String | Unique id of the workspace where the call is made. |
| CatalogId | No | String | Data directory id |
| FetchOption | No | FetchOption | Data access option. Selectable. Controls whether to return permission information and filter by permission. |
| ConnectionId | No | String | Data source connection ID, selectable (additional field in fusion edition). Non-empty → use the analytical path; empty/default → use the professional edition TcLake path |
| CatalogSource | No | String | Data Catalog source, selectable (additional field for Setats fusion). Value: METALAKE (pro edition tclake) / CONNECTION (analytical edition Linked Catalog) / Setats (Setats metadata). Routing priority: explicit non-empty CatalogSource > non-empty ConnectionId (deem as CONNECTION) > default METALAKE; ConnectionId will be ignored when CatalogSource is non-empty. |
| Parameter Name | Type | Description |
|---|---|---|
| Data | GetCatalogRsp | catalog details. |
| RequestId | String | The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem. |
Retrieve data catalog details
POST / HTTP/1.1
Host: databuddy.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: GetCatalog
<Common request parameters>
{
"CatalogName": "capi_no_delete_table",
"WorkspaceId": "17697667906247629"
}{
"Response": {
"Data": {
"Catalog": {
"AssetGuid": "tccatalog.v1.uid3425580874683096126@251436191_ap-guangzhou_CATALOG",
"Audit": {
"CreatedAt": "1778825232449",
"Creator": "wedata30-dev@tencent.com",
"CreatorName": "wedata30-dev@tencent.com",
"LastModifiedAt": "1778825232449",
"LastModifier": "wedata30-dev@tencent.com",
"LastModifierName": "wedata30-dev@tencent.com"
},
"Comment": "",
"CurrentWorkspacePermissionLevel": 0,
"Id": "0c4b0b0f-522c-4039-9d7a-63473f85b779",
"Identifier": "tccatalog.v1.uid3425580874683096126",
"IsExternal": false,
"MetaOwner": {
"FullName": "capi_no_delete_table",
"Owner": "700002164618",
"OwnerName": "wedata30-dev@tencent.com",
"OwnerType": "user"
},
"Name": "capi_no_delete_table",
"Operator": "wedata30-dev@tencent.com",
"Properties": [
{
"Key": "spark.bypass.hive.metastore.jars",
"Value": "/opt/spark/hive312/*"
}
],
"Status": "2",
"Tags": [],
"Type": "TABLE"
}
},
"RequestId": "81b00993-d97c-4dc7-a6f6-c44055b39b1b"
}
}TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.
| Error Code | Description |
|---|---|
| InvalidParameter.InvalidParameter | Incorrect parameter. |
| ResourceNotFound.CatalogNotFound | The specified Catalog does not exist. |
文档反馈