minio/docs
1
0
Fork 0
mirror of https://github.com/minio/docs.git synced 2025-07-30 07:03:26 +03:00
Code Activity
Files
rename
docs/source/reference/minio-mc/mc-ilm-rule-ls.rst
Andrea Longo 874b56eaeb Partial update for mc RELEASE.2023-05-26T23-31-54Z (#877) 
Update reference docs for recent changes:

* `mc admin user svcacct ls` service account expiration date
* `mc ilm rule ls`  `updateAt` policy mod time

Staged:

http://192.241.195.202:9000/staging/DOCS-866/linux/html/reference/minio-mc-admin/mc-admin-user-svcacct-list.html

file:///Users/andrealongo/repos/docs/build/DOCS-866/linux/html/reference/minio-mc/mc-ilm-rule-ls.html#show-policy-modification-time

Partially addresses https://github.com/minio/docs/issues/866
2023-06-09 14:51:19 -06:00

9.1 KiB
Raw Permalink Blame History

mc ilm rule ls

minio

Table of Contents

mc ilm rule list

mc ilm rule ls

RELEASE.2022-12-24T15-21-38Z

mc ilm rule ls replaces mc ilm ls.

RELEASE.2023-05-26T23-31-54Z

mc ilm rule ls --JSON output includes the policy modification time in updateAt.

Syntax

The mc ilm rule ls command summarizes all configured object lifecycle management rules on a MinIO bucket in a tabular format.

The mc ilm rule list command has equivalent functionality to mc ilm rule ls.

EXAMPLE

The following command lists all lifecycle management rules for the mydata bucket on the myminio MinIO deployment:

mc ilm rule ls myminio/mydata

The output of the command might resemble the following:

┌───────────────────────────────────────────────────────────────────────────────┐
│ Transition for latest version (Transition)                                    │
├────────┬─────────┬────────┬─────────────────────┬──────────────┬──────────────┤
│ ID     │ STATUS  │ PREFIX │ TAGS                │ DAYS TO TIER │ TIER         │
├────────┼─────────┼────────┼─────────────────────┼──────────────┼──────────────┤
│ rule-1 │ Enabled │ doc/   │ key1=val1&key2=val2 │            0 │ WARM-MINIO-1 │
└────────┴─────────┴────────┴─────────────────────┴──────────────┴──────────────┘
┌────────────────────────────────────────────────────────────────┐
│ Transition for older versions (NoncurrentVersionTransition)    │
├────────┬─────────┬────────┬──────┬──────────────┬──────────────┤
│ ID     │ STATUS  │ PREFIX │ TAGS │ DAYS TO TIER │ TIER         │
├────────┼─────────┼────────┼──────┼──────────────┼──────────────┤
│ rule-2 │ Enabled │ logs/  │ -    │           10 │ WARM-MINIO-1 │
└────────┴─────────┴────────┴──────┴──────────────┴──────────────┘
┌────────────────────────────────────────────────────────────────────────────────────────┐
│ Expiration for latest version (Expiration)                                             │
├────────┬─────────┬────────┬─────────────────────┬────────────────┬─────────────────────┤
│ ID     │ STATUS  │ PREFIX │ TAGS                │ DAYS TO EXPIRE │ EXPIRE DELETEMARKER │
├────────┼─────────┼────────┼─────────────────────┼────────────────┼─────────────────────┤
│ rule-1 │ Enabled │ doc/   │ key1=val1&key2=val2 │             30 │ false               │
└────────┴─────────┴────────┴─────────────────────┴────────────────┴─────────────────────┘
┌──────────────────────────────────────────────────────────────────────────────────┐
│ Expiration for older versions (NoncurrentVersionExpiration)                      │
├────────┬─────────┬────────┬─────────────────────┬────────────────┬───────────────┤
│ ID     │ STATUS  │ PREFIX │ TAGS                │ DAYS TO EXPIRE │ KEEP VERSIONS │
├────────┼─────────┼────────┼─────────────────────┼────────────────┼───────────────┤
│ rule-1 │ Enabled │ doc/   │ key1=val1&key2=val2 │             15 │             0 │
│ rule-2 │ Enabled │ logs/  │ -                   │              1 │             3 │
└────────┴─────────┴────────┴─────────────────────┴────────────────┴───────────────┘

SYNTAX

The mc ilm rule ls command has the following syntax:

mc [GLOBALFLAGS] ilm rule ls     \
                 [--expiry]      \
                 [--transition]

Parameters

ALIAS

The alias <alias> and full path to the bucket on the MinIO deployment for which to list the object lifecycle management rules. For example:

mc ilm rule ls myminio/mydata
--expiry

mc ilm rule ls returns only fields related to lifecycle rule expiration.

Mutually exclusive with ~mc ilm rule ls --transition.

--transition

mc ilm rule ls returns only fields related to lifecycle rule transition.

Mutually exclusive with ~mc ilm rule ls --expiry.

Global Flags

Examples

List Bucket Lifecycle Management Rules

Use mc ilm rule ls to list a bucket's lifecycle management rules:

mc ilm rule ls ALIAS/PATH
  • Replace ALIAS <mc ilm rule ls ALIAS> with the alias <mc alias> of the S3-compatible host.
  • Replace PATH with the path to the bucket on the S3-compatible host.

Show Policy Modification Time

Use mc ilm rule ls with --JSON <mc.--JSON> to show the time the policy for a bucket was last updated.

mc ilm rule ls ALIAS/PATH --JSON
  • Replace ALIAS <mc ilm rule ls ALIAS> with the alias <mc alias> of the S3-compatible host.
  • Replace PATH with the path to the bucket on the S3-compatible host.

The updateAt property in the JSON output contains the date and time the policy was updated.

The output resembles the following:

{
 "status": "success",
 "target": "myminio/mybucket",
 "config": {
  "Rules": [
   {
    "Expiration": {
     "Days": 30
    },
    "ID": "ci1o2mg0sko6f1r3krv0",
    "Status": "Enabled"
   }
  ]
 },
 "updatedAt": "2023-06-09T19:45:30Z"
}

Required Permissions

For permissions required to list rules, refer to the required permissions <minio-mc-ilm-rule-permissions> on the parent command.

Behavior

S3 Compatibility