MyFavMirrors/minio
1
0
Fork 0
mirror of https://github.com/minio/minio.git synced 2024-12-27 15:45:55 -05:00
Code Issues Packages Projects Releases Wiki Activity
c8f57133a4
minio/docs/admin-api/management-api.md
Krishnan Parthasarathi c8f57133a4 Implement list, clear locks REST API w/ pkg/madmin support (#3491) 
* Filter lock info based on bucket, prefix and time since lock was held
* Implement list and clear locks REST API
* madmin: Add list and clear locks API
* locks: Clear locks matching bucket, prefix, relTime.
* Gather lock information across nodes for both list and clear locks admin REST API.
* docs: Add lock API to management APIs
2017-01-03 23:39:22 -08:00

2.2 KiB
Raw Blame History

Management REST API

Authentication

  • AWS signatureV4
  • We use "minio" as region. Here region is set only for signature calculation.

List of management APIs

  • Service

    • Stop
    • Restart
    • Status

  • Locks

    • List
    • Clear

  • Healing

Service Management APIs

  • Stop

    • POST /?service
    • x-minio-operation: stop
    • Response: On success 200

  • Restart

    • POST /?service
    • x-minio-operation: restart
    • Response: On success 200

  • Status

    • GET /?service
    • x-minio-operation: status
    • Response: On success 200, return json formatted StorageInfo object.

Lock Management APIs

  • ListLocks

    • GET /?lock&bucket=mybucket&prefix=myprefix&older-than=rel_time
    • x-minio-operation: list
    • Response: On success 200, json encoded response containing all locks held, older than rel_time. e.g, older than 3 hours.
    • Possible error responses

      • ErrInvalidBucketName InvalidBucketName The specified bucket is not valid. / 3L137 3L137

      • ErrInvalidObjectName XMinioInvalidObjectName Object name contains unsupported characters. Unsupported characters are `^*|" / 3L137 3L137

      • ErrInvalidDuration InvalidDuration Relative duration provided in the request is invalid. / 3L137 3L137

  • ClearLocks

    • POST /?lock&bucket=mybucket&prefix=myprefix&older-than=rel_time
    • x-minio-operation: clear
    • Response: On success 200, json encoded response containing all locks cleared, older than rel_time. e.g, older than 3 hours.
    • Possible error responses, similar to errors listed in ListLocks.
      • ErrInvalidBucketName
      • ErrInvalidObjectName
      • ErrInvalidDuration