1. 接口描述
接口请求域名： dbbrain.api3.fincloud.tencent.com。
查询健康报告生成任务列表。
默认接口请求频率限制：20次/秒。
接口更新时间：2025-05-16 15:41:51。
接口只验签名不鉴权。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。
| 参数名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Action | 是 | 否 | String | 公共参数，本接口取值：DescribeDBDiagReportTasks |
| Version | 是 | 否 | String | 公共参数，本接口取值：2021-05-27 |
| Region | 是 | 否 | String | 公共参数，地域信息可通过DescribeRegions接口查看产品支持的地域列表 |
| Limit | 否 | 是 | Int64 | 返回数量，默认20，最大值为100。 示例值： 20 |
| Product | 是 | 否 | String | 服务产品类型，支持值包括： "mariadb" - 数据库 MariaDB， "dcdb" - 数据库 TDSQL MySQL，默认为"mariadb"。 示例值： mariadb |
| InstanceIds | 否 | 是 | Array of String | 实例ID数组，用于筛选指定实例的任务列表。 示例值： ["share-c1nl9rpv"] |
| TaskStatuses | 否 | 是 | String | 任务的状态，支持的取值包括："created" - 新建；"chosen" - 待执行； "running" - 执行中；"failed" - 失败；"finished" - 已完成。 示例值： ["finished"] |
| Offset | 否 | 是 | Int64 | 偏移量，默认0。 示例值： 0 |
| HealthLevels | 否 | 是 | String | 报告的健康等级，支持的取值包括："HEALTH" - 健康；"SUB_HEALTH" - 亚健康；"RISK" - 危险；"HIGH_RISK" - 高危。 示例值： ["HEALTH"] |
| StartTime | 否 | 是 | Datetime | 第一个任务的开始时间，用于范围查询，时间格式如：2019-09-10 12:13:14。 示例值： 2019-09-10 12:13:14 |
| EndTime | 否 | 是 | Datetime | 最后一个任务的开始时间，用于范围查询，时间格式如：2019-09-10 12:13:14。 示例值： 2019-09-10 12:13:14 |
| Sources | 否 | 是 | Array of String | 任务的触发来源，支持的取值包括："DAILY_INSPECTION" - 实例巡检；"SCHEDULED" - 定时生成；"MANUAL" - 手动触发。 示例值： ["DAILY_INSPECTION"] |
| ClusterIds | 否 | 是 | Array of String | 集群ID数组，用于筛选指定实例的任务列表。 示例值： ["tdsql-c1nl9rpv"] |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| TotalCount | Int64 | 任务总数目。 示例值： 1 |
| Tasks | Array of HealthReportTask | 任务列表。 示例值：查看 |
| RequestId | String | 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。
| 错误码 | 描述 |
|---|---|
| InvalidParameterValue | |
| InvalidParameter | |
| UnauthorizedOperation | |
| UnsupportedOperation | |
| MissingParameter | |
| AuthFailure | |
| InternalError | |
| LimitExceeded | |
| ResourceNotFound | |
| OperationDenied | |
| FailedOperation | |
| UnknownParameter | |
| OperationDenied.UserHasNoStrategy |