put-bucket-requester-qos-info

Usage notes

Important

Resource pool QoS is in invitational preview. If OSS throughput in a region reaches 500 Gbit/s or higher, contact technical support to apply.

Alibaba Cloud accounts have this permission by default. RAM users and STS require the oss:PutBucketRequesterQoSInfo permission. For more information, see Grant a custom policy.
Each item cannot exceed the bucket-level bandwidth throttling limits.
A value of -1 means no limit is imposed (default if unspecified). A value of 0 prohibits that type of access.
Subitem values cannot exceed the parent total. For example, if total upload bandwidth is 10 Gbit/s, internal upload bandwidth cannot exceed 10 Gbit/s.
Requester bandwidth throttling cannot be lower than 5 Gbit/s. For example, upload bandwidth must be at least 5 Gbit/s.
Each bucket supports bandwidth throttling for up to 300 RAM users.

Syntax

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

Parameter	Type	Description
--bucket	string	Bucket name.
--parameters	stringArray	Request parameters in k[=v] format, such as versionId=123 and delete.
--body	string	The request body. file:// reads from a file. - reads from stdin.

--body

The --body parameter accepts XML. Values starting with file:// load from the specified file.

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

Parameter	Type	Required	Example	Unit	Description
TotalUploadBandwidth	Integer	Yes	10	Gbps	Total upload bandwidth. Parent node: QoSConfiguration
IntranetUploadBandwidth	Integer	Yes	-1	Gbps	Upload bandwidth over internal networks, including the classic network and VPCs. Parent node: QoSConfiguration
ExtranetUploadBandwidth	Integer	Yes	-1	Gbps	Upload bandwidth over external networks, including the Internet and CDN. Parent node: QoSConfiguration
TotalDownloadBandwidth	Integer	Yes	10	Gbps	Total download bandwidth. Parent node: QoSConfiguration
IntranetDownloadBandwidth	Integer	Yes	-1	Gbps	Download bandwidth over internal networks, including the classic network and VPCs. Parent node: QoSConfiguration
ExtranetDownloadBandwidth	Integer	Yes	-1	Gbps	Download bandwidth over external networks, including the Internet and CDN. Parent node: QoSConfiguration

Note

For more information about supported global command-line options, see Global command-line options.

Examples

Configure QoS for requester 202835923910178018 in bucket examplebucket. Create a file named 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>

Parameter descriptions:

TotalUploadBandwidth is set to 10 (10 Gbit/s). Internal and public upload bandwidth combined cannot exceed this value.
IntranetUploadBandwidth is set to -1 (no limit), but cannot exceed the total upload bandwidth of 10 Gbit/s.
ExtranetUploadBandwidth is set to -1 (no limit), but cannot exceed the total upload bandwidth of 10 Gbit/s.
TotalDownloadBandwidth is set to 10 (10 Gbit/s). Internal and public download bandwidth combined cannot exceed this value.
IntranetDownloadBandwidth is set to -1 (no limit), but cannot exceed the total download bandwidth of 10 Gbit/s.
ExtranetDownloadBandwidth is set to -1 (no limit), but cannot exceed the total download bandwidth of 10 Gbit/s.

Sample command:

ossutil api invoke-operation --op-name put-bucket-requester-qos-info --method PUT --bucket=examplebucket --parameters requesterQosInfo --parameters qosRequester=202835923910178018 --body file://qos.xml