ListExperiment - 获取实验列表

更新时间:2025-04-28 03:01:40

获取实验列表。

调试

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

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用前面加 * 表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
操作访问级别资源类型条件关键字关联操作
paiexperiment:ListExperimentslist
*全部资源
*

请求语法

GET /api/v1/experiments HTTP/1.1

请求参数

名称类型必填描述示例值
名称类型必填描述示例值
Namestring

实验名称。

exp-test
WorkspaceIdstring

实验所在工作空间 ID。如何获取工作空间 ID,请参见 ListWorkspaces

说明
不填写工作空间 ID,系统将返回默认工作空间的实验列表。
1517**
Labelsstring

标签过滤条件,多个条件以半角逗号(,)分隔。 单个条件过滤格式为Key=Value

is_evaluation:true
SortBystring

分页查询时的排序字段。目前 GmtCreateTime 字段用于排序。

GmtCreateTime
Orderstring

分页查询时,对指定的排序字段进行升序或降序。

  • ASC:升序。
  • DESC(默认):降序。
DESC
PageNumberinteger

分页编号,从 1 开始。

1
PageSizeinteger

分页大小。

10
OrderBystring

排序方式字符串列表,支持排序的字段包括:GmtCreateTime、Name、GmtModifiedTime 或 ExperimentId。排序方式包括 DESC 和 ASC,默认为 ASC。

GmtCreateTime DESC,Name ASC
PageTokenlong

分页 token,从 0 开始,默认为 0。

0
MaxResultslong

请求的最大结果数,默认为 10。

10
Verboseboolean

是否获取于实验相关的 LatestRun 信息。

false
Optionsobject

可选参数。

match_name_exactlystring

是否精确匹配名称,可以填“true“或”false“。

true

返回参数

名称类型描述示例值
名称类型描述示例值
object

Schema of Response

requestIdstring

请求 ID。

0C6835C5-A424-5AFB-ACC2-F1E3CA1ABF7C
TotalCountlong

记录总数

5
Experimentsarray

实验列表。

ExperimentsExperiment

实验详情。

NextPageTokenlong

下一页标识。需记录下来,在下一次请求时传入即可。

0

示例

正常返回示例

JSON格式

{
  "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
}

错误码

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

变更历史

变更时间变更内容概要操作
变更时间变更内容概要操作
暂无变更历史
  • 本页导读 (1)
  • 调试
  • 授权信息
  • 请求语法
  • 请求参数
  • 返回参数
  • 示例
  • 错误码
  • 变更历史
AI助理

点击开启售前

在线咨询服务

你好,我是AI助理

可以解答问题、推荐解决方案等