NAV Navbar
shell

Introduction

BizFly Cloud Cloud Server API - Power by BizFly Cloud

Service Endpoint

https://manage.bizflycloud.vn/iaas-cloud/api

Authentication

The BizFly Cloud Server API use openstack keystone middleware for authorization, so you need to retrieve a token from keystone before calling BizFly Cloud Server API:

X-Auth-Token: Token {YOUR_KEYSTONE_TOKEN}

Contact

Please contact the developers:

Terms of service
BizFly Cloud Support - Website

General API Overview

Status Code

BizFly Cloud Server có 11 mã trạng thái hiển thị trong response body. status mô tả trạng thái Cloud Server của bạn.

Cloud Server Status Codes

Code Description
ACTIVE - Cloud Server đang hoạt động và có thể sử dụng.
SHUTOFF - Cloud Server đang tắt, cần bật lại để sử dụng.
BUILD - Cloud Server hiện đang tạo.
MIGRATING - Cloud Server đang được di chuyển sang node vật lý khác.
RESIZE - Cloud Server đang thay đổi cấu hình.
VERIFY_RESIZE - Cloud Server đang đợi để xác nhận resize hoặc migrate
REVERT_RESIZE - Cloud Server resize hoặc migrate lỗi.
REBUILD - Cloud Server đang thay đổi hệ điều hành.
ERROR - Cloud Server đang bị lỗi và không thể sử dụng, liên hệ quản trị viên để được hỗ trợ.
REBOOT - Cloud Server đang được reboot mềm.
HARD_REBOOT - Cloud Server đang được reboot cứng.

Volume, Snapshot Status Codes

Code Description
Creating Volume đang được khởi tạo.
Available Volume đang ở trạng thái sẵn sàng, có thể attach vào server để sử dụng.
In-Use Volume đang được gắn vào server.
Deleting Volume đang được xóa.
Error Volume gặp lỗi, liên hệ quản trị viên để được hỗ trợ.

Token

- POST /token

curl --location --request POST "https://manage.bizflycloud.vn/iaas-cloud/api/token" \
  --header "Content-Type: application/json" \
  --data ""

Body Parameters

Tên Loại giá trị Mô tả
username string Email đăng nhập trang manage.bizflycloud.vn
password string Password đăng nhập trang manage.bizflycloud.vn

Image

- GET /os-images

$ curl --location --request GET "https://manage.bizflycloud.vn/iaas-cloud/api/os-images" \
  --header "X-Auth-Token: {token}"
  --header "X-Tenant-Name: {your_email}"

Liệt kê toàn bộ image có thể tạo thành server.

Parameters
No parameters

Response Example

[
    {
        "os": "Ubuntu",
        "versions": [
            {
                "id": "fd9dfb37-76b4-4d28-91a6-de9ac4124645",
                "name": "18.04 x64"
            },
            {
                "id": "b01d2f9d-0b25-41f5-890e-8266e2e26f25",
                "name": "16.04 x64"
            },
            {
                "id": "83aeff78-14ad-498d-976b-ed15bc5fa5ac",
                "name": "14.04 x64"
            }
        ]
    },
    {
        "os": "CentOS",
        "versions": [
            {
                "id": "9a0f31e3-c43d-4fc2-ae1c-cc6ebde571fa",
                "name": "7 x64"
            },
            {
                "id": "78476d38-e1e6-46fa-ac98-be7c6b769287",
                "name": "6.9 x64"
            },
            {
                "id": "106ce872-e71e-479d-8d35-1b3b6911d520",
                "name": "6.8 x64"
            }
        ]
    },
    {
        "os": "Debian",
        "versions": [
            {
                "id": "a247e27e-03f0-4438-80c5-d9bbcc3ba658",
                "name": "9 x64"
            }
        ]
    },
    {
        "os": "Windows",
        "versions": [
            {
                "id": "961ae9e9-4a3c-4dad-9631-ee8a105975ce",
                "name": "2016 Standard"
            },
            {
                "id": "c9479e61-de4e-4b36-bba1-4d25c622ba19",
                "name": "2016 Datacenter"
            },
            {
                "id": "7a4efaea-b771-4818-84ea-d2ffbd63efa8",
                "name": "2012 R2 Standard"
            },
            {
                "id": "ac88c5eb-a3d9-45df-9610-800b475e35c8",
                "name": "2012 R2 Datacenter"
            },
            {
                "id": "a8aa0101-f08d-41c8-bf04-c6b95781f1df",
                "name": "2008 R2 Enterprise"
            }
        ]
    }
]

