Retrieve E-HPC Queue Details with GetQueue API - Elastic High Performance Computing

Query the details of a specified queue in an E-HPC 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:GetQueue

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
ClusterId	string	No	The ID of the cluster. You can call ListClusters to query the cluster ID.	ehpc-hz-FYUr32****
QueueName	string	No	The name of the queue.	comp

Response elements

Element	Type	Description	Example
	object	The response data.
RequestId	string	The ID of the request.	04F0F334-1335-436C-A1D7-6C044FE7****
Queue	object	The configuration of the queue.
QueueName	string	The name of the queue.	comp
EnableScaleOut	boolean	Specifies whether automatic scale-out is enabled for the queue. Valid values: true false	true
EnableScaleIn	boolean	Specifies whether automatic scale-in is enabled for the queue. Valid values: true false	true
MinCount	integer	The minimum number of compute nodes that the queue maintains.	0
MaxCount	integer	The maximum number of compute nodes that the queue maintains.	1000
InitialCount	integer	The initial number of nodes in the queue.	0
InterConnect	string	The network type between compute nodes in the queue. Valid values: vpc eRDMA	erdma
VSwitchIds	array	The list of virtual switches available to compute nodes in the queue. N ranges from 1 to 5.
	string	The ID of the virtual switch.	vsw-t4nw7upbpzb3u071twiys
ComputeNodes	array	The hardware configurations of compute nodes in the queue.
	NodeTemplate	The configuration details of the compute node.
AllocationStrategy	string	The strategy used for automatic scale-out of the queue.	PriorityInstanceType
RamRole	string	The name of the RAM role attached to compute nodes in the queue.	AliyunECSInstanceForEHPCRole
HostnamePrefix	string	The hostname prefix for compute nodes in the queue.	compute
HostnameSuffix	string	The hostname suffix for compute nodes in the queue.	demo
MaxCountPerCycle	integer	The minimum number of nodes delivered per scale-out cycle.	99
KeepAliveNodes	array	The list of nodes with deletion protection enabled in the queue.
	string	The hostname of a node with deletion protection enabled.	compute000
ReservedNodePoolId	string	The ID of the reserved node pool.	rnp-756vlp7a
CreateTime	string		2025-01-01T12:05:00Z
UpdateTime	string		2025-01-01T12:05:00Z

Examples

Success response

JSON format

{
  "RequestId": "04F0F334-1335-436C-A1D7-6C044FE7****",
  "Queue": {
    "QueueName": "comp",
    "EnableScaleOut": true,
    "EnableScaleIn": true,
    "MinCount": 0,
    "MaxCount": 1000,
    "InitialCount": 0,
    "InterConnect": "erdma",
    "VSwitchIds": [
      "vsw-t4nw7upbpzb3u071twiys"
    ],
    "ComputeNodes": [
      {
        "InstanceType": "ecs.c7.4xlarge",
        "ImageId": "aliyun_3_x64_20G_alibase_20221102.vhd",
        "InstanceChargeType": "PostPaid",
        "PeriodUnit": "Month",
        "Period": 1,
        "AutoRenew": false,
        "AutoRenewPeriod": 1,
        "SpotStrategy": "NoSpot",
        "SpotPriceLimit": 0.97,
        "Duration": 1,
        "EnableHT": true,
        "SystemDisk": {
          "Category": "cloud_essd",
          "Size": 40,
          "Level": "PL0"
        },
        "DataDisks": [
          {
            "Category": "cloud_essd",
            "Size": 40,
            "Level": "PL0",
            "DeleteWithInstance": false,
            "MountDir": "/data1",
            "Device": "/dev/xvdb",
            "SnapshotId": "s-bp1ei2b44ripxuo46hym"
          }
        ]
      }
    ],
    "AllocationStrategy": "PriorityInstanceType",
    "RamRole": "AliyunECSInstanceForEHPCRole",
    "HostnamePrefix": "compute",
    "HostnameSuffix": "demo",
    "MaxCountPerCycle": 99,
    "KeepAliveNodes": [
      "compute000"
    ],
    "ReservedNodePoolId": "rnp-756vlp7a",
    "CreateTime": "2025-01-01T12:05:00Z",
    "UpdateTime": "2025-01-01T12:05:00Z"
  }
}

Error codes

HTTP status code	Error code	Error message	Description
403	InvalidClusterStatus	The operation failed due to invalid cluster status.	The cluster status does not support the operation.
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.