Skip to content
导航

读取文件

文件的全部或部分字节，一次调用可以读取任意长度。不超过 1 MiB 的文件（或所请求的部分）直接返回；更长的则边读边从沙箱传给调用方，一次一段，守护进程只持有其中有限的一段，从不持有全部：先给出长度（Content-Length：查看时文件从 offset 起、最多到 length 的内容长度），连接会保留给下一个请求。如果文件在读取过程中变短，响应会在达到该长度之前结束，连接也随之关闭（如果在发送任何内容之前就发现，则返回 409 file_changed）：请重新读取。只读取普通文件：管道、套接字或设备返回 409 not_a_regular_file。路径都是绝对路径。操作以运行命令的用户身份执行，或以 user 的身份执行：该用户无权做的操作会被拒绝 (403)，创建的东西归该用户所有。

所需权限范围：files，或带 files 的沙箱令牌。

GET
https://api.glac.ai/v1/sandboxes/{id}/files

授权

  • apiKeyoptionalHTTP
  • sandboxTokenoptionalHTTP Bearer (st_<payload>.<signature>)
  • sandboxTokenInQueryoptionalAPI key in query

路径参数

  • idstringrequired

    沙箱的 id (sbx-…) 或名称。

查询参数

  • pathstringrequired

    沙箱中的绝对路径，最多 4096 字节。

  • offsetoptionalinteger

    从这个字节开始。

    format: int64 · minimum: 0 · default: 0
  • lengthoptionalinteger

    最多读取的字节数。默认：一直读到文件末尾，无论多长。

    format: int64 · minimum: 0
  • useroptionalstring

    以此用户身份执行：用户名、uid 或 uid:gid。默认：运行命令的用户。

    maxLength: 64 · minLength: 1

请求头参数

  • X-Request-Idoptionalstring

    调用方为请求自定的 id：1 到 64 个字母、数字、.、_ 和 -。节点随后以它标识该请求：出现在响应的 X-Request-Id、错误响应体和节点日志中。其他任何值都会被忽略，由节点生成 id。

    pattern: ^[A-Za-z0-9._\-]{1,64}$

Returns

200

字节内容，始终为 application/octet-stream。offset 位于或超过文件末尾时为空。

400

请求不符合本调用的要求。missing_path：缺少路径；invalid_path：路径不是绝对路径，或者文件系统不接受该路径；name_too_long：路径中某个名称超出了文件系统允许的长度（255 字节）；invalid_field：某个字段或查询参数类型错误或超出范围；unknown_parameter：查询中有本调用不接受的参数；no_such_user：user 不是沙箱中的用户。
JSON
  • errorobjectrequired
    • typestringrequired

      失败的类别。它决定状态码：invalid_request 400、unauthenticated 401、forbidden 403、not_found 404、conflict 409、too_large 413、internal 500、bad_gateway 502（预览监听器、出站代理，以及无法带回其沙箱的接管）、unavailable 503、timeout 504。

    • codestringrequired

      具体是哪种失败。本文档顶层的 x-error-codes 表说明了每一个的含义。

    • messagestringrequired

      给人看的说明。英文。

    • paramstring | nullrequired

      出错的字段或查询参数（如果有）。

    • retryablebooleanrequired

      在其他条件都不变的情况下，同一请求稍后可能成功时为 true。

    • request_idstringrequired

      所在响应的 X-Request-Id，响应是针对 Idempotency-Key 的重放时也一样。

      pattern: ^[A-Za-z0-9._\-]{1,64}$
    • docs_urlstring | nullrequired

      节点的 --docs-url 加上错误码，或者为 null。

  • allowed_hostsoptionalarray | null

    随 secret_host_not_allowed 返回：机密可以发往的主机，即机密上设置的主机；没有设置时为 null。

  • tooptionalstring | null

    随 moved 和 sandbox_moved 返回：沙箱被交给的节点，以控制平面给它起的名称为准，或者为 null。

  • epochoptionalinteger

    随 moved 和 sandbox_moved 返回：沙箱被释放时的纪元。随 wrong_epoch 返回：本节点持有它或释放它时的纪元。

    format: int64 · minimum: 1
  • offsetoptionalinteger

    随 sandbox_moved 返回：调用、事件流或终端在命令输出中已读到的位置（事件流最后一个事件的 id）：在沙箱去往的地方从这里接着读（Last-Event-ID，或 from）。

    format: int64 · minimum: 0
  • exec_idoptionalstring

    随 POST …/run 的 sandbox_moved 返回：调用启动并在等待的命令的 id，命令在沙箱去往的地方继续运行：迁移结束后，通过控制平面用 GET …/exec/{exec_id}?wait_seconds= 在那里等待它。再次发起同一调用会再启动一次命令，除非带着同一个 Idempotency-Key。

  • disk_msoptionalnumber | null

    随 copy_behind 返回：释放时为等待对象存储保存到休眠时的磁盘所等的时长，单位为毫秒；没有等待时为 null。

    minimum: 0
  • memory_msoptionalnumber | null

    随 copy_behind 返回：释放时为等待对象存储保存那次休眠的内存镜像所等的时长，单位为毫秒；没有等待时为 null。

    minimum: 0
  • drives_msoptionalnumber | null

    随 copy_behind 返回：释放时为等待对象存储保存沙箱云盘的当前状态所等的时长，单位为毫秒 (slice D2)；没有等待或没有云盘时为 null。

    minimum: 0
  • image_msoptionalnumber | null

    随 copy_behind 返回：释放时为等待对象存储保存沙箱磁盘所基于的镜像所等的时长，单位为毫秒（其节点会在模板的镜像上传之前就复制磁盘）；没有等待时为 null。

    minimum: 0
  • imageoptionalstring

    随 image_missing 返回：对象存储中没有的镜像的 id，与基于它的磁盘和模板的 disk_image 中的名称一致。

    pattern: ^[A-Za-z0-9_-]{1,128}$
  • buildoptionalstring

    随 build_missing 返回：写下沙箱内存的 Firecracker 构建版本，本节点没有保留它。

    pattern: ^[0-9a-f]{16}$

