AI开发平台ModelArtsAI开发平台ModelArts

计算
弹性云服务器 ECS
裸金属服务器 BMS
云手机 CPH
专属主机 DeH
弹性伸缩 AS
镜像服务 IMS
函数工作流 FunctionGraph
云耀云服务器 HECS
VR云渲游平台 CVR
特惠算力专区
存储
对象存储服务 OBS
云硬盘 EVS
云备份 CBR
弹性文件服务 SFS
存储容灾服务 SDRS
云硬盘备份 VBS
云服务器备份 CSBS
数据快递服务 DES
专属企业存储服务
云存储网关 CSG
专属分布式存储服务 DSS
CDN与智能边缘
内容分发网络 CDN
智能边缘云 IEC
智能边缘小站 IES
智能边缘平台 IEF
人工智能
AI开发平台ModelArts
华为HiLens
图引擎服务 GES
图像识别 Image
文字识别 OCR
自然语言处理 NLP
内容审核 Moderation
图像搜索 ImageSearch
医疗智能体 EIHealth
园区智能体 CampusGo
企业级AI应用开发专业套件 ModelArts Pro
人脸识别服务 FRS
对话机器人服务 CBS
视频分析服务 VAS
语音交互服务 SIS
知识图谱 KG
人证核身服务 IVS
IoT物联网
设备接入 IoTDA
设备管理 IoTDM(联通用户专用)
全球SIM联接 GSL
IoT开发者服务
IoT数据分析
车联网服务 IoV
路网数字化服务 DRIS
IoT边缘 IoTEdge
设备发放 IoTDP
开发与运维
软件开发平台 DevCloud
项目管理 ProjectMan
代码托管 CodeHub
流水线 CloudPipeline
代码检查 CodeCheck
编译构建 CloudBuild
部署 CloudDeploy
云测 CloudTest
发布 CloudRelease
移动应用测试 MobileAPPTest
CloudIDE
Classroom
开源镜像站 Mirrors
应用魔方 AppCube
云性能测试服务 CPTS
应用管理与运维平台 ServiceStage
云应用引擎 CAE
视频
实时音视频 SparkRTC
视频直播 Live
视频点播 VOD
媒体处理 MPC
视频接入服务 VIS
管理与监管
统一身份认证服务 IAM
消息通知服务 SMN
云监控服务 CES
应用运维管理 AOM
应用性能管理 APM
云日志服务 LTS
云审计服务 CTS
标签管理服务 TMS
资源管理服务 RMS
应用身份管理服务 OneAccess
区块链
区块链服务 BCS
可信跨链服务 TCS
智能协作
IdeaHub
开发者工具
SDK开发指南
API签名指南
DevStar
HCloud CLI
Terraform
Ansible
API问题定位指导
云生态
云市场
合作伙伴中心
华为云培训中心
其他
管理控制台
消息中心
产品价格详情
系统权限
我的凭证
客户关联华为云合作伙伴须知
公共问题
宽限期保留期
奖励推广计划
活动
容器
云容器引擎 CCE
云容器实例 CCI
容器镜像服务 SWR
应用编排服务 AOS
多云容器平台 MCP
基因容器 GCS
容器洞察引擎 CIE
云原生服务中心 OSC
容器批量计算 BCE
容器交付流水线 ContainerOps
应用服务网格 ASM
网络
虚拟私有云 VPC
弹性公网IP EIP
弹性负载均衡 ELB
NAT网关 NAT
云专线 DC
虚拟专用网络 VPN
云连接 CC
VPC终端节点 VPCEP
数据库
云数据库 RDS
数据复制服务 DRS
文档数据库服务 DDS
分布式数据库中间件 DDM
云数据库 GaussDB (for openGauss)
云数据库 GaussDB(for MySQL)
云数据库 GaussDB NoSQL
数据管理服务 DAS
数据库和应用迁移 UGO
大数据
MapReduce服务 MRS
数据湖探索 DLI
表格存储服务 CloudTable
可信智能计算服务 TICS
推荐系统 RES
云搜索服务 CSS
数据可视化 DLV
数据湖治理中心 DGC
数据接入服务 DIS
数据仓库服务 GaussDB(DWS)
应用中间件
微服务引擎 CSE
分布式消息服务Kafka版
分布式消息服务RabbitMQ版
API网关 APIG
分布式缓存服务 DCS
分布式消息服务RocketMQ版
企业应用
域名注册服务 Domains
云解析服务 DNS
云速建站 CloudSite
网站备案
华为云WeLink
会议
隐私保护通话 PrivateNumber
语音通话 VoiceCall
消息&短信 MSGSMS
云管理网络
SD-WAN 云服务
边缘数据中心管理 EDCM
云桌面 Workspace
应用与数据集成平台 ROMA Connect
ROMA资产中心 ROMAExchange
API全生命周期管理 ROMA API
安全与合规
安全技术与应用
DDoS防护 ADS
Web应用防火墙 WAF
云防火墙 CFW
应用信任中心 ATC
企业主机安全 HSS
容器安全服务 CGS
云堡垒机 CBH
数据库安全服务 DBSS
数据加密服务 DEW
数据安全中心 DSC
云证书管理服务 CCM
SSL证书管理 SCM
漏洞扫描服务 VSS
态势感知 SA
威胁检测服务 MTD
管理检测与响应 MDR
安全治理云图 Compass
迁移
主机迁移服务 SMS
对象存储迁移服务 OMS
云数据迁移 CDM
专属云
专属计算集群 DCC
解决方案
高性能计算 HPC
SAP
游戏云
混合云灾备
华为工业云平台 IMC
价格
成本优化最佳实践
专属云商业逻辑
用户服务
帐号中心
费用中心
成本中心
资源中心
企业管理
工单管理
客户运营能力
国际站常见问题
支持计划
专业服务
合作伙伴支持计划
更新时间:2021-11-26 GMT+08:00
分享

