List of operations by function - Elastic High Performance Computing

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 (78410016550) 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

API	Title	Description
DescribePrice	DescribePrice	Queries the pricing information of a cluster.
CreateCluster	CreateCluster	Creates a pay-as-you-go or subscription E-HPC cluster.
DescribeCluster	DescribeCluster	Queries the details of a cluster.
ModifyClusterAttributes	ModifyClusterAttributes	Modifies the basic information of a cluster, including the name, description, and image.
ListClusters	ListClusters	Queries the list of clusters in all regions within an account.
ListClustersMeta	ListClustersMeta	Queries the list of cluster metadata.
StartCluster	StartCluster	Starts a cluster.
StopCluster	StopCluster	Stops a cluster.
RecoverCluster	RecoverCluster	Resets and restores a cluster.
DeleteCluster	DeleteCluster	Releases a cluster.

Hybrid cloud clusters

API	Title	Description
CreateHybridCluster	CreateHybridCluster	Creates a hybrid cloud cluster.
AddLocalNodes	AddLocalNodes	Adds local nodes to a specified cluster on hybrid cloud or cluster on the cloud.
GetHybridClusterConfig	GetHybridClusterConfig	Queries the configurations of a specified hybrid cloud cluster or a specified compute node.
SyncUsers	SyncUsers	Synchronizes local cluster users to a hybrid cloud cluster in hybrid-cloud proxy mode.

ECS instances

API	Title	Description
ListPreferredEcsTypes	ListPreferredEcsTypes	Queries the Elastic Compute Service (ECS) instance types recommended by Elastic High Performance Computing (E-HPC).
ListAvailableEcsTypes	ListAvailableEcsTypes	Queries available Elastic Compute Service (ECS) instance types.
GetIfEcsTypeSupportHtConfig	GetIfEcsTypeSupportHtConfig	Queries whether hyper-threading can be enabled or disabled for an instance type.

Image

API	Title	Description
ListImages	ListImages	Queries the list of images that can be installed in a cluster.
DescribeEstackImage	DescribeEstackImage	Queries the base images of Elastic High Performance Computing (E-HPC).
ListCustomImages	ListCustomImages	Queries custom images and shared images supported by Elastic High Performance Computing (E-HPC).
ListCommunityImages	ListCommunityImages	Queries a list of community images.
DescribeImagePrice	DescribeImagePrice	Queries the price of an Alibaba Cloud Marketplace image.

User

API	Title	Description
AddUsers	AddUsers	Adds users to a cluster.
ListUsers	ListUsers	Queries all users of a cluster.
ListUsersAsync	ListUsersAsync	Queries the users in a cluster.
ModifyUserGroups	ModifyUserGroups	Changes the user group to which users belong.
ModifyUserPasswords	ModifyUserPasswords	Changes the passwords of users.
DeleteUsers	DeleteUsers	Deletes users from a cluster.

Nodes

API	Title	Description
AddNodes	AddNodes	Adds one or more compute nodes to an E-HPC cluster.
ApplyNodes	ApplyNodes	Adds pay-as-you-go or preemptible compute nodes to a cluster.
AddExistedNodes	AddExistedNodes	Adds one or more existing ECS instances as compute nodes to a specified cluster.
ListNodes	ListNodes	Queries the list of nodes in a cluster.
ListNodesNoPaging	ListNodesNoPaging	Queries the information of all nodes in a specified cluster on one page.
StartNodes	StartNodes	Starts one or more nodes in a cluster.
StopNodes	StopNodes	Stops one or more nodes in an E-HPC cluster.
ResetNodes	ResetNodes	Resets one or more compute nodes.
DeleteNodes	DeleteNodes	Deletes one or more compute nodes from a cluster.

Queues

API	Title	Description
AddQueue	AddQueue	Creates a queue for a cluster.
ListQueues	ListQueues	Queries the queues of a specified cluster.
UpdateQueueConfig	UpdateQueueConfig	Updates the resource group information and the instance types of compute nodes for a queue of a cluster.
ListNodesByQueue	ListNodesByQueue	Queries the node information of a single cluster within an Alibaba Cloud account by queue.
SetQueue	SetQueue	Moves compute nodes from a queue to another queue.
DeleteQueue	DeleteQueue	Deletes a queue from a cluster.

Schedulers

API	Title	Description
SetSchedulerInfo	SetSchedulerInfo	Configures the scheduler settings of a cluster.
GetSchedulerInfo	GetSchedulerInfo	Queries the scheduler settings of a cluster.

Software

API	Title	Description
ListSoftwares	ListSoftwares	Queries the list of software that can be installed in a cluster.
InstallSoftware	InstallSoftware	Installs software in a cluster.
ListInstalledSoftware	ListInstalledSoftware	Queries the software that is installed in a cluster.
UninstallSoftware	UninstallSoftware	Uninstalls software from a cluster.

Storage

