Use put-resource-pool-requester-qos-info to configure requester bandwidth throttling in a resource pool - Object Storage Service

Set per-requester bandwidth throttling for a RAM user in a resource pool.

Important

Resource pool quality of service (QoS) is in invitational preview. To apply, contact technical support. The feature is available only when the throughput of Object Storage Service (OSS) buckets in a specific region is 500 Gbit/s or higher.

Prerequisites

Before you begin, ensure that you have:

The oss:PutResourcePoolRequesterQoSInfo permission, if you are configuring bandwidth throttling by using another RAM user or Security Token Service (STS). Alibaba Cloud accounts have this permission by default. For more information, see Attach a custom policy to a RAM user

Syntax

ossutil api invoke-operation --op-name put-resource-pool-requester-qos-info --method PUT --parameters resourcePool=<resource-pool> --parameters qosRequester=<uid> --parameters requesterQosInfo --body=file://<path-to-xml>

Parameter	Type	Description
`--parameters`	stringArray	Request parameters in the `key[=value]` format, such as `versionId=123` or `delete`.
`--body`	string	Request body. Use `file://<path>` to load from a file, or `-` to read from stdin.

For all supported global options, see Global command-line options.

Request body

The --body parameter accepts an XML file with the following structure:

<QoSConfiguration>
  <TotalUploadBandwidth>integer</TotalUploadBandwidth>
  <IntranetUploadBandwidth>integer</IntranetUploadBandwidth>
  <ExtranetUploadBandwidth>integer</ExtranetUploadBandwidth>
  <TotalDownloadBandwidth>integer</TotalDownloadBandwidth>
  <IntranetDownloadBandwidth>integer</IntranetDownloadBandwidth>
  <ExtranetDownloadBandwidth>integer</ExtranetDownloadBandwidth>
</QoSConfiguration>

All six fields are required. Unit: Gbit/s.

Parameter	Required	Description	Example
`TotalUploadBandwidth`	Yes	Total upload bandwidth cap. Internal and external network upload combined cannot exceed this value. Parent: `QoSConfiguration`	`10`
`IntranetUploadBandwidth`	Yes	Upload bandwidth cap for internal networks (classic network and VPC). Parent: `QoSConfiguration`	`-1`
`ExtranetUploadBandwidth`	Yes	Upload bandwidth cap for external networks (Internet and CDN). Parent: `QoSConfiguration`	`-1`
`TotalDownloadBandwidth`	Yes	Total download bandwidth cap. Internal and external network download combined cannot exceed this value. Parent: `QoSConfiguration`	`10`
`IntranetDownloadBandwidth`	Yes	Download bandwidth cap for internal networks (classic network and VPC). Parent: `QoSConfiguration`	`-1`
`ExtranetDownloadBandwidth`	Yes	Download bandwidth cap for external networks (Internet and CDN). Parent: `QoSConfiguration`	`-1`

Special values:

-1: No limit. If a field is omitted, it defaults to -1. The sub-field still cannot exceed its parent total.
0: Block that traffic type entirely.

Usage notes

Each field value cannot exceed the bandwidth throttling configuration of the bucket.
Sub-field values cannot exceed their parent total. For example, if TotalUploadBandwidth is 10 (10 Gbit/s), then IntranetUploadBandwidth cannot exceed 10 Gbit/s.
The minimum bandwidth limit is 5 Gbit/s. For example, TotalUploadBandwidth must be at least 5 (5 Gbit/s).
A single bucket supports bandwidth throttling for up to 300 RAM users.

Example

Set TotalUploadBandwidth and TotalDownloadBandwidth to 10 Gbit/s each for requester 202835923910178019 in the examplePool resource pool, with no sub-limits on internal or external network traffic.

Step 1: Create qos.xml with the following content.

<QoSConfiguration>
  <TotalUploadBandwidth>10</TotalUploadBandwidth>
  <IntranetUploadBandwidth>-1</IntranetUploadBandwidth>
  <ExtranetUploadBandwidth>-1</ExtranetUploadBandwidth>
  <TotalDownloadBandwidth>10</TotalDownloadBandwidth>
  <IntranetDownloadBandwidth>-1</IntranetDownloadBandwidth>
  <ExtranetDownloadBandwidth>-1</ExtranetDownloadBandwidth>
</QoSConfiguration>

This configuration sets a 10 Gbit/s cap on both total upload and total download. The -1 values on the internal and external sub-fields mean no additional sub-limits — traffic from all networks shares the 10 Gbit/s total cap.

Step 2: Run the following command.

ossutil api invoke-operation --op-name put-resource-pool-requester-qos-info --method PUT --parameters resourcePool=examplePool --parameters qosRequester=202835923910178019 --parameters requesterQosInfo --body=file://qos.xml