401

missing_api_key, invalid_api_key, expired_api_key, invalid_token.
JSON
  • errorobjectrequired
    • typestringrequired
    • codestringrequired
    • messagestringrequired
    • paramstring | nullrequired
    • retryablebooleanrequired
    • request_idstringrequired
    • docs_urlstring | nullrequired
  • move_idoptionalstring

    随 already_moving 返回：该沙箱正在进行的迁移。

  • upgrade_idoptionalstring

    随 upgrade_in_progress（该键尚未结束的升级）、upgrade_started（已开始的升级）和 rollback_gone（回退被拒绝的那次升级）返回：即那次升级。

    pattern: ^upg-[0-9a-hjkmnp-tv-z]{16}$
  • moveoptionalobject

    随 move_over、move_going_back 和 move_taken_over 返回 (POST /internal/moves/{id}/cancel)：迁移的当前状态。

    • objectstringrequired
    • idstringrequired
      pattern: ^mov-[0-9a-hjkmnp-tv-z]{16}$
    • sandbox_idstringrequired
    • project_idstringrequired
    • fromobjectrequired
      • idstringrequired
      • namestring | nullrequired

        节点名称；之后已从记录中消失的节点为 null。

    • toobjectrequired
      • idstringrequired
      • namestring | nullrequired

        节点名称；之后已从记录中消失的节点为 null。

    • epochintegerrequired

      迁移开始时表中记录的沙箱纪元：旧节点在这个纪元释放它，新节点在纪元加一时接管它，旧节点在纪元加二时收回它，从对象存储接管则在纪元加三时。

      minimum: 1
    • stepstringrequired

      迁移的进展：releasing（正在请旧节点释放它；表中记录它在旧节点上）、taking_over（正在请新节点接管它；表中记录它在新节点上）、reclaiming（新节点拒绝了它，正在请旧节点收回）、restoring（旧节点没有保留它的任何东西，正从对象存储接管）、done（已在新节点上）、failed（留在原处，或回到了原处，或停在某个时间无法消除的故障或运营方的取消发生时所在的位置：error 说明原因）。

    • whystringrequired

      发起迁移的原因：运营方的迁移、撤离或恢复。

    • wakebooleanrequired

      新节点是否唤醒它：按调用的指定，或按迁移开始时它的状态（是否在运行）。

    • from_storebooleanrequired

      新节点只从对象存储接管它。

    • releaseobject | nullrequired

      旧节点释放时的响应（sandboxd/openapi/openapi.json，releaseSandbox），不含释放所用的密钥；响应之前为 null。

    • takeoverobject | nullrequired

      结束迁移的那次接管的响应（节点文档中的 takeoverSandbox）：磁盘和内存来自哪里 (source)、各用了多长时间 (ms)、memory；之前为 null。

    • errorrequired

      失败的迁移：失败原因（如果被带回旧节点，则为新节点的拒绝原因）；已完成的迁移：null；进行中的迁移：如果当前步骤要再次请求，则为该步骤上次得到的答复。

      以下之一：

      • object
      • null
    • attemptsintegerrequired

      当前步骤已请求了多少次，仍没有得到确定的答复。

      minimum: 0
    • next_attempt_atstring | nullrequired

      该步骤何时再次请求；不在等待时为 null。

      format: date-time
    • batchstring | nullrequired

      它所属的撤离 (evc-…) 或恢复 (rcv-…)。

    • created_atstringrequired
      format: date-time
    • updated_atstringrequired
      format: date-time
    • ended_atstring | nullrequired
      format: date-time
  • lease_untiloptionalstring

    随 lease_held 返回：节点最后获得的租约最晚可以持有到何时，再加上让节点察觉租约到期所需的时间（在此之前 recoverNode 会被拒绝）。

    format: date-time
  • activeoptionalobject | null

    随 standby 返回：备用副本最后一次读取租约时的活动副本；没有副本持有租约时为 null。

    • namestringrequired
    • urlstringrequired
    • termintegerrequired
      minimum: 1
  • allowed_hostsoptionalarray | null

    随 secret_host_not_allowed 返回：机密可以发往的主机，即机密上设置的主机；没有设置时为 null（节点的 SecretHosts）。

  • problemsoptional数组，元素为object

    随 invalid_definition 返回：定义中的每个问题，各附其位置和内容。

    • atstringrequired

      在定义中的位置，用点分隔的路径 (services.web.port)；针对整个定义时为空。

    • messagestringrequired
  • reportoptionalobject

    随 compose_refused 返回：导入的报告，说明拒绝了什么、为什么以及要改什么。

    • objectcompose_importrequired
    • namestring | nullrequired

      模型的 name：即每个服务的标签 compose.project。null：模型没有名称。

    • dry_runbooleanrequired
    • strictbooleanrequired
    • profiles数组，元素为stringrequired
    • treatmentsobjectrequired

      报告中每种处理方式各有多少项。

      • doneintegerrequired
        minimum: 0
      • adaptedintegerrequired
        minimum: 0
      • ignoredintegerrequired
        minimum: 0
      • refusedintegerrequired
        minimum: 0
    • items数组，元素为objectrequired

      模型的顶层元素：name，以及每个卷、网络、config、secret 和扩展。

      • atstringrequired

        在模型中的位置：对服务而言，是其属性（ports[0]、depends_on.db、environment.KEY），针对整个服务时为空；对顶层而言，是元素 (volumes.db-data)。

      • treatmentdone或adapted或ignored或refusedrequired

        done：在平台上含义相同；adapted：平台用另一种方式实现同样的效果；ignored：只对本地运行有意义（带 strict 时会被拒绝）；refused：平台做不到，而忽略它会让程序悄悄出错。

      • whystringrequired
      • changestring | nullrequired

        被拒绝的项：要改什么。其他情况为 null。

    • services数组，元素为objectrequired

      导入所采纳的服务，按模型中的顺序。

      • namestringrequired

        服务的名称，也是其应用的名称。

      • app_idstring | nullrequired

        其应用。null：试运行，且项目中没有该服务。

        pattern: ^app-
      • statuscreated或changed或unchangedrequired

        导入对其应用做了（试运行时为将会做）什么：创建、写入变化的部分，或什么都不做。

      • kindservice或jobrequired

        job：模型中有服务等待它完成，它会在每次需要它的部署中运行到结束。

      • statefulbooleanrequired

        它挂载自己的存储卷：只有一个实例，由该实例持有存储卷。

      • versionbooleanrequired

        导入的部署是否为它创建版本：即解析引用后其版本的构成与当前版本不同。

      • items数组，元素为objectrequired
        • atstringrequired

          在模型中的位置：对服务而言，是其属性（ports[0]、depends_on.db、environment.KEY），针对整个服务时为空；对顶层而言，是元素 (volumes.db-data)。

        • treatmentdone或adapted或ignored或refusedrequired

          done：在平台上含义相同；adapted：平台用另一种方式实现同样的效果；ignored：只对本地运行有意义（带 strict 时会被拒绝）；refused：平台做不到，而忽略它会让程序悄悄出错。

        • whystringrequired
        • changestring | nullrequired

          被拒绝的项：要改什么。其他情况为 null。

      • appobjectrequired

        导入写入的服务应用字段：其版本的构成，以及立即生效的设置。

        • imagestring | nullrequired

          应用下一个版本的构成，连同其后的七个字段：即其最新版本的构成，加上此后的修改。null：应用没有镜像，也没有版本。

        • image_pull_secretstring | nullrequired

          保存镜像仓库凭据的机密的名称。任何响应都不包含其值。null：没有。

        • start_commandrequired

          以下之一：

          • StartCommand
          • null
        • start_argsrequired

          放在镜像 ENTRYPOINT 之后、取代其 CMD 的内容。null：使用镜像的 CMD，或者整个 start_command。

          以下之一：

          • array<string>
          • null
        • portinteger | nullrequired
        • readyobjectrequired

          判断实例已启动的方式，版本的模板会在实例启动后保存：三者必须恰好给出一个。前两种从实例外部检查，所以服务必须监听所有地址 (0.0.0.0)。

          • httpoptionalstring

            一个以 / 开头的路径：在应用端口上对它发起 GET，返回 200 到 399 之间的状态码。

          • tcpoptionaltrue

            应用端口接受连接。

          • commandoptional

            在实例中执行成功的一条命令。由实例的 shell 运行：参数列表会被写成一行交给它。

            以下之一：

            • string
            • array<string>
        • env映射，值为stringrequired
        • secrets映射，值为stringrequired

          机密的名称。任何响应都不包含值。

        • sizeobjectrequired

          单个实例最多能使用的资源。按实际用量计费。

          • vcpusintegerrequired
            minimum: 1
          • memory_bytesintegerrequired

            偶数个 MiB（即节点为虚拟机加载内存所用的 2 MiB 页的整数倍），以字节表示。其他任何大小都返回 400 invalid_field（param 为 size.memory_bytes）：没有节点会创建这种大小的实例，正如没有节点会创建这种大小的沙箱（节点的 SandboxLimitsCreate.memory_bytes）。

            minimum: 134217728
        • volumes数组，元素为objectrequired
          • volumestringrequired
          • pathstringrequired
          • read_onlybooleanrequired
          • nocopyoptionalunknown

            只有给出为 true 时才会出现。

        • kindstringrequired
        • files数组，元素为objectrequired
          • pathstringrequired
          • modeintegerrequired
          • uidintegerrequired
          • gidintegerrequired
          • contentoptionalstring
          • secretoptionalstring
        • userstring | nullrequired
        • working_dirstring | nullrequired
        • stoprequired

          以下之一：

          • ServiceStop
            • signalstring | nullrequired
            • grace_msinteger | nullrequired
          • null
        • hostnamestring | nullrequired
        • regions数组，元素为stringrequired

          按 na、eu、ap 的顺序。

        • scaleobjectrequired
          • min_instancesintegerrequired

            无论有没有请求，应用在一个区域内保持运行的实例数：即下限。该区域服务该应用的节点按分摊 max_instances 的方式分摊它（两个节点、下限为 2：各一个；下限为 1：一个，在最先尝试的节点上；下限为 5：三个和两个），不在线的节点由其他节点补足。节点在收到通知时就创建自己那部分，而不是等到第一个请求，也不会因为空闲而停止或删除这些实例；它们按运行中的实例计量。0（未设置时的值）：没有下限。调低后，超出部分的实例从那一刻起视为空闲，并像空闲实例一样被停止和删除。最多为 max_instances（如果给出），且不超过账户套餐允许应用在一个区域请求的数量（caps.app_instances.limit：5、50 和 500）：超出会被拒绝，返回 403 plan_cap_reached。

            minimum: 0
          • max_instancesinteger | nullrequired

            应用在一个区域内最多有多少个实例：由该区域服务该应用的节点分摊。最多为账户套餐允许应用请求的数量（caps.app_instances.limit：免费版 5，付费版 500）：超出会被拒绝，返回 403 plan_cap_reached；在允许的套餐上请求的数值会保留，但受当前套餐数值的限制。null：未指定数量的应用使用套餐的数值（caps.app_instances.default：免费版 2，付费版 50），如果 min_instances 更大则用它。告诉节点的数值，不超过账户除其他运行中资源外还能容纳的运行量，也不少于应用当前运行的实例数。

            minimum: 1
          • concurrencyinteger | nullrequired

            单个实例同时处理的上限：边缘节点发给它的请求，加上它在项目网络上打开的连接（经由其服务的地址，节点会按连接把它们分给各个实例；或者直接连到它自己的地址）。达到上限的实例即为已满，更多的请求会创建新实例。null（未设置时的值）：没有上限。此时节点会在现有实例的 CPU 或内存接近其规格时增加实例，应用不必猜一个数字；一次只处理一个请求的服务应设为 1。

            maximum: 1000 · minimum: 1
          • sleep_after_msinteger | nullrequired

            实例在没有请求时最多等待多久就停止，单位为毫秒。在这个上限以内，节点根据应用自己的流量选择等待时间：在应用最近一段时间里两次请求之间的间隔上，比较多运行一秒空闲与停止再恢复所花的 CPU 时间，选出成本最低的等待时间；这样，请求间隔比停止成本还短的应用会一直运行，请求间隔很长的应用则在最后一个响应结束后立即停止（0：总是立即停止）。null（未设置时的值）：平台的上限，三秒。设置过 100（2026年10月28日之前的默认值）的应用，从那天起视为 null。持续停止的实例会在 delete_after_ms 后被其节点删除，下一个需要实例的请求会得到一个新实例；min_instances 保持运行的实例既不会停止也不会删除。

            maximum: 600000 · minimum: 0
          • sleep_notice_msinteger | nullrequired

            在实例因空闲而停止之前多久，向连接到其客户机 /run/sbx/awake 的程序发送一行 sleep N，单位为毫秒：程序可以借此写出手头的数据、关闭连接，或者发起保持，从而推迟停止。无论它们是否响应，停止都会在这段时间之后到来；没有程序连接时，不会推迟。键控实例也会收到通知。0 或 null：不通知（默认）。

            maximum: 60000 · minimum: 0
          • sleep_hold_max_msintegerrequired

            实例中的程序发起的保持，在空闲时间到期后最多还能让实例运行多久，单位为毫秒：程序连接 /run/sbx/awake，如果某个请求在响应之后还有后续工作，就在响应它之前发送 +，工作完成后发送 -（或关闭连接，或退出）；最后一个保持解除 sleep_after_ms 之后，实例停止。超过这个时间，无论有什么保持，实例都会停止；如果 sleep_notice_ms 要求通知，会先向已连接的程序发送 sleep N cap。保持期间实例在运行，并按运行计量。0：不理会保持。null：30000（默认）。

            maximum: 900000 · minimum: 0
          • delete_after_msinteger | nullrequired

            实例空闲多久后被删除，与停止使用同一个起算点：下一个需要实例的请求会得到一个新实例，即版本模板的克隆，不含被删除的实例在内存和磁盘中积累的东西（需要长久保存的数据请放在存储卷或数据库中）。一秒到一小时，一小时是平台的时间，也是上限：超出会被拒绝 (400 invalid_field)，需要保持预热的实例应计入 min_instances。null（未设置时的值）：节点的一小时 (--app-delete-after-seconds)。修改对应用现有的实例和之后创建的实例同样有效：每个节点至少每秒按应用当前的时间检查一次每个实例。不适用于应用的键控实例，键控实例用 keys.delete_after_idle_ms。

            maximum: 3600000 · minimum: 1000
          • suspend_after_msoptionalinteger | null

            已停止的实例在保存内存并真正休眠之前保持暂停多久，单位为毫秒：暂停时，下一个请求在一两毫秒内得到响应，内存照常计量；休眠时，唤醒要多几毫秒，只计量它保存的数据。节点会把它限制在节点让任何实例保持暂停的最长时间内（十分钟）；宿主机内存不足、其他虚拟机需要占用槽位，或者有人请求休眠，都会让它更早休眠。null（默认）：节点的最长时间。数据库的 suspend_after_seconds 就是其应用的这一设置。

            maximum: 86400000 · minimum: 1000
          • wake_daily_atoptionalstring | null

            每天的某个 UTC 时刻 (HH:MM)，在此时唤醒应用中处于休眠状态的键控实例和有状态服务的实例，让它们完成等待唤醒才能做的工作（比如数据库维护）；节点根据应用请求创建和删除的实例只会被请求唤醒。唤醒本身不算活动：唤醒后运行的东西才算，运行完毕后实例会再次休眠。此外，无论这里怎么设置，有状态服务的实例都会为其 PostgreSQL 服务器 pg_cron 任务的下一次运行而被唤醒。null（默认）：不唤醒。数据库的 wake_daily_at 就是其应用的这一设置。

            pattern: ^([01][0-9]|2[0-3]):[0-5][0-9]$
        • keysrequired

          以下之一：

          • object
          • null
        • egressobject | nullrequired

          与沙箱相同的出站规则（default、allow、deny、http、inject），没有时为 null；按调用给出的原样保存（PATCH 会像节点那样按键逐个合并）。规则立即生效，不产生新版本：服务该应用的节点会把它们应用到其组内的每个实例上，包括现有的实例（运行中的实例对其已有连接也生效）和之后创建的实例；键控实例不受这些规则约束。控制平面只检查它们是不是由这些键组成、不超过 256 KiB 的对象：规则的内容由节点在应用时检查，节点读不懂其规则的实例，所有出站流量都会被拒绝（节点日志会说明原因）。

          • defaultoptionalallow或deny或null
          • allowoptionalarray | null
          • denyoptionalarray | null
          • httpoptionalarray | null
          • injectoptionalarray | null
          • deny_portsoptionalarray | null

            任何连接都到达不了的端口，TCP 或 UDP，无论连往哪里，也无论规则的其他部分怎么说。浏览器会话的规则总是包含 25、465、587 以及矿池监听的端口（3333、4444、5555、7777、14444、45700）：无论其规则如何修改，控制平面都会把它们加上。

        • metadata映射，值为stringrequired
        • logsobjectrequired

          应用日志包含哪些内容，每一项为给出的值或默认值 (AppLogSettings)。

          • outputbooleanrequired
          • keepbooleanrequired
          • requestsobjectrequired
            • sample_ratenumberrequired
              maximum: 1 · minimum: 0
            • keep_errorsbooleanrequired
        • publicbooleanrequired

          是否在其默认域名 (url) 上响应。

        • depends_on数组，元素为objectrequired
          • servicestringrequired
          • conditionstringrequired
        • networkobjectrequired
          • aliases数组，元素为stringrequired
          • endpoint_modestringrequired
        • drivesoptional数组，元素为object

          其实例挂载的云盘 (AppCreate.drives)：没有指定时为空列表 []。

          • drivestringrequired
          • pathstringrequired
          • modestringrequired
        • key_drivesoptional数组，元素为object

          每个键的实例自有的云盘 (AppCreate.key_drives)：没有给出时为空列表 []。

          • namestringrequired
          • pathstringrequired
          • size_bytesinteger | nullrequired
            format: int64
          • nocopyoptionalunknown

            只有给出为 true 时才会出现。

        • runtimeoptional

          运行时设置 (AppCreate.runtime)。null：没有。

          以下之一：

          • Runtime
            • ulimits映射，值为RuntimeLimitGivenrequired
            • sysctls映射，值为stringrequired
            • tmpfs数组，元素为objectrequired
              • pathstringrequired
              • size_bytesinteger | nullrequired
              • modeintegerrequired
            • dnsobjectrequired
              • servers数组，元素为stringrequired
              • search数组，元素为stringrequired
              • options数组，元素为stringrequired
            • shm_size_bytesinteger | nullrequired
          • null
        • tracesoptionalobject

          应用请求的链路追踪包含哪些内容，每一项为给出的值或默认值 (AppTraceSettings)：sample_rate 为 0 时不产生任何 span。

          • sample_ratenumberrequired
            maximum: 1 · minimum: 0
          • trust_incomingbooleanrequired
    • volumes数组，元素为objectrequired

      服务挂载的项目存储卷。

      • modelstring | nullrequired

        它在模型中的名称。null：为有状态服务挂载但未命名卷的路径创建的。

      • namestringrequired

        它在项目中的名称。

      • idstring | nullrequired

        null：尚未创建 (to_make)。

        pattern: ^vol-
      • sharedbooleanrequired

        有多个服务挂载它，或者某个服务有多个实例：每个服务的每个实例同时挂载它。

      • statusto_make或made或there或externalrequired

        to_make：导入会创建它（试运行时对将要创建的存储卷这样说明）；made：本次导入创建了它；there：之前的导入创建了它，或者已有同名的存储卷；external：模型把它标为 external，而项目中已有它。

      • used_by数组，元素为stringrequired
    • secrets数组，元素为objectrequired

      模型中授予服务的 secrets。

      • modelstringrequired

        它在模型中的名称。

      • namestringrequired

        保存它的项目机密：即模型中的名称，其中机密名称不允许的每个字符都写成下划线。

      • therebooleanrequired

        项目中是否已有它。导入（非试运行）时如果它还不存在，会被拒绝，返回 404 secret_not_found。

      • used_by数组，元素为stringrequired
    • left_out数组，元素为objectrequired

      属于未启用 profile 的服务，导入不会处理它们。

      • namestringrequired
      • profiles数组，元素为stringrequired
    • absent数组，元素为stringrequired

      项目中有而模型中没有的服务：保持原样。

    • deploystring | nullrequired

      导入触发的部署 (GET /v1/deploys/{id})。null：试运行，或者没有服务需要新版本。

      pattern: ^dpl-
  • accountsoptional数组，元素为object

    随 sole_owner 返回：该用户是唯一所有者的那些账户。

    • idstringrequired
      pattern: ^acct-[0-9a-hjkmnp-tv-z]{16}$
    • namestringrequired

