jupyter_lab

Create a notebook instance

post/me/jupyter/lab/instance

Request

  • Base URL: https://api.cloud.wherobots.com
  • URL: https://api.cloud.wherobots.com/me/jupyter/lab/instance
  • Auth: one of:
    • HTTP bearer
    • API key in header X-API-Key

Query parameters

regionstring required

Request body

runtimeId'TINY' | 'SMALL' | 'MEDIUM' | 'LARGE' | 'XLARGE' | 'XXLARGE' | 'micro' | 'tiny' | 'small' | 'medium' | 'large' | 'x-large' | '2x-large' | '4x-large' | 'medium-himem' | 'large-himem' | 'x-large-himem' | '2x-large-himem' | '4x-large-himem' | 'x-large-hicpu' | '2x-large-hicpu' | 'x-large-matcher' | '2x-large-matcher' | 'micro-a10-gpu' | 'tiny-a10-gpu' | 'small-a10-gpu' | 'medium-a10-gpu' | 'large-a10-gpu' | 'x-large-a10-gpu'
versionstring nullable
environmentPresetIdstring nullable
environmentOverridePresetIdstring nullable
idleTimeoutMinutesinteger nullable
namestring nullable

Response

Successful Response

idstring required
createTimestring date-time required
updateTimestring date-time required
instanceIdstring required
appType'JUPYTER' | 'SQL_SESSION' | 'RUN' required
status'PENDING' | 'PREPARING' | 'PREPARE_FAILED' | 'REQUESTED' | 'DEPLOYING' | 'DEPLOY_FAILED' | 'DEPLOYED' | 'INITIALIZING' | 'INIT_FAILED' | 'READY' | 'DESTROY_REQUESTED' | 'DESTROYING' | 'DESTROY_FAILED' | 'DESTROYED' required
createdByIdstring nullable required
apiPayloadobject nullable
cpuUsageinteger required
regionNamestring required
messagestring nullable required

Return the latest trace info that is valuable for troubleshooting

Changes

No recorded changes to this operation across all 1 revision of this API.