All Products
Search
Document Center

Object Storage Service:PutBucketRequesterQoSInfo

Last Updated:Feb 18, 2025

Use PutBucketRequesterQoSInfo to configure requester-level bandwidth throttling for a bucket.

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.

  • By default, an Alibaba Cloud account has the permission to set bandwidth throttling for requesters at the bucket level. To configure this via a RAM user or Security Token Service (STS), you must possess the oss:PutBucketRequesterQoSInfo permission. For detailed instructions, see RAM policy examples.

Request 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>-1</TotalQps>
  <IntranetQps>-1</IntranetQps>
  <ExtranetQps>-1</ExtranetQps>
</QoSConfiguration>

Request headers

This operation only requires common request headers. For more information, see Common request headers.

Request elements

Note
  • In the bandwidth configuration items below, the default value of -1 indicates no bandwidth limit. A value of 0 indicates that the bandwidth type is not supported. For instance, a value of 0 for ExtranetUploadBandwidth means that uploading data to the specified bucket over a public network is not possible.

  • The requester's bandwidth configuration at the bucket level must not exceed the bucket's total bandwidth configuration. For example, if the bucket's total download bandwidth is set to 100 Gbit/s, the requester's external network download bandwidth for that bucket cannot surpass 100 Gbit/s.

  • The minimum bandwidth limit for each requester is 5 Gbit/s.

Name

Type

Required

Example value

Description

qosRequester

String

Yes

300xxxx

The user ID (UID) of the requester模型无法生成答案,请稍后重试~```html .

Parent nodes: none

QoSConfiguration

Container

Yes

N/A

The container that stores the results.

Parent nodes: none

TotalUploadBandwidth

Integer

Yes

10

The total upload bandwidth of the requester for the bucket. Unit: Gbit/s.

Parent nodes: QoSConfiguration

IntranetUploadBandwidth

Integer

Yes

-1

The upload 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

ExtranetUploadBandwidth

Integer

Yes

-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

Yes

10

The total download bandwidth of the requester for the bucket. Unit: Gbit/s.

Parent nodes: QoSConfiguration

IntranetDownloadBandwidth

Integer

Yes

-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

Yes

-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

Response headers

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

Examples

  • Request example

    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: 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>
  • Response example

    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 corresponding to the PutBucketRequesterQoSInfo operation, refer to put-bucket-requester-qos-info.