1. 接口描述
接口请求域名: oceanus.tencentcloudapi.com 。
修改元数据表
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:ModifyMetaTable。 |
| Version | 是 | String | 公共参数,本接口取值:2019-04-22。 |
| Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
| ClusterId | 是 | String | 集群唯一id 示例值:cluster-12 |
| TableId | 是 | String | 元数据表唯一id 示例值:table-12 |
| SqlCode | 是 | String | SQL 参数格式:base64加密 示例值:Y3JlYXRlIHRhYmxl |
| FlinkVersion | 是 | String | Flink版本 示例值:Flink-1.14 |
| WorkSpaceId | 是 | String | 空间唯一id 示例值:spave-12 |
| Remark | 是 | String | 备注 示例值:remark |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 元数据表编辑
输入示例
POST / HTTP/1.1
Host: oceanus.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyMetaTable
<公共请求参数>
{
"ClusterId": "cluster-xxx",
"TableId": "1",
"SqlCode": "Q1JFQVRFIFRBQkxFIGRhdGFnZW5fc291cmNlX3RhYmxlICggCiAgICBpZCBJTlQsIAogICAgbmFtZSBTVFJJTkcgCikgV0lUSCAoCidjb25uZWN0b3InPSdkYXRhZ2VuJywKJ3Jvd3MtcGVyLXNlY29uZCcgPSAnMScKKTs=",
"FlinkVersion": "Flink-1.13",
"WorkSpaceId": "space-xx",
"Remark": "remark"
}
输出示例
{
"Response": {
"RequestId": "407D2293-E7A8-456B-97F8-B242677AE71D"
}
}
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.ClusterNotFound | 找不到集群。 |
| FailedOperation.DDLParseFailure | DDL解析失败。 |
| FailedOperation.ModifyConnectorFailedOperation | 修改Connector type 失败 |
| FailedOperation.ModifyTableFailedOperation | 修改table name 失败 |
| InvalidParameter | 参数错误。 |
| InvalidParameter.UnsupportedOptions | Unsupported options |
| ResourceNotFound.ClusterNotFound | 未找到群集。 |
| ResourceNotFound.MetaDataNotFound | 未找到元数据。 |
| UnknownParameter | 未知参数错误。 |