获取分类分级任务执行结果

最近更新时间:2025-06-26 01:18:15

我的收藏

1. 接口描述

接口请求域名: dsgc.tencentcloudapi.com 。

获取分类分级任务结果,该接口只有在任务状态为以下状态时才支持结果正常查询:3 扫描成功,4 扫描失败

默认接口请求频率限制:20次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeDSPADiscoveryTaskResult。
Version String 公共参数,本接口取值:2019-07-23。
Region String 公共参数,详见产品支持的 地域列表,本接口仅支持其中的: ap-guangzhou, ap-shanghai-fsi, ap-singapore 。
DspaId String DSPA实例ID
示例值:dspa-89asd23f
DataSourceType String 数据源类型,可取值如下:
cdb 表示云数据库 MySQL,
dcdb 表示TDSQL MySQL版,
mariadb 表示云数据库 MariaDB,
postgres 表示云数据库 PostgreSQL,
cynosdbpg 表示TDSQL-C PostgreSQL版,
cynosdbmysql 表示TDSQL-C MySQL版,
selfbuilt-db 表示自建数据库
示例值:cdb
TaskId Integer 任务ID
示例值:1
TaskName String 任务名称
示例值:扫描任务
DataSourceId String 数据源ID
示例值:cdb-a80sd23a
DbName String 数据库名称
示例值:db1
Offset Integer 偏移量,默认值为0
示例值:0
Limit Integer 返回数量,默认值为20,最大值为100
示例值:10
ResourceRegion String 资源所在地域
示例值:ap-guangzhou
StartTime String 开始时间
示例值:2025-05-01 12:00:00
EndTime String 结束时间
示例值:2025-05-01 13:00:00
FetchHistory Boolean 是否查询历史结果
示例值:true

3. 输出参数

参数名称 类型 描述
Items Array of DspaDiscoveryTaskDbResult 扫描任务结果项
TotalCount Integer 符合条件的扫描任务结果记录数
示例值:1
MaxCount Integer 最大展示扫描结果次数
示例值:10
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 获取分类分级任务结果

输入示例

POST / HTTP/1.1
Host: dsgc.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeDSPADiscoveryTaskResult
<公共请求参数>

{
    "DataSourceType": "cdb",
    "DspaId": "dspa-8u9asd2h",
    "Limit": 10,
    "TaskId": "1",
    "Offset": 0,
    "TaskName": "自定义分类分级任务结果获取实验"
}

输出示例

{
    "Response": {
        "RequestId": "20569756-56ba-4a13-b545-e1528d5cb239",
        "TotalCount": 1,
        "Items": [
            {
                "DbResultId": 5640,
                "TaskId": 14596,
                "TaskName": "通用规则集验证",
                "DataSourceId": "cdb-6cfae42v",
                "DataSourceName": "新采集实验数据源",
                "ResourceRegion": "ap-guangzhou",
                "ResultId": 4242,
                "DbName": "dsgctest001",
                "TotalTables": 1,
                "SensitiveTables": 0,
                "SensitiveField": 0,
                "TotalField": 51,
                "EndTime": "2024-11-05 17:17:30",
                "Status": 3,
                "ErrorInfo": "没有错误则为空,有错误可能报错如:连接数据源错误"
            }
        ]
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

错误码 描述
InternalError 内部错误。
InvalidParameter 参数错误。
InvalidParameterValue 参数取值错误。
ResourceNotFound 资源不存在。
ResourceUnavailable 资源不可用。
UnauthorizedOperation 未授权操作。
UnknownParameter 未知参数错误。
UnsupportedOperation 操作不支持。