put-resource-pool-bucket-group-qos-info-Object Storage Service(OSS)-阿里云帮助中心

Usage notes

Important

Resource pool quality of service (QoS) is in invitational preview. If the throughput of Object Storage Service (OSS) buckets in a specific region is greater than or equal to 500 Gbit/s, contact technical support to apply for the feature.

By default, an Alibaba Cloud account has the permissions to configure throttling rules for a bucket group in a resource pool. To configure throttling rules for a bucket group in a resource pool by using a RAM user or Security Token Service (STS), you must have the oss:PutResourcePoolBucketGroupQoSInfo permission. For more information, see Attach a custom policy to a RAM user.

Syntax

ossutil api invoke-operation --op-name put-resource-pool-bucket-group-qos-info --method PUT --parameters resourcePool=<resource-pool> --parameters resourcePoolBucketGroup=<GroupName> --parameters resourcePoolBucketGroupQosInfo --body=file://<path-to-xml>

Parameter	Type	Description
--parameters	stringArray	The query parameters of the request in the k[=v] format, such as versionId=123 and delete.
--body	string	The request body. file:// specifies that the configurations are read from a file, whereas - specifies that configurations are read from standard input.

--body

The --body parameter supports the XML format. If the value of the parameter starts with file://, the configurations are loaded from a specific file.

<QoSConfiguration>
  <TotalUploadBandwidth>integer</TotalUploadBandwidth>
  <IntranetUploadBandwidth>integer</IntranetUploadBandwidth>
  <ExtranetUploadBandwidth>integer</ExtranetUploadBandwidth>
  <TotalDownloadBandwidth>integer</TotalDownloadBandwidth>
  <IntranetDownloadBandwidth>integer</IntranetDownloadBandwidth>
  <ExtranetDownloadBandwidth>integer</ExtranetDownloadBandwidth>
  <TotalQps>integer</TotalQps>
  <IntranetQps>integer</IntranetQps>
  <ExtranetQps>integer</ExtranetQps>
</QoSConfiguration>

Note

In the following table, the default value -1 specifies that the bucket bandwidth is not limited. The value 0 disables the corresponding bandwidth type. For example, the value 0 for ExtranetUploadBandwidth specifies that data cannot be uploaded to the specified bucket over a public network.
The sum of the bandwidth configurations for a bucket group cannot exceed the resource pool's total bandwidth configuration. Each individual bandwidth configuration for the bucket group cannot exceed the bucket group's total bandwidth configuration. For example, if the total download bandwidth is 10 Gbit/s, the Internet download bandwidth cannot exceed 10 Gbit/s.
The bandwidth specified for an item of a bucket group cannot be lower than 5 Gbit/s.

Parameter	Type	Required	Example	Unit	Description
TotalUploadBandwidth	Integer	Yes	10	Gbps	The total upload bandwidth. Parent nodes: QoSConfiguration
IntranetUploadBandwidth	Integer	Yes	-1	Gbps	The upload bandwidth over internal networks. The internal networks include the classic network and VPC. Unit: Gbit/s. Parent nodes: QoSConfiguration
ExtranetUploadBandwidth	Integer	Yes	-1	Gbps	The upload bandwidth over external networks. The external networks include the Internet and CDN. Parent nodes: QoSConfiguration
TotalDownloadBandwidth	Integer	Yes	10	Gbps	The total download bandwidth. Parent nodes: QoSConfiguration
IntranetDownloadBandwidth	Integer	Yes	-1	Gbps	The download bandwidth over internal networks. The internal networks include the classic network and VPC. Unit: Gbit/s. Parent nodes: QoSConfiguration
ExtranetDownloadBandwidth	Integer	Yes	-1	Gbps	The download bandwidth over external networks. The external networks include the Internet and CDN. Parent nodes: QoSConfiguration
TotalQps	Integer	Yes	10000	requests/s	The total QPS configuration. Parent node: QoSConfiguration
IntranetQps	Integer	Yes	-1	requests/s	The QPS configuration for requests from internal networks, including the classic network and VPCs. Parent node: QoSConfiguration
ExtranetQps	Integer	Yes	-1	requests/s	The QPS configuration for requests from external networks, including the Internet and CDNs. Parent node: QoSConfiguration

Note

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

Examples

Apply the specified QoS information to a bucket group named exampleGroup in a resource pool named examplePool by adding the following sample code to an XML configuration file named qos.xml:

<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>

The following items describe the parameters:

The TotalUploadBandwidth parameter is set to 10, which specifies that the total upload bandwidth is 10 Gbit/s. The total upload bandwidth over internal networks and public networks cannot exceed 10 Gbit/s.
The IntranetUploadBandwidth parameter is set to -1, which specifies that no limits are imposed on the upload bandwidth over internal networks. However, the upload bandwidth over internal networks must be less than or equal to the total upload bandwidth which is 10 Gbit/s.
The ExtranetUploadBandwidth parameter is set to -1, which specifies that no limits are imposed on the upload bandwidth over public networks. However, the upload bandwidth over public networks must be less than or equal to the total upload bandwidth which is 10 Gbit/s.
The TotalDownloadBandwidth parameter is set to 10, which specifies that the total download bandwidth is 10 Gbit/s. The total download bandwidth over internal networks and public networks cannot exceed 10 Gbit/s.
The IntranetDownloadBandwidth parameter is set to -1, which specifies that no limits are imposed on the download bandwidth over internal networks. However, the download bandwidth over internal networks must be less than or equal to the total download bandwidth which is 10 Gbit/s.
The ExtranetDownloadBandwidth parameter is set to -1, which specifies that no limits are imposed on the download bandwidth over public networks. However, the download bandwidth over public networks must be less than or equal to the total download bandwidth which is 10 Gbit/s.
The TotalQps parameter is set to 10000, which limits the total QPS to 10,000 requests per second. The combined QPS of all requests over internal and external networks cannot exceed this limit.
The IntranetQps parameter is set to -1, which imposes no separate QPS limit on requests over internal networks. However, the QPS over internal networks is still subject to the overall limit configured by TotalQps.
The ExtranetQps parameter is set to -1, which imposes no separate QPS limit on requests over external networks. However, the QPS over external networks is still subject to the overall limit configured by TotalQps.

Sample command:

ossutil api invoke-operation --op-name put-resource-pool-bucket-group-qos-info --method PUT --parameters resourcePool=examplePool --parameters resourcePoolBucketGroup=exampleGroup --parameters resourcePoolBucketGroupQosInfo --body=file://qos.xml