Call ListResourcePools to retrieve information about all resource pools under the current account, including resource pool names and creation times.
Usage notes
Resource pool QoS is in invitational preview. If the throughput of your OSS buckets in a region has reached or exceeded 500 Gbit/s, you can contact technical support to apply for this feature.
An Alibaba Cloud account has the default permission to retrieve information about all resource pools under the current account. If you need to retrieve this information through a RAM user or STS, you must have the
oss:ListResourcePoolspermission. For more information, see Common examples of RAM Policy.
Request syntax
GET /?resourcePool&max-keys=10&continuation-token=abcd
Host: oss-cn-shanghai.aliyuncs.com
Date: GMT Date
Authorization: SignatureValueRequest headers
All headers in a ListResourcePools request are common request headers. For more information, see Common Request Headers.
Request elements
Name | Type | Required | Example | Description |
max-keys | Integer | No | 10 | The maximum number of resource pool entries to return. |
continuation-token | String | No | abcd | Specifies which resource pool to start returning information from. |
Response headers
All headers in the response to a ListResourcePools request are common response headers. For more information, see Common Response Headers.
Response elements
Name | Type | Example | Description |
ListResourcePoolsResult | Container | N/A | The container that stores the result of the request. Parent nodes: none |
Region | String | oss-cn-hangzhou | The region where the resource pool is located. Parent nodes: ListResourcePoolsResult |
Owner | String | 103xxxx | The unique identifier (UID) of the account to which the resource pool belongs. Parent nodes: ListResourcePoolsResult |
ContinuationToken | String | abcd | The continuationToken that is used in this ListResourcePools request. Parent nodes: ListResourcePoolsResult |
NextContinuationToken | String | xyz | Indicates that this ListResourcePools request contains subsequent results. The value of NextContinuationToken is used as the value of ContinuationToken to query subsequent results. Parent nodes: ListResourcePoolsResult |
IsTruncated | Boolean | true | Indicates whether the queried results are truncated.
Parent nodes: ListResourcePoolsResult |
ResourcePool | Container | N/A | The container that stores the resource pool listing results. Parent nodes: ListResourcePoolsResult |
Name | String | resource-pool-for-ai | The name of the resource pool. Parent nodes: ResourcePool |
CreateTime | String | 2024-11-29T08:42:32.000Z | The time when the resource pool was created. The time follows the ISO 8601 standard. Parent nodes: ResourcePool |
Examples
Sample request
GET /?resourcePool&max-keys=10&continuation-token=abcd Host: oss-cn-hangzhou.aliyuncs.com Date: Fri, 27 Dec 2024 03:21:12 GMT Authorization: OSS4-HMAC-SHA256 Credential=LTAI********************/20250417/cn-hangzhou/oss/aliyun_v4_request,Signature=a7c3554c729d71929e0b84489addee6b2e8d5cb48595adfc51868c299c0c218eSample response
HTTP/1.1 200 OK Date: Fri, 27 Dec 2024 03:21:12 GMT Content-Length: 655 Content-Type: application/xml <?xml version="1.0" encoding="UTF-8"?> <ListResourcePoolsResult> <Region>oss-cn-hangzhou</Region> <Owner>103xxxx</Owner> <ContinuationToken>abcd</ContinuationToken> <NextContinuationToken>xyz</NextContinuationToken> <IsTruncated>true</IsTruncated> <ResourcePool> <Name>resource-pool-for-ai</Name> <CreateTime>2024-11-29T08:42:32.000Z</CreateTime> </ResourcePool> <ResourcePool> <Name>resource-pool-for-video</Name> <CreateTime>2024-11-29T08:42:32.000Z</CreateTime> </ResourcePool> <ResourcePool> <Name>resource-pool-for-datalake</Name> <CreateTime>2024-11-29T08:42:32.000Z</CreateTime> </ResourcePool> </ListResourcePoolsResult>
SDK
The following SDKs are available for the ListResourcePools operation:
ossutil
For information about the ossutil command that corresponds to the ListResourcePools operation, see list-resource-pools.