FrontEnd API (Project Nano)

bokuore frontenden
Help

Apiary Powered Documentation

Sign in with Apiary account.

FrontEnd API (Project Nano)

Introduction

RESTful API provided by FrontEnd module, listen at port 5870 by default.

This document corresponds to version 1.3.1

Verify and allocate a new session before call functions, set session ID in header 'Nano-Session' for authentication.

Data Structures

GuestConfig
object
  • name
    guest name
    string
  • owner
    user id
    string
  • group
    user group
    string
  • pool
    compute pool name
    string
  • cores
    number of cpu cores
    number
  • memory
    memory size in bytes
    number
  • disks

    [system_disk_size, data_disk_n_size...], size in bytes

    array[number]
  • auto_start
    auto start instance
    boolean
  • system

    system type, "linux", "windows", etc

    string, optional
  • network_address
    optional specified ip address
    string, optional
  • ethernet_address
    optional specified mac address
    string, optional
  • from_image
    ID of source disk image when cloning
    string, optional
  • ports
    nat ports
    array, optional[number]
  • template
    id of system template
    string
  • modules

    installed guest module, "qemu"/"cloud-init"

    array, optional[string]
  • cloud_init

    cloud-init params

    object, optional
  • qos
    qos config
    object, optional
  • security_policy_group
    id of security group
    string, optional
InterfaceStatus
object
  • network_address

    network address of interface, IPv4 dot format: '172.10.6.8'

    string
  • display_address

    monitor address of guest, 'host:port'

    string
  • allocated_address
    interface address allocated by system when attached with address pool
    string, optional
InstanceData
object
  • name
    guest name
    string
  • owner
    user id
    string
  • group
    user group
    string
  • pool
    compute pool name
    string
  • cores
    number of cpu cores
    number
  • memory
    memory size in bytes
    number
  • disks

    [system_disk_size, data_disk_n_size...], size in bytes

    array[number]
  • auto_start
    auto start instance
    boolean
  • system
    id of system
    string, optional
  • network_address
    optional specified ip address
    string, optional
  • ethernet_address
    optional specified mac address
    string, optional
  • from_image
    ID of source disk image when cloning
    string, optional
  • ports
    nat ports
    array, optional[number]
  • template
    id of system template
    string
  • modules

    installed guest module, "qemu"/"cloud-init"

    array, optional[string]
  • cloud_init

    cloud-init params

    object, optional
  • qos
    qos config
    object, optional
  • security_policy_group
    id of security group
    string, optional
  • id
    guest ID
    string
  • created
    is instance created
    boolean
  • running
    is instance running
    boolean
  • cell
    name of hosting cell
    string, optional
  • host

    IP/domain of hosting server

    string, optional
  • lost
    is instance lost
    boolean, optional
  • monitor_secret
    monitor password
    string, optional
  • display_protocol
    name of monitor protocol
    string, optional
  • total_disk
    total disk size in bytes
    number
  • progress

    creating progress, range from 0 to 100

    number, optional
  • create_time

    created time in format 'YYYY-MM-DD HH:MI:SS'

    string, optional
  • internal
    status of internal network interface
    object, optional
  • external
    status of external network interface
    object, optional
InstanceStatus
object
  • name
    guest name
    string
  • owner
    user id
    string
  • group
    user group
    string
  • pool
    compute pool name
    string
  • cores
    number of cpu cores
    number
  • memory
    memory size in bytes
    number
  • disks

    [system_disk_size, data_disk_n_size...], size in bytes

    array[number]
  • auto_start
    auto start instance
    boolean
  • system
    id of system
    string, optional
  • network_address
    optional specified ip address
    string, optional
  • ethernet_address
    optional specified mac address
    string, optional
  • from_image
    ID of source disk image when cloning
    string, optional
  • ports
    nat ports
    array, optional[number]
  • template
    id of system template
    string
  • modules

    installed guest module, "qemu"/"cloud-init"

    array, optional[string]
  • cloud_init

    cloud-init params

    object, optional
  • qos
    qos config
    object, optional
  • security_policy_group
    id of security group
    string, optional
  • id
    guest ID
    string
  • created
    is instance created
    boolean
  • running
    is instance running
    boolean
  • cell
    name of hosting cell
    string, optional
  • host

    IP/domain of hosting server

    string, optional
  • lost
    is instance lost
    boolean, optional
  • monitor_secret
    monitor password
    string, optional
  • display_protocol
    name of monitor protocol
    string, optional
  • total_disk
    total disk size in bytes
    number
  • progress

    creating progress, range from 0 to 100

    number, optional
  • create_time

    created time in format 'YYYY-MM-DD HH:MI:SS'

    string, optional
  • internal
    status of internal network interface
    object, optional
  • external
    status of external network interface
    object, optional
  • cpu_usage
    total CPU usage range from 0.00 to 100.00
    number
  • memory_available
    available memory size in bytes
    number
  • disk_available
    available disk size in bytes
    number
  • bytes_read
    total read disk bytes
    number
  • bytes_written
    total written disk bytes
    number
  • bytes_received
    total received network bytes
    number
  • bytes_sent
    total sent network bytes
    number
  • media_attached
    is media image attached
    boolean, optional
  • media_source
    id of attached media image
    string, optional
QoS
object
  • cpu_priority
    CPU priority
    enum, optional
  • write_speed

    disk write bps limit, 0 = unlimited

    number, optional
    10485760
  • write_iops

    disk write iops limit, 0 = unlimited

    number, optional
    100
  • read_speed

    disk read bps limit, 0 = unlimited

    number, optional
    10485760
  • read_iops

    disk read iops limit, 0 = unlimited

    number, optional
    100
  • receive_speed

    network receive bps, 0 = unlimited

    number, optional
    10485760
  • send_speed

    network send bps, 0 = unlimited

    number, optional
    10485760
CloudInit
object
  • root_enabled

    allow root user login via SSH, enable in default

    boolean, optional
    true
  • admin_name

    specify admin name, using root when omitted

    string, optional
    nano
  • admin_secret

    password in plain text, nano generate a new one when omitted

    string, optional
  • data_path

    data disk mount path, /opt/data in default

    string, optional
ComputePoolConfig
object
  • storage

    name of storage pool, using local storage when omit

    string, optional
  • network

    name of address pool, using bridge mode by default when omit

    string, optional
  • failover
    enable failover on shared storage
    boolean
