JSON Object References¶
Paging Query Object¶
It describes how many items to fetch for object listing APIs.
If index
exceeds the number of pages calculated by the server, an empty list is returned.
Key | Type | Description |
---|---|---|
size |
int |
The number of items per page.
If set zero or this object is entirely omitted, all items are returned and index is ignored. |
index |
int |
The page number to show, zero-based. |
Paging Info Object¶
It contains the paging information based on the paging query object in the request.
Key | Type | Description |
---|---|---|
pages |
int |
The number of total pages. |
count |
int |
The number of all items. |
KeyPair Item Object¶
Key | Type | Description |
---|---|---|
accessKey |
slug |
The access key part. |
isActive |
bool |
Indicates if the keypair is active or not. |
totalQueries |
int |
The number of queries done via this keypair. It may have a stale value. |
created |
datetime |
The timestamp when the keypair was created. |
KeyPair Properties Object¶
Key | Type | Description |
---|---|---|
isActive |
bool |
Indicates if the keypair is activated or not.
If not activated, all authentication using the keypair returns 401 Unauthorized.
When changed from true to false , existing running kernel sessions continue to run but any requests to create new kernel sessions are refused.
(default: true ) |
concurrecy |
int |
The maximum number of concurrent kernel sessions allowed for this keypair.
(default: 5 ) |
ML.clusterSize |
int |
Sets the number of instances clustered together when launching new machine learning kernel sessions. (default: 1 ) |
ML.instanceMemory |
int (MiB) |
Sets the memory limit of each instance in the cluster launched for new machine learning kernel sessions. (default: 8 ) |
The enterprise edition offers the following additional properties:
Key | Type | Description |
---|---|---|
cost.automatic |
bool |
If set true , enables automatic cost optimization (BETA).
With supported kernel types, it automatically suspends or resize the kernel sessions not to exceed the configured cost limit per day.
(default: false ) |
cost.dailyLimit |
str |
The string representation of money amount as decimals.
The currency is fixed to USD. (default: "50.00" ) |
Batch Execution Query Object¶
Key | Type | Description |
---|---|---|
build |
str |
The bash command to build the main program from the given uploaded files. If this field is not present, an empty string or If this field is a constant string |
exec |
str |
The bash command to execute the main program. If this is not present, an empty string, or |
clean |
str |
The bash command to clean the intermediate files produced during the build phase. The clean step comes before the build step if specified so that the build step can (re)start fresh. If the field is not present, an empty string, or Unlike the build and exec command, the default for |
Note
A client can distinguish whether the current output is from the build phase
or the execution phase by whether it has received build-finished
status
or not.
Note
All shell commands are by default executed under /home/work
.
The common environment is:
TERM=xterm
LANG=C.UTF-8
SHELL=/bin/bash
USER=work
HOME=/home/work
but individual kernels may have additional environment settings.
Warning
The shell does NOT have access to sudo or the root privilege. Though, some kernels may allow installation of language-specific packages in the user directory.
Also, your build script and the main program is executed inside
Backend.AI Jail, meaning that some system calls are blocked by our policy.
Since ptrace
syscall is blocked, you cannot use native debuggers
such as gdb.
This limitation, however, is subject to change in the future.
Example:
{
"build": "gcc -Wall main.c -o main -lrt -lz",
"exec": "./main"
}
Execution Result Object¶
Key | Type | Description |
---|---|---|
runId |
str |
The user-provided run identifier. If the user has NOT provided it, this will be set by the API server upon the first execute API call. In that case, the client should use it for the subsequent execute API calls during the same run. |
status |
enum[str] |
One of "continued" , "waiting-input" , "finished" , "clean-finished" , "build-finished" ,
or "exec-timeout" .
See more details at Code Execution Model. |
exitCode |
int | null |
The exit code of the last process.
This field has a valid value only when the For batch-mode kernels and query-mode kernels without global context support,
For query-mode kernels with global context support, this value is always zero, regardless of whether the user code has caused an exception or not. A negative value (which cannot happen with normal process termination) indicates a Backend.AI-side error. |
console |
list[
tuple[
enum[str], *
]
]
|
Contains a list of console output items.
Each item is a pair of the item type (enum[str] ) and its value (* ).
See more details at Handling Console Output. |
options |
object |
An object containing extra display options. If there is no options indicated by the kernel, this field is null .
When result.status is "waiting-input" , it has a boolean field is_password so that you could use
different types of text boxes for user inputs. |
files |
list of Execution Result File Object |
A list of details of created files during the code execution. |
Execution Result File Object¶
Key | Type | Description |
---|---|---|
name |
str |
The name of a created file after execution. |
url |
str |
The URL of a create file uploaded to AWS S3. |
Container Stats Object¶
Key | Type | Description |
---|---|---|
cpu_used |
int (msec) |
The total time the kernel was running. |
mem_max_bytes |
int (Byte) |
The maximum memory usage. |
mem_cur_bytes |
int (Byte) |
The current memory usage. |
net_rx_bytes |
int (Byte) |
The total amount of received data through network. |
net_tx_bytes |
int (Byte) |
The total amount of transmitted data through network. |
io_read_bytes |
int (Byte) |
The total amount of received data from IO. |
io_write_bytes |
int (Byte) |
The total amount of transmitted data to IO. |
io_max_scratch_size |
int (Byte) |
Currently not used field. |
io_write_bytes |
int (Byte) |
Currently not used field. |
Creation Config Object¶
Key | Type | Description |
---|---|---|
environ |
object |
A dictionary object specifying additional environment variables. The values must be strings. |
mounts |
list[str] |
An optional list of the name of virtual folders that belongs to the current API key.
These virtual folders are mounted under If the name contains a colon in the middle, the second part of the string indicates
the alias location in the kernel’s file system which is relative to You may mount up to 5 folders for each kernel session. |
clusterSize |
int |
The number of instances bundled for this session. |
instanceMemory |
int (MiB) |
The maximum memory allowed per instance. The value is capped by the per-kernel image limit. Additional charges may apply on the public API service. |
instanceCores |
int |
The number of CPU cores. The value is capped by the per-kernel image limit. Additional charges may apply on the public API service. |
instanceGPUs |
float |
The fraction of GPU devices (1.0 means a whole device). The value is capped by the per-kernel image limit. Additional charges may apply on the public API service. |
Virtual Folder List Item Object¶
Key | Type | Description |
---|---|---|
name |
str |
The human readable name set when created. |
id |
slug |
The unique ID of the folder. |
is_owner |
bool |
Indicates if the requested user is the owner of this folder. |
permission |
str |
The requested user’s permission for this folder. |
Virtual Folder Item Object¶
Key | Type | Description |
---|---|---|
name |
str |
The human readable name set when created. |
id |
slug |
The unique ID of the folder. |
linked |
bool |
Indicates if this folder is linked to an external service. (enterprise edition only) |
numFiles |
int |
The number of files in this folder. |
is_owner |
bool |
Indicates if the requested user is the owner of this folder. |
permission |
str |
The requested user’s permission for this folder. |
created |
datetime |
The date and time when the folder is created. |
Virtual Folder Invitation Object¶
Key | Type | Description |
---|---|---|
id |
slug |
The unique ID of the invitation. Use this when making API requests referring this invitation. |
inviter |
str |
The inviter name of the invitation. |
permission |
str |
The permission to give to invited user. |
state |
string |
The current state of the invitation. |
numFiles |
int |
The number of files in this folder. |
vfolder_id |
slug |
The unique ID of the vfolder to which the permission will be applied if accepted. |
created_at |
datetime |
The date and time when the folder is created. |