云安全中心创建节点列表导出任务

1. 接口描述

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

创建集群节点列表导出任务。导出字段包含节点ID、节点名称、公网IP、内网IP、节点类型、核数、客户端状态、运行状态。NodeType和ClientStatus、RunStatus均经过国际化翻译。支持Filter过滤（含ClientStatus内存过滤）。导出通过异步任务实现，返回JobId后前端轮询查询导出任务状态。

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：CreateClusterNodeListExportJob。
Version	是	String	公共参数，本接口取值：2022-11-21。
Region	否	String	公共参数，此参数为可选参数。
ClusterCaMD5	是	String	集群CA证书MD5（32位十六进制；唯一标识）入参限制：长度必须等于32个字符示例值：a1b2c3d4e5f6789012345678901234ab
MemberId.N	否	Array of String	集团账号的成员id 示例值：["mem-tencent-6f5795752f66e429"]
Filter	否	Filter	通用过滤条件列表。支持的过滤字段： NodeName：节点名称，模糊匹配。 NodeId：节点ID，精确匹配。 NodeUniqueID：节点唯一ID，精确匹配（NodeAssetID 为等价别名）。 NodeType：节点类型，精确匹配。取值：SUPER（超级节点）、MASTER（主节点）、WORKER（工作节点）。 RunStatus：节点运行状态，精确匹配。 InternalIP：内网IP，精确匹配。 ClientStatus：客户端状态，精确匹配。取值：ONLINE（在线）、OFFLINE（离线）、UNINSTALL（未安装）。
ExportFields.N	否	Array of String	导出字段列表（不传则导出全部字段）枚举值： NodeId：节点ID NodeName：节点名称 PublicIP：公网IP InternalIP：内网IP NodeType：节点类型（NORMAL普通节点 / SUPER超级节点 / WORKER / MASTER / ETCD） CoresCount：核数 ClientStatus：客户端状态（ONLINE在线 / OFFLINE离线 / UNINSTALL未安装） RunStatus：运行状态（Running运行中 / Exception异常）示例值：["NodeId","NodeName","PublicIP","InternalIP","NodeType","CoresCount","ClientStatus","RunStatus"]

3. 输出参数

参数名称	类型	描述
JobId	String	导出任务ID 取值参考：前端轮询导出任务状态时使用示例值：export-job-node-12345
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 创建集群节点列表导出任务示例

输入示例

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

{
    "ClusterCaMD5": "a1b2c3d4e5f6789012345678901234ab",
    "Filter": {
        "Filters": [
            {
                "Name": "ClientStatus",
                "Values": [
                    "ONLINE"
                ]
            }
        ]
    },
    "ExportFields": [
        "NodeId",
        "NodeName",
        "PublicIP",
        "InternalIP",
        "NodeType",
        "CoresCount",
        "ClientStatus",
        "RunStatus"
    ]
}

输出示例

{
    "Response": {
        "JobId": "export-job-node-12345",
        "RequestId": "5cd96106-1d72-466c-9bcf-9876543210ab"
    }
}

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. 错误码

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

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

创建节点列表导出任务

本页目录：