文档首页/ 数据库安全服务 DBSS/ API参考/ API/ 报表管理/ 更改报表的计划任务配置信息（topic方式）
更新时间：2025-09-10 GMT+08:00
查看PDF
分享

更改报表的计划任务配置信息（topic方式）

功能介绍

更改报表的计划任务配置信息（topic方式）

URI

POST /v1/{project_id}/audit/{instance_id}/reports/task

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释：

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

约束限制：

不涉及

取值范围：

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

默认取值：

不涉及

instance_id

是

String

参数解释：

实例ID。可通过查询实例列表接口ID字段获取

约束限制：

不涉及

取值范围：

以查询实例列表接口值为准，字符长度32-64。

默认取值：

不涉及

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释：

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

约束限制：

不涉及

取值范围：

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

默认取值：

不涉及
表3 请求Body参数

参数

是否必选

参数类型

描述

scheduler

是

SchedulerBean object

调度信息
表4 SchedulerBean

参数

是否必选

参数类型

描述

db_ids

否

String

数据库ID

format

是

String

文件类型,默认ZIP

frequency

是

String

周期

id

是

String

模板ID

mode

是

String

调度方式

notice

是

String

是否通知

  • OFF：不通知

  • ON：通知

start_time

是

String

开始时间

status

是

String

模板状态

topic_urn

是

String

主题URN

响应参数

状态码：200

表5 响应Body参数

参数

参数类型

描述

status

String

状态

  • success: 成功

  • fail: 失败

状态码：400

表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错误信息

状态码：401

表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错误信息

状态码：403

表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错误信息

状态码：500

表12 响应Body参数

参数

参数类型

描述

details

Array of DbssErrorDetail objects

PDP5鉴权异常信息

encoded_authorization_message

String

PDP5鉴权异常信息

error_code

String

错误码

error_msg

String

错误信息
表13 DbssErrorDetail

参数

参数类型

描述

error_code

String

错误码

error_msg

String

PDP5错误信息

请求示例

/v1/{project_id}/audit/{instance_id}/reports/task

{
  "scheduler" : {
    "status" : "OFF",
    "notice" : "ON",
    "mode" : "CYCLE",
    "start_time" : 17,
    "topic_urn" : "urn:smn:cn-north-7:b9351f98c724428794ba7d105fa3558d:SMN-JJH",
    "db_ids" : null,
    "id" : "HDIbD5YBZUbBN2XwhfrD",
    "frequency" : "AUDIT_REPORT_WEEK",
    "format" : "ZIP"
  }
}

响应示例

状态码：200

OK

{
  "status" : "success"
}

状态码

状态码

描述

200

OK

400

请求参数有误。

401

认证失败

403

未授权

500

服务端错误

错误码

请参见错误码。

父主题： 报表管理