Use the ListQueues API to query cluster queues - Elastic High Performance Computing - Alibaba Cloud - Elastic High Performance Computing

Queries the queues of a specified 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:ListQueues

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
ClusterId	string	Yes	The ID of the cluster.	ehpc-hz-FYUr32****
Async	boolean	No	Specifies whether to enable asynchronous query.	false

Response elements

Element	Type	Description	Example
	object
RequestId	string	The ID of the request.	C6E5005C-00B0-4F27-98BB-95AB88016C22
Queues	object
QueueInfo	array<object>	The queried cluster queues.
	array<object>	The details of the queue.
Type	string	The type of queue. Valid values: Execution: Queues in which jobs can be executed. Router: Queues in which jobs cannot be executed. The received jobs in the queues must be forwarded to the bound Execution queues for execution.	Execution
HostNamePrefix	string	The prefix of the hostname.	compute
QueueName	string	The name of the queue.	workq
EnableAutoGrow	boolean	Indicates whether auto scale-out is enabled for the queue. Valid values: true false	false
ResourceGroupId	string	The ID of the resource group to which the queue belongs.	rg-acfmxp7uc24****
ImageId	string	The ID of the image.	centos_7_06_64_20G_alibase_20****.vhd
HostNameSuffix	string	The suffix of the hostname.	01
SpotStrategy	string	The preemption policy of the compute nodes. Valid values: NoSpot: The instance is a regular pay-as-you-go instance. SpotWithPriceLimit: The instance is a preemptible instance for which you specify the maximum hourly price. SpotAsPriceGo: The instance is a preemptible instance for which the market price at the time of purchase is automatically used as the bid price.	NoSpot
SpotInstanceTypes	object
Instance	array<object>	The information about the preemptible instance.
	object	The information about the preemptible instance.
InstanceType	string	The instance type of the preemptible instance.	ecs.n1.tiny
SpotPriceLimit	number	The maximum hourly price of the instance. The price can be accurate to three decimal places. This parameter is valid only when the SpotStrategy parameter is set to SpotWithPriceLimit.	0.062
ComputeInstanceType	object
InstanceType	array	The instance type of the compute nodes.
	string	The instance type of compute node.	ecs.c7.xlarge
DeploymentSetId	string	The ID of the deployment set to which to deploy the instance. You can call the DescribeDeploymentSets operation to query the deployment set ID. Only the deployment sets that use low latency policies are supported.	ds-bp1frxuzdg87zh4pzq****
UseESS	boolean	Specifies whether to use scaling groups of Auto Scaling.	false
NetworkInterfaceTrafficMode	string	The communication mode of the elastic network interface (ENI). Valid values: Standard: The TCP communication mode is used. HighPerformance: The Elastic RDMA Interface (ERI) is enabled and the remote direct memory access (RDMA) communication mode is used.	Standard

Examples

Success response

JSON format

{
  "RequestId": "C6E5005C-00B0-4F27-98BB-95AB88016C22",
  "Queues": {
    "QueueInfo": [
      {
        "Type": "Execution",
        "HostNamePrefix": "compute",
        "QueueName": "workq",
        "EnableAutoGrow": false,
        "ResourceGroupId": "rg-acfmxp7uc24****",
        "ImageId": "centos_7_06_64_20G_alibase_20****.vhd",
        "HostNameSuffix": "01",
        "SpotStrategy": "NoSpot",
        "SpotInstanceTypes": {
          "Instance": [
            {
              "InstanceType": "ecs.n1.tiny",
              "SpotPriceLimit": 0.062
            }
          ]
        },
        "ComputeInstanceType": {
          "InstanceType": [
            "ecs.c7.xlarge"
          ]
        },
        "DeploymentSetId": "ds-bp1frxuzdg87zh4pzq****",
        "UseESS": false,
        "NetworkInterfaceTrafficMode": "Standard"
      }
    ]
  }
}

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.
404	ManagerNotFound	The manager nodes do not exist or their status is abnormal.	The manager nodes do not exist or their status is abnormal.
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	EcsError	An error occurred while calling the ECS API operation.	ECS API call error. %s
406	DbError	A database service error occurred.	Database request failed.
406	RedisError	A Redis service error occurred.	Redis request failed.
406	ExecFail	Failed to execute the command: %s.
406	AgentError	The agent service request failed.	The cluster-side command failed to run. %s
406	AliyunError	An Alibaba Cloud product error occurred.	Alibaba Cloud product error. %s
406	AgentResponseTimeout	Agent response timeout: %s
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.