文档中心

数据库工作台

工单管理

DescribeTickets

DescribeTickets

调用 DescribeTickets 接口批量查询工单。

请求类型

同步请求。

请求参数

名称	类型	是否必选	描述	示例值
ListType	String	是	批量查询的工单类型，取值如下。 All：全部。 CreatedByMe：我创建的。 ApprovedByMe：我审批的。	All
OrderBy	String	否	返回结果的排序字段。	UpdateTime
SortBy	String	否	按照降序或升序方式排列。取值如下。 ASC：表示升序。默认值。 DESC：表示降序。	DESC
PageNumber	Integer	否	页码。取值范围 1~1000，默认值为 1。	1
PageSize	Integer	否	每页记录数。取值范围 1~1000，默认值为 10。	3

返回参数

您只需要关注下面表格中的返回参数即可，不在表格中的参数无需关注。

名称	类型	描述	示例值
CreateTime	Long	工单创建时间。	2025-09-05T09:59:58Z
CreateUser	String	工单创建人。	请参见返回示例。
CurrentUser	String	当前处理人。	请参见返回示例。
CurrentUserRole	String	当前处理人角色。	InstanceOwner
DBName	String	数据库名称。	test
InstanceId	String	实例 ID。	mysql-04af670e****
InstanceType	String	数据库类型，当前支持的数据库如下所示。 MySQL：云数据库 MySQL 版。 VeDBMySQL：云数据库 veDB MySQL 版。 Postgres：云数据库 PostgresSQL 版。	MySQL
Memo	String	工单备注信息。	test
TicketExecuteType	String	工单执行类型，取值如下。 Auto：审批完成自动执行，默认值。 Manual：手动执行。 Cron：定时执行。	Auto
TicketId	String	工单号。	196390493418532****
TicketStatus	String	工单状态，返回值如下。 TicketUndo：未开始 TicketPreCheck：预检查中 TicketPreCheckError：预检查失败 TicketExamine：审批中 TicketCancel：已取消 TicketReject：已拒绝 TicketWaitExecute：等待执行 TicketExecute：执行中 TicketFinished：执行成功 TicketError：执行失败	TicketFinished
TicketType	String	工单类型，返回值如下。 NormalSqlChange：普通 SQL 变更工单 FreeLockStructChange：无锁结构变更工单 FreeLockSqlChange：无锁数据变更工单 DataMigrationImport：数据导入工单 DataMigrationExportDB：数据导出工单 DataMigrationExportSqlResult：SQL 结果集导出工单 DataClean：数据清理归档工单	FreeLockStructChange
Title	String	工单标题。	test
UpdateTime	Long	更新时间。	2025-09-05T10:00:13Z
total	Integer	工单总数。	3

请求示例

返回示例

错误码

更多详情，请参见错误码。

最近更新时间：2025.09.28 15:31:26

这个页面对您有帮助吗？

有用

有用

无用

无用