403

凭据无权执行此操作。token_scope：沙箱令牌缺少所需的权限范围；permission_denied：执行该操作的用户没有权限。spend_limit_reached：沙箱因达到支出上限而被冻结；它会连同数据一起休眠，直到上限提高。
JSON
  • errorobjectrequired
    • typestringrequired

      失败的类别。它决定状态码：invalid_request 400、unauthenticated 401、forbidden 403、not_found 404、conflict 409、too_large 413、internal 500、bad_gateway 502（预览监听器、出站代理，以及无法带回其沙箱的接管）、unavailable 503、timeout 504。

    • codestringrequired

      具体是哪种失败。本文档顶层的 x-error-codes 表说明了每一个的含义。

    • messagestringrequired

      给人看的说明。英文。

    • paramstring | nullrequired

      出错的字段或查询参数（如果有）。

    • retryablebooleanrequired

      在其他条件都不变的情况下，同一请求稍后可能成功时为 true。

    • request_idstringrequired

      所在响应的 X-Request-Id，响应是针对 Idempotency-Key 的重放时也一样。

      pattern: ^[A-Za-z0-9._\-]{1,64}$
    • docs_urlstring | nullrequired

      节点的 --docs-url 加上错误码，或者为 null。

  • allowed_hostsoptionalarray | null

    随 secret_host_not_allowed 返回：机密可以发往的主机，即机密上设置的主机；没有设置时为 null。

  • tooptionalstring | null

    随 moved 和 sandbox_moved 返回：沙箱被交给的节点，以控制平面给它起的名称为准，或者为 null。

  • epochoptionalinteger

    随 moved 和 sandbox_moved 返回：沙箱被释放时的纪元。随 wrong_epoch 返回：本节点持有它或释放它时的纪元。

    format: int64 · minimum: 1
  • offsetoptionalinteger

    随 sandbox_moved 返回：调用、事件流或终端在命令输出中已读到的位置（事件流最后一个事件的 id）：在沙箱去往的地方从这里接着读（Last-Event-ID，或 from）。

    format: int64 · minimum: 0
  • exec_idoptionalstring

    随 POST …/run 的 sandbox_moved 返回：调用启动并在等待的命令的 id，命令在沙箱去往的地方继续运行：迁移结束后，通过控制平面用 GET …/exec/{exec_id}?wait_seconds= 在那里等待它。再次发起同一调用会再启动一次命令，除非带着同一个 Idempotency-Key。

  • disk_msoptionalnumber | null

    随 copy_behind 返回：释放时为等待对象存储保存到休眠时的磁盘所等的时长，单位为毫秒；没有等待时为 null。

    minimum: 0
  • memory_msoptionalnumber | null

    随 copy_behind 返回：释放时为等待对象存储保存那次休眠的内存镜像所等的时长，单位为毫秒；没有等待时为 null。

    minimum: 0
  • drives_msoptionalnumber | null

    随 copy_behind 返回：释放时为等待对象存储保存沙箱云盘的当前状态所等的时长，单位为毫秒 (slice D2)；没有等待或没有云盘时为 null。

    minimum: 0
  • image_msoptionalnumber | null

    随 copy_behind 返回：释放时为等待对象存储保存沙箱磁盘所基于的镜像所等的时长，单位为毫秒（其节点会在模板的镜像上传之前就复制磁盘）；没有等待时为 null。

    minimum: 0
  • imageoptionalstring

    随 image_missing 返回：对象存储中没有的镜像的 id，与基于它的磁盘和模板的 disk_image 中的名称一致。

    pattern: ^[A-Za-z0-9_-]{1,128}$
  • buildoptionalstring

    随 build_missing 返回：写下沙箱内存的 Firecracker 构建版本，本节点没有保留它。

    pattern: ^[0-9a-f]{16}$

