调用ListHpoExperiments API查询HPO实验列表-人工智能平台 PAI-阿里云

查询符合条件的HPO实验信息。

调试

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

授权信息

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

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

操作	访问级别	资源类型	条件关键字	关联操作
paiautoml:ListHpoExperiments	list	全部资源 ``	无	无

请求语法

GET /api/automl/v1/hpo/experiments HTTP/1.1

请求参数

名称	类型	必填	描述	示例值
Name	string	否	实验名称关键字	任意关键字
Creator	string	否	实验创建人的 UserId	266977839132045194
PageNumber	integer	否	页码。起始值：1。默认值：1。	1
PageSize	integer	否	分页大小。	10
MinCreateTime	string	否	最早的实验创建时间	yyyy-mm-dd hh:mm:ss或着yyyy-mm-dd，比如2023-03-31 10:29:30
MaxCreateTime	string	否	最晚的实验创建时间	yyyy-mm-dd hh:mm:ss或着yyyy-mm-dd，比如2023-03-31 10:29:30
Status	string	否	实验状态	CREATED, RUNNING, FINISHED, FAILED, EARLY_STOPPED, USER_CANCELED, SYS_CANCELED, WAITING, NO_MORE_TRIAL, UNKNOWN
WorkspaceId	string	否	工作空间 ID。	default
Accessibility	string	否	工作空间可见性，可能值为： PRIVATE：在此工作空间中，仅对您和管理员可见。 PUBLIC：在此工作空间中，对所有人可见。	PRIVATE
IncludeConfigData	string	否	响应里是否包括实验配置数据	True或者False，默认False表示不包括
SortBy	string	否	查询结果排序依据	create_time, update_time, workspace_id, status, accessibility其中之一
Order	string	否	排序顺序，取值如下，与 SortBy 一起使用。 DESC（默认值）：降序排列。 ASC：升序排列。	DESC或ASC
Tag	array<object>	否	资源标签。
	object	否	标签列表。查询的过滤条件。最多可以指定 20 个标签。
Key	string	否	资源的标签键。	group
Value	string	否	标签值。一个标签值最多支持输入 128 个字符，不能以`aliyun`和`acs:`开头，不能包含`http://`或者`https://`。一次最多支持输入 20 个标签的标签值。	group_name

返回参数

名称	类型	描述	示例值
	object	Schema of Response
RequestId	string	POP 的请求 id	3F190916-B3E5-5D1E-AD0C-35C0DF105F51
Code	string	内部错误码。只在响应出错时被设置。	INVALID_INPUT_PARAMS
Message	string	响应错误信息。只在响应出错时被设置	Missing 'user_id' in request.
AccessDeniedDetail	object	访问被拒绝详细信息。
	string	访问被拒绝详细信息。	{ "AuthPrincipalType": "sub", "PolicyType": "AccountLevelIdentityBasedPolicy", "NoPermissionType": "NoPermission" }
TotalCount	integer	查询到的实验总数。	5
Experiments	array<object>	符合搜索条件的实验列表。
experiments	object	实验数据结构体
ExperimentId	string	实验 id。	sORVEck
Creator	string	实验创建者的 id。	1049310008714189
SearchSpace	string	实验配置里的 SearchSpace 属性。	{'foo':'bar'}
Name	string	实验名称。	my experiment x
Status	string	实验状态。	CREATED, RUNNING, FINISHED, FAILED, EARLY_STOPPED, USER_CANCELED, WAITING, NO_MORE_TRIAL, UNKNOWN
JobType	string	实验类型。对于 HPO 实验，类型值始终是 1.	1
ConfigIni	string	trial.ini 配置内容。其中 ak/sk 等敏感数据如果存在，则会被 API 用星号替换实际数据内容。	[odps_config] key1 = value1 key2 = value2
ConfigYml	string	exp.yml 配置内容	experimentName: dlc_oss_mnist experimentWorkingDirectory: ../expdir searchSpaceFile: search_space.json trialCommand: python3 -m hpo_tools.core.utils.run --config=./trial.ini trialConcurrency: 1 maxTrialNumber: 4 tuner: name: TPE classArgs: optimize_mode: maximize trainingService: platform: local assessor: name: PAIAssessor classArgs: optimize_mode: maximize start_step: 2
GmtCreateTime	string	实验创建时间。	2023-03-31T10:29:30Z
GmtModifiedTime	string	实验数据最近更新时间。	2022-10-27T00:55:54Z
WorkspaceId	string	工作空间 id	default
Accessibility	string	工作空间可见度。支持以下取值： PRIVATE（默认值）：表示工作空间内自己以及管理员可见。 PUBLIC 为：工作空间所有用户可见。	PUBLIC
Description	string	实验描述信息	description
TrialCount	integer	该实验总的 trial 数量	20
TrialStatus	object	trial 状态和处于各个状态的 trial 的数量的 map
	string	FINISHED	3
Deleted	boolean	是否已经被删除	1
Tags	array<object>	标签体系列表
tags	object	标签列表
Key	string	资源的标签键	group
Value	string	标签值。	group_name

示例

正常返回示例

JSON格式

{
  "RequestId": "3F190916-B3E5-5D1E-AD0C-35C0DF105F51",
  "Code": "INVALID_INPUT_PARAMS",
  "Message": "Missing 'user_id' in request.",
  "AccessDeniedDetail": {
    "key": {
      "AuthPrincipalType": "sub",
      "PolicyType": "AccountLevelIdentityBasedPolicy",
      "NoPermissionType": "NoPermission"
    }
  },
  "TotalCount": 5,
  "Experiments": [
    {
      "ExperimentId": "sORVEck",
      "Creator": 1049310008714189,
      "SearchSpace": "{'foo':'bar'}",
      "Name": "my experiment x",
      "Status": "CREATED, RUNNING, FINISHED, FAILED, EARLY_STOPPED, USER_CANCELED, WAITING, NO_MORE_TRIAL, UNKNOWN",
      "JobType": 1,
      "ConfigIni": "[odps_config]\nkey1 = value1\nkey2 = value2",
      "ConfigYml": "experimentName: dlc_oss_mnist\nexperimentWorkingDirectory: ../expdir\nsearchSpaceFile: search_space.json\ntrialCommand: python3 -m hpo_tools.core.utils.run --config=./trial.ini\ntrialConcurrency: 1\nmaxTrialNumber: 4\ntuner:\n  name: TPE\n  classArgs:\n    optimize_mode: maximize\ntrainingService:\n  platform: local\nassessor:\n  name: PAIAssessor\n  classArgs:\n    optimize_mode: maximize\n    start_step: 2",
      "GmtCreateTime": "2023-03-31T10:29:30Z",
      "GmtModifiedTime": "2022-10-27T00:55:54Z",
      "WorkspaceId": "default",
      "Accessibility": "PUBLIC",
      "Description": "description",
      "TrialCount": 20,
      "TrialStatus": {
        "key": 3
      },
      "Deleted": true,
      "Tags": [
        {
          "Key": "group",
          "Value": "group_name"
        }
      ]
    }
  ]
}

错误码

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

变更历史

变更时间	变更内容概要	操作
2024-10-21	OpenAPI 返回结构发生变更	查看变更详情