API overview

更新时间:
复制 MD 格式

API standard and pre-built SDKs in multi-language

The OpenAPI specification of this product (EHPC/2024-07-30) follows the RPC 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.

API list

API

Title

Description

AttachNodes AttachNodes Adds Elastic Compute Service (ECS) instances as compute nodes to Elastic High Performance Computing (E-HPC) clusters.
AttachSharedStorages AttachSharedStorages Attaches shared storage to an Elastic High Performance Computing (E-HPC) cluster.
CreateCluster CreateCluster Creates a pay-as-you-go or subscription Elastic High Performance Computing (E-HPC) cluster.
CreateJob CreateJob Creates a job for a cluster.
CreateNodes CreateNodes Creates a batch of compute nodes for an E-HPC cluster.
CreateQueue CreateQueue Creates a queue for an Enterprise High Performance Computing (E-HPC) cluster.
CreateReservedNodePool CreateReservedNodePool Creates a reserved node pool. A reserved node pool preempts IP addresses provided in a vSwitch and maps them one by one to host names that are generated based on rules. Resources are also maintained based on the mapping table. When you use a reserved node pool to scale out or scale in nodes, the resources in the node pool are occupied or released accordingly.
CreateUsers CreateUsers Adds users to an Elastic High Performance Computing (E-HPC) cluster.
DeleteCluster DeleteCluster Releases an Enterprise High Performance Computing (E-HPC) cluster.
DeleteNodes DeleteNodes Deletes compute nodes from an Enterprise High Performance Computing (E-HPC) cluster at a time.
DeleteQueues DeleteQueues Deletes queues from an Enterprise High Performance Computing (E-HPC) cluster.
DeleteReservedNodePool DeleteReservedNodePool Deletes a reserved node pool.
DeleteUsers DeleteUsers Deletes users from a cluster.
DescribeAddonTemplate DescribeAddonTemplate Queries the details of an addon template.
DetachSharedStorages DetachSharedStorages Unmounts shared storage from the mount directory of a cluster.
GetAddon GetAddon Queries the details of an installed addon.
GetCluster GetCluster Queries information about an Elastic High Performance Computing (E-HPC) cluster.
GetCommonLogDetail GetCommonLogDetail Query logs based on a request ID. Logs for specific actions can be queried thanks to an Action-Stage-Method three-layer log splitting structure.
GetJob GetJob Obtains the details of a job.
GetJobLog GetJobLog Queries the output logs of a job, including standard output logs and error output logs.
GetQueue GetQueue Queries the details of a queue in an Elastic High Performance Computing (E-HPC) cluster.
InstallAddon InstallAddon Installs an addon.
InstallSoftwares InstallSoftwares Install software for the specified cluster.
ListAddonTemplates ListAddonTemplates Queries supported addon templates.
ListAddons ListAddons Queries installed addons of an Elastic High Performance Computing (E-HPC) cluster.
ListAvailableFileSystems ListAvailableFileSystems Queries the file systems that can be attached in a region.
ListAvailableImages ListAvailableImages Queries images that are available for Elastic High Performance Computing (E-HPC) clusters.
ListClusters ListClusters Queries all clusters of a user in each region.
ListCommonLogs ListCommonLogs Queries the logs of a cluster that are generated within a time range.
ListInstalledSoftwares ListInstalledSoftwares Queries the installed software of a cluster.
ListJobs ListJobs Queries the jobs in a cluster.
ListNodes ListNodes Queries the nodes of an Elastic High Performance Computing (E-HPC) cluster.
ListQueues ListQueues Queries queues in an Elastic High Performance Computing (E-HPC) cluster.
ListRegions ListRegions Queries the available regions for the product.
ListSharedStorages ListSharedStorages Queries the shared storage that is attached to a cluster.
ListSoftwares ListSoftwares Queries the software that can be installed in an Elastic High Performance Computing (E-HPC) cluster.
ListUsers ListUsers Queries the users of a cluster.
StopJobs StopJobs Stops uncompleted jobs in a batch in an Elastic High Performance Computing (E-HPC) cluster.
UnInstallAddon UnInstallAddon Uninstalls an addon.
UninstallSoftwares UninstallSoftwares Uninstalls software systems from an Enterprise High Performance Computing (E-HPC) cluster.
UpdateCluster UpdateCluster Modify the basic information of a specified cluster.
UpdateNodes UpdateNodes Updates the configurations of compute nodes in an Enterprise High Performance Computing (E-HPC) cluster.
UpdateQueue UpdateQueue Modifies the configurations of a queue in an Elastic High Performance Computing (E-HPC) cluster.
UpdateUser UpdateUser Updates the information of a user in an Elastic High Performance Computing (E-HPC) cluster, including the user group and password.