1. 接口描述
接口请求域名: ssa.tencentcloudapi.com 。
拉取告警列表
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DescribeSocAlertList。 |
Version | 是 | String | 公共参数,本接口取值:2018-06-08。 |
Region | 否 | String | 公共参数,本接口不需要传递此参数。 |
PageSize | 是 | Integer | 页大小 示例值:1 |
PageIndex | 是 | Integer | 页码 示例值:1 |
Scenes | 是 | Integer | 1:急需关注 2.重保监控 3.全量告警 示例值:1 |
Filter.N | 否 | Array of QueryFilter | 查询参数 示例值:"asd" |
Sorter.N | 否 | Array of QuerySort | 排序参数 示例值:"asd" |
ExportFlag | 否 | Boolean | 是否导出;默认为否,如量级超过1000,则使用单独的导出接口 示例值:false |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
Data | AlertListData | 业务数据 |
RequestId | String | 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 demo
输入示例
POST / HTTP/1.1
Host: ssa.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeSocAlertList
<公共请求参数>
{
"Filter": [
{
"FilterKey": "abc",
"FilterOperatorType": 0,
"FilterValue": "abc"
}
],
"Sorter": [
{
"SortKey": "abc",
"SortType": 0
}
],
"PageSize": 0,
"PageIndex": 0,
"Scenes": 0,
"ExportFlag": true
}
输出示例
{
"Response": {
"Data": {
"Total": 0,
"AlertList": [
{
"AlertTime": "abc",
"AlertId": "abc",
"AssetId": "abc",
"AssetPrivateIp": [
"abc"
],
"AlertName": "abc",
"Level": 0,
"Type": "abc",
"Source": "abc",
"AttackChain": "abc",
"AttackId": "abc",
"Concerns": [
{
"ConcernType": 0,
"EntityType": 0,
"Concern": "abc",
"StatisticsCount": 0,
"IpCountry": "abc",
"IpProvince": "abc",
"Result": "abc",
"Confidence": 0,
"IpIsp": "abc",
"IpInfrastructure": "abc",
"ThreatType": [
"abc"
],
"Groups": [
"abc"
],
"Status": "abc",
"Tags": [
"abc"
],
"VictimAssetType": "abc",
"VictimAssetName": "abc",
"DomainRegistrant": "abc",
"DomainRegisteredInstitution": "abc",
"DomainRegistrationTime": "abc",
"FileName": "abc",
"FileMd5": "abc",
"VirusName": "abc",
"FilePath": "abc",
"FileSize": "abc",
"ProcName": "abc",
"Pid": "abc",
"ProcPath": "abc",
"ProcUser": "abc",
"DefendedCount": 1,
"DetectedCount": 1,
"SearchData": "abc",
"IpCountryIso": "abc",
"IpProvinceIso": "abc",
"IpCity": "abc",
"EventSubType": "abc"
}
],
"Action": 0,
"AttackResult": 0,
"EventStatus": 0,
"EventId": "abc",
"Status": 0,
"AssetName": "abc",
"ConcernMaliciousCount": 0,
"ConcernVictimCount": 0,
"VictimAssetType": "abc",
"SubType": "abc",
"AttackName": "abc",
"AssetPublicIp": [
"abc"
],
"AttackTactic": "abc",
"VictimAssetSub": "abc",
"VictimAssetVpc": "abc",
"Timestamp": "abc",
"AssetGroupName": [
"abc"
],
"AssetProjectName": "abc",
"VictimAssetContent": [
"abc"
],
"WrongReportStatus": 0,
"WrongReportConditionId": 0
}
],
"Aggregations": {
"Name": "abc",
"Value": "abc"
}
},
"RequestId": "abc"
}
}
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. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
LimitExceeded | 超过配额限制。 |