maxmustermann/minio
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity
minio/docs/admin-api
History
Krishnan Parthasarathi 0472e5c1e1 Change query param name to duration in list/clear locks API (#3664) 
Following is a sample list lock API request schematic,

  /?lock&bucket=mybucket&prefix=myprefix&duration=holdDuration
  x-minio-operation: list

The response would contain the list of locks held on mybucket matching
myprefix for a duration longer than holdDuration.
2017-02-01 11:17:30 -08:00
..
README.md Change query param name to duration in list/clear locks API (#3664) 2017-02-01 11:17:30 -08:00

README.md

Management REST API

Authentication

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

List of management APIs

  • Service

    • Restart
    • Status
    • SetCredentials

  • Locks

    • List
    • Clear

  • Healing

Service Management APIs

  • 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 object which contains StorageInfo and ServerVersion structures

  • SetCredentials

    • GET /?service
    • x-minio-operation: set-credentials
    • Response: Success 200
    • Possible error responses
      • ErrMethodNotAllowed MethodNotAllowed The specified method is not allowed against this resource. / 3L137 3L137
      • ErrAdminBadCred XMinioBadCred XMinioBadCred / 3L137 3L137
      • ErrInternalError InternalError We encountered an internal error, please try again. / 3L137 3L137

Lock Management APIs

  • ListLocks

    • GET /?lock&bucket=mybucket&prefix=myprefix&duration=duration
    • x-minio-operation: list
    • Response: On success 200, json encoded response containing all locks held, for longer than duration.
    • 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 Duration provided in the request is invalid. / 3L137 3L137

  • ClearLocks

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

Healing

  • ListBucketsHeal
    • GET /?heal
    • x-minio-operation: list-buckets