ListPools-阿里云帮助中心

Queries the list of resource pools.

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:ListPools

list

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
Filter	object	No	The filter conditions for querying resource pools.
PoolName	array	No	The list of resource pool names to query.	["MyPool"]
	string	No	The resource pool name. The name can be up to 15 characters in length. The name can contain digits, uppercase letters, lowercase letters, underscores (_), and periods (.).	PoolTest
Status	array	No	The list of resource pool statuses to query.	["Working"]
	string	No	The resource pool status. Valid values: Creating: The resource pool is being created. Updating: The resource pool is being updated. Deleting: The resource pool is being deleted. Working: The resource pool is working. Deleted: The resource pool is deleted.	Working
TimeCreatedBefore	integer	No	The UNIX timestamp. Only resource pools created before the specified time are queried. The time is converted to a UNIX timestamp based on the time zone of the region where the resource pool resides. For regions in the Chinese mainland, the time zone is UTC+8.	1703820113
TimeCreatedAfter	integer	No	The UNIX timestamp. Only resource pools created after the specified time are queried. The time is converted to a UNIX timestamp based on the time zone of the region where the resource pool resides. For regions in the Chinese mainland, the time zone is UTC+8.	1703819914
PageSize	integer	No	The number of entries per page in a paging query. Maximum value: 50. Default value: 10.	10
PageNumber	integer	No	The current page number. Default value: 1.	1

Response elements

Element	Type	Description	Example
	object	Schema of Response
RequestId	string	Id of the request	896D338C-E4F4-41EC-A154-D605E5DE****
PageSize	integer	The number of entries per page in a paging query. Maximum value: 50. Default value: 10.	10
PageNumber	integer	The current page number. Default value: 1.	1
TotalCount	integer	The total number of entries.	2
PoolList	array<object>	The list of resource pools.
	array<object>	The information about a single resource pool in the list.
PoolName	string	The resource pool name. The name can be up to 15 characters in length. The name can contain digits, uppercase letters, lowercase letters, underscores (_), and periods (.).	PoolTest
Status	string	The resource pool status. Valid values: Creating: The resource pool is being created. Updating: The resource pool is being updated. Deleting: The resource pool is being deleted. Working: The resource pool is working. Deleted: The resource pool is deleted.	Working
Priority	integer	The priority of the resource pool. Valid values: 1 to 99. Default value: 1, which indicates the lowest priority. Jobs submitted to a resource pool with a higher priority level are scheduled before pending jobs in a resource pool with a lower priority level. The priority level of a resource pool takes precedence over the priority of a job.	1
IsDefault	boolean	Specifies whether the resource pool is the default resource pool. Valid values: true: Yes. false: No.	true
MaxExecutorNum	integer	The number of running executor nodes in a resource pool.	100
SchedulingPolicyId	string	The ID of the scheduling policy.	policy-xxx
CreateTime	string	The time when the resource pool was created. The time is in the YYYY-MM-DD HH:mm:ss format.	2026-04-20 11:09:59
UpdateTime	string	The time when the resource pool was updated. The time is in the YYYY-MM-DD HH:mm:ss format.	2026-04-20 11:09:59
Tags	array<object>	The tag information.
	object	The tag information.
Key	string	The tag key.	TestKey
Value	string	The tag value.	TestValue

Examples

Success response

JSON format

{
  "RequestId": "896D338C-E4F4-41EC-A154-D605E5DE****",
  "PageSize": 10,
  "PageNumber": 1,
  "TotalCount": 2,
  "PoolList": [
    {
      "PoolName": "PoolTest",
      "Status": "Working",
      "Priority": 1,
      "IsDefault": true,
      "MaxExecutorNum": 100,
      "SchedulingPolicyId": "policy-xxx",
      "CreateTime": "2026-04-20 11:09:59",
      "UpdateTime": "2026-04-20 11:09:59",
      "Tags": [
        {
          "Key": "TestKey",
          "Value": "TestValue"
        }
      ]
    }
  ]
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidParams	The specified parameter %s is invalid.	The specified parameter %s is invalid.
407	NotAuthorized	No authorization is granted.	No authorization is granted.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.