通用响应格式

TRAE 企业版接口的通用响应格式如下：

成功响应：

{
  "code": 0,
  "message": "success",
  "request_id": "req_abc123xyz",
  "data": { ... }
}

分页响应：

{
  "code": 0,
  "message": "success",
  "request_id": "req_abc123xyz",
  "data": {
    "items": [ ... ],
    "pagination": {
      "page": 1,
      "page_size": 100,
      "total": 128,
      "total_pages": 2
    }
  }
}

错误响应：

{
  "code": 1001,
  "request_id": "req_abc123xyz",
  "message": "invalid access token",
  "data": null
}

响应中的通用参数如下：

参数	类型	描述
`code`	int	业务状态码，用于标识请求结果。
`message`	string	请求结果的描述信息。
`request_id`	string	请求的唯一标识，用于问题排查与日志追踪。
`data`	object	业务数据，不同接口的结构不同。
`data.items`	array	当前页返回的信息列表。
`data.pagination`	object	分页信息。
`data.pagination.page`	int	当前页码。
`data.pagination.page_size`	int	每页条数。
`data.pagination.total`	int	总记录数。
`data.pagination.total_pages`	int	总页数。

文档对您有帮助吗?

鉴权

添加成员