ByCloud Docs
GuidesCLIAPISDK

Python SDK

Compute

Virtual machines, flavors, images, and keypairs

18 methods

GET

list_flavors()

List flavors

Parameters

limit

integer

- Maximum number of items to return

marker

string

- ID of the last item from the previous page (for pagination)

min_ram

integer

- Filter by minimum RAM (MB)

min_disk

integer

- Filter by minimum disk (GB)

min_vcpus

integer

- Filter by minimum vCPUs

Example

from bycloud import ByCloud


client = ByCloud(token="YOUR_ACCESS_TOKEN")


result = client.compute.list_flavors()
print(result)
GET

get_flavor()

Get flavor

Parameters

flavor_id

string

required

- Flavor ID

Example

from bycloud import ByCloud


client = ByCloud(token="YOUR_ACCESS_TOKEN")


result = client.compute.get_flavor(flavor_id="550e8400-e29b-41d4-a716-446655440000")
print(result)
GET

list_images()

List images

Parameters

limit

integer

- Maximum number of items to return

marker

string

- ID of the last item from the previous page (for pagination)

name

string

- Filter by name (exact match or prefix with *)

status

string

- Filter by status

tags

string

- Filter by tags (comma-separated)

visibility

string

- Filter by visibility

os_distro

string

- Filter by OS distribution

os_version

string

- Filter by OS version

architecture

string

- Filter by architecture

Example

from bycloud import ByCloud


client = ByCloud(token="YOUR_ACCESS_TOKEN")


result = client.compute.list_images()
print(result)
GET

get_image()

Get image

Parameters

image_id

string

required

- Image ID

Example

from bycloud import ByCloud


client = ByCloud(token="YOUR_ACCESS_TOKEN")


result = client.compute.get_image(image_id="550e8400-e29b-41d4-a716-446655440000")
print(result)
GET

list_instances()

List instances

Parameters

limit

integer

- Maximum number of items to return

marker

string

- ID of the last item from the previous page (for pagination)

name

string

- Filter by name (exact match or prefix with *)

status

string

- Filter by status

tags

string

- Filter by tags (comma-separated)

flavor_id

string

- Filter by flavor ID

image_id

string

- Filter by image ID

Example

from bycloud import ByCloud


client = ByCloud(token="YOUR_ACCESS_TOKEN")


result = client.compute.list_instances()
print(result)
POST

create_instance()

Create instance

Parameters

name

string

required
description

string

flavor_id

string

required

- Flavor ID

image_id

string

- Image ID (required if not booting from volume)

key_names

array

- SSH keypair names to authorize on the instance

security_groups

array

- Security group names or IDs

networks

array

- Networks to attach

assign_public_ip

boolean

- Assign a public IP address to the instance

volumes

array

- Volume attachments for boot from volume

metadata

object

tags

array

user_data

string

- Base64-encoded user data (cloud-init)

Example

from bycloud import ByCloud


client = ByCloud(token="YOUR_ACCESS_TOKEN")


result = client.compute.create_instance(name="web-server-01", flavor_id="550e8400-e29b-41d4-a716-446655440000")
print(result)
GET

get_instance()

Get instance

Parameters

instance_id

string

required

- Instance ID

Example

from bycloud import ByCloud


client = ByCloud(token="YOUR_ACCESS_TOKEN")


result = client.compute.get_instance(instance_id="550e8400-e29b-41d4-a716-446655440000")
print(result)
PATCH

update_instance()

Update instance

Parameters

instance_id

string

required

- Instance ID

name

string

description

string

metadata

object

tags

array

Example

from bycloud import ByCloud


client = ByCloud(token="YOUR_ACCESS_TOKEN")


result = client.compute.update_instance(instance_id="550e8400-e29b-41d4-a716-446655440000")
print(result)
DELETE

delete_instance()

Delete instance

Parameters

instance_id

string

required

- Instance ID

Example

from bycloud import ByCloud


client = ByCloud(token="YOUR_ACCESS_TOKEN")


result = client.compute.delete_instance(instance_id="550e8400-e29b-41d4-a716-446655440000")
print(result)
GET

get_instance_console()

Get instance console

Parameters

instance_id

string

required

- Instance ID

type

string

- Console type

Example

from bycloud import ByCloud


client = ByCloud(token="YOUR_ACCESS_TOKEN")


result = client.compute.get_instance_console(instance_id="550e8400-e29b-41d4-a716-446655440000")
print(result)
POST

reboot_instance()

Reboot instance

Parameters

instance_id

string

required

- Instance ID

type

string

- Reboot type

Example

from bycloud import ByCloud


client = ByCloud(token="YOUR_ACCESS_TOKEN")


result = client.compute.reboot_instance(instance_id="550e8400-e29b-41d4-a716-446655440000")
print(result)
POST

resize_instance()

Resize instance

Parameters

instance_id

string

required

- Instance ID

flavor_id

string

required

- New flavor ID

Example

from bycloud import ByCloud


client = ByCloud(token="YOUR_ACCESS_TOKEN")


result = client.compute.resize_instance(instance_id="550e8400-e29b-41d4-a716-446655440000", flavor_id="550e8400-e29b-41d4-a716-446655440000")
print(result)
POST

start_instance()

Start instance

Parameters

instance_id

string

required

- Instance ID

Example

from bycloud import ByCloud


client = ByCloud(token="YOUR_ACCESS_TOKEN")


result = client.compute.start_instance(instance_id="550e8400-e29b-41d4-a716-446655440000")
print(result)
POST

stop_instance()

Stop instance

Parameters

instance_id

string

required

- Instance ID

Example

from bycloud import ByCloud


client = ByCloud(token="YOUR_ACCESS_TOKEN")


result = client.compute.stop_instance(instance_id="550e8400-e29b-41d4-a716-446655440000")
print(result)
GET

list_keypairs()

List keypairs

Example

from bycloud import ByCloud


client = ByCloud(token="YOUR_ACCESS_TOKEN")


result = client.compute.list_keypairs()
print(result)
POST

create_keypair()

Create keypair

Parameters

name

string

required
public_key

string

- SSH public key (if not provided, a new keypair will be generated)

type

string

Example

from bycloud import ByCloud


client = ByCloud(token="YOUR_ACCESS_TOKEN")


result = client.compute.create_keypair(name="my-keypair")
print(result)
GET

get_keypair()

Get keypair

Parameters

keypair_name

string

required

- Keypair name

Example

from bycloud import ByCloud


client = ByCloud(token="YOUR_ACCESS_TOKEN")


result = client.compute.get_keypair(keypair_name="example")
print(result)
DELETE

delete_keypair()

Delete keypair

Parameters

keypair_name

string

required

- Keypair name

Example

from bycloud import ByCloud


client = ByCloud(token="YOUR_ACCESS_TOKEN")


result = client.compute.delete_keypair(keypair_name="example")
print(result)