Help Center/ ModelArts/ API Reference/ Development Environment Management/ Creating a Notebook Instance

Updated on 2026-04-09 GMT+08:00

View PDF

Creating a Notebook Instance

Function

This API is used to create a notebook instance based on specified parameters.

This API applies to the following scenario: When you need to create a notebook instance for a specific task or project, you can use this API to specify the instance specifications, AI engine images, and storage configurations. Before using this API, ensure that you have logged in to the system, have the permission to create a notebook instance, and provide valid creation parameters. After this API is called, the system asynchronously creates a notebook instance. You can obtain the instance status by calling the query API. After the notebook instance is created, you can access the notebook instance through the web page or SSH client. If you do not have the permission to create an instance or the parameters are invalid, the API will return an error message. Other exceptions include insufficient system resources and creation failure. The API will return the corresponding error message.

Constraints

No constraints

Debugging

You can debug this API through automatic authentication in API Explorer or use the SDK sample code generated by API Explorer.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.

If you are using identity policy-based authorization, the following identity policy-based permissions are required.

Action	Access Level	Resource Type (*: required)	Condition Key	Alias	Dependencies
modelarts:notebook:create	Write	notebook *	-	-	-
modelarts:notebook:create	Write	-	g:TagKeys modelarts:poolType modelarts:poolId g:EnterpriseProjectId g:RequestTag/<tag-key>	-	-

URI

POST /v1/{project_id}/notebooks

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Definition: Project ID. For details, see Obtaining a Project ID and Name. Constraints: N/A Range: N/A Default Value: N/A

Request Parameters

