API 中心
开发与运维产品文档捉虫活动邀您参加！> HOT
文档中心>API 中心>云安全中心>资产中心相关接口>集群列表

集群列表

最近更新时间：2024-12-26 18:44:50

我的收藏

本页目录：

1. 接口描述

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

集群列表

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action 是 String 公共参数，本接口取值：DescribeClusterAssets。
Version 是 String 公共参数，本接口取值：2022-11-21。
Region 否 String 公共参数，此参数为可选参数。
MemberId.N 否 Array of String 集团账号的成员id
示例值：["mem-6wfo0fzks3","mem-85fo0fzks4"]
Filter 否 Filter 过滤
示例值：[ { "Name": "TimeRange", "Values": [ "2" ], "OperatorType": 7 } ]

3. 输出参数

参数名称 类型 描述
Data Array of AssetCluster 列表
示例值：[ { "AppId": 1302396215, "AssetId": "cls-bc1916ky", "AssetName": "benben" } ]
TotalCount Integer 总数
示例值：8
ClusterTypeList Array of FilterDataObject 集群类型枚举
示例值：[ { "Text": "托管集群", "Value": "managed_cluster" } ]
ClusterStatusList Array of FilterDataObject 集群状态枚举
示例值：[ { "Text": "运行中", "Value": "running" } ]
ComponentStatusList Array of FilterDataObject 组件状态枚举
示例值：[ { "Text": "未安装", "Value": "defender_uninstall" } ]
VpcList Array of FilterDataObject 私有网络枚举
示例值：[ { "Text": "wy conflict", "Value": "vpc-39sc6ru5" } ]
RegionList Array of FilterDataObject 地域枚举
示例值：[ { "Text": "广州", "Value": "ap-guangzhou" } ]
AppIdList Array of FilterDataObject 租户枚举
示例值：[ { "Text": "1300448058", "Value": "1300448058" } ]
ProtectStatusList Array of FilterDataObject 集群防护状态枚举
示例值：[{"Text":"未接入","Value":"0"},{"Text":"未防护","Value":"1"},{"Text":"防护中","Value":"3"}]
RequestId String 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 空示例

空示例

输入示例

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

{
    "Filter": {
        "Filters": [
            {
                "Name": "TimeRange",
                "Values": [
                    "2"
                ],
                "OperatorType": 7
            }
        ],
        "Limit": 10,
        "Offset": 0,
        "Order": "desc",
        "By": "InstanceCreateTime"
    },
    "MemberId": [
        "mem-b21i4hgxa"
    ]
}

输出示例

{
    "Response": {
        "AppIdList": [
            {
                "Text": "1300448058",
                "Value": "1300448058"
            },
            {
                "Text": "1302396215",
                "Value": "1302396215"
            },
            {
                "Text": "1305350016",
                "Value": "1305350016"
            }
        ],
        "ClusterStatusList": [
            {
                "Text": "运行中",
                "Value": "running"
            }
        ],
        "ClusterTypeList": [
            {
                "Text": "托管集群",
                "Value": "managed_cluster"
            },
            {
                "Text": "弹性集群",
                "Value": "eks"
            }
        ],
        "ComponentStatusList": [
            {
                "Text": "未安装",
                "Value": "defender_uninstall"
            }
        ],
        "Data": [
            {
                "AppId": 1302396215,
                "AssetId": "cls-bc1916ky",
                "AssetName": "benben",
                "AssetType": "managed_cluster",
                "Region": "ap-guangzhou",
                "ServiceCount": 17,
                "PodCount": 41,
                "MachineCount": 1,
                "VpcId": "vpc-fw2ndu5f",
                "KubernetesVersion": "1.30.0",
                "Component": "containerd",
                "CheckCount": 43,
                "VulRisk": 0,
                "CFGRisk": 1,
                "InstanceCreateTime": "2024-12-04 10:33:08",
                "Status": "running",
                "ComponentStatus": "defended",
                "Uin": "100014592178",
                "VpcName": "fengqqian2test",
                "CheckTime": "",
                "ComponentVersion": "1.6.9",
                "Nick": "声声乌龙",
                "IsCore": 1,
                "IsNewAsset": 0,
                "ProtectStatus": 0,
                "ProtectInfo": "AccessedSubNone",
                "CloudType": 0
            }
        ],
        "ProtectStatusList": [
            {
                "Text": "未接入",
                "Value": "0"
            },
            {
                "Text": "未防护",
                "Value": "1"
            },
            {
                "Text": "部分防护",
                "Value": "2"
            },
            {
                "Text": "防护中",
                "Value": "3"
            },
            {
                "Text": "接入异常",
                "Value": "4"
            },
            {
                "Text": "接入中",
                "Value": "5"
            },
            {
                "Text": "卸载中",
                "Value": "6"
            },
            {
                "Text": "卸载异常",
                "Value": "7"
            }
        ],
        "RegionList": [
            {
                "Text": "广州",
                "Value": "ap-guangzhou"
            }
        ],
        "RequestId": "035c9d95-a2da-465e-b735-535d9afed6cf",
        "TotalCount": 1,
        "VpcList": [
            {
                "Text": "wy conflict",
                "Value": "vpc-39sc6ru5"
            },
            {
                "Text": "Default-VPC",
                "Value": "vpc-ommo5hlv"
            },
            {
                "Text": "fengqqian2test",
                "Value": "vpc-fw2ndu5f"
            },
            {
                "Text": "gordan-test1",
                "Value": "vpc-q1of50wz"
            }
        ]
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

该接口暂无业务逻辑相关的错误码，其他错误码详见 公共错误码。

中国站
文档活动
message-icon联系我们
目录