ComputePoolStatus
object
  • storage

    name of storage pool, using local storage when omit

    string, optional
  • network

    name of address pool, using bridge mode by default when omit

    string, optional
  • failover
    enable failover on shared storage
    boolean
  • name
    pool name
    string
  • enabled
    is pool enabled
    boolean
  • cells
    count of attached cells in the pool
    number
StoragePoolConfig
object
  • type
    backend storage type
    enum
  • host
    IP or hostname of target host
    string, optional
  • target
    path of target host
    string, optional
CellStorage
object
  • mode
    cell storage mode
    enum
  • system

    disk path for storage system disk of guests, available for local mode

    array, optional[string]
  • data

    disk path for storage data disk of guests, available for local mode

    array, optional[string]
StoragePoolStatus
object
  • type
    backend storage type
    enum
  • host
    IP or hostname of target host
    string, optional
  • target
    path of target host
    string, optional
  • name
    name of storage pool
    string
AllocatedAddress
object
  • address
    allocated address
    string
  • instance
    id of allocated instance
    string
  • type
    address type
    enum, optional
AddressRange
object
  • start
    start of address range
    string
  • end
    end of address range
    string
  • netmask
    netmask of address range
    string
  • type
    address type
    enum, optional
AddressPoolConfigure
object
  • name
    pool name
    string
  • gateway
    gateway address
    string
  • provider
    provider method
    enum, optional
  • mode
    network interface mode
    enum, optional
AddressPoolStatus
object
  • name
    pool name
    string
  • gateway
    gateway address
    string
  • provider
    provider method
    enum, optional
  • mode
    network interface mode
    enum, optional
  • ranges
    list of address range
    array, optional
  • allocated
    list of allocated address
    array, optional
AddressPoolSummary
object
  • name
    pool name
    string
  • gateway
    gateway address
    string
  • provider
    provider method
    enum, optional
  • mode
    network interface mode
    enum, optional
  • addresses
    address count
    number
  • allocated
    allocated count
    number
StatisticData
object
  • name
    source name
    string
  • cpu_usage
    used cores in total
    number
  • max_cpu
    total number of cores
    number
  • available_memory
    total usable memory in bytes
    number
  • max_memory
    all memory in bytes
    number
  • available_disk
    total usable disk in bytes
    number
  • max_disk
    all disk in bytes
    number
  • read_speed
    disk read speed in bytes per second
    number
  • write_speed
    disk write speed in bytes per second
    number
  • receive_speed
    network receive speed in bytes per second
    number
  • send_speed
    network send speed in bytes per second
    number
ZoneStatistic
object
  • name
    source name
    string
  • cpu_usage
    used cores in total
    number
  • max_cpu
    total number of cores
    number
  • available_memory
    total usable memory in bytes
    number
  • max_memory
    all memory in bytes
    number
  • available_disk
    total usable disk in bytes
    number
  • max_disk
    all disk in bytes
    number
  • read_speed
    disk read speed in bytes per second
    number
  • write_speed
    disk write speed in bytes per second
    number
  • receive_speed
    network receive speed in bytes per second
    number
  • send_speed
    network send speed in bytes per second
    number
  • pools

    [disabledPools, enabledPools]

    array[number]
  • cells

    [offlineCells, onlineCells]

    array[number]
  • instances

    [stoppedInstances, runningInstances, lostInstances, migratingInstances]

    array[number]
  • start_time

    system start time in 'YYYY-MM-DD HH:MI:SS' format

    string
PoolStatistic
object
  • name
    source name
    string
  • cpu_usage
    used cores in total
    number
  • max_cpu
    total number of cores
    number
  • available_memory
    total usable memory in bytes
    number
  • max_memory
    all memory in bytes
    number
  • available_disk
    total usable disk in bytes
    number
  • max_disk
    all disk in bytes
    number
  • read_speed
    disk read speed in bytes per second
    number
  • write_speed
    disk write speed in bytes per second
    number
  • receive_speed
    network receive speed in bytes per second
    number
  • send_speed
    network send speed in bytes per second
    number
  • enabled
    is pool enabled
    boolean
  • cells

    [offlineCells, onlineCells]

    array[number]
  • instances

    [stoppedInstances, runningInstances, lostInstances, migratingInstances]

    array[number]
CellStatistic
object
  • name
    source name
    string
  • cpu_usage
    used cores in total
    number
  • max_cpu
    total number of cores
    number
  • available_memory
    total usable memory in bytes
    number
  • max_memory
    all memory in bytes
    number
  • available_disk
    total usable disk in bytes
    number
  • max_disk
    all disk in bytes
    number
  • read_speed
    disk read speed in bytes per second
    number
  • write_speed
    disk write speed in bytes per second
    number
  • receive_speed
    network receive speed in bytes per second
    number
  • send_speed
    network send speed in bytes per second
    number
  • address
    IP or hostname of cell node
    string
  • enabled
    is cell enabled
    boolean
  • alive
    is cell alive
    boolean
Visibility
object
  • instance_visible
    user can view instances in the same group
    boolean
    true
  • media_image_visible
    user can view media images in the same group
    boolean
    true
  • disk_image_visible
    user can view disk images in the same group
    boolean
    false
TemplateConfigure
object
  • name
    template name
    string
  • admin
    default administrator name
    string
  • operating_system
    operating system
    enum
  • disk
    disk driver type
    enum
  • network
    network model
    enum
  • display
    display driver
    enum
  • control
    remote control
    enum
  • usb
    usb interface model
    enum
  • tablet
    tablet interface model
    enum
TemplateStatus
object
  • name
    template name
    string
  • admin
    default administrator name
    string
  • operating_system
    operating system
    enum
  • disk
    disk driver type
    enum
  • network
    network model
    enum
  • display
    display driver
    enum
  • control
    remote control
    enum
  • usb
    usb interface model
    enum
  • tablet
    tablet interface model
    enum
  • id
    template id
    string
  • created_time

    template created time, format YYYY-MM-DD HH:MI:SS

    string
  • modified_time

    template modified time, format YYYY-MM-DD HH:MI:SS

    string
TemplateBrief
object
  • id
    template id
    string
  • name
    template name
    string
  • operating_system
    operating system
    enum
  • created_time

    template created time, format YYYY-MM-DD HH:MI:SS

    string
  • modified_time

    template modified time, format YYYY-MM-DD HH:MI:SS

    string