API	Title	Description
ListFileSystemWithMountTargets	ListFileSystemWithMountTargets	Queries file systems and mount targets.
GetClusterVolumes	GetClusterVolumes	Queries the storage resources that are mounted to an E-HPC cluster.
ListVolumes	ListVolumes	Queries the file systems mounted on Elastic High Performance Computing (E-HPC) clusters.
UpdateClusterVolumes	UpdateClusterVolumes	Mount new storage resources to a cluster.

Job

API	Title	Description
SubmitJob	SubmitJob	Submits a job in a cluster.
CreateJobFile	CreateJobFile	Creates a job file.
ListJobs	ListJobs	Queries the list of jobs in a cluster.
DescribeJob	DescribeJob	Queries the information about a job in an E-HPC cluster.
ListJobsWithFilters	ListJobsWithFilters	Queries the details of a specified job.
RerunJobs	RerunJobs	Reruns one or more jobs.
StopJobs	StopJobs	Stops one or more jobs in a cluster.
GetJobLog	GetJobLog	Queries the output logs of a job.
DeleteJobs	DeleteJobs	Deletes jobs from a cluster.

Serverless Job

API	Title	Description
SubmitServerlessJob	SubmitServerlessJob	Submits a serverless job to an Elastic High Performance Computing (E-HPC) cluster.
ListServerlessJobs	ListServerlessJobs	Queries the list of serverless jobs based on filter conditions.
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.
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.

Job template

API	Title	Description
CreateJobTemplate	CreateJobTemplate	Creates a job template.
ListJobTemplates	ListJobTemplates	Queries the list of job templates.
EditJobTemplate	EditJobTemplate	Modifies a job template.
DeleteJobTemplates	DeleteJobTemplates	Deletes job templates.

Interactive commands

API	Title	Description
InvokeShellCommand	InvokeShellCommand	Runs interactive commands in a cluster node.
ListCommands	ListCommands	Queries the interactive commands in a specified cluster.
ListInvocationResults	ListInvocationResults	Queries the result of an interactive command in a cluster.
ListInvocationStatus	ListInvocationStatus	Queries the status of an interactive command.

Post-processing script

API	Title	Description
SetPostScripts	SetPostScripts	Configures the post-processing scripts of a cluster.
GetPostScripts	GetPostScripts	Queries the post-processing scripts of a cluster.

VNC

API	Title	Description
GetVisualServiceStatus	GetVisualServiceStatus	Queries the status of the VNC service in a cluster.
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).
StartVisualService	StartVisualService	Starts the Virtual Network Console (VNC) Remote visualization service in a specified cluster.
StopVisualService	StopVisualService	Stops the remote visualization service of Virtual Network Console (VNC) in a cluster.

Autoscaling

API	Title	Description
SetAutoScaleConfig	SetAutoScaleConfig	Configures the auto scaling settings of a cluster.
DescribeAutoScaleConfig	DescribeAutoScaleConfig	Queries the auto scaling settings of a cluster.
GetAutoScaleConfig	GetAutoScaleConfig	Obtains the auto scaling settings of a cluster.

Performance management

API	Title	Description
RunCloudMetricProfiling	RunCloudMetricProfiling	Starts the profiling process of a cluster.
GetCloudMetricProfiling	GetCloudMetricProfiling	Queries the profiling result of a cluster.
ListCloudMetricProfilings	ListCloudMetricProfilings	Queries the profiling history of a cluster.
GetCloudMetricLogs	GetCloudMetricLogs	Reads performance metrics (CloudMetrics) logs of E-HPC.

Report

API	Title	Description
GetAccountingReport	GetAccountingReport	Queries the resource report information of a specified cluster.

Operation log

API	Title	Description
ListClusterLogs	ListClusterLogs	Queries the operation logs of a cluster within the last three days.

Cluster client

API	Title	Description
ListCurrentClientVersion	ListCurrentClientVersion	Query the latest version number of the cluster client (ehpcutil).
UpgradeClient	UpgradeClient	Updates the client (ehpcutil) in a cluster to a new version.
ListUpgradeClients	ListUpgradeClients	Queries the latest version to which the client (ehpcutil) in a cluster can be updated and historical update records of the client.

Security groups

API	Title	Description
AddSecurityGroup	AddSecurityGroup	Adds a cluster to a security group.
ListSecurityGroups	ListSecurityGroups	Queries the security groups that are assigned to an E-HPC cluster.
DeleteSecurityGroup	DeleteSecurityGroup	Removes a cluster from a specified security group.

Tag

API	Title	Description
TagResources	TagResources	Creates tags and attach the tags to a specified resource.
ListTagResources	ListTagResources	Queries the tags that are attached to a specified resource.
UnTagResources	UnTagResources	Removes tags from a specified resource.

Region

API	Title	Description
ListRegions	ListRegions	Queries a list of regions where Elastic High Performance Computing (E-HPC) is supported.

Others

API	Title	Description
ListTasks	ListTasks	Queries the response of an asynchronous API operation for 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.