yexinru/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
Files
0b3a43371a4bcc99577594de0a685249d676a567
doc-exports/docs/modelarts/api-ref/modelarts_03_0406.html
Wuwan, Qi 78d5ebfce8 ModelArts API 25.3.0 20250710 
Reviewed-by: Pruthi, Vineet <vineet.pruthi@t-systems.com>
Co-authored-by: Wuwan, Qi <wuwanqi1@noreply.gitea.eco.tsi-dev.otc-service.com>
Co-committed-by: Wuwan, Qi <wuwanqi1@noreply.gitea.eco.tsi-dev.otc-service.com>
2025-07-28 12:24:54 +00:00

1124 lines
48 KiB
HTML
Raw Blame History

<a name="EN-US_TOPIC_0000002374896525"></a><a name="EN-US_TOPIC_0000002374896525"></a>
<h1 class="topictitle1">Creating a Development Environment Instance</h1>
<div id="body0000001167870235"><p id="EN-US_TOPIC_0000002374896525__p15380191918816">This section describes how to create a development environment instance by calling ModelArts APIs.</p>
<div class="section" id="EN-US_TOPIC_0000002374896525__section1584656102611"><h4 class="sectiontitle">Overview</h4><p id="EN-US_TOPIC_0000002374896525__p6171183914104">The process for creating a development environment instance is as follows:</p>
<ol id="EN-US_TOPIC_0000002374896525__ol51731432121217"><li id="EN-US_TOPIC_0000002374896525__li15913193817196">Call the API for <a href="modelarts_03_0004.html">authentication</a> to obtain a user token, which will be added in a request header for authentication.</li><li id="EN-US_TOPIC_0000002374896525__li11901135831418">Call the API for <a href="ListImage.html">querying supported images</a> to view the image type and version in the development environment.</li><li id="EN-US_TOPIC_0000002374896525__li33722031111515">Call the API for <a href="CreateNotebook.html">creating a notebook instance</a> to create an instance.</li><li id="EN-US_TOPIC_0000002374896525__li62310211161">Call the API for <a href="ShowNotebook.html">querying details of a notebook instance</a> to query the instance creation details based on the instance ID.</li><li id="EN-US_TOPIC_0000002374896525__li10490131814338">Call the API for <a href="RenewLease.html">prolonging a notebook instance</a> to reset the usage duration of the instance.</li><li id="EN-US_TOPIC_0000002374896525__li541685795511">Call the API for <a href="StopNotebook.html">stopping a notebook instance</a> to stop the instance that is running.</li><li id="EN-US_TOPIC_0000002374896525__li1061746566">Call the API for <a href="StartNotebook.html">starting a notebook instance</a> to restart the instance.</li><li id="EN-US_TOPIC_0000002374896525__li8603640104114">Call the API for <a href="DeleteNotebook.html">deleting a notebook instance</a> to delete the instance that is no longer needed.</li></ol>
</div>
<div class="section" id="EN-US_TOPIC_0000002374896525__section19616688365"><h4 class="sectiontitle">Prerequisites</h4><ul id="EN-US_TOPIC_0000002374896525__ul76456278206"><li id="EN-US_TOPIC_0000002374896525__li1054032119297">You have obtained the endpoints of <a href="modelarts_03_0141.html">ModelArts</a>.</li><li id="EN-US_TOPIC_0000002374896525__li178815407564">The following information is available: region where ModelArts is deployed, <a href="modelarts_03_0147.html">project ID and name</a>, <a href="modelarts_03_0148.html">account name and ID</a>, and <a href="modelarts_03_0006.html">username and user ID</a>.</li></ul>
</div>
<div class="section" id="EN-US_TOPIC_0000002374896525__section05617321652"><h4 class="sectiontitle">Procedure</h4><ol id="EN-US_TOPIC_0000002374896525__ol129691627132819"><li id="EN-US_TOPIC_0000002374896525__li1810635852914"><p id="EN-US_TOPIC_0000002374896525__p1341316561173"><a name="EN-US_TOPIC_0000002374896525__li1810635852914"></a><a name="li1810635852914"></a>Call the API for <a href="ListImage.html">querying supported images</a> to view the image type and version in the development environment.</p>
<ol type="a" id="EN-US_TOPIC_0000002374896525__ol556893613011"><li id="EN-US_TOPIC_0000002374896525__li15576534115910">Request body:<p id="EN-US_TOPIC_0000002374896525__p9451114121616"><a name="EN-US_TOPIC_0000002374896525__li15576534115910"></a><a name="li15576534115910"></a>URI: GET https://<em id="EN-US_TOPIC_0000002374896525__i145114411612">{ma_endpoint}</em>/v1/<em id="EN-US_TOPIC_0000002374896525__i1745117414168">{project_id}</em>/images</p>
<div class="p" id="EN-US_TOPIC_0000002374896525__p1945113416161">Request header:<ul id="EN-US_TOPIC_0000002374896525__ul194518481611"><li id="EN-US_TOPIC_0000002374896525__li114511849163">X-auth-Token →<strong id="EN-US_TOPIC_0000002374896525__b845164121614"><em id="EN-US_TOPIC_0000002374896525__i154511541164">MIIZmgYJKoZIhvcNAQcCoIIZizCCGYcCAQExDTALBglghkgBZQMEAgEwgXXXXXX...</em></strong></li><li id="EN-US_TOPIC_0000002374896525__li54511247160">Content-Type →application/json</li></ul>
</div>
<p id="EN-US_TOPIC_0000002374896525__p1296951910219">Set the following parameters based on site requirements:</p>
<ul id="EN-US_TOPIC_0000002374896525__ul593170155518"><li id="EN-US_TOPIC_0000002374896525__li179315014550"><em id="EN-US_TOPIC_0000002374896525__i20391184103612">ma_endpoint</em>: ModelArts endpoint</li><li id="EN-US_TOPIC_0000002374896525__li1993809553"><em id="EN-US_TOPIC_0000002374896525__i1319673517365">project_id</em>: user's project ID</li><li id="EN-US_TOPIC_0000002374896525__li194170155520"><span class="parmname" id="EN-US_TOPIC_0000002374896525__parmname1039654516375"><b>X-auth-Token</b></span>: token obtained in the previous step</li></ul>
</li><li id="EN-US_TOPIC_0000002374896525__li24521049168"><p id="EN-US_TOPIC_0000002374896525__p9636454168"><a name="EN-US_TOPIC_0000002374896525__li24521049168"></a><a name="li24521049168"></a>Status code <strong id="EN-US_TOPIC_0000002374896525__b558112918385">200</strong> is returned. The response body is as follows:</p>
<pre class="screen" id="EN-US_TOPIC_0000002374896525__screen189169175158">{
"current": 0,
"data": [
{
"arch": "x86_64",
"description": "CPU and GPU general algorithm development and training, preconfigured with AI engine PyTorch1.8",
"dev_services": [
"NOTEBOOK",
"SSH"
],
"id": "278e88d1-5b71-4766-8502-b3ba72e824d9",
"name": "pytorch1.8-cuda10.2-cudnn7-ubuntu18.04",
"resource_categories": [
"CPU",
"GPU"
],
"service_type": "COMMON",
"status": "ACTIVE",
"swr_path": "swr.com/atelier/pytorch_1_8:pytorch_1.8.0-cuda_10.2-py_3.7-ubuntu_18.04-x86_64-20221118143845-d65d817",
"tag": "pytorch_1.8.0-cuda_10.2-py_3.7-ubuntu_18.04-x86_64-20221118143845-d65d817",
"tags": [],
"type": "BUILD_IN",
"update_at": 1648866992843,
"workspace_id": "0"
},
{
"arch": "x86_64",
"description": "CPU and GPU general algorithm development and training, preconfigured with AI engine MindSpore1.7.0 and cuda10.1",
"dev_services": [
"NOTEBOOK",
"SSH"
],
"id": "e1a07296-22a8-4f05-8bc8-e936c8e54202",
"name": "mindspore1.7.0-cuda10.1-py3.7-ubuntu18.04",
"resource_categories": [
"GPU"
],
"service_type": "TRAIN",
"status": "ACTIVE",
"swr_path": "swr.com/atelier/mindspore_1_7_0:mindspore_1.7.0-cuda_10.1-py_3.7-ubuntu_18.04-x86_64-20221118143809-d65d817",
"tag": "mindspore_1.7.0-cuda_10.1-py_3.7-ubuntu_18.04-x86_64-20221118143809-d65d817",
"tags": [],
"type": "BUILD_IN",
"workspace_id": "0"
},
{
"arch": "x86_64",
"description": "CPU general algorithm development and training, preconfigured with AI engine MindSpore1.7.0",
"dev_services": [
"NOTEBOOK",
"SSH"
],
"id": "c0b31f09-1490-4555-9b8b-ab0b2de35b20",
"name": "mindspore1.7.0-py3.7-ubuntu18.04",
"resource_categories": [
"CPU"
],
"service_type": "TRAIN",
"status": "ACTIVE",
"swr_path": "swr.com/atelier/mindspore_1_7_0:mindspore_1.7.0-cpu-py_3.7-ubuntu_18.04-x86_64-20221118143809-d65d817",
"tag": "mindspore_1.7.0-cpu-py_3.7-ubuntu_18.04-x86_64-20221118143809-d65d817",
"tags": [],
"type": "BUILD_IN",
"workspace_id": "0"
},
{
"arch": "x86_64",
"description": "CPU and GPU general algorithm development and training, preconfigured with AI engine TensorFlow2.1",
"dev_services": [
"NOTEBOOK",
"SSH"
],
"id": "e1a07296-22a8-4f05-8bc8-e936c8e54100",
"name": "tensorflow2.1-cuda10.1-cudnn7-ubuntu18.04",
"resource_categories": [
"CPU",
"GPU"
],
"service_type": "COMMON",
"status": "ACTIVE",
"swr_path": "swr.com/atelier/tensorflow_2_1:tensorflow_2.1.0-cuda_10.1-py_3.7-ubuntu_18.04-x86_64-20221121111529-d65d817",
"tag": "tensorflow_2.1.0-cuda_10.1-py_3.7-ubuntu_18.04-x86_64-20221121111529-d65d817",
"tags": [],
"type": "BUILD_IN",
"update_at": 1643166780367,
"workspace_id": "0"
},
{
"arch": "x86_64",
"description": "CPU and GPU general algorithm development and training, preconfigured with AI engine PyTorch1.10 and cuda10.2",
"dev_services": [
"NOTEBOOK",
"SSH"
],
"id": "d996b661-e127-48c4-a90a-fca29535f201",
"name": "pytorch1.10-cuda10.2-cudnn7-ubuntu18.04",
"resource_categories": [
"CPU",
"GPU"
],
"service_type": "UNKNOWN",
"status": "ACTIVE",
"swr_path": "swr.com/atelier/pytorch_1_10:pytorch_1.10.2-cuda_10.2-py_3.7-ubuntu_18.04-x86_64-20221118143845-d65d817",
"tag": "pytorch_1.10.2-cuda_10.2-py_3.7-ubuntu_18.04-x86_64-20221118143845-d65d817",
"tags": [],
"type": "BUILD_IN",
"workspace_id": "0"
},
{
"arch": "x86_64",
"description": "Clean user customized base image include cuda10.2, conda",
"dev_services": [
"NOTEBOOK",
"SSH"
],
"id": "d937149a-785c-4d2d-a568-8dde7c06cca0",
"name": "conda3-cuda10.2-cudnn7-ubuntu18.04",
"resource_categories": [
"GPU"
],
"service_type": "UNKNOWN",
"status": "ACTIVE",
"swr_path": "swr.com/atelier/user_defined_base:cuda_10.2-ubuntu_18.04-x86_64-20230404095316-7fcd503",
"tag": "cuda_10.2-ubuntu_18.04-x86_64-20230404095316-7fcd503",
"tags": [],
"type": "BUILD_IN",
"workspace_id": "0"
},
{
"arch": "x86_64",
"description": "Clean user customized base image only include conda",
"dev_services": [
"NOTEBOOK",
"SSH"
],
"id": "27542a4a-3b37-404d-add9-a7d2d2ce6893",
"name": "conda3-ubuntu18.04",
"resource_categories": [
"CPU"
],
"service_type": "UNKNOWN",
"status": "ACTIVE",
"swr_path": "swr.com/atelier/user_defined_base:ubuntu_18.04-x86_64-20230404095316-7fcd503",
"tag": "ubuntu_18.04-x86_64-20230404095316-7fcd503",
"tags": [],
"type": "BUILD_IN",
"workspace_id": "0"
},
{
"arch": "x86_64",
"description": "CPU and GPU general algorithm development and training, preconfigured with AI engine PyTorch1.4",
"dev_services": [
"NOTEBOOK",
"SSH"
],
"id": "e1a07296-22a8-4f05-8bc8-e936c8e54099",
"name": "pytorch1.4-cuda10.1-cudnn7-ubuntu18.04",
"resource_categories": [
"CPU",
"GPU"
],
"service_type": "TRAIN",
"status": "ACTIVE",
"swr_path": "swr.com/atelier/pytorch_1_4:pytorch_1.4-cuda_10.1-py37-ubuntu_18.04-x86_64-20221118143845-d65d817",
"tag": "pytorch_1.4-cuda_10.1-py37-ubuntu_18.04-x86_64-20221118143845-d65d817",
"tags": [],
"type": "BUILD_IN",
"update_at": 1648866992868,
"workspace_id": "0"
},
{
"arch": "x86_64",
"description": "GPU algorithm development and training, preconfigured with AI engine TensorFlow1.13.1",
"dev_services": [
"NOTEBOOK",
"SSH"
],
"id": "b80bbf3d-a7af-42f6-ad12-33ff9116ab0d",
"name": "tensorflow1.13-cuda10.0-cudnn7-ubuntu18.04",
"resource_categories": [
"GPU"
],
"service_type": "TRAIN",
"status": "ACTIVE",
"swr_path": "swr.com/atelier/tensorflow_1_13:tensorflow_1.13-cuda_10.0-py_3.7-ubuntu_18.04-x86_64-20221118143845-d65d817",
"tag": "tensorflow_1.13-cuda_10.0-py_3.7-ubuntu_18.04-x86_64-20221118143845-d65d817",
"tags": [],
"type": "BUILD_IN",
"update_at": 1648866992960,
"workspace_id": "0"
},
{
"arch": "aarch64",
"create_at": 1608937196685,
"description": "ARM algorithm development and training. TensorFlow and MindSpore are preset in the AI engine.",
"dev_services": [
"NOTEBOOK",
"SSH"
],
"id": "59a6e9f5-93c0-44dd-85b0-82f390c5d53a",
"name": "tensorflow1.15-mindspore1.7.0-cann5.1.0-euler2.8-aarch64",
"service_type": "TRAIN",
"status": "ACTIVE",
"swr_path": "swr.com/atelier/notebook2.0-mul-kernel-arm-cp37:5.0.1-c81-20220726",
"tag": "5.0.1-c81-20220726",
"tags": [],
"type": "BUILD_IN",
"update_at": 1648866992983,
"workspace_id": "0"
},
{
"arch": "x86_64",
"description": "AI inference application development, preconfigured ModelBox and AI engine LibTorch, only SSH connection supported.",
"dev_services": [
"AI_FLOW",
"SSH"
],
"id": "e1a07296-22a8-4f05-8bc8-e936c8e54103",
"name": "modelbox1.3.0-libtorch1.9.1-cuda10.2-cudnn8-euler2.9.6",
"resource_categories": [
"GPU"
],
"service_type": "TRAIN",
"status": "ACTIVE",
"swr_path": "swr.com/atelier/modelarts-modelbox-libtorch-gpu-x86:1.3.0-20221223142251-b3da6d6",
"tag": "1.3.0-20221223142251-b3da6d6",
"tags": [],
"type": "BUILD_IN",
"update_at": 1648866993005,
"workspace_id": "0"
},
{
"arch": "x86_64",
"description": "AI inference application development, preconfigured ModelBox and AI engine TensorRT, only SSH connection supported.",
"dev_services": [
"AI_FLOW",
"SSH"
],
"id": "e1a07296-22a8-4f05-8bc8-e936c8e54101",
"name": "modelbox1.3.0-tensorrt7.1.3-cuda10.2-cudnn8-euler2.9.6",
"resource_categories": [
"GPU"
],
"service_type": "TRAIN",
"status": "ACTIVE",
"swr_path": "swr.com/atelier/modelarts-modelbox-tensorrt-gpu-x86:1.3.0-20221223142251-b3da6d6",
"tag": "1.3.0-20221223142251-b3da6d6",
"tags": [],
"type": "BUILD_IN",
"update_at": 1648866993030,
"workspace_id": "0"
},
{
"arch": "aarch64",
"description": " The professional operator development tool MindStudio is preconfigured, only SSH connection supported.",
"dev_services": [
"SSH"
],
"id": "e1a07296-22a8-4f05-8bc8-e936c8e54088",
"name": "mindstudio5.0.rc1-cann5.1.0-euler2.8.3-aarch64",
"service_type": "TRAIN",
"status": "ACTIVE",
"swr_path": "swr.com/atelier/mindstudio-modelarts-image:5.0.rc1-20230322101430-75f458a",
"tag": "5.0.rc1-20230322101430-75f458a",
"tags": [],
"type": "BUILD_IN",
"update_at": 1648866993052,
"workspace_id": "0"
},
{
"arch": "x86_64",
"description": "CPU algorithm development and training, preconfigured PySpark 2.4.5 and scala 2.11.12 for code development in local notebook and remote spark cluster including MRS and DLI",
"dev_services": [
"NOTEBOOK"
],
"id": "0b2d0728-4c01-11ec-994f-001a7dda7112",
"name": "spark2.4.5-ubuntu18.04",
"resource_categories": [
"CPU"
],
"service_type": "TRAIN",
"status": "ACTIVE",
"swr_path": "swr.com/atelier/pyspark_2_4_5:develop-remote-pyspark_2.4.5-py_3.7-cpu-ubuntu_18.04-x86_64-uid1000-20221222203856-fcc979e",
"tag": "develop-remote-pyspark_2.4.5-py_3.7-cpu-ubuntu_18.04-x86_64-uid1000-20221222203856-fcc979e",
"tags": [],
"type": "BUILD_IN",
"update_at": 1648867218663,
"workspace_id": "0"
},
{
"arch": "x86_64",
"create_at": 1605759392357,
"description": "CPU algorithm development and training, preconfigured with the AI engine MindSpore-CPU",
"dev_services": [
"NOTEBOOK",
"SSH"
],
"id": "65f636a0-56cf-49df-b941-7d2a07ba8c8c",
"name": "mindspore1.2.0-openmpi2.1.1-ubuntu18.04",
"resource_categories": [
"CPU"
],
"service_type": "TRAIN",
"status": "ACTIVE",
"swr_path": "swr.com/atelier/mindspore_1_2_0:mindspore_1.2.0-py_3.7-ubuntu_18.04-x86_64-20221118143809-d65d817",
"tag": "mindspore_1.2.0-py_3.7-ubuntu_18.04-x86_64-20221118143809-d65d817",
"tags": [],
"type": "BUILD_IN",
"update_at": 1643166780389,
"workspace_id": "0"
},
{
"arch": "x86_64",
"create_at": 1664501979865,
"description": "",
"dev_services": [
"NOTEBOOK",
"SSH"
],
"id": "df78b3f7-98a4-4616-aef0-71cfff4195c9",
"name": "spark",
"namespace": "testdli002",
"origin": "CUSTOMIZE",
"resource_categories": [
"CPU"
],
"service_type": "UNKNOWN",
"size": 1133670676,
"status": "ACTIVE",
"swr_path": "swr.com/testdli002/spark:2.4.5.tensorflow",
"tag": "2.4.5.tensorflow",
"tags": [],
"type": "DEDICATED",
"update_at": 1664501979865,
"visibility": "PRIVATE",
"workspace_id": "0"
},
{
"arch": "x86_64",
"create_at": 1664513619044,
"description": "",
"dev_services": [
"NOTEBOOK",
"SSH"
],
"id": "836ab55d-4a02-4dbb-b04f-ece555d642a8",
"name": "tensorflow2_1_1",
"namespace": "hwstaff_pub_cbuinfo_ei",
"origin": "IMAGE_SAVE",
"resource_categories": [
"CPU",
"GPU"
],
"service_type": "COMMON",
"size": 5094544544,
"status": "ERROR",
"status_message": "",
"swr_path": "swr.com/hwstaff_pub_cbuinfo_ei/tensorflow2_1_1:1.0.0",
"tag": "1.0.0",
"tags": [],
"type": "DEDICATED",
"update_at": 1664513676950,
"visibility": "PRIVATE",
"workspace_id": "0"
},
{
"arch": "x86_64",
"create_at": 1668482562290,
"description": "test",
"dev_services": [
"NOTEBOOK",
"SSH"
],
"id": "689c81b3-15dd-4500-b63e-1871e24eb391",
"name": "pytorch_1_8",
"namespace": "atelier",
"origin": "CUSTOMIZE",
"resource_categories": [
"GPU"
],
"service_type": "UNKNOWN",
"size": 8285974481,
"status": "ACTIVE",
"swr_path": "swr.com/atelier/pytorch_1_8:pytorch_1.8.2-cuda_11.1-py_3.7-ubuntu_18.04-x86_64-20220926104358-041ba2e",
"tag": "pytorch_1.8.2-cuda_11.1-py_3.7-ubuntu_18.04-x86_64-20220926104358-041ba2e",
"tags": [],
"type": "DEDICATED",
"update_at": 1668482562290,
"visibility": "PRIVATE",
"workspace_id": "0"
},
{
"arch": "aarch64",
"description": "ARM algorithm development and training. MindSpore is preset in the AI engine.",
"dev_services": [
"NOTEBOOK",
"SSH"
],
"id": "f6d0908e-9596-41f9-9843-83089cbdd0de",
"name": "mindspore1.7.0-cann5.1.0-py3.7-euler2.8.3",
"namespace": "atelier",
"service_type": "UNKNOWN",
"status": "ACTIVE",
"swr_path": "swr.com/atelier/mindspore_1_7_0:mindspore_1.7.0-cann_5.1.0-py_3.7-euler_2.8.3-aarch64-d910-20220906",
"tag": "mindspore_1.7.0-cann_5.1.0-py_3.7-euler_2.8.3-aarch64-d910-20220906",
"tags": [],
"type": "BUILD_IN",
"workspace_id": "0"
},
{
"arch": "aarch64",
"description": "ARM algorithm development and training. TensorFlow is preset in the AI engine.",
"dev_services": [
"NOTEBOOK",
"SSH"
],
"id": "c5b7507b-ca8d-48d5-a373-fe4b42c66ed8",
"name": "tensorflow1.15-cann5.1.0-py3.7-euler2.8.3",
"namespace": "atelier",
"service_type": "UNKNOWN",
"status": "ACTIVE",
"swr_path": "swr.com/atelier/tensorflow_1_15:tensorflow_1.15-cann_5.1.0-py_3.7-euler_2.8.3-aarch64-d910-20220906",
"tag": "tensorflow_1.15-cann_5.1.0-py_3.7-euler_2.8.3-aarch64-d910-20220906",
"tags": [],
"type": "BUILD_IN",
"workspace_id": "0"
},
{
"arch": "x86_64",
"create_at": 1678261148079,
"description": "",
"dev_services": [
"NOTEBOOK",
"SSH"
],
"id": "e1ab81ef-f452-46b5-9663-6fc1f982f9e9",
"name": "grafana",
"namespace": "hwstaff_pub_cbuinfo_ei",
"origin": "IMAGE_SAVE",
"resource_categories": [
"CPU",
"GPU"
],
"service_type": "COMMON",
"size": 5247805223,
"status": "ACTIVE",
"status_message": "",
"swr_path": "swr.com/hwstaff_pub_cbuinfo_ei/grafana:v1.0",
"tag": "v1.0",
"tags": [],
"type": "DEDICATED",
"update_at": 1678261330238,
"visibility": "PRIVATE",
"workspace_id": "0"
},
{
"arch": "x86_64",
"create_at": 1681973786157,
"dev_services": [
"NOTEBOOK",
"SSH"
],
"id": "a5a43175-30a6-43d2-9596-38bee562f8c0",
"name": "pytorch_1_8",
"namespace": "sdk-test2",
"origin": "CUSTOMIZE",
"resource_categories": [
"CPU",
"GPU"
],
"service_type": "UNKNOWN",
"size": 2308736380,
"status": "ACTIVE",
"swr_path": "swr.com/sdk-test2/pytorch_1_8:v2",
"tag": "v2",
"tags": [],
"type": "DEDICATED",
"update_at": 1681973786157,
"visibility": "PRIVATE",
"workspace_id": "0"
},
{
"arch": "aarch64",
"create_at": 1682670088194,
"description": "ARM algorithm development and training. MindSpore is preset in the AI engine.",
"dev_services": [
"NOTEBOOK",
"SSH"
],
"id": "75cbf0f2-0a3e-48c9-b2c4-7e78af18d86e",
"name": "mindspore_1.9.0-cann_6.0.0-py_3.7-euler_2.8.3",
"namespace": "atelier",
"service_type": "TRAIN",
"size": 4011027643,
"status": "ACTIVE",
"swr_path": "swr.com/atelier/mindspore_1_9:mindspore_1.9.0-cann_6.0.0-py_3.7-euler_2.8.3-aarch64-d910-20221116111529",
"tag": "mindspore_1.9.0-cann_6.0.0-py_3.7-euler_2.8.3-aarch64-d910-20221116111529",
"tags": [],
"type": "BUILD_IN",
"update_at": 1682670088197,
"visibility": "PUBLIC",
"workspace_id": "0"
},
{
"arch": "x86_64",
"description": "notebook2.0 gpu",
"dev_services": [
"NOTEBOOK",
"SSH"
],
"id": "e1a07296-22a8-4f05-8bc8-e936c8e54092",
"name": "notebook2.0-mul-kernel-cpu-cp36",
"resource_categories": [
"GPU"
],
"service_type": "TRAIN",
"status": "ACTIVE",
"swr_path": "swr.com/atelier/notebook2.0-mul-kernel-gpu-cp36:5.0.1-release-v2-20220505",
"tag": "5.0.1-release-v2-20220505",
"tags": [],
"type": "BUILD_IN",
"update_at": 1628221753209,
"workspace_id": "0"
},
{
"arch": "aarch64",
"create_at": 1683537880541,
"description": "ARM algorithm development and training. MindSpore is preset in the AI engine.",
"dev_services": [
"NOTEBOOK",
"SSH"
],
"id": "31ae7ba4-63e6-4fa6-8aeb-cb382953e414",
"name": "mindspore_1.10.0-cann_6.0.1-py_3.7-euler_2.8.3",
"namespace": "atelier",
"service_type": "COMMON",
"size": 4057170552,
"status": "ACTIVE",
"swr_path": "swr.com/atelier/mindspore_1_10:mindspore_1.10.0-cann_6.0.1-py_3.7-euler_2.8.3-aarch64-d910-20230303173945-815d627",
"tag": "mindspore_1.10.0-cann_6.0.1-py_3.7-euler_2.8.3-aarch64-d910-20230303173945-815d627",
"tags": [],
"type": "BUILD_IN",
"update_at": 1683537880548,
"visibility": "PUBLIC",
"workspace_id": "0"
},
{
"arch": "x86_64",
"description": "CPU algorithm development and training, including the MLStudio tool for graphical ML algorithm development, and preconfigured PySpark 2.3.2",
"dev_services": [
"NOTEBOOK"
],
"id": "0e5f9a41-c9c2-4d9a-a190-4e1b17a7782f",
"name": "mlstudio-pyspark2.3.2-ubuntu16.04",
"resource_categories": [
"CPU"
],
"service_type": "TRAIN",
"status": "ACTIVE",
"swr_path": "swr.com/atelier/notebook2.0-mlstudio-cp36:3.3.1.9",
"tag": "3.3.1.9",
"tags": [],
"type": "BUILD_IN",
"update_at": 1648867218685,
"workspace_id": "0"
},
{
"arch": "x86_64",
"description": "notebook2.0 cpu base image",
"dev_services": [
"NOTEBOOK",
"SSH"
],
"id": "e1a07296-22a8-4f05-8bc8-e936c8e54090",
"name": "notebook2.0-mul-kernel-cpu-cp36",
"resource_categories": [
"CPU"
],
"service_type": "TRAIN",
"status": "ACTIVE",
"swr_path": "swr.com/atelier/notebook2.0-mul-kernel-cpu-cp36:5.0.1-release-v2-20220505",
"tag": "5.0.1-release-v2-20220505",
"tags": [],
"type": "BUILD_IN",
"update_at": 1628221753345,
"workspace_id": "0"
},
{
"arch": "x86_64",
"description": "GPU algorithm development and training, preconfigured with the AI engine MindSpore-GPU",
"dev_services": [
"NOTEBOOK",
"SSH"
],
"id": "d7fb5355-9045-4deb-94c6-4033e1e62728",
"name": "mindspore1.2.0-openmpi2.1.1-ubuntu18.04",
"resource_categories": [
"GPU"
],
"service_type": "TRAIN",
"status": "ACTIVE",
"swr_path": "swr.com/atelier/mindspore_1_2_0:mindspore_1.2.0-py_3.7-ubuntu_18.04-x86_64-20221118143809-d65d817",
"tag": "mindspore_1.2.0-py_3.7-ubuntu_18.04-x86_64-20221118143809-d65d817",
"tags": [],
"type": "BUILD_IN",
"update_at": 1636963735672,
"workspace_id": "0"
},
{
"arch": "x86_64",
"create_at": 1628757809703,
"description": "CPU operations research development, preconfigured with cylp, cbcpy, ortools, cplex(community).",
"dev_services": [
"NOTEBOOK",
"SSH"
],
"id": "b9933af0-3119-4045-a427-5e668327dafd",
"name": "cylp0.91.4-cbcpy2.10-ortools9.0-cplex20.1.0-ubuntu18.04",
"namespace": "atelier",
"resource_categories": [
"CPU"
],
"service_type": "TRAIN",
"size": 2550402546,
"status": "ACTIVE",
"swr_path": "swr.com/atelier/or_1_0_0:or_1.0.0-py_3.7-ubuntu_18.04-x86_64-roma-20220812093355-e50493d",
"tag": "or_1.0.0-py_3.7-ubuntu_18.04-x86_64-roma-20220812093355-e50493d",
"tags": [],
"type": "BUILD_IN",
"update_at": 1642836699554,
"workspace_id": "0"
},
{
"arch": "x86_64",
"description": "CPU algorithm development and training, including the MLStudio tool for graphical ML algorithm development, and preconfigured PySpark 2.4.5",
"dev_services": [
"NOTEBOOK"
],
"id": "0b2d0728-4c01-11ec-994f-001a7dda7111",
"name": "mlstudio-pyspark2.4.5-ubuntu18.04",
"resource_categories": [
"CPU"
],
"service_type": "TRAIN",
"status": "ACTIVE",
"swr_path": "swr.com/atelier/notebook2.0-mlstudio-cp37:5.0.1-mls-20230118153946",
"tag": "5.0.1-mls-20230118153946",
"tags": [],
"type": "BUILD_IN",
"update_at": 1648867218708,
"workspace_id": "0"
},
{
"arch": "x86_64",
"create_at": 1605759392404,
"description": "GPU algorithm development and training, preconfigured with the AI engine MindSpore-GPU",
"dev_services": [
"NOTEBOOK",
"SSH"
],
"id": "89de30ec-6871-4f22-84af-be37ef28335d",
"name": "mindspore1.2.0-cuda10.1-cudnn7-ubuntu18.04",
"resource_categories": [
"GPU"
],
"service_type": "TRAIN",
"status": "ACTIVE",
"swr_path": "swr.com/atelier/mindspore_1_2_0:mindspore_1.2.0-py_3.7-cuda_10.1-ubuntu_18.04-x86_64-20221118143809-d65d817",
"tag": "mindspore_1.2.0-py_3.7-cuda_10.1-ubuntu_18.04-x86_64-20221118143809-d65d817",
"tags": [],
"type": "BUILD_IN",
"update_at": 1648867218639,
"workspace_id": "0"
},
{
"arch": "x86_64",
"description": "description",
"dev_services": [
"NOTEBOOK"
],
"id": "88bd7bcd-0c91-45b2-ad0e-ef65553d19c5",
"name": "dls-feature-engineering",
"resource_categories": [
"CPU"
],
"service_type": "TRAIN",
"status": "ACTIVE",
"swr_path": "swr.com/atelier/notebook2.0-mul-kernel-dls-feature-engineering-cpu-py37:3.2.0109",
"tag": "3.2.0109",
"tags": [],
"type": "BUILD_IN",
"update_at": 1623899358020,
"workspace_id": "0"
},
{
"arch": "x86_64",
"description": "description",
"dev_services": [
"NOTEBOOK"
],
"id": "1d1b1327-b243-425b-ad81-2689584c1acc",
"name": "mls-feature-engineering",
"resource_categories": [
"CPU"
],
"service_type": "TRAIN",
"status": "ACTIVE",
"swr_path": "swr.com/atelier/notebook2.0-mul-kernel-mls-feature-engineering-cpu-py37:3.2.0109",
"tag": "3.2.0109",
"tags": [],
"type": "BUILD_IN",
"update_at": 1623899357995,
"workspace_id": "0"
},
{
"arch": "x86_64",
"description": "MindSpore1.7.0 and MindQuantum0.6.0",
"dev_services": [
"NOTEBOOK",
"SSH"
],
"id": "6592fa02-a40a-4054-a05f-f22215e45ec1",
"name": "mindquantum0.6.0-mindspore1.7.0-ubuntu18.04",
"resource_categories": [
"CPU"
],
"service_type": "TRAIN",
"status": "ACTIVE",
"swr_path": "swr.com/atelier/mindspore_1_7_0:mindspore_1.7.0-cpu-py_3.7-ubuntu_18.04-x86_64-20220727174747-6a4cdd5",
"tag": "mindspore_1.7.0-cpu-py_3.7-ubuntu_18.04-x86_64-20220727174747-6a4cdd5",
"tags": [],
"type": "BUILD_IN",
"workspace_id": "0"
},
{
"arch": "x86_64",
"create_at": 1628757853111,
"description": "CPU and GPU algorithm development and training, preconfigured with AI engine ray for reinforcement learning.",
"dev_services": [
"NOTEBOOK",
"SSH"
],
"id": "4233d6f9-c3b5-4cf2-9ee6-2ef565935d6d",
"name": "rlstudio1.0.0-ray1.3.0-cuda10.1-ubuntu18.04",
"namespace": "rl-dev",
"resource_categories": [
"CPU",
"GPU"
],
"service_type": "TRAIN",
"size": 4857883146,
"status": "ACTIVE",
"swr_path": "swr.com/atelier/notebook2.0-rl-1.0.0-kernel-cp37:rl-v1220211203",
"tag": "rl-v1220211203",
"tags": [],
"type": "BUILD_IN",
"update_at": 1642836699527,
"workspace_id": "0"
},
{
"arch": "aarch64",
"description": "ARM algorithm development and training. TensorFlow and MindSpore are preset in the AI engine.",
"dev_services": [
"NOTEBOOK",
"SSH"
],
"id": "59a6e9f5-93c0-44dd-85b0-82f390c5d53b",
"name": "tensorflow1.15-mindspore1.7.0-cann5.1.0-euler2.8-aarch64",
"resource_categories": [
"CPU"
],
"service_type": "TRAIN",
"status": "ACTIVE",
"swr_path": "swr.com/atelier/notebook2.0-mul-kernel-arm-cp37:5.0.1-c81-20220726",
"tag": "5.0.1-c81-20220726",
"tags": [],
"type": "BUILD_IN",
"update_at": 1640398185602,
"workspace_id": "0"
},
{
"arch": "x86_64",
"description": "CPU general algorithm development and training, preconfigured with AI engine MindSpore1.7.0",
"dev_services": [
"NOTEBOOK",
"SSH"
],
"id": "9d63f4d1-dc09-4873-b669-3483cea777c0",
"name": "mindspore1.7.0-ubuntu18.04-default",
"resource_categories": [
"CPU"
],
"service_type": "TRAIN",
"status": "ACTIVE",
"swr_path": "swr.com/atelier/mindspore_1_7_0:mindspore_1.7.0-cpu-py_3.7-ubuntu_18.04-x86_64-20220625205423-5a13f29",
"tag": "mindspore_1.7.0-cpu-py_3.7-ubuntu_18.04-x86_64-20220625205423-5a13f29",
"tags": [],
"type": "BUILD_IN",
"workspace_id": "0"
},
{
"arch": "x86_64",
"description": "CPU and GPU general algorithm development and training, preconfigured with AI engine MindSpore1.7.0 and cuda10.1",
"dev_services": [
"NOTEBOOK",
"SSH"
],
"id": "e1a07296-22a8-4f05-8bc8-e936c8e54203",
"name": "mindspore1.7.0-ubuntu18.04-default",
"resource_categories": [
"GPU"
],
"service_type": "TRAIN",
"status": "ACTIVE",
"swr_path": "swr.com/atelier/mindspore_1_7_0:mindspore_1.7.0-cuda_10.1-py_3.7-ubuntu_18.04-x86_64-20220625205423-5a13f29",
"tag": "mindspore_1.7.0-cuda_10.1-py_3.7-ubuntu_18.04-x86_64-20220625205423-5a13f29",
"tags": [],
"type": "BUILD_IN",
"workspace_id": "0"
}
],
"pages": 1,
"size": 200,
"total": 39
}</pre>
<p id="EN-US_TOPIC_0000002374896525__p2813934122719">Select the image required for creating a notebook instance based on the <span class="parmname" id="EN-US_TOPIC_0000002374896525__parmname6813534192711"><b>description</b></span> and <strong id="EN-US_TOPIC_0000002374896525__b1827181834017">name</strong> parameters and record its ID. This section provides an example of using TensorFlow to create a notebook instance with an <span class="parmname" id="EN-US_TOPIC_0000002374896525__parmname1881343432715"><b>id</b></span> of <strong id="EN-US_TOPIC_0000002374896525__b722715483297">e1a07296-22a8-4f05-8bc8-e936c8e54100</strong>.</p>
</li></ol>
</li><li id="EN-US_TOPIC_0000002374896525__li7496164513018"><p id="EN-US_TOPIC_0000002374896525__p10765102718306"><a name="EN-US_TOPIC_0000002374896525__li7496164513018"></a><a name="li7496164513018"></a>Call the API for <a href="CreateNotebook.html">creating a notebook instance</a> to create an instance.</p>
<ol type="a" id="EN-US_TOPIC_0000002374896525__ol1326418534556"><li id="EN-US_TOPIC_0000002374896525__li13264753205515">Request body:<p id="EN-US_TOPIC_0000002374896525__p1264810611321"><a name="EN-US_TOPIC_0000002374896525__li13264753205515"></a><a name="li13264753205515"></a>URI: POST https://<em id="EN-US_TOPIC_0000002374896525__i1464816113215">{ma_endpoint}</em>/v1/<em id="EN-US_TOPIC_0000002374896525__i6648460326">{project_id}</em>/notebooks</p>
<div class="p" id="EN-US_TOPIC_0000002374896525__p18648363321">Request header:<ul id="EN-US_TOPIC_0000002374896525__ul364816643216"><li id="EN-US_TOPIC_0000002374896525__li15648661327">X-auth-Token →<strong id="EN-US_TOPIC_0000002374896525__b10648116123216"><em id="EN-US_TOPIC_0000002374896525__i176483663217">MIIZmgYJKoZIhvcNAQcCoIIZizCCGYcCAQExDTALBglghkgBZQMEAgEwgXXXXXX...</em></strong></li><li id="EN-US_TOPIC_0000002374896525__li16648156113213">Content-Type →application/json</li></ul>
</div>
<p id="EN-US_TOPIC_0000002374896525__p1445941219355">Request body:</p>
<pre class="screen" id="EN-US_TOPIC_0000002374896525__screen1353083118913">{
"name" : "notebooks_test",
"feature" : "NOTEBOOK",
"workspace_id" : "0",
"description" : "api-test",
<strong id="EN-US_TOPIC_0000002374896525__b1635843453810">"</strong><strong id="EN-US_TOPIC_0000002374896525__b1175419914383">flavor</strong><strong id="EN-US_TOPIC_0000002374896525__b1635853415384">"</strong> : "modelarts.vm.cpu.2u",
<strong id="EN-US_TOPIC_0000002374896525__b3924183818382">"</strong><strong id="EN-US_TOPIC_0000002374896525__b2071017143812">image_id</strong><strong id="EN-US_TOPIC_0000002374896525__b1492453823819">"</strong> : "e1a07296-22a8-4f05-8bc8-e936c8e54090",
"volume" : {
"category" : "efs",
"ownership" : "managed",
"capacity" : 50
}
}</pre>
<div class="p" id="EN-US_TOPIC_0000002374896525__p2765114033711">Set the following parameters based on site requirements:<ul id="EN-US_TOPIC_0000002374896525__ul264810633212"><li id="EN-US_TOPIC_0000002374896525__li164886123214"><em id="EN-US_TOPIC_0000002374896525__i680165694410">ma_endpoint</em>: ModelArts endpoint</li><li id="EN-US_TOPIC_0000002374896525__li1464819653218"><em id="EN-US_TOPIC_0000002374896525__i17491059184415">project_id</em>: user's project ID</li><li id="EN-US_TOPIC_0000002374896525__li166481461320"><strong id="EN-US_TOPIC_0000002374896525__b5874344834">X-auth-Token</strong>: token obtained in the previous step</li><li id="EN-US_TOPIC_0000002374896525__li18222144853715"><strong id="EN-US_TOPIC_0000002374896525__b203451828133911">flavor</strong>: flavor of the notebook instance</li><li id="EN-US_TOPIC_0000002374896525__li12408173813912"><strong id="EN-US_TOPIC_0000002374896525__b7196104673917">image_id</strong>: image ID of the notebook instance</li></ul>
</div>
</li><li id="EN-US_TOPIC_0000002374896525__li102641533552">Status code <strong id="EN-US_TOPIC_0000002374896525__b4649173219461">200</strong> is returned. The response body is as follows:<pre class="screen" id="EN-US_TOPIC_0000002374896525__screen104261037122810">{
"action_progress": [
{
"step": 4,
"status": "WAITING",
"description": "Initialize the notebook instance."
},
{
"step": 3,
"status": "WAITING",
"description": "Configuring the network."
},
{
"step": 2,
"status": "WAITING",
"description": "Prepare the compute resource."
},
{
"step": 1,
"status": "WAITING",
"description": "Prepare the storage."
}
],
"create_at": 1687656452472,
"description": "api-test",
"endpoints": [],
"feature": "NOTEBOOK",
"flavor": "modelarts.vm.cpu.2u",
"id": "936bea3e-d3df-435e-8b58-d817283284ae",
"image": {
"description": "",
"id": "e1a07296-22a8-4f05-8bc8-e936c8e54090",
"name": "notebook2.0-mul-kernel-cpu-cp36",
"swr_path": "swr.com/atelier/notebook2.0-mul-kernel-cpu-cp36:5.0.1-release-v2-20220505",
"tag": "5.0.1-release-v2-20220505",
"type": "BUILD_IN"
},
"lease": {
"create_at": 1687656452470,
"duration": 3600000,
"enable": true,
"type": "TIMING",
"update_at": 1687656452470
},
"name": "notebooks_test",
"status": "RUNNING",
"tags": [],
"token": "3452e0d5-15fe-a20d-18a2-010a574aeaaf",
"update_at": 1687656452588,
"user_id": "99250e439b33431081xxxxxxxxxxa885",
"workspace_id": "0",
"billing_items": []
}</pre>
<p id="EN-US_TOPIC_0000002374896525__p13424183016319">You can view the notebook instance details in the response. If <span class="parmname" id="EN-US_TOPIC_0000002374896525__parmname12253122319311"><b>status</b></span> is <span class="parmvalue" id="EN-US_TOPIC_0000002374896525__parmvalue1625315231339"><b>RUNNING</b></span>, the notebook instance is successfully created.</p>
</li></ol>
</li><li id="EN-US_TOPIC_0000002374896525__li572435193112">Call the API for <a href="ShowNotebook.html">querying details of a notebook instance</a> to query the instance creation details based on the instance ID.<ol type="a" id="EN-US_TOPIC_0000002374896525__ol6588124133113"><li id="EN-US_TOPIC_0000002374896525__li181691235193111">Request body:<p id="EN-US_TOPIC_0000002374896525__p1117013513313"><a name="EN-US_TOPIC_0000002374896525__li181691235193111"></a><a name="li181691235193111"></a>URI: GET https://<em id="EN-US_TOPIC_0000002374896525__i16995210103315">{ma_endpoint}</em>/v1/<em id="EN-US_TOPIC_0000002374896525__i171042027153314">{project_id}</em>/notebooks/<em id="EN-US_TOPIC_0000002374896525__i1384616329339">{id}</em></p>
<p id="EN-US_TOPIC_0000002374896525__p217033583118">Request header: X-auth-Token →<strong id="EN-US_TOPIC_0000002374896525__b717073517319"><em id="EN-US_TOPIC_0000002374896525__i9170635153116">MIIZmgYJKoZIhvcNAQcCoIIZizCCGYcCAQExDTALBglghkgBZQMEAgEwgXXXXXX...</em></strong></p>
<p id="EN-US_TOPIC_0000002374896525__p1317043563110">Set the bold parameters based on site requirements.</p>
</li><li id="EN-US_TOPIC_0000002374896525__li1454674812319">Status code <strong id="EN-US_TOPIC_0000002374896525__b949695516485">200</strong> is returned. The response body is as follows:<pre class="screen" id="EN-US_TOPIC_0000002374896525__screen2779559163115">{
"create_at": 1687656452472,
"data_volumes": [],
"description": "api-test",
"endpoints": [
{
"service": "NOTEBOOK",
"uri": "https://authoring-modelarts.com/936bea3e-d3df-435e-8b58-d817283284ae/lab"
}
],
"feature": "NOTEBOOK",
"flavor": "modelarts.vm.cpu.2u",
"id": "936bea3e-d3df-435e-8b58-d817283284ae",
"image": {
"description": "",
"id": "e1a07296-22a8-4f05-8bc8-e936c8e54090",
"name": "notebook2.0-mul-kernel-cpu-cp36",
"swr_path": "swr.com/atelier/notebook2.0-mul-kernel-cpu-cp36:5.0.1-release-v2-20220505",
"tag": "5.0.1-release-v2-20220505",
"type": "BUILD_IN"
},
"lease": {
"create_at": 1687656452470,
"duration": 3627372,
"enable": true,
"type": "TIMING",
"update_at": 1687656479842
},
"name": "notebooks_test",
"status": "RUNNING",
"tags": [],
"token": "3452e0d5-15fe-a20d-18a2-010a574aeaaf",
"update_at": 1687656479880,
"url": "https://authoring-modelarts.com/936bea3e-d3df-435e-8b58-d817283284ae/lab",
"user": {
"domain": {
"id": "878991804cdc4ba597xxxxxxxxxx9dd9",
"name": "hwstaff_pub_CBUInfo_EI"
},
"id": "99250e439b33431081xxxxxxxxxxa885",
"name": "xwx1128222"
},
"user_id": "99250e439b33431081xxxxxxxxxxa885",
"volume": {
"category": "EFS",
"ownership": "MANAGED",
"mount_path": "/home/ma-user/work/",
"capacity": 50,
"read_only": false
},
"workspace_id": "0",
"billing_items": [
"COMPUTE"
]
}</pre>
</li></ol>
</li><li id="EN-US_TOPIC_0000002374896525__li347613392407">Call the API for <a href="RenewLease.html">prolonging a notebook instance</a> to reset the usage duration of the instance.<ol type="a" id="EN-US_TOPIC_0000002374896525__ol1251313427236"><li id="EN-US_TOPIC_0000002374896525__li176341172311">Request body:<p id="EN-US_TOPIC_0000002374896525__p12845857181820"><a name="EN-US_TOPIC_0000002374896525__li176341172311"></a><a name="li176341172311"></a>URI: PATCH https://<em id="EN-US_TOPIC_0000002374896525__i7734623163814">{ma_endpoint}</em>/v1/<em id="EN-US_TOPIC_0000002374896525__i1867016327388">{project_id}</em>notebooks/<em id="EN-US_TOPIC_0000002374896525__i1469774818388">{id}</em>/lease</p>
<p id="EN-US_TOPIC_0000002374896525__p17478511786">Request header:</p>
<ul id="EN-US_TOPIC_0000002374896525__ul653125910449"><li id="EN-US_TOPIC_0000002374896525__li0537592444">X-auth-Token →<strong id="EN-US_TOPIC_0000002374896525__b95395964416"><em id="EN-US_TOPIC_0000002374896525__i145314596441">MIIZmgYJKoZIhvcNAQcCoIIZizCCGYcCAQExDTALBglghkgBZQMEAgEwgXXXXXX...</em></strong></li><li id="EN-US_TOPIC_0000002374896525__li1753185910449">Content-Type →application/json</li></ul>
<p id="EN-US_TOPIC_0000002374896525__p1041563014510">Request body:</p>
<pre class="screen" id="EN-US_TOPIC_0000002374896525__screen5312142164215">{
"duration": <em id="EN-US_TOPIC_0000002374896525__i3737173334210"><strong id="EN-US_TOPIC_0000002374896525__b109345301423">3600000</strong></em>,
"type": "<em id="EN-US_TOPIC_0000002374896525__i188104018422"><strong id="EN-US_TOPIC_0000002374896525__b12441163924213">timing</strong></em>"
}</pre>
<p id="EN-US_TOPIC_0000002374896525__p12900172531915">Set the following parameters based on site requirements:</p>
<ul id="EN-US_TOPIC_0000002374896525__ul851418294511"><li id="EN-US_TOPIC_0000002374896525__li1251442965110"><span class="parmname" id="EN-US_TOPIC_0000002374896525__parmname56962024135118"><b>duration</b></span>: 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.</li><li id="EN-US_TOPIC_0000002374896525__li469652410510"><span class="parmname" id="EN-US_TOPIC_0000002374896525__parmname96964244514"><b>type</b></span>: auto stop type. The default value is <strong id="EN-US_TOPIC_0000002374896525__b130973716522">timing</strong>.</li></ul>
</li><li id="EN-US_TOPIC_0000002374896525__li887484452311">Status code <strong id="EN-US_TOPIC_0000002374896525__b6748136185312">200</strong> is returned, indicating that labeling is successful. The response body is as follows:<pre class="screen" id="EN-US_TOPIC_0000002374896525__screen1329995572519">{
"create_at": 1687656452470,
"duration": 4657544,
"enable": true,
"type": "TIMING",
"update_at": 1687657510014
}</pre>
</li></ol>
</li><li id="EN-US_TOPIC_0000002374896525__li14341105131118">Call the API for <a href="StopNotebook.html">stopping a notebook instance</a> to stop the instance that is running.<ol type="a" id="EN-US_TOPIC_0000002374896525__ol4646185101219"><li id="EN-US_TOPIC_0000002374896525__li11287122131212">Request body.<p id="EN-US_TOPIC_0000002374896525__p1928752181219"><a name="EN-US_TOPIC_0000002374896525__li11287122131212"></a><a name="li11287122131212"></a>URI: POSThttps://<em id="EN-US_TOPIC_0000002374896525__i33901122161219">{ma_endpoint}</em>//v1/<em id="EN-US_TOPIC_0000002374896525__i1791512316128">{project_id}</em>/notebooks/<em id="EN-US_TOPIC_0000002374896525__i1313910382120">{id}</em>/stop</p>
<p id="EN-US_TOPIC_0000002374896525__p1828812214127">Request header: X-auth-Token →<strong id="EN-US_TOPIC_0000002374896525__b1549293818554"><em id="EN-US_TOPIC_0000002374896525__i449223865512">MIIZmgYJKoZIhvcNAQcCoIIZizCCGYcCAQExDTALBglghkgBZQMEAgEwgXXXXXX...</em></strong></p>
<p id="EN-US_TOPIC_0000002374896525__p3288102121215">Set the bold parameters based on site requirements.</p>
</li><li id="EN-US_TOPIC_0000002374896525__li545718569129">Status code <strong id="EN-US_TOPIC_0000002374896525__b28196458552">200</strong> is returned. The response body is as follows:<pre class="screen" id="EN-US_TOPIC_0000002374896525__screen169911265133">{
"create_at": 1687656452472,
"data_volumes": [],
"description": "api-test",
"endpoints": [
{
"service": "NOTEBOOK",
"uri": "https://authoring-modelarts.com/936bea3e-d3df-435e-8b58-d817283284ae/lab"
}
],
"feature": "NOTEBOOK",
"flavor": "modelarts.vm.cpu.2u",
"id": "936bea3e-d3df-435e-8b58-d817283284ae",
"image": {
"description": "",
"id": "e1a07296-22a8-4f05-8bc8-e936c8e54090",
"name": "notebook2.0-mul-kernel-cpu-cp36",
"swr_path": "swr.com/atelier/notebook2.0-mul-kernel-cpu-cp36:5.0.1-release-v2-20220505",
"tag": "5.0.1-release-v2-20220505",
"type": "BUILD_IN"
},
"lease": {
"create_at": 1687656452470,
"duration": 6199814,
"enable": true,
"type": "TIMING",
"update_at": 1687659052284
},
"name": "notebooks_test",
"status": "STOPPING",
"tags": [],
"token": "3452e0d5-15fe-a20d-18a2-010a574aeaaf",
"update_at": 1687656479880,
"url": "https://authoring-modelarts.com/936bea3e-d3df-435e-8b58-d817283284ae/lab",
"user": {
"domain": {
"id": "878991804cdc4ba597xxxxxxxxxx9dd9",
"name": "hwstaff_test"
},
"id": "99250e439b33431081xxxxxxxxxxa885",
"name": "test"
},
"user_id": "99250e439b33431081xxxxxxxxxxa885",
"volume": {
"category": "EFS",
"ownership": "MANAGED",
"mount_path": "/home/ma-user/work/",
"capacity": 50,
"read_only": false
},
"workspace_id": "0",
"billing_items": []
}</pre>
</li></ol>
</li><li id="EN-US_TOPIC_0000002374896525__li18177535141414">Call the API for <a href="StartNotebook.html">starting a notebook instance</a> to restart the instance.<ol type="a" id="EN-US_TOPIC_0000002374896525__ol421745141511"><li id="EN-US_TOPIC_0000002374896525__li1929555918144">Request body.<p id="EN-US_TOPIC_0000002374896525__p1063133168"><a name="EN-US_TOPIC_0000002374896525__li1929555918144"></a><a name="li1929555918144"></a>URI: GET https://<em id="EN-US_TOPIC_0000002374896525__i198104561513">{ma_endpoint}</em>/v1/<em id="EN-US_TOPIC_0000002374896525__i1894035191514">{project_id}</em>/notebooks/<em id="EN-US_TOPIC_0000002374896525__i87655811510">{id}</em>/start</p>
<p id="EN-US_TOPIC_0000002374896525__p9295125941410">Request header: X-auth-Token →<strong id="EN-US_TOPIC_0000002374896525__b0204192516561"><em id="EN-US_TOPIC_0000002374896525__i1920412258562">MIIZmgYJKoZIhvcNAQcCoIIZizCCGYcCAQExDTALBglghkgBZQMEAgEwgXXXXXX...</em></strong></p>
<p id="EN-US_TOPIC_0000002374896525__p102961959111419">Set the bold parameters based on site requirements.</p>
</li><li id="EN-US_TOPIC_0000002374896525__li1475121631620">Status code <strong id="EN-US_TOPIC_0000002374896525__b114696301560">200</strong> is returned. The response body is as follows:<pre class="screen" id="EN-US_TOPIC_0000002374896525__screen117331619131616">{
"create_at": 1687656452472,
"data_volumes": [],
"description": "api-test",
"endpoints": [
{
"service": "NOTEBOOK",
"uri": "https://authoring-modelarts.com/936bea3e-d3df-435e-8b58-d817283284ae/lab"
}
],
"feature": "NOTEBOOK",
"flavor": "modelarts.vm.cpu.2u",
"id": "936bea3e-d3df-435e-8b58-d817283284ae",
"image": {
"description": "",
"id": "e1a07296-22a8-4f05-8bc8-e936c8e54090",
"name": "notebook2.0-mul-kernel-cpu-cp36",
"swr_path": "swr.com/atelier/notebook2.0-mul-kernel-cpu-cp36:5.0.1-release-v2-20220505",
"tag": "5.0.1-release-v2-20220505",
"type": "BUILD_IN"
},
"lease": {
"create_at": 1687656452470,
"duration": 6540099,
"enable": true,
"type": "TIMING",
"update_at": 1687659392569
},
"name": "notebooks_test",
"status": "STARTING",
"tags": [],
"token": "6f773860-21d4-9fe8-75c8-a38ea13ebf08",
"update_at": 1687659203630,
"url": "https://authoring-modelarts.com/936bea3e-d3df-435e-8b58-d817283284ae/lab",
"user": {
"domain": {
"id": "878991804cdc4ba597xxxxxxxxxx9dd9",
"name": "hwstaff_test"
},
"id": "99250e439b33431081xxxxxxxxxxa885",
"name": "test"
},
"user_id": "99250e439b33431081xxxxxxxxxxa885",
"volume": {
"category": "EFS",
"ownership": "MANAGED",
"mount_path": "/home/ma-user/work/",
"capacity": 50,
"read_only": false
},
"workspace_id": "0",
"billing_items": []
}</pre>
</li></ol>
</li><li id="EN-US_TOPIC_0000002374896525__li847603954016">Call the API for <a href="DeleteNotebook.html">deleting a notebook instance</a> to delete the instance that is no longer needed.<ol type="a" id="EN-US_TOPIC_0000002374896525__ol811119572528"><li id="EN-US_TOPIC_0000002374896525__li1911118573520">Request body:<p id="EN-US_TOPIC_0000002374896525__p285220161813"><a name="EN-US_TOPIC_0000002374896525__li1911118573520"></a><a name="li1911118573520"></a>URI: DELETE https://<em id="EN-US_TOPIC_0000002374896525__i66171521151919">{ma_endpoint}</em>/v1/<em id="EN-US_TOPIC_0000002374896525__i7285142771910">{project_id}</em>/notebooks/<em id="EN-US_TOPIC_0000002374896525__i1111651051917">{id}</em></p>
<p id="EN-US_TOPIC_0000002374896525__p1585313014189">Request header:</p>
<ul id="EN-US_TOPIC_0000002374896525__ul1841612321520"><li id="EN-US_TOPIC_0000002374896525__li1441615231151">X-auth-Token →<strong id="EN-US_TOPIC_0000002374896525__b5416223181510"><em id="EN-US_TOPIC_0000002374896525__i741632371518">MIIZmgYJKoZIhvcNAQcCoIIZizCCGYcCAQExDTALBglghkgBZQMEAgEwgXXXXXX...</em></strong></li><li id="EN-US_TOPIC_0000002374896525__li4416152381515">Content-Type →application/json</li></ul>
<p id="EN-US_TOPIC_0000002374896525__p12853809181">Set the bold parameters based on site requirements.</p>
</li><li id="EN-US_TOPIC_0000002374896525__li211155705213">Status code <span class="parmvalue" id="EN-US_TOPIC_0000002374896525__parmvalue18111175717520"><b>200</b></span> is returned, indicating that the instance is successfully deleted.</li></ol>
</li></ol>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="modelarts_03_0400.html">Use Cases</a></div>
</div>
</div>
View Git Blame Copy Permalink