SecurityPolicyRule
object
  • action
    action when rule matched
    enum
  • to_port
    destination port
    number
  • protocol
    match protocol
    enum
  • from_address
    packet source address
    string, optional
  • interface

    index of match interface, 0 for all, 1 for first

    number, optional
SecurityPolicyGroupConfig
object
  • name
    group name
    string
  • description
    group description
    string, optional
  • user
    creator id
    string
  • group
    group id of creator
    string
  • enabled
    policy group enabled
    boolean
  • global
    global policy group visiable to all users
    boolean
  • default_action
    default action when no rule matched
    enum
SecurityPolicyGroupStatus
object
  • name
    group name
    string
  • description
    group description
    string, optional
  • user
    creator id
    string
  • group
    group id of creator
    string
  • enabled
    policy group enabled
    boolean
  • global
    global policy group visiable to all users
    boolean
  • default_action
    default action when no rule matched
    enum
  • id
    group id
    string
ImageConfigure
object
  • name
    image name
    string
  • owner
    owner name of image
    string
  • group
    group name of owner
    string
  • description
    image description
    string, optional
  • tags
    image tags
    array, optional[string]
ImageStatus
object
  • name
    image name
    string
  • owner
    owner name of image
    string
  • group
    group name of owner
    string
  • description
    image description
    string, optional
  • tags
    image tags
    array, optional[string]
  • id
    image id
    string, optional
  • created
    image created
    boolean
  • progress
    progress range from 0 to 100
    number, optional
  • create_time

    created time, format YYYY-MM-DD HH:MI:SS

    string, optional
  • modify_time

    modified time, format YYYY-MM-DD HH:MI:SS

    string, optional
  • size
    image size in bytes
    number, optional
DiskImage
object
  • name
    image name
    string
  • owner
    owner name of image
    string
  • group
    group name of owner
    string
  • description
    image description
    string, optional
  • tags
    image tags
    array, optional[string]
  • guest
    source guest id
    string

Reference

Resource Pool


APIs for manage resource pools

Compute Pool

Manage compute pools

Get All Compute Pools

Query all compute pools in current zone

Response
object
  • error_code
    error code
    number
  • message
    error message
    string, optional
  • data
    list of compute pools
    array

Get Compute Pool Status

Get status of a compute pool

URI Parameters
poolname of compute pool
Response
object
  • error_code
    error code
    number
  • message
    error message
    string, optional
  • data
    status of compute pool
    object

Create New Compute Pool

Create a new compute pool

URI Parameters
poolname of compute pool
Request
object
  • storage

    name of storage pool, using local storage when omit

    string, optional
  • network

    name of address pool, using bridge mode by default when omit

    string, optional
  • failover
    enable failover on shared storage
    boolean
Response
object
  • error_code
    error code
    number
  • message
    error message
    string, optional

Delete Compute Pool

Delete a compute pool

URI Parameters
poolname of compute pool
Response
object
  • error_code
    error code
    number
  • message
    error message
    string, optional

Modify Compute Pool

Modify configure of a compute pool

URI Parameters
poolname of compute pool
Request
object
  • storage

    name of storage pool, using local storage when omit

    string, optional
  • network

    name of address pool, using bridge mode by default when omit

    string, optional
  • failover
    enable failover on shared storage
    boolean
Response
object
  • error_code
    error code
    number
  • message
    error message
    string, optional

Compute Pool Cell

Manage compute cells in a pool

Query Unallocated Cells

query cells not attached to any pool

Query Cells In Pool

Query all cells attached in a pool

URI Parameters
poolpool name

Add Compute Cell

Add a new cell to the compute pool

URI Parameters
poolpool name
cellcell name
Response
object
  • error_code
    error code
    number
  • message
    error message
    string, optional

Remove Compute Cell

Remove an attached cell from the compute pool

URI Parameters
poolpool name
cellcell name
Response
object
  • error_code
    error code
    number
  • message
    error message
    string, optional

Modify Compute Cell

Modify a compute cell

URI Parameters
poolpool name
cellcell name
Request
object
  • enable
    enable cell. The disabled cell does not participate in instance allocation
    boolean
Response
object
  • error_code
    error code
    number
  • message
    error message
    string, optional

Get Cell Status

Get current status of a compute cell

URI Parameters
poolpool name
cellcell name

Storage Pool

APIs manage the storage pools

Query Storage Pool

Query configures of all storage pool

Get Storage Pool Configure

Get the configure of a storage pool

URI Parameters
poolname of storage pool

Create New Storage Pool

Create a new stoarge pool

URI Parameters
poolname of storage pool
Request
object
  • type
    backend storage type
    enum
  • host
    IP or hostname of target host
    string, optional
  • target
    path of target host
    string, optional
Response
object
  • error_code
    error code
    number
  • message
    error message
    string, optional

Modify Storage Pool

Modify stoarge pool, only available on an empty storage pool.

URI Parameters
poolname of storage pool
Request
object
  • type
    backend storage type
    enum
  • host
    IP or hostname of target host
    string, optional
  • target
    path of target host
    string, optional
Response
object
  • error_code
    error code
    number
  • message
    error message
    string, optional

Delete Storage Pool

Delete a storage pool, only available on an empty storage pool.

URI Parameters
poolname of storage pool
Response
object
  • error_code
    error code
    number
  • message
    error message
    string, optional

Compute Zone Status

Collect status and statistic data on compute zone

Query Zone Status

Query lastest status of a whole zone

Response
object
  • error_code
    error code
    number
  • message
    error message
    string, optional
  • data
    statistic status
    object

Compute Pool Status

Collect statistic status of compute pools

Query Status of All Compute Pools

Collect status of all compute pools

Response
object
  • error_code
    error code
    number
  • message
    error message
    string, optional
  • data
    list of statistic status
    array

Get Status of a Compute Pool

Collect statistic status on a compute pool

URI Parameters
poolname of a compute pool
Response
object
  • error_code
    error code
    number
  • message
    error message
    string, optional
  • data
    statistic status
    object

Compute Cell Status

Collect statistic status of compute cells

Query Status of Compute Cells

Collect statistic status of compute cells in a pool

URI Parameters
poolname of target pool
Response
object
  • error_code
    error code
    number
  • message
    error message
    string, optional
  • data
    list of statistic status
    array

Get Compute Cell Status

Collect statistic status of a compute cell

URI Parameters
cellname of target cell
poolname of target pool
Response
object
  • error_code
    error code
    number
  • message
    error message
    string, optional
  • data
    statistic status
    object

