All Products
Search
Document Center

Elastic High Performance Computing:ListQueues

Last Updated:Mar 03, 2024

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.

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:
    • The required resource types are displayed in bold characters.
    • 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.
OperationAccess levelResource typeCondition keyAssociated operation
ehpc:ListQueuesREAD
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
ClusterIdstringYes

The ID of the cluster.

ehpc-hz-FYUr32****
AsyncbooleanNo

Specifies whether to enable asynchronous query.

false

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The ID of the request.

C6E5005C-00B0-4F27-98BB-95AB88016C22
Queuesobject []

The details of the queue.

Typestring

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.
Execution
HostNamePrefixstring

The prefix of the hostname.

compute
QueueNamestring

The name of the queue.

workq
EnableAutoGrowboolean

Indicates whether the queue enabled the auto scale-out. Valid values:

  • true: The queue enabled auto scale-out.
  • false: The queue disabled auto scale-out.
false
ResourceGroupIdstring

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

rg-acfmxp7uc24****
ImageIdstring

The ID of the custom image.

centos_7_06_64_20G_alibase_20****.vhd
HostNameSuffixstring

The suffix of the host name.

01
SpotStrategystring

The preemption policy of the compute nodes. Valid values:

  • NoSpot: The instances of the compute node are pay-as-you-go instances.
  • SpotWithPriceLimit: The instance is created as a preemptible instance with a user-defined 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 bidding price.
NoSpot
SpotInstanceTypesobject []

The information about the preemptible instance.

InstanceTypestring

The instance type of the preemptible instance.

ecs.n1.tiny
SpotPriceLimitfloat

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

0.062
ComputeInstanceTypearray

The instance type of compute node.

string

The instance type of compute node.

ecs.c7.xlarge

Examples

Sample success responses

JSONformat

{
  "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": "",
        "UseESS": true,
        "NetworkInterfaceTrafficMode": ""
      }
    ]
  }
}

Error codes

HTTP status codeError codeError messageDescription
400InvalidParamsThe specified parameter %s is invalid.The specified parameter %s is invalid.
404ClusterNotFoundThe specified cluster does not exist.The specified instance does not exist.
404ManagerNotFoundThe manager nodes do not exist or their status is abnormal.The manager nodes do not exist or their status is abnormal.
406EcsErrorAn error occurred while calling the ECS API operation.An error occurred while calling the ECS API operation.
406DbErrorA database service error occurred.Database request failed.
406RedisErrorA Redis service error occurred.Redis request failed.
406ExecFailFailed to execute the command: %s.Failed to execute the command: %s.
406AgentErrorThe agent service request failed.-
406AliyunErrorAn Alibaba Cloud product error occurred.An Alibaba Cloud product error occurred.
406AgentResponseTimeoutAgent response timeout: %s-
407NotAuthorizedYou are not authorized by RAM for this request.The request is not authorized by RAM.
500UnknownErrorAn unknown error occurred.An unknown error occurred.
503ServiceUnavailableThe request has failed due to a temporary failure of the serverThe 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 timeSummary of changesOperation
2023-08-17API Description Update. The Error code has changed. The response structure of the API has changedsee changesets
Change itemChange content
API DescriptionAPI Description Update.
Error CodesThe Error code has changed.
    delete Error Codes: 400
    delete Error Codes: 404
    delete Error Codes: 406
    delete Error Codes: 407
    delete Error Codes: 500
    delete Error Codes: 503
Output ParametersThe response structure of the API has changed.
2023-06-20The Error code has changed. The response structure of the API has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    delete Error Codes: 400
    delete Error Codes: 404
    delete Error Codes: 406
    delete Error Codes: 407
    delete Error Codes: 500
    delete Error Codes: 503
Output ParametersThe response structure of the API has changed.