ListDataLakePartitionByFilter - Data Management - Alibaba Cloud Documentation Center

Retrieves a list of partitions for a data lake table based on filter conditions.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request parameters

Parameter	Type	Required	Description	Example
Tid	integer	No	The tenant ID. Note Hover over your profile picture in the upper-right corner of the DMS console to obtain the tenant ID. For details, see View tenant information.	3****
CatalogName	string	Yes	The name of the data catalog.	hive
DbName	string	Yes	The name of the database.	default
TableName	string	Yes	The name of the table.	test_table
Filter	string	Yes	Query conditional expression. Supported operators: Comparison operators: =, <>, !=, <, <=, >, and >=. For example: `ds>20240101`. Logical operators: AND, OR, and NOT. For example: `ds LIKE '20240%'`. The BETWEEN operator, which specifies a range. For example: `ds BETWEEN 20240101 AND 20241201`. The IN operator, which specifies a set of values. For example: `ds IN (20240101, 20240102)`.	ds>20241201
NextToken	string	No	The token that is used to retrieve the next page of results. Valid values: If this parameter is left empty, no more results are returned. If a value is returned, the value is the token for the next query.	f056501ada12****
MaxResults	integer	No	The number of entries per page. The maximum value is 100.	20
WorkspaceId	integer	No	The ID of the workspace.	12****

Response elements

Element	Type	Description	Example
	object	Schema of Response.
RequestId	string	The ID of the request, used for log tracing and troubleshooting.	427688B8-ADFB-4C4E-9D45-EF5C1FD6****
Success	boolean	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 fails.	UnknownError
ErrorMessage	string	The error message that is returned if the request fails.	UnknownError
PartitionList	array	The list of partitions.
	DLPartition	The information about the data lake table partitions.
NextToken	string	The token for the next page of results.	NesLoKLEdIZrKhDT7I2gS****
MaxResults	integer	The number of entries per page.	20

Examples

Success response

JSON format

{
  "RequestId": "427688B8-ADFB-4C4E-9D45-EF5C1FD6****",
  "Success": true,
  "ErrorCode": "UnknownError",
  "ErrorMessage": "UnknownError",
  "PartitionList": [
    {
      "TableName": "",
      "Sd": {
        "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": ""
      },
      "Parameters": {
        "key": ""
      },
      "CreateTime": 0,
      "Values": [
        ""
      ],
      "CatalogName": "",
      "DbName": "",
      "LastAccessTime": 0
    }
  ],
  "NextToken": "NesLoKLEdIZrKhDT7I2gS****",
  "MaxResults": 20
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.