PutBucketQoSInfo - Object Storage Service - Alibaba Cloud Documentation Center

Use PutBucketQoSInfo to set bandwidth throttling rules for a bucket within a resource pool.

Notes

Resource pool QoS is in invitational preview. If the throughput of your OSS buckets in a region has reached or exceeded 500 Gbps, you can contact technical support to apply for this feature.
An Alibaba Cloud account is granted default permissions to set bandwidth throttling for a bucket in a resource pool. To configure this via a RAM user or Security Token Service (STS), the oss:PutBucketQoSInfo permission is required. For detailed instructions, see RAM policy common examples.

Request syntax

PUT /?qosInfo HTTP/1.1
Date: GMT Date
Content-Length: ContentLength
Content-Type: application/xml
Host: BucketName.oss-cn-hangzhou.aliyuncs.com
Authorization: SignatureValue

<?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>
</QoSConfiguration>

Request headers

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

Request elements

Note

In the bandwidth configuration items below, the default value -1 indicates no limit on bucket bandwidth. A value of 0 indicates that the bandwidth type is unsupported. For instance, an ExtranetUploadBandwidth value of 0 means that uploading to the bucket over a public network is not possible.
The total bandwidth allocated to a bucket must not exceed the total bandwidth available for the resource pool or for all buckets combined. For example, if the total download bandwidth for all buckets is 100 Gbit/s, a single bucket's download bandwidth cannot surpass 100 Gbit/s.

Name	Type	Required	Example value	Description
QoSConfiguration	Container	Yes	N/A	The container that stores the bandwidth throttling rules. Parent nodes: none
TotalUploadBandwidth	Integer	Yes	10	The total upload bandwidth of the bucket. Unit: Gbit/s. Parent nodes: QoSConfiguration
IntranetUploadBandwidth	Integer	Yes	-1	The upload bandwidth over an internal network of the bucket. Internal networks include the classic network and VPC. Unit: Gbit/s. Parent nodes: QoSConfiguration
ExtranetUploadBandwidth	Integer	Yes	-1	The upload bandwidth over a public network of the bucket. Public networks include the Internet and acceleration endpoints. Unit: Gbit/s. Parent nodes: QoSConfiguration
TotalDownloadBandwidth	Integer	Yes	10	The total download bandwidth of the bucket. Unit: Gbit/s. Parent nodes: QoSConfiguration
IntranetDownloadBandwidth	Integer	Yes	-1	The download bandwidth over an internal network of the bucket. Internal networks include the classic network and VPC. Unit: Gbit/s. Parent nodes: QoSConfiguration
ExtranetDownloadBandwidth	Integer	Yes	-1	The download bandwidth over a public network of the bucket. Public networks include the Internet and acceleration endpoints. Unit: Gbit/s. Parent nodes: QoSConfiguration

Response headers

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

Examples

Request example

PUT /?qosInfo HTTP/1.1
Host: oss-example.oss-cn-hangzhou.aliyuncs.com
Content-Length: 209
Date: Fri, 27 Dec 2024 03:21:12 GMT
Authorization: OSS qn6q****:77Dv****

<?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>
</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

Command line tool ossutil

For the ossutil command related to the PutBucketQoSInfo operation, refer to put-bucket-qos-info.