Retrieve & Paginate Run Metrics via ListRunMetrics API - Platform For AI

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

paiexperiment:ListRunMetrics

get

*All Resource

*

None

Request syntax

GET /api/v1/runs/{RunId}/metrics HTTP/1.1

Path Parameters

Parameter	Type	Required	Description	Example
RunId	string	Yes	The run ID.	run-1qJhzJ2YXgX****

Request parameters

Parameter	Type	Required	Description	Example
Key	string	Yes	The key of the metric for the run.	loss
PageToken	integer	No	The paging token. The token starts from 0. The default value is 0.	0
MaxResults	integer	No	The maximum number of results to return. The default value is 10.	100

Response elements

Element	Type	Description	Example
	object	The response schema.
requestId	string	The ID of the request.	ADF6D849-*****-7E7030F0CE53
Metrics	array	The list of metrics.
	RunMetric	The details of the metric.
NextPageToken	integer	The token to retrieve the next page of results. A value of 0 indicates that all results have been returned. Use the value of this parameter for the `PageToken` parameter in your next request to retrieve the next page.	0

Examples

Success response

JSON format

{
  "requestId": "ADF6D849-*****-7E7030F0CE53",
  "Metrics": [
    {
      "Value": 0,
      "Step": 0,
      "Timestamp": 0,
      "Key": ""
    }
  ],
  "NextPageToken": 0
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.