更新开发环境实例信息

功能介绍

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

URI

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

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

参数

是否必选

参数类型

说明

project_id

String

用户项目ID。获取方法请参见获取项目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

实例的创建时间。

latest_update_timestamp

String

实例的更新时间。

profile

Object

配置信息,如表12所示。

flavor

String

机器规格。

flavor_details

Object

机器规格详情,如表16所示。

pool

Object

专属资源池,如表17所示。

spec

Object

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

workspace

Object

工作空间,如表24所示。

ai_project

Object

AI项目,如表25所示。

error_code

String

错误码。请参考错误码

queuing_info

Object

排队信息,如表26所示。

user

Object

用户信息,如表27所示。

repository

Object

Git仓库信息,如表28所示。该字段不支持使用,在调用接口时会自动返回。

表6 profile字段数据结构说明

参数

参数类型

说明

id

String

配置ID。

name

String

配置名称。

description

String

配置描述。

de_type

String

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

provision

Object

部署信息,如表4所示。

labels

Map<String,String>

标签信息。

flavor_type

String

硬件类型。支持CPU,GPU,Ascend。

表7 provision字段数据结构说明

参数

参数类型

说明

type

String

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

spec

Object

部署详情,如表8所示。

表8 spec字段数据结构说明

参数

参数类型

说明

engine

String

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

params

Object

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

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

参数

参数类型

说明

namespace

String

SWR组织名称,全局唯一。

image_name

String

镜像名称。

image_tag

String

镜像标签。

annotations

Map<String,String>

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

表10 flavor_details参数说明

参数

参数类型

描述

name

String

规格名称。

status

String

规格销售状态。当前支持:

  • onSale
  • soldOut

queuing_num

Integer

“promo_type”“Free”“status”“soldOut”时,该参数必选。

queue_left_time

Integer

排到队的剩余时间,单位为秒。

“promo_type”“Free”“status”“soldOut”时,该参数必选。

storage_list

Array< storageType >

支持的存储类型。默认为全部。

  • obs
  • evs
  • efs

is_permitted

Boolean

当前用户是否有权限使用该规格。

type

String

