ListInstances - 查询实例列表

查询DSW实例列表。

调试

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

授权信息

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

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
paidsw:ListInstancesget
*全部资源
*

请求语法

GET /api/v2/instances HTTP/1.1

请求参数

名称类型必填描述示例值
WorkspaceIdstring

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

40823
InstanceNamestring

按实例名称过滤。

training_data
ResourceIdstring

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

rg-123456789
Statusstring

根据实例状态过滤,取值如下:

  • Creating:创建中。
  • Running:运行中。
  • Stopped:已停止。
  • Failed:已失败。
Running
PaymentTypestring

付费类型,取值如下:

  • PayAsYouGo:后付费(后付费/按量付费)。
  • Subscription:预付费(预付费/包年包月)。
PayAsYouGo
Accessibilitystring

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

  • PRIVATE(默认值):表示工作空间内自己以及管理员可见。
  • PUBLIC:为工作空间所有用户可见。
PRIVATE
AcceleratorTypestring

加速器类型。 CPU:无计算加速,只使用 CPU 计算。 GPU:使用 GPU 进行计算加速。

CPU
PageNumberlong

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

1
PageSizelong

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

10
SortBystring

按字段 gmtCreate 排序。

gmtCreate
Orderstring

排列顺序。取值如下:

  • DESC:降序。
  • ASC:升序。
DESC
InstanceIdstring

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

dsw-730xxxxxxxxxx
Labelsobject

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

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

创建人的 UserId

GpuTypestring

Gpu 类型

ImageNamestring

镜像名

返回参数

名称类型描述示例值
object

实例列表。

RequestIdstring

请求 ID。

E7D55162-4489-1619-AAF5-3F97D5FCA948
Successboolean

成功标志,可能值:

  • true
  • false
true
Messagestring

返回结果说明。

"XXX"
Codestring

状态码,可能值:

  • InternalError:内部错误(除了参数验证错误外的其他错误,目前都归类到内部错误)。
  • ValidationError:参数验证错误。
null
HttpStatusCodeinteger

HTTP 状态码,可能值:

  • 400
  • 404
null
TotalCountlong

实例总数。

35
Instancesarray<object>

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

Instanceobject

实例对象。

WorkspaceIdstring

工作空间 ID。

40823
WorkspaceNamestring

工作空间名称。

training_data
InstanceIdstring

实例 ID。

dsw-730xxxxxxxxxx
InstanceNamestring

实例名称。

training_data
EcsSpecstring

实例对应的 ECS 规格。

ecs.c6.large
Statusstring

实例状态。

Running
InstanceUrlstring

实例 Url。

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

Jupyterlab Url。

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

Web IDE url。

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

终端 url。

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

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

3600000
ImageIdstring

镜像 ID。

image-05cefd0be2exxxx
ImageUrlstring

镜像地址。

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

镜像名称。

py36_cpu_tf1.12_ubuntu
GmtCreateTimestring

实例创建时间。

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

实例修改时间。

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

用户 ID。

1612285282502324
UserNamestring

用户名称。

测试用户
Datasetsarray<object>

数据集集合。

Datasetobject

数据集对象

DatasetIdstring

数据集 ID。

d-vsqjvsjp4orp5l206u
MountPathstring

容器内挂载路径。

/mnt/data
Uristring

指定的数据集的 Uri。

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

数据集的挂载属性。

{ "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" }
OptionTypestring

挂载配置项类型

FastReadWrite
UserVpcobject

User VPC 配置。

VpcIdstring

VPC ID。

vpc-xxxxx
VSwitchIdstring

交换机 ID。

vsw-xxxxx
SecurityGroupIdstring

安全组 ID。

sg-xxxxxx
ExtendedCIDRsarray

扩展网络打通网段列表

ExtendedCIDRstring

扩展网络打通网段

192.168.0.1/24
DefaultRoutestring

Default Route

eth0 | eth1
ForwardInfosarray

端口透出信息。

ForwardInfoForwardInfoResponse

端口透出信息列表。

InstanceShutdownTimerobject

定时关机任务。

