Starting a Notebook Instance¶
Function¶
This API is used to start a notebook instance.
Constraints¶
None
URI¶
POST /v1/{project_id}/notebooks/{id}/start
Parameter | Mandatory | Type | Description |
---|---|---|---|
id | Yes | String | Notebook instance ID, which can be obtained by calling the API for querying the notebook instance list. |
project_id | Yes | String | Project ID. For details, see Obtaining a Project ID and Name. |
Parameter | Mandatory | Type | Description |
---|---|---|---|
duration | No | Long | Running duration after startup, in milliseconds. |
type | No | String | Automatic stop type. The default value is timing.
|
Request Parameters¶
None
Response Parameters¶
Status code: 200
Parameter | Type | Description |
---|---|---|
action_progress | Array of JobProgress objects | Instance initialization progress. |
description | String | Instance description |
endpoints | Array of EndpointsRes objects | This section describes how to configure the local IDE (such as PyCharm and VS Code) or SSH client to remotely access a notebook instance through SSH. |
fail_reason | String | Instance failure cause |
flavor | String | Instance flavor |
id | String | Instance ID. |
image | Image object | Instance image |
lease | Lease object | Countdown to automatic instance stop. |
name | String | Instance name |
pool | Pool object | Basic information about the dedicated pool, which is returned by the instance created in the dedicated pool. |
status | String | Instance status. Options:
|
token | String | Token information used for notebook authentication. |
url | String | URL for accessing the notebook instance |
volume | VolumeRes object | Storage volume |
workspace_id | String | Workspace ID. If no workspaces are available, the default value is 0. |
feature | String | Instance type. Options:
|
billing_items | Array of strings | Type of a charging resource. Options: STORAGE: Storage resources are charged. COMPUTE: Computing resources are charged. ALL: all charging types |
user | user object | Account information. |
Parameter | Type | Description |
---|---|---|
notebook_id | String | Instance ID. |
status | String | Job status in a specified step. Enums:
|
step | Integer | Job step. Options:
|
step_description | String | Description of a step in a job. |
Parameter | Type | Description |
---|---|---|
allowed_access_ips | Array of strings | Whitelist of public IP addresses that are allowed to access the notebook instance through SSH. By default, all public IP addresses can access the notebook instance. If this parameter is specified, only the clients with the specified IP addresses can access the notebook instance. |
dev_service | String | Path for accessing the notebook instance. The enumerated values are as follows:
|
ssh_keys | Array of strings | List of SSH key pairs. You can set multiple key pairs to access an SSH instance at the same time. |
service | String | Path for accessing the notebook instance. The enumerated values are as follows:
|
uri | String | Private IP address of the instance |
Parameter | Type | Description |
---|---|---|
arch | String | Processor architecture supported by the image. Enums:
|
create_at | Long | Specifies the time (UTC ms) when the image is created. |
description | String | Image description with a maximum of 512 characters |
dev_services | Array of strings | Services supported by the image. Enums:
|
id | String | Specifies the image ID of the notebook instance to be created. The image ID is in the Universally Unique Identifier (UUID) format. For details about how to obtain the ID of a preset image, see ListImage.xml. |
name | String | Image name, which contains a maximum of 512 characters, including lowercase letters, digits, hyphens (-), underscores (_), and periods (.) |
namespace | String | Organization to which the image belongs. You can create and view the organization on the Organization Management page of the SWR console. |
origin | String | Image source, which defaults to CUSTOMIZE. This parameter is optional. Enums:
|
resource_categories | Array of strings | Flavors supported by the image. Enums:
|
service_type | String | Supported image types. Options:
|
size | Long | Specifies the image size, in KB. |
status | String | Image status. Options:
|
status_message | String | Build information during image saving |
support_res_categories | Array of strings | Flavors supported by the image. Enums:
|
swr_path | String | SWR image address |
tag | String | Image tag |
type | String | Image type. Enums:
|
update_at | Long | Specifies the time (UTC ms) when the image was last updated. |
visibility | String | Image visibility. Enums:
|
workspace_id | String | Workspace ID. If no workspaces are available, the default value is 0. |
Parameter | Type | Description |
---|---|---|
create_at | Long | Time (UTC) when the instance is created, accurate to millisecond. |
duration | Long | Instance running duration, which is calculated based on the instance creation time. If the instance creation time plus the duration is greater than the current time, the system automatically stops the instance. |
enable | Boolean | Whether to enable auto stop of the instance. |
type | String | Indicates the automatic stop type.
|
update_at | Long | Time when the instance is last updated (excluding the heartbeat detection time), in UTC milliseconds. |
Parameter | Type | Description |
---|---|---|
id | String | ID of a dedicated resource pool |
name | String | Name of a dedicated resource pool |
Parameter | Type | Description |
---|---|---|
capacity | Integer | Storage capacity. The default value is 5 GB for EVS and 50 GB for EFS. The maximum value is 4096 GB. |
category | String | Supported storage types. For details about the differences between the storage types, see "Selecting Storage in DevEnviron" in User Guide. Enums:
|
mount_path | String | Directory of the notebook instance to which OBS storage is mounted. Currently, the directory is /home/ma-user/work/. |
ownership | String | Owner to which the resource belongs. Enums:
|
status | String | EVS disk capacity expansion status, which is RESIZING during capacity expansion and does not affect the instance. |
Parameter | Type | Description |
---|---|---|
domain | domain object | Account domain information. |
id | String | IAM user ID. |
name | String | IAM username. |
Parameter | Type | Description |
---|---|---|
id | String | Account ID. |
name | String | Account name. |
Example Requests¶
{ }
Example Responses¶
Status code: 200
OK
{
"description" : "api-test",
"feature" : "NOTEBOOK",
"flavor" : "modelarts.vm.cpu.2u",
"id" : "f9937afa-4451-42db-a76b-72d624749f66",
"image" : {
"description" : "description",
"id" : "e1a07296-22a8-4f05-8bc8-e936c8e54090",
"name" : "notebook2.0-mul-kernel-cpu-cp36",
"swr_path" : "swr.xxxxx.com/atelier/notebook2.0-mul-kernel-cpu-cp36:3.3.2-release_v1",
"tag" : "3.3.2-release_v1",
"type" : "BUILD_IN"
},
"lease" : {
"create_at" : 1638841744515,
"duration" : 6327212,
"enable" : true,
"type" : "TIMING",
"update_at" : 1638844471727
},
"name" : "notebooks_test",
"status" : "STARTING",
"token" : "5cc60e8b-8772-7690-efd6-a5874ca387c0",
"url" : "https://authoring-modelarts-xxxxx.xxxxx.com/f9937afa-4451-42db-a76b-72d624749f66/lab",
"volume" : {
"category" : "EFS",
"ownership" : "MANAGED",
"mount_path" : "/home/ma-user/work/",
"capacity" : 50
},
"workspace_id" : "0"
}
Status Codes¶
Status Code | Description |
---|---|
200 | OK |
201 | Created |
401 | Unauthorized |
403 | Forbidden |
404 | Not Found |
Error Codes¶
See Error Codes.