Cell Storages

Manage storage configure of a cell

URI Parameters
poolname of target pool
cellname of target cell

Query Cell Storages

Get Storage Paths for a cell

Response
object
  • error_code
    error code
    number
  • message
    error message
    string, optional
  • data
    cell storages configure
    object

Modify Cell Storage Paths

Modify Storage Paths

Request
object
  • default
    default storage path
    string
Response
object
  • error_code
    error code
    number
  • message
    error message
    string, optional

Instance Status

Query status of instances

Query Status of Instances In Pool

Query status of all instances in a pool

URI Parameters
poolname of target pool
Response
object
  • error_code
    error code
    number
  • message
    error message
    string, optional
  • data
    list of statistic status
    array

Query Instances In Cell

Query status of instances in a cell

URI Parameters
cellname of target cell
poolname of target pool
Response
object
  • error_code
    error code
    number
  • message
    error message
    string, optional
  • data
    list of statistic status
    array

Address Pool

Manage Address Pools

Query All Address Pools

Query all address pools

Response
object
  • error_code
    error code
    number
  • message
    error message
    string, optional
  • data
    list of address pool
    array

Get Address Pool Status

Get address pool status

URI Parameters
namepool name
Response
object
  • error_code
    error code
    number
  • message
    error message
    string, optional
  • data
    address pool status
    object

Create New Address Pool

Create a new address pool

URI Parameters
namepool name
Request
object
  • name
    pool name
    string
  • gateway
    gateway address
    string
  • provider
    provider method
    enum, optional
  • mode
    network interface mode
    enum, optional
Response
object
  • error_code
    error code
    number
  • message
    error message
    string, optional

Modify Address Pool

Modify address pool

URI Parameters
namepool name
Request
object
  • name
    pool name
    string
  • gateway
    gateway address
    string
  • provider
    provider method
    enum, optional
  • mode
    network interface mode
    enum, optional
Response
object
  • error_code
    error code
    number
  • message
    error message
    string, optional

Delete Address Pool

Delete an address pool

URI Parameters
namepool name
Response
object
  • error_code
    error code
    number
  • message
    error message
    string, optional

Address Range

Manage Address Range

Query Address Ranges

Query all ranges in pool

URI Parameters
namename of address pool
typerange type
Response
object
  • error_code
    error code
    number
  • message
    error message
    string, optional
  • data
    list of address range
    array

Get Address Ranges Status

Get address range status

URI Parameters
startstart address of range
namename of address pool
typerange type
Response
object
  • error_code
    error code
    number
  • message
    error message
    string, optional
  • data
    object

Add Address Range

Add a new address range

URI Parameters
startstart address of range
namename of address pool
typerange type
Request
object
  • end
    end address of ip range
    string
  • netmask
    netmask of ip range
    string
Response
object
  • error_code
    error code
    number
  • message
    error message
    string, optional

Remove Address Range

Remove an address range

URI Parameters
startstart address of range
namename of address pool
typerange type
Response
object
  • error_code
    error code
    number
  • message
    error message
    string, optional

Virtual machines


Manage All guests and instances

Guest Query

Interface for query all guest in specified pool, cell or status flags

URI Parameters
pooltarget pool name
celltarget cell
statusrunning status
createdguest created

Query Guests With Conditions

Response
object
  • error_code
    error code
    number
  • message
    error message
    string, optional
  • data
    list of instances
    array

Manage Guest

Creating, Deleting or query one guest

Query Guest Status

Get status with ID when creating, 201 for creating guest, 200 for created guest

URI Parameters
idguest id
Response
object
  • error_code
    error code
    number
  • message
    error message
    string, optional
  • data
    object
Response
object
  • error_code
    error code
    number
  • message
    error message
    string, optional
  • data
    current instance data
    object

Create Guest

Creating a new guest, return an ID for later querying

Request
object
  • name
    guest name
    string
  • owner
    user id
    string
  • group
    user group
    string
  • pool
    compute pool name
    string
  • cores
    number of cpu cores
    number
  • memory
    memory size in bytes
    number
  • disks

    [system_disk_size, data_disk_n_size...], size in bytes

    array[number]
  • auto_start
    auto start instance
    boolean
  • system
    id of system
    string, optional
  • network_address
    optional specified ip address
    string, optional
  • ethernet_address
    optional specified mac address
    string, optional
  • from_image
    ID of source disk image when cloning
    string, optional
  • ports
    nat ports
    array, optional[number]
  • template
    id of system template
    string
  • modules

    installed guest module, "qemu"/"cloud-init"

    array, optional[string]
  • cloud_init

    cloud-init params

    object, optional
  • qos
    qos config
    object, optional
  • security_policy_group
    id of security group
    string, optional
  • id
    guest ID
    string
  • created
    is instance created
    boolean
  • running
    is instance running
    boolean
  • cell
    name of hosting cell
    string, optional
  • host

    IP/domain of hosting server

    string, optional
  • lost
    is instance lost
    boolean, optional
  • monitor_secret
    monitor password
    string, optional
  • display_protocol
    name of monitor protocol
    string, optional
  • total_disk
    total disk size in bytes
    number
  • progress

    creating progress, range from 0 to 100

    number, optional
  • create_time

    created time in format 'YYYY-MM-DD HH:MI:SS'

    string, optional
  • internal
    status of internal network interface
    object, optional
  • external
    status of external network interface
    object, optional
Response
object
  • error_code
    error code
    number
  • message
    error message
    string, optional
  • data
    object

Delete Guest

delete guest, release all allocated resources

URI Parameters
idguest id
Request
object
  • force
    whether stops instance for deleting
    boolean, optional
Response
object
  • error_code
    error code
    number
  • message
    error message
    string, optional

Auto Start

Enable or disable auto start option of guest

URI Parameters
idguest ID

Modify Auto Start Option

Change status of auto start option

Request
object
  • enable
    enable auto start
    boolean
Response
object
  • error_code
    error code
    number
  • message
    error message
    string, optional

Number Of Cores

Manage cores of guest

URI Parameters
idguest ID

Modify Cores

Change number of cores

Request
object
  • cores
    core number
    number
  • immediate
    take effect when running
    boolean, optional
Response
object
  • error_code
    error code
    number
  • message
    error message
    string, optional

Memory Capacity

URI Parameters
idguest ID

Modify Memory Capacity

Change memory size of guest, only available when guest offline

