上传应用

curl --request POST \
  --url https://api.squarecloud.app/v2/apps \
  --header 'Authorization: YOUR_API_KEY' \
  --form 'file=@./application.zip'

import fs from 'node:fs';

const form = new FormData();
form.append('file', new Blob([fs.readFileSync('./application.zip')]), 'application.zip');

const response = await fetch('https://api.squarecloud.app/v2/apps', {
  method: 'POST',
  headers: { Authorization: 'YOUR_API_KEY' },
  body: form,
});

import requests

with open('application.zip', 'rb') as f:
    response = requests.post(
        'https://api.squarecloud.app/v2/apps',
        headers={'Authorization': 'YOUR_API_KEY'},
        files={'file': ('application.zip', f, 'application/zip')},
    )

{
    "status": "success",
    "response": {
        "id": "945f574e6cc14ea6818f91d7d56de101",
        "name": "My Website",
        "description": "My first website on Square Cloud",
        "domain": "my-website.squareweb.app",
        "ram": 1024,
        "cpu": 6,
        "language": {
            "name": "javascript",
            "version": "recommended"
        }
    }
}

string

必填

你账户的 API 密钥。你可以在账户设置中找到它。

需要具有 apps:write 权限范围的 API 密钥。上传（Upload）会根据一个 zip 压缩包创建一个全新的应用：它会检测运行时及其版本，在当前 RAM 使用率最低的集群上配置一个容器，并启动它。此操作适用于首次部署；若要向已存在的应用推送更改，请改用提交应用，由于它不需要重新配置容器，速度会更快。调用者的套餐必须至少有 256 MB 的可用内存，上传才会被接受，且 zip 大小上限为 100 MB。响应字段取决于你的 squarecloud.config：description 和 domain 仅在其中设置时才会出现，language 会报告检测到的运行时及其版本。请求的速率限制为每个用户每 3 秒 1 次上传。请求体限制为 101 MB（最大 100 MB 的文件加上表单开销）：超出的请求会在仍在上传时即被拒绝，返回 413 FILE_TOO_LARGE。只会读取第一个文件部分；其他表单字段会被忽略。应用运行起来后，可以使用启动、停止和重启来管理它，并使用获取应用状态来查看其状态。

参数

file

必填

要上传的应用必须压缩为 zip 文件（.zip），且 Content-Type 必须为 multipart/form-data。

响应

string

指示调用是否成功。成功时为 success，否则为 error。

object

响应的内容。

显示展开对象

string

已上传应用的 ID。

string

已上传应用的名称。

string

已上传应用的描述。

string

应用的完整主机名，例如 my-app.squareweb.app。仅当 squarecloud.config 设置了 SUBDOMAIN 时才会出现。它与获取应用信息返回的字段相同。

number

分配给应用的内存，单位为 MB。

number

分配给应用的 CPU。

object

显示展开对象

string

检测到的运行时，小写形式（例如 javascript），与获取应用信息中的一致。

string

该编程语言的推荐版本。

string

应用所托管的集群。

curl --request POST \
  --url https://api.squarecloud.app/v2/apps \
  --header 'Authorization: YOUR_API_KEY' \
  --form 'file=@./application.zip'

import fs from 'node:fs';

const form = new FormData();
form.append('file', new Blob([fs.readFileSync('./application.zip')]), 'application.zip');

const response = await fetch('https://api.squarecloud.app/v2/apps', {
  method: 'POST',
  headers: { Authorization: 'YOUR_API_KEY' },
  body: form,
});

import requests

with open('application.zip', 'rb') as f:
    response = requests.post(
        'https://api.squarecloud.app/v2/apps',
        headers={'Authorization': 'YOUR_API_KEY'},
        files={'file': ('application.zip', f, 'application/zip')},
    )

{
    "status": "success",
    "response": {
        "id": "945f574e6cc14ea6818f91d7d56de101",
        "name": "My Website",
        "description": "My first website on Square Cloud",
        "domain": "my-website.squareweb.app",
        "ram": 1024,
        "cpu": 6,
        "language": {
            "name": "javascript",
            "version": "recommended"
        }
    }
}

常见错误

代码	HTTP	说明
`INVALID_CONTENT_TYPE`	415	请求体不是 `multipart/form-data`。
`INVALID_FILE`	400	表单数据中未找到文件字段。
`INVALID_FILENAME`	400	文件名包含路径分隔符、`..` 或控制字符。
`INSUFFICIENT_MEMORY`	400	账户在其套餐下的可用内存少于 256 MB。
`UPLOAD_ABORTED`	400	客户端在上传完成前断开了连接。
`STORAGE_UPLOAD_FAILED`	400	文件上传到存储失败；请稍后重试。
`CLUSTER_SELECTION_FAILED`	400	没有可用的集群来托管该应用。
`EMPTY_RESPONSE`	400	集群未返回可用的响应。
`UPLOAD_FAILED`	400	处理上传时发生了意外错误。
`FILE_TOO_LARGE`	413	文件超过 100 MB，或请求体超过 101 MB。
`CLUSTER_MAINTENANCE_TRY_LATER`	503	由于维护，应用配置暂时不可用。
`UPLOAD_BUSY`	503	当前正在处理的上传过多；请稍后重试。

入门

账户

应用

数据库

工作区

AI

参数

响应

常见错误

相关内容

​参数

​响应

​常见错误

​相关内容

参数

响应

常见错误

相关内容