GetTable - Data Lake Formation - Alibaba Cloud Documentation Center

Get detailed information about the data 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
dlf:GetTable	get	All Resources ``	none	none

Request syntax

GET /api/metastore/catalogs/databases/tables HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
CatalogId	string	No	The ID of the data directory.	1344371
DatabaseName	string	No	The name of a database.	database_test
TableName	string	No	The name of the data table.	test_table_20200715162543389

Response parameters

Parameter	Type	Description	Example
	object	The message returned.
Code	string	The response code.	OK
Message	string	The response message.	.
RequestId	string	The request ID.	B7F4B621-E41E-4C84-B97F-42B5380A32BB
Success	boolean	Indicates whether the request was successful. Valid values: Valid values: true false	true
Table	Table	The details about the data table.

Code: the error code.
NoSuchObject: The specified metadata table does not exist.
InternalError: Other types of errors. For more information, see Message tips.

Examples

Sample success responses

JSONformat

{
  "Code": "OK",
  "Message": ".",
  "RequestId": "B7F4B621-E41E-4C84-B97F-42B5380A32BB",
  "Success": true,
  "Table": {
    "Cascade": false,
    "CreateTime": 1608707407,
    "CreatedBy": "zhangsan",
    "DatabaseName": "database_test",
    "LastAccessTime": 1608707407,
    "LastAnalyzedTime": 1608707407,
    "Owner": "zhangsan",
    "OwnerType": "USER",
    "Parameters": {
      "key": "key"
    },
    "PartitionKeys": [
      {
        "Comment": "comment_day",
        "Name": "day",
        "Parameters": {
          "key": "key"
        },
        "Type": "int"
      }
    ],
    "Privileges": {
      "GroupPrivileges": {
        "key": [
          {
            "CreateTime": 1606226844,
            "GrantOption": true,
            "Grantor": "Grantor",
            "GrantorType": "GrantorType",
            "Privilege": "Privilege"
          }
        ]
      },
      "RolePrivileges": {
        "key": [
          {
            "CreateTime": 1606226844,
            "GrantOption": true,
            "Grantor": "Grantor",
            "GrantorType": "GrantorType",
            "Privilege": "Privilege"
          }
        ]
      },
      "UserPrivileges": {
        "key": [
          {
            "CreateTime": 1606226844,
            "GrantOption": true,
            "Grantor": "Grantor",
            "GrantorType": "GrantorType",
            "Privilege": "Privilege"
          }
        ]
      }
    },
    "Retention": 30000,
    "RewriteEnabled": true,
    "Sd": {
      "BucketCols": [
        "2010"
      ],
      "Cols": [
        {
          "Comment": "comment_day",
          "Name": "day",
          "Parameters": {
            "key": "key"
          },
          "Type": "int"
        }
      ],
      "Compressed": false,
      "InputFormat": "org.apache.hadoop.hive.ql.io.avro.AvroContainerInputFormat",
      "Location": "file:///tmp/table",
      "NumBuckets": 10,
      "OutputFormat": "org.apache.hadoop.hive.ql.io.avro.AvroContainerOutputFormat",
      "Parameters": {
        "key": "key"
      },
      "SerDeInfo": {
        "Name": "name",
        "SerializationLib": "org.apache.hadoop.hive.serde2.OpenCSVSerde"
      },
      "SkewedInfo": {
        "SkewedColNames": [
          "col1"
        ],
        "SkewedColValueLocationMaps": {
          "key": "{“col1”:\"val1\"}"
        },
        "SkewedColValues": [
          [
            "\"123\""
          ]
        ]
      },
      "SortCols": [
        {
          "Col": "col1",
          "Order": 1
        }
      ],
      "StoredAsSubDirectories": false
    },
    "TableName": "table_name",
    "TableType": "MANAGED_TABLE",
    "Temporary": false,
    "UpdateTime": 1608707407,
    "ViewExpandedText": "''",
    "ViewOriginalText": "''",
    "TableId": "59c6c8fefeaa46d8b599c1f790c59a19",
    "TableVersion": {
      "Table": {
        "Cascade": false,
        "CreateTime": 1608707407,
        "CreatedBy": "zhangsan",
        "DatabaseName": "database_test",
        "LastAccessTime": 1608707407,
        "LastAnalyzedTime": 1608707407,
        "Owner": "zhangsan",
        "OwnerType": "USER",
        "PartitionKeys": [
          {
            "Comment": "comment_day",
            "Name": "day",
            "Type": "int"
          }
        ],
        "Privileges": {},
        "Retention": 30000,
        "RewriteEnabled": true,
        "Sd": {
          "BucketCols": [
            "2010"
          ],
          "Cols": [],
          "Compressed": false,
          "InputFormat": "org.apache.hadoop.hive.ql.io.avro.AvroContainerInputFormat",
          "Location": "file:///tmp/table",
          "NumBuckets": 10,
          "OutputFormat": "org.apache.hadoop.hive.ql.io.avro.AvroContainerOutputFormat",
          "Parameters": {
            "key": "key"
          },
          "SerDeInfo": {
            "Name": "name",
            "SerializationLib": "org.apache.hadoop.hive.serde2.OpenCSVSerde"
          },
          "SkewedInfo": {
            "SkewedColNames": [
              "col1"
            ],
            "SkewedColValueLocationMaps": {
              "key": "{“col1”:\"val1\"}"
            },
            "SkewedColValues": [
              [
                "\"123\""
              ]
            ]
          },
          "SortCols": [
            {
              "Col": "col1",
              "Order": 1
            }
          ],
          "StoredAsSubDirectories": false
        },
        "TableName": "table_name",
        "TableType": "MANAGED_TABLE",
        "Temporary": false,
        "UpdateTime": 1608707407,
        "ViewExpandedText": "''",
        "ViewOriginalText": "''",
        "TableId": "59c6c8fefeaa46d8b599c1f790c59a19",
        "TableVersion": {
          "Table": {
            "Cascade": false,
            "CreateTime": 1608707407,
            "CreatedBy": "zhangsan",
            "DatabaseName": "database_test",
            "LastAccessTime": 1608707407,
            "LastAnalyzedTime": 1608707407,
            "Owner": "zhangsan",
            "OwnerType": "USER",
            "PartitionKeys": [],
            "Privileges": {},
            "Retention": 30000,
            "RewriteEnabled": true,
            "Sd": {
              "BucketCols": [
                "2010"
              ],
              "Cols": [],
              "Compressed": false,
              "InputFormat": "org.apache.hadoop.hive.ql.io.avro.AvroContainerInputFormat",
              "Location": "file:///tmp/table",
              "NumBuckets": 10,
              "OutputFormat": "org.apache.hadoop.hive.ql.io.avro.AvroContainerOutputFormat",
              "Parameters": {
                "key": "key"
              },
              "SerDeInfo": {
                "Name": "name",
                "SerializationLib": "org.apache.hadoop.hive.serde2.OpenCSVSerde"
              },
              "SkewedInfo": {
                "SkewedColNames": [
                  "col1"
                ],
                "SkewedColValueLocationMaps": {
                  "key": "{“col1”:\"val1\"}"
                },
                "SkewedColValues": [
                  [
                    "\"123\""
                  ]
                ]
              },
              "SortCols": [
                {
                  "Col": "col1",
                  "Order": 1
                }
              ],
              "StoredAsSubDirectories": false
            },
            "TableName": "table_name",
            "TableType": "MANAGED_TABLE",
            "Temporary": false,
            "UpdateTime": 1608707407,
            "ViewExpandedText": "''",
            "ViewOriginalText": "''",
            "TableId": "59c6c8fefeaa46d8b599c1f790c59a19",
            "TableVersion": {
              "VersionId": 5
            }
          },
          "VersionId": 5
        }
      },
      "VersionId": 5
    }
  }
}

Error codes

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

Change history

Change time	Summary of changes	Operation

No change history