Storage

APIs used for storage management, including S3, maybe Azure drives, Google Cloud...

Create new external storage

POST https://your.host.lab/external-storages

Request Body

Name	Type	Description
name*	String	Storage name
type*	Integer	Now is 0 for AWS S3, future values are coming
config	JSON	A config as JSON, based on config type, sample below

201: Created

{
    "error_code": 0,
    "error_message": "OK",
    "server_time": 1639104302,
    "data": "72ff0519-b416-4031-85c4-e2c412315c7a"
}

S3 Config

Field	Type	Desc	Required
uri	String
region	String
bucket_name	String
access_key	String
secret_key	String
additional_path	String

Sample

// Some code
{
    "name":"storage-03",
    "type":0,
    "config":{
        "uri":"testuri",
        "region":"ap-southeast-1",
        "bucket_name":"test-01",
        "access_key":"test",
        "secret_key":"abcxyz",
        "additional_path":"mypath-01/"
    }
}

Get external storages by page

GET https://your.host.vinlab/external-storages

Path Parameters

Name	Type	Description
_offset	Integer
_limit	Integer
_sort	String

200

{
    "error_code": 0,
    "error_message": "OK",
    "server_time": 1658734089,
    "count": 1,
    "data": [
        {
            "id": "1de6e434-39db-4a1a-b74f-95fce9e2f7d8",
            "config": {
                "uri": "minio.vinlab:9000",
                "region": "ap-southeast-1",
                "bucket_name":"test"
            },
            "name": "storage-01",
            "creator_id":"test",
            "created": 1657764511,
            "type": 1,
            "data_paths": [
                "mypath-01"
            ],
            "last_check": 1658734077,
            "last_check_ok": -1,
            "healthcheck_status": 3,
            "health": [
                {
                    "id": "1de6e434-39db-4a1a-b74f-95fce9e2f7d8",
                    "stage": 1,
                    "last_check": 1658734077,
                    "status": 3,
                    "msg": "Cannot connect to host: minio.vinlab:9000"
                },
                {
                    "id": "1de6e434-39db-4a1a-b74f-95fce9e2f7d8",
                    "stage": 2,
                    "last_check": 1658734077,
                    "status": 3,
                    "msg": "Stage 1 returns failed status"
                }
            ],
            "project_count": 2
        }
    ]
}

Get external storages enums

GET https://your.host.vinlab/external-storages/enums

200

{
    "error_code": 0,
    "error_message": "OK",
    "server_time": 1657795403,
    "data": {
        "0": {
            "AccessKey": "string",
            "BucketName": "string",
            "Region": "string",
            "SecretKey": "string",
            "URI": "string"
        }
    },
    "meta": {
        "storage_types": {
            "0": "Amazon S3",
            "1": "Google Drive"
        }
    }
}

Get Storage detail

GET https://your.host.vinlab/external-storages/:storage_id/info

Path Parameters

Name	Type	Description
storage_id*	String

200

{
    "error_code": 0,
    "error_message": "OK",
    "server_time": 1658734194,
    "data": {
        "id": "1de6e434-39db-4a1a-b74f-95fce9e2f7d8",
        "config": {
            "uri": "minio.vinlab:9000",
            "region": "ap-southeast-1",
            "bucket_name":"test",
            "access_key": "****b",
            "secret_key": "************6$%"
        },
        "name": "storage-01",
        "creator_id":"test",
        "created": 1657764511,
        "modified": 1657764511,
        "type": 1,
        "data_paths": [
            "mypath-01"
        ],
        "last_check": 1658734174,
        "last_check_ok": -1,
        "healthcheck_status": 3,
        "metadata": {},
        "health": [
            {
                "id": "1de6e434-39db-4a1a-b74f-95fce9e2f7d8",
                "stage": 1,
                "last_check": 1658734174,
                "status": 3,
                "msg": "Cannot connect to host: minio.vinlab:9000"
            },
            {
                "id": "1de6e434-39db-4a1a-b74f-95fce9e2f7d8",
                "stage": 2,
                "last_check": 1658734174,
                "status": 3,
                "msg": "Stage 1 returns failed status"
            }
        ],
        "project_count": 0
    }
}

Update Storage

PUT https://your.host.vinlab/external-storages/:storage_id/info

Path Parameters

Name	Type	Description
storage_id*	String

200

{
    "error_code": 0,
    "error_message": "OK",
    "server_time": 1657508401,
    "data": {
        "id": "b5e056c2-b498-4268-ac89-1b2aaf87f23e",
        "config": {
            "access_key": "vinlab",
            "bucket_name":"test",
            "region": "ap-southeast-1",
            "secret_key": "xxxxxxx",
            "uri": "minio.vinlab:9000"
        },
        "name": "storage-01",
        "created": 1656664307,
        "modified": 1656664307
    }
}

First Tab

Field	Type	Desc	Required
uri	String
region	String
bucket_name	String
access_key	String
secret_key	String
additional_path	String

// Some code
{
    "config": {
        "access_key": "vinlab",
        "additional_path": "mypath-02/",
        "bucket_name":"test",
        "region": "ap-southeast-1",
        "secret_key": "xxxxx",
        "uri": "minio.vinlab:9000"
    }
}

Delete Storage

DELETE https://your.host.vinlab/external-storages/:storage_id

Path Parameters

Name	Type	Description
storage_id*	String

200

{
    "error_code": 0,
    "error_message": "OK",
    "server_time": 1657508401,
    "data": "b5e056c2-b498-4268-ac89-1b2aaf87f23e"
}

Get external storages based on permission

GET https://your.host.vinlab/external-storages/v2

Path Parameters

Name	Type	Description
_offset	Integer
_limit	Integer
_sort	String

200

{
    "error_code": 0,
    "error_message": "OK",
    "server_time": 1658734089,
    "count": 1,
    "data": [
        {
            "id": "1de6e434-39db-4a1a-b74f-95fce9e2f7d8",
            "config": {
                "uri": "minio.vinlab:9000",
                "region": "ap-southeast-1",
                "bucket_name":"test"
            },
            "name": "storage-01",
            "creator_id":"test",
            "created": 1657764511,
            "type": 1,
            "data_paths": [
                "mypath-01"
            ],
            "last_check": 1658734077,
            "last_check_ok": -1,
            "healthcheck_status": 3,
            "health": [
                {
                    "id": "1de6e434-39db-4a1a-b74f-95fce9e2f7d8",
                    "stage": 1,
                    "last_check": 1658734077,
                    "status": 3,
                    "msg": "Cannot connect to host: minio.vinlab:9000"
                },
                {
                    "id": "1de6e434-39db-4a1a-b74f-95fce9e2f7d8",
                    "stage": 2,
                    "last_check": 1658734077,
                    "status": 3,
                    "msg": "Stage 1 returns failed status"
                }
            ],
            "project_count": 2
        }
    ]
}