All Products
Search
Document Center

Elastic High Performance Computing:List of operations by function

Last Updated:Mar 26, 2024
This product(EHPC/2018-04-12) OpenAPI adopts RPC Signature style. See signature details in Description of the signature mechanism. We have packaged SDKs for common programming languages for developers. Developers can directly call the OpenAPI of this product by downloading the SDK without paying attention to the technical details. If the existing SDK cannot meet the usage requirements, you can connect through the signature mechanism. It will take about 5 working days. Therefore, it is recommended to join our DingTalk service group (11370001915) and sign under the guidance of experts.
Before using the API, you need to prepare your identity account and access key (AccessKey) to effectively access the API through client tools (SDK, CLI, etc.). For details see getAccessKey.

Clusters

APITitleDescription
DescribePriceDescribePriceQueries the pricing information of a cluster.
CreateClusterCreateClusterCreates a pay-as-you-go or subscription E-HPC cluster.
DescribeClusterDescribeClusterQueries the details of a cluster.
ModifyClusterAttributesModifyClusterAttributesModifies the basic information of a cluster, including the name, description, and image.
ListClustersListClustersQueries the list of clusters in all regions within an account.
ListClustersMetaListClustersMetaQueries the list of cluster metadata.
StartClusterStartClusterStarts a cluster.
StopClusterStopClusterStops a cluster.
RecoverClusterRecoverClusterResets and restores a cluster.
DeleteClusterDeleteClusterReleases a cluster.

Hybrid cloud clusters

APITitleDescription
CreateHybridClusterCreateHybridClusterCreates a hybrid cloud cluster.
AddLocalNodesAddLocalNodesAdds local nodes to a specified cluster on hybrid cloud or cluster on the cloud.
GetHybridClusterConfigGetHybridClusterConfigQueries the configurations of a specified hybrid cloud cluster or a specified compute node.
SyncUsersSyncUsersSynchronizes local cluster users to a hybrid cloud cluster in hybrid-cloud proxy mode.

ECS instances

APITitleDescription
ListPreferredEcsTypesListPreferredEcsTypesQueries the Elastic Compute Service (ECS) instance types recommended by Elastic High Performance Computing (E-HPC).
ListAvailableEcsTypesListAvailableEcsTypesQueries available Elastic Compute Service (ECS) instance types.
GetIfEcsTypeSupportHtConfigGetIfEcsTypeSupportHtConfigQueries whether a specified instance type supports enabling and disabling hyper-threading.

Image

APITitleDescription
ListImagesListImagesQueries the list of images that can be installed in a cluster.
DescribeEstackImageDescribeEstackImageQueries the base images of Elastic High Performance Computing (E-HPC).
ListCustomImagesListCustomImagesQueries custom images and shared images that are supported by Elastic High Performance Computing (E-HPC).
ListCommunityImagesListCommunityImagesQueries a list of community images.
DescribeImagePriceDescribeImagePriceQueries the price of an Alibaba Cloud Marketplace image.

Nodes

APITitleDescription
AddNodesAddNodesAdds one or more compute nodes to an E-HPC cluster.
ApplyNodesApplyNodesAdds pay-as-you-go or preemptible compute nodes to a cluster.
AddExistedNodesAddExistedNodesAdds one or more existing ECS instances as compute nodes to a specified cluster.
ListNodesListNodesQueries the list of nodes in a cluster.
ListNodesNoPagingListNodesNoPagingQueries the information of all nodes in a specified cluster on one page.
StartNodesStartNodesStarts one or more nodes in a cluster.
StopNodesStopNodesStops one or more nodes in an E-HPC cluster.
ResetNodesResetNodesResets one or more compute nodes.
DeleteNodesDeleteNodesDeletes one or more compute nodes from a cluster.

Queues

APITitleDescription
AddQueueAddQueueCreates a queue for a cluster.
ListQueuesListQueuesQueries the queues of a specified cluster.
UpdateQueueConfigUpdateQueueConfigUpdates the resource group information and the instance types of compute nodes for a queue of a cluster.
ListNodesByQueueListNodesByQueueQueries the node information of a single cluster within an Alibaba Cloud account by queue.
SetQueueSetQueueMoves compute nodes from a queue to another queue.
DeleteQueueDeleteQueueDeletes a queue from a cluster.

