GetDataLakeTable - 获取数据湖的表信息 - 数据管理 DMS

调用此API可以获取数据湖的表信息。

调试

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

授权信息

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

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

操作	访问级别	资源类型	条件关键字	关联操作
dms:GetDataLakeTable	get	全部资源 ``	无	无

请求参数

名称	类型	必填	描述	示例值
DataRegion	string	是	数据湖所属的地域。	cn-hangzhou
CatalogName	string	是	数据目录名。	hive
DbName	string	是	表所在的数据库的名称。	default
Name	string	是	表名。	100g_customer
Tid	long	否	租户 ID，可通过调用接口 GetUserActiveTenant 或 ListUserTenants 获取该参数的值。	3

返回参数

名称	类型	描述	示例值
	object	Schema of Response
RequestId	string	请求 ID，用于定位日志，排查问题。	4E1D2B4D-3E53-4ABC-999D-1D2520B3471A
Success	string	请求是否成功，返回值如下： true：请求成功。 false：请求失败。	true
ErrorCode	string	错误码。	400
ErrorMessage	string	错误信息。	Unknown server error
Table	DLTable	获取的表信息。

示例

正常返回示例

JSON格式

{
  "RequestId": "4E1D2B4D-3E53-4ABC-999D-1D2520B3471A",
  "Success": "true",
  "ErrorCode": "400",
  "ErrorMessage": "Unknown server error",
  "Table": {
    "ViewOriginalText": "\"\"",
    "Owner": "zhangsan",
    "TableType": "EXTERNAL_TABLE",
    "Parameters": {
      "EXTERNAL": "TRUE",
      "delta.minReaderVersion": "1"
    },
    "Description": "test",
    "CreatorId": 0,
    "CreateTime": 1731586286,
    "StorageDescriptor": {
      "OriginalColumns": {
        "OriginalColumn": [
          {
            "Comment": "from deserializer",
            "Type": "string",
            "Name": "col"
          }
        ]
      },
      "SortCols": {
        "SortCol": [
          {
            "Order": 1,
            "Col": "col1"
          }
        ]
      },
      "Parameters": {
        "test": "test",
        "test2": 1
      },
      "SkewedInfo": {
        "SkewedColValues": {
          "SkewedColValue": [
            {
              "SkewedColValue": [
                "\"123\""
              ]
            }
          ]
        },
        "SkewedColValueLocationMaps": {
          "test": "test",
          "test2": 1
        },
        "SkewedColNames": {
          "SkewedColName": [
            "col1"
          ]
        }
      },
      "InputFormat": "org.apache.hadoop.mapred.SequenceFileInputFormat",
      "OutputFormat": "org.apache.hadoop.hive.ql.io.HiveSequenceFileOutputFormat",
      "Columns": {
        "Column": [
          {
            "Comment": "from deserializer",
            "Type": "string",
            "Name": "col"
          }
        ]
      },
      "IsCompressed": false,
      "SerdeInfo": {
        "SerializationLib": "org.apache.hadoop.hive.serde2.lazy.LazySimpleSerDe",
        "DeserializerClass": "org.apache.hadoop.hive.serde2.OpenCSVSerde",
        "Parameters": {
          "serialization.format": "1"
        },
        "Description": "\"serialize\"",
        "SerdeType": "0",
        "SerializerClass": "org.apache.hadoop.hive.serde2.lazy.LazySimpleSerDe",
        "Name": "name"
      },
      "BucketCols": {
        "BucketCol": [
          "2010"
        ]
      },
      "NumBuckets": -1,
      "Location": "oss://xxx"
    },
    "LastAccessTime": 1608707407,
    "Retention": 300,
    "Name": "100g_customer",
    "OwnerType": "USER",
    "ViewExpandedText": "\"\"",
    "DbId": 19,
    "DbName": "default",
    "CatalogName": "hive",
    "PartitionKeys": {
      "PartitionKey": [
        {
          "Comment": "from deserializer",
          "Type": "string",
          "Name": "col"
        }
      ]
    },
    "ModifierId": 1410769,
    "Location": "oss://xxx"
  }
}

错误码

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