Request
object
  • memory
    memory in bytes
    number
  • immediate
    take effect when running
    boolean, optional
Response
object
  • error_code
    error code
    number
  • message
    error message
    string, optional

Resize Disk Capacity

Manage disk capacity of guest

URI Parameters
idguest ID
disk

index of target disk, system:0, data0:1, data1:2...

Extend Disk Capacity

Change disk capacity of the guest to larger. Only allow operating in an offline instance.

Request
object
  • size
    size in bytes
    number
  • immediate
    take effect when running
    boolean, optional
Response
object
  • error_code
    error code
    number
  • message
    error message
    string, optional

Shrink Disk Capacity

Shrink the disk capacity of guest

URI Parameters
idguest ID
disk

index of target disk, system:0, data0:1, data1:2...

Shrink Disk File

Shrink size of guest disk file to minimal for building images. Only allow operating in an offline instance.

Request
object
  • immediate
    take effect when running
    boolean, optional
Response
object
  • error_code
    error code
    number
  • message
    error message
    string, optional

Operating System

Manage operating system of guest

URI Parameters
idguest ID

Reset Operating System

Reset operating system of the guest from a disk image, all user data discard.

Request
object
  • from_image
    id of new system image
    string
Response
object
  • error_code
    error code
    number
  • message
    error message
    string, optional

Administrator Password

Manage administator password

URI Parameters
idguest ID

Reset Administrator Password

Reset a new password for administator of guest

Request
object
  • password

    new password, automated generate when omitted

    string, optional
  • user

    username, automated choose username by system type when omitted

    number, optional
Response
object
  • password
    admin password
    string
  • user
    admin name
    number

Get Administrator Password

Get current name and password of administrator

Response
object
  • password
    admin password
    string
  • user
    admin name
    number

Guest Name

Manage name of guest

URI Parameters
idguest ID

Modify Guest Name

Change guest name

Request
object
  • name
    guest name
    string
Response
object
  • error_code
    error code
    number
  • message
    error message
    string, optional

CPU priority

Manage QoS of CPU cores

URI Parameters
idguest ID

Change CPU prioirty

Change CPU priority

Request
object
  • priority
    CPU priority
    enum
Response
object
  • error_code
    error code
    number
  • message
    error message
    string, optional

Disk QoS

Manage Disk QoS

URI Parameters
idguest ID

Modify Disk QoS

Change disk QoS configure

Request
object
  • write_speed

    disk write bps limit, 0 = unlimited

    number, optional
    10485760
  • write_iops

    disk write iops limit, 0 = unlimited

    number, optional
    100
  • read_speed

    disk read bps limit, 0 = unlimited

    number, optional
    10485760
  • read_iops

    disk read iops limit, 0 = unlimited

    number, optional
    100
Response
object
  • error_code
    error code
    number
  • message
    error message
    string, optional

Network QoS

Manage network QoS

URI Parameters
idguest ID

Modify Network QoS

change network QoS configure

Request
object
  • receive_speed

    network receive bps, 0 = unlimited

    number, optional
    10485760
  • send_speed

    network send bps, 0 = unlimited

    number, optional
    10485760
Response
object
  • error_code
    error code
    number
  • message
    error message
    string, optional

Guest Security Policy

Manage security policy of guest

URI Parameters
idguest id

Get Security Policy

Response
object
  • error_code
    error code
    number
  • message
    error message
    string, optional
  • data
    object

Guest Security Policy Default Action

Manage default action of security policy, invoked when a packet does not match any rules.

URI Parameters
idguest id

Change Default Action

Change the default action when no rules matched

Request
object
  • action
    default action when no rule matched
    enum
Response
object
  • error_code
    error code
    number
  • message
    error message
    string, optional

Guest Security Policy Rules

Manage security policy rules

Append New Security Policy Rule

Append new security policy rule to tail

URI Parameters
idguest id
Request
object
  • action
    action when rule matched
    enum
  • to_port
    destination port
    number
  • protocol
    match protocol
    enum
  • from_address
    packet source address
    string, optional
  • interface

    index of match interface, 0 for all, 1 for first

    number, optional
Response
object
  • error_code
    error code
    number
  • message
    error message
    string, optional

Modify Security Policy Rule

Modify Security Policy Rule

URI Parameters
indexindex of policy rule
idguest id
Request
object
  • action
    action when rule matched
    enum
  • to_port
    destination port
    number
  • protocol
    match protocol
    enum
  • from_address
    packet source address
    string, optional
  • interface

    index of match interface, 0 for all, 1 for first

    number, optional
Response
object
  • error_code
    error code
    number
  • message
    error message
    string, optional

Change Rule Order

Change Rule Order

URI Parameters
indexindex of policy rule
idguest id
Request
object
  • direction
    change direction
    enum
Response
object
  • error_code
    error code
    number
  • message
    error message
    string, optional

Remove Security Policy Rule

Remove Security Policy Rule

URI Parameters
indexindex of policy rule
idguest id
Response
object
  • error_code
    error code
    number
  • message
    error message
    string, optional

Manage Instances

Manage guest instances

URI Parameters
idguest ID

Get Running Status

Get current status of an instance

Response
object
  • error_code
    error code
    number
  • message
    error message
    string, optional
  • data
    current status
    object

Start Guest/Instance

Start guest(create instance)

Request
object
  • from_media
    boot from media
    boolean, optional
  • from_network

    boot from network source/PXE

    boolean, optional
  • source

    boot source id/URI

    string, optional
Response
object
  • error_code
    error code
    number
  • message
    error message
    string, optional

Stop Guest/Instance

Stop guest(delete instance)

Request
object
  • reboot
    shutdown or reboot
    boolean
  • force
    force operate
    boolean
Response
object
  • error_code
    error code
    number
  • message
    error message
    string, optional

Instance Media

Manage media in the running instance

URI Parameters
idguest ID

Insert Media

Insert media into a running instance

Request
object
  • source
    media id
    string
  • type

    media type, 0 = Media Image

    number, optional
Response
object
  • error_code
    error code
    number
  • message
    error message
    string, optional

Eject Media

Eject media from a running instance

Response
object
  • error_code
    error code
    number
  • message
    error message
    string, optional

Guest Snapshots

Manage snapshots of a guest

URI Parameters
idguest ID

Query Snapshots

Query all snapshots attached to the guest

Create New Snapshot

Create a new snapshot, only available when guest stopped

Request
object
  • name
    snapshot name
    string
  • description
    snapshot description
    string, optional