Schedulers

APITitleDescription
SetSchedulerInfoSetSchedulerInfoConfigures the scheduler settings of a cluster.
GetSchedulerInfoGetSchedulerInfoQueries the scheduler settings of a cluster.

Software

APITitleDescription
ListSoftwaresListSoftwaresQueries the list of software that can be installed in a cluster.
InstallSoftwareInstallSoftwareInstalls software in a cluster.
ListInstalledSoftwareListInstalledSoftwareQueries the list of software that is installed in a cluster.
UninstallSoftwareUninstallSoftwareUninstalls software from a cluster.

User

APITitleDescription
AddUsersAddUsersAdds users to a cluster.
ListUsersListUsersQueries the users in a cluster.
ListUsersAsyncListUsersAsyncQueries the users in a cluster.
ModifyUserGroupsModifyUserGroupsModifies permission groups.
ModifyUserPasswordsModifyUserPasswordsModifies user passwords.
DeleteUsersDeleteUsersDeletes users from a cluster.

Storage

APITitleDescription
ListFileSystemWithMountTargetsListFileSystemWithMountTargetsQueries file systems and mount targets.
ListCpfsFileSystems ListCpfsFileSystemsQueries the information about Cloud Paralleled File System (CPFS) and its mount targets.
GetClusterVolumesGetClusterVolumesQueries the information about the volumes that are mounted to the specified E-HPC cluster in the user account.
ListVolumesListVolumesQueries the file systems mounted on Elastic High Performance Computing (E-HPC) clusters.
UpdateClusterVolumesUpdateClusterVolumesUpdates the mounted storage resources for a specified cluster.

Job

APITitleDescription
ListServerlessJobsListServerlessJobsQueries the list of serverless jobs based on filter conditions.
DescribeServerlessJobsDescribeServerlessJobsQueries 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.
StopServerlessJobsStopServerlessJobsStops 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.
SubmitServerlessJobSubmitServerlessJobSubmits a serverless job to the E-HPC cluster.
CreateJobFileCreateJobFileCreates a job file.
SubmitJobSubmitJobSubmits a job in a cluster.
ListJobsListJobsQueries the list of jobs in a cluster.
DescribeJobDescribeJobQueries the information about a job in an E-HPC cluster.
ListJobsWithFiltersListJobsWithFiltersQueries the details of a specified job.
GetJobLogGetJobLogQueries the output logs of a job.
RerunJobsRerunJobsReruns one or more jobs.
StopJobsStopJobsStops one or more jobs in a cluster.
DeleteJobsDeleteJobsDeletes jobs from a cluster.

Job template

APITitleDescription
CreateJobTemplateCreateJobTemplateCreates a job template.
ListJobTemplatesListJobTemplatesQueries the list of job templates.
EditJobTemplateEditJobTemplateModifies a job template.
DeleteJobTemplatesDeleteJobTemplatesDeletes one or more job templates at a time.

Interactive commands

APITitleDescription
InvokeShellCommandInvokeShellCommandRuns interactive commands in a cluster node.
ListCommandsListCommandsQueries the interactive commands in a specified cluster.
ListInvocationResultsListInvocationResultsQueries the result of an interactive command in a cluster.
ListInvocationStatusListInvocationStatusQueries the status of an interactive command.

Post-processing script

APITitleDescription
SetPostScriptsSetPostScriptsConfigures the post-processing scripts of a cluster.
GetPostScriptsGetPostScriptsQueries the post-processing scripts of a cluster.

VNC

APITitleDescription
GetVisualServiceStatusGetVisualServiceStatusQueries the status of the VNC service in a cluster.
ModifyVisualServicePasswdModifyVisualServicePasswdSets a connection password for the VNC Remote visualization service of a specified cluster.
StartVisualServiceStartVisualServiceStarts the Virtual Network Console (VNC) Remote visualization service in a specified cluster.
StopVisualServiceStopVisualServiceStops the Virtual Network Console (VNC) Remote visualization service in a specified cluster.

