You can call the GetBucketQoSInfo operation to query the throttling configuration of a bucket.
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 query the throttling configuration of a specified bucket in a resource pool by default. If you want to query the throttling configuration as a RAM user or by using Security Token Service (STS), you must have the
oss:GetBucketQoSInfopermission. For more information, see Common examples of RAM policies.
Request syntax
GET /?qosInfo HTTP/1.1
Host: BucketName.oss-cn-hangzhou.aliyuncs.com
Date: GMT Date
Authorization: SignatureValueRequest headers
All headers in a GetBucketQoSInfo request are common request headers. For more information, see Common Request Headers.
Response headers
All headers in the response to a GetBucketQoSInfo request are common response headers. For more information, see Common Response Headers.
Response elements
Name | Type | Example | Description |
QoSConfiguration | Container | N/A | The container that stores the result of the request. Parent nodes: none |
TotalUploadBandwidth | Integer | 10 | The total upload bandwidth of the bucket. Unit: Gbit/s. Parent nodes: QoSConfiguration |
IntranetUploadBandwidth | Integer | -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 | -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 | 10 | The total download bandwidth of the bucket. Unit: Gbit/s. Parent nodes: QoSConfiguration |
IntranetDownloadBandwidth | Integer | -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 | -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 |
Examples
Query example
Get /?qosInfo HTTP/1.1 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=a7c3554c729d71929e0b84489addee6b2e8d5cb48595adfc51868c299c0c218eSample response
HTTP/1.1 200 OK Date: Fri, 27 Dec 2024 03:21:12 GMT Content-Type: application/xml Content-Length: 556 Connection: keep-alive Server: AliyunOSS x-oss-request-id: 534**** <?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>
SDK
You can use the following SDKs to call the GetBucketQoSInfo operation:
Command-line tool ossutil
For information about the ossutil command that corresponds to the GetBucketQoSInfo operation, see get-bucket-qos-info.