Queries the queues of a specified cluster.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes ListQueues

The operation that you want to perform. Set the value to ListQueues.

ClusterId String Yes ehpc-hz-FYUr32****

The ID of the cluster where the application resides.

Response parameters

Parameter Type Example Description
RequestId String C6E5005C-00B0-4F27-98BB-95AB88016C22

The ID of the request.

Queues Array of QueueInfo

The array of information about queues.

QueueInfo
ComputeInstanceType List ecs.n1.tiny

The instance type of the compute node.

EnableAutoGrow Boolean false

Indicates whether auto scaling is enabled for the queue. Valid values:

  • true: Auto scaling is enabled for the queue.
  • false: Auto scaling is disabled for the queue.
HostNamePrefix String compute

The prefix of the host name.

HostNameSuffix String 01

The suffix of the host name.

ImageId String centos_7_06_64_20G_alibase_20****.vhd

The ID of the image.

QueueName String workq

The name of the queue.

ResourceGroupId String rg-acfmxp7uc24****

The ID of the resource group to which the queue belongs.

SpotInstanceTypes Array of Instance

The array of preemptible instances.

Instance
InstanceType String ecs.n1.tiny

The instance type.

SpotPriceLimit Float 0.062

The maximum hourly price of the preemptible instance. The value can be accurate to three decimal places. This parameter is valid only when the SpotStrategy parameter is set to SpotWithPriceLimit.

SpotStrategy String SpotWithPriceLimit

The preemption policy for compute nodes. Valid value:

  • NoSpot: The instances of the compute node are pay-as-you-go instances.
  • SpotWithPriceLimit: The instances of the compute node are preemptible instances. These types of instances have a specified maximum hourly price.
  • SpotAsPriceGo: The instances of the compute node are preemptible instances. The price of these instances is based on the current market price.
Type String Execution

The type of queue. Valid values:

  • Execution: Queues in which jobs can be executed.
  • Router: Queues in which jobs cannot be executed but are forwarded to the bounded Execution queue for processing.

Examples

Sample requests

https://ehpc.cn-hangzhou.aliyuncs.com/?Action=ListQueues
&ClusterId=ehpc-hz-FYUr32****
&<Common request parameters>

Sample responses

XML format

<ListQueuesResponse>
      <RequestId>C6E5005C-00B0-4F27-98BB-95AB88016C22</RequestId>
      <Queues>
            <QueueInfo>
                  <HostNameSuffix>01</HostNameSuffix>
                  <EnableAutoGrow>false</EnableAutoGrow>
                  <SpotInstanceTypes>
            </SpotInstanceTypes>
                  <ImageId>centos_7_06_64_20G_alibase_20****.vhd</ImageId>
                  <HostNamePrefix>compute</HostNamePrefix>
                  <QueueName>workq</QueueName>
                  <ResourceGroupId>rg-acfmxp7uc24****</ResourceGroupId>
                  <SpotStrategy>SpotWithPriceLimit</SpotStrategy>
                  <SpotPriceLimit>0.062</SpotPriceLimit>
                  <Type>Execution</Type>
                  <ComputeInstanceType>
                        <InstanceType>ecs.n1.small</InstanceType>
                  </ComputeInstanceType>
            </QueueInfo>
      </Queues>
</ListQueuesResponse>

JSON format

{
    "RequestId": "C6E5005C-00B0-4F27-98BB-95AB88016C22",
    "Queues":{
        "QueueInfo": [
            {
				"HostNameSuffix": "01",
				"EnableAutoGrow": false,
				"SpotInstanceTypes": {
					"Instance": []
				},
				"ImageId": "centos_7_06_64_20G_alibase_20****.vhd",
				"HostNamePrefix": "compute",
				"QueueName": "workq",
                "ResourceGroupId": "rg-acfmxp7uc24****",
				"SpotStrategy": "SpotWithPriceLimit",
                "SpotPriceLimit": "0.062",
                "Type": "Execution",
				"ComputeInstanceType": {
					"InstanceType": [
						"ecs.n1.small"
					]
				}
			}
        ]
    }
}

Error codes

HttpCode Error code Error message Description
503 ServiceUnavailable The request has failed due to a temporary failure of the server The error message returned because the request has failed. The server is temporarily unavailable.

For a list of error codes, visit the API Error Center.