InstanceIdstring

实例 ID。

dsw-730xxxxxxxxxx
GmtCreateTimestring

创建时间。

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

修改时间。

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

设定关机时间。

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

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

3600000
ReasonCodestring

实例错误代码。

Internal Error
ReasonMessagestring

实例错误原因。

ImagePullBackOff
PaymentTypestring

支付类型,可能值:

  • PayAsYouGo:后付费(后付费/按量付费)。
  • Subscription:预付费(预付费/包年包月)。
PayAsYouGo
LatestSnapshotobject

最新保存的用户镜像。

ImageIdstring

镜像 ID。

image-05cefd0be2exxxx
ImageNamestring

镜像名称。

py36_cpu_tf1.12_ubuntu
ImageUrlstring

镜像 Url。

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

镜像仓库 Url。

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

快照创建时间。

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

快照修改时间。

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

实例快照错误代码。

Internal Error
ReasonMessagestring

实例快照错误消息。

ImagePullBackOff
Statusstring

实例快照状态。

Pushing
AcceleratorTypestring

实例计算类型。可能值:

  • CPU
  • GPU
CPU
Accessibilitystring

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

  • PRIVATE(默认值):表示工作空间内自己以及管理员可见。
  • PUBLIC:为工作空间所有用户可见。
PRIVATE
EnvironmentVariablesobject

环境变量。

string

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

MAAS
ResourceIdstring

资源 ID,预付费时填写。

dsw-123456789
ResourceNamestring

资源规格。

  • 后付费场景,资源规格为购买的 ECS 规格。
  • 预付费场景,资源规格为请求的 CPU 核数与内存大小。
resource_group
Prioritylong

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

1
RequestedResourceobject

资源配置,弹内或者轻量化时使用。

CPUstring

CPU 核数。

32
Memorystring

内存大小。

32
SharedMemorystring

共享内存大小。

32
GPUstring

GPU 数量。

4
GPUTypestring

GPU 显卡类型。

v100
Labelsarray<object>

用户自定义标签。

{'foo': 'bar'}
Labelobject

用户定义标签。

Keystring

用户定义标签键值。

stsTokenOwner
Valuestring

用户定义标签值。

123xxxxxxxx
IdleInstanceCullerobject

实例闲置关机规则。

InstanceIdstring

实例 ID。

dsw-730xxxxxxxxxx
CpuPercentThresholdinteger

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

20
GpuPercentThresholdinteger

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

10
MaxIdleTimeInMinutesinteger

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

60
IdleTimeInMinutesinteger

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

30
InstanceSnapshotListarray<object>

实例快照列表。

[]
InstanceSnapshotListobject

实例快照。

ImageIdstring

镜像 ID。

image-05cefd0be2exxxx
ImageNamestring

镜像名称。

py36_cpu_tf1.12_ubuntu
ImageUrlstring

镜像 Url。

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

镜像仓库 Url。

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

快照创建时间。

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

快照修改时间。

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

实例快照错误代码。

Internal Error
ReasonMessagestring

实例快照错误消息。

ImagePullBackOff
Statusstring

实例快照状态。

Pushing
CloudDisksarray<object>

实例的云盘列表

[]
CloudDiskobject
Capacitystring

云盘容量

30Gi
SubTypestring

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

rootfs
MountPathstring

容器内挂载云盘路径

/mmt/workspace
Pathstring

云盘内被挂载目录路径

/workspace
WorkspaceSourcestring

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

d-123456789
Driverstring

NVIDIA 驱动配置

535.54.03
CredentialConfigCredentialConfig

Credential 注入配置。

Affinityobject

亲和性配置。

CPUobject

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

Enableboolean

是否开启 CPU 亲和性。

true:开启。 false:不开启。

true
ImageAuthstring

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

示例

正常返回示例

JSON格式

