跳到主要内容

工单

调用前请先阅读概览,了解鉴权、请求约定和错误处理。

账户只能看到自己在该组织中创建的工单。API token 的规则:

  • 不支持附件。创建工单或评论时带 attachments 会返回 HTTP 400。
  • 创建工单、添加评论和修改状态会通知支持团队。每个 token 可以连续发送 3 次这类请求,之后每 10 秒 1 次,超出时返回 HTTP 429。

列出工单类别​

GET /api/v1/tickets/category-options · Read · Self

返回创建工单可用的类别,另见工单类别。

{ "success": true, "data": [{ "name": "Warehouse", "value": 1 }, { "name": "Billing", "value": 8 }] }

列出工单​

POST /api/v1/orgs/{orgSlug}/tickets/query · Read · Creator

返回账户在该组织中创建的工单。默认按最近回复时间从新到旧排列。请求体中的字段都是可选的。要列出全部工单,传 {}。

字段类型必填说明
pageinteger否页码。默认:1。
perPageinteger否每页条数。默认:50。
statusstring(枚举)否new、open、pending、hold、solved 或 closed。
categoryinteger(枚举)否工单类别。
subjectstring否标题中包含的文字。
ticketNostring否工单编号,精确匹配。
prioritystring(枚举)否low、normal、high 或 urgent。
createdTimeFrom、createdTimeTostring否创建时间范围,RFC 3339 格式。
lastReplyTimeFrom、lastReplyTimeTostring否最近回复时间范围,RFC 3339 格式。
sortstring否lastReplyTime(默认)、createdAt 或 updatedAt。
directionstring否asc 或 desc。默认:desc。

响应示例。type 是类别名称,priority 为 low、normal、high 或 urgent。

{
"success": true,
"data": {
"page": 1,
"perPage": 50,
"total": 1,
"list": [
{
"id": 3051,
"number": "T202611090001",
"subject": "Warehouse does not resume",
"description": "The default warehouse stays in Starting.",
"status": "open",
"type": "Warehouse",
"priority": "normal",
"tags": [],
"lastReplyAuthorType": "agent",
"lastReplyTime": "2026-11-09T08:30:00Z",
"lastRepliedBy": null,
"lastRepliedByAvatar": null,
"repliesCount": 2,
"orgName": "Acme",
"orgSlug": "acme-prod",
"createdAt": "2026-11-09T07:00:00Z",
"updatedAt": "2026-11-09T08:30:00Z"
}
]
}
}

lastReplyAuthorType 为 customer 或 agent。

获取工单​

GET /api/v1/orgs/{orgSlug}/tickets/{ticketId} · Read · Creator

参数位置类型必填说明
orgSlug路径string是组织 ID。
ticketId路径integer是工单 ID。

响应:data 是一张工单,包含 id、number、subject、description、status、type、priority、tags、attachments、orgName、orgSlug、createdAt 和 updatedAt。每个附件包含 name、size、url 和 fileID。API token 不能下载附件。

列出工单评论​

GET /api/v1/orgs/{orgSlug}/tickets/{ticketId}/comments · Read · Creator

按从旧到新返回工单的公开评论。

{
"success": true,
"data": [
{ "id": 8812, "authorID": 7, "authorName": "Alice", "authorAvatar": "", "authorType": "customer", "content": "It started after the resize.", "public": true, "replyTime": "2026-11-09T07:10:00Z" }
]
}

创建工单​

POST /api/v1/orgs/{orgSlug}/tickets · Write · Member

字段类型必填说明
categoryinteger(枚举)否工单类别。默认:0(Other)。
subjectstring是标题,最多 1,000 个字符。
descriptionstring否问题描述。
{ "category": 1, "subject": "Warehouse does not resume", "description": "The default warehouse stays in Starting since 07:00 UTC." }

响应:

{ "success": true, "data": { "id": 3051 } }

添加工单评论​

POST /api/v1/orgs/{orgSlug}/tickets/{ticketId}/comments · Write · Creator

字段类型必填说明
commentstring是评论内容。
{ "comment": "The warehouse resumed after a retry. You can close the ticket." }

响应:{ "success": true }。

修改工单状态​

POST /api/v1/orgs/{orgSlug}/tickets/{ticketId}/{status} · Write · Creator

参数位置类型必填说明
orgSlug路径string是组织 ID。
ticketId路径integer是工单 ID。
status路径string(枚举)是solved 表示关闭工单,open 表示重新打开。其他取值返回 HTTP 400。

响应:{ "success": true }。

类型​

工单类别​

取值名称取值名称
0Other11Dashboard
1Warehouse12Pipeline
2Worksheet13SQLHistory
3Load Data14Task
4Database15Data Sources
5Integrations16Data Integrations
6Activity17SQLRunning
7Metrics18AuditLogs
8Billing19Documentation
9Invite Member20Features
10Business
欢迎体验 Databend Cloud

基于 Rust + 对象存储构建的新一代多模态数仓,一个平台即可进行 BI、向量、全文检索及地理空间分析。

支持标准 SQL,自动弹性伸缩,助您快速构建现代化数据平台。

注册即领 ¥200 代金券。

注册体验