All Products
Search
Document Center

Platform For AI:ListHpoTrialCommands

Last Updated:Oct 21, 2025

Queries the command output of a trial in a hyperparameter optimization (HPO) experiment. A trial of an HPO experiment runs one or more commands in sequence based on the command set specified in the configuration. You can call this API operation to obtain the output of these commands.

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:ListHpoTrialCommandslist
*All Resources
*
    none
none

Request syntax

GET /api/automl/v1/hpo/experiment/{ExpId}/trial/{TrialId}/commands HTTP/1.1

Request parameters

ParameterTypeRequiredDescriptionExample
ExperimentIdstringNo

The ID of the HPO experiment.

abcde
TrialIdstringNo

The ID of the trial.

zUEapH

Response parameters

ParameterTypeDescriptionExample
object

Schema of Response

RequestIdstring

The request ID.

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

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

INVALID_USER_OR_EXP
Messagestring

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

Missing 'user_id' in request.
AccessDeniedDetailobject

The details about the failed permission verification.

string

The details about the failed permission verification.

{ "AuthPrincipalType": "sub", "PolicyType": "AccountLevelIdentityBasedPolicy", "NoPermissionType": "NoPermission" }
Commandsarray<object>

The commands.

Commandsobject

The struct of the commands.

Idinteger

The sequence number.

1
Commandstring

The content of the command.

dlc submit pytorch --name=test_nni_foo_bar
Outputstring

The output of the command.

dlc job submitted.

Examples

Sample success responses

JSONformat

{
  "RequestId": "071A904D-5A49-597F-9F69-81C7701D04AC",
  "Code": "INVALID_USER_OR_EXP",
  "Message": "Missing 'user_id' in request.",
  "AccessDeniedDetail": {
    "key": {
      "AuthPrincipalType": "sub",
      "PolicyType": "AccountLevelIdentityBasedPolicy",
      "NoPermissionType": "NoPermission"
    }
  },
  "Commands": [
    {
      "Id": 1,
      "Command": "dlc submit pytorch --name=test_nni_foo_bar",
      "Output": "dlc job submitted."
    }
  ]
}

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