mc qos rule export

The mc qos rule export command exports the Quality of Service (QoS) configuration from a bucket on an AIStor deployment in YAML format.

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

Syntax

Example Syntax

The command has the following syntax:

mc [GLOBALFLAGS] qos rule export 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 the QoS rule.

The target cannot include wildcards.

For example:

mc qos rule export myaistor/mybucket > qos.yaml

Global flags

This command supports any of the global flags.

Examples

Export QoS configuration to a file

The following command exports the QoS configuration from the myaistor/mybucket bucket to a file:

mc qos rule export myaistor/mybucket > qos.yaml

Display QoS configuration to `STDOUT`

The following command exports the QoS configuration in YAML format to STDOUT:

mc qos rule export myaistor/mybucket

Output format

The command exports the QoS configuration in YAML format. The output includes:

version - The QoS configuration version
rules - An array of QoS rules, each containing:
- id - The rule identifier
- api - The API operation
- objectPrefix - The object prefix if set
- priority - The priority level
- rate - The rate limit value
- burst - The burst limit for rps limit type
- limit - The limit type, one of rps or concurrency
- label - The rule label if set

Example output:

version: v1
rules:
  - id: rule1
    api: s3.GetObject
    objectPrefix: ""
    priority: 1
    rate: 100
    burst: 50
    limit: rps
    label: "GetObject rate limit"
  - id: rule2
    api: s3.List*
    objectPrefix: ""
    priority: 2
    rate: 50
    burst: 0
    limit: concurrency
    label: ""

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 export QoS configuration.