DocsICP FilingConsole
Documentation
Home Page Object Storage Service Developer Reference API reference Operations related to the resource pool QoS Requester QoS PutResourcePoolRequesterQoSInfo

PutResourcePoolRequesterQoSInfo

Updated at:
Copy as MD
Product
My Favorites

Configures throttling for a requester 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 400 Gbit/s, you can contact technical support to apply for this feature.

  • By default, an Alibaba Cloud account has the permissions to configure throttling for requesters in a resource pool. If you want to use a Resource Access Management (RAM) user or Security Token Service (STS) to perform this operation, you must have the oss:PutResourcePoolRequesterQoSInfo permission. For more information, see RAM policy examples.

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

Request headers

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

Request elements

Note

  • For the following bandwidth configuration items, a value of -1 (the default value) indicates that the bandwidth is not limited. A value of 0 indicates that the bandwidth type is disabled. For example, if you set ExtranetUploadBandwidth to 0, you cannot upload data to the specified bucket over the Internet.

  • The sum of a requester's bandwidth configurations cannot exceed the resource pool's total bandwidth configuration. Each individual bandwidth configuration for the requester cannot exceed the requester's total bandwidth configuration. For example, if the total download bandwidth is 100 Gbps, the Internet download bandwidth cannot exceed 100 Gbps.

  • The configuration for a single bandwidth type for a requester cannot be less than 5 Gbps.

Name

Type

Required

Example

Description

resourcePool

String

Yes

resource-pool-for-ai

The name of the resource pool.

qosRequester

String

Yes

300xxxx

The UID of the requester.

QoSConfiguration

Container

Yes

N/A

The container for the QoS configuration.

Parent node: None

TotalUploadBandwidth

Integer

Yes

10

The total upload bandwidth for the requester at the resource pool level. Unit: Gbps.

Parent node: QoSConfiguration

IntranetUploadBandwidth

Integer

Yes

-1

The internal network upload bandwidth for the requester at the resource pool level. This includes the upload bandwidth over the classic network and VPCs. Unit: Gbps.

Parent node: QoSConfiguration

ExtranetUploadBandwidth

Integer

Yes

-1

The public network upload bandwidth for the requester at the resource pool level. This includes the upload bandwidth over the public network and acceleration endpoints. Unit: Gbps.

Parent node: QoSConfiguration

TotalDownloadBandwidth

Integer

Yes

10

The total download bandwidth for the requester at the resource pool level. Unit: Gbps.

Parent node: QoSConfiguration

IntranetDownloadBandwidth

Integer

Yes

-1

The internal network download bandwidth for the requester at the resource pool level. This includes the download bandwidth over the classic network and VPCs. Unit: Gbps.

Parent node: QoSConfiguration

ExtranetDownloadBandwidth

Integer

Yes

-1

The public network download bandwidth for the requester at the resource pool level. This includes the download bandwidth over the public network and acceleration endpoints. Unit: Gbps.

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 uses only common response headers. For more information, see Common response headers.

Examples

  • Request example

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

SDK

The following SDKs support this operation:

ossutil command-line interface

For the corresponding ossutil command, see put-resource-pool-requester-qos-info.

Previous：DeleteBucketRequesterQoSInfoNext：GetResourcePoolRequesterQoSInfo