API overview-Platform For AI(PAI)-阿里云帮助中心

API standard and pre-built SDKs in multi-language

The OpenAPI specification of this product (PaiStudio/2022-01-12) follows the ROA standard. Alibaba Cloud provides pre-built SDKs for popular programming languages to abstract low-level complexities such as request signing. This enables developers to call APIs using language-specific syntax without dealing with HTTP details directly.

Custom signature

If your specific needs, such as a customized signature, are not supported by the SDK, manually sign requests using the signature mechanism. Note that manual signing requires significant effort (usually about 5 business days). For support, join our DingTalk group (ID: 147535001692).

Before you begin

An Alibaba Cloud account has full administrative privileges. A compromised AccessKey pair exposes all associated resources to unauthorized access, posing a significant security risk. To call APIs securely, create a Resource Access Management (RAM) user with API access only, configure its AccessKey pairs, and implement the principle of least privilege (PoLP) through RAM policies. Use the Alibaba Cloud account only when its permissions are explicitly required for specific scenarios.

Resource Group

API	Title	Description
UpdateResourceGroup	Update Resource Group	Use UpdateResourceGroup to update resource group information.
GetResourceGroupTotal	Obtain the total number of resources in a resource group	You can use GetResourceGroupTotal to obtain the total number of resources in a resource group.
ListResourceGroups	Obtain a List of Resource Groups	Retrieves a list of resource groups for general-purpose computing resources or Lingjun intelligent computing resources.
GetResourceGroupRequest	Obtain the resources that have been assigned to a resource group	You can use GetResourceGroupRequest to obtain the number of resources that have been assigned to a resource group.
DeleteResourceGroupMachineGroup	DeleteResourceGroupMachineGroup	Deletes the specified machine group from a resource group.
GetNodeMetrics	Obtain metric data by edge zone dimension	You can use GetNodeMetrics to obtain metric information for resource group edge zones.
ListResourceGroupMachineGroups	Obtain the list of machine groups	Retrieves a list of machine groups in a specified resource group.
GetUserViewMetrics	Obtain metrics by user dimension	You can use GetUserViewMetrics to obtain metric data by user dimension.
GetResourceGroupMachineGroup	Get Machine Group Details	Call GetResourceGroupMachineGroup to retrieve the details of a machine group.
GetResourceGroup	Get resource group details	`GetResourceGroup` retrieves details for a resource group.
CreateResourceGroup	Create Resource Group	Use the CreateResourceGroup operation to create a resource group.
DeleteResourceGroup	Delete resource group	Deletes a resource group.

Training algorithm

API	Title	Description
CreateAlgorithm	Create algorithm	Creates an algorithm.
CreateAlgorithmVersion	Create an algorithm version	Creates a version of an algorithm.
DeleteAlgorithm	Delete an algorithm	Deletes an algorithm.
DeleteAlgorithmVersion	Delete an algorithm version	Deletes an algorithm version.
GetAlgorithm	Retrieve algorithm details	Retrieves algorithm details.
GetAlgorithmVersion	Obtain algorithm version details	Retrieve details about an algorithm version.
ListAlgorithms	Retrieve the algorithm details list	Lists algorithm details.
ListAlgorithmVersions	Retrieve the list of algorithm version details	Retrieve a list of algorithm version details.
UpdateAlgorithm	Update algorithm	Updates an algorithm.
UpdateAlgorithmVersion	Update Algorithm Version	Updates an algorithm version.

Training job

API	Title	Description
CreateTrainingJob	Create a training job	Create a training job.
CreateInstanceWebTerminal	Create a link to access the instance container	You can create a link to access the container of the instance.
CheckInstanceWebTerminal	Validate the link to access the instance container.	Checks the connection to the instance container.
DeleteTrainingJob	Delete Training Job	Deletes a training task.
DeleteTrainingJobLabels	Delete training job labels	Deletes the labels of a training task.
GetToken	Obtain a sharing token for a training job	Obtains a share token for a training task.
GetTrainingJob	Get training job details	Get training job details.
GetTrainingJobErrorInfo	Retrieve the error information of a training job	Retrieve error information for a training task.
GetTrainingJobLatestMetrics	Retrieve the latest metrics of a training job	Retrieves the latest metrics for a training task.
ListTrainingJobs	Retrieve the training job list	List training jobs.
ListTrainingJobEvents	Retrieve Training Job Events	Retrieve events for a specific training task to gain detailed insight into the training process.
ListTrainingJobInstanceEvents	Retrieve Management Events for a Training Job Instance	Retrieve events for a training job instance.
ListTrainingJobInstanceMetrics	Obtain monitoring metrics of a training job instance	Retrieve monitoring metrics for training job instances.
ListTrainingJobLogs	Retrieve logs of a training job	Retrieves the logs for a training task.
ListTrainingJobMetrics	Obtain training job metrics	Retrieve monitoring data for a training task.
ListTrainingJobOutputModels	Retrieve models produced by a training job	Retrieves information about the output models of a training job.
StopTrainingJob	Stop Training Job	Stops a training task.
UpdateTrainingJobLabels	Update Training Job Labels	Updates the labels of a training task.

Resource quota

API	Title	Description
CreateQuota	Create Resource Quota	Creates a quota.
ListQuotas	Obtain Resource Quota List	Lists quotas.
GetQuota	Get Resource Quota Details	Call GetQuota to retrieve the details of a resource quota. This helps you monitor current resource usage for effective resource management and planning.
UpdateQuota	Update Resource Quota Configuration	Updates the configuration of a resource quota.
ScaleQuota	Scale Out or Scale In Resource Quota	Use ScaleQuota to scale resource quotas.
DeleteQuota	Delete resource quota	You can delete a resource quota by using DeleteQuota.
ListQuotaWorkloads	Obtain the job list on a resource quota	Retrieves a list of workloads associated with a specific quota.
ListQuotaActiveUserUsages	ListQuotaActiveUserUsages	Lists users within a quota and their resource usage.

Other

API	Title	Description
ListNodes	Retrieve Node List	Returns a list of resource nodes.
GetSpotPriceHistory	Retrieve spot instance historical prices	Retrieves the historical prices of spot instances.
OperateNode	Operate Edge Zone	Use OperateNode to manage nodes.

Others

API	Title	Description
DeleteMachineGroup	DeleteMachineGroup	Deletes a machine group.
GetMachineGroup	GetMachineGroup	Retrieves the details of a specific machine group.
ListTagResources	Query tag list	Tag query API.
TagResources	Create and attach tags to a specified list of resources uniformly	Attaches tags to resources.
UntagResources	Detach tags from the specified resource list in a unified manner	Detach tags from a list of specified resources. If a tag is no longer attached to any resource after detachment, Alibaba Cloud deletes it automatically.