You can call PutResourcePoolRequesterQoSInfo to configure bandwidth throttling for requesters in a resource pool.
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 configure bandwidth throttling for requesters in a resource pool by default. If you want to configure bandwidth throttling as a RAM user or by using Security Token Service (STS), you must have the
oss:PutResourcePoolRequesterQoSInfopermission. For more information, see Common examples of RAM Policy.
Request syntax
PUT /?requesterQosInfo&resourcePool=ResourcePoolName&qosRequester=uid
Host: oss-cn-hangzhou.aliyuncs.com
Date: GMT Date
Content-Type: application/xml
Content-Length: content length
<QoSConfiguration>
<TotalUploadBandwidth>10</TotalUploadBandwidth>
<IntranetUploadBandwidth>-1</IntranetUploadBandwidth>
<ExtranetUploadBandwidth>-1</ExtranetUploadBandwidth>
<TotalDownloadBandwidth>10</TotalDownloadBandwidth>
<IntranetDownloadBandwidth>-1</IntranetDownloadBandwidth>
<ExtranetDownloadBandwidth>-1</ExtranetDownloadBandwidth>
</QoSConfiguration>Request headers
All headers in a PutResourcePoolRequesterQoSInfo request are common request headers. For more information, see Common Request Headers.
Request elements
In the following table, the default value -1 indicates that the bucket bandwidth is not limited. The value 0 indicates that the bandwidth type is not supported. For example, the value 0 for ExtranetUploadBandwidth indicates that data cannot be uploaded to the specified bucket over a public network.
The sum of bandwidth configurations for requesters cannot exceed the total bandwidth configuration of the resource pool. The individual bandwidth configuration of a requester cannot exceed the total bandwidth configuration. For example, if the total download bandwidth is configured as 100 Gbit/s, the public network download bandwidth cannot exceed 100 Gbit/s.
The individual bandwidth configuration of a requester cannot be less than 5 Gbit/s.
Name | Type | Required | Example | Description |
resourcePool | string | Yes | resource-pool-for-ai | The name of the resource pool. |
qosRequester | string | Yes | 300xxxx | The user ID (UID) of the requester. |
QoSConfiguration | container | Yes | N/A | The container that stores the bandwidth throttling rules. Parent nodes: none |
TotalUploadBandwidth | Integer | Yes | 10 | The total upload bandwidth specified by the requester for the resource pool. Unit: Gbit/s. Parent nodes: QoSConfiguration |
IntranetUploadBandwidth | Integer | Yes | -1 | The upload bandwidth over an internal network specified by the requester for the resource pool. 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 specified by the requester for the resource pool. Public networks include the Internet and acceleration endpoints. Unit: Gbit/s. Parent nodes: QoSConfiguration |
TotalDownloadBandwidth | Integer | Yes | 10 | The total download bandwidth specified by the requester for the resource pool. Unit: Gbit/s. Parent nodes: QoSConfiguration |
IntranetDownloadBandwidth | Integer | Yes | -1 | The download bandwidth over an internal network specified by the requester for the resource pool. 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 specified by the requester for the resource pool. Public networks include the Internet and acceleration endpoints. Unit: Gbit/s. Parent nodes: QoSConfiguration |
Response headers
All headers in the response to a PutResourcePoolRequesterQoSInfo request are common response headers. For more information, see Common Response Headers.
Examples
Sample requests
PUT /?requesterQosInfo&resourcePool=resource-pool-for-ai&qosRequester=300xxxx Host: oss-cn-hangzhou.aliyuncs.com Date: Fri, 27 Dec 2024 03:21:12 GMT Content-Type: application/xml Content-Length: 454 Authorization: OSS4-HMAC-SHA256 Credential=LTAI********************/20250417/cn-hangzhou/oss/aliyun_v4_request,AdditionalHeaders=content-length,Signature=a7c3554c729d71929e0b84489addee6b2e8d5cb48595adfc51868c299c0c218e <QoSConfiguration> <TotalUploadBandwidth>10</TotalUploadBandwidth> <IntranetUploadBandwidth>-1</IntranetUploadBandwidth> <ExtranetUploadBandwidth>-1</ExtranetUploadBandwidth> <TotalDownloadBandwidth>10</TotalDownloadBandwidth> <IntranetDownloadBandwidth>-1</IntranetDownloadBandwidth> <ExtranetDownloadBandwidth>-1</ExtranetDownloadBandwidth> </QoSConfiguration>Sample responses
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
SDK
The following SDKs provide the PutResourcePoolRequesterQoSInfo operation:
Command-line tool ossutil
For more information about the ossutil command that corresponds to the PutResourcePoolRequesterQoSInfo operation, see put-resource-pool-requester-qos-info.