404

请求中指定的对象不存在。sandbox_not_found：沙箱不存在；file_not_found：路径上没有任何东西。
JSON
  • errorobjectrequired
    • typestringrequired

      失败的类别。它决定状态码：invalid_request 400、unauthenticated 401、forbidden 403、not_found 404、conflict 409、too_large 413、internal 500、bad_gateway 502（预览监听器、出站代理，以及无法带回其沙箱的接管）、unavailable 503、timeout 504。

    • codestringrequired

      具体是哪种失败。本文档顶层的 x-error-codes 表说明了每一个的含义。

    • messagestringrequired

      给人看的说明。英文。

    • paramstring | nullrequired

      出错的字段或查询参数（如果有）。

    • retryablebooleanrequired

      在其他条件都不变的情况下，同一请求稍后可能成功时为 true。

    • request_idstringrequired

      所在响应的 X-Request-Id，响应是针对 Idempotency-Key 的重放时也一样。

      pattern: ^[A-Za-z0-9._\-]{1,64}$
    • docs_urlstring | nullrequired

      节点的 --docs-url 加上错误码，或者为 null。

  • allowed_hostsoptionalarray | null

    随 secret_host_not_allowed 返回：机密可以发往的主机，即机密上设置的主机；没有设置时为 null。

  • tooptionalstring | null

    随 moved 和 sandbox_moved 返回：沙箱被交给的节点，以控制平面给它起的名称为准，或者为 null。

  • epochoptionalinteger

    随 moved 和 sandbox_moved 返回：沙箱被释放时的纪元。随 wrong_epoch 返回：本节点持有它或释放它时的纪元。

    format: int64 · minimum: 1
  • offsetoptionalinteger

    随 sandbox_moved 返回：调用、事件流或终端在命令输出中已读到的位置（事件流最后一个事件的 id）：在沙箱去往的地方从这里接着读（Last-Event-ID，或 from）。

    format: int64 · minimum: 0
  • exec_idoptionalstring

    随 POST …/run 的 sandbox_moved 返回：调用启动并在等待的命令的 id，命令在沙箱去往的地方继续运行：迁移结束后，通过控制平面用 GET …/exec/{exec_id}?wait_seconds= 在那里等待它。再次发起同一调用会再启动一次命令，除非带着同一个 Idempotency-Key。

  • disk_msoptionalnumber | null

    随 copy_behind 返回：释放时为等待对象存储保存到休眠时的磁盘所等的时长，单位为毫秒；没有等待时为 null。

    minimum: 0
  • memory_msoptionalnumber | null

    随 copy_behind 返回：释放时为等待对象存储保存那次休眠的内存镜像所等的时长，单位为毫秒；没有等待时为 null。

    minimum: 0
  • drives_msoptionalnumber | null

    随 copy_behind 返回：释放时为等待对象存储保存沙箱云盘的当前状态所等的时长，单位为毫秒 (slice D2)；没有等待或没有云盘时为 null。

    minimum: 0
  • image_msoptionalnumber | null

    随 copy_behind 返回：释放时为等待对象存储保存沙箱磁盘所基于的镜像所等的时长，单位为毫秒（其节点会在模板的镜像上传之前就复制磁盘）；没有等待时为 null。

    minimum: 0
  • imageoptionalstring

    随 image_missing 返回：对象存储中没有的镜像的 id，与基于它的磁盘和模板的 disk_image 中的名称一致。

    pattern: ^[A-Za-z0-9_-]{1,128}$
  • buildoptionalstring

    随 build_missing 返回：写下沙箱内存的 Firecracker 构建版本，本节点没有保留它。

    pattern: ^[0-9a-f]{16}$

