API standard and pre-built SDKs in multi-language
The OpenAPI specification of this product (EHPC/2018-04-12) 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.
Hybrid cloud clusters
|
API |
Title |
Description |
| AddLocalNodes | AddLocalNodes | Adds local compute nodes to a hybrid cloud cluster or a cloud cluster. |
ECS instances
|
API |
Title |
Description |
| ListAvailableEcsTypes | ListAvailableEcsTypes | You can call ListAvailableEcsTypes to query available ECS instance types. |
Nodes
|
API |
Title |
Description |
| StartNodes | StartNodes | Starts one or more nodes in a cluster. |
| StopNodes | StopNodes | Stops one or more nodes in a cluster. |
| ResetNodes | ResetNodes | You can call ResetNodes to reset one or more compute nodes. |
| DeleteNodes | DeleteNodes | Deletes one or more compute nodes from a specified cluster. |
Queues
|
API |
Title |
Description |
| SetQueue | SetQueue | You can call SetQueue to move compute nodes to a specified queue. |
Report
|
API |
Title |
Description |
| GetAccountingReport | GetAccountingReport | Obtains the resource report for a specified cluster. |
Service pack
|
API |
Title |
Description |
| QueryServicePackAndPrice | QueryServicePackAndPrice | Call the QueryServicePackAndPrice operation to query information about purchased service packs, the current pay-as-you-go billing status, and the total number of cores in a cluster. |
Others
|
API |
Title |
Description |
| AddExistedNodes | AddExistedNodes | Adds one or more existing ECS instances as compute nodes to a specified cluster. |
| AddNodes | AddNodes | Adds one or more compute nodes to an E-HPC cluster. |
| AddQueue | AddQueue | Creates a queue for a cluster. |
| AddSecurityGroup | AddSecurityGroup | Adds a cluster to a security group. |
| AddUsers | AddUsers | Adds users to a cluster. |
| ApplyNodes | ApplyNodes | Adds pay-as-you-go or preemptible compute nodes to a cluster. |
| CreateCluster | CreateCluster | Creates a pay-as-you-go or subscription E-HPC cluster. |
| CreateHybridCluster | CreateHybridCluster | Creates a hybrid cloud cluster. |
| CreateJobFile | CreateJobFile | Creates a job file. |
| CreateJobTemplate | CreateJobTemplate | Creates a job template. |
| DeleteCluster | DeleteCluster | Releases a cluster. |
| DeleteJobTemplates | DeleteJobTemplates | Deletes job templates. |
| DeleteJobs | DeleteJobs | Deletes jobs from a cluster. |
| DeleteQueue | DeleteQueue | Deletes a queue in a cluster. |
| DeleteSecurityGroup | DeleteSecurityGroup | Removes a cluster from a specified security group. |
| DeleteUsers | DeleteUsers | Deletes users from a cluster. |
| DescribeAutoScaleConfig | DescribeAutoScaleConfig | Queries the auto scaling settings of a cluster. |
| DescribeCluster | DescribeCluster | Queries the details of a cluster. |
| DescribeImagePrice | DescribeImagePrice | Queries the price of an Alibaba Cloud Marketplace image. |
| DescribeJob | DescribeJob | Queries the information about a job in an E-HPC cluster. |
| DescribePrice | DescribePrice | Queries the pricing information of a cluster. |
| DescribeServerlessJobs | DescribeServerlessJobs | Queries the details of a serverless job by job ID or subtask ID (array job). You can specify only a single job ID or a single subtask ID at a time. |
| EditJobTemplate | EditJobTemplate | Modifies a job template. |
| GetAutoScaleConfig | GetAutoScaleConfig | Obtains the auto scaling settings of a cluster. |
| GetCloudMetricLogs | GetCloudMetricLogs | Reads performance metrics (CloudMetrics) logs of E-HPC. |
| GetCloudMetricProfiling | GetCloudMetricProfiling | Queries the profiling result of a cluster. |
| GetClusterVolumes | GetClusterVolumes | Queries the information of the NAS file system mounted to a specified cluster. |
| GetHybridClusterConfig | GetHybridClusterConfig | Queries the configurations of a specified hybrid cloud cluster or a specified compute node. |
| GetIfEcsTypeSupportHtConfig | GetIfEcsTypeSupportHtConfig | Queries whether hyper-threading can be enabled or disabled for an instance type. |
| GetJobLog | GetJobLog | Queries the output logs of a job. |
| GetPostScripts | GetPostScripts | Queries the post-processing scripts of a cluster. |
| GetSchedulerInfo | GetSchedulerInfo | Queries the scheduler settings of a cluster. |
| GetVisualServiceStatus | GetVisualServiceStatus | Queries the status of the VNC service in a cluster. |
| InitializeEHPC | InitializeEHPC | Creates a service-linked role for Elastic High Performance Computing (E-HPC). A service-linked role is required for you to use E-HPC. |
| InstallSoftware | InstallSoftware | Installs software in a cluster. |
| InvokeShellCommand | InvokeShellCommand | Runs interactive commands in a cluster node. |
| ListCloudMetricProfilings | ListCloudMetricProfilings | Queries the profiling history of a cluster. |
| ListClusterLogs | ListClusterLogs | Queries the operation logs of a cluster within the last three days. |
| ListClusters | ListClusters | Queries all Elastic High Performance Computing (E-HPC) clusters of the current account in each region. |
| ListClustersMeta | ListClustersMeta | Queries the list of cluster metadata. |
| ListCommands | ListCommands | Queries the interactive commands in a specified cluster. |
| ListCommunityImages | ListCommunityImages | Queries a list of community images. |
| ListCpfsFileSystems | ListCpfsFileSystems | Queries the information about Cloud Paralleled File System (CPFS) and its mount targets. |
| ListCurrentClientVersion | ListCurrentClientVersion | Query the latest version number of the cluster client (ehpcutil). |
| ListCustomImages | ListCustomImages | Queries custom images and shared images supported by Elastic High Performance Computing (E-HPC). |
| ListFileSystemWithMountTargets | ListFileSystemWithMountTargets | Queries file systems and mount targets. |
| ListImages | ListImages | Queries the list of images that can be installed in a cluster. |
| ListInstalledSoftware | ListInstalledSoftware | Queries the software that is installed in a cluster. |
| ListInvocationResults | ListInvocationResults | Queries the result of an interactive command in a cluster. |
| ListInvocationStatus | ListInvocationStatus | Queries the status of an interactive command. |
| ListJobTemplates | ListJobTemplates | Queries the list of job templates. |
| ListJobs | ListJobs | Queries the list of jobs in a cluster. |
| ListJobsWithFilters | ListJobsWithFilters | Queries the details of a specified job. |
| ListNodes | ListNodes | Queries the list of nodes in a cluster. |
| ListNodesByQueue | ListNodesByQueue | Queries the node information of a single cluster within an Alibaba Cloud account by queue. |
| ListNodesNoPaging | ListNodesNoPaging | Queries the information of all nodes in a specified cluster on one page. |
| ListPreferredEcsTypes | ListPreferredEcsTypes | Queries the Elastic Compute Service (ECS) instance types recommended by Elastic High Performance Computing (E-HPC). |
| ListQueues | ListQueues | Queries the queues of a specified cluster. |
| ListRegions | ListRegions | Queries a list of regions where Elastic High Performance Computing (E-HPC) is supported. |
| ListSecurityGroups | ListSecurityGroups | Queries the security groups that are assigned to an E-HPC cluster. |
| ListServerlessJobs | ListServerlessJobs | Queries the list of serverless jobs based on filter conditions. |
| ListSoftwares | ListSoftwares | Queries the list of software that can be installed in a cluster. |
| ListTagResources | ListTagResources | Queries the tags that are attached to a specified resource. |
| ListTasks | ListTasks | Queries the response of an asynchronous API operation for a cluster. |
| ListUpgradeClients | ListUpgradeClients | Queries the latest version to which the client (ehpcutil) in a cluster can be updated and historical update records of the client. |
| ListUsers | ListUsers | Queries all users of a cluster. |
| ListUsersAsync | ListUsersAsync | Queries the users in a cluster. |
| ListVolumes | ListVolumes | Queries the file systems mounted on Elastic High Performance Computing (E-HPC) clusters. |
| ModifyClusterAttributes | ModifyClusterAttributes | Modifies the basic information of a cluster, including the name, description, and image. |
| ModifyUserGroups | ModifyUserGroups | Changes the user group to which users belong. |
| ModifyUserPasswords | ModifyUserPasswords | Changes the passwords of users. |
| ModifyVisualServicePasswd | ModifyVisualServicePasswd | Sets a password that you can use to remotely connect to a visualization service in a cluster over the virtual network console (VNC). |
| RecoverCluster | RecoverCluster | Resets and restores a cluster. |
| RerunJobs | RerunJobs | Reruns one or more jobs. |
| RunCloudMetricProfiling | RunCloudMetricProfiling | Starts the profiling process of a cluster. |
| SetAutoScaleConfig | SetAutoScaleConfig | Configures the auto scaling settings of a cluster. |
| SetPostScripts | SetPostScripts | Configures the post-processing scripts of a cluster. |
| SetSchedulerInfo | SetSchedulerInfo | Configures the scheduler settings of a cluster. |
| StartCluster | StartCluster | Starts a cluster. |
| StartVisualService | StartVisualService | Starts the Virtual Network Console (VNC) Remote visualization service in a specified cluster. |
| StopCluster | StopCluster | Stops a cluster. |
| StopJobs | StopJobs | Stops one or more jobs in a cluster. |
| StopServerlessJobs | StopServerlessJobs | Stops Serverless jobs in a cluster based on job IDs or subtask IDs (array jobs). If you specify the job ID of an array job, all subtasks in the job are stopped. |
| StopVisualService | StopVisualService | Stops the remote visualization service of Virtual Network Console (VNC) in a cluster. |
| SubmitJob | SubmitJob | Submits a job in a cluster. |
| SubmitServerlessJob | SubmitServerlessJob | Submits a serverless job to an Elastic High Performance Computing (E-HPC) cluster. |
| SyncUsers | SyncUsers | Synchronizes local cluster users to a hybrid cloud cluster in hybrid-cloud proxy mode. |
| TagResources | TagResources | Creates tags and attach the tags to a specified resource. |
| UnTagResources | UnTagResources | Removes tags from a specified resource. |
| UninstallSoftware | UninstallSoftware | Uninstalls software from a cluster. |
| UpdateClusterVolumes | UpdateClusterVolumes | Mount new storage resources to a cluster. |
| UpdateQueueConfig | UpdateQueueConfig | Updates the resource group information and the instance types of compute nodes for a queue of a cluster. |
| UpgradeClient | UpgradeClient | Updates the client (ehpcutil) in a cluster to a new version. |
该文章对您有帮助吗？