- GET /volumes?bootable=true

curl --location --request GET "https://manage.bizflycloud.vn/iaas-cloud/api/volumes?bootable=true" \
  --header "X-Auth-Token: {token}"
  --header "X-Tenant-Name: {your_email}"

Liệt kê toàn bộ volume có thể tạo thành server.

Parameters
No parameters

Response Example

[
    {
        "attachments": [],
        "availability_zone": "HN1",
        "bootable": "true",
        "consistencygroup_id": null,
        "created_at": "2019-09-16T04:58:25.000000",
        "description": null,
        "encrypted": false,
        "id": "a5ad38c9-d05d-4601-a028-2e1cba523bb4",
        "metadata": {
            "category": "premium"
        },
        "multiattach": false,
        "name": "nginx-wp_rootdisk",
        "os-vol-tenant-attr:tenant_id": "21fea7e3c69d4186ba561abf6e9e781e",
        "replication_status": null,
        "size": 20,
        "snapshot_id": null,
        "source_volid": null,
        "status": "available",
        "updated_at": "2019-09-24T04:47:50.000000",
        "user_id": "a849f29b341541748250df661341c386",
        "volume_image_metadata": {
            "base_image_ref": "e410a263-b265-492d-9bb1-cd8e75fc3e92",
            "boot_roles": "admin",
            "checksum": "2cb722f1b5627d2699fc2c39ebe1eeaf",
            "container_format": "bare",
            "disk_format": "raw",
            "image_id": "7dcca85e-e77c-44e6-8a40-1a8c67614858",
            "image_location": "snapshot",
            "image_name": "Ubuntu 18.04 ",
            "image_state": "available",
            "image_type": "image",
            "instance_uuid": "c60b940e-ec58-4608-878d-2421a8bef730",
            "min_disk": "5",
            "min_ram": "0",
            "size": "5368709120",
            "user_id": "5676103832f14c129306bf525ec7b2de"
        },
        "volume_type": "HDD"
    }
]

- GET snapshots?bootable=true

curl --location --request GET "https://manage.bizflycloud.vn/iaas-cloud/api/snapshots?bootable=true" \
  --header "X-Auth-Token: {token}"
  --header "X-Tenant-Name: {your_email}"

Liệt kê toàn bộ snapshot có thể tạo thành server.

Parameters
No parameters

Response Example

[
    {
        "created_at": "2019-09-24T04:49:14.000000",
        "description": null,
        "id": "89a54fb8-fb70-4e37-9052-9592915bfb79",
        "metadata": {
            "category": "premium"
        },
        "name": "snapshot-nginx-wp_rootdisk-11-49",
        "os-extended-snapshot-attributes:progress": "100%",
        "os-extended-snapshot-attributes:project_id": "21fea7e3c69d4186ba561abf6e9e781e",
        "size": 20,
        "status": "available",
        "updated_at": "2019-09-24T04:49:16.000000",
        "volume": {
            "attachments": [],
            "availability_zone": "HN1",
            "bootable": "true",
            "consistencygroup_id": null,
            "created_at": "2019-09-16T04:58:25.000000",
            "description": null,
            "encrypted": false,
            "id": "a5ad38c9-d05d-4601-a028-2e1cba523bb4",
            "metadata": {
                "category": "premium"
            },
            "multiattach": false,
            "name": "nginx-wp_rootdisk",
            "os-vol-tenant-attr:tenant_id": "21fea7e3c69d4186ba561abf6e9e781e",
            "replication_status": null,
            "size": 20,
            "snapshot_id": null,
            "source_volid": null,
            "status": "available",
            "updated_at": "2019-09-24T04:47:50.000000",
            "user_id": "a849f29b341541748250df661341c386",
            "volume_image_metadata": {
                "base_image_ref": "e410a263-b265-492d-9bb1-cd8e75fc3e92",
                "boot_roles": "admin",
                "checksum": "2cb722f1b5627d2699fc2c39ebe1eeaf",
                "container_format": "bare",
                "disk_format": "raw",
                "image_id": "7dcca85e-e77c-44e6-8a40-1a8c67614858",
                "image_location": "snapshot",
                "image_name": "Ubuntu 18.04 ",
                "image_state": "available",
                "image_type": "image",
                "instance_uuid": "c60b940e-ec58-4608-878d-2421a8bef730",
                "min_disk": "5",
                "min_ram": "0",
                "size": "5368709120",
                "user_id": "5676103832f14c129306bf525ec7b2de"
            },
            "volume_type": "HDD"
        },
        "volume_id": "a5ad38c9-d05d-4601-a028-2e1cba523bb4"
    }
]

