根据名称更新数据湖元数据表信息。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
当前API暂无授权信息透出。
请求语法
PUT /api/metastore/catalogs/databases/tables
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
Body | object | 否 | HTTP 请求体(HTTP BODY)内容,均采用 JSON 格式 | |
CatalogId | string | 否 | 数据库分类命名空间,默认填写主账号 Uid | 1344371 |
DatabaseName | string | 否 | 元数据库名称 | database_test |
SkipArchive | boolean | 否 | 默认情况下,更新元数据表会创建一个新的归档版本,但如果 skipArchive 设置 true 则不会创建版本 | false |
TableInput | TableInput | 否 | 更新后元数据表详细信息 | |
TableName | string | 否 | 元数据表名称 | test_table_20201223 |
IsAsync | boolean | 否 | 是否同步更新 | true |
AllowPartitionKeyChange | boolean | 否 | 是否允许更新 partition key | false |
IsAsync:
- true:表示异步调用,不等待后台任务返回,接口即返回结果,返回结果中带上 taskid,这样客户端可以通过 taskid 查询任务的状态。
- false:表示同步调用,接口等待后台任务完成时,接口才返回结果。那么为 false 的风险就是如果后台任务需要做很长,接口会超时
返回参数
- Code 错误码说明
- InvalidOperation:对应的元数据库/表不存在
- InternalError:其他类型错误,请参考 Message 提示
- taskid:因为 updatetable 也会更新 table 的所有 partitions 信息,如果是异步提交,那么就会返回一个 taskid,用来跟踪异步任务的执行状态。如果同步提交,那么该值无意义。
示例
正常返回示例
JSON
格式
{
"Code": "OK",
"Message": ".",
"RequestId": "B7F4B621-E41E-4C84-B97F-42B5380A32BB",
"Success": true,
"TaskId": "aa689782deb97265701f57324fc4ae42"
}
错误码
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 |
---|
暂无变更历史