PutBucketRequesterQoSInfo

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 this permission by default. RAM users or STS-based access requires the oss:PutBucketRequesterQoSInfo permission. RAM policy examples.

Syntax

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

<QoSConfiguration>
  <TotalUploadBandwidth>10</TotalUploadBandwidth>
  <IntranetUploadBandwidth>-1</IntranetUploadBandwidth>
  <ExtranetUploadBandwidth>-1</ExtranetUploadBandwidth>
  <TotalDownloadBandwidth>10</TotalDownloadBandwidth>
  <IntranetDownloadBandwidth>-1</IntranetDownloadBandwidth>
  <ExtranetDownloadBandwidth>-1</ExtranetDownloadBandwidth>
  <TotalQps>10000</TotalQps>
  <IntranetQps>-1</IntranetQps>
  <ExtranetQps>-1</ExtranetQps>
</QoSConfiguration>

Request headers

This operation uses only Common request headers.

Request parameters

Note

A value of -1 (the default value) means no bandwidth limit. A value of 0 disables the bandwidth type. For example, ExtranetUploadBandwidth set to 0 blocks public-network uploads to the bucket.
A requester's bandwidth configuration at the bucket level cannot exceed the bucket's total bandwidth configuration. For example, if the bucket's total download bandwidth is 100 Gbit/s, a requester's Internet download bandwidth for the bucket cannot exceed 100 Gbit/s.
Each bandwidth threshold must be at least 5 Gbit/s.

Parameter	Type	Required	Example	Description
qosRequester	String	Yes	300xxxx	User ID (UID) of the requester. Parent nodes: none
QoSConfiguration	Container	Yes	N/A	Container that stores the results. Parent nodes: none
TotalUploadBandwidth	Integer	Yes	10	Total upload bandwidth of the requester for the bucket. Unit: Gbit/s. Parent node: QoSConfiguration
IntranetUploadBandwidth	Integer	Yes	-1	Internal-network upload bandwidth for the requester on this bucket. Internal networks include classic network and VPC. Unit: Gbit/s. Parent node: QoSConfiguration
ExtranetUploadBandwidth	Integer	Yes	-1	Public-network upload bandwidth for the requester on this bucket. Public networks include the Internet and acceleration endpoints. Unit: Gbit/s. Parent node: QoSConfiguration
TotalDownloadBandwidth	Integer	Yes	10	Total download bandwidth of the requester for the bucket. Unit: Gbit/s. Parent node: QoSConfiguration
IntranetDownloadBandwidth	Integer	Yes	-1	Internal-network download bandwidth for the requester on this bucket. Internal networks include classic network and VPC. Unit: Gbit/s. Parent node: QoSConfiguration
ExtranetDownloadBandwidth	Integer	Yes	-1	Public-network download bandwidth for the requester on this bucket. Public networks include the Internet and acceleration endpoints. Unit: Gbit/s. Parent node: QoSConfiguration
TotalQps	Integer	No	10000	The total QPS configuration. Parent node: QoSConfiguration
IntranetQps	Integer	No	-1	The QPS configuration for requests from internal networks, including the classic network and VPCs. Parent node: QoSConfiguration
ExtranetQps	Integer	No	-1	The QPS configuration for requests from external networks, including the Internet and CDNs. Parent node: QoSConfiguration

Response headers

This operation returns only common response headers. For more information, see Common response headers.

Example

Sample request

PUT /?requesterQosInfo&qosRequester=300xxxx
Host: oss-example.oss-cn-hangzhou.aliyuncs.com
Content-Length: 209
Date: Fri, 27 Dec 2024 03:21:12 GMT
Authorization: OSS4-HMAC-SHA256 Credential=LTAI********************/20250417/cn-hangzhou/oss/aliyun_v4_request,AdditionalHeaders=content-length,Signature=a7c3554c729d71929e0b84489addee6b2e8d5cb48595adfc51868c299c0c218e

<?xml version="1.0" encoding="UTF-8"?>
<QoSConfiguration>
  <TotalUploadBandwidth>10</TotalUploadBandwidth>
  <IntranetUploadBandwidth>-1</IntranetUploadBandwidth>
  <ExtranetUploadBandwidth>-1</ExtranetUploadBandwidth>
  <TotalDownloadBandwidth>10</TotalDownloadBandwidth>
  <IntranetDownloadBandwidth>-1</IntranetDownloadBandwidth>
  <ExtranetDownloadBandwidth>-1</ExtranetDownloadBandwidth>
  <TotalQps>10000</TotalQps>
  <IntranetQps>-1</IntranetQps>
  <ExtranetQps>-1</ExtranetQps>
</QoSConfiguration>

Sample response

HTTP/1.1 200 OK
x-oss-request-id: 534****
Date: Fri, 27 Dec 2024 03:21:12 GMT
Content-Length: 0
Connection: keep-alive
Server: AliyunOSS

OSS SDKs

OSS SDKs that support this operation:

ossutil

For the corresponding ossutil command, see Put-bucket-requester-qos-info.