文档首页/ 湖仓构建 LakeFormation/ API参考/ API/ LakeCat/ 元数据事件管理/ 获取元数据事件
更新时间：2024-10-22 GMT+08:00
查看PDF
分享

获取元数据事件

功能介绍

获取元数据事件。

调试

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

URI

GET /v1/{project_id}/instances/{instance_id}/metadata-event

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目编号。获取方法，请参见获取项目ID。

instance_id

是

String

LakeFormation实例ID。创建实例时自动生成。例如：2180518f-42b8-4947-b20b-adfc53981a25。
表2 Query参数

参数

是否必选

参数类型

描述

begin_time

否

String

开始时间对应的UTC时间，返回该时间之后的元数据事件。

end_time

否

String

结束时间对应的UTC时间，返回该时间之前的元数据事件。

limit

否

Integer

查询返回条数。

marker

否

String

查询的起始记录ID。

reverse_page

否

Boolean

是否倒序查询。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

Array of strings

租户token。

响应参数

状态码： 200

表4 响应Body参数

参数

参数类型

描述

page_info

PagedInfo object

分页信息。

metadata_events

Array of MetadataEvent objects

元数据事件列表。
表5 PagedInfo

参数

参数类型

描述

current_count

Integer

本次返回的对象个数。最小值为0，最大值为2000。

next_marker

String

下一页查询地址。当不存在下一页，则值为null，当值为null时，响应Body无该参数。

previous_marker

String

上一页查询地址。当不存在上一页，则值为null，当值为null时，响应Body无该参数。
表6 MetadataEvent

参数

参数类型

描述

event_time

String

事件发生时间对应的UTC时间。

metadata_action_type

String

元数据操作类型：CREATE_CATALOG-创建Catalog、CREATE_DATABASE-创建数据库、 CREATE_TABLE-创建表、CREATE_FUNCTION-创建函数、CREATE_PARTITION-添加分区、UPDATE_CATALOG-修改Catalog、UPDATE_DATABASE-修改数据库、UPDATE_TABLE-修改表、UPDATE_FUNCTION-修改函数、UPDATE_PARTITION-修改分区、DELETE_TABLE-删除表、 DELETE_DATABASE-删除数据库、DELETE_CATALOG-删除Catalog、DELETE_FUNCTION-删除函数、DELETE_PARTITION-删除分区。

枚举值：

  • CREATE_CATALOG

  • CREATE_DATABASE

  • CREATE_TABLE

  • CREATE_FUNCTION

  • CREATE_PARTITION

  • UPDATE_CATALOG

  • UPDATE_DATABASE

  • UPDATE_TABLE

  • UPDATE_FUNCTION

  • UPDATE_PARTITION

  • DELETE_CATALOG

  • DELETE_DATABASE

  • DELETE_TABLE

  • DELETE_FUNCTION

  • DELETE_PARTITION

metadata_object

Object

元数据对象，包含元数据操作类型对应的元数据信息，如库、表信息等。

original_metadata_object

Object

原元数据对象，包含元数据操作类型对应的元数据信息，如库、表信息等。

状态码： 400

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

solution_msg

String

解决方案描述。

状态码： 404

表8 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

solution_msg

String

解决方案描述。

状态码： 500

表9 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

solution_msg

String

解决方案描述。

请求示例

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

响应示例

状态码： 200

OK

{
  "page_info" : {
    "current_count" : 1,
    "next_marker" : "006f492b-xxxx",
    "previous_marker" : "003e6eba-xxxx"
  },
  "metadata_events" : [ {
    "event_time" : "2022-12-31T23:59:59.000+00:00",
    "metadata_action_type" : "CREATE_CATALOG",
    "metadata_object" : {
      "catalog_id" : "123",
      "catalog_name" : "hive",
      "description" : "Default catalog, for Hive",
      "location" : "obs://lakeformation/test",
      "database_location_list" : null,
      "owner" : "admin",
      "owner_type" : "USER",
      "owner_source" : "IAM"
    }
  } ]
}

状态码： 400

Bad Request

{
  "error_code" : "common.01000001",
  "error_msg" : "failed to read http request, please check your input, code: 400, reason: Type mismatch., cause: TypeMismatchException"
}

状态码： 401

Unauthorized

{
  "error_code": 'APIG.1002',
  "error_msg": 'Incorrect token or token resolution failed'
}

状态码： 403

Forbidden

{
  "error" : {
    "code" : "403",
    "message" : "X-Auth-Token is invalid in the request",
    "error_code" : null,
    "error_msg" : null,
    "title" : "Forbidden"
  },
  "error_code" : "403",
  "error_msg" : "X-Auth-Token is invalid in the request",
  "title" : "Forbidden"
}

状态码： 404

Not Found

{
  "error_code" : "common.01000001",
  "error_msg" : "response status exception, code: 404"
}

状态码： 408

Request Timeout

{
  "error_code" : "common.00000408",
  "error_msg" : "timeout exception occurred"
}

状态码： 500

Internal Server Error

{
  "error_code" : "common.00000500",
  "error_msg" : "internal error"
}

状态码

状态码

描述

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

408

Request Timeout

500

Internal Server Error

错误码

请参见错误码。

父主题： 元数据事件管理

相关文档