文档平台 API 中心 容器服务 集群相关接口 查询加入集群的主机列表

查询加入集群的主机列表

最近更新时间:2018-07-13 10:25:29

接口描述

本接口 ( DescribeExistedCvmForAddClusterInstances ) 用于查询加入集群的主机列表。

接口请求域名:

ccs.api.qcloud.com

输入参数

以下请求参数列表仅列出了接口请求参数,其它参数见 公共请求参数

参数名称 描述 类型 必选
clusterId 集群 ID,请填写 查询集群列表 接口中返回的 clusterId 字段 String
instanceName 主机名称过滤,支持模糊查询,默认为空,不过滤 String
ip IP 过滤,支持外网和内网 IP,支持模糊查询,默认为空,不过滤 String
instanceIds 实例列表,默认为空 []String

输出参数

参数名称 描述 类型
code 公共错误码。0 表示成功,其他值表示失败 Int
codeDesc 业务错误码。成功时返回 Success,错误时返回具体业务错误原因 String
message 模块错误信息描述,与接口相关 String
data 日志收集规则相关数据 Object

data 字段的结构如下:

参数名称 描述 类型
totalCount 集群所在 VPC 下所有节点总数 Int
deviceList 节点信息列表 []Object

deviceList 字段的结构如下:

参数名称 描述 类型
instanceName 实例名称 String
lanIp 实例内网 IP String
wanIp 实例外网 IP String
instanceId 实例 ID 查询,实例 ID 示例:ins-11112222 String
instanceCreateTime 实例创建时间,例如:2018-05-30 23:30:35 Date
usable 是否可用 Bool
unusableReason 不可用原因描述:
  • “already in Cluster”:已经添加到集群中,过滤掉;
  • “cvm status error”:CVM 状态不是运行中,过滤掉;
  • “windows and Local disk”:CVM 限制 Windows 本地盘不支持重装,过滤掉
  • String

    示例

    输入

      https://domain/v2/index.php?Action=GetLogDaemonStatus
      &clusterId=cls-xxxxxx
      &其它公共参数
    

    输出

    {
        "data":{
            "code":0,
            "message":"",
            "codeDesc":"Success",
            "data":{
                "totalCount":11,
                "deviceList":[
                    {
                        "instanceName":"演示主机B",
                        "lanIp":"xxx.xxx.xxx.xxx",
                        "wanIp":"xxx.xxx.xxx.xxx",
                        "instanceId":"ins-xxxxxxxx",
                        "instanceCreateTime":"2018-05-30 xx:xx:xx",
                        "usable":false,
                        "unusableReason":"already in Cluster"
                    }
                    ]
        },
        "message":"",
        "code":0
    }