Flavor

- GET /flavors

curl --location --request GET "https://manage.bizflycloud.vn/iaas-cloud/api/flavors" \
  --header "X-Auth-Token: {token}"
  --header "X-Tenant-Name: {your_email}"

Parameters
No parameters

Response Example

[
    {
        "_id": "5d7f58903c4c0127da9896ae",
        "name": "1c_1g"
    },
    {
        "_id": "5d7f58903c4c0127da9896af",
        "name": "1c_2g"
    },
    {
        "_id": "5d7f58903c4c0127da9896b0",
        "name": "1c_3g"
    },
    {
        "_id": "5d7f58903c4c0127da9896b1",
        "name": "1c_4g"
    }
]

Cloud Server

- GET /servers

$ curl --location --request GET "https://manage.bizflycloud.vn/iaas-cloud/api/servers" \
  --header "X-Auth-Token: {token}"
  --header "X-Tenant-Name: {your_email}"

Liệt kê toàn bộ server trong tài khoản của bạn.

Parameters
No parameters

- POST /servers

curl --location --request POST "https://manage.bizflycloud.vn/iaas-cloud/api/servers" \
  --header "X-Auth-Token: {token}" \
  --header "X-Tenant-Name: {your_email}"
  --header "Content-Type: application/json" \
  --data ""

Tạo server trên hệ thống của BizFly, có thể tạo từ image, volume hoặc snapshot.

Body Example

[
    {
        "flavor": "2c_2g",
        "name": "bizflycloud",
        "os": { 
            "id": "9a0f31e3-c43d-4fc2-ae1c-cc6ebde571fa",
            "type": "image"
        },
        "rootdisk": { 
            "size": 20,
            "type": "HDD"
        },
        "datadisks":[ { 
            "size": 50,
            "type": "SSD"
                }
        ]
        ,
        "sshkey": "bizflycloud",
        "password": true,
        "type": "premium",
        "availability_zone": "HN1"
    }  
]

Body Parameters

Tên Loại giá trị Mô tả
name string Tên server muốn khởi tạo
flavor string Tên flavor muốn sử dụng để tạo server
type (os) string Tạo server từ image, volume hoặc snapshot
id (os) string ID của image, volume hoặc snapshot
size int Dung lượng ổ cứng rootdisk
type string Loại volume (SSD hoặc HDD)
sshkey int Tên ssh key
password boolean True là có nhận password về email và ngược lại
type string Loại Server (premium, basic, enterprise)
availability_zone string Tên Datacenter muốn đặt server

- GET /servers/{server_id}

curl --location --request GET "https://manage.bizflycloud.vn/iaas-cloud/api/servers/{server_id}" \
  --header "X-Auth-Token: {token}"
  --header "X-Tenant-Name: {your_email}"

Lấy các thông tin chi tiết của server.

Parameters
No parameters

- DELETE /servers/{server_id}

curl --location --request DELETE "https://manage.bizflycloud.vn/iaas-cloud/api/servers/{server_id}" \
  --header "X-Auth-Token: {token}" \
  --header "X-Tenant-Name: {your_email}"
  --data ""

Xóa server.

Body Example

{"delete_volume": ["volume_id1", "volume_id2"]}

Body Parameters

Tên Loại giá trị Mô tả
delete_volume list Danh sách các ID volume muốn xóa cùng server. Nếu không muốn xóa volume, trường này để thành []

- POST /servers/{server_id}/action

curl --location --request POST "https://manage.bizflycloud.vn/iaas-cloud/api/servers/{server_id}/action" \
  --header "X-Auth-Token: {token}" \
  --header "X-Tenant-Name: {your_email}"
  --header "Content-Type: application/json" \
  --data ""

