建立個人開發環境執行個體。
介面說明
建立個人開發環境(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"
}
錯誤碼
訪問錯誤中心查看更多錯誤碼。
變更歷史
更多資訊,參考變更詳情。