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-singapore 。 |
DspaId | 是 | String | DSPA实例ID 示例值:dspa-001 |
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 示例值:datasource-00000000 |
DbName | 否 | String | 数据库名称 示例值:db1 |
Offset | 否 | Integer | 偏移量,默认值为0 示例值:0 |
Limit | 否 | Integer | 返回数量,默认值为20,最大值为100 示例值:1 |
ResourceRegion | 否 | String | 资源所在地域 示例值:ap-guangzhou |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
Items | Array of DspaDiscoveryTaskDbResult | 扫描任务结果项 注意:此字段可能返回 null,表示取不到有效值。 |
TotalCount | Integer | 符合条件的扫描任务结果记录数 注意:此字段可能返回 null,表示取不到有效值。 示例值:1 |
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-001",
"Limit": "1",
"TaskId": "1",
"Offset": "0",
"TaskName": "test"
}
输出示例
{
"Response": {
"RequestId": "20569756-56ba-4a13-b545-e1528d5cb239",
"TotalCount": 1,
"Items": [
{
"DbResultId": 3,
"TaskId": 28,
"TaskName": "898111",
"DbName": "testdb",
"TotalTables": 2
}
]
}
}
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: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
InternalError | 内部错误。 |
InvalidParameter | 参数错误。 |
InvalidParameterValue | 参数取值错误。 |
ResourceNotFound | 资源不存在。 |
ResourceUnavailable | 资源不可用。 |
UnauthorizedOperation | 未授权操作。 |
UnknownParameter | 未知参数错误。 |
UnsupportedOperation | 操作不支持。 |