DescribeAIDBClusterTasks

Retrieves a list of model operators for a specified PolarDB instance.

Operation description

Request

This API returns a list of model operators filtered by the RelativeDBClusterId and KubeType parameters.
Note: Ensure the provided RelativeDBClusterId matches the ID of an existing PolarDB database instance. Otherwise, no data will be returned.

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:DescribeAIDBClusterTasks

list

*All Resource

*

None

Request syntax

POST  HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	No	The region ID.	cn-hangzhou
RelativeDBClusterId	string	No	The ID of the PolarDB instance.	pc-2ze88***
KubeType	string	No	The model operator type.	aitrain

Response elements

Element	Type	Description	Example
	object	The response object.
RequestId	string	The request ID.	925B84D9-CA72-432C-95CF-738C22******
Engine	string	The engine.	polardb_ai
EngineVersion	string	The engine version.	3.1
Items	array<object>	A list of model operators.
	object	An object that contains the details of a model operator.
DBNodeId	string	The model operator instance ID.	pm-2ze***
DBNodeStatus	string	The instance status. This parameter is not always returned.	RUNNING
DBNodeStatusDesc	string	The description of the instance status.	RUNNING
DBNodeDescription	string	The node description.	test
CreationTime	string	The creation time.	2025-03-25T09:37:10Z
ModelName	string	The model name.	***
ModelSource	string	The model source.	public
TrainMode	string	The training mode.	sft
TrainType	string	The training type.	lora
Engine	string	The engine.	polardb_ai
DataZoneId	string	The availability zone.	cn-beijing-i
EngineVersion	string	The engine version.	3.1
ModelPath	string	The model path.	***
RunningTimes	string	The runtime parameters.	xxx
StartTime	string	The start time.	2020-06-09T18:00:00Z
CompletedTime	string	The completion time.	2020-06-09T18:00:00Z
RelativeDBClusterId	string	The PolarDB cluster ID.	pc-2ze***
TaskType	string	The task type.	train

Examples

Success response

JSON format

{
  "RequestId": "925B84D9-CA72-432C-95CF-738C22******",
  "Engine": "polardb_ai",
  "EngineVersion": "3.1",
  "Items": [
    {
      "DBNodeId": "pm-2ze***",
      "DBNodeStatus": "RUNNING",
      "DBNodeStatusDesc": "RUNNING",
      "DBNodeDescription": "test",
      "CreationTime": "2025-03-25T09:37:10Z",
      "ModelName": "***",
      "ModelSource": "public",
      "TrainMode": "sft",
      "TrainType": "lora",
      "Engine": "polardb_ai",
      "DataZoneId": "cn-beijing-i",
      "EngineVersion": "3.1",
      "ModelPath": "***",
      "RunningTimes": "xxx",
      "StartTime": "2020-06-09T18:00:00Z",
      "CompletedTime": "2020-06-09T18:00:00Z"
    }
  ],
  "RelativeDBClusterId": "pc-2ze***",
  "TaskType": "train"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.