查询集群视图

1. 接口描述

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

查询集群各视图数据，包括集群维度、节点维度、Kibana维度

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

2. 输入参数

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

3. 输出参数

4. 示例

示例1 查询集群视图

查询集群视图

输入示例

https://es.tencentcloudapi.com/?Action=DescribeViews
&InstanceId=es-xxxxxxxx
&<公共请求参数>

输出示例

{
    "Response": {
        "ClusterView": {
            "Health": 0,
            "Visible": 0,
            "Break": 0,
            "AvgDiskUsage": 0,
            "AvgMemUsage": 0,
            "AvgCpuUsage": 0,
            "TotalDiskSize": 1,
            "TargetNodeTypes": [
                "abc"
            ],
            "NodeNum": 0,
            "TotalNodeNum": 0,
            "DataNodeNum": 0,
            "IndexNum": 0,
            "DocNum": 0,
            "DiskUsedInBytes": 0,
            "ShardNum": 0,
            "PrimaryShardNum": 0,
            "RelocatingShardNum": 0,
            "InitializingShardNum": 0,
            "UnassignedShardNum": 0,
            "TotalCosStorage": 0,
            "SearchableSnapshotCosBucket": "abc",
            "SearchableSnapshotCosAppId": "abc"
        },
        "NodesView": [
            {
                "NodeId": "abc",
                "NodeIp": "abc",
                "Visible": 0,
                "Break": 0,
                "DiskSize": 0,
                "DiskUsage": 0,
                "MemSize": 0,
                "MemUsage": 0,
                "CpuNum": 0,
                "CpuUsage": 0,
                "Zone": "abc",
                "NodeRole": "abc",
                "NodeHttpIp": "abc",
                "JvmMemUsage": 0,
                "ShardNum": 0,
                "DiskIds": [
                    "abc"
                ],
                "Hidden": true,
                "IsCoordinationNode": true
            }
        ],
        "KibanasView": [
            {
                "Ip": "abc",
                "DiskSize": 0,
                "DiskUsage": 0,
                "MemSize": 0,
                "MemUsage": 0,
                "CpuNum": 0,
                "CpuUsage": 0,
                "Zone": "abc",
                "NodeId": "abc"
            }
        ],
        "RequestId": "abc"
    }
}

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

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