youjiageng1/doc-exports
1
0
Fork 0
forked from laiweijian4/doc-exports
Code Pull Requests Activity
doc-exports/docs/modelarts/api-ref/CreateNotebook.html
laiweijian 62e650a6fe modelarts_api_22.3.0_20240304
2024-03-04 09:37:06 +08:00

686 lines
52 KiB
HTML
Raw Blame History

<a name="CreateNotebook"></a><a name="CreateNotebook"></a>
<h1 class="topictitle1">Creating a Notebook Instance</h1>
<div id="body0000001321338265"><div class="section" id="CreateNotebook__section2597514419"><h4 class="sectiontitle">Function</h4><p id="CreateNotebook__p1059351174116">This API is used to create a notebook instance based on the specified flavor, AI engine images, and storage. You can access the instance through a web page or SSH client. \r\n Calling this API is an asynchronous operation. The notebook instance status can be obtained by calling the API for querying the details about this instance.</p>
</div>
<div class="section" id="CreateNotebook__section186075184112"><h4 class="sectiontitle">Constraints</h4><p id="CreateNotebook__p1260195114419">None</p>
</div>
<div class="section" id="CreateNotebook__section196275114115"><h4 class="sectiontitle">URI</h4><p id="CreateNotebook__p116365184117">POST /v1/{project_id}/notebooks</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="CreateNotebook__table106417511411" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path Parameters</caption><thead align="left"><tr id="CreateNotebook__row186455113413"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.1"><p id="CreateNotebook__p56445114118">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.2"><p id="CreateNotebook__p66595164113">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.3"><p id="CreateNotebook__p1065145134115">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.3.2.5.1.4"><p id="CreateNotebook__p86611513413">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="CreateNotebook__row1864145184110"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="CreateNotebook__p26635116414">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="CreateNotebook__p166145119418">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="CreateNotebook__p176712511418">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="CreateNotebook__p1667165194110">Project ID. For details, see <a href="modelarts_03_0147.html">Obtaining a Project ID</a>.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="CreateNotebook__section146845110417"><h4 class="sectiontitle">Request Parameters</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="CreateNotebook__request_NotebookCreateRequest" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request body parameters</caption><thead align="left"><tr id="CreateNotebook__row768155118411"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.1"><p id="CreateNotebook__p17707516419">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.2"><p id="CreateNotebook__p177115515412">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.3"><p id="CreateNotebook__p1571165113419">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.4.2.2.5.1.4"><p id="CreateNotebook__p37216512413">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="CreateNotebook__row1969195154115"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.1 "><p id="CreateNotebook__p147314517419">description</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.2 "><p id="CreateNotebook__p77335124120">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.3 "><p id="CreateNotebook__p4741951134120">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.2.2.5.1.4 "><p id="CreateNotebook__p137575112417">Instance description. The value can contain a maximum of 512 characters and cannot contain the following special characters: &amp;&lt;&gt;"'/. By default, this parameter is left blank.</p>
</td>
</tr>
<tr id="CreateNotebook__row16995117414"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.1 "><p id="CreateNotebook__p0767519415">duration</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.2 "><p id="CreateNotebook__p6761351184115">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.3 "><p id="CreateNotebook__p157735117419">Long</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.2.2.5.1.4 "><p id="CreateNotebook__p57775110410">Running duration calculated from the current time, in milliseconds. The instance automatically stops when the duration expires.</p>
</td>
</tr>
<tr id="CreateNotebook__row1169105134115"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.1 "><p id="CreateNotebook__p11782511414">endpoints</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.2 "><p id="CreateNotebook__p127818516411">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.3 "><p id="CreateNotebook__p14791951104118">Array of <a href="#CreateNotebook__request_EndpointsReq">EndpointsReq</a> objects</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.2.2.5.1.4 "><p id="CreateNotebook__p167910514414">Local IDE (such as PyCharm and vsCode) or SSH client for remotely accessing a notebook instance through SSH.</p>
</td>
</tr>
<tr id="CreateNotebook__row12691751144116"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.1 "><p id="CreateNotebook__p188016519416">feature</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.2 "><p id="CreateNotebook__p178011510411">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.3 "><p id="CreateNotebook__p28115515413">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.2.2.5.1.4 "><p id="CreateNotebook__p1881185184120">Instance type. The default value is <strong id="CreateNotebook__b1582351204111">NOTEBOOK</strong>. Options: - <strong id="CreateNotebook__b08215517410">DEFAULT</strong>: free CodeLab instance. You can create only one. - <strong id="CreateNotebook__b1682851134113">NOTEBOOK</strong>: billed instance.</p>
</td>
</tr>
<tr id="CreateNotebook__row469195116413"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.1 "><p id="CreateNotebook__p17826516411">flavor</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.2 "><p id="CreateNotebook__p128385164112">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.3 "><p id="CreateNotebook__p168465164115">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.2.2.5.1.4 "><p id="CreateNotebook__p11851251114117">Instance flavor. Currently, the following flavors are supported: \r\n-<strong id="CreateNotebook__b78515518414">modelarts.vm.cpu.2u</strong>: General-purpose Intel CPU flavors, ideal for rapid data exploration and tests. \r\n- <strong id="CreateNotebook__b128505117410">modelarts.vm.cpu.8u</strong>: General computing-plus Intel CPU flavors, ideal for compute-intensive applications. \r\n- <strong id="CreateNotebook__b5852051154116">modelarts.bm.gpu.v100NV32</strong>: One NVIDIA V100 GPU with 32 GB of memory, ideal for training and debugging deep learning algorithms. \r\n- <strong id="CreateNotebook__b138525174113">modelarts.bm.d910.xlarge.1</strong>: One Arm-powered Ascend 910 processor with 32 GB of GPU memory, ideal for training and debugging deep learning models. \r\n- <strong id="CreateNotebook__b98575114416">modelarts.bm.d910.xlarge.2</strong>: Two Arm-powered Ascend 910 processors, each with 32 GB of GPU memory, ideal for training and debugging deep learning models. \r\n- <strong id="CreateNotebook__b785451174117">modelarts.bm.d910.xlarge.8</strong>: Eight Arm-powered Ascend 910 processors, each with 32 GB of GPU memory, ideal for training and debugging deep learning algorithms. \r\n\r\n The preceding flavors are for reference only. The flavors available in specific regions are displayed on the console.</p>
</td>
</tr>
<tr id="CreateNotebook__row16955115418"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.1 "><p id="CreateNotebook__p1286551184111">image_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.2 "><p id="CreateNotebook__p198614516412">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.3 "><p id="CreateNotebook__p087135174110">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.2.2.5.1.4 "><p id="CreateNotebook__p1288135164111">ID of the image used for creating notebook instances. The ID is in Universally Unique Identifier (UUID) format. \r\n For details, see <a href="ListImage.html">Querying Supported Images</a>.</p>
</td>
</tr>
<tr id="CreateNotebook__row6692051114110"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.1 "><p id="CreateNotebook__p20881851204112">name</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.2 "><p id="CreateNotebook__p4891951194115">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.3 "><p id="CreateNotebook__p108912515417">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.2.2.5.1.4 "><p id="CreateNotebook__p13901151154112">Instance name, which contains a maximum of 64 characters that can be duplicate. The name can contain uppercase letters, lowercase letters, digits, hyphens (-), and underscores (_).</p>
</td>
</tr>
<tr id="CreateNotebook__row1669175117416"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.1 "><p id="CreateNotebook__p16911851154119">pool_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.2 "><p id="CreateNotebook__p17913518414">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.3 "><p id="CreateNotebook__p792155118412">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.2.2.5.1.4 "><p id="CreateNotebook__p169375119413">ID of a dedicated resource pool, for example, <strong id="CreateNotebook__b109418518412">pool41664192</strong>. This parameter is mandatory if a dedicated resource pool needs to be specified for creating an instance.</p>
</td>
</tr>
<tr id="CreateNotebook__row26955118411"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.1 "><p id="CreateNotebook__p2094151184117">volume</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.2 "><p id="CreateNotebook__p99516515419">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.3 "><p id="CreateNotebook__p9951851104113"><a href="#CreateNotebook__request_VolumeReq">VolumeReq</a> object</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.2.2.5.1.4 "><p id="CreateNotebook__p59665144117">Storage volume.</p>
</td>
</tr>
<tr id="CreateNotebook__row669151124112"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.1 "><p id="CreateNotebook__p1696105114116">workspace_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.2 "><p id="CreateNotebook__p199735110416">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.3 "><p id="CreateNotebook__p109795111414">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.2.2.5.1.4 "><p id="CreateNotebook__p19981451114115">Workspace ID. If no workspaces are available, the default value is <strong id="CreateNotebook__b179811512415">0</strong>.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="CreateNotebook__request_EndpointsReq"></a><a name="request_EndpointsReq"></a><table cellpadding="4" cellspacing="0" summary="" id="CreateNotebook__request_EndpointsReq" frame="border" border="1" rules="all"><caption><b>Table 3 </b>EndpointsReq</caption><thead align="left"><tr id="CreateNotebook__row199855174114"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.5.1.1"><p id="CreateNotebook__p1599951104115">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.5.1.2"><p id="CreateNotebook__p1310035115413">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.5.1.3"><p id="CreateNotebook__p1710016511414">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.4.3.2.5.1.4"><p id="CreateNotebook__p810055113418">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="CreateNotebook__row498175154117"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.1 "><p id="CreateNotebook__p191011251134115">allowed_access_ips</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.2 "><p id="CreateNotebook__p710135124111">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.3 "><p id="CreateNotebook__p17101105116419">Array of strings</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.3.2.5.1.4 "><p id="CreateNotebook__p1510275154112">Public IP addresses that can remotely access the notebook instance. A maximum of five public IP addresses are supported.</p>
</td>
</tr>
<tr id="CreateNotebook__row1598251134115"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.1 "><p id="CreateNotebook__p151021151114110">dev_service</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.2 "><p id="CreateNotebook__p1510325117414">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.3 "><p id="CreateNotebook__p15103651204117">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.3.2.5.1.4 "><p id="CreateNotebook__p1410325124111">Supported services. Options: - <strong id="CreateNotebook__b71047513412">NOTEBOOK</strong>: You can access the notebook instance using HTTPS.- <strong id="CreateNotebook__b13104185104118">SSH</strong>: You can remotely access the notebook instance through SSH.</p>
</td>
</tr>
<tr id="CreateNotebook__row1498145116417"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.1 "><p id="CreateNotebook__p610495174115">ssh_keys</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.2 "><p id="CreateNotebook__p9104155118411">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.3 "><p id="CreateNotebook__p7105115119411">Array of strings</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.3.2.5.1.4 "><p id="CreateNotebook__p81061251164115">Name of the SSH key pair, which can be created and viewed on the <strong id="CreateNotebook__b1510635174119">Key Pair</strong> page of the Elastic Cloud Server (ECS) console.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="CreateNotebook__request_VolumeReq"></a><a name="request_VolumeReq"></a><table cellpadding="4" cellspacing="0" summary="" id="CreateNotebook__request_VolumeReq" frame="border" border="1" rules="all"><caption><b>Table 4 </b>VolumeReq</caption><thead align="left"><tr id="CreateNotebook__row18107165144110"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.4.2.5.1.1"><p id="CreateNotebook__p1108151184114">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.4.2.5.1.2"><p id="CreateNotebook__p1010815154111">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.4.2.5.1.3"><p id="CreateNotebook__p51098516411">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.4.4.2.5.1.4"><p id="CreateNotebook__p9109125104115">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="CreateNotebook__row6107195154118"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.1 "><p id="CreateNotebook__p1511015512419">capacity</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.2 "><p id="CreateNotebook__p13110151124117">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.3 "><p id="CreateNotebook__p3111451144117">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.4.2.5.1.4 "><p id="CreateNotebook__p1112195112419">Storage capacity. The default value is 5 GB for EVS and 50 GB for EFS. The maximum value is 4,096 GB.</p>
</td>
</tr>
<tr id="CreateNotebook__row110795164119"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.1 "><p id="CreateNotebook__p171126512410">category</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.2 "><p id="CreateNotebook__p151121251124116">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.3 "><p id="CreateNotebook__p2011315114118">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.4.2.5.1.4 "><p id="CreateNotebook__p8113175194114">Storage category. Options: \r\n-<strong id="CreateNotebook__b311416512417">EFS</strong>: Scalable File Service (SFS), which is the default storage. \r\n-<strong id="CreateNotebook__b3114135144117">EVS</strong>: Elastic Volume Service (EVS). \r\n\r\n For details about the differences between the two types of storage, see Selecting a Storage Type in DevEnviron.\r\n.\r\n\r\n\r\n\r\n</p>
</td>
</tr>
<tr id="CreateNotebook__row1107115117415"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.1 "><p id="CreateNotebook__p1211465104117">ownership</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.2 "><p id="CreateNotebook__p17114185194114">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.3 "><p id="CreateNotebook__p1111510516414">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.4.2.5.1.4 "><p id="CreateNotebook__p211511518413">Owner to which the resource belongs. Options: - <strong id="CreateNotebook__b611635184117">MANAGED</strong>: Resources are managed by services.- <strong id="CreateNotebook__b8116105116415">DEDICATED</strong>: Resources are managed by the user account. This mode is supported only when the instance category is <strong id="CreateNotebook__b21161151184111">EFS</strong>.</p>
</td>
</tr>
<tr id="CreateNotebook__row1010711510412"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.1 "><p id="CreateNotebook__p4116751194115">uri</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.2 "><p id="CreateNotebook__p1011605115414">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.3 "><p id="CreateNotebook__p611785117411">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.4.2.5.1.4 "><p id="CreateNotebook__p611745119412">URI of the EFS. This parameter is mandatory only when the instance category is <strong id="CreateNotebook__b12118951184114">EFS</strong> and ownership is <strong id="CreateNotebook__b51183514411">DEDICATED</strong>. An example URI is <strong id="CreateNotebook__b011812515418">192.168.0.1:/user-9sfdsdgdfgh5ea4d56871e75d6966aa274/mount/</strong>.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="CreateNotebook__section11118451164110"><h4 class="sectiontitle">Response Parameters</h4><p id="CreateNotebook__p11119151104117"><strong id="CreateNotebook__b1911918511411">Status code: 200</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="CreateNotebook__response_NotebookResp" frame="border" border="1" rules="all"><caption><b>Table 5 </b>Response body parameters</caption><thead align="left"><tr id="CreateNotebook__row21201151144111"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.3.2.4.1.1"><p id="CreateNotebook__p6121451154114">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.3.2.4.1.2"><p id="CreateNotebook__p2122125120419">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.5.3.2.4.1.3"><p id="CreateNotebook__p912495120412">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="CreateNotebook__row1712055113419"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.1 "><p id="CreateNotebook__p1212555115416">action_progress</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.2 "><p id="CreateNotebook__p1112516515412">Array of <a href="#CreateNotebook__response_JobProgress">JobProgress</a> objects</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.3.2.4.1.3 "><p id="CreateNotebook__p1712625174114">Instance initialization progress.</p>
</td>
</tr>
<tr id="CreateNotebook__row6120951154110"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.1 "><p id="CreateNotebook__p1812625115417">description</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.2 "><p id="CreateNotebook__p17127185134112">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.3.2.4.1.3 "><p id="CreateNotebook__p8127151194112">Instance description</p>
</td>
</tr>
<tr id="CreateNotebook__row191205515418"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.1 "><p id="CreateNotebook__p11127125134120">endpoints</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.2 "><p id="CreateNotebook__p1612835117414">Array of <a href="#CreateNotebook__response_EndpointsRes">EndpointsRes</a> objects</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.3.2.4.1.3 "><p id="CreateNotebook__p11291551104114">Local IDE (such as PyCharm and vsCode) or SSH client for remotely accessing a notebook instance through SSH.</p>
</td>
</tr>
<tr id="CreateNotebook__row9120165119410"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.1 "><p id="CreateNotebook__p111301551114111">fail_reason</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.2 "><p id="CreateNotebook__p613045194111">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.3.2.4.1.3 "><p id="CreateNotebook__p7130951164110">Instance failure cause</p>
</td>
</tr>
<tr id="CreateNotebook__row412075110415"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.1 "><p id="CreateNotebook__p181311251154111">feature</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.2 "><p id="CreateNotebook__p111311051124115">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.3.2.4.1.3 "><p id="CreateNotebook__p20132175117414">Instance type. Options: - <strong id="CreateNotebook__b10132105124119">DEFAULT</strong>: free CodeLab instance. You can create only one. - <strong id="CreateNotebook__b121321951104119">NOTEBOOK</strong>: billed instance.</p>
</td>
</tr>
<tr id="CreateNotebook__row17120105110414"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.1 "><p id="CreateNotebook__p1313275117412">flavor</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.2 "><p id="CreateNotebook__p11133851174112">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.3.2.4.1.3 "><p id="CreateNotebook__p15133185114115">Instance flavor</p>
</td>
</tr>
<tr id="CreateNotebook__row1712055112414"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.1 "><p id="CreateNotebook__p101341051164118">id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.2 "><p id="CreateNotebook__p181345519419">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.3.2.4.1.3 "><p id="CreateNotebook__p1613415119411">Instance ID.</p>
</td>
</tr>
<tr id="CreateNotebook__row81208516416"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.1 "><p id="CreateNotebook__p1613505114416">image</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.2 "><p id="CreateNotebook__p18136105124112"><a href="#CreateNotebook__response_Image">Image</a> object</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.3.2.4.1.3 "><p id="CreateNotebook__p1213695144116">Instance image</p>
</td>
</tr>
<tr id="CreateNotebook__row1120251114118"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.1 "><p id="CreateNotebook__p151376516410">lease</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.2 "><p id="CreateNotebook__p151371551104120"><a href="#CreateNotebook__response_Lease">Lease</a> object</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.3.2.4.1.3 "><p id="CreateNotebook__p10138351124111">Countdown to automatic instance stop.</p>
</td>
</tr>
<tr id="CreateNotebook__row1212075124110"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.1 "><p id="CreateNotebook__p2138145113419">name</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.2 "><p id="CreateNotebook__p10139165114118">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.3.2.4.1.3 "><p id="CreateNotebook__p81399515419">Instance name</p>
</td>
</tr>
<tr id="CreateNotebook__row112015512416"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.1 "><p id="CreateNotebook__p101401515414">pool</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.2 "><p id="CreateNotebook__p131409515419"><a href="#CreateNotebook__response_Pool">Pool</a> object</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.3.2.4.1.3 "><p id="CreateNotebook__p12140251184113">Basic information about the dedicated pool, which is returned by the instance created in the dedicated pool.</p>
</td>
</tr>
<tr id="CreateNotebook__row111201510414"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.1 "><p id="CreateNotebook__p11411251164114">status</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.2 "><p id="CreateNotebook__p114117518418">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.3.2.4.1.3 "><p id="CreateNotebook__p18142951134117">Instance status Options: \r\n-<strong id="CreateNotebook__b16142105184116">INIT</strong>: The instance is being initialized. \r\n-<strong id="CreateNotebook__b1142185154114">CREATING</strong>: The instance is being created. \r\n-<strong id="CreateNotebook__b161421351124114">STARTING</strong>: The instance is starting. \r\n-STOPPING: The instance is stopping. \r\n-DELETING: The instance is being deleted.\r\n-RUNNING: The instance is running.\r\n-STOPPED: The instance is stopped.\r\n-SNAPSHOTTING: A snapshot is being taken for the instance (status when the image is being saved).\r\n-CREATE_FAILED: The instance fails to be created. \r\n-START_FAILED: The instance fails to be started. \r\n-DELETE_FAILED: The instance fails to be deleted.\r\n-ERROR: An error occurs. \r\n-DELETED: The instance is deleted. \r\n-FROZEN: The instance is frozen.</p>
</td>
</tr>
<tr id="CreateNotebook__row18120105110414"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.1 "><p id="CreateNotebook__p13143135164114">token</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.2 "><p id="CreateNotebook__p2143125154116">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.3.2.4.1.3 "><p id="CreateNotebook__p8143155113414">Token used for notebook authentication</p>
</td>
</tr>
<tr id="CreateNotebook__row8120135164113"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.1 "><p id="CreateNotebook__p131441651164115">url</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.2 "><p id="CreateNotebook__p01442518416">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.3.2.4.1.3 "><p id="CreateNotebook__p17145155118418">URL for accessing the notebook instance</p>
</td>
</tr>
<tr id="CreateNotebook__row19120251184113"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.1 "><p id="CreateNotebook__p01451351174118">volume</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.2 "><p id="CreateNotebook__p214695174116"><a href="#CreateNotebook__response_VolumeRes">VolumeRes</a> object</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.3.2.4.1.3 "><p id="CreateNotebook__p414615117416">Storage volume</p>
</td>
</tr>
<tr id="CreateNotebook__row1412011516414"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.1 "><p id="CreateNotebook__p1714685164113">workspace_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.2 "><p id="CreateNotebook__p61471451144117">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.3.2.4.1.3 "><p id="CreateNotebook__p14147105113418">Workspace ID. If no workspaces are available, the default value is <strong id="CreateNotebook__b91481151164116">0</strong>.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="CreateNotebook__response_JobProgress"></a><a name="response_JobProgress"></a><table cellpadding="4" cellspacing="0" summary="" id="CreateNotebook__response_JobProgress" frame="border" border="1" rules="all"><caption><b>Table 6 </b>JobProgress</caption><thead align="left"><tr id="CreateNotebook__row31491151124113"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.4.2.4.1.1"><p id="CreateNotebook__p41501051164116">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.4.2.4.1.2"><p id="CreateNotebook__p915075110413">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.5.4.2.4.1.3"><p id="CreateNotebook__p181511151124114">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="CreateNotebook__row7149551164114"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.1 "><p id="CreateNotebook__p1615111517414">notebook_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.2 "><p id="CreateNotebook__p21511651194116">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.4.2.4.1.3 "><p id="CreateNotebook__p71521351124118">Instance ID.</p>
</td>
</tr>
<tr id="CreateNotebook__row514965174112"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.1 "><p id="CreateNotebook__p1715255112411">status</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.2 "><p id="CreateNotebook__p71531351204110">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.4.2.4.1.3 "><p id="CreateNotebook__p1415375116411">Job status in a specified step. Options: - <strong id="CreateNotebook__b18154195184118">WAITING</strong>: The job is waiting to begin. - <strong id="CreateNotebook__b315418512416">PROCESSING</strong>: The job is being processed. - <strong id="CreateNotebook__b1615414514414">FAILED</strong>: The job failed. - <strong id="CreateNotebook__b14154451134119">COMPLETED</strong>: The task is complete.</p>
</td>
</tr>
<tr id="CreateNotebook__row114965111412"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.1 "><p id="CreateNotebook__p1415445113416">step</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.2 "><p id="CreateNotebook__p615595119415">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.4.2.4.1.3 "><p id="CreateNotebook__p20155195118413">Job step. Options: - 1: Storage preparation. - 2: Computing resource preparation. - 3: Network configurations. - 4: Instance initialization.</p>
</td>
</tr>
<tr id="CreateNotebook__row6149155112411"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.1 "><p id="CreateNotebook__p191561517417">step_description</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.2 "><p id="CreateNotebook__p1815645144113">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.4.2.4.1.3 "><p id="CreateNotebook__p7157175110413">Description of a step in a job.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="CreateNotebook__response_EndpointsRes"></a><a name="response_EndpointsRes"></a><table cellpadding="4" cellspacing="0" summary="" id="CreateNotebook__response_EndpointsRes" frame="border" border="1" rules="all"><caption><b>Table 7 </b>EndpointsRes</caption><thead align="left"><tr id="CreateNotebook__row17158115118413"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.5.2.4.1.1"><p id="CreateNotebook__p10159205119419">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.5.2.4.1.2"><p id="CreateNotebook__p616017511411">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.5.5.2.4.1.3"><p id="CreateNotebook__p3160205111416">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="CreateNotebook__row10158175113413"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.5.2.4.1.1 "><p id="CreateNotebook__p1116115118415">allowed_access_ips</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.5.2.4.1.2 "><p id="CreateNotebook__p716111512411">Array of strings</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.5.2.4.1.3 "><p id="CreateNotebook__p2016205114416">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.</p>
</td>
</tr>
<tr id="CreateNotebook__row015865154117"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.5.2.4.1.1 "><p id="CreateNotebook__p11621651134117">dev_service</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.5.2.4.1.2 "><p id="CreateNotebook__p1916225111413">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.5.2.4.1.3 "><p id="CreateNotebook__p1416345104113">Supported services. Options: - <strong id="CreateNotebook__b416318514415">NOTEBOOK</strong>: You can access the notebook instance using HTTPS.- <strong id="CreateNotebook__b6163751184115">SSH</strong>: You can remotely access the notebook instance through SSH.</p>
</td>
</tr>
<tr id="CreateNotebook__row1215819516412"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.5.2.4.1.1 "><p id="CreateNotebook__p3163751134113">ssh_keys</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.5.2.4.1.2 "><p id="CreateNotebook__p1616465116413">Array of strings</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.5.2.4.1.3 "><p id="CreateNotebook__p1116417517415">List of SSH key pairs. You can set multiple key pairs to access an SSH instance at the same time.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="CreateNotebook__response_Image"></a><a name="response_Image"></a><table cellpadding="4" cellspacing="0" summary="" id="CreateNotebook__response_Image" frame="border" border="1" rules="all"><caption><b>Table 8 </b>Image</caption><thead align="left"><tr id="CreateNotebook__row1016585174112"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.6.2.4.1.1"><p id="CreateNotebook__p1166175134115">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.6.2.4.1.2"><p id="CreateNotebook__p616715519417">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.5.6.2.4.1.3"><p id="CreateNotebook__p111672051184110">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="CreateNotebook__row11165851194112"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.6.2.4.1.1 "><p id="CreateNotebook__p18167145104112">id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.6.2.4.1.2 "><p id="CreateNotebook__p171685516413">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.6.2.4.1.3 "><p id="CreateNotebook__p1516817515411">Image ID</p>
</td>
</tr>
<tr id="CreateNotebook__row4165165114418"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.6.2.4.1.1 "><p id="CreateNotebook__p67689514419">name</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.6.2.4.1.2 "><p id="CreateNotebook__p276810515417">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.6.2.4.1.3 "><p id="CreateNotebook__p1576915144119">Image name.</p>
</td>
</tr>
<tr id="CreateNotebook__row16165185124115"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.6.2.4.1.1 "><p id="CreateNotebook__p15769195124118">swr_path</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.6.2.4.1.2 "><p id="CreateNotebook__p20769105124115">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.6.2.4.1.3 "><p id="CreateNotebook__p13769165119411">SWR image address</p>
</td>
</tr>
<tr id="CreateNotebook__row1416518513413"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.6.2.4.1.1 "><p id="CreateNotebook__p376915112412">type</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.6.2.4.1.2 "><p id="CreateNotebook__p87708512418">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.6.2.4.1.3 "><p id="CreateNotebook__p167701051154120">Image type. Options: - <strong id="CreateNotebook__b57701551124111">BUILD_IN</strong>: built-in system image- <strong id="CreateNotebook__b8770151164112">DEDICATED</strong>: image saved by the user</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="CreateNotebook__response_Lease"></a><a name="response_Lease"></a><table cellpadding="4" cellspacing="0" summary="" id="CreateNotebook__response_Lease" frame="border" border="1" rules="all"><caption><b>Table 9 </b>Lease</caption><thead align="left"><tr id="CreateNotebook__row1317455144115"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.7.2.4.1.1"><p id="CreateNotebook__p377125113417">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.7.2.4.1.2"><p id="CreateNotebook__p377135124115">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.5.7.2.4.1.3"><p id="CreateNotebook__p15771851184120">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="CreateNotebook__row14174115134110"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.7.2.4.1.1 "><p id="CreateNotebook__p57711951144117">create_time</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.7.2.4.1.2 "><p id="CreateNotebook__p0772155134118">Long</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.7.2.4.1.3 "><p id="CreateNotebook__p3772195116411">Time (UTC) when the instance is created, accurate to millisecond.</p>
</td>
</tr>
<tr id="CreateNotebook__row151745516413"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.7.2.4.1.1 "><p id="CreateNotebook__p1977216518414">duration</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.7.2.4.1.2 "><p id="CreateNotebook__p377255114418">Long</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.7.2.4.1.3 "><p id="CreateNotebook__p877255115416">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.</p>
</td>
</tr>
<tr id="CreateNotebook__row181741251114117"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.7.2.4.1.1 "><p id="CreateNotebook__p877319512418">enable</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.7.2.4.1.2 "><p id="CreateNotebook__p47731251114111">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.7.2.4.1.3 "><p id="CreateNotebook__p16773751104119">Whether to enable auto stop of the instance.</p>
</td>
</tr>
<tr id="CreateNotebook__row1717411518415"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.7.2.4.1.1 "><p id="CreateNotebook__p6773115174113">update_time</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.7.2.4.1.2 "><p id="CreateNotebook__p1477417516411">Long</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.7.2.4.1.3 "><p id="CreateNotebook__p1577418517419">Time (UTC) when the instance is last updated (excluding the keepalive heartbeat time), accurate to millisecond.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="CreateNotebook__response_Pool"></a><a name="response_Pool"></a><table cellpadding="4" cellspacing="0" summary="" id="CreateNotebook__response_Pool" frame="border" border="1" rules="all"><caption><b>Table 10 </b>Pool</caption><thead align="left"><tr id="CreateNotebook__row1618145111413"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.8.2.4.1.1"><p id="CreateNotebook__p16774351104114">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.8.2.4.1.2"><p id="CreateNotebook__p1577417518413">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.5.8.2.4.1.3"><p id="CreateNotebook__p677545134112">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="CreateNotebook__row0181195115419"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.8.2.4.1.1 "><p id="CreateNotebook__p13775145114410">id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.8.2.4.1.2 "><p id="CreateNotebook__p477585164115">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.8.2.4.1.3 "><p id="CreateNotebook__p127751651194113">ID of a dedicated resource pool</p>
</td>
</tr>
<tr id="CreateNotebook__row1818155154113"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.8.2.4.1.1 "><p id="CreateNotebook__p20775195154110">name</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.8.2.4.1.2 "><p id="CreateNotebook__p157757513412">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.8.2.4.1.3 "><p id="CreateNotebook__p12775185116418">Name of a dedicated resource pool</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="CreateNotebook__response_VolumeRes"></a><a name="response_VolumeRes"></a><table cellpadding="4" cellspacing="0" summary="" id="CreateNotebook__response_VolumeRes" frame="border" border="1" rules="all"><caption><b>Table 11 </b>VolumeRes</caption><thead align="left"><tr id="CreateNotebook__row5185185114119"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.9.2.4.1.1"><p id="CreateNotebook__p177762051134116">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.9.2.4.1.2"><p id="CreateNotebook__p1277685118416">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.5.9.2.4.1.3"><p id="CreateNotebook__p14776951124110">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="CreateNotebook__row8185145154112"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.9.2.4.1.1 "><p id="CreateNotebook__p9776125124120">capacity</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.9.2.4.1.2 "><p id="CreateNotebook__p197761251154113">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.9.2.4.1.3 "><p id="CreateNotebook__p777705119412">Storage capacity. The default value is 5 GB for EVS and 50 GB for EFS. The maximum value is 4,096 GB.</p>
</td>
</tr>
<tr id="CreateNotebook__row15185115114417"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.9.2.4.1.1 "><p id="CreateNotebook__p14777851154115">category</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.9.2.4.1.2 "><p id="CreateNotebook__p177771451154119">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.9.2.4.1.3 "><p id="CreateNotebook__p1077914511417">Storage category. Options: \r\n-<strong id="CreateNotebook__b12779251114111">EFS</strong>: Scalable File Service (SFS), which is the default storage. \r\n-<strong id="CreateNotebook__b1977995119415">EVS</strong>: Elastic Volume Service (EVS). \r\n\r\n For details about the differences between the two types of storage, see Selecting a Storage Type in DevEnviron.\r\n.\r\n\r\n\r\n\r\n</p>
</td>
</tr>
<tr id="CreateNotebook__row1418565184111"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.9.2.4.1.1 "><p id="CreateNotebook__p17780155117419">mount_path</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.9.2.4.1.2 "><p id="CreateNotebook__p13781115110412">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.9.2.4.1.3 "><p id="CreateNotebook__p37811051144119">Directory of the notebook instance to which OBS storage is mounted. Currently, the directory is <strong id="CreateNotebook__b57819516416">/home/ma-user/work/</strong>.</p>
</td>
</tr>
<tr id="CreateNotebook__row131851651144115"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.9.2.4.1.1 "><p id="CreateNotebook__p778145114112">ownership</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.9.2.4.1.2 "><p id="CreateNotebook__p187816516413">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.9.2.4.1.3 "><p id="CreateNotebook__p167811751144116">Owner to which the resource belongs. Options: - <strong id="CreateNotebook__b14781155117417">MANAGED</strong>: Resources are managed by services.- <strong id="CreateNotebook__b19781105116418">DEDICATED</strong>: Resources are managed by the user account. This mode is supported only when the instance category is <strong id="CreateNotebook__b127811151124110">EFS</strong>.</p>
</td>
</tr>
<tr id="CreateNotebook__row13185155113413"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.9.2.4.1.1 "><p id="CreateNotebook__p1378105134118">status</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.9.2.4.1.2 "><p id="CreateNotebook__p19781115119417">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.9.2.4.1.3 "><p id="CreateNotebook__p1778265118411">EVS disk capacity expansion status, which is <strong id="CreateNotebook__b15782145134110">RESIZING</strong> during capacity expansion and does not affect the instance.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="CreateNotebook__section16782155144119"><h4 class="sectiontitle">Example Requests</h4><pre class="screen" id="CreateNotebook__screen178235110417">{
"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" : "efs",
"ownership" : "managed",
"capacity" : 50
}
}</pre>
</div>
<div class="section" id="CreateNotebook__section127841751194111"><h4 class="sectiontitle">Example Responses</h4><p id="CreateNotebook__p478475124110"><strong id="CreateNotebook__b878495111419">Status code: 200</strong></p>
<p id="CreateNotebook__p1478412514418">OK</p>
<pre class="screen" id="CreateNotebook__screen12784155114418">{
"action_progress" : [ {
"step" : 1,
"status" : "WAITING",
"description" : "Prepare the storage."
}, {
"step" : 2,
"status" : "WAITING",
"description" : "Prepare the compute resource."
}, {
"step" : 3,
"status" : "WAITING",
"description" : "Configuring the network."
}, {
"step" : 4,
"status" : "WAITING",
"description" : "Initialize the notebook instance."
} ],
"create_at" : 1638841744521,
"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..xxxx.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,
"update_at" : 1638841744515
},
"name" : "notebooks_test",
"status" : "CREATING",
"token" : "3eff13f2-3d70-5456-6dc7-e3f99f562022",
"update_at" : 1638841744522,
"workspace_id" : "0"
}</pre>
</div>
<div class="section" id="CreateNotebook__section167917514410"><h4 class="sectiontitle">Status Codes</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="CreateNotebook__status_code" frame="border" border="1" rules="all"><thead align="left"><tr id="CreateNotebook__row172111751104116"><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.8.2.1.3.1.1"><p id="CreateNotebook__p3791175154120">Status Code</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="85%" id="mcps1.3.8.2.1.3.1.2"><p id="CreateNotebook__p11791451144115">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="CreateNotebook__row321155164115"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p id="CreateNotebook__p1379119519412">200</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p id="CreateNotebook__p1179195114414">OK</p>
</td>
</tr>
<tr id="CreateNotebook__row4211185184117"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p id="CreateNotebook__p12792155114418">201</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p id="CreateNotebook__p1479216517415">Created</p>
</td>
</tr>
<tr id="CreateNotebook__row1321120513418"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p id="CreateNotebook__p1479216514411">401</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p id="CreateNotebook__p279285110417">Unauthorized</p>
</td>
</tr>
<tr id="CreateNotebook__row13211451164114"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p id="CreateNotebook__p12792951204118">403</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p id="CreateNotebook__p157921751154113">Forbidden</p>
</td>
</tr>
<tr id="CreateNotebook__row14211105114111"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p id="CreateNotebook__p37921051184115">404</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p id="CreateNotebook__p127930511415">Not Found</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="CreateNotebook__section079315154119"><h4 class="sectiontitle">Error Codes</h4><p id="CreateNotebook__p1379315134114">See <a href="modelarts_03_0095.html">Error Codes</a>.</p>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="notebook.html">DevEnviron Instance Management</a></div>
</div>
</div>
View Git Blame Copy Permalink