All Products
Search
Document Center

Elastic High Performance Computing:ListInstalledSoftwares

Last Updated:Jan 14, 2026

Queries the installed software of a cluster.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

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:
    • For mandatory resource types, indicate with a prefix of * .
    • 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:ListInstalledSoftwaresget
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
PageNumberstringNo

The page number.

1
PageSizestringNo

The number of entries per page.

10
ClusterIdstringNo

The cluster ID.

ehpc-hz-FYUr32****

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The request ID.

04F0F334-1335-436C-A1D7-6C044FE73368
PageNumberstring

The page number of the returned page.

1
PageSizestring

The number of entries per page.

10
TotalCountstring

The total number of entries returned.

2
AdditionalPackagesarray<object>

The list of installed software.

AdditionalPackageInfosobject
Namestring

The software name.

gromacs
Categorystring

The category into which the software falls.

NWP
Iconstring

The URL of the software icon.

https://gw.alicdn.com/imgextra/i2/O1CN01FIkxZ81LmE0fvrAyR_!!6000000001341-55-tps-6349-1603.svg
Descriptionstring

The software description.

Versionstring

The software version.

2024.1
Statusstring

The installation status of the software.

Valid values:

  • Installed
  • Uninstalled
  • Installing
  • Exception
Installed
CreateTimestring

The time when the software was installed.

2024-03-05 18:24:08

Examples

Sample success responses

JSONformat

{
  "RequestId": "04F0F334-1335-436C-A1D7-6C044FE73368",
  "PageNumber": 1,
  "PageSize": 10,
  "TotalCount": 2,
  "AdditionalPackages": {
    "AdditionalPackageInfos": [
      {
        "Name": "gromacs",
        "Category": "NWP",
        "Icon": "https://gw.alicdn.com/imgextra/i2/O1CN01FIkxZ81LmE0fvrAyR_!!6000000001341-55-tps-6349-1603.svg",
        "Description": "",
        "Version": 2024.1,
        "Status": "Installed",
        "CreateTime": "2024-03-05 18:24:08"
      }
    ]
  }
}

Error codes

HTTP status codeError codeError messageDescription
404ImageNotFoundThe specified image does not exist.The specified image does not exist. Please verify the parameter.
404LoginNotFoundThe specified login node does not exist.The specified login node does not exist.
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.

Change history

Change timeSummary of changesOperation
No change history