# 获取部署状态 (/zh/api/update/status)

<!-- agent-signals: reading_time_min: 1 · est_tokens: 1187 · updated: 2026-07-30 -->
Related: [触发部署](/zh/api/update/trigger.md), [简介](/zh/api/introduction.md)



`GET /project/update-status/{statusId}`

通过状态 ID 获取更新状态

使用管理员 API 密钥进行身份验证。

## OpenAPI

```json
{
  "security": [
    {
      "bearerAuth": []
    }
  ],
  "parameters": [
    {
      "name": "statusId",
      "in": "path",
      "description": "已触发的更新的状态 ID。",
      "required": true,
      "schema": {
        "type": "string"
      }
    }
  ],
  "responses": {
    "200": {
      "description": "成功响应",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "_id": {
                "type": "string",
                "description": "已触发更新项的状态 ID。"
              },
              "projectId": {
                "type": "string",
                "description": "文档项目的 ID。"
              },
              "createdAt": {
                "type": "string",
                "description": "具有指定 UTC 日期时间的 ISODate"
              },
              "endedAt": {
                "type": "string",
                "description": "包含指定 UTC 日期时间的 ISODate"
              },
              "status": {
                "type": "string",
                "enum": [
                  "queued",
                  "in_progress",
                  "success",
                  "failure"
                ],
                "description": "更新状态。"
              },
              "summary": {
                "type": "string",
                "description": "更新状态概览"
              },
              "logs": {
                "type": "array",
                "description": "一组日志。",
                "items": {
                  "type": "string"
                }
              },
              "subdomain": {
                "type": "string",
                "description": "正在更新的文档站点的子域。"
              },
              "screenshot": {
                "type": "string",
                "description": "文档截图。"
              },
              "screenshotLight": {
                "type": "string",
                "description": "文档截图。"
              },
              "screenshotDark": {
                "type": "string",
                "description": "文档在深色模式下的截图。"
              },
              "author": {
                "type": "object",
                "description": "此更新的作者。",
                "nullable": true,
                "properties": {
                  "name": {
                    "type": "string",
                    "description": "作者的名称。"
                  },
                  "avatarUrl": {
                    "type": "string",
                    "description": "作者头像的 URL。"
                  },
                  "githubUserId": {
                    "type": "number",
                    "description": "作者的 GitHub 用户 ID。"
                  }
                }
              },
              "commit": {
                "type": "object",
                "description": "提交详情",
                "properties": {
                  "sha": {
                    "type": "string",
                    "description": "提交的 SHA 哈希值。"
                  },
                  "ref": {
                    "type": "string",
                    "description": "该提交的 ref。"
                  },
                  "message": {
                    "type": "string",
                    "description": "提交信息。"
                  },
                  "filesChanged": {
                    "type": "object",
                    "description": "更改文件的详细信息。",
                    "properties": {
                      "added": {
                        "type": "array",
                        "description": "已添加新文件。",
                        "items": {
                          "type": "string"
                        }
                      },
                      "modified": {
                        "type": "array",
                        "description": "已被修改的现有文件。",
                        "items": {
                          "type": "string"
                        }
                      },
                      "removed": {
                        "type": "array",
                        "description": "已删除的文件。",
                        "items": {
                          "type": "string"
                        }
                      }
                    }
                  }
                }
              },
              "source": {
                "type": "string",
                "description": "更新触发器的来源。",
                "enum": [
                  "internal",
                  "github-app-installation",
                  "api",
                  "github",
                  "dashboard",
                  "gitlab",
                  "onboarding"
                ]
              }
            }
          }
        }
      }
    }
  }
}
```