获取实验列表。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| paiexperiment:ListExperiments | list | *全部资源 * |
| 无 |
请求语法
GET /api/v1/experiments HTTP/1.1
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| Name | string | 否 | 实验名称。 | exp-test |
| WorkspaceId | string | 否 | 实验所在工作空间 ID。如何获取工作空间 ID，请参见 ListWorkspaces 。 说明
不填写工作空间 ID，系统将返回默认工作空间的实验列表。
| 1517** |
| Labels | string | 否 | 标签过滤条件，多个条件以半角逗号（,）分隔。
单个条件过滤格式为 | is_evaluation:true |
| SortBy | string | 否 | 分页查询时的排序字段。目前 GmtCreateTime 字段用于排序。 | GmtCreateTime |
| Order | string | 否 | 分页查询时，对指定的排序字段进行升序或降序。
| DESC |
| PageNumber | integer | 否 | 分页编号，从 1 开始。 | 1 |
| PageSize | integer | 否 | 分页大小。 | 10 |
| OrderBy | string | 否 | 排序方式字符串列表，支持排序的字段包括：GmtCreateTime、Name、GmtModifiedTime 或 ExperimentId。排序方式包括 DESC 和 ASC，默认为 ASC。 | GmtCreateTime DESC,Name ASC |
| PageToken | long | 否 | 分页 token，从 0 开始，默认为 0。 | 0 |
| MaxResults | long | 否 | 请求的最大结果数，默认为 10。 | 10 |
| Verbose | boolean | 否 | 是否获取于实验相关的 LatestRun 信息。 | false |
| Options | object | 否 | 可选参数。 | |
| match_name_exactly | string | 否 | 是否精确匹配名称，可以填“true“或”false“。 | true |
返回参数
示例
正常返回示例
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": "",
"SourceId": "",
"SourceType": "",
"WorkspaceId": "",
"Params": [
{
"Value": "",
"Key": ""
}
],
"Labels": [
{
"Value": "",
"RunId": "",
"GmtCreateTime": "",
"GmtModifiedTime": "",
"Key": ""
}
],
"GmtModifiedTime": "",
"Name": "",
"Metrics": [
{
"Value": 0,
"Step": 0,
"Timestamp": 0,
"Key": ""
}
],
"OwnerId": "",
"ExperimentId": "",
"UserId": "",
"RunId": "",
"GmtCreateTime": "",
"RequestId": ""
}
}
],
"NextPageToken": 0
}错误码
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 |
|---|
暂无变更历史