ListQueues - Elastic High Performance Computing - Alibaba Cloud Documentation Center

Queries queues 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:ListQueues	list	All Resources ``	none	none

Request parameters

Parameter	Type	Required	Description	Example
ClusterId	string	No	The cluster ID.	ehpc-hz-FYUr32****
QueueNames	array	No	The names of the queues that you want to query. You can specify up to eight names.
	string	No	The queue name.	comp

Response parameters

Parameter	Type	Description	Example
	object	The results returned.
RequestId	string	The request ID.	C6E5005C-00B0-4F27-98BB-95AB88016C22
TotalCount	integer	The total number of entries returned.	1
ClusterId	string	The cluster ID. You can call the ListClusters operation to query the cluster ID.	ehpc-hz-FYUr32****
PageNumber	integer	The page number of the returned page.	1
PageSize	integer	The number of entries per page.	10
Queues	array<object>	The information about the queues.
Queue	object	The information about the queue.
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.	100
MaxCountPerCycle	integer	The minimum number of compute nodes that are added to the queue in each auto scale-out.	1
ComputeNodes	array	The hardware configurations of the compute nodes that are added in auto scale-outs. Up to five nodes are displayed.
ComputeNode	NodeTemplate	The hardware configurations of the compute nodes.
VSwitchIds	array	The vSwitches that can be used for added nodes during auto scale-outs. Up to three vSwitches are displayed.
VSwitchId	string	The vSwitch ID.	vsw-bp12pmqe9gh0pi7i1f2ed
Nodes	object	The statistics about the compute nodes in the queue.
RunningCounts	integer	The number of running compute nodes.	1
ExceptionCounts	integer	The number of malfunctioning compute nodes.	0
CreatingCounts	integer	The number of compute nodes that are not ready.	2
CreateTime	string	The time when the queue was created. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mmZ format. The time is displayed in UTC. For more information, see ISO 8601.	2023-11-10T02:04:00Z
UpdateTime	string	The time when the queue was updated. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mmZ format. The time is displayed in UTC. For more information, see ISO 8601.	2024-04-25T02:02:32
TotalCores	integer	The total number of vCPUs that are used by all compute nodes in the queue.	24

Examples

Sample success responses

JSONformat

{
  "RequestId": "C6E5005C-00B0-4F27-98BB-95AB88016C22",
  "TotalCount": 1,
  "ClusterId": "ehpc-hz-FYUr32****",
  "PageNumber": 1,
  "PageSize": 10,
  "Queues": [
    {
      "QueueName": "comp",
      "EnableScaleOut": true,
      "EnableScaleIn": true,
      "MinCount": 0,
      "MaxCount": 100,
      "MaxCountPerCycle": 1,
      "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"
            }
          ]
        }
      ],
      "VSwitchIds": [
        "vsw-bp12pmqe9gh0pi7i1f2ed"
      ],
      "Nodes": {
        "RunningCounts": 1,
        "ExceptionCounts": 0,
        "CreatingCounts": 2
      },
      "CreateTime": "2023-11-10T02:04:00Z",
      "UpdateTime": "2024-04-25T02:02:32",
      "TotalCores": 24
    }
  ]
}

Error codes

HTTP status code	Error code	Error message	Description
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.

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

Change history

Change time	Summary of changes	Operation

No change history