创建个人开发环境实例。
接口说明
创建个人开发环境（ServerIDE）实例。指定 DataWorks 工作空间、资源组、镜像与规格后创建实例，并返回实例 ID。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| ProjectId |
integer |
是 |
DataWorks 工作空间 ID。 |
10000 |
| ResourceGroupId |
string |
是 |
DataWorks 资源组标识。支持资源组数字 ID，或 Serverless_res_group_{tenantId}_{resgId} 格式的完整标识。 |
Serverless_res_group_123456789012345_9876543210**** |
| Cu |
integer |
否 |
实例使用的 CU 数量。 |
10 |
| Owner |
string |
否 |
实例所属用户的阿里云账号 ID。不传时默认为当前调用用户。 |
20933221576142**** |
| ImageId |
string |
否 |
镜像 ID。可调用 ListServerIdeImages 获取。 |
System_serveride_notebook_20240822 |
| ImageUrl |
string |
否 |
镜像地址。使用非 DataWorks 官方镜像时需要提供。 |
registry.cn-hangzhou.aliyuncs.com/example/serveride:latest |
| InstanceName |
string |
是 |
个人开发环境实例名称。 |
notebook_dev |
| UserVpc |
object |
否 |
实例使用的专有网络配置。 |
|
| SecurityGroupId |
string |
否 |
安全组 ID。 |
sg-bp1**** |
| VSwitchId |
string |
否 |
交换机 ID。 |
vsw-bp1**** |
| VpcId |
string |
否 |
专有网络 VPC ID。 |
vpc-bp1**** |
| ForwardInfos |
array<object> |
否 |
端口转发配置列表。 |
|
|
object |
否 |
端口转发配置。 |
||
| AccessType |
array |
否 |
访问类型列表。 |
|
|
string |
否 |
访问类型。取值 intranet 表示内网，internet 表示公网。 |
intranet |
|
| ContainerName |
string |
否 |
目标容器名称。 |
dsw-notebook |
| Enable |
boolean |
否 |
是否启用该端口转发配置。 |
true |
| ForwardPort |
string |
否 |
实例容器内的目标端口。 |
22 |
| Name |
string |
否 |
端口转发配置名称。 |
ssh |
| NatGatewayId |
string |
否 |
NAT 网关 ID。 |
ngw-bp1**** |
| SSHPublicKey |
string |
否 |
用于 SSH 访问的公钥。 |
ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQ**** |
| EipAllocationId |
string |
否 |
公网 EIP 的实例 ID。 |
eip-bp1**** |
| ExternalPort |
string |
否 |
映射后的公网端口。 |
1024 |
| Datasets |
array<object> |
否 |
挂载到实例的数据集列表。 |
|
|
object |
否 |
数据集挂载配置。 |
||
| Identifier |
string |
否 |
数据集标识。 |
d-vsqjvs****rp5l206u |
| Version |
integer |
否 |
数据集版本号。 |
1 |
| MountPath |
string |
否 |
数据集在实例中的挂载路径。 |
/mnt/data |
| ReadOnly |
boolean |
否 |
是否以只读方式挂载数据集。 |
false |
| ExtOptions |
string |
否 |
数据集的自定义挂载属性，内容将作为挂载 Options 传递。 |
{"fs.oss.download.thread.concurrency":"10"} |
| Uri |
string |
否 |
用于直接挂载的存储服务目录 URI。 |
oss://example-bucket/data/ |
| CredentialConfig |
object |
否 |
实例的凭据注入配置。开启后可使用默认 RAM 角色链或指定自定义 RAM 角色。 |
|
| Enable |
boolean |
否 |
是否开启凭据注入。 |
True |
| AliyunEnvRoleKey |
string |
否 |
环境变量角色 Key。 |
0 |
| Configs |
array<object> |
否 |
凭据配置列表。 |
|
|
array<object> |
否 |
单个凭据配置。 |
||
| Key |
string |
否 |
凭据配置的标识 Key。 |
0 |
| Type |
string |
否 |
凭据配置类型。取值 Role 表示单角色扮演，RoleChain 表示角色链扮演。 |
RoleChain |
| Roles |
array<object> |
否 |
凭据配置中的角色列表。 |
|
|
array<object> |
否 |
角色扮演配置。 |
||
| AssumeRoleFor |
string |
否 |
扮演角色所属主体的阿里云账号 ID。 |
123456789012**** |
| Policy |
string |
否 |
用于进一步限制角色权限的策略。 |
{} |
| RoleArn |
string |
否 |
RAM 角色 ARN。 |
acs:ram::123456789012****:role/DataWorksRole |
| RoleType |
string |
否 |
角色扮演类型。取值 service 表示由服务扮演，user 表示由用户扮演。 |
service |
| UserInfo |
object |
否 |
被代理的用户信息。 |
|
| Id |
string |
否 |
被代理用户的账号 ID。 |
20933221576142**** |
| Type |
string |
否 |
用户类型。取值 customer 表示主账号，sub 表示 RAM 用户，AssumedRoleUser 表示 RAM 角色。 |
sub |
| UserCommand |
object |
否 |
实例启动时执行的用户命令配置。 |
|
| OnStart |
object |
否 |
实例启动后执行的命令配置。 |
|
| Content |
string |
否 |
实例启动后执行的命令内容，长度不超过 1024 个字符。 |
echo "serveride ready" |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
返回结果。 |
||
| RequestId |
string |
请求 ID。 |
E7D55162-4489-1619-AAF5-3F97D5FCA948 |
| InstanceId |
string |
个人开发环境实例 ID。 |
699573 |
示例
正常返回示例
JSON格式
{
"RequestId": "E7D55162-4489-1619-AAF5-3F97D5FCA948",
"InstanceId": "699573"
}错误码
访问错误中心查看更多错误码。
变更历史
更多信息，参考变更详情。