ListHpoTrials - 获取一个HPO实验里的多个trials信息_人工智能平台 PAI(PAI)-阿里云帮助中心

返回指定实验id的trial

调试

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

授权信息

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

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

操作	访问级别	资源类型	条件关键字	关联操作
paiautoml:ListHpoTrials	list	*HpoExperiment `acs:paiautoml:{#regionId}:{#accountId}:hpoexperiment/{#HpoExperimentId}`	无	无

请求语法

GET /api/automl/v1/hpo/experiment/{ExperimentId}/trials HTTP/1.1

请求参数

名称	类型	必填	描述	示例值
ExperimentId	string	否	HPO 实验 id	abcde
PageNumber	integer	否	1-based 结果页面序号。做为搜索实验的限制条件。	1
PageSize	integer	否	当前查询的页大小（每页上显示的 trials 的个数）	10
SortBy	string	否	排序依据	FINAL_METRIC 或着 CREATE_TIME
Order	string	否	分页查询时，对指定的排序字段进行升序或降序。默认 ASC。 ASC 升序 DESC 降序	ASC

返回参数

名称	类型	描述	示例值
	object	Schema of Response
RequestId	string	POP 的请求 id	3F190916-B3E5-5D1E-AD0C-35C0DF105F51
Code	string	内部错误码。只在响应出错时被设置。	INVALID_USER_OR_EXP
Message	string	响应错误信息。只在响应出错时被设置。	Missing 'user_id' in request.
TotalCount	integer	TotalCount 本次请求条件下的数据总量，此参数为可选参数，默认可不返回	5
Trials	array<object>	trial 数据结构体列表
Trials	object	Trial 结构体
TrialId	string	trial 的 id	asdf
ExperimentId	string	HPO 实验 id	abcde
ParameterId	integer	trail 所对应的后台任务给这个 trial 分配的一个 id	未使用。空字符串
Hyperparam	string	trial 配置的超参(hyper parameter)值	{"${centerCount}": 5, "${distanceType}": "cityblock"}
Status	string	Trial 状态	UNKNOWN, RUNNING, WAITING, EARLY_STOPPED, SUCCEEDED, FAILED, USER_CANCELED, SYS_CANCELED
Model	string	这个 Trial 所对应的后台任务生成的模型的存储位置。	pai_kmeans_test_output_model_sy9zkpvc_zleam
MetricName	string	未填充。不在使用中。	空字符串
Metric	string	trial 计算 metric 的结果数组。包括一个或多个计算过程中产生的临时值，和一个最终值。	[{"default":9999.2,"type":"PERIODICAL","vrc":9999.2}, {"default":9999.2,"type":"FINAL","vrc":9999.2}
JobMeta	string	trial 所对应的后台任务的 meta 信息。json string 格式。	{"nni_trial_id": "ZLeAM", "nni_exp_id": "sy9zkpvc", "nni_trial_sequence_id": 0}
FinalMetric	string	trial 成功结束后，后台任务计算出的最终的 metric 值。来自 metric 数组里的 FINAL 类型的 metric 项里的 default key 所对应的值。	9999.2
GmtCreateTime	string	Trial 创建时间 UTC time。	2023-06-07T13:17:13Z
GmtModifiedTime	string	Trial 最后更新时间 UTC time	2023-02-27T07:01:12Z
AccessDeniedDetail	object	访问被拒绝详细信息；只有 Ram 校验失败才会返回此字段
	string	访问被拒绝详细信息。	{ "AuthPrincipalType": "sub", "PolicyType": "AccountLevelIdentityBasedPolicy", "NoPermissionType": "NoPermission" }

示例

正常返回示例

JSON格式

{
  "RequestId": "3F190916-B3E5-5D1E-AD0C-35C0DF105F51",
  "Code": "INVALID_USER_OR_EXP",
  "Message": "Missing 'user_id' in request.",
  "TotalCount": 5,
  "Trials": [
    {
      "TrialId": "asdf",
      "ExperimentId": "abcde",
      "ParameterId": 0,
      "Hyperparam": {
        "${centerCount}": 5,
        "${distanceType}": "cityblock"
      },
      "Status": "UNKNOWN, RUNNING, WAITING, EARLY_STOPPED, SUCCEEDED, FAILED, USER_CANCELED, SYS_CANCELED",
      "Model": " pai_kmeans_test_output_model_sy9zkpvc_zleam",
      "MetricName": "空字符串",
      "Metric": "[{\"default\":9999.2,\"type\":\"PERIODICAL\",\"vrc\":9999.2}, {\"default\":9999.2,\"type\":\"FINAL\",\"vrc\":9999.2}",
      "JobMeta": {
        "nni_trial_id": "ZLeAM",
        "nni_exp_id": "sy9zkpvc",
        "nni_trial_sequence_id": 0
      },
      "FinalMetric": 9999.2,
      "GmtCreateTime": "2023-06-07T13:17:13Z",
      "GmtModifiedTime": "2023-02-27T07:01:12Z"
    }
  ],
  "AccessDeniedDetail": {
    "key": {
      "AuthPrincipalType": "sub",
      "PolicyType": "AccountLevelIdentityBasedPolicy",
      "NoPermissionType": "NoPermission"
    }
  }
}

错误码

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

变更历史

变更时间	变更内容概要	操作
2024-10-21	OpenAPI 返回结构发生变更	查看变更详情
2024-07-26	API 内部配置变更，不影响调用	查看变更详情