GetQueue - Elastic High Performance Computing - Alibaba Cloud Documentation Center

This topic is generated by a machine translation engine without any human intervention. ALIBABA CLOUD DOES NOT GUARANTEE THE ACCURACY OF MACHINE TRANSLATED CONTENT. To request a human-translated version of this topic or provide feedback on this translation, please include it in the feedback form.

Queries the details of a queue in an Elastic High Performance Computing (E-HPC) 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.

Debug

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.

Operation	Access level	Resource type	Condition key	Associated operation
ehpc:GetQueue	get	All Resources ``	none	none

Request parameters

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

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	04F0F334-1335-436C-A1D7-6C044FE7****
Queue	object	The queue configurations.
QueueName	string	The queue name.	comp
EnableScaleOut	boolean	Indicates whether auto scale-out is enabled for the queue. Valid values: true false	true
EnableScaleIn	boolean	Indicates whether auto scale-in is enabled for the queue. Valid values: true false	true
MinCount	integer	The minimum number of compute nodes that the queue must contain.	0
MaxCount	integer	The maximum number of compute nodes that the queue can contain.	1000
InitialCount	integer	The initial number of nodes in the queue.	0
InterConnect	string	The type of the network between compute nodes in the queue. Valid values: vpc eRDMA	erdma
VSwitchIds	array	The available vSwitches for compute nodes in the queue. Valid values of N: 1 to 5.
VSwitchId	string	The vSwitch ID.	vsw-t4nw7upbpzb3u071twiys
ComputeNodes	array	The hardware configurations of the compute nodes in the queue.
ComputeNode	NodeTemplate	The configurations of the compute node.
AllocationStrategy	string	The auto scale-out policy of the queue.	PriorityInstanceType
RamRole	string	The Resource Access Management (RAM) role that is assumed by compute nodes in the queue.	AliyunECSInstanceForEHPCRole
HostnamePrefix	string	The hostname prefix of the compute nodes in the queue.	compute
HostnameSuffix	string	The hostname suffix of the compute nodes in the queue.	demo
MaxCountPerCycle	long	The minimum number of nodes that are delivered to the queue in each scale-out cycle.	99
KeepAliveNodes	array	The nodes for which deletion protection is enabled in the queue.
KeepAliveNode	string	The hostname of the node for which deletion protection is enabled.	compute000
ReservedNodePoolId	string	Preset node pool ID.	rnp-756vlp7a

Examples

Sample success responses

JSONformat

{
  "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"
          }
        ]
      }
    ],
    "AllocationStrategy": "PriorityInstanceType",
    "RamRole": "AliyunECSInstanceForEHPCRole",
    "HostnamePrefix": "compute",
    "HostnameSuffix": "demo",
    "MaxCountPerCycle": 99,
    "KeepAliveNodes": [
      "compute000"
    ],
    "ReservedNodePoolId": "rnp-756vlp7a"
  }
}

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.
406	DbError	A database service error occurred.	Database request failed.
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.

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

Change history

Change time	Summary of changes	Operation
2025-02-12	The Error code has changed. The response structure of the API has changed	View Change Details