{
  "RequestId": "E7D55162-4489-1619-AAF5-3F97D5FCA948",
  "Success": true,
  "Message": "\"XXX\"",
  "Code": "null",
  "HttpStatusCode": 0,
  "TotalCount": 35,
  "Instances": [
    {
      "WorkspaceId": "40823",
      "WorkspaceName": "training_data",
      "InstanceId": "dsw-730xxxxxxxxxx",
      "InstanceName": "training_data",
      "EcsSpec": "ecs.c6.large",
      "Status": "Running",
      "InstanceUrl": "https://dsw-cn-shanghai.data.aliyun.com/notebook.htm?instance=39772#/",
      "JupyterlabUrl": "https://dsw-gateway-cn-shanghai.aliyun.com/dsw-39772/lab/",
      "WebIDEUrl": "https://dsw-gateway-cn-shanghai.aliyun.com/dsw-39772/ide/",
      "TerminalUrl": "https://dsw-gateway-cn-shanghai.aliyun.com/dsw-39772/tty/",
      "AccumulatedRunningTimeInMs": 3600000,
      "ImageId": "image-05cefd0be2exxxx",
      "ImageUrl": "registry.cn-shanghai.aliyuncs.com/pai_product/tensorflow:py36_cpu_tf1.12_ubuntu",
      "ImageName": "py36_cpu_tf1.12_ubuntu",
      "GmtCreateTime": "2021-01-12T14:36:01Z",
      "GmtModifiedTime": "2021-01-12T14:36:01Z",
      "UserId": "1612285282502324",
      "UserName": "测试用户",
      "Datasets": [
        {
          "DatasetId": "d-vsqjvsjp4orp5l206u",
          "MountPath": "/mnt/data",
          "Uri": "oss://bucket-name.oss-cn-shanghai-internal.aliyuncs.com/data/path/",
          "Options": "{\n  \"fs.oss.download.thread.concurrency\": \"10\",\n  \"fs.oss.upload.thread.concurrency\": \"10\",\n  \"fs.jindo.args\": \"-oattr_timeout=3 -oentry_timeout=0 -onegative_timeout=0 -oauto_cache -ono_symlink\"\n}",
          "OptionType": "FastReadWrite"
        }
      ],
      "UserVpc": {
        "VpcId": "vpc-xxxxx",
        "VSwitchId": "vsw-xxxxx",
        "SecurityGroupId": "sg-xxxxxx",
        "ExtendedCIDRs": [
          "192.168.0.1/24"
        ],
        "DefaultRoute": "eth0 | eth1",
        "ForwardInfos": [
          {
            "Enable": true,
            "ContainerName": "dsw-notebook",
            "ForwardPort": "22",
            "NatGatewayId": "ngw-bp1uewa15k4iy5770****",
            "EipAllocationId": "eip-25877c70gddh****",
            "SSHPublicKey": "",
            "ConnectInfo": {
              "Phase": "Ready",
              "Message": "DNAT and privateZone are both ready.",
              "Intranet": {
                "Endpoint": "dsw-notebook-22-urz3u6cnu0uts7ej9r.dsw-5cc6083084818f60.dsw.pai.alibaba.com",
                "Port": "22"
              },
              "Internet": {
                "Endpoint": "47.111.119.114",
                "Port": "22"
              }
            },
            "Name": "ssh",
            "ExternalPort": "1024",
            "AccessType": [
              "intranet"
            ]
          }
        ]
      },
      "InstanceShutdownTimer": {
        "InstanceId": "dsw-730xxxxxxxxxx",
        "GmtCreateTime": "2021-01-12T14:36:01Z",
        "GmtModifiedTime": "2021-01-12T14:36:01Z",
        "DueTime": "2021-01-12T14:36:01Z",
        "RemainingTimeInMs": 3600000
      },
      "ReasonCode": "Internal Error",
      "ReasonMessage": "ImagePullBackOff",
      "PaymentType": "PayAsYouGo",
      "LatestSnapshot": {
        "ImageId": "image-05cefd0be2exxxx",
        "ImageName": "py36_cpu_tf1.12_ubuntu",
        "ImageUrl": "registry.cn-shanghai.aliyuncs.com/pai_product/tensorflow:py36_cpu_tf1.12_ubuntu",
        "RepositoryUrl": "https://cr.console.aliyun.com/repository/cn-hangzhou/zouxu/kf/images",
        "GmtCreateTime": "2021-01-12T14:36:01Z",
        "GmtModifiedTime": "2021-01-12T14:36:01Z",
        "ReasonCode": "Internal Error",
        "ReasonMessage": "ImagePullBackOff",
        "Status": "Pushing"
      },
      "AcceleratorType": "CPU",
      "Accessibility": "PRIVATE",
      "EnvironmentVariables": {
        "key": "MAAS"
      },
      "ResourceId": "dsw-123456789",
      "ResourceName": "resource_group",
      "Priority": 1,
      "RequestedResource": {
        "CPU": "32",
        "Memory": "32",
        "SharedMemory": "32",
        "GPU": "4",
        "GPUType": "v100"
      },
      "Labels": [
        {
          "Key": "stsTokenOwner",
          "Value": "123xxxxxxxx"
        }
      ],
      "IdleInstanceCuller": {
        "InstanceId": "dsw-730xxxxxxxxxx",
        "CpuPercentThreshold": 20,
        "GpuPercentThreshold": 10,
        "MaxIdleTimeInMinutes": 60,
        "IdleTimeInMinutes": 30
      },
      "InstanceSnapshotList": [
        {
          "ImageId": "image-05cefd0be2exxxx",
          "ImageName": "py36_cpu_tf1.12_ubuntu",
          "ImageUrl": "registry.cn-shanghai.aliyuncs.com/pai_product/tensorflow:py36_cpu_tf1.12_ubuntu",
          "RepositoryUrl": "https://cr.console.aliyun.com/repository/cn-hangzhou/zouxu/kf/images",
          "GmtCreateTime": "2021-01-12T14:36:01Z",
          "GmtModifiedTime": "2021-01-12T14:36:01Z",
          "ReasonCode": "Internal Error",
          "ReasonMessage": "ImagePullBackOff",
          "Status": "Pushing"
        }
      ],
      "CloudDisks": [
        {
          "Capacity": "30Gi",
          "SubType": "rootfs",
          "MountPath": "/mmt/workspace",
          "Path": "/workspace"
        }
      ],
      "WorkspaceSource": "d-123456789",
      "Driver": "535.54.03",
      "CredentialConfig": {
        "Enable": true,
        "AliyunEnvRoleKey": "0",
        "Configs": [
          {
            "Key": "0",
            "Type": "Role",
            "Roles": [
              {
                "RoleArn": "acs:ram::123******:role/****",
                "RoleType": "service",
                "AssumeRoleFor": "123******",
                "Policy": "{}",
                "UserInfo": {
                  "Id": "456******",
                  "Type": "S",
                  "AccessKeyId": "LT********",
                  "SecurityToken": "********"
                }
              }
            ]
          }
        ]
      },
      "Affinity": {
        "CPU": {
          "Enable": true
        }
      },
      "ImageAuth": "",
      "Tags": [
        {
          "TagKey": "",
          "TagValue": ""
        }
      ]
    }
  ]
}

错误码

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

变更历史

变更时间变更内容概要操作
2024-09-10OpenAPI 返回结构发生变更查看变更详情
2024-08-14OpenAPI 入参发生变更查看变更详情
2024-07-25OpenAPI 入参发生变更查看变更详情
2024-07-09OpenAPI 返回结构发生变更查看变更详情
2024-06-24API 内部配置变更,不影响调用查看变更详情
2024-06-04OpenAPI 入参发生变更、OpenAPI 返回结构发生变更查看变更详情
2023-12-27OpenAPI 返回结构发生变更查看变更详情
2023-11-14OpenAPI 返回结构发生变更查看变更详情
2023-08-08OpenAPI 返回结构发生变更查看变更详情
2023-07-25OpenAPI 返回结构发生变更查看变更详情
2023-06-09OpenAPI 返回结构发生变更查看变更详情
2023-05-06OpenAPI 返回结构发生变更查看变更详情
2022-01-20OpenAPI 返回结构发生变更查看变更详情
2022-01-20OpenAPI 返回结构发生变更查看变更详情