获取静态导出作业状态

GET

static-export

jobs

{jobId}

获取静态导出任务状态

curl --request GET \
  --url https://api.mintlify.com/v1/static-export/jobs/{jobId} \
  --header 'Authorization: Bearer <token>'

{
  "jobId": "se_3f9a2c1b8e7d4a06",
  "status": "running",
  "progress": 42,
  "pageCount": 128,
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "error": "<string>"
}

静态导出需要 Enterprise 套餐。

授权

Authorization

string

header

必填

管理员 API 密钥。可在控制台的 API 密钥页面生成。

路径参数

jobId

string

必填

由 Start static export job 返回的静态导出任务的 ID。

响应

导出任务的当前状态。

jobId

string

必填

静态导出任务的唯一标识符。

示例:

"se_3f9a2c1b8e7d4a06"

status

enum<string>

必填

任务的当前状态。

可用选项:

queued,

running,

completed,

failed

示例:

"running"

progress

number

必填

完成百分比，范围为 0 到 100。

必填范围: 0 <= x <= 100

示例:

42

pageCount

integer

必填

目前已导出的页面数量。

示例:

128

createdAt

string<date-time>

必填

任务的创建时间。

updatedAt

string<date-time>

必填

任务的最后更新时间。

error

string | null

人类可读的错误消息。仅当 status 为 failed 时才会出现。

相关主题

启动静态导出作业静态导出生成导出包

启动静态导出作业

生成导出包

⌘I

获取静态导出任务状态

curl --request GET \
  --url https://api.mintlify.com/v1/static-export/jobs/{jobId} \
  --header 'Authorization: Bearer <token>'

{
  "jobId": "se_3f9a2c1b8e7d4a06",
  "status": "running",
  "progress": 42,
  "pageCount": 128,
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "error": "<string>"
}