接口功能介绍
此接口提供查询集群下指定表的元数据的功能,用户输入集群id、时间戳、Hive库名、Hive表名,返回集群的该表的文件数、存储大小、分区数等元数据。
接口约束
- V2.16版本起,支持使用OpenAPI查询元数据信息。
- 当前仅支持查询Hive元数据信息。
- 集群必须处于运行状态。
接口是否审批
否
URI
GET /v1/emr/doctor/openapi/meta/hive/tableInfo
Content-Type
application/json
路径参数
无
Query参数
Query参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 |
---|---|---|---|---|
clusterId | 是 | String | 集群id | da595eb1d81503b323fdc01d9bf786b7 |
timestamp | 是 | Long | 要查询的时间点,以 Unix 时间戳表示(单位:秒) | 1700000000 |
databaseName | 是 | String | Hive库名 | test_db1 |
tableName | 是 | String | Hive表名 | test_table1 |
请求头header参数
无
请求体body参数
无
响应参数
响应参数
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
statusCode | Integer | 状态码 | 200 | |
message | String | 用来简述当前接口调用状态以及必要提示信息 | success | |
error | String | 错误码,请求成功时,不返回该字段 | EMR_400001 | |
returnObj | Object | 返回结果 | returnObj |
枚举参数
无
请求头header示例
无
请求url示例
https://emr-global.ctapi.ctyun.cn/v1/emr/doctor/openapi/meta/hive/tableInfo?clusterId=cluster-12345×tamp=1700000000&databaseName=test_db1&tableName=test_table1
请求体body示例
无
响应示例
请求成功返回值示例
{
"statusCode": 200,
"message": "success",
"returnObj": {
"clusterId": "da595eb1d81503b323fdc01d9bf786b7",
"databaseName": "test_db1",
"tableName": "test_table1",
"hivePath": "/hive/xxx/xxx/xx",
"fileCnt": 100,
"storageCnt": 204800,
"avgStorageCnt": 2048,
"lastAccessTime": "2024-11-06 01:09:37",
"isExternalTable": false,
"isMisDelete": false,
"isPartitionTable": true,
"partitionCnt": 20,
"iceFileCnt": 1,
"iceStorageCnt": 20,
"coldFileCnt": 1,
"coldStorageCnt": 1024,
"emptyFilePtCnt": 1,
"emptyFilePtFileCnt": 2,
"smallFilePtCnt": 5,
"smallFilePtFileCnt": 5
}
}
请求失败返回值示例
{
"statusCode": 500,
"error": "EMR_401005",
"message": "该集群不存在",
"returnObj": {}
}
状态码
请参考状态码
错误码
请参考错误码