文档首页 > > API参考> 开发环境> 创建开发环境实例

创建开发环境实例

分享
更新时间: 2020/07/10 GMT+08:00

功能介绍

创建开发环境实例,用于代码开发。

该接口为异步操作,创建开发环境实例的状态请通过查询开发环境实例详情接口获取。

URI

POST /v1/{project_id}/demanager/instances

参数说明如 表1所示。
表1 参数说明

参数

是否必选

参数类型

说明

project_id

String

用户项目ID。获取方法请参见获取项目ID

请求消息

请求参数如 表2所示。
表2 请求参数

参数

是否必选

参数类型

说明

name

String

实例名称,长度限制为64个字符,

支持大小写字母、数字、中划线和下划线。

profile_id

String

配置ID,当前支持:

  • Python2
  • Python2-gpu
  • Python3
  • Python3-gpu

description

String

实例说明,长度限制为512字符,不可包含特殊字符&<>"'/,缺省值为空。

flavor

String

实例的机器规格。现在支持的有:

  • modelarts.vm.cpu.2u
  • modelarts.vm.cpu.8u
  • modelarts.vm.gpu.p100
  • modelarts.vm.gpu.2p100
  • modelarts.vm.gpu.4p100

其中modelarts.vm.gpu.2p100和modelarts.vm.gpu.4p100需要用户自己申请权限。

spec

Object

实例定义,当前仅支持Notebook,如表3所示。

workspace

Object

工作空间,默认id为0的工作空间,如表7所示。

表3 notebook定义数据结构说明

参数

是否必选

参数类型

说明

storage

Object

存储路径,如表4所示

auto_stop

Object

自动停止参数,如表6 auto_stop定义数据结构说明所示。

annotations

Object

注解信息,可扩展字段,缺省值为“NULL”

表4 storage定义数据结构说明

参数

是否必选

参数类型

说明

type

String

存储类型,当前只支持“OBS”“EVS”

location

Object

存储位置,如果type为OBS类型,该参数必须填写,如表5所示数据结构,如缺省值为“NULL”

表5 location定义数据结构说明

参数

是否必选

参数类型

说明

path

String

存储路径。

  • 如果type为OBS类型,该值必须填写,需为有效的OBS桶路径,且以“/”结束。不能指定为OBS桶的根目录,需指定为OBS桶下的具体目录。
  • 如果type为EVS类型,该值不需要填写。

volume_size

Integer

EVS存储盘大小,最小为5GB,最大为4096GB,缺省值为5GB;如果type为OBS类型,该值不需要填写。

表6 auto_stop定义数据结构说明

参数

是否必选

参数类型

说明

enable

Boolean

是否开启自动停止功能, true表示开启,则会在运行时长到达之后自动停止实例,false表示关闭,默认为false。

duration

Integer

运行时长,单位为秒,取值范围为3600-86400,该参数配置之后,每次启动均有效。如果enable为true时,该参数是必须的。

prompt

Boolean

是否需要再次提醒,该参数提供给前台console,用于让console判断是否需要再次弹出弹出框对用户进行提醒,默认是true。

表7 workspace定义结构说明

参数

是否必选

参数类型

说明

id

String

工作空间id。未创建工作空间时取值默认值为0,存在创建并使用的工作空间,以实际取值为准。

响应消息

响应参数如 表8所示。
表8 响应参数

参数

参数类型

说明

id

String

实例ID。

name

String

实例名称。

description

String

实例说明。

status

String

实例状态。

creation_timestamp

String

实例的创建时间。

profile

Object

配置信息,如表9所示。

flavor

String

机器规格。

spec

Object

实例定义。Notebook类型实例,数据结构如表13 notebook字段数据结构说明所示。

workspace

Object

工作空间,如表15所示。

表9 profile字段数据结构说明

参数

参数类型

说明

id

String

配置ID。

name

String

配置名称。

description

String

配置说明。

de_type

String

开发环境类型,当前仅支持Notebook。

provision

Object

部署信息,如表10所示。

表10 provision字段数据结构说明

参数

参数类型

说明

type

String

部署类型,当前仅支持Docker。

spec

Object

部署详情,如表11所示。

annotations

Object

注解信息,可扩展字段,缺省值为NULL。

表11 spec字段数据结构说明

参数

参数类型

说明

engine

String

部署引擎,当前仅支持CCE。

params

Object

部署参数,当前仅支持Docker,如表12所示。

表12 Docker部署参数数据结构说明

参数

参数类型

说明

namespace

String

SWR组织名称,全局唯一。

image_name

String

镜像名称。

image_tag

String

镜像标签。

annotations

Object

注解信息,可扩展字段,缺省值为“NULL”

表13 notebook字段数据结构说明

参数

参数类型

说明

storage

Object

存储路径。

auto_stop

Object

自动停止参数,如表14 auto_stop字段数据结构说明所示。

annotations

Object

注解信息。

其中,生成的url信息,不可直接访问使用。

表14 auto_stop字段数据结构说明

参数

参数类型

说明

enable

Boolean

是否开启自动停止功能。

duration

Integer

运行时长,单位为秒。

prompt

Boolean

是否需要再次弹框提醒,提供给console使用。

stop_timestamp

Integer

实例停止时间点, 13位时间戳。

remain_time

Integer

实际停止剩余时间,单位为秒。

表15 workspace字段数据结构说明

参数

参数类型

说明

id

String

工作空间ID。

示例

如下以创建名为“notebook-instance”,配置ID为“Python2”的实例为例。

  • 请求示例
    {
        "name": "notebook-instance",
        "profile_id": "Python2",
        "description": "create a notebook instance",
        "flavor": "modelarts.vm.cpu.2u",
        "spec": {
            "storage": {
                "type": "obs",
                "location": {
                    "path": "obs-bucket/test/"
                }
            },
            "auto_stop": {
                "enable": true,
    	    "duration": 3600
            }
        },
        "workspace": {
            "id": "0"
        }
    }
  • 成功响应示例
    {
        "id": "6fa459ea-ee8a-3ca4-894e-db77e160355e",
        "name": "notebook-instance",
        "description": "create a notebook instance",
        "status": "STARTING",
        "creation_timestamp": "1539575583517",
        "profile": {
            "de_type": "Notebook",
            "description": "machine learning python2.7 notebook",
            "id": "ML-1.0.0-python2.7",
            "name": "ML-1.0.0-python2.7",
            "provision": {
                "spec": {
                    "engine": "CCE",
                    "params": {
                        "image_name": "mls_singleuser_python",
                        "image_tag": "4",
                        "namespace": "atelier"
                    }
                },
                "type": "Docker"
            }
        },
        "flavor": "modelarts.vm.cpu.2u",
        "spec": {
            "storage": {
                "location": {
                    "path": "obs-bucket/test/"
                },
                "type": "obs"
            },
            "annotations": {
                "url": ""
            },
            "auto_stop": {
                 "duration": 3600,
                 "enable": true,
                 "prompt": true
            }
        },
        "workspace": {
            "id": "0"
        }
    }
  • 失败响应示例
    {
        "error_msg": "The param path needs to end with /.",
        "error_code": "ModelArts.6318"
    }

状态码

状态码请参见状态码

分享:

    相关文档

    相关产品

文档是否有解决您的问题?

提交成功!

非常感谢您的反馈,我们会继续努力做到更好!

反馈提交失败,请稍后再试!

*必选

请至少选择或填写一项反馈信息

字符长度不能超过200

提交反馈 取消

如您有其它疑问,您也可以通过华为云社区问答频道来与我们联系探讨

智能客服提问云社区提问