Updated on 2025-09-09 GMT+08:00

Creating a Notebook Instance

This section describes how to create a notebook instance.

Prerequisites

You must have the DataArts Studio system role DAYU User. For details, see Creating an IAM User and Granting DataArts Studio Permissions.

Preparations

  • Enable notebooks. If notebooks are disabled, enable them by referring to Managing Notebooks.
  • Create an OBS bucket.
  • Create a VPC, a subnet, and a security group. Plan the network properly.
    • If you want to connect to only MRS, select the VPC, subnet, and security group of the MRS cluster.
    • If you want to connect to only DLI, select the VPC and subnet of the user for the DLI enhanced datasource connection and ensure that the inbound rule of the security group allows traffic from port 30000 of the VPC where the DLI elastic resource pool is located.
    • If you want to connect to both MRS and DLI, ensure that the VPC and subnet of the MRS cluster are the same as those of the user for the DLI enhanced datasource connection, and that the inbound rule of the security group allows traffic from port 30000 of the VPC where the DLI elastic resource pool is located.
    • Ensure that the preceding VPC subnets do not use 172.30.0.0/16 or 172.31.0.0/16 network segment.

Constraints

Only one notebook can be created in each workspace.

Creating a Notebook Instance

  1. Log in to the DataArts Studio console by following the instructions in Accessing the DataArts Studio Instance Console.
  2. On the DataArts Studio console, locate a workspace and click DataArts Factory.
  3. In the navigation pane on the left, choose Data Development > Notebook.

    • If a notebook is available in the current workspace, click Open to go to the notebook development page.
    • If no notebook is available in the current workspace, the following message is displayed: "There are no notebooks in the current xxxxx workspace. Click Create Now below to create one.
      Figure 1 Create Now

  4. Click Create Now. On the displayed page, set the following parameters.

    Table 1 Parameters for creating a notebook

    Category

    Parameter

    Description

    Basic Information

    Name

    Notebook name

    Description (Option)

    Notebook description

    OBS Configuration

    OBS Bucket

    OBS bucket for storing .ipynb files

    NOTE:

    You must have the permission to upload files to OBS.

    VCP Configuration

    VPC

    Select the VPC of the MRS cluster or the DLI enhanced datasource connection.

    Subnet

    Select the subnet of the MRS cluster or the DLI enhanced datasource connection.

    Security Group

    Select the security group of the MRS cluster or the DLI enhanced datasource connection.

    Figure 2 Creating a notebook

  5. In the lower right corner, click Create Now. The creation takes about one minute.

    The created notebook is displayed in the lower part of the page.

    Click Open to go to the notebook development page. For details, see the subsequent sections.

More Operations

  • Deleting a notebook instance: Click Delete. In the displayed Delete Notebook dialog box, click OK.
  • Refreshing authorization: If the credential of a notebook instance has expired, you can authorize the instance. Click Refresh Authorization to reset user authorization in the notebook. The settings are valid for 24 hours.

    When the token expires, resources cannot be obtained. To resolve this issue, click Authorize.

  • Starting a notebook instance: You can only manually start a notebook instance that has been stopped. Click Start.
  • Stopping a notebook instance: You can only manually stop a running notebook instance. Click Stop.

    After a notebook instance is stopped, tasks configured in Notebook Jobs will be lost.

    A stopped notebook instance will be unavailable. User authorization, ENI NICs, and resources will be released.

  • Sharing a notebook instance: You can share a notebook instance with other members in the workspace. Click Share and add the accounts of the users with whom you want to share the notebook instance.
    • A notebook instance can be shared with a maximum of 100 users or user groups. It is recommended that no more than 10 users use a notebook instance at the same time. Otherwise, user experience will be affected.
    • You can only open and view details of the notebook instances shared with you. You cannot perform other operations, such as deleting, refreshing authorization, starting, or stopping the notebook instances. The notebook instances you created and those shared with you are displayed on the My Notebooks page.
    • If the owner of the notebook instance shared with you cancels the sharing, but you have opened the shared notebook instance, you can still view it within 24 hours.
  • Viewing details of a notebook instance: You can view the basic information about a notebook instance. Click View Details to view the creator, creation time, security group, OBS, and network information of a notebook instance.