**Table 2** Request body parameters
Parameter	Mandatory	Type	Description
description	No	String	Definition: Instance description. Constraints: N/A Range: The value can contain up to 512 characters and cannot contain these special characters (&<>"'/). Default Value: N/A
endpoints	No	Array of EndpointsReq objects	Definition: Only a local IDE (such as PyCharm or VS Code) or SSH client can be used to access a notebook instance. Constraints: Configurations are only required for remotely accessing a notebook instance via SSH on a local IDE (such as PyCharm or VS Code) or SSH client.
feature	No	String	Definition: Instance type. Constraints: N/A Range: DEFAULT: free CodeLab instance. Each user can create only one. NOTEBOOK: billed instance. Default Value: NOTEBOOK
flavor	No	String	Definition: Instance flavor. The following flavors are for reference only. Obtain the flavors displayed on the console in the target region. modelarts.vm.cpu.2u: General-purpose Intel CPU flavor, ideal for rapid data exploration and experiments modelarts.vm.cpu.8u: General computing-plus Intel CPU flavors, ideal for compute-intensive applications Constraints: N/A Range: N/A Default Value: N/A
custom_spec	No	NotebookCustomSpec object	Definition: Custom specifications of an instance. Either this parameter or flavor must be set. Constraints: This is only supported in CPU or GPU dedicated pool scenarios based on the specific node specifications of the dedicated pool.
image_id	Yes	String	Definition : ID of the image used for creating notebook instances. The ID is in the format of a Universally Unique Identifier (UUID). For details, see [Querying Supported Images]](https://support.huaweicloud.com/intl/en-us/api-modelarts/ListImage.html). Constraints: N/A Range: Valid image IDs obtained by calling the API for Querying Supported Images. Default Value: N/A
name	Yes	String	Definition: Instance name. Constraints: N/A Range: The value can contain a maximum of 128 characters. Only letters, digits, hyphens (-), and underscores (_) are allowed. The name can be duplicate. Default Value: N/A
pool_id	No	String	Definition: ID of a dedicated resource pool. This parameter is mandatory if a dedicated resource pool is used to create an instance. The dedicated resource pool ID can be obtained by calling the API for Obtaining Resource Pools. Constraints: N/A Range: Valid resource pool IDs obtained by calling the API for Obtaining Resource Pools. Default Value: N/A
volume	Yes	VolumeMountRequest object	Definition: Storage configuration. Constraints: N/A
workspace_id	No	String	Definition: Workspace ID. If no workspaces are available, the default value is 0. If a workspace is created and used, use the actual value. Constraints: N/A Range: This value is a string of 0 or 32 characters. Only digits or lowercase letters are allowed. Default Value: 0
hooks	No	CustomHooks object	Definition: Hook configuration of a custom boot script. Constraints: N/A
lease	No	LeaseReq object	Definition: Instance lease configuration. Constraints: N/A
affinity	No	AffinityType object	Definition: Instance affinity configuration. Constraints: N/A.
run_user	No	RunUserRequest object	Definition: Startup user and startup user group settings. Constraints: N/A. Default Value: uid=1000, gid=100 Range: When started as root/root: uid=0, gid=0 When started as ma-user/ma-group: uid=1000, gid=100
data_volumes	No	Array of VolumeMountRequest objects	Definition: Instance storage configuration. Constraints: N/A
user_vpc	No	UserVpcRequest object	Definition: User VPC configuration.
duration	No	Integer	Definition: The instance stops as scheduled. Its runtime is measured in milliseconds starting now. Constraints: N/A Range: 3600000 to 259200000 Default Value: 3600000

**Table 3** EndpointsReq
Parameter	Mandatory	Type	Description
service	No	String	Definition: Supported services. Constraints: N/A Range: NOTEBOOK: You can access notebook instances using HTTPS. SSH: You can remotely access notebook instances through SSH. Default Value: N/A
key_pair_names	No	Array of strings	Definition: Name of the SSH key pair, which can be created and viewed on the Key Pair page of the Elastic Cloud Server (ECS) console. Constraints: N/A

**Table 4** NotebookCustomSpec
Parameter	Mandatory	Type	Description
gpu	No	Float	Definition: Number of GPUs of an instance. Constraints: This parameter is unavailable in CPU dedicated resource pools and is mandatory in GPU dedicated resource pools. Range: N/A Default Value: N/A
cpu	Yes	Float	Definition: Number of CPUs of an instance. Constraints: This parameter is mandatory for custom specifications in CPU/GPU dedicated pools. Range: The integer part can contain at most 10 digits and the decimal part can contain at most 2 digits. The value cannot be smaller than 0.4. Default Value: N/A
memory	Yes	Float	Definition: Memory size of an instance. Constraints: This parameter is mandatory for custom specifications in CPU/GPU dedicated pools. Range: The value must be an integer containing at most 10 digits, and the value cannot be smaller than 513. Default Value: N/A
gpu_type	No	String	Definition: GPU acceleration PU of an instance. Constraints: This parameter is unavailable in CPU dedicated resource pools and is mandatory in GPU dedicated resource pools. Range: N/A Default Value: N/A
arch	No	String	Definition: CPU architecture of an instance. Constraints: This parameter is mandatory for custom specifications in CPU/GPU dedicated resource pools. Range: The value can be: X86_64: x86 architecture AARCH64: Arm architecture Default Value: N/A
category	No	String	Definition: Specification type of an instance. Constraints: This parameter is mandatory for custom specifications in CPU/GPU dedicated pools. Range: The value can be: CPU GPU Default Value: N/A
resource_flavor	No	String	Definition: Specifications of the target resource pool node selected for the instance. Constraints: N/A Range: N/A Default Value: N/A

**Table 5** VolumeMountRequest
Parameter	Mandatory	Type	Description
category	Yes	String	Definition: Extended storage type, for example, EFS, OBS, or OBSFS. Constraints: N/A
ownership	Yes	String	Definition: Resource ownership. MANAGED and DEDICATED are supported. Constraints: N/A
uri	No	String	Definition: URI of the EFS dedicated storage disk or path of the OBS parallel file system. Constraints: This parameter is mandatory only when category is set to EFS, OBS, or OBSFS and ownership is set to DEDICATED. The value can contain at most 1,024 characters.
id	No	String	Definition: ID of the EFS dedicated storage disk. Constraints: This parameter is mandatory only when category is set to EFS and ownership is set to DEDICATED. The value must be in the UUID format, for example, 280a8bd5-03e2-4a5c-bea1-83d81e75bc53.
mount_path	No	String	Definition: Path mounted to the notebook instance. Constraints: The value can contain at most 256 characters.
read_only	No	Boolean	Definition: Whether the mounting directory of extended storage is read-only. The default value is false, indicating that the directory can be read and written. Constraints: N/A
dew_secret_name	No	String	Definition: Name of the AK/SK secret stored in DEW. Constraints: This parameter is mandatory when category is set to OBS. The value can contain 1 to 64 characters. Only letters, digits, hyphens (-), and underscores (_) are allowed.
capacity	No	Integer	Definition: EVS storage capacity, in GB. Constraints: This parameter is valid only when category is EVS. Range: N/A Default Value: 5

**Table 6** CustomHooks
Parameter	Mandatory	Type	Description
container_hooks	No	ContainerHooks object	Definition: Container hook configuration. Constraints: N/A

**Table 7** ContainerHooks
Parameter	Mandatory	Type	Description
post_start	No	Config object	Definition: Script configuration after the service is started. Constraints: N/A
pre_start	No	Config object	Definition: Script configuration before the service is started. Constraints: N/A

**Table 8** Config
Parameter	Mandatory	Type	Description
script	No	String	Definition: Custom script (Base64 encoding) or absolute path of a script. Constraints: N/A Range: N/A Default Value: N/A
type	No	String	Definition: Script type. Constraints: N/A Range: COMMAND: The script content (Base64-encoded) must be specified. SCRIPT: The script path must be specified. Default Value: SCRIPT
mode	No	String	Definition: Execution mode of custom scripts, which can be synchronous or asynchronous. Constraints: N/A Range: The value can be: BLOCK: synchronous ASYNC: asynchronous Default Value: ASYNC

**Table 9** LeaseReq
Parameter	Mandatory	Type	Description
duration	No	Long	Definition: The instance stops as scheduled. Its runtime is measured in milliseconds starting now. Constraints: N/A Range: 3600000 to 259200000 Default Value: 3600000
type	No	String	Definition: Auto stop type. Constraints: N/A Range: TIMING: auto stop IDLE: stop when idle Default Value: TIMING

**Table 10** AffinityType
Parameter	Mandatory	Type	Description
required_during_scheduling_ignored_during_execution	No	Array of AffinityRule objects	Definition: Strong affinity feature in the dedicated pool scenario. Constraints: key, values, and operator are mandatory.
preferred_during_scheduling_ignored_during_execution	No	Array of AffinityRule objects	Definition: Weak affinity feature in the dedicated pool scenario. Constraints: key, values, and operator are mandatory, and weight is optional.

**Table 11** AffinityRule
Parameter	Mandatory	Type	Description
key	No	String	Definition: Affinity description. Both default labels and custom labels are supported. For details about the default node labels, see Managing Node Labels. Constraints: Labels are key-value pairs. A valid label key consists of two segments: prefix (optional) and name, which are separated by a slash (/). Range: The name segment is mandatory and must be less than or equal to 63 characters. It must start and end with a letter or digit and only contain letters, digits, hyphens (-), underscores (_), and periods (.). The prefix is optional. If specified, the prefix must be a DNS subdomain: a series of DNS labels separated by periods (.), with a total of no more than 253 characters, followed by a slash (/). For details, see Labels and Selectors. Default Value: N/A.
operator	No	String	Definition: Operator. Constraints: N/A Range: The following operators are supported: In: The label of the affinity or anti-affinity object is in the label value list (values field). NotIn: The label of the affinity or anti-affinity object is not in the label value list (values field). Exists: The affinity or anti-affinity object has a specified label key. DoesNotExist: The affinity or anti-affinity object does not have a specified label key. Gt: The label value of the scheduling node exceeds what is listed (string comparison). Lt: The label value of the scheduling node is under what is listed (string comparison). Default Value: N/A.
values	No	Array of strings	Definition: When configuring node affinity, enter the value of the node label. Constraints: The value must be 63 characters or fewer (can be empty). If the label value is not empty, the value must start and end with a letter or digit and can contain hyphens (-), underscores (_), periods (.), letters, or digits. For details, see Labels and Selectors.
weight	No	Integer	Weight value of the weak affinity node. The value ranges from 0 to 100. The value is NULL for strong affinity and optional for weak affinity.

**Table 12** RunUserRequest
Parameter	Mandatory	Type	Description
uid	No	Integer	User ID of the container startup user.
gid	No	Integer	Group ID of the container startup user.

**Table 13** UserVpcRequest
Parameter	Mandatory	Type	Description
vpc_id	Yes	String	Definition: VPC ID. Constraints: N/A Range: N/A Default Value: N/A
subnet_id	Yes	String	Definition: Subnet ID. Constraints: N/A Range: N/A Default Value: N/A
security_group_ids	Yes	Array of strings	Definition: Security group ID list. Constraints: N/A Range: N/A Default Value: N/A
connect_cidrs	No	Array of strings	Definition: Connected CIDR block list. Constraints: This parameter is optional. Use this parameter when you want to use the mounted NIC to access addresses in other IP address ranges. Range: N/A Default Value: N/A

Response Parameters

Status code: 200

**Table 14** Response body parameters
Parameter	Type	Description
action_progress	Array of JobProgress objects	Definition: Initialization progress of the instance.
description	String	Definition: Instance description. Range: N/A
endpoints	Array of EndpointsRes objects	Definition: Local IDE (such as PyCharm and VS Code) or SSH client for remotely accessing a notebook instance through SSH.
fail_reason	String	Definition: Instance failure cause. Range: N/A
flavor	String	Definition: Instance flavor. If you select a system specification, the returned value is the system specification code. If you select a custom specification when creating an instance, this parameter is always returned as custom.flavor.spec.code. Range: N/A.
custom_spec	NotebookCustomSpecRep object	Definition: Custom specifications of an instance. This parameter is returned only when a CPU or GPU dedicated pool is used and the custom specifications are used. Range: N/A.
id	String	Definition: Instance ID. Range: N/A
image	Image object	Definition: Instance image information.
lease	Lease object	Definition: Countdown to auto stop of an instance.
name	String	Definition: Instance name. Range: N/A
pool	Pool object	Definition: Basic information about the dedicated pool, which is returned by the instance created in the dedicated pool.
status	String	Definition: Instance status. Range: INIT: The instance is being initialized. CREATING: The instance is being created. STARTING: The instance is being started. STOPPING: The instance is being stopped. DELETING: The instance is being deleted. RUNNING: The instance is running. STOPPED: The instance has been stopped. SNAPSHOTTING: The image of the instance is being saved. CREATE_FAILED: Creating the instance failed. START_FAILED: Starting the instance failed. DELETE_FAILED: Deleting the instance failed. ERROR: An error occurred. DELETED: The instance has been deleted. FROZEN: The instance is frozen.
token	String	Description: Token used for notebook authentication. Range: N/A
url	String	Definition: URL for accessing the instance. Range: N/A
volume	VolumeRes object	Definition: Instance storage information.
workspace_id	String	Definition: Workspace ID. If no workspaces are available, the default value is 0. If a workspace is created and used, use the actual value. Range: N/A
feature	String	Definition: Instance type. Range: DEFAULT: free CodeLab instance. Each user can create only one. NOTEBOOK: billed instance.
billing_items	Array of strings	Definition: Billing resource type. Range: STORAGE: Storage resource billing COMPUTE: Computing resources billing ALL: All billing types
user	UserResponse object	Description: Account information.
affinity	AffinityType object	Definition: Affinity information.
run_user	RunUserInfo object	Definition: Information about the startup user and startup user group.
data_volumes	Array of VolumeResponse objects	Definition: Extended storage information.
ip	String	Definition: IP address of the node where the instance is located. Range: N/A
user_vpc	UserVpcResponse object	Definition: User VPC configuration.
user_id	String	Definition: User ID. Range: N/A
is_need_credentials	Boolean	Definition: Whether to create a user secret by default. The default value is true. Range: N/A
jupyter_version	String	Definition: Jupyter version. Range: N/A
tags	Array of TmsTagResponse objects	Definition: Instance tag.

**Table 15** JobProgress
Parameter	Type	Description
status	String	Definition: Job status in a specified step. Range: WAITING: The job is awaiting. PROCESSING: The job is being processed. FAILED: The job failed. COMPLETED: The job is complete.
step	Integer	Definition: Job step. Range: 1: Prepare storage. 2: Prepare compute resources. 3: Configure the network. 4: Initialize the instance.
description	String	Definition: Job description in a specified step. Range: N/A

**Table 16** EndpointsRes
Parameter	Type	Description
key_pair_names	Array of strings	Definition: List of SSH key pairs. You can set multiple key pairs to access an SSH instance at the same time. Range: N/A
service	String	Definition: Method for accessing the notebook instance. Range: NOTEBOOK: You can access notebook instances using HTTPS. SSH: You can remotely access notebook instances through SSH.
uri	String	Definition: Private IP address of the instance. Range: N/A

**Table 17** NotebookCustomSpecRep
Parameter	Type	Description
gpu	Float	Definition: Number of GPUs of an instance. Range: N/A
gpu_type	String	Definition: GPU acceleration PU of an instance. Range: N/A
cpu	Float	Definition: Number of CPUs of an instance. Range: The integer part can contain at most 10 digits and the decimal part can contain at most 2 digits. The value cannot be smaller than 0.4.
memory	Float	Definition: Memory size of an instance. Range: The value must be an integer containing at most 10 digits, and the value cannot be smaller than 513.
arch	String	Definition: CPU architecture of an instance. Range: The value can be: X86_64: x86 architecture AARCH64: Arm architecture
category	String	Definition: Specification type of an instance. Range: The value can be: CPU GPU
resource_flavor	String	Definition: Specifications of the target resource pool node selected for the instance. Range: N/A

**Table 18** Image
Parameter	Type	Description
arch	String	Definition: Processor architecture supported by the image. Range X86_64: x86 architecture AARCH64: Arm architecture
create_at	Long	Definition: UTC time when the image is created, accurate to millisecond. Range: N/A
description	String	Definition: Image description. Range: Up to 512 characters
dev_services	Array of strings	Definition: Services supported by the image. Range: NOTEBOOK: You can access a notebook instance using HTTPS. SSH: You can remotely access a notebook instance from a local IDE through SSH.
id	String	Definition: ID of the image used for creating notebook instances. The ID is in Universally Unique Identifier (UUID) format. For details, see Querying Supported Images. Range: N/A
name	String	Definition: Image name. Range: The name can contain a maximum of 512 characters. Lowercase letters, digits, hyphens (-), underscores (_), and periods (.) are allowed.
namespace	String	Definition: Organization to which the image belongs. You can create and view an organization on the Organization Management page of the SWR console. Range: N/A
origin	String	Definition: Image source. Range: CUSTOMIZE: custom image IMAGE_SAVE: image saved by a notebook instance
resource_categories	Array of strings	Definition: Flavors supported by the image. Range: CPU GPU ASCEND
service_type	String	Definition: Supported image types. Range: COMMON: common image INFERENCE: image used for inference TRAIN: image used for training DEV: image used for development and debugging UNKNOWN: image whose supported services are not specified
size	Long	Definition: Image size, in KB. Range: N/A
status	String	Definition: Image status. Range: INIT: The image is being initialized. CREATING: The image is being saved. In this case, the notebook instance is unavailable. CREATE_FAILED: Saving the image failed. ERROR: An error occurs. DELETED: The image has been deleted. ACTIVE: The image has been saved, which you can view on the SWR console and use to create notebook instances.
status_message	String	Definition: Build information during image saving. Range: N/A
swr_path	String	Definition: SWR image path. Range: N/A
tag	String	Definition: Image tag. Range: N/A
type	String	Definition: Image type. Range: BUILD_IN: built-in system image DEDICATED: image you have saved
update_at	Long	Definition: Time (UTC) when the image was last updated, accurate to millisecond. Range: N/A
visibility	String	Definition: Image visibility. Range: PRIVATE: private image PUBLIC: All users can perform read-only operations based on image_id.
workspace_id	String	Definition: Workspace ID. If no workspaces are available, the default value is 0. If a workspace is created and used, use the actual value. Range: N/A
flavor_type	String	Definition: Resource type of the image. Range: ASCEND_SNT9: 910 chip ASCEND_SNT9B: 910B chip ASCEND_SNT3: 310 chip
swr_instance_id	String	Definition: Enterprise edition SWR repository ID. Range: N/A
show_tag	String	Definition: Image tag. Range: N/A
show_name	String	Definition: Image name. Range: N/A
tags	Array of TmsTagResponse objects	Definition: Image tag.

**Table 19** Lease
Parameter	Type	Description
create_at	Long	Definition: UTC time when the instance is created, accurate to millisecond. Range: N/A
duration	Long	Definition: Instance runtime, which is calculated based on the instance creation time. If the instance creation time plus the runtime is greater than the current time, the system automatically stops the instance. Range: N/A
enable	Boolean	Definition: Specifies whether to enable auto stop. Range: Boolean true: Auto stop is enabled. false: Auto stop is disabled.
type	String	Definition: Auto stop type. Range: TIMING: auto stop IDLE: stop when idle
update_at	Long	Definition: Time (UTC) when the instance is last updated (excluding liveness check), accurate to millisecond. Range: N/A

**Table 20** Pool
Parameter	Type	Description
id	String	Definition: Dedicated resource pool ID. Range: N/A
name	String	Definition: Dedicated resource pool name. Range: N/A

**Table 21** VolumeRes
Parameter	Type	Description
capacity	Integer	Definition: Storage capacity. Range: The default value is 5 GB for EVS and 50 GB for EFS. The maximum value is 4,096 GB.
category	String	Definition: Supported storage type. For details about the differences between the storage types, see Selecting Storage in DevEnviron. Range: SFS EVS OBS OBSFS: parallel file system EFS: SFS Turbo
mount_path	String	Definition: Directory of the notebook instance to which the storage is mounted. Currently, the directory is /home/ma-user/work/. Range: N/A
ownership	String	Definition: Resource owner. Range: MANAGED: Resources are managed by the service. DEDICATED: Resources are managed by the user account. This mode is supported only when the instance category is EFS.
status	String	Definition: EVS disk capacity expansion status, which is RESIZING during capacity expansion and does not affect the instance. Range: N/A
id	String	Definition: EFS disk ID or OBS storage ID. This parameter is returned only when extended storage is used. Range: N/A
read_only	Boolean	Definition: Whether the mounting directory of extended storage is read-only. Range: N/A
dew_secret_name	String	Definition: Name of the AK/SK secret stored in DEW. Range: N/A
evs_sku_code	String	Definition: SKU code of EVS storage. Range: N/A
uri	String	Definition: Source path for mounting the storage when category is EFS, OBS, or OBSFS. Range: N/A
mount_type	String	Definition: Storage mount type. Range: The value can be: STATIC: Storage cannot be mounted or unmounted when the instance is running. DYNAMIC: Storage can be mounted and unmounted when the instance is running.

**Table 22** UserResponse
Parameter	Type	Description
id	String	Definition: User ID. Range: N/A
name	String	Definition: Username. Range: N/A
domain	Domain object	Definition: Domain information of an account.

**Table 23** Domain
Parameter	Type	Description
id	String	Definition: Account ID. Range: N/A
name	String	Definition: Account name. Range: N/A

**Table 24** AffinityType
Parameter	Type	Description
required_during_scheduling_ignored_during_execution	Array of AffinityRule objects	Definition: Strong affinity feature in the dedicated pool scenario. Constraints: key, values, and operator are mandatory.
preferred_during_scheduling_ignored_during_execution	Array of AffinityRule objects	Definition: Weak affinity feature in the dedicated pool scenario. Constraints: key, values, and operator are mandatory, and weight is optional.

**Table 25** AffinityRule
Parameter	Type	Description
key	String	Definition: Affinity description. Both default labels and custom labels are supported. For details about the default node labels, see Managing Node Labels. Constraints: Labels are key-value pairs. A valid label key consists of two segments: prefix (optional) and name, which are separated by a slash (/). Range: The name segment is mandatory and must be less than or equal to 63 characters. It must start and end with a letter or digit and only contain letters, digits, hyphens (-), underscores (_), and periods (.). The prefix is optional. If specified, the prefix must be a DNS subdomain: a series of DNS labels separated by periods (.), with a total of no more than 253 characters, followed by a slash (/). For details, see Labels and Selectors. Default Value: N/A.
operator	String	Definition: Operator. Constraints: N/A Range: The following operators are supported: In: The label of the affinity or anti-affinity object is in the label value list (values field). NotIn: The label of the affinity or anti-affinity object is not in the label value list (values field). Exists: The affinity or anti-affinity object has a specified label key. DoesNotExist: The affinity or anti-affinity object does not have a specified label key. Gt: The label value of the scheduling node exceeds what is listed (string comparison). Lt: The label value of the scheduling node is under what is listed (string comparison). Default Value: N/A.
values	Array of strings	Definition: When configuring node affinity, enter the value of the node label. Constraints: The value must be 63 characters or fewer (can be empty). If the label value is not empty, the value must start and end with a letter or digit and can contain hyphens (-), underscores (_), periods (.), letters, or digits. For details, see Labels and Selectors.
weight	Integer	Weight value of the weak affinity node. The value ranges from 0 to 100. The value is NULL for strong affinity and optional for weak affinity.

**Table 26** RunUserInfo
Parameter	Type	Description
uid	Integer	User ID of the container startup user.
gid	Integer	Group ID of the container startup user.
user_name	String	Username of the container startup user.
group_name	String	Group name of the container startup user.

**Table 27** VolumeResponse
Parameter	Type	Description
category	String	Definition: Extended storage type, for example, EFS, OBS, or OBSFS. Constraints: N/A
mount_path	String	Definition: Directory where the storage is mounted to a notebook instance. Constraints: N/A
url	String	Definition: Source path for mounting the storage when category is OBS or OBSFS. Constraints: N/A
status	String	Definition: Storage status. MOUNTING: being mounted MOUNTED: mounted UNMOUNTING: being unmounted UNMOUNTED: unmounted MOUNT_FAILED: mounting failed UNMOUNT_FAILED: unmounting failed Constraints: N/A
mount_type	String	Definition: Storage mount type. Constraints: N/A

**Table 28** UserVpcResponse
Parameter	Type	Description
vpc_id	String	Definition: VPC ID. Range: N/A
subnet_id	String	Definition: Subnet ID. Range: N/A
security_group_ids	Array of strings	Definition: Security group ID list. Range: N/A
connect_cidrs	String	Definition: Connected CIDR block list. Range: N/A
port_id	Array of strings	Definition: NIC ID. Range: N/A
port_ip	String	Definition: NIC IP address. Range: N/A

**Table 29** TmsTagResponse
Parameter	Type	Description
key	String	Definition: TMS tag key. Range: N/A
value	String	Definition: TMS tag value. Range: N/A

Status code: 201

Created

Example Requests

Create a notebook instance. Set the instance affinity to either strong or weak. If strong affinity is selected, instances are scheduled to the node whose tag is <kubernetes.io/hostname, 192.168.1.1> in the pool-test1202-06024304be00d5092fbdc0013d201342 dedicated resource pool.

{
  "name" : "notebooks_test",
  "feature" : "NOTEBOOK",
  "workspace_id" : "0",
  "description" : "api-test",
  "flavor" : "modelarts.vm.cpu.2u",
  "image_id" : "e1a07296-22a8-4f05-8bc8-e936c8e54090",
  "volume" : {
    "category" : "evs",
    "ownership" : "managed",
    "capacity" : 50
  },
  "pool_id" : "pool-test1202-06024304be00d5092fbdc0013d201342",
  "affinity" : {
    "required_during_scheduling_ignored_during_execution" : [ {
      "key" : "kubernetes.io/hostname",
      "operator" : "In",
      "values" : [ "192.168.1.1" ]
    } ]
  }
}

Create a notebook instance. If weak affinity is selected, when instances are scheduled to the node whose tag is <kubernetes.io/hostname, 192.168.1.1> in the pool-test1202-06024304be00d5092fbdc0013d201342 dedicated resource pool, the weight is 80. When instances are scheduled to the node whose tag is <kubernetes.io/hostname, 192.168.1.2>, the weight is 10. Instances are preferentially scheduled to the node with a larger weight.

{
  "name" : "notebooks_test",
  "feature" : "NOTEBOOK",
  "workspace_id" : "0",
  "description" : "api-test",
  "pool_id" : "pool-test1202-06024304be00d5092fbdc0013d201342",
  "custom_spec" : {
    "gpu" : 1,
    "cpu" : 0.5,
    "memory" : 40
  },
  "image_id" : "e1a07296-22a8-4f05-8bc8-e936c8e54090",
  "volume" : {
    "category" : "evs",
    "ownership" : "managed",
    "capacity" : 50
  },
  "affinity" : {
    "preferred_during_scheduling_ignored_during_execution" : [ {
      "weight" : 80,
      "key" : "kubernetes.io/hostname",
      "operator" : "In",
      "values" : [ "192.168.1.1" ]
    }, {
      "weight" : 10,
      "key" : "kubernetes.io/hostname",
      "operator" : "In",
      "values" : [ "192.168.1.2" ]
    } ]
  }
}

Example Responses

Status code: 200

{
  "description" : "api-test",
  "feature" : "NOTEBOOK",
  "flavor" : "custom.flavor.spec.code",
  "custom_spec" : {
    "arch" : "x86_64",
    "category" : "GPU",
    "gpu" : 1,
    "cpu" : 0.5,
    "memory" : 40
  },
  "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" : 3600000,
    "enable" : true,
    "type" : "TIMING",
    "update_at" : 1638841744515
  },
  "name" : "notebooks_test",
  "status" : "CREATING",
  "token" : "3eff13f2-3d70-5456-6dc7-e3f99f562022",
  "workspace_id" : "0",
  "affinity" : {
    "required_during_scheduling_ignored_during_execution" : [ {
      "key" : "kubernetes.io/hostname",
      "operator" : "In",
      "values" : [ "192.168.1.1" ]
    } ]
  }
}