文档首页 > > API参考> 开发环境> 更新开发环境实例信息

更新开发环境实例信息

分享
更新时间: 2020/01/20 GMT+08:00

功能介绍

该接口用于更新开发环境实例的描述信息或自动停止信息。

URI

PUT /v1/{project_id}/demanager/instances/{instance_id}

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

参数

是否必选

参数类型

说明

project_id

String

用户项目ID。

instance_id

String

实例ID。

请求消息

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

参数

是否必选

参数类型

说明

description

String

配置描述,长度限制为512字符,不可包含特殊字符&<>"'/。

spec

Object

实例定义,如表3 spec定义数据结构说明所示。

表3 spec定义数据结构说明

参数

是否必选

参数类型

说明

auto_stop

Object

自动停止参数,如表4所示。

表4 auto_stop定义数据结构说明

参数

是否必选

参数类型

说明

enable

Boolean

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

duration

Integer

运行时长,单位为秒,取值范围为3600-86400,该参数配置之后,每次启动均有效。如果enable为true时,该参数是必须的。如果当前实例的状态为运行中,修改此参数,只有在下次启动才会生效。

prompt

Boolean

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

响应消息

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

参数

参数类型

说明

id

String

实例ID。

name

String

实例名称。

description

String

实例描述。

status

String

实例状态。

creation_timestamp

String

实例的创建时间。

profile

Object

配置信息,如表6所示。

flavor

String

机器规格。

spec

Object

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

workspace

Object

工作空间,如表12 workspace字段数据结构说明所示。

表6 profile字段数据结构说明

参数

参数类型

说明

id

String

配置ID。

name

String

配置名称。

description

String

配置描述。

de_type

String

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

provision

Object

部署信息,如表7所示。

labels

Object

标签信息,可扩展字段。

表7 provision字段数据结构说明

参数

参数类型

说明

type

String

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

spec

Object

部署详情,如表8所示。

annotations

Object

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

表8 spec字段数据结构说明

参数

参数类型

说明

engine

String

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

params

Object

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

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

参数

参数类型

说明

namespace

String

SWR组织名称,全局唯一。

image_name

String

镜像名称。

image_tag

String

镜像标签。

annotations

Object

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

表10 notebook字段数据结构说明

参数

参数类型

说明

storage

Object

存储路径。

auto_stop

Object

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

annotations

Object

注解信息。

表11 auto_stop字段数据结构说明

参数

参数类型

说明

enable

Boolean

是否开启自动停止功能。

duration

Integer

运行时长,单位为秒。

prompt

Boolean

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

stop_timestamp

Integer

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

remain_time

Integer

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

表12 workspace字段数据结构说明

参数

参数类型

描述

id

String

工作空间ID。

示例

如下以更新实例ID为“6fa459ea-ee8a-3ca4-894e-db77e160355e”的实例信息为例。

  • 请求示例
    {
      "description": "machine learning python2.7 notebook"
    }
  • 成功响应示例
    {
        "id": "6fa459ea-ee8a-3ca4-894e-db77e160355e",
        "name": "notebook-instance",
        "description": "machine learning python2.7 notebook",
        "status": "RUNNING",
        "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": "https://127.0.0.1:8080/modelarts/internal/hub/notebook/user/6fa459ea-ee8a-3ca4-894e-db77e160355e"
            },
            "auto_stop": {
                "enable": false,
                "prompt": true
            }
        }
    }
  • 失败响应示例
    {
        "error_msg": "The instance does not exist.",
        "error_code": "ModelArts.6309"
    }

状态码

状态码请参见状态码

分享:

    相关文档

    相关产品

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

提交成功!

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

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

*必选

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

字符长度不能超过200

提交反馈 取消

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

跳转到云社区