forked from TrueCloudLab/frostfs-dev-env

Denis Kirillov ffe5012ab6 [TrueCloudLab#1] Update docs

Signed-off-by: Denis Kirillov <d.kirillov@yadro.com>

2022-12-29 18:02:22 +03:00

1.7 KiB

Raw Blame History

REST Gateway

REST Gateway to access data in FrostFS using REST.

Source code and more information can be found in project's GitHub repository

.env settings

REST_GW_VERSION=0.4.0

Image version label to use for containers.

If you want to use locally built image, just set its label here. Instead of pulling from DockerHub, the local image will be used.

REST_GW_IMAGE=truecloudlab/frostfs-rest-gw

Image label prefix to use for containers.

Usage example

List container for specific owner:

$ curl http://rest.frostfs.devenv:8090/v1/containers?ownerId=NbUgTSFvPmsRxmGeWpuuGeJUoRoi6PErcM | jq
{
  "containers": [
    {
      "attributes": [
        {
          "key": "Timestamp",
          "value": "1663755230"
        }
      ],
      "basicAcl": "fbfbfff",
      "cannedAcl": "eacl-public-read-write",
      "containerId": "BKcAvz8awKKy9NGsGKi1Hoxxu9AjTGvjKMNMQamvdLmX",
      "containerName": "",
      "ownerId": "NbUgTSFvPmsRxmGeWpuuGeJUoRoi6PErcM",
      "placementPolicy": "REP 1 IN X\nCBF 1\nSELECT 1 FROM * AS X",
      "version": "v2.13"
    }
  ],
  "size": 1
}

Get container info:

$ curl http://rest.frostfs.devenv:8090/v1/containers/BKcAvz8awKKy9NGsGKi1Hoxxu9AjTGvjKMNMQamvdLmX | jq
{
  "attributes": [
    {
      "key": "Timestamp",
      "value": "1663755230"
    }
  ],
  "basicAcl": "fbfbfff",
  "cannedAcl": "eacl-public-read-write",
  "containerId": "BKcAvz8awKKy9NGsGKi1Hoxxu9AjTGvjKMNMQamvdLmX",
  "containerName": "",
  "ownerId": "NbUgTSFvPmsRxmGeWpuuGeJUoRoi6PErcM",
  "placementPolicy": "REP 1 IN X\nCBF 1\nSELECT 1 FROM * AS X",
  "version": "v2.13"
}

See all available routes http://rest.frostfs.devenv:8090/v1/docs

1.7 KiB Raw Blame History