Response
object
  • error_code
    error code
    number
  • message
    error message
    string, optional

Restore snapshot

Resume to a specified snapshot, available on stopped guest

Request
object
  • target
    snapshot name
    string
Response
object
  • error_code
    error code
    number
  • message
    error message
    string, optional

Configure Snapshot

Operate on a specified snapshot

URI Parameters
idguest id
namesnapshot

Get snapshot info

Query info of a snapshot

Response
object
  • running
    is running snapshot
    boolean
  • create_time

    created time in 'YYYY-MM-DD HH:MI:SS' format

    string
  • description
    snapshot description
    string, optional

Delete snapshot

Delete a snapshot

Response
object
  • error_code
    error code
    number
  • message
    error message
    string, optional

Monitor Channel

create channel for monitor and control instance. Create a new temporary channel id ABC using POST Method, then connect and consumed channel with websocket address ws://host/monitor_channels/ABC using noVNC or other clients. Unused channel will be released if no connection established in time.

Create New Channel

Establish a new monitor channel

Request
object
  • guest
    target guest id
    string
Response
object
  • error_code
    error code
    number
  • message
    error message
    string, optional
  • data
    object

Image


APIs manage disk and media images

Search Media Images

Search Media Image

Search media images with login session

Response
object
  • error_code
    error code
    number
  • message
    error message
    string, optional
  • data
    list of image status
    array

Media Image

Manage Media Images

Synchronize Local Media Images

Synchronize media images from local directory

Request
object
  • owner
    owner of synchronized image
    string
  • group
    group of synchronized image
    string
Response
object
  • error_code
    error code
    number
  • message
    error message
    string, optional

Query All Media Images

Query all media image

Response
object
  • error_code
    error code
    number
  • message
    error message
    string, optional
  • data
    list of image status
    array

Get Media Image

Get info of media image

URI Parameters
idmedia image id
Response
object
  • error_code
    error code
    number
  • message
    error message
    string, optional
  • data
    image status
    object

Create Media Image

Create a new media image

Request
object
  • name
    image name
    string
  • owner
    owner name of image
    string
  • group
    group name of owner
    string
  • description
    image description
    string, optional
  • tags
    image tags
    array, optional[string]
Response
object
  • error_code
    error code
    number
  • message
    error message
    string, optional
  • data
    object

Modify Media Image

Modify info of media image

URI Parameters
idmedia image id
Request
object
  • name
    image name
    string
  • owner
    owner name of image
    string
  • group
    group name of owner
    string
  • description
    image description
    string, optional
  • tags
    image tags
    array, optional[string]
Response
object
  • error_code
    error code
    number
  • message
    error message
    string, optional

Detele Media Image

Delete a media image

URI Parameters
idmedia image id
Response
object
  • error_code
    error code
    number
  • message
    error message
    string, optional

Media Image File

APIs manage file of media images

URI Parameters
idimage id

Download Image File

Download binary media image data

Upload Image File

Upload iso data as media image

Search disk images

URI Parameters
tagsimage tags

Search Disk Image

Search disk images

Response
object
  • error_code
    error code
    number
  • message
    error message
    string, optional
  • data
    list of image status
    array

Disk Image

Manage Disk Images

Synchronize Local Disk Image

Synchronize disk images from local directory

Response
object
  • error_code
    error code
    number
  • message
    error message
    string, optional

Get Disk Image

Get status of disk image

URI Parameters
iddisk image id
Response
object
  • error_code
    error code
    number
  • message
    error message
    string, optional
  • data
    image status
    object
Response
object
  • error_code
    error code
    number
  • message
    error message
    string, optional
  • data
    image status
    object

Create Disk Image

Clone a new disk image from the source guest, or create an empty one for uploading when the guest ID omits.

Request
object
  • name
    image name
    string
  • owner
    owner name of image
    string
  • group
    group name of owner
    string
  • description
    image description
    string, optional
  • tags
    image tags
    array, optional[string]
  • guest
    source guest id
    string
Response
object
  • error_code
    error code
    number
  • message
    error message
    string, optional
  • data
    object

Modify Disk Image

Modify info of disk image

URI Parameters
iddisk image id
Request
object
  • name
    image name
    string
  • owner
    owner name of image
    string
  • group
    group name of owner
    string
  • description
    image description
    string, optional
  • tags
    image tags
    array, optional[string]
  • guest
    source guest id
    string
Response
object
  • error_code
    error code
    number
  • message
    error message
    string, optional

Delete Disk Image

delete a disk image

URI Parameters
iddisk image id
Response
object
  • error_code
    error code
    number
  • message
    error message
    string, optional

Disk Image File

APIs manage files of disk images

URI Parameters
idimage id

Upload Image File

Upload a qcow2 file as disk image

Response
object
  • error_code
    error code
    number
  • message
    error message
    string, optional

System Maintain


APIs for maintaing system

System Templates

Manage system templates

Query System Templates

Query All Templates

Response
object
  • error_code
    error code
    number
  • message
    error message
    string, optional
  • data
    list of templates
    array

Get System Template

Get configure of a system template

URI Parameters
idtemplate id
Response
object
  • error_code
    error code
    number
  • message
    error message
    string, optional
  • data
    status
    object

Create New System Template

Create System Template

Request
object
  • name
    template name
    string
  • admin
    default administrator name
    string
  • operating_system
    operating system
    enum
  • disk
    disk driver type
    enum
  • network
    network model
    enum
  • display
    display driver
    enum
  • control
    remote control
    enum
  • usb
    usb interface model
    enum
  • tablet
    tablet interface model
    enum
Response
object
  • error_code
    error code
    number
  • message
    error message
    string, optional
  • data
    object

Modify System Templates

Modify System Templates

URI Parameters
idtemplate id
Request
object
  • name
    template name
    string
  • admin
    default administrator name
    string
  • operating_system
    operating system
    enum
  • disk
    disk driver type
    enum
  • network
    network model
    enum
  • display
    display driver
    enum
  • control
    remote control
    enum
  • usb
    usb interface model
    enum
  • tablet
    tablet interface model
    enum
Response
object
  • error_code
    error code
    number
  • message
    error message
    string, optional

Delete System Template

Delete System Template

URI Parameters
idtemplate id
Response
object
  • error_code
    error code
    number
  • message
    error message
    string, optional

Security Policy Group

APIs manage security policy groups

Get Security Group

Get Security Group

