数据安全治理中心

3.0

获取COS分类分级任务信息列表

最近更新时间:2025-03-20 11:25:57

我的收藏

1. 接口描述

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

获取COS分类分级任务列表

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeDSPACOSDiscoveryTasks。
Version String 公共参数,本接口取值:2019-07-23。
Region String 公共参数,详见产品支持的 地域列表,本接口仅支持其中的: ap-guangzhou, ap-shanghai-fsi, ap-singapore 。
DspaId String DSPA实例ID
示例值:dspa-1f96daa1
TaskId Integer 任务ID
示例值:1
Name String 任务名称
示例值:扫描敏感数据任务
StatusList.N Array of Integer 任务扫描结果状态,可供选择的状态值有:-1待触发 0待扫描 1扫描中 2扫描终止 3扫描成功 4扫描失败
示例值:[1,2]
Offset Integer 偏移量,默认为0
示例值:0
Limit Integer 返回结果集数量,默认值是10000,最大值为10000,根据该资源的个数限制条件,该资源的个数不会超过10000,所以如果不输入该字段,默认获取全量数据
示例值:20

3. 输出参数

参数名称 类型 描述
Items Array of DspaCOSDiscoveryTask 任务列表
示例值:[ { "TaskId": 1, "Name": "cos扫描任务", "Description": "", "Period": 0, "Plan": 0, "Enable": 1, "DataSourceInfo": { "ResourceRegion": "ap-guangzhou", "DataSourceId": "cos-d653b75c5bac583e5003012eff6cf40ecbadfe3c", "DataSourceName": "kyrie-cos-test-251007922", "ProxyAddress": [ ], "Condition": { "Bucket": "kyrie-cos-test-251007922", "FileTypes": [ ".txt" ], "FileSizeLimit": 102400 } }, "GeneralRuleSetEnable": 0, "TimingStartTime": "2024-11-07 22:40:19", "ComplianceUpdate": true, "Result": { "Id": 1, "EndTime": "2024-11-07 22:41:19", "Status": 4, "Result": "ComplianceConfigError" } } ]
TotalCount Integer 符合条件的任务列表数
示例值:1
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 获取COS分类分级任务列表

输入示例

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

{
    "DspaId": "dspa-12cd45g7",
    "TaskId": 0,
    "Name": "apple",
    "StatusList": [
        0
    ],
    "Offset": 0,
    "Limit": 10
}

输出示例

复制
复制成功
{
    "Response": {
        "Items": [
            {
                "Name": "cos分类分级任务",
                "Description": "cos分类分级任务",
                "Period": 0,
                "Plan": 0,
                "Enable": 1,
                "DataSourceInfo": {
                    "ResourceRegion": "ap-guangzhou",
                    "DataSourceId": "cos-d653b75c5bac583e5003012eff6cf40ecbadfe3c",
                    "DataSourceName": "kyrie-cos-test-251007922",
                    "ProxyAddress": [],
                    "Condition": {
                        "Bucket": "kyrie-cos-test-251007922",
                        "FileTypes": [
                            ".txt"
                        ],
                        "FileSizeLimit": 102400
                    }
                },
                "GeneralRuleSetEnable": 0,
                "TimingStartTime": "2024-11-07 22:40:19",
                "ComplianceUpdate": true,
                "Result": {
                    "Id": 1,
                    "EndTime": "2024-11-07 22:41:19",
                    "Status": 4,
                    "Result": "ComplianceConfigError"
                }
            }
        ],
        "RequestId": "0f3bffa9-2993-0df7-0301-4a8c9fe74aa7",
        "TotalCount": 0
    }
}

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 未知参数错误。

如果遇到产品相关问题,您可咨询 在线客服 寻求帮助。

返回顶部
可通过正文划词反馈文档内容问题,我们会快速处理并更新文档内容。