列出实例

POST

/instance/list

列出当前用户的所有实例。

鉴权说明

你可以在请求头中找到 AccessToken，也可以直接从网页上复制（Auth Token）。该 Token 在你每次登录时生成，并且一天后过期。
你也可以通过调用登录接口获取新的 Token。

请求时需要把 AccessToken 作为 Cookie 传递。在下方的 cURL 示例中，可以看到使用 -b 传递 Token 的方式：

-b 'AccessToken=your_token_here'

注意：请将 your_token_here 替换为你实际的 AccessToken。该 Token 是一个 JWT (JSON Web Token)，包含了用户认证信息与权限。

请求体参数

请求体包含分页参数：

字段	类型	必填	描述
`pager`	object	是	分页配置

字段	类型	必填	描述
`currentPage`	number	是	当前页码（从 1 开始）
`pageSize`	number	是	每页条目数量

请求示例

{
  "pager": {
    "currentPage": 1,
    "pageSize": 10
  }
}

cURL 示例

curl 'https://cloud.luchentech.com/api/instance/list' \
  -H 'content-type: application/json' \
  -b 'AccessToken=your_token_here' \
  --data-raw '{"pager":{"currentPage":1,"pageSize":10}}'

响应字段

字段	类型	描述
`instances`	array	实例对象数组
`pager`	object	分页信息

实例对象

字段	类型	描述
`instanceMetadata`	object	实例元数据信息
`instanceSpecInfo`	object	实例规格信息
`instanceRuntimeInfo`	object	实例运行时信息

实例元数据 (instanceMetadata)

字段	类型	描述
`instanceAuth`	object	实例认证信息
`instanceId`	string	实例唯一 ID
`instanceUsername`	string	实例用户名

实例认证 (instanceAuth)

字段	类型	描述
`ownerUserName`	string	实例所属用户 ID

实例规格信息 (instanceSpecInfo)

字段	类型	描述
`name`	string	实例名称
`instanceBillingInfo`	object	计费信息
`imageInfo`	object	镜像信息
`instanceConfiguration`	object	实例配置
`instanceTypeInfo`	object	实例类型信息
`regionInfo`	object	区域信息
`remoteStorages`	array	远程存储配置
`nodePorts`	array	节点端口配置
`isSpotInstance`	boolean	是否为抢占式实例

计费信息 (instanceBillingInfo)

字段	类型	描述
`chargeMode`	string	计费模式（perHour, tidePerHour, perDay, perWeek, perMonth）
`duration`	number	计费时长
`price`	number	单位价格
`unit`	string	价格单位 ($)
`type`	string	计费类型（On-Demand 等）

镜像信息 (imageInfo)

字段	类型	描述
`architecture`	string	镜像架构
`isPublic`	string	是否公开镜像
`name`	string	镜像名称
`tags`	array	镜像标签
`type`	string	镜像类型

实例配置 (instanceConfiguration)

字段	类型	描述
`enableCommonData`	boolean	是否启用公共数据
`enableDocker`	boolean	是否启用 Docker
`InstanceDiskAmountRequest`	object	磁盘配置请求
`dockerStorageSize`	number	Docker 存储大小（GB）

磁盘配置请求 (InstanceDiskAmountRequest)

字段	类型	描述
`rootDiskAmountGiReq`	number	根盘大小（GB）
`dataDiskAmountGiReq`	number	数据盘大小（GB）

实例类型信息 (instanceTypeInfo)

字段	类型	描述
`instanceId`	string	实例类型 ID
`instanceTypeName`	string	实例类型名称
`cpu`	object	CPU 配置
`memory`	object	内存配置
`gpu`	object	GPU 配置
`disk`	object	磁盘配置

CPU 配置

字段	类型	描述
`amount`	number	CPU 核心数
`type`	string	CPU 类型
`unit`	string	CPU 单位

内存配置

字段	类型	描述
`amount`	number	内存大小
`type`	string	内存类型
`unit`	string	内存单位 (GB)

GPU 配置

字段	类型	描述
`amount`	number	GPU 数量
`type`	string	GPU 类型
`unit`	string	GPU 单位

磁盘配置

字段	类型	描述
`amount`	number	磁盘大小
`type`	string	磁盘类型
`unit`	string	磁盘单位 (GB)

区域信息 (regionInfo)

字段	类型	描述
`domain`	string	域名
`location`	string	地理位置
`name`	string	区域名称
`sshAddress`	string	SSH 连接地址
`value`	string	区域值
`regionId`	string	区域 ID

节点端口 (nodePorts)

字段	类型	描述
`port`	number	Notebook 内部端口
`address`	string	IP 地址
`nodePort`	number	节点端口（对外访问）

实例运行时信息 (instanceRuntimeInfo)

