DescribeAIDBClusterDatasets

Updated at:
Copy as MD

Query datasets

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

polardb:DescribeAIDBClusterDatasets

list

*All Resource

*

None None

Request syntax

POST  HTTP/1.1

Request parameters

Parameter

Type

Required

Description

Example

RegionId

string

No

The region ID.

cn-beijing

DBClusterId

string

No

The ID of the PolarDB cluster for AI model services.

pc-2ze88***

DatasetType

string

No

The type of the dataset. Valid values:

  • train: The training set.

  • eval: The evaluation set.

train

TrainMode

string

No

The training mode. Valid values:

  • sft: supervised fine-tuning.

  • grpo: reinforcement learning.

  • text: text generation.

grpo

ContinuationToken

string

No

The token used to retrieve the next page of results. This value is obtained from the response of a previous request. For the first request, leave this parameter empty.

EFSDF-DF-***

PageSize

string

No

The number of entries to return on each page. Valid values: 30, 50, and 100.

Default value: 30.

30

PageNumber

string

No

The page number to return. Default value: 1.

1

DatasetId

string

No

The dataset ID.

pds-2ze88***

Response elements

Element

Type

Description

Example

object

The data returned.

RequestId

string

The request ID.

2921D843-433A-5FB3-A03B-4EC093B219F8

ContinuationToken

string

The continuation token from the request.

EFSDF-DF-***

RelativeDBClusterId

string

The relative DB cluster ID.

pc-2ze88***

DatasetType

string

The dataset type. Valid values:

  • train: The training set.

  • eval: The evaluation set.

train

DatasetMode

string

The training mode. Valid values:

  • sft: Supervised Fine-Tuning (SFT).

  • grpo: Reinforcement Learning (RL).

  • text: Text generation.

stf

NextContinuationToken

string

The token for retrieving the next page of results. This parameter is returned only if IsTruncated is true.

EFSDF-DF-***

IsTruncated

boolean

Indicates if more datasets are available. Valid values:

  • true: More datasets are available.

  • false: All datasets have been listed.

true

TotalCount

string

The total count of datasets.

6

PageSize

string

The page size.

30

Datasets

array<object>

An array of dataset objects.

object

A dataset object.

FileName

string

The file name.

train-***.json

Path

string

The file path.

polardb_ai/datasets/train/sft/dataset01/train-***.json

BucketName

string

The bucket name.

pcs-2ze22***-q7***

StorageType

string

The storage type. The only valid value is:

  • Standard.

Standard

Capacity

string

The file size in bytes.

2845904

LastModified

string

The time the file was last modified, in UTC and formatted as ISO 8601.

2025-11-06T06:50:43Z

CreationTime

string

The time the file was created, in UTC and formatted as ISO 8601.

2025-11-06T06:50:43Z

DatasetId

string

The dataset ID.

pds-2ze88***

DatasetType

string

The dataset type. Valid values:

  • train: The training set.

  • eval: The evaluation set.

train

TrainMode

string

The training mode. Valid values:

  • sft: Supervised Fine-Tuning (SFT).

  • grpo: Reinforcement Learning (RL).

  • text: Text generation.

stf

TotalRecords

string

The total number of records.

6

PageNumber

string

The page number.

1

DatasetId

string

The dataset ID.

pds-2ze88***

DataServiceId

string

The data service ID.

pcs-2zeei***

FileCount

string

The total number of files in the dataset.

6

Examples

Success response

JSON format

{
  "RequestId": "2921D843-433A-5FB3-A03B-4EC093B219F8",
  "ContinuationToken": "EFSDF-DF-***",
  "RelativeDBClusterId": "pc-2ze88***",
  "DatasetType": "train",
  "DatasetMode": "stf",
  "NextContinuationToken": "EFSDF-DF-***\n",
  "IsTruncated": true,
  "TotalCount": "6",
  "PageSize": "30",
  "Datasets": [
    {
      "FileName": "train-***.json",
      "Path": "polardb_ai/datasets/train/sft/dataset01/train-***.json",
      "BucketName": "pcs-2ze22***-q7***",
      "StorageType": "Standard\n",
      "Capacity": "2845904",
      "LastModified": "2025-11-06T06:50:43Z",
      "CreationTime": "2025-11-06T06:50:43Z",
      "DatasetId": "pds-2ze88***",
      "DatasetType": "train",
      "TrainMode": "stf"
    }
  ],
  "TotalRecords": "6",
  "PageNumber": "1",
  "DatasetId": "pds-2ze88***",
  "DataServiceId": "pcs-2zeei***",
  "FileCount": "6"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.