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

最近更新时间:2025-01-15 01:15:13

我的收藏

1. 接口描述

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

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

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeDSPACOSDiscoveryTaskResult。
Version String 公共参数,本接口取值:2019-07-23。
Region String 公共参数,详见产品支持的 地域列表,本接口仅支持其中的: ap-guangzhou, ap-shanghai-fsi, ap-singapore 。
DspaId String DSPA实例ID
示例值:dspa-001
Offset Integer 偏移量,默认值为0
示例值:0
Limit Integer 返回数量,默认值为20,最大值为100
示例值:1
Filters.N Array of Filter Array of Filter 此参数对外不可见。过滤数组。支持的Name:
BucketName 对象桶名
TaskID 任务ID,
TaskName 任务名,
DataSourceId:数据源ID,
ResourceRegion:资源所在地域
每项过滤条件最多支持5个。
示例值:[ { "Name": "DataSourceId", "Values": [ "cos-1bhjsad71h2eb21j2134b1jh" ] } ]

3. 输出参数

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

4. 示例

示例1 DescribeCOSTaskResult

输入示例

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

{
    "DspaId": "dspa-2jnk9scx",
    "Offset": 0,
    "Limit": 10,
    "Filters": [
        {
            "Name": "DataSourceId",
            "Values": [
                "cos-1bhjsad71h2eb21j2134b1jh"
            ]
        }
    ]
}

输出示例

{
    "Response": {
        "Items": [
            {
                "BucketResultId": 1,
                "TaskId": 1,
                "TaskName": "cos分类分级测试",
                "ResultId": 1,
                "DataSourceId": "cos-1bhjsad71h2eb21j2134b1jh",
                "BucketName": "cos_bucket",
                "TotalFiles": 20,
                "SensitiveDataNums": 120,
                "EndTime": "2024-10-10 12:00:00",
                "DataSourceName": "cos数据源1",
                "Status": 0,
                "ErrorInfo": "没有错误则为空,有错误可能报错如:连接数据源错误",
                "ResourceRegion": "ap-guangzhou",
                "OverSize": "OverQuotaSuccess"
            }
        ],
        "TotalCount": 1,
        "RequestId": "826f0635-b168-52a7-8db9-45b1d46d2c8a"
    }
}

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 操作不支持。