ListRuns API参考获取实验运行列表-人工智能平台 PAI-阿里云

获取Run列表。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

当前API暂无授权信息透出。

请求语法

GET /api/v1/runs HTTP/1.1

请求参数

名称	类型	必填	描述	示例值
Name	string	否	运行名称。	myName
WorkspaceId	string	否	实验所在工作空间 ID。如何获取工作空间 ID，请参见 ListWorkspaces 。说明不填写工作空间 ID，系统将返回默认工作空间的运行列表。	228**
ExperimentId	string	否	Run 所属实验 ID。	exp-1zpfthdx******
SourceType	string	否	Run 关联的 PAI Workload 类型。	TrainingService
SourceId	string	否	Run 关联的 PAI Workload ID。	job-rbvg5wzlj****
Labels	string	否	任务的标签，精确匹配。支持：单标签查询："is_evaluation:true" 多标签场景（非特殊场景不推荐，可能存在性能问题）："is_evaluation:true,LLM_evaluation:true" 使用半角逗号（,）分隔，表示多个标签 key-value 需要同时匹配。	is_evaluation:true
Verbose	boolean	否	是否展示详细信息，包括：Metrics、Params 和 Labels。取值如下： true：表示展示详细信息。 false（默认值）：表示不展示详细信息。	true
GmtCreateTime	string	否	实例创建时间。	2021-01-30T12:51:33.028Z
OrderBy	string	否	排序方式的字符串列表，支持排序的字段包括：GmtCreateTime、Name。排序方式包括 DESC 和 ASC，默认为 ASC。支持多个字段，用半角逗号","分隔。	GmtCreateTime DESC,Name ASC
PageToken	integer	否	分页 token，从 0 开始，默认为 0。	0
MaxResults	integer	否	请求的最大结果数，默认为 10。	10
PageNumber	integer	否	当前页数。取值范围：大于 0。默认值：1。	1
PageSize	integer	否	每页显示的记录数。	10
SortBy	string	否	用于排序的字段名，取值如下： Name：Run 名称。 GmtCreateTime（默认值）：Run 创建时间。	GmtCreateTime
Order	string	否	分页查询时，对指定的排序字段进行升序或降序，与 SortBy 结合使用。 ASC：升序。 DESC（默认值）：降序。	DESC

返回参数

名称	类型	描述	示例值
	object	返回结果。
requestId	string	请求 ID。	ADF6D849-*****-7E7030F0CE53
Runs	array	任务列表。
	Run	运行实例详情。
TotalCount	integer	TotalCount 本次请求条件下的数据总量，此参数为可选参数，默认可不返回。	1
NextPageToken	integer	分页 token，首页查询时传空，查询结果中返回下一页 token 地址。当结果 token 为 0 时表示全部查完。可通过查询结果中的 NextPageToken 字段获取下一页 token。	0

示例

正常返回示例

JSON格式

{
  "requestId": "ADF6D849-*****-7E7030F0CE53",
  "Runs": [
    {
      "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"
    }
  ],
  "TotalCount": 1,
  "NextPageToken": 0
}

错误码

访问错误中心查看更多错误码。

变更历史

更多信息，参考变更详情。