StopHpoTrials - 停止一个HPO实验里指定的trials_人工智能平台 PAI(PAI)-阿里云帮助中心

停止一个HPO实验里指定的trials，以及这些trials对应的后台任务。

调试

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

授权信息

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

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

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

请求语法

PUT /api/automl/v1/hpo/experiment/{ExperimentId}/stop_trials HTTP/1.1

请求参数

名称	类型	必填	描述	示例值
ExperimentId	string	否	实验 id。	abcde
body	object	否	请求 body 参数。
TrialIds	array	否	需要被停止的 trial ids。不填则不会有任何 trial 被停止。
	string	否	trial id	[xrYq99, xrYq9N]

返回参数

名称	类型	描述	示例值
	object	Schema of Response
Code	string	内部错误码。只在响应出错时被设置。	INVALID_USER_OR_EXP
Message	string	响应错误信息。只在响应出错时被设置。	failed to stop any trial
Results	object	(trial id: 停止操作结果) map。	{ 'xrYq99':'successfully stopped trial,', 'xrYq9N':'failed to stop trial,' }
RequestId	string	POP 请求 id	071A904D-5A49-597F-9F69-81C7701D04AC
AccessDeniedDetail	object	权限校验失败详情
	string	权限校验失败详情	{ "AuthPrincipalType": "sub", "PolicyType": "AccountLevelIdentityBasedPolicy", "NoPermissionType": "NoPermission" }

示例

正常返回示例

JSON格式

{
  "Code": "INVALID_USER_OR_EXP",
  "Message": "failed to stop any trial",
  "Results": {
    "test": "test",
    "test2": 1
  },
  "RequestId": "071A904D-5A49-597F-9F69-81C7701D04AC",
  "AccessDeniedDetail": {
    "key": {
      "AuthPrincipalType": "sub",
      "PolicyType": "AccountLevelIdentityBasedPolicy",
      "NoPermissionType": "NoPermission"
    }
  }
}

错误码

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

变更历史

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