iOA 零信任安全管理系统按终端查看软件统计信息

1. 接口描述

接口请求域名： ioa.tencentcloudapi.com 。

查看终端树下的软件列表,私有化调用path为：capi/Software/DescribeSoftCensusListByDevice

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：DescribeSoftCensusListByDevice。
Version	是	String	公共参数，本接口取值：2022-06-01。
Region	否	String	公共参数，本接口不需要传递此参数。
OsType	否	Integer	必填，系统类型（0: win，1：linux，2: mac，4：android，5：ios ）示例值：0
GroupId	否	Integer	必填，终端分组ID 示例值：11668614
Condition	否	Condition	过滤条件、分页参数 Name - String - 是否必填：否 - 操作符: eq,like,ilike - 排序支持：否 - 备注：字段含义，终端名。 UserName - String - 是否必填：否 - 操作符: eq,like,ilike - 排序支持：否 - 备注：字段含义，终端用户名。 IoaUserName - String - 是否必填：否 - 操作符: eq,like,ilike - 排序支持：否 - 备注：字段含义，最近登录账号。 Ip - String - 是否必填：否 - 操作符: eq,like,ilike - 排序支持：否 - 备注：字段含义，IP地址。 MacAddr - String - 是否必填：否 - 操作符: eq,like,ilike - 排序支持：否 - 备注：字段含义，MAC地址。示例值：{"PageNum":1,"PageSize":20,"Filters":[{"Field":"Name","Values":["lucal"],"Operator":"ilike"}]}

3. 输出参数

参数名称	类型	描述
Data	DescribeSoftCensusListByDevicePageData	业务响应数据注意：此字段可能返回 null，表示取不到有效值。
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 按终端查看软件统计

输入示例

POST / HTTP/1.1
Host: ioa.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeSoftCensusListByDevice
<公共请求参数>

{
    "OsType": 0,
    "GroupId": 1
}

输出示例

{
    "Response": {
        "Data": {
            "Items": [
                {
                    "GroupId": 11668634,
                    "SoftNum": 0,
                    "IoaUserName": "",
                    "MacAddr": "",
                    "PiracyRisk": 2,
                    "Mid": "1EBWA5184BEC838B96B29CE8105EC66167F8CFBD",
                    "GroupName": "dddd",
                    "Name": "lucal_win-PC",
                    "Ip": "119.147.10.202",
                    "Id": 288661,
                    "GroupNamePath": "全网终端.dddd",
                    "UserName": "lucal_win"
                },
                {
                    "GroupId": 11668615,
                    "SoftNum": 161,
                    "IoaUserName": "",
                    "MacAddr": "B0:DC:EF:E7:37:EA",
                    "PiracyRisk": 2,
                    "Mid": "8314BF3FD3FD738410C4FBB0DDDA48786800AB00",
                    "GroupName": "未分组终端",
                    "Name": "STEVENSSHE-NBIR",
                    "Ip": "119.147.10.192",
                    "Id": 288663,
                    "GroupNamePath": "全网终端.未分组终端",
                    "UserName": "Administrator"
                },
                {
                    "GroupId": 11668615,
                    "SoftNum": 0,
                    "IoaUserName": "",
                    "MacAddr": "B0:DC:EF:E7:37:EE",
                    "PiracyRisk": 2,
                    "Mid": "489C698CAECC13B1B7C44E59443F5CBB676B7F33",
                    "GroupName": "未分组终端",
                    "Name": "cs-207addad83ae",
                    "Ip": "113.108.77.70",
                    "Id": 288664,
                    "GroupNamePath": "全网终端.未分组终端",
                    "UserName": "Administrator"
                }
            ],
            "Page": {
                "PageSize": 10,
                "PageNum": 1,
                "PageCount": 1,
                "Total": 3
            }
        },
        "RequestId": "8104e997-1a80-4697-afeb-cb2154bb0235"
    }
}

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

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

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

错误码	描述
InternalError.DatabaseException	内部错误，数据库异常。
InternalError.Unknown	内部未知错误。

按终端查看软件统计信息

本页目录：