Thực hiện các hành động với server như reset password, rebuild, reboot,...

Body Example

{"action":"rebuild", "image": "fd9dfb37-76b4-4d28-91a6-de9ac4124645"}

Body Parameters

Tên Loại giá trị Mô tả
action string Hành động thực hiện với server. Gồm rebuild, resize, get_vnc, reset_password, hard_reboot, soft_reboot, start, stop, add_firewall, change_type.
image string Chỉ áp dụng với action rebuild, chỉ định ID của image muốn rebuild
flavor_name string Chỉ áp dụng với action resize, tên của flavor muốn resize
type string Chỉ áp dụng với action get_vnc. Lấy console "novnc"
firewall_ids string Chỉ áp dụng với action add_firewall. Thêm firewall vào server
new_type string Chỉ áp dụng với action change_type. Thay đổi type của server. Chỉ áp dụng chuyển từ Basic --> Premium, Enterprise hoăc Premium <---> Enterprise.

Volume

- GET /volumes

curl --location --request GET "https://manage.bizflycloud.vn/iaas-cloud/api/volumes" \
  --header "X-Tenant-Name: {your_email}"
  --header "X-Auth-Token: {token}"

Liệt kê danh sách các volume có trong tài khoản của bạn.

Parameters
No parameters

- POST /volumes

curl --location --request POST "https://manage.bizflycloud.vn/iaas-cloud/api/volumes" \
  --header "X-Auth-Token: {token}" \
  --header "X-Tenant-Name: {your_email}"
  --header "Content-Type: application/json" \
  --data "{\"name\": \"bizflycloud\", \"size\": 20, \"volume_type\": \"HDD\", \"availability_zone\": \"HN1\"}"

Khởi tạo volume tại BizFly.

Body Example

{
    "name": "bizflycloud",
    "size": 20,
    "volume_type": "HDD",
    "availability_zone": "HN1"
}

Body Parameters

Tên Loại giá trị Mô tả
name string Tên volume muốn khởi tạo
size int Kích thước của volume
volume_type string Loại của volume (HDD hoặc SSD)
availability_zone string Datacenter muốn đặt volume
snapshot_id string ID của snapshot muốn tạo thành volume. Nếu tạo volume từ snapshot thì không cần truyền size, volume sẽ có kích thước bằng kích thước của snapshot

- GET /volumes/{volume_id}

curl --location --request GET "https://manage.bizflycloud.vn/iaas-cloud/api/volumes/{volume_id}" \
  --header "X-Tenant-Name: {your_email}"
  --header "X-Auth-Token: {token}"

Lấy chi tiết các thông tin của volume.

Parameters
No parameters

- DELETE /volumes/{volume_id}

curl --location --request DELETE "https://manage.bizflycloud.vn/iaas-cloud/api/volumes/{volume_id}" \
  --header "X-Auth-Token: {token}"
  --header "X-Tenant-Name: {your_email}"

Xóa volume.

Parameters
No parameters

- POST /volumes/{volume_id}/action

curl --location --request POST "https://manage.bizflycloud.vn/iaas-cloud/api/volumes/{volume_id}/action" \
  --header "X-Auth-Token: {token}" \
  --header "X-Tenant-Name: {your_email}"
  --header "Content-Type: application/json" \
  --data ""

Thực hiện các hành động với volume như tăng dung lượng, rollback, gắn vào server. Lưu ý:
- Khi thực hiện tăng dung lượng ổ rootdisk server sẽ bị stop để tăng dung lượng.
- Khi thực hiện tăng dung lượng ổ datadisk đang gắn vào server, cần umount volume trong server ra để tránh bị crash data.

Body Example

{
    "type": "restore_volume",
    "snapshot_id": "f5b154e6-aa48-48b7-ab2f-d2270f429440"
}

Body Parameters

Tên Loại giá trị Mô tả
type string action muốn thực hiện với volume. Hỗ trợ restore_volume, detach, attach, extend.
new_size int Chỉ áp dụng với action extend. Nâng dung lượng ổ cứng, hỗ trợ nâng theo block 10G
instance_uuid string Chỉ áp dụng với action attach. ID Server muốn gắn ổ cứng vào
snapshot_id string Chỉ áp dụng với action restore_volume. Snapshot ID muốn restore.

Snapshot

- GET /snapshots