规格状态。当前支持:

  • GPU
  • CPU
  • ASCEND

params

Dict

描述规格的参数。

promo_type

String

促销类型。包括:

  • Free
  • NoDiscount

instance_num

Integer

当前用户创建地该规格实例的数量。

duration

Integer

启动后设置的自动停止时间,单位为秒。

store_time

Integer

该规格实例处于非活跃状态,在数据库最长保存的时长。单位为小时。

默认为“-1”, 表示可以无限制保存。

billing_flavor

String

计费规格。当该字段为空时,使用规格名称计费。

billing_params

Integer

计费倍率。当billing_flavor不为空时,该字段必选。

表11 pool参数说明

参数

参数类型

描述

id

String

资源池ID。

name

String

资源池名称。

type

String

资源池类型。主要区分类型:USER_DEFINED,表明为专属资源池。

owner

Object

“type”“USER_DEFINED”时是必选项。如表13所示。

表12 AIProject

参数

参数类型

描述

id

String

AI项目ID。

表13 owner参数说明

参数

是否必选

参数类型

描述

project_id

String

项目ID。

表14 notebook字段数据结构说明

参数

参数类型

说明

log_path

String

自定义镜像日志存储路径。

custom_script_path

String

Notebook启动时的自定义初始化脚本路径。

extend_storage

Array<Storage>

扩展存储列表,如表20所示。扩展存储当前仅支持type为“obsfs”的类型,且仅对部分专属资源池开放。

storage

Object

存储路径。表20

credential

Object

访问OBS的AK/SK。表30

repository

Object

Git仓库信息,如表28所示。该字段不支持使用,在调用接口时会自动返回。

resource_reserved_timestamp

Integer

资源预留时间戳。

auto_stop

Object

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

failed_reasons

Object

创建、启动失败原因,如表22所示。

annotations

Map<String,String>

注解信息。

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

extend_params

Map<String,String>

扩展参数。

表15 storage定义数据结构说明

参数

参数类型

说明

type

String

存储类型。当前支持“obs”“obsfs”“evs”,其中,obsfs类型当前仅支持部分专属资源池。若您需要挂载OBS并行文件系统,请提工单。

location

Object

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

表16 location定义数据结构说明

参数

是否必选

参数类型

说明

path

String

存储路径。

  • 如果type为“obs”类型,该值必须填写,该值需为有效的OBS桶路径,且以“/”结束。不能指定为OBS桶的根目录,需指定为OBS桶下的具体目录。
  • 如果type为“obsfs”类型,该值需为有效的OBS并行文件系统的桶名(当前CCE不支持挂载子目录)。
  • 如果type为“evs”类型,该值不需要填写。

volume_size

Integer

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

mount_path

String

Notebook内的挂载路径,仅type为“obsfs”类型,该字段有效。

默认值为“/home/ma-user/work”

若希望挂载到指定路径,建议填写“/home/ma-user/work”的子目录,否则可能因权限等问题导致挂载失败或读写异常。

access_modes

String

挂载文件的访问权限,支持读写和只读两种方式,仅type为“obsfs”类型,该字段有效。可选值:

  • ReadOnlyMany:只读方式
  • ReadWriteMany:读写方式(默认值)
表17 auto_stop字段数据结构说明

参数

参数类型

说明

enable

Boolean

是否开启自动停止功能。

duration

Integer

运行时长,单位为秒。

prompt

Boolean

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

stop_timestamp

Integer

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

remain_time

Integer

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

表18 failed_reasons字段数据结构说明

参数

参数类型

说明

code

String

错误码。

message

String

错误信息。

detail

Map<String,String>

错误详情。

表19 workspace字段数据结构说明

参数

参数类型

描述

id

String

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

表20 queuing_info参数说明

参数

参数类型

描述

id

String

实例ID。

name

String

实例名称。

de_type

String

开发环境类型,缺省时返回全部类型。

当前仅支持Notebook。

flavor

String

实例的机器规格,缺省时返回全部类型。现在支持的有:

  • modelarts.vm.cpu.free
  • modelarts.vm.gpu.free

