ListHpoExperimentLogs - Platform For AI - Alibaba Cloud Documentation Center

Queries the content of a log file for a hyperparameter optimization (HPO) experiment.

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:ListHpoExperimentLogs	none	*HpoExperiment `acs:paiautoml:{#regionId}:{#accountId}:hpoexperiment/{#HpoExperimentId}`	none	none

Request syntax

GET /api/automl/v1/hpo/experiment/{ExperimentId}/logs HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
ExperimentId	string	No	The ID of the HPO experiment.	abcde
LogName	string	No	The name of the log. Valid values: nnimanager.log and dispatcher.log.	nnimanager.log
PageNumber	integer	No	The page number. Page start from page 1. If you leave this parameter empty, all content in the log file is returned.	1
PageSize	integer	No	The number of entries per page. If you leave this parameter empty, all content in the log file is returned.	40

Response parameters

Parameter	Type	Description	Example
	object	Schema of Response
RequestId	string	The request ID.	071A904D-5A49-597F-9F69-81C7701D04AC
Code	string	The status code.	SUCCESS
Message	string	The error message. This parameter is returned if an exception occurred.	Missing 'user_id' in request.
AccessDeniedDetail	object	The details about the access denial.	{ "AuthPrincipalType": "sub", "PolicyType": "AccountLevelIdentityBasedPolicy", "NoPermissionType": "NoPermission" }
TotalCount	integer	The total number of entries returned.	467
Logs	array	The content of the log entry.
Logs	string	The content of the log entry.	[2024-03-07 18:29:29] INFO (LocalTrainingService) Run local machine training service.

Examples

Sample success responses

JSONformat

{
  "RequestId": "071A904D-5A49-597F-9F69-81C7701D04AC",
  "Code": "SUCCESS",
  "Message": "Missing 'user_id' in request.",
  "AccessDeniedDetail": {
    "AuthPrincipalType": "sub",
    "PolicyType": "AccountLevelIdentityBasedPolicy",
    "NoPermissionType": "NoPermission"
  },
  "TotalCount": 467,
  "Logs": [
    "[2024-03-07 18:29:29] INFO (LocalTrainingService) Run local machine training service."
  ]
}

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