edit-icon download-icon

Other APIs

Last Updated: Dec 04, 2017

ListRegions

The ListRegions API queries the list of regions that can use E-HPC.

Request parameters

Field Type Required? Default value Description
Action String Yes - Operation interface name, required parameter; value: ListRegions

Return parameters

Public return parameters and the following parameter:

Field Type Description
Regions Array< RegionInfo > List of RegionTypes

The format of the RegionInfo structure is as follows:

Field Type Description
RegionId String Region ID
LocalName String Region name

Error codes

Code Description
UnknownError Unknown error

ListImages

The ListImages API queries the list of images supported by E-HPC.

Request parameters

Field Type Required? Default value Description
Action String Yes - Operation interface name, required parameter; value: ListImages
RegionId String Yes - Region ID

Return parameters

Public return parameters and the following parameter:

Field Type Description
OsTags Array\ List of operating system images supported by E-HPC

The format of the OsInfo structure is as follows:

Field Type Description
OsTag String Operating system image tag, for example, CentOS_7.2_64
Platform String Operating system platform, for example, CentOS
Version String Operating system version, for example, 7.2
Architecture String Operating system architecture, which may be i386 or x86_64

Error codes

Code Description
UnknownError Unknown error

ListSoftwares

The ListSoftwares API queries the list of software supported by E-HPC.

Request parameters

Field Type Required? Default value Description
Action String Yes - Operation interface name, required parameter; value: ListSoftwares
RegionId String Yes - Region ID
EhpcVersion String No - E-HPC version

Return parameters

Public return parameters and the following parameter:

Field Type Description
Softwares Array\ Software information list. Each entry includes the names and versions of supported software under an E-HPC version and an operating system version.

The format of the SoftwareInfo structure is as follows:

Field Type Description
EhpcVersion String E-HPC version.
OsTag String Operating system image tag, which can be queried using the ListImages API.
SchedulerType String Scheduler type.
SchedulerVersion String Scheduler software version.
AccountType String Service type of the domain account.
AccountVersion String Service version of the domain account.
Applications Array\ List of the application software used by the cluster. Each entry includes the name and version of the software, and information about whether the software is required.

The format of the ApplicationInfo structure is as follows:

Field Type Description
Tag String Software tag, for example, OpenMPI_1.8.7
Name String Software name
Version String Software version
Required Boolean Whether the software is required

Error codes

Code Description
UnknownError Unknown error

ListPreferredEcsTypes

The ListPreferredEcsTypes API queries the ECS instance types recommended by E-HPC.

Request parameters

Field Type Required? Default value Description
Action String Yes - Operation interface name, required parameter; value: ListPreferredEcsTypes
RegionId String Yes - Region ID

Return parameters

Public return parameters and the following parameter:

Field Type Description
Series Array\ List of recommended ECS instance generations. Each generation includes the instance types recommended for each node type in the E-HPC cluster.

The format of the SeriesInfo structure is as follows:

Field Type Description
SeriesId String Generation ID. Optional values include HighCompute, HighMem, GPU, and All. The value All indicates all options.
SeriesName String Generation name, for example, computing intensive, large memory, GPU card accelerated, and custom configuration.
Roles RoleEcsInfo Information about the instance types included in the current generation that are recommended for the various node types in the E-HPC cluster.

The format of the RoleEcsInfo structure is as follows:

Field Type Description
Manager Array\ List of ECS instance types recommended for control nodes (Manager)
Compute Array\ List of ECS instance types recommended for computing nodes (Compute)
Logon Array\ List of ECS instance types recommended for logon nodes (Logon)

InstanceTypeId indicates the ECS instance type ID, for example, ecs.n1.large.

Error codes

Code Description
UnknownError Unknown error
Thank you! We've received your feedback.