iOA 零信任安全管理系统查询边缘节点列表

1. 接口描述

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

查询边缘节点列表，私有化调用path为：capi/DlpOpenApi/DescribeDLPEdgeNodes

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：DescribeDLPEdgeNodes。
Version	是	String	公共参数，本接口取值：2022-06-01。
Region	是	String	公共参数，详见产品支持的地域列表。
DomainInstanceId	否	String	管理域实例ID，用于CAM管理域权限分配。若企业未进行管理域的划分，可直接传入根域"1"，此时表示针对当前企业的全部设备和账号进行接口CRUD，具体CRUD的影响范围限制于相应接口的入参。示例值：1
Condition	否	Condition	过滤条件、分页参数 EdgeNodeName - string - 是否必填：否 - 操作符: ilike - 排序支持：否- 按节点名称过滤。

3. 输出参数

参数名称	类型	描述
Data	DescribeDLPEdgeNodesPageData	业务响应数据
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询边缘节点

查询指定分组的边缘节点

输入示例

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

{
    "Condition": {
        "PageNum": 1,
        "PageSize": 10,
        "Filters": [
            {
                "Field": "GroupId",
                "Operator": "eq",
                "Values": [
                    "ioa_default_group_id"
                ]
            }
        ],
        "Sort": {
            "Field": "UTime",
            "Order": "desc"
        }
    }
}

输出示例

{
    "Response": {
        "Data": {
            "Items": [
                {
                    "EdgeNodeId": "d2hi48v7sdjjc675mpc0",
                    "EdgeNodeName": "深圳节点3",
                    "GroupId": "d2hhpaf7sdjjc675mp5g",
                    "GroupName": "深圳节点",
                    "Id": 6,
                    "Ip": "1.1.1.3"
                },
                {
                    "EdgeNodeId": "d2hi47f7sdjjc675mpbg",
                    "EdgeNodeName": "深圳节点2",
                    "GroupId": "d2hhpaf7sdjjc675mp5g",
                    "GroupName": "深圳节点",
                    "Id": 5,
                    "Ip": "1.1.1.2"
                }
            ],
            "Page": {
                "PageCount": 1,
                "PageNum": 1,
                "PageSize": 10,
                "Total": 5
            }
        },
        "RequestId": "e853fda5-34fb-42e2-8c72-b8bbcc9e8906"
    }
}

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: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Java: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for PHP: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Go: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Node.js: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for .NET: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for C++: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Ruby: CNB, GitHub, Gitee

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

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

错误码	描述
FailedOperation.QueryData	查询数据失败。
InternalError.DatabaseException	内部错误，数据库异常。
InternalError.Unknown	内部未知错误。
InvalidParameter.RequestParam	请求参数错误。
MissingParameter.CommonParam	缺少公共参数。
ResourceNotFound.NotFound	资源不存在。

查询边缘节点列表

本页目录：