ListInstances_人工智能平台 PAI - 交互式建模_API文档

插件下载了解更多
VS Code 插件
安装插件之前,确保已安装 VS Code安装插件之前,确保已安装 VS Code
Alibaba Cloud Developer Toolkit is a collection of extensions that can help access Alibaba Cloud services in Visual Studio Code.
JetBrains 插件
安装插件之前,确保已安装 JetBrains IDE安装插件之前,确保已安装 JetBrains IDE
The Alibaba Cloud Developer Toolkit for JetBrains makes it easier to access Alibaba Cloud services.

流控信息

请求速率为100/1(s)。

授权信息

如下是此API对应的授权信息,用于RAM权限策略语句的Action元素中,为RAM用户或RAM角色授予调用此API的权限。请通过 RAM 访问控制设置,使用方法可参考访问控制帮助文档

具体说明如下:展开详情

操作访问级别资源类型条件关键字关联操作
paidsw:ListInstances
Get
全部资源
*

请求语法

GET /api/v2/instances HTTP/1.1

请求参数

字段名称字段详情
WorkspaceIdstring

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

示例值:40823
InstanceNamestring

按实例名称过滤。

示例值:training_data参考取值来源:
    GetInstance
ResourceIdstring

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

示例值:ALL
Statusstring

根据实例状态过滤。

示例值:Running枚举值:CreatingSaveFailedStoppedFailedResourceAllocatingStoppingUpdatingSavingQueuingRecoveringStartingRunningSavedDeletingEnvPreparing
PaymentTypestring

付费类型。

示例值:PayAsYouGo枚举值:PayAsYouGoSubscription
Accessibilitystring

工作空间可见度。取值如下:展开详情

示例值:PRIVATE
AcceleratorTypestring

加速器类型。展开详情

示例值:CPU枚举值:CPUGPU
PageNumberinteger<int64>

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

注意 该字段类型为 Long,在序列化/反序列化的过程中可能导致精度丢失,请注意数值不得大于 9007199254740991。
示例值:1
PageSizeinteger<int64>

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

注意 该字段类型为 Long,在序列化/反序列化的过程中可能导致精度丢失,请注意数值不得大于 9007199254740991。
示例值:10
SortBystring

排序字段。

示例值:GmtCreateTime枚举值:PriorityGmtCreateTimeGmtModifiedTime
Orderstring

排列顺序。

示例值:DESC枚举值:ASCDESC
InstanceIdstring

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

示例值:dsw-730xxxxxxxxxx参考取值来源:
    UpdateInstance
    StopInstance
    StartInstance
    CreateInstance
Labelsobject

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

示例值:{ "key1": "value1", "key2": "value2", "key3": "value3" }
CreateUserIdstring

创建人的 UserId

示例值:12345*****67890
GpuTypestring

GPU 型号。

示例值:NVIDIA A10
MinCpustring

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

示例值:2000
MaxCpustring

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

示例值:30000
MinGpustring

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

示例值:100
MaxGpustring

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

示例值:8000
MinMemorystring

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

示例值:4
MaxMemorystring

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

示例值:48
MinGpuMemorystring

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

示例值:8
MaxGpuMemorystring

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

示例值:16
ImageNamestring

镜像名

示例值:modelscope:1.9.4-pytorch2.0.1tensorflow2.13.0-cpu-py38-ubuntu20.04
Tagarray<object>

标签列表。

OversoldInfostring
OversoldTypestring

返回参数

字段名称字段详情
RequestIdstring

请求 ID。

示例值:E7D55162-4489-1619-AAF5-3F97D5FCA948
Successboolean

成功标志,可能值:展开详情

示例值:true
Messagestring

返回结果说明。

示例值:"XXX"
Codestring

状态码,可能值:展开详情

示例值:null
HttpStatusCodeinteger<int32>

HTTP 状态码,可能值:展开详情

示例值:null
TotalCountinteger<int64>

实例总数。

注意 请注意,该值为 Long 类型,在某些语言中可能存在精度丢失的风险,请小心使用。
示例值:35
Instancesarray<object>

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

返回示例

变更历史

变更时间变更内容概要操作
2025-04-18
新增请求参数OversoldInfo
新增请求参数OversoldType
变更返回参数
2025-03-13
变更返回参数
2025-03-12
变更返回参数
2025-02-28
变更返回参数
2024-11-27
新增请求参数Tag
变更返回参数
2024-09-10
变更返回参数
2024-08-14
新增请求参数GpuType
新增请求参数MinCpu
新增请求参数MaxCpu
新增请求参数MinGpu
新增请求参数MaxGpu
新增请求参数MinMemory
新增请求参数MaxMemory
新增请求参数MinGpuMemory
新增请求参数MaxGpuMemory
新增请求参数ImageName
2024-07-25
新增请求参数CreateUserId
2024-07-09
变更返回参数

相关示例