容器列表¶

接口说明¶

功能: 获取平台容器列表
请求URI: /zsc/open/api/v1/container/list
请求方法: GET

鉴权

该接口需要通过 Basic 认证。请查看接口鉴权文档接口鉴权

请求参数¶

参数	必选	类型	说明
page	true	integer	页码
page_size	true	integer	页数

返回字段¶

返回字段	字段类型	说明
code	integer	错误码
message	string	返回信息
trace	string	请求ID
data.list[..].id	integer	容器ID
data.list[..].remark	integer	容器备注
data.list[..].name	string	容器名称
data.list[..].user_id	integer	用户ID
data.list[..].rent_type	integer	租用类型,1代表按量租赁，目前仅支持按量支付
data.list[..].auto_renew	integer	自动续费，默认关闭
data.list[..].ssh_user	string	SSH默认用户名
data.list[..].ssh_init_pass	string	SSH初始密码
data.list[..].ssh_port	integer	SSH端口
data.list[..].jupyter_token	string	JupyterLab token
data.list[..].jupyter_url	string	JupyterLab_url
data.list[..].jupyter_port	integer	JupyterLab_port
data.list[..].run_without_gpu	integer	是否无卡启动，1代表有卡启动，0代表无卡启动
data.list[..].cpu_count	integer	CPU核数
data.list[..].gpu_count	integer	GPU卡数
data.list[..].gpu_price	string	GPU价格
data.list[..].data_disk_price	string	数据盘价格
data.list[..].mem_size	integer	内存大小，单位：字节
data.list[..].system_disk_size	integer	系统盘大小，单位：字节
data.list[..].system_disk_usage	integer	系统盘用量，单位：字节
data.list[..].data_disk_size	integer	数据盘大小，单位：字节
data.list[..].data_disk_usage	integer	数据盘用量，单位：字节
data.list[..].data_disk_release_at	integer	数据盘释放时间
data.list[..].cloud_disk_size	integer	云盘大小，单位：字节
data.list[..].cloud_disk_usage	integer	云盘用量，单位：字节
data.list[..].clones	integer	克隆次数
data.list[..].status	integer	容器状态[0:已取消,1:待支付,2:已支付,3:开机中,4:初始化,5:运行中,6:正在重装,7:关机中,8:已关机,9:释放中,10:已释放]
data.list[..].status_at	string	状态更新时间
data.list[..].expire_at	integer	容器过期时间
data.list[..].template_id	integer	模板ID
data.list[..].order_id	integer	订单ID
data.list[..].gpu.model	string	显卡型号
data.list[..].gpu.tf_lops16	float	半精
data.list[..].gpu.tf_lops32	float	单精
data.list[..].gpu.mem_size	integer	显存大小，单位：字节
data.list[..].area.name	string	地区名称
data.list[..].user.name	string	子账号名称
data.list[..].machine.name	string	主机名称
data.list[..].machine.model	string	主机型号
data.list[..].machine.gpu_available	integer	GPU空闲卡数
data.list[..].machine.gpu_count	integer	GPU卡数
data.list[..].machine.data_disk_size	integer	数据盘大小，单位：字节
data.list[..].machine.data_disk_usage	integer	数据盘用量，单位：字节
data.list[..].machine.data_disk_available	integer	数据盘可扩容大小
data.list[..].machine.ended_at	string	服务期限
data.list[..].image.name	string	当前运行镜像名
data.list[..].proxies.[..]	[]	代理容器端口列表
data.list[..].proxies.[..].protocol	integer	协议[1: both,2: tcp, 3: udp]
data.list[..].proxies.[..].host_port	integer	主机映射端口
data.list[..].proxies.[..].container_port	integer	容器开放端口
data.list[..].proxies.[..].url	string	访问代理地址
data.list[..].ports.[..]	[]	端口列表
data.list[..].ports.[..].protocol	integer	协议[1: both,2: tcp, 3: udp]
data.list[..].ports.[..].container_port	integer	SSH容器端口
data.list[..].ports.[..].host_port	integer	主机映射端口
data.list[..].created_at	string	容器创建时间
data.totals	integer	容器总数

接口示例¶

请求参数示例：/zsc/open/api/v1/container/list?page=1&page_size=10

返回示例：

{
  "code": 200,
  "msg": "success",
  "trace": "acec07501e324e919f9d4aa8e381f728",
  "data": {
    "list": [
      {
        "id": 10210,
        "remark": null,
        "name": "1389587233720000",
        "user_id": 10152,
        "rent_type": 1,
        "auto_renew": 0,
        "ssh_user": "root",
        "ssh_init_pass": "1389587233720001",
        "ssh_port": 0,
        "jupyter_token": "1389587233720002",
        "jupyter_url": "https://bK5mDYxoQml8ulpo.jupyter.aohoo.cn/jupyter?token=1389587233720002&target=100.125.136.76:0",
        "jupyter_port": 0,
        "run_without_gpu": 0,
        "cpu_count": 2,
        "gpu_count": 2,
        "gpu_price": "0",
        "data_disk_price": "0",
        "mem_size": 10737418240,
        "system_disk_size": 32212254720,
        "system_disk_usage": 0,
        "data_disk_size": 53687091200,
        "data_disk_usage": 0,
        "data_disk_release_at": null,
        "cloud_disk_size": 0,
        "cloud_disk_usage": 0,
        "clones": 3,
        "status": 5,
        "status_at": "2024-04-25 15:38:43",
        "expire_at": null,
        "template_id": 50,
        "order_id": 10679,
        "gpu": {
          "model": "NVIDIA GeForce RTX 4090",
          "tf_lops16": 165.2,
          "tf_lops32": 82.58,
          "mem_size": 12884901888
        },
        "area": {
          "name": "武汉"
        },
        "user": {
          "name": "zhangsan"
        },
        "machine": {
          "name": "zscloud",
          "model": "AMD EPYC 7742 64-Core Processor",
          "gpu_available": 1,
          "gpu_count": 64,
          "data_disk_size": 1000204886016,
          "data_disk_usage": 322122547200,
          "data_disk_available": 0,
          "ended_at": "2024-06-06 15:22:40"
        },
        "image": {
          "name": "registry.gpuez.com:9443/power/jittor:cuda11.3-cudnn8-devel-ubuntu18.04-py38-jt1.3.1"
        },
        "proxies": [
          {
            "protocol": 2,
            "host_port": 30904,
            "container_port": 3333,
            "url": "https://835-nug.proxy.wh.aohoo.cn"
          }
        ],
        "ports": [
          {
            "protocol": "tcp",
            "container_port": 22,
            "host_port": 0
          },
          {
            "protocol": "tcp",
            "container_port": 8888,
            "host_port": 0
          }
        ],
        "created_at": "2024-04-25T15:38:43+08:00"
      }
    ],
    "totals": 1
  }
}