CreateHpoExperiment - Platform For AI - Alibaba Cloud Documentation Center

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.

calling HPO CreateExperiment

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:CreateHpoExperiment	create	All Resources ``	none	none

Request syntax

POST /api/automl/v1/hpo/experiment HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
body	object	No	The request body.
HpoExperimentConfiguration	HpoExperimentConfig	No	The parameter struct of the HPO experiment configuration.
Name	string	No	The name of the experiment.	my experiment x
WorkspaceId	string	No	The workspace ID.	default
Description	string	No	The description of the experiment.	This is an AutoML HPO experiment.
Accessibility	string	No	The visibility of the code configuration. Valid values: PUBLIC: The configuration is public in the workspace. PRIVATE: The configuration is visible only to you and the administrator of the workspace.	PRIVATE
Tag	array<object>	No	Tag information.
	object	No	Tag information.
Key	string	No	Tag name	group
Value	string	No	Tag value	group_name

Response parameters

Parameter	Type	Description	Example
	object	The response body.
ExperimentId	string	The ID of the HPO experiment.	sORVEck
Code	string	The internal error code. This parameter is returned if an exception occurred.	INVALID_INPUT_PARAMS
Message	string	The error message. This parameter is returned if an exception occurred.	Missing 'user_id' in request.
RequestId	string	The ID of the POP request.	3F190916-B3E5-5D1E-AD0C-35C0DF105F51
AccessDeniedDetail	object	The information about the request denial.
	string	The information about the request denial..	{"AuthPrincipalType": "sub", "PolicyType": "AccountLevelIdentityBasedPolicy", "NoPermissionType": "NoPermission"}

Examples

Sample success responses

JSONformat

{
  "ExperimentId": "sORVEck",
  "Code": "INVALID_INPUT_PARAMS",
  "Message": "Missing 'user_id' in request.",
  "RequestId": "3F190916-B3E5-5D1E-AD0C-35C0DF105F51",
  "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