ListExperiment-阿里云帮助中心

Retrieves a list of experiments.

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

list

*All Resource

*

None

Request syntax

GET /api/v1/experiments HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
Name	string	No	The name of the experiment.	exp-test
WorkspaceId	string	No	The ID of the workspace where the experiment resides. For more information about how to obtain a workspace ID, see ListWorkspaces. Note If you do not specify a workspace ID, the system returns the list of experiments in the default workspace.	1517**
Labels	string	No	The filter conditions for labels. Separate multiple conditions with commas (,). A single filter condition must be in the `Key=Value` format.	is_evaluation:true
SortBy	string	No	The field to use for sorting in a paged query. Currently, only the GmtCreateTime field is supported for sorting.	GmtCreateTime
Order	string	No	The order in which to sort the results of a paged query. Valid values: ASC: ascending order. DESC (default): descending order.	DESC
PageNumber	integer	No	The page number. Pages start from 1.	1
PageSize	integer	No	The number of entries per page.	10
OrderBy	string	No	A list of sorting methods as strings. You can sort by the following fields: GmtCreateTime, Name, GmtModifiedTime, or ExperimentId. The sorting methods are DESC and ASC. The default is ASC.	GmtCreateTime DESC,Name ASC
PageToken	integer	No	The paging token. It starts from 0. The default is 0.	0
MaxResults	integer	No	The maximum number of results to return. The default is 10.	10
Verbose	boolean	No	Specifies whether to retrieve the LatestRun information related to the experiment.	false
Options	object	No	Optional parameters.
match_name_exactly	string	No	Specifies whether to perform an exact match for the name. Valid values are "true" and "false".	true

Response elements

Element	Type	Description	Example
	object	The schema of the response.
requestId	string	The request ID.	0C6835C5-A424-5AFB-ACC2-F1E3CA1ABF7C
TotalCount	integer	The total number of records.	5
Experiments	array	The list of experiments.
	Experiment	The details of an experiment.
NextPageToken	integer	The token for the next page. Save this token and include it in the next request to retrieve the next page of results.	0

Examples

Success response

JSON format

{
  "requestId": "0C6835C5-A424-5AFB-ACC2-F1E3CA1ABF7C",
  "TotalCount": 5,
  "Experiments": [
    {
      "ExperimentId": "",
      "Name": "",
      "WorkspaceId": "",
      "ArtifactUri": "",
      "TensorboardLogUri": "",
      "Labels": [
        {
          "Key": "key",
          "Value": "value",
          "GmtCreateTime": "2023-12-27T03:30:04Z",
          "GmtModifiedTime": "2023-12-27T03:30:04Z",
          "ExperimentId": "exp-890waerw09a0f"
        }
      ],
      "UserId": "",
      "OwnerId": "",
      "GmtCreateTime": "",
      "GmtModifiedTime": "",
      "RequestId": "",
      "Accessibility": "",
      "LatestRun": {
        "Accessibility": "PRIVATE",
        "SourceId": "train9s0afvjkf",
        "SourceType": "TrainingService",
        "WorkspaceId": "145883",
        "Params": [
          {
            "Value": "",
            "Key": ""
          }
        ],
        "Labels": [
          {
            "Value": "",
            "RunId": "",
            "GmtCreateTime": "",
            "GmtModifiedTime": "",
            "Key": ""
          }
        ],
        "GmtModifiedTime": "2021-01-30T12:51:33.028Z",
        "Name": "testrun",
        "Metrics": [
          {
            "Value": 0,
            "Step": 0,
            "Timestamp": 0,
            "Key": ""
          }
        ],
        "OwnerId": "1631044****3440",
        "ExperimentId": "exp-1zpfthdx******",
        "UserId": "",
        "RunId": "run-1qJhzJ2YXgX****",
        "GmtCreateTime": "2021-01-30T12:51:33.028Z",
        "RequestId": "5A14FA81-DD4E-******-6343FE44B941"
      }
    }
  ],
  "NextPageToken": 0
}

Error codes

See for a complete list.

Release notes

See Release Notes for a complete list.