Autoscaling

APITitleDescription
SetAutoScaleConfigSetAutoScaleConfigConfigures the auto scaling settings of a cluster.
DescribeAutoScaleConfigDescribeAutoScaleConfigQueries the auto scaling settings of a cluster.
GetAutoScaleConfigGetAutoScaleConfigObtains the auto scaling settings of a cluster.

Container application

APITitleDescription
ImageImage
GetCommonImageGetCommonImageQuries the images provided by Elastic High Performance Computing (E-HPC), such as intel oneapi images, PyTorch images, and TensorFlow images.
GetUserImageGetUserImagePulls an image from an Object Storage Service (OSS) bucket to a specified cluster. The image is managed based on the policies configured for the cluster.
SummaryImagesSummaryImagesQueries the names of all images in a cluster.
SummaryImagesInfoSummaryImagesInfoQueries the detailed information about an existing image in a cluster, including the creation time and image size.
DescribeImageGatewayConfigDescribeImageGatewayConfigQueries the image gateway configuration file of a shifter container in a specified cluster.
ModifyImageGatewayConfigModifyImageGatewayConfigModifies the gateway configuration file of an image in a specified cluster.
PullImagePullImagePulls images from a repository.
InspectImageInspectImageDisplays the Inspect information about an image.
ListContainerImagesListContainerImagesQueries the list of local images in a cluster.
DescribeImageDescribeImageQueries the information about the on-premises image of a specified cluster.
DeleteLocalImageDeleteLocalImageDeletes an image from a cluster.
DeleteImageDeleteImageDeletes a local image.
ApplicationApplication
DeleteContainerAppsDeleteContainerAppsDeletes multiple the container applications at a time.
DescribeContainerAppDescribeContainerAppQueries the information of a containerized application.
ListContainerAppsListContainerAppsQueries the list of containerized applications and their information.
ModifyContainerAppAttributesModifyContainerAppAttributesModifies the description of a containerized application.
AddContainerAppAddContainerAppAdds a containerized application.

Performance management

APITitleDescription
RunCloudMetricProfilingRunCloudMetricProfilingStarts the profiling process of a cluster.
GetCloudMetricProfilingGetCloudMetricProfilingQueries the profiling result of a cluster.
ListCloudMetricProfilingsListCloudMetricProfilingsQueries the profiling information of a specified cluster.
GetCloudMetricLogsGetCloudMetricLogsQueries the performance metric logs of E-HPC.

Report

APITitleDescription
GetAccountingReportGetAccountingReportQueries the resource report information of a specified cluster.

Operation log

APITitleDescription
ListClusterLogsListClusterLogsQueries the operations records of a cluster for the last three days.

Cluster client

APITitleDescription
ListCurrentClientVersionListCurrentClientVersionQueries the latest version number of the Elastic High Performance Computing (E-HPC) client.
UpgradeClientUpgradeClientUpgrades the cluster client to the target version.
ListUpgradeClientsListUpgradeClientsQueries the latest version of the Elastic High Performance Computing (E-HPC) client and the upgrade records of the client in the E-HPC cluster.

Security groups

APITitleDescription
AddSecurityGroupAddSecurityGroupAdds a cluster to a security group.
ListSecurityGroupsListSecurityGroupsQueries the list of security groups in a cluster.
DeleteSecurityGroupDeleteSecurityGroupRemoves a cluster from a specified security group.

Tag

APITitleDescription
TagResourcesTagResourcesCreates tags and attach the tags to a specified resource.
ListTagResourcesListTagResourcesQueries the tags that are attached to a specified resource.
UnTagResourcesUnTagResourcesRemoves tags from a specified resource.

Region

APITitleDescription
ListRegionsListRegionsQueries a list of regions where Elastic High Performance Computing (E-HPC) is supported.

Others

APITitleDescription
ListTasksListTasksQueries the response of an asynchronous API operation for a cluster.
InitializeEHPCInitializeEHPCCreates a service-linked role for Elastic High Performance Computing (E-HPC). A service-linked role is required for you to use E-HPC.