curl --location --request GET "https://manage.bizflycloud.vn/iaas-cloud/api/snapshots" \
  --header "X-Auth-Token: {token}"
  --header "X-Tenant-Name: {your_email}"

Liệt kê danh sách các snapshot có trong tài khoản của bạn

Parameters
No parameters

- POST /snapshot

curl --location --request POST "https://manage.bizflycloud.vn/iaas-cloud/api/snapshots" \
  --header "X-Auth-Token: {token}" \
  --header "X-Tenant-Name: {your_email}"
  --header "Content-Type: application/json" \
  --data ""

Tạo snapshot của 1 volume

Body Example

{
    "name": "bizflycloud",
    "volume_id": "bfa4a464-27af-4e12-b42e-470a459823df",
    "force": true
}

Body Parameters

Tên Loại giá trị Mô tả
name string Tên snapshot muốn khởi tạo
volume_id string Volume ID muốn snapshot
force boolean Với các volume hiện đang gắn vào server để sử dụng, cần sử dụng option force=true để tạo snapshot

- GET /snapshots/{snapshot_id}

curl --location --request GET "https://manage.bizflycloud.vn/iaas-cloud/api/snapshots/{snapshot_id}" \
  --header "X-Auth-Token: {token}"
  --header "X-Tenant-Name: {your_email}"

Lấy thông tin chi tiết của snapshot

Parameters
No parameters

- DELETE /snapshots/{snapshot_id}

curl --location --request DELETE "https://manage.bizflycloud.vn/iaas-cloud/api/snapshots/{snapshot_id}" \
  --header "X-Auth-Token: {token}"

Xóa snapshot

Parameters
No parameters

Keypair

- GET /keypairs

curl --location --request GET "https://manage.bizflycloud.vn/iaas-cloud/api/keypairs" \
  --header "X-Auth-Token: {token}"
  --header "X-Tenant-Name: {your_email}"

Liệt kê danh sách keypair có trong tài khoản

Parameters
No parameters

- POST /keypairs

curl --location --request POST "https://manage.bizflycloud.vn/iaas-cloud/api/keypairs" \
  --header "X-Auth-Token: {token}" \
  --header "X-Tenant-Name: {your_email}"
  --header "Content-Type: application/json" \
  --data ""

Tạo hoặc import keypair

Body Example

{
    "name": "bizflycloud",
    "public_key": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAACAQC/9oVvOaykPX6AWMFq5H1FqQL4xcHW5InB4EOxv9YzL+m3BnTAOnZvt6QnrF+aFUlSlzeM+o+147dEAKD89AUsttggMAi9kpgC9Lh+FP8R5uaE/bb8l26Uoj21/CMN3p+o5XIxdA7vgbeSjuUJDB5IDGbLfHPQaGCUdcWvgDk2Zj+GwGECyHnexZ4pzjRpQfgQ8kk04ZbhVTKoKratfSU+E467FPkaGvSviu8CW//Q9gCFreyhtVyr4Z4qRKuRi6SFKU29l0pxboTpFIgKGk6gIUVBjNm+aJjDv/wpus4Q7G4mFUApv7/Julh9OCVdv8/IzZ77b2W7ieGrM+zNrSs5fRV3/FI6EC8s795KHMdL7IDlLe8ovYe3DcXi59bPXUg2RvnlKGBweK8UPTrNX/p4EEPrbLYKEVUUOdrzdEC82pFducdUaqj1SMbv1XehjFfKwz3ASQuOHkGIk3y+CHxuNEub/vcpP6xZnJtdFmEwah1fKzicMnmJmaOGo8E6+vPJMA5QDo/9sXvD9MiQ7yZFIyvPj2BvTNS77vsAr+90YUQD33SIVaf3jPAiyWMgkg7BetHyBkCH2SFwera8CgtiqpxfqU3CPlWqGpS9TZAFDU1NIhGa4oigep4zgA1WEz9o0soQP0HnqvEHHa3A0mIknK7J455ew5EPorpM3Xb8yQ== congnt@vccloud.vn"
}

Body Parameters

Tên Loại giá trị Mô tả
name string Tên keypair muốn khởi tạo. Nếu chưa có keypair thì chỉ cần truyền name, nếu đã có cặp key cần truyền thêm public_key
public_key string Nếu bạn đã có sẵn cặp key và muốn import vào thì truyền thêm public_key

