Vercel 管理 API 指南 (v1.2)
GIIP 平台提供用于管理 Vercel 项目配置和查询部署历史记录的 API。该 API 默认采用 Sk3 (基于 JSON 数据) 接口来处理请求。
📋 概述
Vercel 管理 API 用于查询在 GIIP 中注册的 Vercel 项目设置,或监控最新的部署历史。
🔐 认证与安全
所有请求都必须包含 GIIP 通用身份验证标头。
- 标头 (Header):
x-giip-ak,x-giip-sk - 请求体上下文 (Body Context): Sk3 接口(使用
jsondata字段)
📡 API 详情 (Sk3)
1. 查询 Vercel 配置列表 (VercelConfigsList)
- 命令:
text=VercelConfigsList - jsondata:
{"csn": 123}(可选:项目标识符) - 说明: 返回当前注册的所有 Vercel 配置信息以及关联的 Vercel 项目名称。
2. 创建 Vercel 配置 (VercelConfigCreate)
- 命令:
text=VercelConfigCreate - jsondata:
{
"csn": 123,
"configName": "Production_Main",
"vercelProjectName": "giip-next-app",
"vercelToken": "vcl_token_...",
"vercelTeamId": "team_xxx",
"vercelProjectId": "prj_xxx"
}
3. 修改/删除 Vercel 配置 (VercelConfigUpdate / VercelConfigDelete)
- 修改:
text=VercelConfigUpdate+{"vcId": 123, ...} - 删除:
text=VercelConfigDelete+{"vcSn": 123}(或vcId)
4. 查询部署历史 (VercelDeploymentsList)
- 命令:
text=VercelDeploymentsList - jsondata:
{"vcId": 123, "limit": 20} - 说明: 按时间倒序查询对应特定配置 (
vcId) 的 Vercel 部署列表。
🛡️ 巧用 Sk3 (高性能日志)
Vercel 管理 API 从设计阶段起就将 giipApiSk3 接口作为标准。它为所有配置管理和查询请求提供详细的执行上下文和错误追踪。
- 端点:
https://giipfaw.azurewebsites.net/api/giipApiSk3 - 优势: 当发生 Vercel 令牌 (Token) 错误或部署状态同步失败时,会自动记录调用者的 IP、User-Agent 以及详细的服务端堆栈跟踪 (StackTrace),帮助您迅速诊断集成问题。
- 使用技巧: 在发送如
VercelConfigCreate等包含大量参数的请求时,利用jsondata对象结构可以确保复杂的令牌值安全、完整地传输,并保留详细日志。
🔧 故障排除
| 症状 | 原因 | 解决 |
|---|---|---|
| 请求因认证错误被拒绝 | 缺少 x-giip-ak / x-giip-sk 请求头或密钥错误 | 包含有效的认证请求头后重试 |
text 命令无法识别或返回空响应 | text 值拼写错误(例如 VercelConfigList 与 VercelConfigsList) | 确认准确的命令名并设置到 text 参数中 |
| 部署列表为空或同步失败 | vercelToken 已过期或无效 | 通过 VercelConfigUpdate 更新有效令牌后重新查询 |
VercelDeploymentsList 无返回结果 | vcId 错误,或该配置无部署历史 | 使用 VercelConfigsList 确认正确的 vcId 后重试 |
版本: 1.3
最后更新: 2026-04-11
源文件: giipv3/public/help/api-vercel.zh-CN.md
相关文档: