Usługi

Usługi S3

Endpoint zwraca listę usług S3

GET https://365.exea.pl/api/v5/services/s3
Accept: application/json
Authorization: Bearer {{token}}

Przykładowa odpowiedź

HTTP/1.1 200 OK

[
    {
        "id": "9d19c712-c624-4314-944b-77ab142f1853",
        "status": 1,
        "status_description": "The service is delivered.",
        "name": "s3_api_v5",
        "project_id": "46ac4576-6f2c-469d-aec6-6a7c86b93a30",
        "product_id": "ab4a10ef-084a-4509-adc2-57aeaaebea64",
        "created_at": "2024-09-26 10:46:36",
        "service_type": "Object Storage S3",
        "service_type_id": "99300294-d654-4674-9019-24b438ad3e4a"
    }
]

Szczegóły usługi S3

Aby pobrać informacje o VDC, wyślij zapytanie GET.

GET https://365.exea.pl/api/v5/services/s3/{{serviceId}}
Accept: application/json
Authorization: Bearer {{token}}

Przykładowa odpowiedź

HTTP/1.1 200 OK

{
    "id": "9d19c712-c624-4314-944b-77ab142f1853",
    "status": 3,
    "status_description": "The service is delivered.",
    "name": "s3_api_v5",
    "project_id": "46ac4576-6f2c-469d-aec6-6a7c86b93a30",
    "product_id": "ab4a10ef-084a-4509-adc2-57aeaaebea64",
    "created_at": "2024-09-26 10:46:36",
    "service_components": [
        {
            "name": "Object Storage S3",
            "quantity": 50,
            "unit": "GB"
        },
        {
            "name": "Object Storage S3 Usage",
            "quantity": 1,
            "unit": "GB"
        },
        {
            "name": "Object Storage S3 Upload",
            "quantity": 1,
            "unit": "GB"
        },
        {
            "name": "Object Storage S3 Download",
            "quantity": 1,
            "unit": "GB"
        }
    ],
    "service_type": "Object Storage S3",
    "service_type_id": "99300294-d654-4674-9019-24b438ad3e4a",
    "s3-user": {
        "uid": "5440042a058772f5afb4$9a42b59f00b12c61dabb",
        "display_name": "user",
        "suspended": 0,
        "access_key": "*******",
        "secret_key": "*******",
        "endpoint": "https://s3.exea.pl"
    },

    "used_storage": "3.124794960022 GB",
    "buckets": 1,
    "objects": 14
}

Status 200 oznacza, że zapytanie było prawidłowe. W odpowiedzi znajduje się informacja o usłudze. Status usługi 3 oznacza że usługa jest wytworzona. Status usługi 2 oznacza że usługa jest w trakcie edycji. Status usługi 4 oznacza że usługa została zlecona do usunięcia. Aby pobrać status usługi i informacje o zamówieniu sprawdź status zamówienia pod adresem /api/v5/orders/{orderId}.

Tworzenie usługi S3

Aby utworzyć usługę S3, wyślij request jak poniżej.

POST https://365.exea.pl/api/v5/services/s3
Accept: application/json
Authorization: Bearer {{token}}
Content-Type: application/json

{
    "project_id": "46ac4576-6f2c-469d-aec6-6a7c86b93a30",
    "product_id": "ab4a10ef-084a-4509-adc2-57aeaaebea64",
    "service_name": "s3_api_v5",
    "quota" : 50
}

Opis pól

Pole	Opis
project_id	ID projektu Exea365 należącego do użytkownika korzystającego z API
service_name	Nazwa usługi, musi być unikatowa w obrębie projektu
product_id	ID produktu S3
quota	Limit powierzchni dyskowej w GB

Przykładowe odpowiedzi

HTTP/1.1 202 Accepted

{
    "id": "9d19c712-9fed-454f-8bcb-2b6ef48e2c9c",
    "status": 2,
    "status_description": "Order in progress.",
    "order_type": "new",
    "product_id": "ab4a10ef-084a-4509-adc2-57aeaaebea64",
    "created_at": "2024-09-26 10:46:36",
    "delivered_at": null,
    "service": {
        "id": "9d19c712-c624-4314-944b-77ab142f1853",
        "status": 1,
        "status_description": "The service creation in progress.",
        "name": "s3_api_v5",
        "project_id": "46ac4576-6f2c-469d-aec6-6a7c86b93a30",
        "product_id": "ab4a10ef-084a-4509-adc2-57aeaaebea64",
        "created_at": "2024-09-26 10:46:36",
        "service_type": "Object Storage S3",
        "service_type_id": "99300294-d654-4674-9019-24b438ad3e4a"
    },
    "service_type": "Object Storage S3",
    "service_type_id": "99300294-d654-4674-9019-24b438ad3e4a"
}

Status 202 oznacza, że zapytanie było prawidłowe, usługa jest w trakcie tworzenia. W odpowiedzi znajduje się informacja o zamówieniu i tworzonej usłudze. Status zamówienia 2 oznacza że usługa jest w trakcie wytwarzania. Aby pobrać status usługi i informacje o zamówieniu sprawdź status zamówienia pod adresem /api/v5/orders/{orderId}.

HTTP/1.1 422 Unprocessable Content

{
    "errors": {
        "service_name": [
            "Usługa o podanej nazwie już istnieje. Wprowadź inną nazwę dla usługi."
        ]
    }
}

Nazwy usług muszą być unikatowe w obrębie projektu. W związku z tym nie można utworzyć usługi z nazwą, która już istnieje.

WARNING

Utworzenie usługi w Exea365 skutkuje naliczaniem opłat.

Edycja usługi S3

Aby edytować usługę, wyślij request jak poniżej.

PATCH https://365.exea.pl/api/v5/services/s3/{{serviceId}}
Accept: application/json
Authorization: Bearer {{token}}
Content-Type: application/json

{
    "quota" : 100
}

Opis pól

Pole	Opis
'quota'	Limit powierzchni dyskowej w GB. Liczba całkowita.

Przykładowa odpowiedź

HTTP/1.1 202 Accepted

{
    "id": "9d19de35-b45e-45ff-9347-fe9c180ea181",
    "status": 2,
    "status_description": "Order in progress.",
    "order_type": "edit",
    "product_id": "ab4a10ef-084a-4509-adc2-57aeaaebea64",
    "created_at": "2024-09-26 11:51:18",
    "delivered_at": null,
    "service": {
        "id": "9d19c712-c624-4314-944b-77ab142f1853",
        "status": 2,
        "status_description": "The service edition in progress.",
        "name": "s3_api_v5",
        "project_id": "46ac4576-6f2c-469d-aec6-6a7c86b93a30",
        "product_id": "ab4a10ef-084a-4509-adc2-57aeaaebea64",
        "created_at": "2024-09-26 10:46:36",
        "service_type": "Object Storage S3",
        "service_type_id": "99300294-d654-4674-9019-24b438ad3e4a"
    },
    "service_type": "Object Storage S3",
    "service_type_id": "99300294-d654-4674-9019-24b438ad3e4a"
}

Status 202 oznacza, że zapytanie było prawidłowe, usługa jest w trakcie edycji. W odpowiedzi znajduje się informacja o zamówieniu i edytowanej usłudze. Status zamówienia 2 oznacza że usługa jest w trakcie edycji. Aby pobrać status usługi i informacje o zamówieniu sprawdź status zamówienia pod adresem /api/v5/orders/{orderId}.

Usunięcie danych usługi S3

Aby usunąć dane usługi, wyślij request jak poniżej. Usuwanie danych rozpocznie się po godzinie od utworzenia zamówienia. Możesz w ty czasie anulować usunięcie danych. Datę rozpoczęcia przetwarzania zamówienia określa pole preprocess_at w zamówieniu.

DELETE https://365.exea.pl/api/v5/services/s3/{{serviceId}}/delete-data
Accept: application/json
Authorization: Bearer {{token}}
Content-Type: application/json

Przykładowa odpowiedź

HTTP/1.1 202 Accepted

{
    "id": "9d1bc3e9-fe1c-4376-ac7f-c1e7946b2d65",
    "status": 2,
    "status_description": "Order in progress.",
    "order_type": "delete_data",
    "product_id": "ab4a10ef-084a-4509-adc2-57aeaaebea64",
    "created_at": "2024-09-27 10:29:25",
    "preprocess_at": "2024-09-27 11:29:25",
    "delivered_at": null,
    "service": {
        "id": "9d19c712-c624-4314-944b-77ab142f1853",
        "status": 3,
        "status_description": "The service is delivered.",
        "name": "s3_api_v5",
        "project_id": "46ac4576-6f2c-469d-aec6-6a7c86b93a30",
        "product_id": "ab4a10ef-084a-4509-adc2-57aeaaebea64",
        "created_at": "2024-09-26 10:46:36",
        "service_type": "Object Storage S3",
        "service_type_id": "99300294-d654-4674-9019-24b438ad3e4a"
    },
    "service_type": "Object Storage S3",
    "service_type_id": "99300294-d654-4674-9019-24b438ad3e4a"
}

Status 202 oznacza, że zapytanie było prawidłowe, usługa jest w trakcie edycji. W odpowiedzi znajduje się informacja o zamówieniu i edytowanej usłudze. Status zamówienia 2 oznacza że usługa jest w trakcie edycji. Aby pobrać status usługi i informacje o zamówieniu sprawdź status zamówienia pod adresem /api/v5/orders/{orderId}.

Anulowanie usunięcia danych usługi S3

Użytkownik może anulować usuwanie danych. Aby to zrobić, wyślij request jak poniżej.

PATCH https://365.exea.pl/api/v5/services/s3/{{serviceId}}/cancel-delete-data
Accept: application/json
Authorization: Bearer {{token}}
Content-Type: application/json

Przykładowa odpowiedź

HTTP/1.1 200 OK

{
    "id": "9d1bc3e9-fe1c-4376-ac7f-c1e7946b2d65",
    "status": 4,
    "status_description": "Order cancelled.",
    "order_type": "delete_data",
    "product_id": "ab4a10ef-084a-4509-adc2-57aeaaebea64",
    "created_at": "2024-09-27 10:29:25",
    "preprocess_at": "2024-09-27 11:29:25",
    "delivered_at": null,
    "service": {
        "id": "9d19c712-c624-4314-944b-77ab142f1853",
        "status": 3,
        "status_description": "The service is delivered.",
        "name": "s3_api_v5",
        "project_id": "46ac4576-6f2c-469d-aec6-6a7c86b93a30",
        "product_id": "ab4a10ef-084a-4509-adc2-57aeaaebea64",
        "created_at": "2024-09-26 10:46:36",
        "service_type": "Object Storage S3",
        "service_type_id": "99300294-d654-4674-9019-24b438ad3e4a"
    },
    "service_type": "Object Storage S3",
    "service_type_id": "99300294-d654-4674-9019-24b438ad3e4a"
}

Status 200 oznacza, że zapytanie było prawidłowe, a usunięcie danych zostało anulowane. W odpowiedzi znajduje się informacja o zamówieniu i edytowanej usłudze. Status zamówienia 4 oznacza że zamówienie zostało anulowane. Aby pobrać status usługi i informacje o zamówieniu sprawdź status zamówienia pod adresem /api/v5/orders/{orderId}.

Zmiana secret_key S3

Aby zmienić klucz dostępu S3, wyślij request jak poniżej.

