Domain name for API request: databuddy.intl.tencentcloudapi.com.
This API is used to create a data catalog.
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: CreateCatalog. |
| 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. |
| Name | Yes | String | catalog name |
| Type | Yes | String | catalog type. Available values: TABLE, MODEL, VOLUME |
| WorkspaceId | Yes | String | Workspace unique id |
| Comment | No | String | Description |
| ConnectionId | No | String | ID of the connection |
| CatalogSource | No | String | Data catalog source. Option (additional field in the fusion edition). For values, see CatalogSourceEnum: METALAKE (pro edition) / CONNECTION (analytics edition). If not specified, it is handled as METALAKE by default. |
| ConnectionCatalogName | No | String | Catalog name or database name on the connection side. Required for three-segment data sources, not required for two-segment data sources such as MySQL. For three-segment data sources with MySQL kernels such as Doris, StarRocks, and TChouse-D, fill in the external catalog name. For three-segment data sources with PG kernels such as PostgreSQL, Tencent PG, GaussDB, and Hologres, fill in the databaseName. Not required for two-segment data sources such as MySQL. |
| Parameter Name | Type | Description |
|---|---|---|
| Data | CreateCatalogRsp | Response for creating a catalog |
| 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. |
POST / HTTP/1.1
Host: databuddy.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateCatalog
<Common request parameters>
{
"Name": "my_catalog",
"Type": "TABLE",
"WorkspaceId": "17697667906247629",
"Comment": "This is a data catalog"
}{
"Response": {
"RequestId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"Data": {
"CatalogId": "e3f9a474-0f2e-4f93-90e7-b2fc9ec1405c"
}
}
}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 |
|---|---|
| FailedOperation.DuplicateAnaCatalog | This data source Connection is already associated with an analytical catalog. Each Connection can only create one analytical catalog in the same workspace. |
| InternalError.BizException | Business logic error. |
| InternalError.FailedOperation | Operation failed |
| InvalidParameter.InvalidParameter | Incorrect parameter. |
| LimitExceeded.SetatsCatalogLimitExceeded | The number of Setats Catalogs in the current tenant has reached the cap (max 5) |
| ResourceInUse.CatalogAlreadyExists | Data catalog already exists |
피드백