All Products
Search

This Product

    PolarDB:DescribeAIDBClusterTaskMetrics

    Document Center

    PolarDB:DescribeAIDBClusterTaskMetrics

    Last Updated:May 08, 2026

    Queries the metrics of model operators.

    Operation description

    Note

    For more information about kernel versions for PolarDB for MySQL clusters, see Kernel versions and Kernel release notes.

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

    get

    *All Resource

    *

    		 None None

    Request syntax

    GET  HTTP/1.1

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    DBClusterId

    string

    Yes

    The cluster ID.

    pm-2zejpr***
    RelativeDBClusterId

    string

    No

    The ID of the associated PolarDB instance.

    pc-2zejpr***
    PageSize

    integer

    No

    The number of records to return on each page. Valid values:

    • 30

    • 50

    • 100

    The default value is 100.

    100
    PageNumber

    integer

    No

    The page number of the query result.

    1
    StartTime

    string

    Yes

    The start time of the query. The time is in the yyyy-MM-ddTHH:mm:ssZ format in UTC.

    2026-01-15T14:00:00Z
    EndTime

    string

    Yes

    The end time of the query. The time is in the yyyy-MM-ddTHH:mm:ssZ format in UTC.

    2026-01-15T15:00:00Z
    Reverse

    boolean

    No

    Specifies whether to sort the results in reverse order. The default value is false.

    false
    MetricType

    string

    No

    The metric type. Valid values:

    • all

    • train

    • eval

    Note

    The default value is all.

    all

    Response elements

    Element

    Type

    Description

    Example

    object

    Schema of Response

    PageRecordCount

    integer

    The total number of entries that match the query conditions. This parameter is optional and is not returned by default.

    5
    RequestId

    string

    Id of the request

    5E71541A-6007-4DCC-A38A-F872C31FEB45
    PageSize

    integer

    The maximum number of entries returned for the current request.

    10
    PageNumber

    integer

    The page number of the returned page. The default value is 1.

    1
    StartTime

    string

    The start time of the query. The time is in the yyyy-MM-ddTHH:mm:ssZ format in UTC.

    2026-01-15T14:00:00Z
    EndTime

    string

    The end time of the query. The time is in the yyyy-MM-ddTHH:mm:ssZ format in UTC.

    2026-01-15T15:00:00Z
    Items

    object

    The list.

    SlsMetricsItems

    array<object>

    The list of metrics.

    array<object>

    Timestamp

    string

    The specific point in time when the monitoring metric was collected. The value is a UNIX timestamp. Unit: seconds.

    1742090703
    LogTime

    string

    The log time.

    2026-01-15T14:16:49.52140317Z
    CurrentStep

    integer

    The current step.

    21
    GlobalStep

    integer

    The total number of steps.

    90
    Epoch

    number

    The epoch.

    0.23
    MetricType

    string

    The metric type.

    train
    Metric

    object

    The metric details.

    {"memory(GiB)":"xxx"}
    MetricType

    string

    The metric type.

    all
    DBClusterId

    string

    The cluster ID.

    pm-2zejpr***
    RelativeDbClusterId

    string

    The ID of the associated PolarDB cluster.

    pc-2zejpr***

    Examples

    Success response

    JSON format

    {
  "PageRecordCount": 5,
  "RequestId": "5E71541A-6007-4DCC-A38A-F872C31FEB45",
  "PageSize": 10,
  "PageNumber": 1,
  "StartTime": "2026-01-15T14:00:00Z",
  "EndTime": "2026-01-15T15:00:00Z",
  "Items": {
    "SlsMetricsItems": [
      {
        "Timestamp": "1742090703",
        "LogTime": "2026-01-15T14:16:49.52140317Z",
        "CurrentStep": 21,
        "GlobalStep": 90,
        "Epoch": 0.23,
        "MetricType": "train",
        "Metric": {
          "memory(GiB)": "xxx"
        }
      }
    ]
  },
  "MetricType": "all",
  "DBClusterId": "pm-2zejpr***",
  "RelativeDbClusterId": "pc-2zejpr***"
}

    Error codes

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.