调用CreateInstance创建实例_人工智能平台 PAI(PAI)-阿里云帮助中心

调用CreateInstance创建一个DSW实例。

调试

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

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
paidsw:CreatePostPaidInstance	create	全部资源 ``	无	无

请求语法

POST /api/v2/instances HTTP/1.1

请求参数

名称	类型	必填	描述	示例值
body	object	否	实例属性。
WorkspaceId	string	否	工作空间 ID。如何获取工作空间 ID，请参见 ListWorkspaces 。	40823
InstanceName	string	否	实例名称。格式要求：只能包含英文字母、数字和下划线（_）。不能超过 27 个字符。	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。如何获取数据集 ID，请参见 ListDatasets ，使用时不能指定 Uri。	d-vsqjvsjp4orp5l206u
MountPath	string	否	容器内挂载路径。	/mnt/data
Uri	string	否	需要挂载的 OSS 目录的 Uri，使用时不能同时指定 DatasetId。	oss://bucket-name.oss-cn-shanghai-internal.aliyuncs.com/data/path/
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" }
OptionType`deprecated`	string	否	挂载类型，使用时不能同时指定 Options，目前已废弃，不建议使用，建议使用 Options 参数。	ReadOnly
UserVpc	object	否	User VPC 配置。
VpcId	string	否	VPC ID。	vpc-xxxxx
VSwitchId	string	否	交换机 ID。	vsw-xxxxx
SecurityGroupId	string	否	安全组 ID。	sg-xxxxxx
ExtendedCIDRs	array	否	扩展网段。当交换机 ID 为空时，此参数可以不提供，系统会自动获取 VPC 下的所有网段；当交换机 ID 不为空时，此参数必须提供，建议填写 VPC 下的所有网段。
ExtendedCIDR	string	否	扩展网段。	"172.16.19.0/24","172.16.2.0/24","172.16.12.0/24"
DefaultRoute	string	否	默认路由。取值如下： eth0：表示使用默认网卡，通过公共网关访问外部网络。 eth1：表示使用用户弹性网卡，通过私有网关访问外部网络。具体配置方法，请参考配置 DSW 实例通过专有公网网关访问公网。	eth0
ForwardInfos	array	否	端口透出信息。
	ForwardInfo	否	端口透出信息列表，可配置映射端口、网关 ID、SSH 公钥等参数。
Accessibility	string	否	工作空间内是否他人可见。取值如下： PRIVATE：表示工作空间内自己及管理员可见。 PUBLIC：工作空间所有用户可见。	PRIVATE
EnvironmentVariables	object	否	环境变量。
	string	否	用户指定环境变量，DSW 实例启动后，指定环境变量会被注入到容器中。	MAAS
ResourceId	string	否	资源组 ID，预付费时配置。如何创建专有资源组，请参见准备及管理 DLC 资源组集群。	dsw-123456789
Priority	long	否	优先级，在分配资源给实例时，优先级越高的实例越优先。取值范围为 1~9。 1 为最低优先级。 9 为最高优先级。	1
RequestedResource	object	否	资源配置，弹内或者轻量化时使用。
CPU	string	否	CPU 核数。	32
Memory	string	否	内存大小。单位为 GB。	32GB
SharedMemory	string	否	共享内存大小。单位为 GB。	32GB
GPU	string	否	GPU 数量。	4
GPUType	string	否	GPU 显卡类型，取值如下： V100 A100 T4 A10 P100	v100
Labels	array<object>	否	用户自定义标签。	{'foo': 'bar'}
Label	object	否	用户定义标签。
Key	string	否	用户定义标签键。	stsTokenOwner
Value	string	否	用户定义标签值。	123xxxxxxxx
CloudDisks	array<object>	否	云盘列表。	[]
CloudDisk	object	否	云盘列表。
Capacity	string	否	为每个按量付费实例赠送免费云盘做持久化存储。 GPU 规格：默认为 100 GB。 CPU 规格：默认为 30 GB。	30
SubType	string	否	rootfs：表示将磁盘挂载为系统盘，系统环境存储在磁盘上。	rootfs
MountPath	string	否	磁盘在容器内额外挂载的数据目录路径。	/mnt/workspace
Path	string	否	磁盘被挂载的路径。	/mnt/systemdist
Status	object	否	云盘或者快照使用情况。
Available	long	否	可使用量，单位 Byte。	31841058816
Usage	long	否	已使用量，单位 Byte。	371195904
Capacity	long	否	容量，单位 Byte。	32212254720
WorkspaceSource	string	否	选择云盘作为默认工作目录。	rootfsCloudDisk
UserId	string	否	实例所有者的账号 ID。支持阿里云账号或 RAM 用户。	161228528250****
Driver	string	否	NVIDIA 驱动配置。	535.54.03
CredentialConfig	CredentialConfig	否	凭据配置。
Affinity	object	否	亲和性配置信息。
CPU	object	否	CPU 亲和性配置信息。仅支持通用计算预付费实例。
Enable	boolean	否	是否开启 CPU 亲和性。 false：不开启。 true：开启。	true
ImageAuth	string	否	用户私有镜像的账号密码信息 base64 编码后的值，密码部分会被隐藏。	****

返回参数

名称	类型	描述	示例值
	object	执行结果。
RequestId	string	请求 ID。	E7D55162-4489-1619-AAF5-3F97D5FCA948
Success	boolean	成功标志，可能值： true false	true
Message	string	返回结果说明。	"XXX"
Code	string	状态码，可能值： InternalError：内部错误（除了参数验证错误外的其他错误，目前都归类到内部错误）。 ValidationError：参数验证错误。	null
HttpStatusCode	integer	HTTP 状态码，可能值： 400 404 200	200
InstanceId	string	实例 ID。	dsw-730xxxxxxxxxx

示例

正常返回示例

JSON格式

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

错误码

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

变更历史

变更时间	变更内容概要	操作
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 返回结构发生变更	查看变更详情