文档首页/ 数据库安全服务 DBSS/ API参考/ API/ 总览/ 获取租户审计信息汇总任务状态
更新时间：2025-09-10 GMT+08:00
查看PDF
分享

获取租户审计信息汇总任务状态

功能介绍

获取租户审计信息汇总任务状态

URI

GET /v3/{project_id}/audit/summary/{busi_type}/task-status

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释：

项目ID。可通过IAM服务[查询指定IAM用户的项目列表]接口获取。

约束限制：

不涉及

取值范围：

以IAM服务接口返回值为准，字符长度32-64。

默认取值：

不涉及

busi_type

是

String

参数解释：

业务类型。

约束限制：

不涉及

取值范围：

  • audit：审计实例

  • risk：风险

默认取值：

不涉及

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释：

用户Token。 通过调用IAM服务查询用户Token接口获取（响应消息头中X-Subject-Token的值）。

约束限制：

不涉及

取值范围：

IAM服务查询用户Token接口为准

默认取值：

不涉及

响应参数

状态码：200

表3 响应Body参数

参数

参数类型

描述

begin_time

Long

开始时间

busi_type

String

业务类型

  • audit: 审计

  • risk: 风险

completed_num

Integer

已统计实例数

end_time

Long

结束时间

id

Long

Task任务ID

project_id

String

项目ID

query_begin_time

Long

查询条件：开始时间

query_end_time

Long

查询条件：结束时间

task_status

String

任务状态

  • 0：已就绪

  • 1：运行中

  • 2：成功

  • 3：失败

task_switch

String

任务开关

total_num

Integer

总实例数

状态码：400

表4 响应Body参数

参数

参数类型

描述

details

Array of DbssErrorDetail objects

PDP5鉴权异常信息

encoded_authorization_message

String

PDP5鉴权异常信息

error_code

String

错误码

error_msg

String

错误信息
表5 DbssErrorDetail

参数

参数类型

描述

error_code

String

错误码

error_msg

String

PDP5错误信息

状态码：401

表6 响应Body参数

参数

参数类型

描述

details

Array of DbssErrorDetail objects

PDP5鉴权异常信息

encoded_authorization_message

String

PDP5鉴权异常信息

error_code

String

错误码

error_msg

String

错误信息
表7 DbssErrorDetail

参数

参数类型

描述

error_code

String

错误码

error_msg

String

PDP5错误信息

状态码：403

表8 响应Body参数

参数

参数类型

描述

details

Array of DbssErrorDetail objects

PDP5鉴权异常信息

encoded_authorization_message

String

PDP5鉴权异常信息

error_code

String

错误码

error_msg

String

错误信息
表9 DbssErrorDetail

参数

参数类型

描述

error_code

String

错误码

error_msg

String

PDP5错误信息

状态码：500

表10 响应Body参数

参数

参数类型

描述

details

Array of DbssErrorDetail objects

PDP5鉴权异常信息

encoded_authorization_message

String

PDP5鉴权异常信息

error_code

String

错误码

error_msg

String

错误信息
表11 DbssErrorDetail

参数

参数类型

描述

error_code

String

错误码

error_msg

String

PDP5错误信息

请求示例

/v3/{project_id}/audit/summary/{busi_type}/task-status

响应示例

状态码：200

OK

{
  "id" : 32,
  "project_id" : "b9351f98c724428794ba7d105fa3558d",
  "busi_type" : "risk",
  "task_switch" : "off",
  "task_status" : "2",
  "total_num" : 10,
  "completed_num" : 10,
  "begin_time" : 1753427737077,
  "end_time" : 1753427757803,
  "query_begin_time" : 1752974753000,
  "query_end_time" : 1753427733000
}

状态码

状态码

描述

200

OK

400

请求参数有误。

401

认证失败

403

未授权

500

服务端错误

错误码

请参见错误码。

父主题： 总览