URI Parameters
idgroup id
Response
object
  • error_code
    error code
    number
  • message
    error message
    string, optional
  • data
    status
    object

Create Security Group

Create Security Group

Request
object
  • name
    group name
    string
  • description
    group description
    string, optional
  • user
    creator id
    string
  • group
    group id of creator
    string
  • enabled
    policy group enabled
    boolean
  • global
    global policy group visiable to all users
    boolean
  • default_action
    default action when no rule matched
    enum
Response
object
  • error_code
    error code
    number
  • message
    error message
    string, optional
  • data
    object

Modify Security Group

Modify Security Group

URI Parameters
idgroup id
Request
object
  • name
    group name
    string
  • description
    group description
    string, optional
  • user
    creator id
    string
  • group
    group id of creator
    string
  • enabled
    policy group enabled
    boolean
  • global
    global policy group visiable to all users
    boolean
  • default_action
    default action when no rule matched
    enum
Response
object
  • error_code
    error code
    number
  • message
    error message
    string, optional

Delete Security Group

Delete Security Group

URI Parameters
idgroup id
Response
object
  • error_code
    error code
    number
  • message
    error message
    string, optional

Query Security Policy Rules

Query Security Policy Rule

URI Parameters
idgroup id
Response
object
  • error_code
    error code
    number
  • message
    error message
    string, optional
  • data
    list of rules
    array

Add Security Policy Rule

Add Security Policy Rule

URI Parameters
idgroup id
Request
object
  • action
    action when rule matched
    enum
  • to_port
    destination port
    number
  • protocol
    match protocol
    enum
  • from_address
    packet source address
    string, optional
  • interface

    index of match interface, 0 for all, 1 for first

    number, optional
Response
object
  • error_code
    error code
    number
  • message
    error message
    string, optional

Modify Security Policy Rule

Modify Security Policy Rule

URI Parameters
idgroup id
index

index of policy rule, start from 0

Request
object
  • action
    action when rule matched
    enum
  • to_port
    destination port
    number
  • protocol
    match protocol
    enum
  • from_address
    packet source address
    string, optional
  • interface

    index of match interface, 0 for all, 1 for first

    number, optional
Response
object
  • error_code
    error code
    number
  • message
    error message
    string, optional

Change Rule Order

Change Rule Order

URI Parameters
idgroup id
index

index of policy rule, start from 0

Request
object
  • direction
    move direction
    enum
Response
object
  • error_code
    error code
    number
  • message
    error message
    string, optional

Remove Security Policy Rule

Remove Security Policy Rule

URI Parameters
idgroup id
index

index of policy rule, start from 0

Response
object
  • error_code
    error code
    number
  • message
    error message
    string, optional

Migration

Manage instance migrations

Start Migration

Create and start a new migration task

Request
object
  • source_pool
    pool of instance host
    string
  • source_cell
    cell of instance host
    string
  • target_pool
    target pool you want to migrate
    string, optional
  • target_cell
    target cell you want to migrate
    string, optional
  • instances
    UUID list of instances need to migrate
    array, optional[string]
Response
object
  • error_code
    error code
    number
  • message
    error message
    string, optional
  • data
    object

Get Status Of Migration Task

Query status of a migration task

URI Parameters
idmigration task id
Response
object
  • error_code
    error code
    number
  • message
    error message
    string, optional
  • data
    object
Response
object
  • error_code
    error code
    number
  • message
    error message
    string, optional
  • data
    object

Query All Migration in progress

Query all pending migrations

Response
object
  • error_code
    error code
    number
  • message
    error message
    string, optional
  • data
    array

Batch Creating Guest

Manage batch creating tasks

Start Creation

Create a bulk of new guests, return a task ID for query status

Request
object
  • name_rule
    rule of generating guest name
    enum[string, fixed]
  • name_prefix
    guest name prefix
    string, optional
  • owner
    user id
    string
  • group
    user group
    string
  • pool
    compute pool name
    string
  • count
    instance count
    number
  • cores
    vm cpu cores
    number
  • memory
    vm memory
    number
  • disks

    [system_disk_size, data_disk_n_size...]

    array[number]
  • auto_start
    auto start instance
    boolean
  • from_image
    initial disk image id
    string, optional
  • template
    id of system template
    string
  • modules

    installed guest module, "qemu"/"cloud-init"

    array, optional[string]
  • cloud_init

    cloud-init params

    object, optional
  • qos
    QoS config
    object, optional
Response
object
  • error_code
    error code
    number
  • message
    error message
    string, optional
  • data
    object

Query Batch Creating Status

Query task status of batch creating

URI Parameters
idid of batch task
Response
object
  • error_code
    error code
    number
  • message
    error message
    string, optional
  • data
    array
Response
object
  • error_code
    error code
    number
  • message
    error message
    string, optional
  • data
    array

Batch Deleting Guest

Manage batch deleting tasks

Start Batch Deleting

Delete a bulk of guests, return a task ID for query status

Request
object
  • guest
    list of target guest UUID
    array[string]
  • force
    stop running instance for deleting
    boolean, optional
Response
object
  • error_code
    error code
    number
  • message
    error message
    string, optional
  • data
    object

Query Batch Deleting Status

Query task status of batch deleting

URI Parameters
idid of batch task
Response
object
  • error_code
    error code
    number
  • message
    error message
    string, optional
  • data
    array
Response
object
  • error_code
    error code
    number
  • message
    error message
    string, optional
  • data
    array

Batch Stopping Guest

APIs manage batch stopping tasks

Start Batch Stopping

Stop a bulk of guests, return a task ID for query status

Request
object
  • guest
    list of target guest UUID
    array[string]
Response
object
  • error_code
    error code
    number
  • message
    error message
    string, optional
  • data
    object

Query Batch Stopping Status

Query task status of batch stopping

URI Parameters
idid of batch task
Response
object
  • error_code
    error code
    number
  • message
    error message
    string, optional
  • data
    array
Response
object
  • error_code
    error code
    number
  • message
    error message
    string, optional
  • data
    array

APIs for search resources

Search Security Policy Groups

Search secuirity policy groups by condition

URI Parameters
ownerreturn policy created by owner
groupreturn policy in specified group
enabled_onlyenabled group only
global_onlyglobal group only

Query Security Group

Query security group by current user/group

Response
object
  • error_code
    error code
    number
  • message
    error message
    string, optional
  • data
    list of security policy groups
    array

Search Guests

Search Guests

