All Products
Search
Document Center

Elastic High Performance Computing:ListUpgradeClients

Last Updated:Sep 10, 2026

Queries the latest upgradable client (ehpcutil) version and historical upgrade operations for 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:ListUpgradeClients

*All Resource

*

None None

Request parameters

Parameter

Type

Required

Description

Example

RegionId

string

Yes

The region ID.

cn-hangzhou

ClusterId

string

Yes

The cluster ID.

ehpc-hz-FYUr32****

Response elements

Element

Type

Description

Example

object

Schema of Response

RequestId

string

The request ID.

89A1AC0F-4A6C-4F3D-98F9-BEF9A823****

LatestVersion

string

The latest released ehpcutil version.

1.2.22

ClientRecords

array<object>

The ehpcutil upgrade operation records of the cluster.

object

The ehpcutil upgrade operation records of the cluster.

SubUid

string

The ID of the user who upgraded the ehpcutil version.

129******84

OldVersion

string

The ehpcutil version before the upgrade.

1.2.16

NewVersion

string

The ehpcutil version after the upgrade.

1.2.21

UpdateTime

string

The time of the operation. The time is displayed in the ISO 8601 standard in UTC.

2022-08-26T06:26:57.000Z

CurrentVersion

string

The current ehpcutil version of the cluster.

1.2.21

Examples

Success response

JSON format

{
  "RequestId": "89A1AC0F-4A6C-4F3D-98F9-BEF9A823****",
  "LatestVersion": "1.2.22",
  "ClientRecords": [
    {
      "SubUid": "129******84",
      "OldVersion": "1.2.16",
      "NewVersion": "1.2.21",
      "UpdateTime": "2022-08-26T06:26:57.000Z"
    }
  ],
  "CurrentVersion": "1.2.21"
}

Error codes

HTTP status code

Error code

Error message

Description

400 InvalidParams The specified parameter %s is invalid. The specified parameter %s is invalid.
500 UnknownError An unknown error occurred. An unknown error occurred.
404 ClusterNotFound The specified cluster does not exist. The specified instance does not exist.
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.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.