All Products
Search
Document Center

List of operations by function

Last Updated: Sep 10, 2021

The following tables list the API operations that are available for use in Elastic High Performance Computing (E-HPC).

Clusters

API

Description

DescribePrice

Queries the pricing information of a cluster.

ListPreferredEcsTypes

Queries the recommended ECS instance types.

ListAvailableEcsTypes

Queries available ECS instance types.

GetIfEcsTypeSupportHtConfig

Queries whether an instance type supports enabling and disabling hyper-threading.

CreateCluster

Creates a pay-as-you-go or subscription cluster.

ModifyClusterAttributes

Modifies the basic information of a cluster, including the name, description, and image.

ListClusters

Queries the list of clusters in all regions within an account.

ListClustersMeta

Queries the list of cluster metadata.

DescribeCluster

Queries the details of a cluster.

ListClusterLogs

Queries the operations records of a cluster in the last three days.

StartCluster

Starts a cluster.

RecoverCluster

Resets and fixes a cluster.

StopCluster

Stops a cluster.

DeleteCluster

Releases a cluster.

Hybrid cloud clusters

API

Description

CreateHybridCluster

Creates a hybrid cloud cluster.

AddLocalNodes

Adds on-premises compute nodes to a hybrid cloud cluster or a cluster on the cloud.

GetHybridClusterConfig

Queries the configurations of a hybrid cloud cluster or a compute node.

Nodes

API

Description

AddNodes

Adds one or more compute nodes to a cluster.

ListNodes

Queries the list of nodes in a cluster.

ListNodesNoPaging

Queries the list of nodes in a cluster without pagination.

StartNodes

Starts one or more nodes in a cluster.

ResetNodes

Resets one or more compute nodes.

StopNodes

Stops one or more nodes in a cluster.

DeleteNodes

Deletes one or more compute nodes.

Queues

API

Description

AddQueue

Creates a queue for a cluster.

UpdateQueueConfig

Updates the instance types of resource groups and compute nodes in a queue of a cluster.

SetQueue

Moves compute nodes from a queue to another queue.

ListNodesByQueue

Queries the information about nodes in a queue of a cluster.

DeleteQueue

Deletes a queue in a cluster.

Interactive commands

API

Description

InvokeShellCommand

Runs interactive commands in a cluster node.

ListCommands

Queries the list of interactive commands in a cluster.

ListInvocationStatus

Queries the status of an interactive command.

ListInvocationResults

Queries the result of an interactive command in a cluster.

Auto scaling

API

Description

SetAutoScaleConfig

Configures the auto scaling settings of a cluster.

DescribeAutoScaleConfig

Queries the auto scaling settings of a cluster.

GetAutoScaleConfig

Obtains the auto scaling settings of a cluster.

Container applications

API

Description

AddContainerApp

Adds a container application.

ModifyContainerAppAttributes

Modifies the description of a container application.

ListContainerImages

Queries the list of on-premises images in a cluster.

ListContainerApps

Queries the list of container applications and their information.

DescribeImage

Queries the information about the on-premises image of a cluster.

DescribeContainerApp

Queries the information of a container application.

DeleteImage

Deletes an on-premises image.

DeleteContainerApps

Deletes multiple container applications at a time.

Job templates

API

Description

CreateJobTemplate

Creates a job template.

EditJobTemplate

Modifies a job template.

ListJobTemplates

Queries the list of job templates.

DeleteJobTemplates

Deletes multiple job templates at a time.

Jobs

API

Description

CreateJobFile

Creates a job file.

SubmitJob

Submits a job.

RerunJobs

Reruns one or more jobs.

DescribeJob

Queries the information about a job in a cluster.

ListJobs

Queries the list of jobs in a cluster.

StopJobs

Stops multiple jobs at a time.

DeleteJobs

Deletes multiple jobs at a time.

Storage management

API

Description

GetClusterVolumes

Queries the information of file systems in a cluster.

ListFileSystemWithMountTargets

Queries file systems and mount targets.

UpdateClusterVolumes

Mounts one or more file systems on a cluster.

Users

API

Description

AddUsers

Adds multiple users at a time.

ListUsers

Queries the list of users in a cluster.

ModifyUserGroups

Modifies one or more permission groups.

DeleteUsers

Deletes one or more cluster users.

Resource reports and service-linked roles

API

Description

GetAccountingReport

Queries the resource information of a cluster.

InitializeEHPC

Creates a service-linked role for E-HPC.

Software and images

API

Description

ListSoftwares

Queries the list of software that can be installed in a cluster.

ListInstalledSoftware

Queries the list of software that is installed in a cluster.

InstallSoftware

Installs software in a cluster.

UninstallSoftware

Uninstalls software from a cluster.

ListImages

Queries the list of images that can be installed in a cluster.

ListCustomImages

Queries the list of custom images and shared images that are supported by E-HPC.

E-HPC optimizer

API

Description

RunCloudMetricProfiling

Starts the profiling process of a cluster.

GetCloudMetricLogs

Queries the performance metric logs of E-HPC.

GetCloudMetricProfiling

Queries the profiling result of a cluster.

ListCloudMetricProfilings

Queries the profiling history of a cluster.

Security groups

API

Description

AddSecurityGroup

Adds a cluster to a security group.

ListSecurityGroups

Queries the list of security groups that are attached to a cluster.

DeleteSecurityGroup

Removes a cluster from a security group.

Clients

API

Description

UpgradeClient

Upgrades a cluster client to a specified version.

VNC service

API

Description

StartVisualService

Starts the virtual network computing (VNC) service.

ModifyVisualServicePasswd

Sets a connection password for the VNC service in a cluster.

GetVisualServiceStatus

Queries the usage status of the VNC service in a cluster.

StopVisualService

Stops the VNC service.

Regions

API

Description

ListRegions

Queries the list of regions where E-HPC is supported.