文档

CreateInstance - 创建实例

更新时间:

调用CreateInstance创建一个DSW实例。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

当前API暂无授权信息透出。

请求语法

POST /api/v2/instances

请求参数

名称类型必填描述示例值
bodyobject

实例属性。

WorkspaceIdstring

工作空间 ID。如何获取工作空间 ID,请参见 ListWorkspaces

40823
InstanceNamestring

实例名称。格式要求:

  • 只能包含英文字母、数字和下划线(_)。
  • 不能超过 27 个字符。
training_data
EcsSpecstring

实例对应的 ECS 规格。如何获取 ECS 规格,请参见 ListEcsSpecs

ecs.c6.large
ImageIdstring

镜像 ID。如何获取镜像 ID,请参见 ListImages

image-05cefd0be2exxxx
ImageUrlstring

镜像地址。如何获取镜像地址,请参见 ListImages

registry.cn-shanghai.aliyuncs.com/pai_product/tensorflow:py36_cpu_tf1.12_ubuntu
Datasetsarray<object>

数据集集合。

object

数据集。

DatasetIdstring

数据集 ID。如何获取数据集 ID,请参见 ListDatasets ,使用时不能指定 Uri。

d-vsqjvsjp4orp5l206u
MountPathstring

容器内挂载路径。

/mnt/data
Uristring

需要挂载的 OSS 目录的 Uri,使用时不能同时指定 DatasetId。

oss://bucket-name.oss-cn-shanghai-internal.aliyuncs.com/data/path/
Optionsstring

自定义挂载属性,目前仅支持 OSS,使用时不能同时指定 OptionType。

{ "fs.oss.download.thread.concurrency": "10", "fs.oss.upload.thread.concurrency": "10", "fs.jindo.args": "-oattr_timeout=3 -oentry_timeout=0 -onegative_timeout=0 -oauto_cache -ono_symlink" }
OptionTypestring

挂载类型,使用时不能同时指定 Options,目前仅支持 OSS:

  • FastReadWrite:快速读写模式。
  • IncrementalReadWrite:增量读写模式。
  • ConsistentReadWrite:读写一致模式。
  • ReadOnly:只读模式。
FastReadWrite
UserVpcobject

User VPC 配置。

VpcIdstring

VPC ID。

vpc-xxxxx
VSwitchIdstring

交换机 ID。

vsw-xxxxx
SecurityGroupIdstring

安全组 ID。

sg-xxxxxx
ExtendedCIDRsarray

扩展网段。

  • 当交换机 ID 为空时,此参数可以不提供,系统会自动获取 VPC 下的所有网段;
  • 当交换机 ID 不为空时,此参数必须提供,建议填写 VPC 下的所有网段。
string

扩展网段。

"172.16.19.0/24","172.16.2.0/24","172.16.12.0/24"
DefaultRoutestring

默认路由。取值如下:

eth0
ForwardInfosarray

端口透出信息。

ForwardInfo

端口透出信息列表。

Accessibilitystring

工作空间内是否他人可见。取值如下:

  • PRIVATE:表示工作空间内自己及管理员可见。
  • PUBLIC:工作空间所有用户可见。
PRIVATE
EnvironmentVariablesobject

环境变量。

string

用户指定环境变量,DSW 实例启动后,指定环境变量会被注入到容器中。

MAAS
ResourceIdstring

资源组 ID,预付费时配置。如何创建专有资源组,请参见准备及管理 DLC 资源组集群

dsw-123456789
Prioritylong

优先级,在分配资源给实例时,优先级越高的实例越优先。取值范围为 1~9。

  • 1 为最低优先级。
  • 9 为最高优先级。
1
RequestedResourceobject

资源配置,弹内或者轻量化时使用。

CPUstring

CPU 核数。

32
Memorystring

内存大小。单位为 GB。

32GB
SharedMemorystring

共享内存大小。单位为 GB。

32GB
GPUstring

GPU 数量。

4
GPUTypestring

GPU 显卡类型,取值如下:

  • V100
  • A100
  • T4
  • A10
  • P100
v100
Labelsarray<object>

用户自定义标签。

{'foo': 'bar'}
object

用户定义标签。

Keystring

用户定义标签键。

stsTokenOwner
Valuestring

用户定义标签值。

123xxxxxxxx
CloudDisksarray<object>

云盘列表。

[]
object

云盘列表。

Capacitystring

为每个按量付费实例赠送免费云盘做持久化存储。

  • GPU 规格:默认为 100 GB。
  • CPU 规格:默认为 30 GB。
30
SubTypestring

rootfs:表示将磁盘挂载为系统盘,系统环境存储在磁盘上。

rootfs
MountPathstring

磁盘在容器内额外挂载的数据目录路径。

/mnt/workspace
Pathstring

磁盘被挂载的路径。

/mnt/systemdist
Statusobject

云盘或者快照使用情况。

Availablelong

可使用量,单位 Byte。

31841058816
Usagelong

已使用量,单位 Byte。

371195904
Capacitylong

容量,单位 Byte。

32212254720
WorkspaceSourcestring

选择云盘作为默认工作目录。

rootfsCloudDisk
UserIdstring

实例所有者的账号 ID。支持阿里云账号或 RAM 用户。

161228528250****
Driverstring

NVIDIA 驱动配置。

535.54.03
Affinityobject

亲和性配置信息。

CPUobject

CPU 亲和性配置信息。仅支持通用计算预付费实例。

Enableboolean

是否开启 CPU 亲和性。

false:不开启。 true:开启。

true

返回参数

名称类型描述示例值
object

执行结果。

RequestIdstring

请求 ID。

E7D55162-4489-1619-AAF5-3F97D5FCA948
Successboolean

成功标志,可能值:

  • true
  • false
true
Messagestring

返回结果说明。

"XXX"
Codestring

状态码,可能值:

  • InternalError:内部错误(除了参数验证错误外的其他错误,目前都归类到内部错误)。
  • ValidationError:参数验证错误。
null
HttpStatusCodeinteger

HTTP 状态码,可能值:

  • 400
  • 404
  • 200
200
InstanceIdstring

实例 ID。

dsw-730xxxxxxxxxx

示例

正常返回示例

JSON格式

{
  "RequestId": "E7D55162-4489-1619-AAF5-3F97D5FCA948",
  "Success": true,
  "Message": "\"XXX\"",
  "Code": "null",
  "HttpStatusCode": 200,
  "InstanceId": "dsw-730xxxxxxxxxx"
}

错误码

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2024-07-09API 内部配置变更,不影响调用查看变更详情
2024-06-24API 内部配置变更,不影响调用查看变更详情
2024-06-24API 内部配置变更,不影响调用查看变更详情
2024-01-09API 内部配置变更,不影响调用查看变更详情
2023-12-27API 内部配置变更,不影响调用查看变更详情
2023-11-14API 内部配置变更,不影响调用查看变更详情
2023-08-09API 内部配置变更,不影响调用查看变更详情
2023-08-08API 内部配置变更,不影响调用查看变更详情
2023-07-25API 内部配置变更,不影响调用查看变更详情
2023-03-28API 内部配置变更,不影响调用查看变更详情
2022-09-05API 内部配置变更,不影响调用查看变更详情
2022-01-20API 内部配置变更,不影响调用查看变更详情
2022-01-20OpenAPI 返回结构发生变更查看变更详情