Query the list of software in a cluster by using ListSoftwares - Elastic High Performance Computing - Alibaba Cloud - Elastic High Performance Computing

Queries the software available for installation in a cluster.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

ehpc:ListSoftwares

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
EhpcVersion	string	No	The version of the E-HPC client. Call the ListCurrentClientVersion operation to query the version.	1.0.0
OsTag	string	No	The image tag of the cluster. Call the ListImages operation to query the image tag.	CentOS_7.2_64

Response elements

Element	Type	Description	Example
	object
RequestId	string	The ID of the request.	04F0F334-1335-436C-A1D7-6C044FE7****
Softwares	object
SoftwareInfo	array<object>	The information about software installed in the cluster.
	array<object>
SchedulerType	string	The type of the scheduler. Valid values: pbs pbs19 slurm slurm19 slurm20 opengridscheduler deadline gridengine cube custom	pbs
OsTag	string	The image tag of the cluster.	CentOS_7.2_64
SchedulerVersion	string	The version of the scheduler.	18.1.1
AccountVersion	string	The version of the domain account service.	2.31
AccountType	string	The service type of the domain account. Valid values: nis ldap	nis
EhpcVersion	string	The version of the E-HPC client.	1.0.0
Applications	object
ApplicationInfo	array<object>	The software available in the cluster.
	object
Required	boolean	Indicates whether the software is required. Valid values: false: optional true: required	true
Tag	string	The tag of the software.	CUDNN_9.0
Name	string	The name of the software.	cudnnt
Version	string	The version of the software.	9.0

Examples

Success response

JSON format

{
  "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 code	Error code	Error message	Description
500	UnknownError	An unknown error occurred.	An unknown error occurred.
404	ImageNotFound	The specified image does not exist.	The specified image does not exist. Please verify the parameter.
503	ServiceUnavailable	The request has failed due to a temporary failure of the server	The request has failed due to a temporary failure of the server.
406	DbError	A database service error occurred.	Database request failed.
407	NotAuthorized	You are not authorized by RAM for this request.	The request is not authorized by RAM.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.