StopHpoTrials - Platform For AI - Alibaba Cloud Documentation Center

Stops specific trials in a hyperparameter optimization (HPO) experiment and the backend tasks of the trials.

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.

Debug

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.

Operation	Access level	Resource type	Condition key	Associated operation
paiautoml:StopHpoTrials	update	All Resources ``	none	none

Request syntax

POST /api/automl/v1/hpo/experiment/{ExpId}/stop_trials HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
ExperimentId	string	No	The ID of the experiment.	abcde
body	object	No	The body of the request.
TrialIds	array	No	The IDs of the trials that you want to stop. If you leave this parameter empty, no trial is stopped.
	string	No	trial id	[xrYq99, xrYq9N]

Response parameters

Parameter	Type	Description	Example
	object	Schema of Response
Code	string	The internal error code. This parameter is returned if an exception occurred.	INVALID_USER_OR_EXP
Message	string	The error message. This parameter is returned if an exception occurred.	failed to stop any trial
Results	object	The information that contains the IDs and the status of the trials.	{ 'xrYq99':'successfully stopped trial,', 'xrYq9N':'failed to stop trial,' }
RequestId	string	The ID of the POP request.	071A904D-5A49-597F-9F69-81C7701D04AC
AccessDeniedDetail	object	The details about the failed permission verification.
	string	The details about the failed permission verification.	{ "AuthPrincipalType": "sub", "PolicyType": "AccountLevelIdentityBasedPolicy", "NoPermissionType": "NoPermission" }

Examples

Sample success responses

JSONformat

{
  "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"
    }
  }
}

Error codes

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

Change history

Change time	Summary of changes	Operation
2024-10-21	The response structure of the API has changed	View Change Details