ListResourcePoolBucketGroupQoSInfos - Object Storage Service

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.
By default, an Alibaba Cloud account has full permissions on its resources. To list resources as a RAM user or RAM role, the Alibaba Cloud account or the administrator must grant the oss:ListResourcePoolBucketGroupQoSInfos permission by using RAM Policy or Bucket Policy.

Request syntax

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

Request headers

This operation uses only common request headers. For more information, see Common Request Headers.

Request elements

Name	Type	Required	Example	Description
resourcePool	String	Yes	resource-pool-for-ai	The name of the resource pool.
max-keys	Integer	No	2	The maximum number of bucket groups to return.
continuation-token	String	No	abcd	The bucket group from which to start listing.

Response headers

This operation uses only common response headers. For more information, see Common Response Headers.

Response elements

Name	Type	Example	Description
ListResourcePoolBucketGroupQoSInfosResult	Container	None	The container that stores the throttling configurations of bucket groups in the resource pool. Parent nodes: none
ResourcePool	String	test-group	The name of the resource pool. Parent nodes: ListResourcePoolBucketGroupQoSInfosResult
ContinuationToken	String	1105678	The continuation token included in this request. Parent nodes: ListResourcePoolBucketGroupQoSInfosResult
NextContinuationToken	String	3105678	Indicates that this request contains subsequent results. The value of NextContinuationToken is used as the continuation-token parameter to retrieve the next page of results. Parent nodes: ListResourcePoolBucketGroupQoSInfosResult
IsTruncated	Boolean	true	Indicates whether the queried results are truncated. true indicates that not all results are returned this time. false indicates that all results are returned this time. Parent nodes: ListResourcePoolBucketGroupQoSInfosResult
ResourcePoolBucketGroupQoSInfo	Container	None	The container that stores the throttling configurations of bucket groups in the resource pool. Parent nodes: ListResourcePoolBucketGroupQoSInfosResult
BucketGroup	String	test-group	The name of the bucket group. Parent nodes: ResourcePoolBucketGroupQoSInfo
QoSConfiguration	Container	None	The container for the throttling configuration. Parent nodes: ResourcePoolBucketGroupQoSInfo
TotalUploadBandwidth	Integer	10	The total upload bandwidth of the bucket group. Unit: Gbps. Parent nodes: QoSConfiguration
IntranetUploadBandwidth	Integer	-1	The internal upload bandwidth of the bucket group, including the internal upload bandwidth of the classic network and VPC network. Unit: Gbps. Parent nodes: QoSConfiguration
ExtranetUploadBandwidth	Integer	-1	The external upload bandwidth of the bucket group, including the upload bandwidth of the public network and acceleration endpoint. Unit: Gbps. Parent nodes: QoSConfiguration
TotalDownloadBandwidth	Integer	10	The total download bandwidth of the bucket group. Unit: Gbps. Parent nodes: QoSConfiguration
IntranetDownloadBandwidth	Integer	-1	The internal download bandwidth of the bucket group, including the internal download bandwidth of the classic network and VPC network. Unit: Gbps. Parent nodes: QoSConfiguration
ExtranetDownloadBandwidth	Integer	-1	The external download bandwidth of the bucket group, including the download bandwidth of the public network and acceleration endpoint. Unit: Gbps. Parent nodes: QoSConfiguration

Examples

Sample request

GET /?resourcePoolBucketGroupQosInfo&resourcePool=resource-pool-for-ai&continuation-token=1105678&max-keys=2
Host: oss-cn-shanghai.aliyuncs.com
Date: Sun, 11 Aug 2024 17:45:00 GMT
Authorization: SignatureValue

Sample responses

HTTP/1.1 200 OK
Date: Sun, 11 Aug 2024 17:45:00 GMT
Content-Length: 1386
x-oss-request-id: 534B************

<?xml version="1.0" encoding="UTF-8"?>
<ListResourcePoolBucketGroupQoSInfosResult>
  <ResourcePool>resource-pool-for-ai</ResourcePool>
  <ContinuationToken>1105678</ContinuationToken>
  <NextContinuationToken>3105678</NextContinuationToken>
  <IsTruncated>true</IsTruncated>
  <ResourcePoolBucketGroupQoSInfo>
    <BucketGroup>test-group</BucketGroup>
    <QoSConfiguration>
      <TotalUploadBandwidth>10</TotalUploadBandwidth>
      <IntranetUploadBandwidth>-1</IntranetUploadBandwidth>
      <ExtranetUploadBandwidth>-1</ExtranetUploadBandwidth>
      <TotalDownloadBandwidth>10</TotalDownloadBandwidth>
      <IntranetDownloadBandwidth>-1</IntranetDownloadBandwidth>
      <ExtranetDownloadBandwidth>-1</ExtranetDownloadBandwidth>
    </QoSConfiguration>
  </ResourcePoolBucketGroupQoSInfo>
  <ResourcePoolBucketGroupQoSInfo>
    <BucketGroup>test-group-02<BucketGroup/>
    <QoSConfiguration>
      <TotalUploadBandwidth>10</TotalUploadBandwidth>
      <IntranetUploadBandwidth>-1</IntranetUploadBandwidth>
      <ExtranetUploadBandwidth>-1</ExtranetUploadBandwidth>
      <TotalDownloadBandwidth>10</TotalDownloadBandwidth>
      <IntranetDownloadBandwidth>-1</IntranetDownloadBandwidth>
      <ExtranetDownloadBandwidth>-1</ExtranetDownloadBandwidth>
    </QoSConfiguration>
  </ResourcePoolBucketGroupQoSInfo>
</ListResourcePoolBucketGroupQoSInfosResult>

SDK

The following SDKs support this operation: