有奖捉虫:办公协同&微信生态&物联网文档专题 HOT

1. 接口描述

接口请求域名: tcss.tencentcloudapi.com 。

查询漏洞防御事件列表

默认接口请求频率限制:20次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeVulDefenceEvent。
Version String 公共参数,本接口取值:2020-11-01。
Region String 公共参数,此参数为可选参数。
Filters.N Array of RunTimeFilters 过滤条件。
  • Status- String - 是否必填:否 - 插件状态,待处理:EVENT_UNDEAL,EVENT_DEALED:已处理,已忽略:EVENT_IGNORE, EVENT_DEFENDED:已防御
  • ContainerStatus- String - 是否必填:否 - 容器运行状态筛选,已创建:CREATED,正常运行:RUNNING, 暂定运行:PAUSED, 停止运行: STOPPED,重启中:RESTARTING, 迁移中:REMOVING, 销毁:DESTROYED
  • ContainerNetStatus- String -是否必填: 否 - 容器网络状态筛选 未隔离:NORMAL,已隔离:ISOLATED,隔离失败:ISOLATE_FAILED,解除隔离失败:RESTORE_FAILED,解除隔离中:RESTORING,隔离中:ISOLATING
  • EventType - String -是否必填: 否 - 入侵状态,防御成功:EVENT_DEFENDED,尝试攻击:EVENT_ATTACK
  • TimeRange- String -是否必填: 否 - 时间范围,第一个值表示开始时间,第二个值表示结束时间
  • VulName- string - 是否必填:否 - 漏洞名称。
  • CVEID- string - 是否必填:否 - CVE编号。
  • SourceIP- string - 是否必填:否 - 攻击源IP。
  • ContainerName- string - 是否必填:否 - 容器名称。
  • ContainerID- string - 是否必填:否 - 容器ID。
  • ImageName- string - 是否必填:否 - 镜像名称。
  • ImageID- string - 是否必填:否 - 镜像ID。
  • HostName- string - 是否必填:否 - 主机名称。
  • HostIP- string - 是否必填:否 - 内网IP。
  • Limit Integer 需要返回的数量,默认为10,最大值为100
    示例值:10
    Offset Integer 偏移量,默认为0。
    示例值:0
    Order String 排序方式:asc/desc
    By String 排序字段:事件数量:EventCount

    3. 输出参数

    参数名称 类型 描述
    List Array of VulDefenceEvent 漏洞防御事件列表
    TotalCount Integer 总数量
    示例值:1
    RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

    4. 示例

    示例1 查询漏洞防御事件列表

    DescribeVulDefenceEvent

    输入示例

    POST / HTTP/1.1
    Host: tcss.tencentcloudapi.com
    Content-Type: application/json
    X-TC-Action: DescribeVulDefenceEvent
    <公共请求参数>
    
    {
        "Limit": "10",
        "Offset": "0"
    }

    输出示例

    {
        "Response": {
            "List": [
                {
                    "CVEID": "abc",
                    "VulName": "abc",
                    "PocID": "abc",
                    "EventType": "abc",
                    "SourceIP": "abc",
                    "City": "abc",
                    "EventCount": 0,
                    "ContainerID": "abc",
                    "ContainerName": "abc",
                    "ImageID": "abc",
                    "ImageName": "abc",
                    "Status": "abc",
                    "EventID": 0,
                    "CreateTime": "abc",
                    "ContainerNetStatus": "abc",
                    "MergeTime": "abc",
                    "ContainerStatus": "abc",
                    "ContainerNetSubStatus": "abc",
                    "ContainerIsolateOperationSrc": "abc",
                    "QUUID": "abc",
                    "HostIP": "abc",
                    "HostName": "abc",
                    "ClusterID": "abc",
                    "NodeType": "abc"
                }
            ],
            "TotalCount": 0,
            "RequestId": "abc"
        }
    }

    5. 开发者资源

    腾讯云 API 平台

    腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

    API Inspector

    用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

    SDK

    云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

    命令行工具

    6. 错误码

    以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

    错误码 描述
    AuthFailure CAM签名/鉴权错误。
    FailedOperation 操作失败。
    InvalidParameter 参数错误。
    InvalidParameter.InvalidFormat 参数格式错误。
    InvalidParameter.MissingParameter 缺少必须参数。
    InvalidParameter.ParsingError 参数解析错误。
    InvalidParameterValue 参数取值错误。
    MissingParameter 缺少参数错误。
    UnknownParameter 未知参数错误。