All Products
Search

This Product

    Object Storage Service:get-bucket-qos-info

    Document Center

    Object Storage Service:get-bucket-qos-info

    Last Updated:Feb 06, 2025

    Queries the Quality of Service (QoS) configurations for a bucket.

    Notes

    Important

    The resource pool QoS feature 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 permission to query the QoS configurations for a bucket. Making query requests as a RAM user or by using Security Token Service (STS) requires the oss:GetBucketQoSInfo permission. For more information, see granting custom policy permissions to RAM users.

    • A value of -1 specifies that no limits are imposed on the field. If a field is not specified, the default value is -1. A value of 0 specifies that a specific type of access request is prohibited.

    Syntax

    ossutil api invoke-operation --op-name get-bucket-qos-info --method GET --bucket <bucket-name> --parameters qosInfo

    Parameter

    Type

    Description

    --bucket

    string

    Name of the bucket.

    --parameters

    stringArray

    Request parameters in the k[=v] format, such as versionId=123 and delete.

    Note

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

    Example

    The following command provides an example of how to query the QoS configurations for examplebucket.

    ossutil api invoke-operation --op-name get-bucket-qos-info --method GET --bucket examplebucket --parameters qosInfo