- DELETE /keypairs/{key_name}

curl --location --request DELETE "https://manage.bizflycloud.vn/iaas-cloud/api/keypairs/{key_name}" \
  --header "X-Auth-Token: {token}"
  --header "X-Tenant-Name: {your_email}"

Xóa keypair

Parameters
No parameters

Backup Calendars

- GET /backup

curl --location --request GET "https://manage.bizflycloud.vn/iaas-cloud/api/backup" \
  --header "X-Auth-Token: {token}"
  --header "X-Tenant-Name: {your_email}"

Liệt kê toàn bộ lịch backup trong tài khoản của bạn

Parameters
No parameters

- POST /backup

curl --location --request POST "https://manage.bizflycloud.vn/iaas-cloud/api/backup" \
  --header "X-Auth-Token: {token}"\
  --header "X-Tenant-Name: {your_email}"
  --header "Content-Type: application/json" \
  --data ""

Tạo lịch backup cho volume

Body Example

{
   "resource_id": "bfa4a464-27af-4e12-b42e-470a459823df",
   "hour": 16,
   "frequency": 1440,
   "size": 2
}

Body Parameters

Tên Loại giá trị Mô tả
resource_id string ID Volume muốn lập lịch backup
hour int Giờ muốn bắt đầu backup
frequency int Chu kỳ muốn backup
size int Số lượng bản backup muốn giữ lại

- GET /backup/{backup_id}

curl --location --request GET "https://manage.bizflycloud.vn/iaas-cloud/api/backup/{backup_id}" \
  --header "X-Auth-Token: {token}"
  --header "X-Tenant-Name: {your_email}"

Lấy thông chi tiết lịch backup

Parameters
No parameters

- DELETE /backup/{backup_id}

curl --location --request DELETE "https://manage.bizflycloud.vn/iaas-cloud/api/backup/{backup_id}" \
  --header "X-Auth-Token: {token}"
  --header "X-Tenant-Name: {your_email}"

Xóa lịch backup

Parameters
No parameters

- PUT /backup/{backup_id}

curl --location --request PUT "https://manage.bizflycloud.vn/iaas-cloud/api/backup/{backup_id}" \
  --header "X-Auth-Token: {token}" \ 
  --header "X-Tenant-Name: {your_email}"
  --header "Content-Type: application/json" \
  --data ""

Cập nhật lịch backup.

Body Example

{
   "hour": 10,
   "frequency": 2880,
   "size": 3
}

Body Parameters

Tên Loại giá trị Mô tả
hour int Giờ muốn bắt đầu backup
frequency int Chu kỳ muốn backup
size int Số lượng bản backup muốn giữ lại

Firewall

- GET /firewalls

curl --location --request GET "https://manage.bizflycloud.vn/iaas-cloud/api/firewalls" \
  --header "X-Auth-Token: {token}"
  --header "X-Tenant-Name: {your_email}"

Liệt kê danh sách firewall trong tài khoản của bạn

Parameters
No parameters

- POST /firewalls

curl --location --request POST "https://manage.bizflycloud.vn/iaas-cloud/api/firewalls" \
  --header "X-Auth-Token: {token}" \
  --header "X-Tenant-Name: {your_email}"
  --header "Content-Type: application/json" \
  --data ""

Tạo firewall

Body Example

{
  "name": "bizflycloud-firewall",
  "inbound": [
    { "type": "SSH",
      "protocol": "TCP",
      "port_range": "22",
      "cidr": "0.0.0.0/0"
    },
    { "type": "HTTP",
      "protocol": "TCP",
      "port_range": "80",
      "cidr": "192.168.17.5"
    },
    { "type": "SSH",
      "protocol": "TCP",
      "port_range": "22",
      "cidr": "2001:0db8:85a3:0000:0000:8a2e:0370:7334/128"
    }
  ],
  "outbound": [
    { "type": "PING",
      "protocol": "ICMP",
      "cidr": "::/0"
    },
    { "type": "CUSTOM",
      "protocol": "TCP",
      "port_range": "1-255",
      "cidr": "192.168.0.0/28"
    }

  ],
  "targets": ["26b5cb61-95bb-417e-a1a3-2ea51f40d6ee"]
}

Body Parameters

