更新时间：2026-08-11 GMT+08:00

清除元数据 - ClearMetadata

功能介绍

清除元数据。

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限，具体权限要求请参见权限和授权项。

URI

POST /v1/{project_id}/instances/{instance_id}/metadata/clear

表1 路径参数
参数	是否必选	参数类型	描述
project_id	是	String	参数解释: 项目编号。获取方法，请参见获取项目ID。约束限制: 长度为1~64个字符取值范围: 长度为1~64个字符默认取值: 不涉及
instance_id	是	String	参数解释: LakeFormation实例ID。创建实例时自动生成。例如：2180518f-42b8-4947-b20b-adfc53981a25。约束限制: 不涉及取值范围: 不涉及默认取值: 不涉及

请求参数

表2 请求Header参数
参数	是否必选	参数类型	描述
X-Auth-Token	是	Array of strings	参数解释: 租户token。约束限制: 数组元素个数为1~100 取值范围: 数组元素个数为1~100 默认取值: 不涉及

表3 请求Body参数
参数	是否必选	参数类型	描述
metadata_id	否	String	参数解释: 元数据ID 约束限制: 长度为1~24个字符取值范围: 长度为1~24个字符默认取值: 不涉及
metadata_type	是	String	参数解释: 元数据类型：CATALOG、DATABASE、TABLE、FUNCTION、PARTITION、FILE、FILESET、FILEGROUP 约束限制: 可选值为：CATALOG, DATABASE, TABLE, FUNCTION, PARTITION 取值范围: 不涉及默认取值: 不涉及
version	否	String	参数解释: 元数据版本约束限制: 不涉及取值范围: 不涉及默认取值: 不涉及
clear_data	否	Boolean	参数解释: 是否清除数据。默认为false。清除数据库和表时可选true 约束限制: 不涉及取值范围: 不涉及默认取值: false
cascade	否	Boolean	参数解释: 是否级联清除数据库下的表、分区以及函数。默认为false。清除数据库时可选true 约束限制: 不涉及取值范围: 不涉及默认取值: false

响应参数

状态码：201

无

请求示例

GET https://{endpoint} /v1/{project_id}/instances/{instance_id}/metadata/clear

{
  "metadata_id" : "123456",
  "metadata_type" : "CATALOG",
  "version" : "123456123456123456123456",
  "clear_data" : false,
  "cascade" : false
}

响应示例

无

状态码

状态码	描述
201	OK

错误码

请参见错误码。

父主题： 元数据恢复