GetDataLakeTable - Data Management - Alibaba Cloud Documentation Center

Queries basic information about tables in the data lake.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- For mandatory resource types, indicate with a prefix of * .
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
dms:GetDataLakeTable	get	All Resources ``	none	none

Request parameters

Parameter	Type	Required	Description	Example
DataRegion	string	Yes	The region where the data lake resides.	cn-hangzhou
CatalogName	string	Yes	The name of the data catalog.	hive
DbName	string	Yes	The name of the database to which the table belongs.	default
Name	string	Yes	The table name.	100g_customer
Tid	long	No	The tenant ID. You can call the GetUserActiveTenant or ListUserTenants operation to obtain the tenant ID.	3
WorkspaceId	long	No	The workspace ID.	12****

Response parameters

Parameter	Type	Description	Example
	object	Schema of Response
RequestId	string	The request ID. You can use the request ID to locate logs and troubleshoot issues.	4E1D2B4D-3E53-4ABC-999D-1D2520B3471A
Success	string	Indicates whether the request was successful. Valid values: true: The request was successful. false: The request failed.	true
ErrorCode	string	The error code that is returned if the request failed.	400
ErrorMessage	string	The error message that is returned if the request failed.	Unknown server error
Table	DLTable	The information of the table.

Examples

Sample success responses

JSONformat

{
  "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": 1410769,
    "CreatorId": 88653,
    "CreateTime": 1731586286,
    "StorageDescriptor": {
      "OriginalColumns": [
        {
          "Comment": "from deserializer",
          "Type": "string",
          "Name": "col"
        }
      ],
      "SortCols": [
        {
          "Order": 1,
          "Col": "col1"
        }
      ],
      "Parameters": {
        "test": "test",
        "test2": 1
      },
      "SkewedInfo": {
        "SkewedColValues": [
          [
            123
          ]
        ],
        "SkewedColValueLocationMaps": {
          "test": "test",
          "test2": 1
        },
        "SkewedColNames": [
          "col1"
        ]
      },
      "InputFormat": "org.apache.hadoop.mapred.SequenceFileInputFormat",
      "OutputFormat": "org.apache.hadoop.hive.ql.io.HiveSequenceFileOutputFormat",
      "Columns": [
        {
          "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": [
        2010
      ],
      "NumBuckets": -1,
      "Location": "oss://xxx"
    },
    "LastAccessTime": 1608707407,
    "Retention": 300,
    "Name": "100g_customer",
    "OwnerType": "USER",
    "ViewExpandedText": "",
    "DbId": 19,
    "DbName": "default",
    "CatalogName": "hive",
    "PartitionKeys": [
      {
        "Comment": "from deserializer",
        "Type": "string",
        "Name": "col"
      }
    ],
    "ModifierId": 1410769,
    "Location": "oss://xxx"
  }
}

Error codes

For a list of error codes, visit the Service error codes.