flavor_details

Object

规格详情,用于展示规格信息,以及查询规格是否售罄。请参见表16

status

String

实例状态,缺省时返回全部类型。包括:

  • CREATE_QUEUING
  • START_QUEUING

begin_timestamp

Integer

实例排队的开始时间,13位时间戳。

remain_time

Integer

排到队的剩余时间,单位为秒。

end_timestamp

Integer

实例排队的预计停止时间,13位时间戳。

rank

Integer

实例在队列中的排位。

表21 user字段数据结构说明

参数

参数类型

说明

id

String

用户ID。

name

String

用户名。

表22 repository字段数据结构说明

参数

参数类型

说明

id

String

仓库ID。

branch

String

仓库分支。

user_name

String

仓库配置用户名。

user_email

String

仓库配置用户邮箱。

type

String

仓库类型。CodeClub,GitHub。

connection_info

Object

仓库链接信息。请参见表29

表23 connection_info字段数据结构说明

参数

参数类型

说明

protocol

String

链接仓库协议。当前支持:ssh,https。

url

String

链接仓库地址。

credential

Object

证书信息,请参见表30

表24 credential字段数据结构说明

参数

参数类型

说明

ssh_private_key

String

ssh私有证书。

access_token

String

GitHub的oauth token。

示例

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

  • 请求示例
    {
      "description": "machine learning python2.7 notebook"
    }
  • 成功响应示例
    {
        "ai_project": {
            "id": "default-ai-project"
        },
        "creation_timestamp": "1594887749962",
        "description": "update notebook",
        "flavor": "modelarts.bm.gpu.v100NV32",
        "flavor_details": {
            "name": "modelarts.bm.gpu.v100NV32",
            "params": {
                "CPU": 8,
                "GPU": 1,
                "gpu_type": "v100NV32",
                "memory": "64GiB"
            },
            "status": "onSale",
            "type": "GPU"
        },
        "id": "DE-7d558ef8-c73d-11ea-964c-0255ac100033",
        "latest_update_timestamp": "1594888143062",
        "name": "notebook-c6fd",
        "profile": {
            "de_type": "Notebook",
            "description": "multi engine, gpu, python 3.6 for notebook",
            "flavor_type": "GPU",
            "id": "Python3-gpu",
            "name": "Python3",
            "provision": {
                "annotations": {
                    "category": "Multi-Engine (Recommend)",
                    "flavor": "modelarts.vm.gpu.p100",
                    "type": "system"
                },
                "spec": {
                    "engine": "CCE",
                    "params": {
                        "annotations": null,
                        "image_name": "mul-kernel-gpu-cuda-cp36",
                        "image_tag": "2.0.5-B003",
                        "namespace": "atelier"
                    }
                },
                "type": "Docker"
            }
        },
        "spec": {
            "annotations": {
                "target_domain": "https://modelarts-notebook-2.cn-north-4.myhuaweicloud.com",
                "url": "https://modelarts-lvs-common-lb.cn-north-4.myhuaweicloud.com:32000/modelarts/cn-north-4/hubv100/notebook/user/DE-7d558ef8-c73d-11ea-964c-0255ac100033"
            },
            "auto_stop": {
                "duration": 3600,
                "enable": true,
                "prompt": true,
                "remain_time": 3266,
                "stop_timestamp": 1594891408723
            },
            "extend_params": null,
            "failed_reasons": null,
            "repository": null,
            "storage": {
                "location": {
                    "path": "/home/ma-user/work",
                    "volume_size": 5,
                    "volume_unit": "GB"
                },
                "type": "evs"
            }
        },
        "status": "RUNNING",
        "user": {
            "id": "15dda26361214ca2a5953917d2f48ffb",
            "name": "ops_dev_env"
        },
        "workspace": {
            "id": "0"
        }
    }
  • 失败响应示例
    {
        "error_message": "The instance does not exist.",
        "error_code": "ModelArts.6309"
    }

状态码

状态码请参见状态码

分享:

    相关文档

    相关产品

关闭导读