分页查询个人开发环境实例列表。
接口说明
分页查询个人开发环境（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": true,
"ExternalPort": "1024",
"ForwardPort": "22",
"Name": "ssh",
"NatGatewayId": "ngw-bp1****",
"SSHPublicKey": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQ****"
}
]
},
"Datasets": [
{
"Identifier": "d-vsqjvs****rp5l206u",
"Version": 1,
"MountPath": "/mnt/data",
"ReadOnly": true,
"ExtOptions": "{\"fs.oss.download.thread.concurrency\":\"10\"}",
"Uri": "oss://example-bucket/data/"
}
],
"CredentialConfig": {
"Enable": true,
"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****"
}错误码
访问错误中心查看更多错误码。
变更历史
更多信息，参考变更详情。