调用ListInstances，获取实例列表。

调试

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

请求头

该接口使用公共请求头，无特殊请求头。请参见公共请求参数文档。

请求语法

GET /api/v1/instances HTTP/1.1

请求参数

名称 类型 位置 是否必选 示例值 描述
InstanceNameContains String Query 否 test

实例名称关键字
InstanceStatusEquals String Query 否 Runnning

实例状态

  • Running 运行中
  • Stopped 已停止
  • Starting 启动中
  • Stopping 停止中
  • Saving 保存镜像中
  • Failed 启动失败
PageNumber String Query 否 1

当前页
PageSize String Query 否 10

每页返回的实例数
SortOrder String Query 否 Desc

排序顺序

  • Desc 逆序排列
  • Asc 升序排列
SortBy String Query 否 gmtCreate

按返回字段排序
WorkspaceIdEquals String Query 否 35412

工作空间ID过滤等于。
InWorkspace Boolean Query 否 true

在工作空间的实例中查找。

返回数据

名称 类型 示例值 描述
RequestId String 473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E

请求ID
Instances Array of Instance

实例列表
PageNumber Long 1

当前页
PageSize Long 10

每页返回的实例数
TotalCount Long 30

符合条件的实例数

示例

请求示例

GET /api/v1/instances?InstanceNameContains=test&InstanceStatusEquals=Runnning&PageNumber=1&PageSize=10&SortOrder=Desc&SortBy=gmtCreate&WorkspaceIdEquals=35412&InWorkspace=true HTTP/1.1
Host:pai-dsw.aliyuncs.com
Content-Type:application/json

正常返回示例

XML格式 

HTTP/1.1 200 OK
Content-Type:application/xml

<RequestId>473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E</RequestId>
<Instances>
    <InstanceId>dsw-d7adefa77718****</InstanceId>
    <InstanceName>test</InstanceName>
    <EcsSpec>ecs规格</EcsSpec>
    <InstanceStatus>Running</InstanceStatus>
    <JupyterlabUrl>https://dsw-gateway-cn-beijing.aliyun.com/dsw-****/lab/</JupyterlabUrl>
    <WebIdeUrl>https://dsw-gateway-cn-beijing.aliyun.com/dsw-****/ide/</WebIdeUrl>
    <TerminalUrl>https://dsw-gateway-cn-beijing.aliyun.com/dsw-****/terminals/tty</TerminalUrl>
    <AccumulativeRunningTimeInMinutes>10</AccumulativeRunningTimeInMinutes>
    <ImageId>img-d7adefa77718*****</ImageId>
    <ImageUrl>registry.cn-shanghai.aliyuncs.com/pai_product/image:pai-images-dsw-ubuntu18.04-py3.6-paitf1.15-build.****</ImageUrl>
    <GmtCreateTime>2021-04-01T00:00:00Z</GmtCreateTime>
    <GmtModifiedTime>2021-04-02T00:00:00Z</GmtModifiedTime>
    <UserId>161228528250****</UserId>
    <NasFileSystemId>0051a4****</NasFileSystemId>
    <UserVpc>
        <VpcId>vpc-bp1i4x5wj2kgro93l****</VpcId>
        <VswitchId>vsw-bp1irltu139f5qufw****</VswitchId>
        <RoleArn>acs:ram::123456789012****:role/appserverrole</RoleArn>
        <SecurityGroupId>sg-bp10mttdnsk58y5n****</SecurityGroupId>
    </UserVpc>
    <InstanceShutdownTimer>
        <InstanceId>dsw-d7adefa77718****</InstanceId>
        <ScheduleTime>2021-04-01T01:00:00Z</ScheduleTime>
        <GmtModifiedTime>2021-04-01T00:00:00Z</GmtModifiedTime>
        <GmtCreateTime>2021-04-01T00:00:00Z</GmtCreateTime>
    </InstanceShutdownTimer>
</Instances>
<PageNumber>1</PageNumber>
<PageSize>10</PageSize>
<TotalCount>30</TotalCount>

JSON格式 

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
  "Instances" : [ {
    "InstanceId" : "dsw-d7adefa77718****",
    "InstanceName" : "test",
    "EcsSpec" : "ecs规格",
    "InstanceStatus" : "Running",
    "JupyterlabUrl" : "https://dsw-gateway-cn-beijing.aliyun.com/dsw-****/lab/",
    "WebIdeUrl" : "https://dsw-gateway-cn-beijing.aliyun.com/dsw-****/ide/",
    "TerminalUrl" : "https://dsw-gateway-cn-beijing.aliyun.com/dsw-****/terminals/tty",
    "AccumulativeRunningTimeInMinutes" : 10,
    "ImageId" : "img-d7adefa77718*****",
    "ImageUrl" : "registry.cn-shanghai.aliyuncs.com/pai_product/image:pai-images-dsw-ubuntu18.04-py3.6-paitf1.15-build.****",
    "GmtCreateTime" : "2021-04-01T00:00:00Z",
    "GmtModifiedTime" : "2021-04-02T00:00:00Z",
    "UserId" : "161228528250****",
    "NasFileSystemId" : "0051a4****",
    "UserVpc" : {
      "VpcId" : "vpc-bp1i4x5wj2kgro93l****",
      "VswitchId" : "vsw-bp1irltu139f5qufw****",
      "RoleArn" : "acs:ram::123456789012****:role/appserverrole",
      "SecurityGroupId" : "sg-bp10mttdnsk58y5n****"
    },
    "InstanceShutdownTimer" : {
      "InstanceId" : "dsw-d7adefa77718****",
      "ScheduleTime" : "2021-04-01T01:00:00Z",
      "GmtModifiedTime" : "2021-04-01T00:00:00Z",
      "GmtCreateTime" : "2021-04-01T00:00:00Z"
    }
  } ],
  "PageNumber" : 1,
  "PageSize" : 10,
  "TotalCount" : 30
}

错误码

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