409

某个对象的状态不允许此操作。is_a_directory：路径是一个目录；not_a_directory：路径中途的某一级不是目录；symlink_loop：路径中途的符号链接形成了循环；not_a_regular_file：路径指向管道、套接字或设备；file_changed：一个大于 1 MiB 的文件在开始读取和查看其长度之间变短了（请重试）；sandbox_failed：沙箱处于 failed 状态。
JSON
  • errorobjectrequired
    • typestringrequired

      失败的类别。它决定状态码：invalid_request 400、unauthenticated 401、forbidden 403、not_found 404、conflict 409、too_large 413、internal 500、bad_gateway 502（预览监听器、出站代理，以及无法带回其沙箱的接管）、unavailable 503、timeout 504。

    • codestringrequired

      具体是哪种失败。本文档顶层的 x-error-codes 表说明了每一个的含义。

    • messagestringrequired

      给人看的说明。英文。

    • paramstring | nullrequired

      出错的字段或查询参数（如果有）。

    • retryablebooleanrequired

      在其他条件都不变的情况下，同一请求稍后可能成功时为 true。

    • request_idstringrequired

      所在响应的 X-Request-Id，响应是针对 Idempotency-Key 的重放时也一样。

      pattern: ^[A-Za-z0-9._\-]{1,64}$
    • docs_urlstring | nullrequired

      节点的 --docs-url 加上错误码，或者为 null。

  • allowed_hostsoptionalarray | null

    随 secret_host_not_allowed 返回：机密可以发往的主机，即机密上设置的主机；没有设置时为 null。

  • tooptionalstring | null

    随 moved 和 sandbox_moved 返回：沙箱被交给的节点，以控制平面给它起的名称为准，或者为 null。

  • epochoptionalinteger

    随 moved 和 sandbox_moved 返回：沙箱被释放时的纪元。随 wrong_epoch 返回：本节点持有它或释放它时的纪元。

    format: int64 · minimum: 1
  • offsetoptionalinteger

    随 sandbox_moved 返回：调用、事件流或终端在命令输出中已读到的位置（事件流最后一个事件的 id）：在沙箱去往的地方从这里接着读（Last-Event-ID，或 from）。

    format: int64 · minimum: 0
  • exec_idoptionalstring

    随 POST …/run 的 sandbox_moved 返回：调用启动并在等待的命令的 id，命令在沙箱去往的地方继续运行：迁移结束后，通过控制平面用 GET …/exec/{exec_id}?wait_seconds= 在那里等待它。再次发起同一调用会再启动一次命令，除非带着同一个 Idempotency-Key。

  • disk_msoptionalnumber | null

    随 copy_behind 返回：释放时为等待对象存储保存到休眠时的磁盘所等的时长，单位为毫秒；没有等待时为 null。

    minimum: 0
  • memory_msoptionalnumber | null

    随 copy_behind 返回：释放时为等待对象存储保存那次休眠的内存镜像所等的时长，单位为毫秒；没有等待时为 null。

    minimum: 0
  • drives_msoptionalnumber | null

    随 copy_behind 返回：释放时为等待对象存储保存沙箱云盘的当前状态所等的时长，单位为毫秒 (slice D2)；没有等待或没有云盘时为 null。

    minimum: 0
  • image_msoptionalnumber | null

    随 copy_behind 返回：释放时为等待对象存储保存沙箱磁盘所基于的镜像所等的时长，单位为毫秒（其节点会在模板的镜像上传之前就复制磁盘）；没有等待时为 null。

    minimum: 0
  • imageoptionalstring

    随 image_missing 返回：对象存储中没有的镜像的 id，与基于它的磁盘和模板的 disk_image 中的名称一致。

    pattern: ^[A-Za-z0-9_-]{1,128}$
  • buildoptionalstring

    随 build_missing 返回：写下沙箱内存的 Firecracker 构建版本，本节点没有保留它。

    pattern: ^[0-9a-f]{16}$

