AI 助理
备案控制台
官方文档
输入文档关键字查找
首页 人工智能平台 PAI 开发参考 API参考 PAI-DSW API API目录 实例 ListInstances - 查询实例列表

ListInstances - 查询实例列表

更新时间：
产品详情
我的收藏

查询DSW实例列表。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

  • 操作：是指具体的权限点。

  • 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。

  • 资源类型：是指操作中支持授权的资源类型。具体说明如下：

    • 对于必选的资源类型，用前面加 * 表示。

    • 对于不支持资源级授权的操作，用全部资源表示。

  • 条件关键字：是指云产品自身定义的条件关键字。

  • 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

paidsw:ListInstances

get

*全部资源

*

 无 无

请求语法

GET /api/v2/instances HTTP/1.1

请求参数

名称

类型

必填

描述

示例值
WorkspaceId

string

否

按工作空间 ID 过滤。如何获取工作空间 ID，请参见 ListWorkspaces 。

40823
InstanceName

string

否

按实例名称过滤。

training_data
ResourceId

string

否

按资源组 ID 过滤，假如为空，只过滤后付费资源组的实例，填 ALL 会过滤出所有的实例。

ALL
Status

string

否

根据实例状态过滤。

枚举值：

  • Creating :

    创建中

  • SaveFailed :

    镜像保存失败

  • Stopped :

    已停止

  • Failed :

    失败

  • ResourceAllocating :

    资源分配中

  • Stopping :

    停止中

  • Updating :

    更新中

  • Saving :

    镜像保存中

  • Queuing :

    排队中

  • Recovering :

    恢复中

  • Starting :

    启动中

  • Running :

    运行中

  • Saved :

    镜像保存成功

  • Deleting :

    删除中

  • EnvPreparing :

    环境准备中

Running
PaymentType

string

否

付费类型。

枚举值：

  • PayAsYouGo :

    后付费（后付费/按量付费）

  • Subscription :

    预付费（预付费/包年包月）

PayAsYouGo
Accessibility

string

否

工作空间可见度。取值如下：

  • PRIVATE（默认值）：表示工作空间内自己以及管理员可见。

  • PUBLIC：为工作空间所有用户可见。

PRIVATE
AcceleratorType

string

否

加速器类型。

  • CPU：无计算加速，只使用 CPU 计算。

  • GPU：使用 GPU 进行计算加速。

枚举值：

  • CPU :

    CPU

  • GPU :

    GPU

CPU
PageNumber

integer

否

实例列表的页码。起始值为 1，默认为 1。

1
PageSize

integer

否

分页查询时设置的每页显示的实例数量。

10
SortBy

string

否

排序字段。

枚举值：

  • Priority :

    优先级

  • GmtCreateTime :

    创建时间

  • GmtModifiedTime :

    修改时间

GmtCreateTime
Order

string

否

排列顺序。

枚举值：

  • ASC :

    升序

  • DESC :

    降序

DESC
InstanceId

string

否

按实例 ID 过滤。如何获取实例 ID，请参见 ListInstances 。

dsw-730xxxxxxxxxx
Labels

object

否

用于过滤的实例标签，最多支持 4 组标签。

{ "key1": "value1", "key2": "value2", "key3": "value3" }
CreateUserId

string

否

创建人的 UserId

12345*****67890
GpuType

string

否

GPU 型号。

NVIDIA A10
MinCpu

string

否

最小的 Cpu 数量，单位是 0.001 Cpu，1000 表示 1 个 Cpu。

2000
MaxCpu

string

否

最大的 Cpu 数量，单位是 0.001 Cpu，1000 表示 1 个 Cpu。

30000
MinGpu

string

否

最小的 Gpu 数量，单位是 0.001 Gpu，1000 表示 1 个 Gpu。

100
MaxGpu

string

否

最大的 Gpu 数量，单位是 0.001 Gpu，1000 表示 1 个 Gpu。

8000
MinMemory

string

否

最小的机器内存数，单位是 G。

4
MaxMemory

string

否

最大的机器内存数，单位是 G。

48
MinGpuMemory

string

否

最小单卡 Gpu 内存大小，单位是 G。

8
MaxGpuMemory

string

否

最大单卡 Gpu 内存大小，单位是 G。

16
ImageName

string

否

镜像名

modelscope:1.9.4-pytorch2.0.1tensorflow2.13.0-cpu-py38-ubuntu20.04
Tag

array<object>

否

标签列表。

object

否

标签信息。

Key

string

否

标签 Key。

tag1
Value

string

否

标签的值。

value1
OversoldInfo

string

否

OversoldType

string

否

返回参数

名称

类型

描述

示例值

object

实例列表。

RequestId

string

请求 ID。

E7D55162-4489-1619-AAF5-3F97D5FCA948
Success

boolean

成功标志，可能值：

  • true

  • false

true
Message

string

返回结果说明。

"XXX"
Code

string

状态码，可能值：

  • InternalError：内部错误（除了参数验证错误外的其他错误，目前都归类到内部错误）。

  • ValidationError：参数验证错误。

