分頁查詢個人開發環境執行個體列表；呼叫時請使用與目標工作空間地域對應的 DataWorks 服務接入點。
介面說明
分頁查詢個人開發環境（ServerIDE）執行個體列表，支援按工作空間、資源群組、關鍵字、歸屬使用者和執行個體子類型過濾。
調試
您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。
調試
授權資訊
請求參數
|
名稱 |
類型 |
必填 |
描述 |
樣本值 |
| ProjectId |
integer |
否 |
DataWorks 工作空間 ID。 |
10000 |
| ResourceGroupId |
string |
否 |
DataWorks 資源群組識別碼。支援資源群組數字 ID，或 Serverless_res_group_{tenantId}_{resgId} 格式的完整識別碼。 |
Serverless_res_group_123456789012345_9876543210**** |
| Keyword |
string |
否 |
按執行個體 ID 或執行個體名稱進行關鍵字比對。 |
notebook_dev |
| RelatedUserId |
string |
否 |
按執行個體所屬使用者的帳號 ID 過濾。 |
20933221576142**** |
| SubType |
string |
否 |
執行個體子類型。取值 PERSONAL_DEV 表示個人開發環境，DATA_AGENT 表示 Data Agent。 |
PERSONAL_DEV |
| PageNumber |
integer |
否 |
頁碼，起始值為 1。 |
1 |
| PageSize |
integer |
否 |
每頁返回的記錄數。 |
10 |
| MaxResults |
integer |
否 |
單次請求返回的最大記錄數。 |
20 |
| NextToken |
string |
否 |
用於繼續查詢的分頁權杖，首次呼叫無需傳入。 |
CAESG**** |
返回參數
|
名稱 |
類型 |
描述 |
樣本值 |
|
object |
返回結果。 |
||
| RequestId |
string |
請求 ID。 |
E7D55162-4489-1619-AAF5-3F97D5FCA948 |
| PagingInfo |
object |
分頁資訊。 |
|
| PageNumber |
integer |
當前頁碼。 |
1 |
| PageSize |
integer |
當前分頁的每頁記錄數。 |
10 |
| TotalCount |
integer |
符合條件的記錄總數。 |
3 |
| Instances |
array<object> |
個人開發環境執行個體列表。 |
|
|
array<object> |
個人開發環境執行個體資訊。 |
||
| InstanceId |
string |
個人開發環境執行個體 ID。 |
699573 |
| InstanceName |
string |
個人開發環境執行個體名稱。 |
notebook_dev |
| Status |
string |
執行個體狀態。取值包括 Creating、Starting、Running、Stopping、Stopped、Updating、Deleting、DELETED、Failed、Arrearage、Saving、SaveFailed 和 Saved。 |
Running |
| ResourceGroupId |
integer |
資源群組的內部數字 ID。 |
9876543210 |
| ResourceGroupName |
string |
資源群組名稱。 |
serverless_group |
| Cu |
integer |
執行個體使用的 CU 數量。 |
10 |
| ProjectId |
integer |
DataWorks 工作空間 ID。 |
10000 |
| ProjectName |
string |
DataWorks 工作空間名稱。 |
example_project |
| ImageId |
string |
執行個體使用的映像 ID。 |
System_serveride_notebook_20240822 |
| ImageName |
string |
映像名稱。 |
serveride_notebook |
| ImageUrl |
string |
映像位址。 |
registry.cn-hangzhou.aliyuncs.com/example/serveride:latest |
| OwnerId |
string |
執行個體所屬使用者的帳號 ID。 |
20933221576142**** |
| FailReason |
string |
執行個體進入失敗狀態時的原因。 |
ImagePullBackOff |
| CreateTime |
integer |
執行個體建立時間，毫秒級 Unix 時間戳記。 |
1756000000000 |
| UpdateTime |
integer |
執行個體最後更新時間，毫秒級 Unix 時間戳記。 |
1756003600000 |
| 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 |
| EipAllocationId |
string |
公網 EIP 的執行個體 ID。 |
eip-bp1**** |
| Enable |
boolean |
是否啟用該連接埠轉送設定。 |
|
| ExternalPort |
string |
對應後的公網連接埠。 |
1024 |
| ForwardPort |
string |
執行個體容器內的目標連接埠。 |
22 |
| Name |
string |
連接埠轉送設定名稱。 |
ssh |
| NatGatewayId |
string |
NAT 閘道 ID。 |
ngw-bp1**** |
| SSHPublicKey |
string |
用於 SSH 存取的公鑰。 |
ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQ**** |
| Datasets |
array<object> |
掛載到執行個體的資料集列表。 |
|
|
object |
資料集掛載設定。 |
||
| Identifier |
string |
資料集識別碼。 |
d-vsqjvs****rp5l206u |
| Version |
integer |
資料集版本號。 |
1 |
| MountPath |
string |
資料集在執行個體中的掛載路徑。 |
/mnt/data |
| ReadOnly |
boolean |
是否以唯讀方式掛載資料集。 |
|
| ExtOptions |
string |
資料集的自訂掛載屬性，內容將作為掛載 Options 傳遞。 |
{"fs.oss.download.thread.concurrency":"10"} |
| Uri |
string |
用於直接掛載的儲存服務目錄 URI。 |
oss://example-bucket/data/ |
| CredentialConfig |
object |
執行個體的憑證注入設定。開啟後可使用預設 RAM 角色鏈或指定自訂 RAM 角色。 |
|
| Enable |
boolean |
是否開啟憑證注入。 |
|
| 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 |
被代理的使用者資訊。 |
|
| AccessKeyId |
string |
憑證注入使用的臨時存取金鑰 ID。 |
STS.N*********7 |
| Id |
string |
被代理使用者的帳號 ID。 |
20933221576142**** |
| SecurityToken |
string |
憑證注入使用的臨時安全性權杖。 |
DFE32G******* |
| Type |
string |
使用者類型。取值 customer 表示主帳號，sub 表示 RAM 使用者，AssumedRoleUser 表示 RAM 角色。 |
sub |
| MaxResults |
integer |
本次回應使用的最大返回記錄數。 |
20 |
| NextToken |
string |
下一頁查詢權杖；為空表示沒有更多結果。 |
CAESG**** |
樣本
正常返回樣本
JSON格式
{
"RequestId": "E7D55162-4489-1619-AAF5-3F97D5FCA948",
"PagingInfo": {
"PageNumber": 1,
"PageSize": 10,
"TotalCount": 3,
"Instances": [
{
"InstanceId": "699573",
"InstanceName": "notebook_dev",
"Status": "Running",
"ResourceGroupId": 9876543210,
"ResourceGroupName": "serverless_group",
"Cu": 10,
"ProjectId": 10000,
"ProjectName": "example_project",
"ImageId": "System_serveride_notebook_20240822",
"ImageName": "serveride_notebook",
"ImageUrl": "registry.cn-hangzhou.aliyuncs.com/example/serveride:latest",
"OwnerId": "20933221576142****",
"FailReason": "ImagePullBackOff",
"CreateTime": 1756000000000,
"UpdateTime": 1756003600000,
"UserVpc": {
"SecurityGroupId": "sg-bp1****",
"VSwitchId": "vsw-bp1****",
"VpcId": "vpc-bp1****",
"ForwardInfos": [
{
"AccessType": [
"intranet"
],
"ContainerName": "dsw-notebook",
"EipAllocationId": "eip-bp1****",
"Enable": false,
"ExternalPort": "1024",
"ForwardPort": "22",
"Name": "ssh",
"NatGatewayId": "ngw-bp1****",
"SSHPublicKey": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQ****"
}
]
},
"Datasets": [
{
"Identifier": "d-vsqjvs****rp5l206u",
"Version": 1,
"MountPath": "/mnt/data",
"ReadOnly": false,
"ExtOptions": "{\"fs.oss.download.thread.concurrency\":\"10\"}",
"Uri": "oss://example-bucket/data/"
}
],
"CredentialConfig": {
"Enable": false,
"AliyunEnvRoleKey": "0",
"Configs": [
{
"Key": "0",
"Type": "RoleChain",
"Roles": [
{
"AssumeRoleFor": "123456789012****",
"Policy": "{}",
"RoleArn": "acs:ram::123456789012****:role/DataWorksRole",
"RoleType": "service",
"UserInfo": {
"AccessKeyId": "STS.N*********7",
"Id": "20933221576142****",
"SecurityToken": "DFE32G*******",
"Type": "sub"
}
}
]
}
]
}
}
]
},
"MaxResults": 20,
"NextToken": "CAESG****"
}錯誤碼
訪問錯誤中心查看更多錯誤碼。
變更歷史
更多資訊，參考變更詳情。