ListResourcePools - List OSS resource pools API - Object Storage Service

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 can access all resource pools by default. RAM users and Security Token Service (STS) tokens require the oss:ListResourcePools permission. RAM policy examples.

Request syntax

GET /?resourcePool&max-keys=10&continuation-token=abcd
Host: oss-cn-shanghai.aliyuncs.com
Date: GMT Date
Authorization: SignatureValue

Request headers

This operation uses only Common request headers.

Request elements

Name	Type	Required	Example value	Description
max-keys	Integer	No	10	Maximum number of resource pools to return.
continuation-token	String	No	abcd	Pagination token. Use the NextContinuationToken from a previous response to list additional resource pools.

Response headers

This operation only requires common response headers and does not need specific ones. For more information, see Common response headers.

Response elements

Name	Type	Example value	Description
ListResourcePoolsResult	Container	N/A	Container for the response. Parent nodes: none
Region	String	oss-cn-hangzhou	Region of the resource pool. Parent nodes: ListResourcePoolsResult
Owner	String	103xxxx	UID of the resource pool owner. Parent nodes: ListResourcePoolsResult
ContinuationToken	String	abcd	Pagination token from the request. Parent nodes: ListResourcePoolsResult
NextContinuationToken	String	xyz	Token to retrieve the next page of results. Pass this value as the continuation-token in a subsequent request. Parent nodes: ListResourcePoolsResult
IsTruncated	Boolean	true	Whether the results are truncated. true: more results available. false: all results returned. Parent nodes: ListResourcePoolsResult
ResourcePool	Container	N/A	Container for resource pool details. Parent nodes: ListResourcePoolsResult
Name	String	resource-pool-for-ai	Name of the resource pool. Parent nodes: ResourcePool
CreateTime	String	2024-11-29T08:42:32.000Z	Creation time of the resource pool in ISO 8601 format. Parent nodes: ResourcePool

Examples

Request example

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=a7c3554c729d71929e0b84489addee6b2e8d5cb48595adfc51868c299c0c218e

Success 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

Call ListResourcePools with the following OSS SDKs:

ossutil

For the ossutil command corresponding to the ListResourcePools operation, see list-resource-pools.