GetBucketRequesterQoSInfo - Object Storage Service - Alibaba Cloud Documentation Center

You can call GetBucketRequesterQoSInfo to retrieve the throttling configuration of a specified requester at the bucket level.

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 permission to retrieve the throttling configuration of a specified requester at the bucket level by default. If you want to obtain the configuration by using a RAM user or Security Token Service (STS), you must have the oss:GetBucketRequesterQoSInfo permission. For more information, see Common examples of RAM policies.

Request syntax

GET /?requesterQosInfo&qosRequester=uid
Host: BucketName.oss-cn-shanghai.aliyuncs.com
Date: GMT Date
Authorization: SignatureValue

Request headers

All headers in a GetBucketRequesterQoSInfo request are common request headers. For more information, see Common request headers.

Request elements

Name	Type	Required	Example	Description
qosRequester	string	Yes	300xxxx	The user ID (UID) of the requester.

Response headers

All headers in the response to a GetBucketRequesterQoSInfo request are common response headers. For more information, see Common response headers.

Response elements

Name	Type	Example	Description
RequesterQoSInfo	container	N/A	The container that stores the result of the request. Parent nodes: none
Requester	string	300xxxx	The user ID (UID) of the requester. Parent nodes: RequesterQoSInfo
QoSConfiguration	container	N/A	The container that stores the bandwidth configuration result. Parent nodes: RequesterQoSInfo
TotalUploadBandwidth	Integer	10	The total upload bandwidth of the requester for the bucket. Unit: Gbit/s. Parent nodes: QoSConfiguration
IntranetUploadBandwidth	Integer	-1	The upload bandwidth over an internal network of the requester for the bucket. Internal networks include the classic network and virtual private cloud (VPC). Unit: Gbit/s. Parent nodes: QoSConfiguration
ExtranetUploadBandwidth	Integer	-1	The upload bandwidth over a public network of the requester for the bucket. Public networks include the Internet and acceleration endpoints. Unit: Gbit/s. Parent nodes: QoSConfiguration
TotalDownloadBandwidth	Integer	10	The total download bandwidth of the requester for the bucket. Unit: Gbit/s. Parent nodes: QoSConfiguration
IntranetDownloadBandwidth	Integer	-1	The download bandwidth over an internal network of the requester for the bucket. Internal networks include the classic network and VPC. Unit: Gbit/s. Parent nodes: QoSConfiguration
ExtranetDownloadBandwidth	Integer	-1	The download bandwidth over a public network of the requester for the bucket. Public networks include the Internet and acceleration endpoints. Unit: Gbit/s. Parent nodes: QoSConfiguration

Examples

Sample requests

GET /?requesterQosInfo&qosRequester=300xxxx
Host: oss-example.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

Sample responses

HTTP/1.1 200 OK
Date: Fri, 27 Dec 2024 03:21:12 GMT
Content-Length: 515
x-oss-request-id: 534****

<RequesterQoSInfo>
  <Requester>300xxxx</Requester>
  <QoSConfiguration>
    <TotalUploadBandwidth>10</TotalUploadBandwidth>
    <IntranetUploadBandwidth>-1</IntranetUploadBandwidth>
    <ExtranetUploadBandwidth>-1</ExtranetUploadBandwidth>
    <TotalDownloadBandwidth>10</TotalDownloadBandwidth>
    <IntranetDownloadBandwidth>-1</IntranetDownloadBandwidth>
    <ExtranetDownloadBandwidth>-1</ExtranetDownloadBandwidth>
  </QoSConfiguration>
</RequesterQoSInfo>

SDK

The following SDKs provide the GetBucketRequesterQoSInfo operation:

Command-line tool ossutil

For more information about the ossutil command that corresponds to the GetBucketRequesterQoSInfo operation, see get-bucket-requester-qos-info.