跳到主要内容

列出实例

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),包含了用户认证信息与权限。

请求体参数

请求体包含分页参数:

字段类型必填描述
pagerobject分页配置

Pager 配置说明

字段类型必填描述
currentPagenumber当前页码(从 1 开始)
pageSizenumber每页条目数量

请求示例

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

响应字段

字段类型描述
instancesarray实例对象数组
pagerobject分页信息

实例对象

字段类型描述
instanceMetadataobject实例元数据信息
instanceSpecInfoobject实例规格信息
instanceRuntimeInfoobject实例运行时信息

实例元数据 (instanceMetadata)

字段类型描述
instanceAuthobject实例认证信息
instanceIdstring实例唯一 ID
instanceUsernamestring实例用户名

实例认证 (instanceAuth)

字段类型描述
ownerUserNamestring实例所属用户 ID

实例规格信息 (instanceSpecInfo)

字段类型描述
namestring实例名称
instanceBillingInfoobject计费信息
imageInfoobject镜像信息
instanceConfigurationobject实例配置
instanceTypeInfoobject实例类型信息
regionInfoobject区域信息
remoteStoragesarray远程存储配置
nodePortsarray节点端口配置
isSpotInstanceboolean是否为抢占式实例

计费信息 (instanceBillingInfo)

字段类型描述
chargeModestring计费模式(perHour, tidePerHour, perDay, perWeek, perMonth)
durationnumber计费时长
pricenumber单位价格
unitstring价格单位 ($)
typestring计费类型(On-Demand 等)

镜像信息 (imageInfo)

字段类型描述
architecturestring镜像架构
isPublicstring是否公开镜像
namestring镜像名称
tagsarray镜像标签
typestring镜像类型

实例配置 (instanceConfiguration)

字段类型描述
enableCommonDataboolean是否启用公共数据
enableDockerboolean是否启用 Docker
InstanceDiskAmountRequestobject磁盘配置请求
dockerStorageSizenumberDocker 存储大小(GB)
磁盘配置请求 (InstanceDiskAmountRequest)
字段类型描述
rootDiskAmountGiReqnumber根盘大小(GB)
dataDiskAmountGiReqnumber数据盘大小(GB)

实例类型信息 (instanceTypeInfo)

字段类型描述
instanceIdstring实例类型 ID
instanceTypeNamestring实例类型名称
cpuobjectCPU 配置
memoryobject内存配置
gpuobjectGPU 配置
diskobject磁盘配置
CPU 配置
字段类型描述
amountnumberCPU 核心数
typestringCPU 类型
unitstringCPU 单位
内存配置
字段类型描述
amountnumber内存大小
typestring内存类型
unitstring内存单位 (GB)
GPU 配置
字段类型描述
amountnumberGPU 数量
typestringGPU 类型
unitstringGPU 单位
磁盘配置
字段类型描述
amountnumber磁盘大小
typestring磁盘类型
unitstring磁盘单位 (GB)

区域信息 (regionInfo)

字段类型描述
domainstring域名
locationstring地理位置
namestring区域名称
sshAddressstringSSH 连接地址
valuestring区域值
regionIdstring区域 ID

节点端口 (nodePorts)

字段类型描述
portnumberNotebook 内部端口
addressstringIP 地址
nodePortnumber节点端口(对外访问)

实例运行时信息 (instanceRuntimeInfo)

字段类型描述
createAtUnixMsnumber创建时间戳(毫秒)
statusstring实例状态(Running, Stopped, Starting, StartingFailed, Initializing, InitializationFailed, Archived, Released, PullingImage, Restarting)
phasestring实例阶段
messagestring状态信息
diagnosisReasonstring诊断原因
diagnosisMessagestring诊断信息
healthyboolean是否健康
subUrlstring访问 jupyter notebook 的子路径
instanceDiskUsageInfoobject磁盘使用信息
instanceDiskAmountInfoobject磁盘总量信息
stopTimestampnumber停止时间戳
scheduledStopTimestampnumber计划停止时间戳

磁盘使用信息 (instanceDiskUsageInfo)

字段类型描述
rootDiskUsedGinumber根盘已使用大小(GB)
dataDiskUsedGinumber数据盘已使用大小(GB)

磁盘总量信息 (instanceDiskAmountInfo)

字段类型描述
rootDiskAmountGinumber根盘总大小(GB)
dataDiskAmountGinumber数据盘总大小(GB)

分页信息 (pager)

字段类型描述
currentPagenumber当前页码
pageSizenumber每页条目数
totalEntriesnumber总条目数

响应示例

成功响应

{
"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": "未登录或登录已过期,请重新登录"
}