Domain name for API request: databuddy.intl.tencentcloudapi.com.
Create a schema
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: CreateSchema. |
| 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 | catalog name |
| Name | Yes | String | Schema name |
| WorkspaceId | Yes | String | Unique id of the workspace where the call is made |
| Comment | No | String | Description |
| ConnectionId | No | String | Data source connection ID. This parameter is optional (an additional field in the fusion edition). The analytical edition catalog does not support creating schemas. If a non-empty value is imported, the server returns the ANA_CATALOG_NOT_SUPPORTED error. |
| CatalogSource | No | String | Data catalog source. Selectable (additional fields added in Setats fusion). Values: METALAKE (pro edition tclake) / CONNECTION (analytical edition Linked Catalog) / SETATS (Setats metadata). Routing priority: explicit non-empty CatalogSource > non-empty ConnectionId (deemed as CONNECTION) > default METALAKE. ConnectionId will be ignored when CatalogSource is non-empty. |
| Parameter Name | Type | Description |
|---|---|---|
| Data | CreateSchemaRsp | schema information |
| 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: CreateSchema
<Common request parameters>
{
"CatalogName": "my_catalog",
"Name": "my_schema",
"WorkspaceId": "17697667906247629",
"Comment": "This is a Schema"
}{
"Response": {
"RequestId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"Data": {
"Schema": {
"Name": "my_schema",
"Comment": "This is a Schema"
}
}
}
}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. |
| ResourceInUse.SchemaAlreadyExists | Schema already exists |
| ResourceNotFound.CatalogNotFound | The specified Catalog does not exist. |
피드백