null
HttpStatusCode

integer

HTTP 状态码，可能值：

  • 400

  • 404

null
TotalCount

integer

实例总数。

35
Instances

array<object>

本分页中请求的实例列表。

array<object>

实例对象。

WorkspaceId

string

工作空间 ID。

40823
WorkspaceName

string

工作空间名称。

training_data
InstanceId

string

实例 ID。

dsw-730xxxxxxxxxx
InstanceName

string

实例名称。

training_data
EcsSpec

string

实例对应的 ECS 规格。

ecs.c6.large
Status

string

实例状态。

Running
InstanceUrl

string

实例 Url。

https://dsw-cn-shanghai.data.aliyun.com/notebook.htm?instance=39772#/
JupyterlabUrl

string

Jupyterlab Url。

https://dsw-gateway-cn-shanghai.aliyun.com/dsw-39772/lab/
WebIDEUrl

string

Web IDE url。

https://dsw-gateway-cn-shanghai.aliyun.com/dsw-39772/ide/
TerminalUrl

string

终端 url。

https://dsw-gateway-cn-shanghai.aliyun.com/dsw-39772/tty/
AccumulatedRunningTimeInMs

integer

累计运行时间，单位为毫秒。

3600000
ImageId

string

镜像 ID。

image-05cefd0be2exxxx
ImageUrl

string

镜像地址。

registry.cn-shanghai.aliyuncs.com/pai_product/tensorflow:py36_cpu_tf1.12_ubuntu
ImageName

string

镜像名称。

py36_cpu_tf1.12_ubuntu
GmtCreateTime

string

实例创建时间。

2021-01-12T14:36:01Z
GmtModifiedTime

string

实例修改时间。

2021-01-12T14:36:01Z
UserId

string

用户 ID。

1612285282502324
UserName

string

用户名称。

测试用户
Datasets

array<object>

数据集集合。

object

数据集对象

DatasetId

string

数据集 ID。

d-vsqjvsjp4orp5l206u
DatasetVersion

string

数据集版本。

v1
Uri

string

指定的数据集的 Uri。

oss://bucket-name.oss-cn-shanghai-internal.aliyuncs.com/data/path/
MountPath

string

容器内挂载路径。

/mnt/data
MountAccess

string

读写权限，RW：读写，RO：只读。

枚举值：

  • RW :

    读写

  • RO :

    只读

RW
Options

string

数据集的挂载属性。

{ "fs.oss.download.thread.concurrency": "10", "fs.oss.upload.thread.concurrency": "10", "fs.jindo.args": "-oattr_timeout=3 -oentry_timeout=0 -onegative_timeout=0 -oauto_cache -ono_symlink" }
OptionType

string

挂载配置项类型

FastReadWrite
Dynamic

boolean

是否开启动态挂载，默认为 false。

false
UserVpc

object

User VPC 配置。

VpcId

string

VPC ID。

vpc-xxxxx
VSwitchId

string

交换机 ID。

vsw-xxxxx
SecurityGroupId

string

安全组 ID。

sg-xxxxxx
ExtendedCIDRs

array

扩展网络打通网段列表

["192.168.0.1/24", "192.168.1.1/24"]

string

扩展网络打通网段

192.168.0.1/24
DefaultRoute

string

Default Route

eth0 | eth1
ForwardInfos

array

端口透出信息。

ForwardInfoResponse

端口透出信息列表。

BandwidthLimit

BandwidthLimit

Ip

string

InstanceShutdownTimer

object

定时关机任务。

InstanceId

string

实例 ID。

dsw-730xxxxxxxxxx
GmtCreateTime

string

创建时间。

2021-01-12T14:36:01Z
GmtModifiedTime

string

修改时间。

2021-01-12T14:36:01Z
DueTime

string

设定关机时间。

2021-01-12T14:36:01Z
RemainingTimeInMs

integer

剩余关机时间，单位为毫秒。

3600000
ReasonCode

string

实例错误代码。

Internal Error
ReasonMessage

string

实例错误原因。

ImagePullBackOff
PaymentType

string

支付类型，可能值：

  • PayAsYouGo：后付费（后付费/按量付费）。

  • Subscription：预付费（预付费/包年包月）。

PayAsYouGo
LatestSnapshot

object

最新保存的用户镜像。

ImageId

string

镜像 ID。

image-05cefd0be2exxxx
ImageName

string

镜像名称。

py36_cpu_tf1.12_ubuntu
ImageUrl

string

镜像 Url。

registry.cn-shanghai.aliyuncs.com/pai_product/tensorflow:py36_cpu_tf1.12_ubuntu
RepositoryUrl

string

镜像仓库 Url。

https://cr.console.aliyun.com/repository/cn-hangzhou/zouxu/kf/images
GmtCreateTime

string

快照创建时间。

2021-01-12T14:36:01Z
GmtModifiedTime

string

快照修改时间。

2021-01-12T14:36:01Z
ReasonCode

string

实例快照错误代码。

