1. 接口描述
接口请求域名: csip.tencentcloudapi.com 。
获取扫描任务列表
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DescribeScanTaskList。 |
Version | 是 | String | 公共参数,本接口取值:2022-11-21。 |
Region | 否 | String | 公共参数,此参数为可选参数。 |
MemberId.N | 否 | Array of String | 集团账号的成员id 示例值:["mem-6wfo0fzks3","mem-85fo0fzks4"] |
Filter | 否 | Filter | 过滤内容 示例值:{"Limit":1} |
Tags.N | 否 | Array of Tags | 标签 示例值:[{"TagKey":"1","TagValue":"1"}] |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
TotalCount | Integer | 总条数 示例值:10 |
Data | Array of ScanTaskInfoList | 任务日志列表 示例值:[ { "AppId": "1302396215", "AssetNumber": 1, "Assets": [ { "Asset": "ins-0cl9wvfx", "AssetName": "kevan-", "AssetType": "Instance", "InstanceType": "CVM", "Region": "ap-shanghai" } ], "CSPMTaskId": "CspmTaskId-fa844539-e15c-4e29-9981-2e632477addf", "CSPMTaskProcess": 100, "CWPBlId": "cwpblt_oxrasjb6", "CWPBlProcess": 100, "CWPPOCId": "1", "CWPPOCProcess": 0, "CompleteAssetNumber": 1, "CompleteNumber": 1, "EndTime": "2024-10-30 11:23:50", "ErrorCode": 0, "ErrorInfo": "ok", "Frequency": 0, "InsertTime": "2024-10-30 11:18:09", "IsDelete": 1, "IsEdit": 0, "IsFree": 0, "Percent": 100, "PredictEndTime": "2024-10-30 11:18:09", "PredictTime": 6, "ReportNumber": 1, "RiskCount": 0, "ScanAssetType": 1, "ScanFrom": "csip", "ScanItem": "port,poc,weakpass,configrisk,exposedserver", "ScanPlanContent": "59 59 23 /1 * * *", "ScanStatus": 2, "SelfDefiningAssets": ["1.1.1.1"], "SourceType": 0, "StartDay": -1, "StartTime": "2024-10-30 11:18:09", "TaskId": "rmis-sv6we7ol", "TaskMode": 2, "TaskName": "advance_select_csip", "TaskType": 1, "UIN": "100014592178", "UserName": "声声乌龙", "VSSTaskId": "mis-*", "VSSTaskProcess": 0 } ] |
UINList | Array of String | 主账户ID列表 示例值:["100011949846", "100014592178"] |
TaskModeList | Array of FilterDataObject | 体检模式过滤列表 示例值:[{ "Text": "标准体检", "Value": "0" }, { "Text": "快速体检", "Value": "1" }, { "Text": "高级体检", "Value": "2" }] |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询任务列表
查询任务列表
输入示例
POST / HTTP/1.1
Host: csip.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeScanTaskList
<公共请求参数>
{
"MemberId": [
"mem-68b8087a65268000",
"mem-tencent-522badef8ad96a4d"
],
"Filter": {
"Limit": 1
}
}
输出示例
{
"Response": {
"Data": [
{
"AppId": "1302396215",
"AssetNumber": 1,
"Assets": [
{
"Asset": "ins-0cl9wvfx",
"AssetName": "kevan-**",
"AssetType": "Instance",
"InstanceType": "CVM",
"Region": "ap-shanghai"
}
],
"CSPMTaskId": "CspmTaskId-fa844539-e15c-4e29-9981-2e632477addf",
"CSPMTaskProcess": 100,
"CWPBlId": "cwpblt_oxrasjb6",
"CWPBlProcess": 100,
"CWPPOCId": "1",
"CWPPOCProcess": 0,
"CompleteAssetNumber": 1,
"CompleteNumber": 1,
"EndTime": "2024-10-30 11:23:50",
"ErrorCode": 0,
"ErrorInfo": "ok",
"Frequency": 0,
"InsertTime": "2024-10-30 11:18:09",
"IsDelete": 1,
"IsFree": 0,
"Percent": 100,
"PredictEndTime": "2024-10-30 11:18:09",
"PredictTime": 6,
"ReportNumber": 1,
"RiskCount": 0,
"ScanAssetType": 1,
"ScanFrom": "csip",
"ScanItem": "port,poc,weakpass,configrisk,exposedserver",
"ScanPlanContent": "59 59 23 */1 * * *",
"ScanStatus": 2,
"SelfDefiningAssets": [
"1.1.1.1"
],
"SourceType": 0,
"StartDay": -1,
"StartTime": "2024-10-30 11:18:09",
"TaskId": "rmis-sv6we7ol",
"TaskMode": 2,
"TaskName": "advance_select_csip",
"TaskType": 1,
"UIN": "100014592178",
"UserName": "声声乌龙",
"VSSTaskId": "mis-****",
"VSSTaskProcess": 0
}
],
"RequestId": "d32ed248-d824-4893-9cda-9530eced4bd1",
"TaskModeList": [
{
"Text": "标准体检",
"Value": "0"
},
{
"Text": "快速体检",
"Value": "1"
},
{
"Text": "高级体检",
"Value": "2"
}
],
"TotalCount": 229,
"UINList": [
"100011949846",
"100014592178"
]
}
}
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. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
AuthFailure | CAM签名/鉴权错误。 |
DryRunOperation | DryRun 操作,代表请求将会是成功的,只是多传了 DryRun 参数。 |
FailedOperation | 操作失败。 |
InternalError | 内部错误。 |
InvalidParameter | 参数错误。 |
InvalidParameterValue | 参数取值错误。 |
LimitExceeded | 超过配额限制。 |
MissingParameter | 缺少参数错误。 |
OperationDenied | 操作被拒绝。 |
RequestLimitExceeded | 请求的次数超过了频率限制。 |
ResourceInUse | 资源被占用。 |
ResourceInsufficient | 资源不足。 |
ResourceNotFound | 资源不存在。 |
ResourceUnavailable | 资源不可用。 |
ResourcesSoldOut | 资源售罄。 |
UnauthorizedOperation | 未授权操作。 |
UnknownParameter | 未知参数错误。 |
UnsupportedOperation | 操作不支持。 |