StopHpoExperiment - 停止一个指定的HPO实验

完全停止一个指定的AutoML HPO实验,包括停止该实验所属的trials,和这些trials所依赖的后台任务。

调试

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

授权信息

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

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

请求语法

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

请求参数

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

需要被停止的实验的 id。

abcde

返回参数

名称类型描述示例值
object

Schema of Response

ExpIdstring

实验 id。

abcde
Codestring

内部错误码。只在响应出错时被设置。

INVALID_INPUT_PARAMS
Messagestring

响应错误信息。只在响应出错时被设置。

Missing 'user_id' in request.
RequestIdstring

POP 的请求 id

071A904D-5A49-597F-9F69-81C7701D04AC
AccessDeniedDetailobject

权限校验失败详情

string

权限校验失败详情

{ "AuthPrincipalType": "sub", "PolicyType": "AccountLevelIdentityBasedPolicy", "NoPermissionType": "NoPermission" }
Statusstring

实验运行状态

TERMINATING, USER_CANCELED

示例

正常返回示例

JSON格式

{
  "ExpId": "abcde",
  "Code": "INVALID_INPUT_PARAMS",
  "Message": "Missing 'user_id' in request.",
  "RequestId": "071A904D-5A49-597F-9F69-81C7701D04AC",
  "AccessDeniedDetail": {
    "key": {
      "AuthPrincipalType": "sub",
      "PolicyType": "AccountLevelIdentityBasedPolicy",
      "NoPermissionType": "NoPermission"
    }
  },
  "Status": "TERMINATING, USER_CANCELED"
}

错误码

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

变更历史

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