Retrieve EMR Serverless Spark Workspace Queues via API - E-MapReduce - Alibaba Cloud - E-MapReduce

Queries the queues in a workspace.

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

emr-serverless-spark:ListWorkspaceQueues

none

*All Resource

*

None

Request syntax

GET /api/v1/workspaces/{workspaceId}/queues HTTP/1.1

Path Parameters

Parameter	Type	Required	Description	Example
workspaceId	string	No	The workspace ID.	w-26ca1703f6d7****

Request parameters

Parameter	Type	Required	Description	Example
environment	string	No	The environment type. Valid values: dev : dev production : production	production
regionId	string	No	The region ID.	cn-hangzhou

Response elements

Element	Type	Description	Example
	object	The response data.
queues	array<object>	The list of queues.
	array<object>	The queue details.
regionId	string	The region ID.	cn-hangzhou
queueName	string	The queue name.	dev_queue
workspaceId	string	The workspace ID.	w-1234abcd
queueType	string	The queue type. Valid values: instance: single task type instanceChildren: parent task type	instance
properties	string	The queue label.	dev_queue
queueScope	string	The queue architecture.	{"arch": "x86"}
maxResource	string	The maximum resource capacity of the queue.	{"cpu": "2","memory": "2Gi"}
minResource	string	The minimum resource capacity of the queue.	{"cpu": "2","memory": "2Gi"}
usedResource	string	The used resource capacity of the queue.	{"cpu": "2","memory": "2Gi"}
queueStatus	string	The queue status.	RUNNING
creator	string	The UID of the creator.	237109
allowActions	array<object>	The list of allowed operations for the queue.
	object	The allowed operation for the queue.
actionArn	string	The ARN of the action.	acs:emr::workspaceId:action/create_queue
actionName	string	The permission name.	view
displayName	string	The display name of the permission.	Directory traversal and file browsing
description	string	The description of the action.	Directory traversal and file browsing
dependencies	array	The list of dependencies for the action.	["view"]
	string	The dependency of the action.	view
environments	array	The list of environment types for the queue.
	string	The environment type of the queue.	production
paymentType	string	The billing method. Valid values: PayAsYouGo: pay-as-you-go Pre: subscription	PayAsYouGo
createTime	integer	The time when the workspace was created. The value is a UNIX timestamp in milliseconds.	1684115879955
preheat	boolean	Specifies whether resource prefetching is performed.	true
queueCategory	string	The queue category, such as CPU or GPU.	CPU
gpuSpec	array	The list of GPU instance types.
	string	The GPU instance type.	ecs.gn7i-c8g1.2xlarge
gpuMachineNum	integer	The number of GPU machines.	0
instanceId	string	The ID of the resource instance associated with the queue.
description	string	The description.	test queue
requestId	string	The request ID.	DD6B1B2A-5837-5237-ABE4-FF0C8944****
nextToken	string	The token for the next page.	1
maxResults	integer	The maximum number of records to return per request.	20
totalCount	integer	The total number of records.	200

Examples

Success response

JSON format

{
  "queues": [
    {
      "regionId": "cn-hangzhou",
      "queueName": "dev_queue",
      "workspaceId": "w-1234abcd",
      "queueType": "instance",
      "properties": "dev_queue",
      "queueScope": "{\"arch\": \"x86\"}",
      "maxResource": "{\"cpu\": \"2\",\"memory\": \"2Gi\"}",
      "minResource": "{\"cpu\": \"2\",\"memory\": \"2Gi\"}",
      "usedResource": "{\"cpu\": \"2\",\"memory\": \"2Gi\"}",
      "queueStatus": "RUNNING",
      "creator": "237109",
      "allowActions": [
        {
          "actionArn": "acs:emr::workspaceId:action/create_queue",
          "actionName": "view",
          "displayName": "File directory traversal, file browsing",
          "description": "Directory traversal and file browsing",
          "dependencies": [
            "view"
          ]
        }
      ],
      "environments": [
        "production"
      ],
      "paymentType": "PayAsYouGo",
      "createTime": 1684115879955,
      "preheat": true,
      "queueCategory": "CPU",
      "gpuSpec": [
        "ecs.gn7i-c8g1.2xlarge"
      ],
      "gpuMachineNum": 0,
      "instanceId": "",
      "description": "test queue"
    }
  ],
  "requestId": "DD6B1B2A-5837-5237-ABE4-FF0C8944****",
  "nextToken": "1",
  "maxResults": 20,
  "totalCount": 200
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.