PATCH https://365.exea.pl/api/v5/services/s3/{{serviceId}}/change-key
Accept: application/json
Authorization: Bearer {{token}}
Content-Type: application/json

Przykładowa odpowiedź HTTP/1.1 200 OK

{
    "uid": "5440042a058772f5afb4$9a42b59f00b12c61dabb",
    "display_name": "user",
    "suspended": 0,
    "access_key": "****",
    "secret_key": "****",
    "endpoint": "https://s3.exea.pl"
}

Status 200 oznacza, że zapytanie było prawidłowe, a klucz secret_key został zmieniony. W odpowiedzi znajduje się informacja o danych dostępowych dla usługi S3.

Zmiana nazwy usługi S3

Aby zmienić nazwę usługi S3, wyślij request jak poniżej.

PATCH https://365.exea.pl/api/v5/services/s3/{{serviceId}}/change-name
Accept: application/json
Authorization: Bearer {{token}}
Content-Type: application/json

{
    "service_name": "s3_api_v5_renamed"
}

Opis pól

Pole	Opis
'service_name'	Nowa nazwa usługi

Przykładowa odpowiedź

HTTP/1.1 200 OK

{
    "id": "9d19c712-c624-4314-944b-77ab142f1853",
    "status": 3,
    "status_description": "The service is delivered.",
    "name": "s3_api_v5_renamed",
    "project_id": "46ac4576-6f2c-469d-aec6-6a7c86b93a30",
    "product_id": "ab4a10ef-084a-4509-adc2-57aeaaebea64",
    "created_at": "2024-09-26 10:46:36",
    "service_type": "Object Storage S3",
    "service_type_id": "99300294-d654-4674-9019-24b438ad3e4a"
}

Status 200 oznacza, że zapytanie było prawidłowe, a nazwa usługi została zmieniona. W odpowiedzi znajduje się informacja o usłudze.

Usuwanie usługi

Aby usunąć usługę, wyślij request jak poniżej.

DELETE https://365.exea.pl/api/v5/services/s3/{{serviceId}}
Accept: application/json
Authorization: Bearer {{token}}
Przykładowe odpowiedzi
HTTP/1.1 202 Accepted

{
    "id": "9d1bb1f2-0117-49ab-8bcc-5dd60d70324c",
    "status": 2,
    "status_description": "Order in progress.",
    "order_type": "resign",
    "product_id": "ab4a10ef-084a-4509-adc2-57aeaaebea64",
    "created_at": "2024-09-27 09:39:11",
    "delivered_at": null,
    "service": {
        "id": "9d19c712-c624-4314-944b-77ab142f1853",
        "status": 4,
        "status_description": "The service will be deleted.",
        "name": "s3_api_v5",
        "project_id": "46ac4576-6f2c-469d-aec6-6a7c86b93a30",
        "product_id": "ab4a10ef-084a-4509-adc2-57aeaaebea64",
        "created_at": "2024-09-26 10:46:36",
        "vcloud_vdc_id": null,
        "service_type": "Object Storage S3",
        "service_type_id": "99300294-d654-4674-9019-24b438ad3e4a"
    },
    "service_type": "Object Storage S3",
    "service_type_id": "99300294-d654-4674-9019-24b438ad3e4a"
}

Status 202 oznacza, że zapytanie było prawidłowe, dane usługi zostaną usunięte po 1 godzinie, a usługa zostanie usunięta. W odpowiedzi znajduje się informacja o zamówieniu i usuwanej usłudze. Status zamówienia 4 oznacza że usługa jest w trakcie usuwania. Aby pobrać status usługi i informacje o zamówieniu sprawdź status zamówienia pod adresem /api/v5/orders/{orderId}.

HTTP/1.1 409 Conflict

"Service 9d19c712-c624-4314-944b-77ab142f1853 has pending orders. Try again later."

Nie można utworzyć zamówienia, trwają inne operacje na obiekcie. Zaczekaj na zakończenie zadań i ponów próbę.