1. 接口描述
接口请求域名: dsgc.tencentcloudapi.com 。
获取DSPA评估任务列表
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DescribeDSPAAssessmentTasks。 |
Version | 是 | String | 公共参数,本接口取值:2019-07-23。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表,本接口仅支持其中的: ap-beijing, ap-chengdu, ap-guangzhou, ap-shanghai, ap-shanghai-fsi 。 |
DspaId | 是 | String | DSPA实例Id,格式“dspa-xxxxxxxx” 示例值:dspa-ad0gf4ks |
Offset | 否 | Integer | 偏移量。默认为0 示例值:0 |
Limit | 否 | Integer | 结果集个数限制。默认为20,最大值为100 示例值:20 |
Filters.N | 否 | Array of DspaAssessmentFilter | 过滤项。支持模糊搜索:TaskId,TaskName支持过滤:BusinessName:业务名称BusinessDept:业务部门名称TemplateName:评估模板名称Status:评估状态 (waiting待评估,processing评估中, , finished已评估, failed评估失败) 示例值:[{"Name":"AssessmentId","Values":["1","2"]}] |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
TotalCount | Integer | 符合条件的评估任务数目 示例值:1 |
Items | Array of AssessmentTask | 评估任务列表 示例值:[{"TaskUid":11500,"TaskId":"task-yji1zgjm","TaskName":"一键评估1109-19491112127","BusinessName":"","BusinessDept":"","BusinessOwner":"","TemplateId":"template-Yzc2Z","TemplateUid":10171,"TemplateName":"身份认证","ComplianceGroupId":1,"ComplianceGroupName":"通用规则集","ControlItemCount":0,"RiskCount":24,"RiskCountInfoList":[{"RiskLevel":"high","RiskLevelName":"高","Count":0},{"RiskLevel":"medium","RiskLevelName":"中","Count":24},{"RiskLevel":"low","RiskLevelName":"低","Count":0}],"FinishedTime":"2024-11-09 19:51:33","CreatedTime":"2024-11-09 19:49:11","Status":"finished","DiscoveryCondition":{"RDBInstances":[],"COSInstances":[],"NOSQLInstances":[],"ESInstances":[]},"ErrorInfo":"","ProgressPercent":100}] |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 获取DSPA评估任务列表
输入示例
POST / HTTP/1.1
Host: dsgc.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeDSPAAssessmentTasks
<公共请求参数>
{
"DspaId": "dspa-92aabacd",
"Offset": 0,
"Limit": 10
}
输出示例
{
"Response": {
"TotalCount": 0,
"Items": [
{
"TaskUid": 11500,
"TaskId": "task-yji1zgjm",
"TaskName": "一键评估1109-19491112127",
"BusinessName": "",
"BusinessDept": "",
"BusinessOwner": "",
"TemplateId": "template-Yzc2Z",
"TemplateUid": 10171,
"TemplateName": "身份认证",
"ComplianceGroupId": 1,
"ComplianceGroupName": "通用规则集",
"ControlItemCount": 0,
"RiskCount": 24,
"RiskCountInfoList": [
{
"RiskLevel": "high",
"RiskLevelName": "高",
"Count": 0
},
{
"RiskLevel": "medium",
"RiskLevelName": "中",
"Count": 24
},
{
"RiskLevel": "low",
"RiskLevelName": "低",
"Count": 0
}
],
"FinishedTime": "2024-11-09 19:51:33",
"CreatedTime": "2024-11-09 19:49:11",
"Status": "finished",
"DiscoveryCondition": {
"RDBInstances": [],
"COSInstances": [],
"NOSQLInstances": [],
"ESInstances": []
},
"ErrorInfo": "",
"ProgressPercent": 100
}
],
"RequestId": "c9950094-26b3-9163-4fe0-3d60ae5a2d95"
}
}
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 | 操作不支持。 |