使用UpdateTable API更新数据表信息-数据湖构建-阿里云-数据湖构建(DLF)-阿里云帮助中心

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

dlf:UpdateTable

*全部资源

*

无

请求语法

PUT /api/metastore/catalogs/databases/tables HTTP/1.1

请求参数

名称	类型	必填	描述	示例值
Body	object	否	HTTP 请求体，均采用 JSON 格式。
CatalogId	string	否	数据目录 ID。	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 的风险就是如果后台任务需要做很长，接口会超时

返回参数

名称	类型	描述	示例值
	object	返回结果体。
Code	string	状态码描述。	OK
Message	string	返回信息。	.
RequestId	string	请求 ID。	B7F4B621-E41E-4C84-B97F-42B5380A32BB
Success	boolean	是否调用成功。取值如下： true：成功。 false：失败。	true
TaskId	string	异步任务 ID。	aa689782deb97265701f57324fc4ae42

Code 错误码说明：

InvalidOperation：对应的数据库、表不存在。
InternalError：其他类型错误，请参考 Message 提示。
taskid：因为 updatetable 也会更新 table 的所有 partitions 信息，如果是异步提交，那么就会返回一个 taskid，用来跟踪异步任务的执行状态。如果同步提交，那么该值无意义。

示例

正常返回示例

JSON格式

{
  "Code": "OK",
  "Message": ".",
  "RequestId": "B7F4B621-E41E-4C84-B97F-42B5380A32BB",
  "Success": true,
  "TaskId": "aa689782deb97265701f57324fc4ae42"
}

错误码

访问错误中心查看更多错误码。

变更历史

更多信息，参考变更详情。