All Products
Search
Document Center

Elastic High Performance Computing:ListSoftwares

Last Updated:Mar 03, 2024

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

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
ehpc:ListSoftwaresREAD
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
EhpcVersionstringNo

The version of the E-HPC client.

You can call the ListCurrentClientVersion operation to query the E-HPC client version.

1.0.0
OsTagstringNo

The image tag of the cluster.

You can use the ListImages to query the image tag of the cluster.

CentOS_7.2_64

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The ID of the request.

04F0F334-1335-436C-A1D7-6C044FE7****
Softwaresobject []

The list of the information about the software installed in the cluster.

SchedulerTypestring

The type of the scheduler. Valid values:

  • pbs
  • pbs19
  • slurm
  • slurm19
  • slurm20
  • opengridscheduler
  • deadline
  • gridengine
  • cube
  • custom
pbs
OsTagstring

The image tag of the cluster.

CentOS_7.2_64
SchedulerVersionstring

The version of the scheduler.

18.1.1
AccountVersionstring

The version of the domain account service.

2.31
AccountTypestring

The service type of the domain account. Valid values:

  • nis
  • ldap
nis
EhpcVersionstring

The version of the E-HPC client.

1.0.0
Applicationsobject []

The list of the software in the cluster.

Requiredboolean

Indicates whether the software is required. Valid values:

  • false: optional
  • true: required
true
Tagstring

The tag of the software.

CUDNN_9.0
Namestring

The name of the software.

cudnnt
Versionstring

The version of the software.

9.0

Examples

Sample success responses

JSONformat

{
  "RequestId": "04F0F334-1335-436C-A1D7-6C044FE7****",
  "Softwares": {
    "SoftwareInfo": [
      {
        "SchedulerType": "pbs",
        "OsTag": "CentOS_7.2_64",
        "SchedulerVersion": "18.1.1",
        "AccountVersion": "2.31",
        "AccountType": "nis",
        "EhpcVersion": "1.0.0",
        "Applications": {
          "ApplicationInfo": [
            {
              "Required": true,
              "Tag": "CUDNN_9.0",
              "Name": "cudnnt",
              "Version": "9.0"
            }
          ]
        }
      }
    ]
  }
}

Error codes

HTTP status codeError codeError messageDescription
404ImageNotFoundThe specified image does not exist.The specified image does not exist. Please verify the parameter.
406DbErrorA database service error occurred.Database request failed.
407NotAuthorizedYou are not authorized by RAM for this request.The request is not authorized by RAM.
500UnknownErrorAn unknown error occurred.An unknown error occurred.
503ServiceUnavailableThe request has failed due to a temporary failure of the serverThe request has failed due to a temporary failure of the server.

For a list of error codes, visit the Service error codes.