Internal Error
ReasonMessage

string

实例快照错误消息。

ImagePullBackOff
Status

string

实例快照状态。

Pushing
AcceleratorType

string

实例计算类型。可能值：

  • CPU

  • GPU

CPU
Accessibility

string

工作空间内是否他人可见。可能值：

  • PRIVATE（默认值）：表示工作空间内自己以及管理员可见。

  • PUBLIC：为工作空间所有用户可见。

PRIVATE
EnvironmentVariables

object

环境变量。

{userName: "Chris"}

string

用户指定环境变量。DSW 实例启动后，指定环境变量会被注入到容器中。

MAAS
ResourceId

string

资源 ID，预付费时填写。

dsw-123456789
ResourceName

string

资源规格。

  • 后付费场景，资源规格为购买的 ECS 规格。

  • 预付费场景，资源规格为请求的 CPU 核数与内存大小。

resource_group
Priority

integer

优先级，在分配资源给实例时，优先级越高的实例越优先。

1
RequestedResource

object

资源配置。

{"CPU":"4","Memory":"8Gi","SharedMemory":"4Gi","GPU":"1","GPUType":"Tesla-V100-16G"}
CPU

string

CPU 核数。

32
Memory

string

内存大小。

32
SharedMemory

string

共享内存大小。

32
GPU

string

GPU 数量。

4
GPUType

string

GPU 显卡类型。

NVIDIA A10
Labels

array<object>

用户自定义标签。

{'foo': 'bar'}

object

用户定义标签。

Key

string

用户定义标签键值。

stsTokenOwner
Value

string

用户定义标签值。

123xxxxxxxx
IdleInstanceCuller

object

实例闲置关机规则。

{"InstanceId":"dsw-05cefd0be2e5a278","CpuPercentThreshold":20,"GpuPercentThreshold":10,"MaxIdleTimeInMinutes":120,"IdleTimeInMinutes":30}
InstanceId

string

实例 ID。

dsw-730xxxxxxxxxx
CpuPercentThreshold

integer

CPU 使用率阈值，单位是百分比，取值 1~100，低于此值则认为实例当前处于闲置。

20
GpuPercentThreshold

integer

GPU 使用率阈值，单位是百分比，取值 1~100。如果实例为 GPU 类型，则此参数生效。CPU 和 GPU 同时低于阈值则认为指定实例处于闲置。

10
MaxIdleTimeInMinutes

integer

闲置等待时间阈值，单位是分钟。如果闲置时长超过此值，将自动停止 DSW 实例。

60
IdleTimeInMinutes

integer

实例当前闲置时长，单位是分钟。

30
InstanceSnapshotList

array<object>

实例快照列表。

[]

object

实例快照。

ImageId

string

镜像 ID。

image-05cefd0be2exxxx
ImageName

string

镜像名称。

py36_cpu_tf1.12_ubuntu
ImageUrl

string

镜像 Url。

registry.cn-shanghai.aliyuncs.com/pai_product/tensorflow:py36_cpu_tf1.12_ubuntu
RepositoryUrl

string

镜像仓库 Url。

https://cr.console.aliyun.com/repository/cn-hangzhou/zouxu/kf/images
GmtCreateTime

string

快照创建时间。

2021-01-12T14:36:01Z
GmtModifiedTime

string

快照修改时间。

2021-01-12T14:36:01Z
ReasonCode

string

实例快照错误代码。

Internal Error
ReasonMessage

string

实例快照错误消息。

ImagePullBackOff
Status

string

实例快照状态。

Pushing
CloudDisks

array<object>

实例的云盘列表

[]

object

Capacity

string

云盘容量

30Gi
SubType

string

云盘使用方式, rootfs 挂载为 rootfs

rootfs
MountPath

string

容器内挂载云盘路径

/mmt/workspace
Path

string

云盘内被挂载目录路径

/workspace
WorkspaceSource

string

工作空间指向的存储，如果不指定，则依次使用 NAS，CloudDisk 或者本地磁盘

d-123456789
Driver

string

NVIDIA 驱动配置

535.54.03
CredentialConfig CredentialConfig

Credential 注入配置。

Affinity

object

亲和性配置。

CPU

object

CPU 亲和性配置。仅支持通用计算预付费实例。

Enable

boolean

是否开启 CPU 亲和性。

true：开启。 false：不开启。

true
ImageAuth

string

用户私有镜像的账号密码信息 base64 编码后的值，密码部分会被隐藏。

aGFyYm9yYWlAeGltYWxheWE6KioqKioq
Tags

array<object>

标签列表。

object

标签信息。

TagKey

string

标签 Key。

tag1
TagValue

string

标签值。

value1
DynamicMount DynamicMount

动态挂载配置。

OversoldType

string

OversoldInfo

string

ServiceConfig

ServiceConfig

错误码

访问错误中心查看更多错误码。

变更历史

更多信息，参考变更详情。

上一篇：GetInstance - 查询实例详情下一篇：GetInstanceEvents - 获取实例的事件列表