调用CreateInstance创建一个DSW实例。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
请求语法
POST /api/v2/instances HTTP/1.1
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
body | object | 否 | 实例属性。 | |
WorkspaceId | string | 否 | 工作空间 ID。如何获取工作空间 ID,请参见 ListWorkspaces 。 | 40823 |
InstanceName | string | 否 | 实例名称。格式要求:
| training_data |
EcsSpec | string | 否 | 实例对应的 ECS 规格。如何获取 ECS 规格,请参见 ListEcsSpecs 。 | ecs.c6.large |
ImageId | string | 否 | 镜像 ID。如何获取镜像 ID,请参见 ListImages 。 | image-05cefd0be2exxxx |
ImageUrl | string | 否 | 镜像地址。如何获取镜像地址,请参见 ListImages 。 | registry.cn-shanghai.aliyuncs.com/pai_product/tensorflow:py36_cpu_tf1.12_ubuntu |
Datasets | array<object> | 否 | 数据集列表。 | |
Dataset | object | 否 | 数据集。 | |
DatasetId | string | 否 | 数据集 ID,当数据集为只读时,无法通过 MountAccess 将数据集改为读写。 如何获取数据集 ID,请参见 ListDatasets ,指定数据集 ID 时不能指定 Uri。 | d-vsqjvs****rp5l206u |
DatasetVersion | string | 否 | 数据集版本,需同时指定 DatasetId,不填默认为 v1。 | v1 |
Uri | string | 否 | 存储服务目录的 Uri,实现直接挂载,该字段与 DatasetId 互斥。 不同类型存储的 Uri 格式详见:
| oss://bucket-name.oss-cn-shanghai-internal.aliyuncs.com/data/path/ |
MountPath | string | 否 | 数据集的挂载路径。 | /mnt/data |
MountAccess | string | 否 | 数据集挂载后的读写权限,假如数据集是只读,无法修改为读写。 | RW |
Options | string | 否 | 自定义挂载属性,目前仅支持 OSS,使用时不能同时指定 OptionType,详见: DSW 挂载配置。 | { "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" } |
OptionTypedeprecated | string | 否 | 挂载类型,使用时不能同时指定 Options,目前已废弃,不建议使用,建议使用 Options 参数。 | ReadOnly |
Dynamic | boolean | 否 | 是否开启动态挂载,默认为 false。
| true |
UserVpc | object | 否 | User VPC 配置。 | |
VpcId | string | 否 | VPC ID。 | vpc-xxxxx |
VSwitchId | string | 否 | 交换机 ID。 | vsw-xxxxx |
SecurityGroupId | string | 否 | 安全组 ID。 | sg-xxxxxx |
ExtendedCIDRs | array | 否 | 扩展网段。
| |
ExtendedCIDR | string | 否 | 扩展网段。 | "172.16.19.0/24","172.16.2.0/24","172.16.12.0/24" |
DefaultRoute | string | 否 | 默认路由。取值如下:
| eth0 |
ForwardInfos | array | 否 | 端口透出信息。 | |
ForwardInfo | 否 | 端口透出信息列表,可配置映射端口、网关 ID、SSH 公钥等参数。 | ||
Accessibility | string | 否 | 实例的可见性。 枚举值:
| PRIVATE |
EnvironmentVariables | object | 否 | 环境变量。 | |
string | 否 | 用户指定环境变量,DSW 实例启动后,指定环境变量会被注入到容器中。 | MAAS | |
ResourceId | string | 否 | 资源组 ID,预付费时配置。如何创建专有资源组,请参见准备及管理 DLC 资源组集群。 | dsw-123456789 |
Priority | long | 否 | 优先级,在分配资源给实例时,优先级越高的实例越优先。取值范围为 1~9。
| 1 |
RequestedResource | object | 否 | 资源配置。 | |
CPU | string | 否 | CPU 核数。 | 32 |
Memory | string | 否 | 内存大小。单位为 GB。 | 32GB |
SharedMemory | string | 否 | 共享内存大小。单位为 GB。 | |
GPU | string | 否 | GPU 数量。 | 4 |
GPUType | string | 否 | GPU 显卡类型,取值如下:
| v100 |
Labels | array<object> | 否 | 用户自定义标签。 | {'foo': 'bar'} |
Label | object | 否 | 用户定义标签。 | |
Key | string | 否 | 用户定义标签键。 | stsTokenOwner |
Value | string | 否 | 用户定义标签值。 | 123xxxxxxxx |
CloudDisks | array<object> | 否 | 云盘列表。 | [] |
CloudDisk | object | 否 | 云盘列表。 | |
Capacity | string | 否 | 当资源类型选择公共资源,或当资源配额选择预付费通用计算资源(CPU 核数≥2 且内存≥4G,或配置 GPU)时: 每个实例会赠送 100 GiB 免费系统盘额度,用于持久化存储。如果实例停机超过 15 天,云盘的内容将被清空。云盘支持扩容,具体扩容价格以控制台界面为准。 警告
扩容后不支持缩容,请按需操作扩容。 扩容后整块系统盘(免费+付费),不再受到停机 15 天释放的限制,但会持续产生费用。 实例删除,系统盘同步释放,删除前请确保必要数据备份。 如果您需要永久性存储,可以配置数据集挂载,或在存储路径挂载中添加 OSS、NAS、CPFS 路径。 | 100Gi |
SubType | string | 否 | 云盘类型:
| rootfs |
MountPath | string | 否 | 云盘的挂载路径。 | /mnt/systemDisk |
Path | string | 否 | 挂载到实例的云盘子路径。 | workspace |
Status | object | 否 | 云盘或者快照使用情况。 | |
Available | long | 否 | 可使用量,单位 Byte。 | 31841058816 |
Usage | long | 否 | 已使用量,单位 Byte。 | 371195904 |
Capacity | long | 否 | 容量,单位 Byte。 | 32212254720 |
WorkspaceSource | string | 否 | 指定工作目录对应的存储,支持将云盘或 Datasets 中的数据集同时挂载到/mnt/workspace 工作目录,不支持 oss 数据集和动态挂载的数据集。 目前可以填写:
假如为空:
| rootfsCloudDisk |
UserId | string | 否 | 实例所有者的账号 ID。支持阿里云账号或 RAM 用户。 | 161228528250**** |
Driver | string | 否 | NVIDIA 驱动配置。 | 535.54.03 |
CredentialConfig | CredentialConfig | 否 | 凭据配置。 | |
Affinity | object | 否 | 亲和性配置信息。 | |
CPU | object | 否 | CPU 亲和性配置信息。仅支持通用计算预付费实例。 | |
Enable | boolean | 否 | 是否开启 CPU 亲和性。
| true |
ImageAuth | string | 否 | 用户私有镜像的账号密码信息 base64 编码后的值,密码部分会被隐藏。 | **** |
DynamicMount | DynamicMount | 否 | 动态挂载配置。 | |
Tag | array<object> | 否 | Tag 列表。 | |
object | 否 | Tag。 | ||
Key | string | 否 | Tag 的 key。 | tag1 |
Value | string | 否 | Tag 的 Value。 | value1 |
返回参数
示例
正常返回示例
JSON
格式
{
"RequestId": "E7D55162-4489-1619-AAF5-3F97D5FCA948",
"Success": true,
"Message": "XXX",
"Code": null,
"HttpStatusCode": 200,
"InstanceId": "dsw-730xxxxxxxxxx"
}
错误码
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 |
---|---|---|
2025-04-18 | API 内部配置变更,不影响调用 | 查看变更详情 |
2025-03-13 | API 内部配置变更,不影响调用 | 查看变更详情 |
2025-03-12 | API 内部配置变更,不影响调用 | 查看变更详情 |
2025-02-28 | API 内部配置变更,不影响调用 | 查看变更详情 |
2024-11-27 | API 内部配置变更,不影响调用 | 查看变更详情 |
2024-08-01 | API 内部配置变更,不影响调用 | 查看变更详情 |
2024-07-09 | API 内部配置变更,不影响调用 | 查看变更详情 |
2024-06-24 | API 内部配置变更,不影响调用 | 查看变更详情 |
2024-06-24 | API 内部配置变更,不影响调用 | 查看变更详情 |
2024-01-09 | API 内部配置变更,不影响调用 | 查看变更详情 |
2023-12-27 | API 内部配置变更,不影响调用 | 查看变更详情 |
2023-11-14 | API 内部配置变更,不影响调用 | 查看变更详情 |
2023-08-09 | API 内部配置变更,不影响调用 | 查看变更详情 |
2023-08-08 | API 内部配置变更,不影响调用 | 查看变更详情 |
2023-07-25 | API 内部配置变更,不影响调用 | 查看变更详情 |
2023-03-28 | API 内部配置变更,不影响调用 | 查看变更详情 |
2022-09-05 | API 内部配置变更,不影响调用 | 查看变更详情 |
2022-01-20 | API 内部配置变更,不影响调用 | 查看变更详情 |
2022-01-20 | OpenAPI 返回结构发生变更 | 查看变更详情 |