mc qos rule list

The mc qos rule list command displays all configured Quality of Service (QoS) rules on an AIStor deployment.

The command can also be invoked using the short name ls.

For more information, see Bucket-level Quality of Service.

Syntax

Example Syntax

The command has the following syntax:

mc [GLOBALFLAGS] qos rule list TARGET

Brackets [] indicate optional parameters.
Parameters sharing a line are mutually dependent.
Parameters separated using the pipe | operator are mutually exclusive.

Copy the example to a text editor and modify as needed before running the command in the terminal/shell.

Parameters

TARGET

Required

The alias and bucket for which to list QoS rules.

For example:

mc qos rule list myaistor/mybucket

Global flags

This command supports any of the global flags.

Output

The command displays QoS rules grouped by API operation, showing:

API operation
Priority level (sorted from lowest to highest)
Object prefix
Label (if set)
Rule ID
Rate limits:
- For concurrency limit type: Rate and limit type
- For rps limit type: Rate, burst, and limit type

Example output:

QoS Configuration Rules:
API: s3.GetObject
  Priority     : 1 Object Prefix:
  Label        : GetObject rate limit   Rule ID    : rule1
  Limits       : Rate: 100, Burst: 50, Limit: rps

API: s3.List*
  Priority     : 2 Object Prefix:
  Rule ID      : rule2
  Limits       : Rate: 50, Limit: concurrency

S3 compatibility

The mc commandline tool is built for compatibility with the AWS S3 API and is tested with AIStor and AWS S3 for expected functionality and behavior.

MinIO provides no guarantees for other S3-compatible services, as their S3 API implementation is unknown and therefore unsupported.

While mc commands may work as documented, any such usage is at your own risk.

Permissions

You must have appropriate permissions on the deployment to list QoS rules.