GetDataLakeTable - 获取数据湖的表信息

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

调试

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

调试

授权信息

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

  • 操作:是指具体的权限点。

  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。

  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:

    • 对于必选的资源类型,用前面加 * 表示。

    • 对于不支持资源级授权的操作,用全部资源表示。

  • 条件关键字:是指云产品自身定义的条件关键字。

  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

dms:GetDataLakeTable

get

*全部资源

*

请求参数

名称

类型

必填

描述

示例值

CatalogName

string

数据目录名。

hive

DbName

string

表所在的数据库的名称。

default

Name

string

表名。

100g_customer

Tid

integer

租户 ID,可通过调用接口 GetUserActiveTenant 或 ListUserTenants 获取该参数的值。

3****

WorkspaceId

integer

工作空间 ID。

12****

返回参数

名称

类型

描述

示例值

object

Schema of Response

RequestId

string

请求 ID,用于定位日志,排查问题。

4E1D2B4D-3E53-4ABC-999D-1D2520B3****

Success

string

请求是否成功,返回值如下:

  • true:请求成功。

  • false:请求失败。

true

ErrorCode

string

错误码

400

ErrorMessage

string

错误信息。

Unknown server error

Table DLTable

获取的表信息。

示例

正常返回示例

JSON格式

{
  "RequestId": "4E1D2B4D-3E53-4ABC-999D-1D2520B3****",
  "Success": "true",
  "ErrorCode": "400",
  "ErrorMessage": "Unknown server error",
  "Table": {
    "ViewOriginalText": "",
    "Owner": "",
    "TableType": "",
    "Parameters": {
      "test": "test",
      "test2": 1
    },
    "Description": "",
    "CreatorId": 0,
    "CreateTime": 0,
    "StorageDescriptor": {
      "OriginalColumns": [
        {
          "Comment": "",
          "Type": "",
          "Name": ""
        }
      ],
      "SortCols": [
        {
          "Order": 0,
          "Col": ""
        }
      ],
      "Parameters": {
        "test": "test",
        "test2": 1
      },
      "SkewedInfo": {
        "SkewedColValues": [
          [
            ""
          ]
        ],
        "SkewedColValueLocationMaps": {
          "test": "test",
          "test2": 1
        },
        "SkewedColNames": [
          ""
        ]
      },
      "InputFormat": "",
      "OutputFormat": "",
      "Columns": [
        {
          "Comment": "",
          "Type": "",
          "Name": ""
        }
      ],
      "IsCompressed": true,
      "SerdeInfo": {
        "SerializationLib": "",
        "DeserializerClass": "",
        "Parameters": {
          "test": "test",
          "test2": 1
        },
        "Description": "",
        "SerdeType": 0,
        "SerializerClass": "",
        "Name": ""
      },
      "BucketCols": [
        ""
      ],
      "NumBuckets": 0,
      "Location": ""
    },
    "LastAccessTime": 0,
    "Retention": 0,
    "Name": "",
    "OwnerType": "",
    "ViewExpandedText": "",
    "DbId": 0,
    "DbName": "",
    "CatalogName": "",
    "PartitionKeys": [
      {
        "Comment": "",
        "Type": "",
        "Name": ""
      }
    ],
    "ModifierId": 0,
    "Location": ""
  }
}

错误码

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

变更历史

更多信息,参考变更详情