Tên Loại giá trị Mô tả
name string Tên firewall muốn khởi tạo
inbound list Danh sách các quy tắc tường lửa từ ngoài vào bên trong server
outbound lít Danh sách các quy tắc tường lửa từ bên trong server ra ngoài
type string SSH, RDP, HTTP, HTTPS, MySQL, DNS TCP, DNS UDP, ALL UDP, ALL TCP, PING, CUSTOM, ALL OUT
protocol string Gồm các giao thức UDP, TCP, ICMP
port_range string Port hoặc danh sách các port
cidr string Địa chỉ IP hoặc subnet. Có thể sử dụng IPv4 và IPv6
targets list Danh sách các server muốn gắn firewall vào.

- PATCH /firewalls/{firewall_id}

curl --location --request PATCH "https://manage.bizflycloud.vn/iaas-cloud/api/firewalls/{firewall_id}" \
  --header "X-Auth-Token: {token}" \
  --header "X-Tenant-Name: {your_email}"
  --header "Content-Type: application/json" \
  --data ""

Cập nhật một phần hoặc toàn bộ firewall.

Body Example

{
  "inbound": [
    { "type": "SSH",
      "protocol": "TCP",
      "port_range": "22",
      "cidr": "0.0.0.0/0"
    },
    { "type": "HTTP",
      "protocol": "TCP",
      "port_range": "80",
      "cidr": "10.5.68.111"
    },
  ],
  "outbound": [
  ],
  "targets": ["26b5cb61-95bb-417e-a1a3-2ea51f40d6ee"]
}

Body Parameters

Tên Loại giá trị Mô tả
name string Tên firewall muốn khởi tạo
inbound list Danh sách các quy tắc tường lửa từ ngoài vào bên trong server
outbound lít Danh sách các quy tắc tường lửa từ bên trong server ra ngoài
type string SSH, RDP, HTTP, HTTPS, MySQL, DNS TCP, DNS UDP, ALL UDP, ALL TCP, PING, CUSTOM, ALL OUT
protocol string Gồm các giao thức UDP, TCP, ICMP
port_range string Port hoặc danh sách các port
cidr string Địa chỉ IP hoặc subnet. Có thể sử dụng IPv4 và IPv6
targets list Danh sách các server muốn gắn firewall vào.

- GET /firewalls/{firewall_id}

curl --location --request GET "https://manage.bizflycloud.vn/iaas-cloud/api/firewalls/{firewall_id}" \
  --header "X-Auth-Token: {token}"
  --header "X-Tenant-Name: {your_email}"

Lấy thông tin chi tiết của firewall

Parameters
No parameters

- DELETE /firewalls/{firewall_id}

curl --location --request DELETE "https://manage.bizflycloud.vn/iaas-cloud/api/firewalls/{firewall_id}" \
  --header "X-Auth-Token: {token}"
  --header "X-Tenant-Name: {your_email}"

Xóa firewall

Parameters
No parameters

- DELETE /firewalls/{firewall_id}/servers

curl --location --request DELETE "https://manage.bizflycloud.vn/iaas-cloud/api/firewalls/b4ad432c-4c1a-473a-af87-84adf8f85609/servers" \
  --header "X-Auth-Token: {token}" \
  --header "X-Tenant-Name: {your_email}"
  --header "Content-Type: application/json" \
  --data ""

Xóa firewall ra khỏi server

Body Example

{"servers": ["a42d2fec-48c6-47b3-bf92-79f13f6b75c2"]}

Body Parameters

Tên Loại giá trị Mô tả
servers List Danh sách các server muốn xóa firewall

RESTful API Errors

The Cloud Server API uses the following error codes:

Code Meaning
400 Bad Request -- Your request is invalid.
401 Unauthorized -- Your API key is wrong.
403 Forbidden -- The kitten requested is hidden for administrators only.
404 Not Found -- The specified kitten could not be found.
405 Method Not Allowed -- You tried to access a kitten with an invalid method.
406 Not Acceptable -- You requested a format that isn't json.
410 Gone -- The kitten requested has been removed from our servers.
418 I'm a teapot.
429 Too Many Requests -- You're requesting too many kittens! Slow down!
500 Internal Server Error -- We had a problem with our server. Try again later.
503 Service Unavailable -- We're temporarily offline for maintenance. Please try again later.