1. 接口描述
接口请求域名: oceanus.tencentcloudapi.com 。
创建元数据表
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:CreateMetaTable。 |
| Version | 是 | String | 公共参数,本接口取值:2019-04-22。 |
| Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
| CatalogId | 是 | Integer | Catalog Id 示例值:1 |
| DatabaseId | 是 | Integer | 库Id 示例值:2 |
| SqlCode | 是 | String | 建表语句 参数格式:需要base64加密 示例值:Y3JlYXRlIHRhYmxl |
| Comment | 否 | String | 备注 示例值:维表 |
| ClusterId | 否 | String | 集群id 示例值:cluster-aaa |
| ResourceRefs.N | 否 | Array of ResourceRef | 引用资源 |
| FlinkVersion | 否 | String | Flink版本 示例值:Flink-1.11 |
| WorkSpaceId | 否 | String | 工作空间 SerialId 示例值:space-aaaa |
| AsyncTaskId | 否 | String | 异步id 示例值:407D2293-E7A8-456B-97F8-B242677AE72D |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| TableId | Integer | 表Id 示例值:0 |
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 创建元数据表
输入示例
POST / HTTP/1.1
Host: oceanus.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateMetaTable
<公共请求参数>
{
"CatalogId": 0,
"DatabaseId": 0,
"SqlCode": "Q1JFQVRFIFRBQkxFIFNvdXJjZVRhYmxlICggICAgICBmX3NlcXVlbmNlIElOVCwgICAgICBmX3JhbmRvbSBJTlQsICAgICAgZl9yYW5kb21fc3RyIFNUUklORyAgKSBXSVRIICggICAgICAnY29ubmVjdG9yJyA9ICdteXNxbC1jZGMnLCAgICAgICdkYXRhYmFzZS1uYW1lJyA9ICd0ZXN0JywgICAgICAnaG9zdG5hbWUnID0gJzEwLjAuMC4xNicsICAgICAgJ3Bhc3N3b3JkJyA9ICdRY2xvdWRWNSEnLCAgICAgICdwb3J0JyA9ICczMzA2JywgICAgICAndGFibGUtbmFtZScgPSAnbXlfdGVzdCcsICAgICAgJ3VzZXJuYW1lJyA9ICdyb290JyApIA==",
"Comment": "维表"
}
输出示例
{
"Response": {
"RequestId": "ff2de498-281d-4b26-8f31-f3cdd9904559",
"TableId": 0
}
}
5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Java: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for PHP: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Go: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Node.js: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for .NET: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for C++: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Ruby: CNB, GitHub, Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| FailedOperation | 操作失败。 |
| FailedOperation.CheckDdlGrammar | ddl语法检查失败。 |
| FailedOperation.DDLParseFailure | DDL解析失败。 |
| InternalError | 内部错误。 |
| InternalError.DB | 数据库异常。 |
| InvalidParameterValue.MetaTableExisted | 元数据表名已存在。 |
| LimitExceeded.MetaTable | 创建的数据表个数超过限额。 |
| UnsupportedOperation.NoPermissionAccess | 权限拦截,没有进入权限。 |