1. 接口描述
接口请求域名: dsgc.tencentcloudapi.com 。
修改分类分级任务,该接口只有在任务状态为以下状态时才支持正确修改:
0 待扫描,
2 扫描终止,
3 扫描成功,
4 扫描失败
默认接口请求频率限制:20次/秒。
                推荐使用 API Explorer
            
            点击调试
        
                API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
            
        2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 | 
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:ModifyDSPADiscoveryTask。 | 
| Version | 是 | String | 公共参数,本接口取值:2019-07-23。 | 
| Region | 是 | String | 公共参数,详见产品支持的 地域列表,本接口仅支持其中的: ap-guangzhou, ap-shanghai-fsi, ap-singapore 。 | 
| DspaId | 是 | String | DSPA实例ID 示例值:dspa-001  | 
| TaskId | 是 | Integer | 任务ID 示例值:1  | 
| Name | 否 | String | 任务名称,1-60个字符,仅允许输入中文、英文字母、数字、'_'、'-',并且开头和结尾需为中文、英文字母或者数字,Name不可重复 示例值:task  | 
| Description | 否 | String | 任务描述,最大长度为1024个字符 示例值:扫描任务  | 
| Enable | 否 | Integer | 任务开关,0 关闭,1 启用 示例值:1  | 
| DataSourceId | 否 | String | 数据源ID 示例值:datasource-00000000  | 
| Condition | 否 | String | 用于传入的数据源的条件,目前只支持数据库,所以目前表示数据库的名称,最多添加5个数据库,之间通过逗号分隔 示例值:db_1,db_2  | 
| GeneralRuleSetEnable | 否 | Integer | 通用规则集开关;0 关闭,1 启用 示例值:1  | 
| ComplianceGroupIds.N | 否 | Array of Integer | 合规组ID列表,最多支持添加5个 示例值:[1,2]  | 
| Plan | 否 | Integer | 执行计划; 0立即 1定时,选择“立即”时,扫描周期只能选择单次 示例值:1  | 
| Period | 否 | Integer | 扫描周期;0单次 1每天 2每周 3每月 示例值:1  | 
| TimingStartTime | 否 | String | 任务定时启动时间,格式:2006-01-02 15:04:05 当执行计划(Plan字段)为”立即“时,定时启动时间不会生效,此场景下给该字段传值不会被保存。 示例值:2006-01-02 15:04:05  | 
| ResourceRegion | 否 | String | 资源所在地域 示例值:ap-guangzhou  | 
| DataSourceType | 否 | String | 数据源类型,可取值如下: cdb 表示云数据库 MySQL, dcdb 表示TDSQL MySQL版, mariadb 表示云数据库 MariaDB, postgres 表示云数据库 PostgreSQL, cynosdbpg 表示TDSQL-C PostgreSQL版, cynosdbmysql 表示TDSQL-C MySQL版, selfbuilt-db 表示自建数据库 示例值:cdb  | 
| ScanRange | 否 | String | full:全量扫描 incre:变更扫描 示例值:full  | 
3. 输出参数
| 参数名称 | 类型 | 描述 | 
|---|---|---|
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 | 
4. 示例
示例1 修改分类分级任务
输入示例
POST / HTTP/1.1
Host: dsgc.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyDSPADiscoveryTask
<公共请求参数>
{
    "Enable": "1",
    "Name": "task",
    "ComplianceGroupIds": [
        "0"
    ],
    "GeneralRuleSetEnable": "1",
    "Period": "0",
    "TimingStartTime": "2021/4/2 10:46:18",
    "DspaId": "dspa-0001",
    "DataSourceId": "cdb-a1b2c3",
    "Plan": "0",
    "TaskId": "1",
    "Condition": "db1,db_2",
    "Description": "扫描任务"
}
输出示例
{
    "Response": {
        "RequestId": "20569756-56ba-4a13-b545-e1528d5cb239"
    }
}
5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: CNB, GitHub, Gitee
 - Tencent Cloud SDK 3.0 for Java: CNB, GitHub, Gitee
 - Tencent Cloud SDK 3.0 for PHP: CNB, GitHub, Gitee
 - Tencent Cloud SDK 3.0 for Go: CNB, GitHub, Gitee
 - Tencent Cloud SDK 3.0 for Node.js: CNB, GitHub, Gitee
 - Tencent Cloud SDK 3.0 for .NET: CNB, GitHub, Gitee
 - Tencent Cloud SDK 3.0 for C++: CNB, GitHub, Gitee
 - Tencent Cloud SDK 3.0 for Ruby: CNB, GitHub, Gitee
 
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
| 错误码 | 描述 | 
|---|---|
| InternalError | 内部错误。 | 
| InvalidParameter | 参数错误。 | 
| InvalidParameterValue | 参数取值错误。 | 
| LimitExceeded | 超过配额限制。 | 
| ResourceInUse | 资源被占用。 | 
| ResourceNotFound | 资源不存在。 | 
| ResourceUnavailable | 资源不可用。 | 
| UnauthorizedOperation | 未授权操作。 | 
| UnknownParameter | 未知参数错误。 | 
| UnsupportedOperation | 操作不支持。 |