Updates the configuration of a specified personal development environment instance.
Operation description
Updates the configuration of a specified personal development environment (ServerIDE) instance. You can modify the CU, image, instance name, VPC, dataset, and credential configurations. If the CU and image parameters are not specified, the existing instance configurations are retained.
Try it now
Test
RAM authorization
Request parameters
|
Parameter |
Type |
Required |
Description |
Example |
| InstanceId |
string |
Yes |
The personal development environment instance ID. You can call ListServerIdeInstances to obtain the ID. |
699573 |
| ProjectId |
integer |
No |
The DataWorks workspace ID. |
10000 |
| Cu |
integer |
No |
The number of CUs used by the instance. |
10 |
| ImageId |
string |
No |
The image ID. You can call ListServerIdeImages to obtain the ID. |
System_serveride_notebook_20240822 |
| ImageUrl |
string |
No |
The image URL. This parameter is required when you use a non-DataWorks official image. |
registry.cn-hangzhou.aliyuncs.com/example/serveride:latest |
| InstanceName |
string |
No |
The name of the personal development environment instance. |
notebook_dev |
| UserVpc |
object |
No |
The VPC configuration used by the instance. |
|
| SecurityGroupId |
string |
No |
The security group ID. |
sg-bp1**** |
| VSwitchId |
string |
No |
The vSwitch ID. |
vsw-bp1**** |
| VpcId |
string |
No |
The VPC ID. |
vpc-bp1**** |
| ForwardInfos |
array<object> |
No |
The list of port forwarding configurations. |
|
|
object |
No |
The port forwarding configuration. |
||
| AccessType |
array |
No |
The list of access types. |
|
|
string |
No |
The access type. Valid values:
|
intranet |
|
| ContainerName |
string |
No |
The name of the target container. |
dsw-notebook |
| Enable |
boolean |
No |
Specifies whether to enable the port forwarding configuration. |
true |
| ForwardPort |
string |
No |
The target port in the instance container. |
22 |
| Name |
string |
No |
The name of the port forwarding configuration. |
ssh |
| NatGatewayId |
string |
No |
The NAT gateway ID. |
ngw-bp1**** |
| SSHPublicKey |
string |
No |
The public key used for SSH access. |
ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQ**** |
| EipAllocationId |
string |
No |
The instance ID of the public EIP. |
eip-bp1**** |
| ExternalPort |
string |
No |
The mapped public port. |
1024 |
| Datasets |
array<object> |
No |
The list of datasets mounted to the instance. |
|
|
object |
No |
The dataset mount configuration. |
||
| Identifier |
string |
No |
The dataset identifier. |
d-vsqjvs****rp5l206u |
| Version |
integer |
No |
The dataset version number. |
1 |
| MountPath |
string |
No |
The mount path of the dataset in the instance. |
/mnt/data |
| ReadOnly |
boolean |
No |
Specifies whether to mount the dataset in read-only mode. |
|
| ExtOptions |
string |
No |
The custom mount properties of the dataset. The content is passed as mount options. |
{"fs.oss.download.thread.concurrency":"10"} |
| Uri |
string |
No |
The storage service directory URI for direct mounting. |
oss://example-bucket/data/ |
| CredentialConfig |
object |
No |
The credential injection configuration for the instance. After this feature is enabled, you can use the default RAM role chain or specify a custom RAM role. |
|
| Enable |
boolean |
No |
Specifies whether to enable credential injection. |
|
| AliyunEnvRoleKey |
string |
No |
The environment variable role key. |
0 |
| Configs |
array<object> |
No |
The list of credential configurations. |
|
|
array<object> |
No |
The credential configuration. |
||
| Key |
string |
No |
The identifier key of the credential configuration. |
0 |
| Type |
string |
No |
The credential configuration type. Valid values:
|
RoleChain |
| Roles |
array<object> |
No |
The list of roles in the credential configuration. |
|
|
array<object> |
No |
The role assumption configuration. |
||
| AssumeRoleFor |
string |
No |
The Alibaba Cloud account ID of the principal that owns the role to be assumed. |
123456789012**** |
| Policy |
string |
No |
The policy used to further restrict the role permissions. |
{} |
| RoleArn |
string |
No |
The ARN of the RAM role. |
acs:ram::123456789012****:role/DataWorksRole |
| RoleType |
string |
No |
The role assumption type. Valid values:
|
service |
| UserInfo |
object |
No |
The information of the delegated user. |
|
| Id |
string |
No |
The account ID of the delegated user. |
20933221576142**** |
| Type |
string |
No |
The user type. Valid values:
|
sub |
Response elements
|
Element |
Type |
Description |
Example |
|
object |
The response parameters. |
||
| RequestId |
string |
The request ID. |
E7D55162-4489-1619-AAF5-3F97D5FCA948 |
| InstanceId |
string |
The personal development environment instance ID. |
699573 |
Examples
Success response
JSON format
{
"RequestId": "E7D55162-4489-1619-AAF5-3F97D5FCA948",
"InstanceId": "699573"
}
Error codes
See Error Codes for a complete list.
Release notes
See Release Notes for a complete list.