notebooks_list_deployments: List deployments for a Notebook

In civis: R Client for the 'Civis Platform API'

List deployments for a Notebook

Description

List deployments for a Notebook

Usage

notebooks_list_deployments(
  notebook_id,
  deployment_id = NULL,
  limit = NULL,
  page_num = NULL,
  order = NULL,
  order_dir = NULL
)

Arguments

notebook_id	integer required. The ID of the owning Notebook
deployment_id	integer optional. The ID for this deployment
limit	integer optional. Number of results to return. Defaults to 20. Maximum allowed is 50.
page_num	integer optional. Page number of the results to return. Defaults to the first page, 1.
order	string optional. The field on which to order the result set. Defaults to created_at. Must be one of: created_at.
order_dir	string optional. Direction in which to sort, either asc (ascending) or desc (descending) defaulting to desc.

Value

An array containing the following fields:

deploymentId	integer, The ID for this deployment.
userId	integer, The ID of the owner.
host	string, Domain of the deployment.
name	string, Name of the deployment.
dockerImageName	string, The name of the docker image to pull from DockerHub.
dockerImageTag	string, The tag of the docker image to pull from DockerHub (default: latest).
instanceType	string, The EC2 instance type requested for the deployment.
memory	integer, The memory allocated to the deployment, in MB.
cpu	integer, The cpu allocated to the deployment, in millicores.
state	string, The state of the deployment.
stateMessage	string, A detailed description of the state.
maxMemoryUsage	number, If the deployment has finished, the maximum amount of memory used during the deployment, in MB.
maxCpuUsage	number, If the deployment has finished, the maximum amount of cpu used during the deployment, in millicores.
createdAt	string,
updatedAt	string,
notebookId	integer, The ID of owning Notebook

civis documentation built on April 1, 2023, 12:01 a.m.