All Products
Search
Document Center

Platform For AI:StopHpoExperiment

Last Updated:Oct 21, 2025
This topic is generated by a machine translation engine without any human intervention. ALIBABA CLOUD DOES NOT GUARANTEE THE ACCURACY OF MACHINE TRANSLATED CONTENT. To request a human-translated version of this topic or provide feedback on this translation, please include it in the feedback form.

Stops a hyperparameter optimization (HPO) experiment, including its trials and the backend tasks.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • For mandatory resource types, indicate with a prefix of * .
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
paiautoml:StopHpoExperimentupdate
*All Resources
*
    none
none

Request syntax

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

Request parameters

ParameterTypeRequiredDescriptionExample
ExperimentIdstringYes

The ID of the experiment that you want to stop.

abcde

Response parameters

ParameterTypeDescriptionExample
object

Schema of Response

ExpIdstring

The ID of the experiment.

sHpITOH
Codestring

The internal error code. This parameter is returned if an exception occurred.

INVALID_INPUT_PARAMS
Messagestring

The error message. This parameter is returned if an exception occurred.

Missing 'user_id' in request.
RequestIdstring

The request ID.

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

The details about the access denial.

string

The details about the access denial.

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

Current expriment status.

TERMINATING, USER_CANCELED

Examples

Sample success responses

JSONformat

{
  "ExpId": "sHpITOH",
  "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"
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
2024-10-21The response structure of the API has changedView Change Details
2024-08-08The response structure of the API has changedView Change Details