503

暂时无法处理，没有做任何操作。body_memory_full：节点同时持有的调用请求体已达上限，5 秒内没有腾出空间；请稍后重试。
JSON
  • errorobjectrequired
    • typestringrequired

      失败的类别。它决定状态码：invalid_request 400、unauthenticated 401、forbidden 403、not_found 404、conflict 409、too_large 413、internal 500、bad_gateway 502（预览监听器、出站代理，以及无法带回其沙箱的接管）、unavailable 503、timeout 504。

    • codestringrequired

      具体是哪种失败。本文档顶层的 x-error-codes 表说明了每一个的含义。

    • messagestringrequired

      给人看的说明。英文。

    • paramstring | nullrequired

      出错的字段或查询参数（如果有）。

    • retryablebooleanrequired

      在其他条件都不变的情况下，同一请求稍后可能成功时为 true。

    • request_idstringrequired

      所在响应的 X-Request-Id，响应是针对 Idempotency-Key 的重放时也一样。

      pattern: ^[A-Za-z0-9._\-]{1,64}$
    • docs_urlstring | nullrequired

      节点的 --docs-url 加上错误码，或者为 null。

  • allowed_hostsoptionalarray | null

    随 secret_host_not_allowed 返回：机密可以发往的主机，即机密上设置的主机；没有设置时为 null。

  • tooptionalstring | null

    随 moved 和 sandbox_moved 返回：沙箱被交给的节点，以控制平面给它起的名称为准，或者为 null。

  • epochoptionalinteger

    随 moved 和 sandbox_moved 返回：沙箱被释放时的纪元。随 wrong_epoch 返回：本节点持有它或释放它时的纪元。

    format: int64 · minimum: 1
  • offsetoptionalinteger

    随 sandbox_moved 返回：调用、事件流或终端在命令输出中已读到的位置（事件流最后一个事件的 id）：在沙箱去往的地方从这里接着读（Last-Event-ID，或 from）。

    format: int64 · minimum: 0
  • exec_idoptionalstring

    随 POST …/run 的 sandbox_moved 返回：调用启动并在等待的命令的 id，命令在沙箱去往的地方继续运行：迁移结束后，通过控制平面用 GET …/exec/{exec_id}?wait_seconds= 在那里等待它。再次发起同一调用会再启动一次命令，除非带着同一个 Idempotency-Key。

  • disk_msoptionalnumber | null

    随 copy_behind 返回：释放时为等待对象存储保存到休眠时的磁盘所等的时长，单位为毫秒；没有等待时为 null。

    minimum: 0
  • memory_msoptionalnumber | null

    随 copy_behind 返回：释放时为等待对象存储保存那次休眠的内存镜像所等的时长，单位为毫秒；没有等待时为 null。

    minimum: 0
  • drives_msoptionalnumber | null

    随 copy_behind 返回：释放时为等待对象存储保存沙箱云盘的当前状态所等的时长，单位为毫秒 (slice D2)；没有等待或没有云盘时为 null。

    minimum: 0
  • image_msoptionalnumber | null

    随 copy_behind 返回：释放时为等待对象存储保存沙箱磁盘所基于的镜像所等的时长，单位为毫秒（其节点会在模板的镜像上传之前就复制磁盘）；没有等待时为 null。

    minimum: 0
  • imageoptionalstring

    随 image_missing 返回：对象存储中没有的镜像的 id，与基于它的磁盘和模板的 disk_image 中的名称一致。

    pattern: ^[A-Za-z0-9_-]{1,128}$
  • buildoptionalstring

    随 build_missing 返回：写下沙箱内存的 Firecracker 构建版本，本节点没有保留它。

    pattern: ^[0-9a-f]{16}$