字段	类型	描述
`createAtUnixMs`	number	创建时间戳（毫秒）
`status`	string	实例状态（Running, Stopped, Starting, StartingFailed, Initializing, InitializationFailed, Archived, Released, PullingImage, Restarting）
`phase`	string	实例阶段
`message`	string	状态信息
`diagnosisReason`	string	诊断原因
`diagnosisMessage`	string	诊断信息
`healthy`	boolean	是否健康
`subUrl`	string	访问 jupyter notebook 的子路径
`instanceDiskUsageInfo`	object	磁盘使用信息
`instanceDiskAmountInfo`	object	磁盘总量信息
`stopTimestamp`	number	停止时间戳
`scheduledStopTimestamp`	number	计划停止时间戳

磁盘使用信息 (instanceDiskUsageInfo)

字段	类型	描述
`rootDiskUsedGi`	number	根盘已使用大小（GB）
`dataDiskUsedGi`	number	数据盘已使用大小（GB）

磁盘总量信息 (instanceDiskAmountInfo)

字段	类型	描述
`rootDiskAmountGi`	number	根盘总大小（GB）
`dataDiskAmountGi`	number	数据盘总大小（GB）

字段	类型	描述
`currentPage`	number	当前页码
`pageSize`	number	每页条目数
`totalEntries`	number	总条目数

响应示例

成功响应

{
  "instances": [
    {
      "instanceMetadata": {
        "instanceAuth": {
          "ownerUserName": "08f6f261-xxxx-xxxx-xxxx-85e6ae32f492"
        },
        "instanceId": "notebook-5ac72ea0-xxxx-xxxx-xxxx-eea5891c2019",
        "instanceUsername": "username"
      },
      "instanceSpecInfo": {
        "name": "example-instance",
        "instanceBillingInfo": {
          "chargeMode": "perHour",
          "duration": 1,
          "price": 0.23999999463558197,
          "unit": "$",
          "type": "On-Demand"
        },
        "imageInfo": {
          "architecture": "",
          "isPublic": "",
          "name": "",
          "tags": null,
          "type": ""
        },
        "instanceConfiguration": {
          "enableCommonData": false,
          "enableDocker": false,
          "InstanceDiskAmountRequest": {
            "rootDiskAmountGiReq": 0,
            "dataDiskAmountGiReq": 0
          },
          "dockerStorageSize": 0
        },
        "instanceTypeInfo": {
          "instanceId": "ee90dd8f-xxxx-xxxx-xxxx-c3ff72915722",
          "instanceTypeName": "",
          "cpu": {
            "amount": 8,
            "type": "INTEL(R) XEON(R) PLATINUM 8558",
            "unit": ""
          },
          "memory": {
            "amount": 16,
            "type": "",
            "unit": "GB"
          },
          "gpu": {
            "amount": 0,
            "type": "",
            "unit": ""
          },
          "disk": {
            "amount": 50,
            "type": "nvme",
            "unit": "GB"
          }
        },
        "regionInfo": {
          "domain": "asia-sg-1.cloud.luchentech.com",
          "location": "Asia,Singapore",
          "name": "asia-sg-1",
          "sshAddress": "122.xx.xx.202",
          "value": "",
          "regionId": "fce31a0c-xxxx-xxxx-xxxx-41caa1bdd251"
        },
        "remoteStorages": [],
        "nodePorts": [
          {
            "port": 22,
            "address": "122.xx.xx.202",
            "nodePort": 31674
          }
        ],
        "isSpotInstance": false
      },
      "instanceRuntimeInfo": {
        "createAtUnixMs": 1751527726179,
        "status": "Running",
        "phase": "",
        "message": "",
        "diagnosisReason": "",
        "diagnosisMessage": "",
        "healthy": true,
        "subUrl": "/notebook/notebook-5ac72ea0-xxxx-xxxx-xxxx-eea5891c2019/notebook-5ac72ea0-xxxx-xxxx-xxxx-eea5891c2019-0",
        "instanceDiskUsageInfo": {
          "rootDiskUsedGi": 2.48,
          "dataDiskUsedGi": 0
        },
        "instanceDiskAmountInfo": {
          "rootDiskAmountGi": 50,
          "dataDiskAmountGi": 50
        },
        "stopTimestamp": 0,
        "scheduledStopTimestamp": 0
      }
    }
  ],
  "pager": {
    "currentPage": 1,
    "pageSize": 3,
    "totalEntries": 92
  }
}

失败响应

{
  "code": -1,
  "message": "未登录或登录已过期，请重新登录"
}

鉴权说明​

请求体参数​

Pager 配置说明​

请求示例​

cURL 示例​

响应字段​

实例对象​

实例元数据 (instanceMetadata)​

实例认证 (instanceAuth)​

实例规格信息 (instanceSpecInfo)​

计费信息 (instanceBillingInfo)​

镜像信息 (imageInfo)​

实例配置 (instanceConfiguration)​

磁盘配置请求 (InstanceDiskAmountRequest)​

实例类型信息 (instanceTypeInfo)​

CPU 配置​

内存配置​

GPU 配置​

磁盘配置​

区域信息 (regionInfo)​

节点端口 (nodePorts)​

实例运行时信息 (instanceRuntimeInfo)​

磁盘使用信息 (instanceDiskUsageInfo)​

磁盘总量信息 (instanceDiskAmountInfo)​

分页信息 (pager)​

响应示例​

成功响应​

失败响应​