Search guests by conditions with current user, keyword could using guest name or target IP

Request
object
  • limit
    max record returned
    number
  • offset
    record offset
    number, optional
  • pool
    hosting pool
    string, optional
  • cell
    hosting cell
    string, optional
  • keyword

    search keyword, match guest name/IP, hosting cell name/IP

    string, optional
Response
object
  • error_code
    error code
    number
  • message
    error message
    string, optional
  • data
    object

FrontEnd Management


Management APIs for FrontEnd module

Role

Manage user roles

List Roles

Query all user roles in the system

Response
object
  • error_code
    error code
    number
  • message
    error message
    string, optional
  • data
    list of role names
    array, optional[string]

Get Role

Get configure data for the specified role

URI Parameters
role_namename of user role
Response
object
  • error_code
    error code
    number
  • message
    error message
    string, optional
  • data
    object

Add Role

Add a new user role to system

URI Parameters
role_namename of user role
Request
object
  • menu
    menu tags list which can access using this role
    array[string]
Response
object
  • error_code
    error code
    number
  • message
    error message
    string, optional

Modify Role

Change resource can access for a specified role

URI Parameters
role_namename of user role
Request
object
  • menu
    menu tags list which can access using this role
    array[string]
Response
object
  • error_code
    error code
    number
  • message
    error message
    string, optional

Remove Role

Remove a role from the system, only available when the role don't bind to any user or group

URI Parameters
role_namename of user role
Response
object
  • error_code
    error code
    number
  • message
    error message
    string, optional

User Group

APIs manage user groups

Query All User Groups

Query all user groups in the system

Response
object
  • error_code
    error code
    number
  • message
    error message
    string, optional
  • data
    array

Get User Group Detail

Get detail data of a user group

URI Parameters
group_namename of user group
Response
object
  • error_code
    error code
    number
  • message
    error message
    string, optional
  • data
    object

Add User Group

Add a new user group to the system

URI Parameters
group_namename of user group
Request
object
  • display
    display name of group
    string
  • role
    list of attached roles
    array, optional[string]
Response
object
  • error_code
    error code
    number
  • message
    error message
    string, optional

Modify User Group

Modify a user group

URI Parameters
group_namename of user group
Request
object
  • display
    display name of group
    string
  • role
    list of attached roles
    array, optional[string]
Response
object
  • error_code
    error code
    number
  • message
    error message
    string, optional

Remove User Group

Remove a user group from the system

URI Parameters
group_namename of user group
Response
object
  • error_code
    error code
    number
  • message
    error message
    string, optional

User Group Members

APIs manage members of a user group

Query User Group Members

Query all members of a user group

URI Parameters
group_namename of user group
Response
object
  • error_code
    error code
    number
  • message
    error message
    string, optional
  • data
    list of member names
    array[string]

Add User Group Member

Add a new member to the user group

URI Parameters
user_nameuser name
group_namename of user group
Response
object
  • error_code
    error code
    number
  • message
    error message
    string, optional

Remove User Group Member

Remove a member from the user group

URI Parameters
user_nameuser name
group_namename of user group
Response
object
  • error_code
    error code
    number
  • message
    error message
    string, optional

User

APIs manage users

Query All Users

Query all users in the system

Response
object
  • error_code
    error code
    number
  • message
    error message
    string, optional
  • data
    list of users
    array[string]

Get User Info

Get info of a user

URI Parameters
user_nameuser name
Response
object
  • error_code
    error code
    number
  • message
    error message
    string, optional
  • data
    object

Create New User

Create a new user in the system

URI Parameters
user_nameuser name
Request
object
  • nick
    nick name for display
    string, optional
  • mail
    user email
    string, optional
  • password
    user password
    string
Response
object
  • error_code
    error code
    number
  • message
    error message
    string, optional

Modify User

Modify user info

URI Parameters
user_nameuser name
Request
object
  • nick
    nick name for display
    string, optional
  • mail
    user email
    string, optional
Response
object
  • error_code
    error code
    number
  • message
    error message
    string, optional

Delete User

Delete a user

URI Parameters
user_nameuser name
Response
object
  • error_code
    error code
    number
  • message
    error message
    string, optional

User Password

APIs manage user password

URI Parameters
user_nameuser name

Modify User Password

Verify and update a new user password

Request
object
  • old
    old password for verify
    string
  • new
    new password
    string
Response
object
  • error_code
    error code
    number
  • message
    error message
    string, optional

APIs for searching users

Search User

Search users by group

URI Parameters
groupuser group
Response
object
  • error_code
    error code
    number
  • message
    error message
    string, optional
  • data
    list of users
    array[string]

Sessions

Manage authenticated session

Authenticate New Session

Verify and allocate a new sesion for all other requests, set session ID in header 'Nano-Session' for authentication.

Request
object
  • user
    user name
    string
  • password
    new password
    string
  • nonce
    nonce for crypt
    string
Response
object
  • error_code
    error code
    number
  • message
    error message
    string, optional
  • data
    object

Update Session

Keep session alive

URI Parameters
session_idsession ID
Response
object
  • error_code
    error code
    number
  • message
    error message
    string, optional

Obtain Authenticated Session

Get attached info with authenticated session

URI Parameters
session_idsession ID
Response
object
  • error_code
    error code
    number
  • message
    error message
    string, optional
  • data
    object

Resource Visibility

Manage resource visibility with login session

Get Current Visibility

Get current visibility configure with the group of current user

Set Current Visibility

Modify current visibility configure with the group of current user

Request
object
  • instance_visible
    user can view instances in the same group
    boolean
    true
  • media_image_visible
    user can view media images in the same group
    boolean
    true
  • disk_image_visible
    user can view disk images in the same group
    boolean
    false
Response
object
  • error_code
    error code
    number
  • message
    error message
    string, optional

Logs

APIs manage system logs

Query Log Entry

Query system logs by conditions

URI Parameters
limitmax entries returned
startstart offset
afterquery logs after this date
beforequery logs before this date
Response
object
  • error_code
    error code
    number
  • message
    error message
    string, optional
  • data
    object

Add Log Entry

Add a single log entry

Request
object
  • format
    format of content
    string, optional
  • content
    log content
    string
Response
object
  • error_code
    error code
    number
  • message
    error message
    string, optional

Delete Log Entry

Delete logs

Request
object
  • entries
    list of log entry
    array[string]
Response
object
  • error_code
    error code
    number
  • message
    error message
    string, optional