查询安全日志接入对象列表

最近更新时间:2024-10-31 02:10:09

我的收藏

1. 接口描述

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

查询安全日志接入对象列表

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeSecLogJoinObjectList。
Version String 公共参数,本接口取值:2020-11-01。
Region String 公共参数,此参数为可选参数。
LogType String 日志类型
bash: "container_bash",
启动: "container_launch",
"k8s": "k8s_api"
示例值:container_bash
Limit Integer 需要返回的数量,默认为10,最大值为100
示例值:10
Offset Integer 偏移量,默认为0。
示例值:1
Filters.N Array of RunTimeFilters 过滤条件。
  • Status- String - 是否必填:否 - 主机状态
  • HostIP- String - 是否必填:否 - 主机内网IP
  • PublicIP- String - 是否必填:否 - 主机外网IP
  • HostName- String - 是否必填:否 - 主机名称

  • 示例值:[]
    By String 排序字段
    Order String 排序方式
    示例值:asc

    3. 输出参数

    参数名称 类型 描述
    TotalCount Integer 总数
    示例值:10
    List Array of SecLogJoinObjectInfo 接入对象列表
    RangeType Integer 日志节点范围类型,0自选 1全部
    示例值:0
    AutoJoin Boolean 新增资产是否自动加入,节点范围为全部时生效
    示例值:true
    ExcludedCount Integer 剔除节点数
    示例值:0
    RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

    4. 示例

    示例1 查询安全日志接入对象列表

    查询安全日志接入对象列表

    输入示例

    POST / HTTP/1.1
    Host: tcss.tencentcloudapi.com
    Content-Type: application/json
    X-TC-Action: DescribeSecLogJoinObjectList
    <公共请求参数>
    
    {
        "LogType": "container_bash",
        "Offset": 0,
        "Limit": 10,
        "Filters": [
            {
                "Name": "Status",
                "Values": [
                    "ONLINE",
                    "OFFLINE",
                    "UNINSTALL"
                ],
                "ExactMatch": true
            }
        ]
    }

    输出示例

    {
        "Response": {
            "AutoJoin": false,
            "ExcludedCount": 0,
            "List": [
                {
                    "ClusterID": "cls-q0bc0ed2",
                    "ClusterMainAddress": "",
                    "ClusterName": "tke2",
                    "ClusterStatus": "",
                    "ClusterType": "",
                    "ClusterVersion": "v1.26.1-tke.5",
                    "ContainerCnt": 23,
                    "HostID": "3b6b1bbc-1c7a-47e2-9ca8-e9c27ec9d068",
                    "HostIP": "172.17.1.6",
                    "HostName": "tke_cls-q0bc0ed2_worker",
                    "HostStatus": "ONLINE",
                    "JoinState": true,
                    "PublicIP": "159.75.90.217"
                }
            ],
            "RangeType": 1,
            "RequestId": "a38b89a7-fbdf-4133-9981-1c09a5a94895",
            "TotalCount": 55
        }
    }

    5. 开发者资源

    腾讯云 API 平台

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

    API Inspector

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

    SDK

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

    命令行工具

    6. 错误码

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

    错误码 描述
    InternalError 内部错误。
    InvalidParameter 参数错误。