ListDataLakePartitionByFilter API Reference - Data Management - Alibaba Cloud - Data Management

Lists data lake table partitions that match a filter condition.

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

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

dms:ListDataLakePartitionByFilter

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
DataRegion	string	Yes	The region where the data lake resides.	cn-hangzhou
Tid	integer	No	The tenant ID. Note Find this ID by hovering over your profile picture in the upper-right corner of the console. For more information, 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	The conditional expression used to filter partitions. Supported operators include the following: Comparison operators: =, <>, !=, <, <=, >, >=. Example: ds>20240101. Logical operators: AND, OR, NOT. Example: ds LIKE '20240%' BETWEEN operator: Specifies a range. Example: ds BETWEEN 20240101 AND 20241201. IN operator: Specifies a set of values. Example: ds IN (20240101, 20240102).	ds>20241201
NextToken	string	No	The token for the next page of results. Values: If NextToken is empty, no more pages exist. If NextToken has a value, use it as the starting token for the next request.	f056501ada12c1cc
MaxResults	integer	No	The maximum number of results per page. Maximum: 100.	20
WorkspaceId	integer	No	The workspace ID.	12****

Response elements

Element	Type	Description	Example
	object	Response schema
RequestId	string	The request ID. Use it to locate logs and troubleshoot issues.	427688B8-ADFB-4C4E-9D45-EF5C1FD6E23D
Success	boolean	Indicates whether the call succeeded. true: The call succeeded. false: The call failed.	true
ErrorCode	string	The error code returned when the request fails.	UnknownError
ErrorMessage	string	The error message returned when the call fails.	UnknownError
PartitionList	array	The list of partitions.
	DLPartition	Information about a data lake table partition.
NextToken	string	The token for the next page of results.	NesLoKLEdIZrKhDT7I2gS****
MaxResults	integer	The maximum number of results per page.	20

Examples

Success response

JSON format

{
  "RequestId": "427688B8-ADFB-4C4E-9D45-EF5C1FD6E23D",
  "Success": true,
  "ErrorCode": "UnknownError",
  "ErrorMessage": "UnknownError",
  "PartitionList": [
    {
      "TableName": "table_name",
      "Sd": {
        "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"
      },
      "Parameters": {
        "key": "{\"key\":\"value\"}"
      },
      "CreateTime": 1735109884,
      "Values": [
        "part_val1"
      ],
      "CatalogName": "hive",
      "DbName": "default",
      "LastAccessTime": 1608707407
    }
  ],
  "NextToken": "NesLoKLEdIZrKhDT7I2gS****",
  "MaxResults": 20
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.