default

其他任何失败，格式相同。internal (500)：节点出错；错误信息不会多说，节点日志中以请求的 id 记录了原因。unavailable（503，可重试）：no_capacity，节点的网络槽位都已占用；memory_full，调用需要启动的虚拟机（创建、唤醒、从磁盘启动、恢复、回滚、构建）在宿主机内存中放不下（还要算上已承诺给其上运行的虚拟机的内存），也没有暂停或空闲的虚拟机可以让其休眠来腾出空间（节点的 memory）；drive_full，调用需要构建模板，而节点的数据盘没有空间（节点的 drive）；unavailable，节点正在关闭、沙箱 10 分钟后仍处于 starting、沙箱没有响应，或者沙箱正在迁到本节点（带 Retry-After: 1）；fenced，节点的租约隔离了该沙箱 (Node.lease)。moved (409)：沙箱已迁到另一个节点，由 to 指明。

JSON
  • errorobjectrequired
    • typestringrequired

      失败的类别。它决定状态码：invalid_request 400、unauthenticated 401、forbidden 403、not_found 404、conflict 409、too_large 413、internal 500、bad_gateway 502（预览监听器、出站代理，以及无法带回其沙箱的接管）、unavailable 503、timeout 504。

    • codestringrequired

      具体是哪种失败。本文档顶层的 x-error-codes 表说明了每一个的含义。

    • messagestringrequired

      给人看的说明。英文。

    • paramstring | nullrequired

      出错的字段或查询参数（如果有）。

    • retryablebooleanrequired

      在其他条件都不变的情况下，同一请求稍后可能成功时为 true。

    • request_idstringrequired

      所在响应的 X-Request-Id，响应是针对 Idempotency-Key 的重放时也一样。

      pattern: ^[A-Za-z0-9._\-]{1,64}$
    • docs_urlstring | nullrequired

      节点的 --docs-url 加上错误码，或者为 null。

  • allowed_hostsoptionalarray | null

    随 secret_host_not_allowed 返回：机密可以发往的主机，即机密上设置的主机；没有设置时为 null。

  • tooptionalstring | null

    随 moved 和 sandbox_moved 返回：沙箱被交给的节点，以控制平面给它起的名称为准，或者为 null。

  • epochoptionalinteger

    随 moved 和 sandbox_moved 返回：沙箱被释放时的纪元。随 wrong_epoch 返回：本节点持有它或释放它时的纪元。

    format: int64 · minimum: 1
  • offsetoptionalinteger

    随 sandbox_moved 返回：调用、事件流或终端在命令输出中已读到的位置（事件流最后一个事件的 id）：在沙箱去往的地方从这里接着读（Last-Event-ID，或 from）。

    format: int64 · minimum: 0
  • exec_idoptionalstring

    随 POST …/run 的 sandbox_moved 返回：调用启动并在等待的命令的 id，命令在沙箱去往的地方继续运行：迁移结束后，通过控制平面用 GET …/exec/{exec_id}?wait_seconds= 在那里等待它。再次发起同一调用会再启动一次命令，除非带着同一个 Idempotency-Key。

  • disk_msoptionalnumber | null

    随 copy_behind 返回：释放时为等待对象存储保存到休眠时的磁盘所等的时长，单位为毫秒；没有等待时为 null。

    minimum: 0
  • memory_msoptionalnumber | null

    随 copy_behind 返回：释放时为等待对象存储保存那次休眠的内存镜像所等的时长，单位为毫秒；没有等待时为 null。

    minimum: 0
  • drives_msoptionalnumber | null

    随 copy_behind 返回：释放时为等待对象存储保存沙箱云盘的当前状态所等的时长，单位为毫秒 (slice D2)；没有等待或没有云盘时为 null。

    minimum: 0
  • image_msoptionalnumber | null

    随 copy_behind 返回：释放时为等待对象存储保存沙箱磁盘所基于的镜像所等的时长，单位为毫秒（其节点会在模板的镜像上传之前就复制磁盘）；没有等待时为 null。

    minimum: 0
  • imageoptionalstring

    随 image_missing 返回：对象存储中没有的镜像的 id，与基于它的磁盘和模板的 disk_image 中的名称一致。

    pattern: ^[A-Za-z0-9_-]{1,128}$
  • buildoptionalstring

    随 build_missing 返回：写下沙箱内存的 Firecracker 构建版本，本节点没有保留它。

    pattern: ^[0-9a-f]{16}$

输入以搜索……

↑↓ 切换↵ 选择Esc 关闭