查询已经存在的节点

最近更新时间:2019-08-15 21:15:15

1. 接口描述

接口请求域名: tke.tencentcloudapi.com 。

查询已经存在的节点,判断是否可以加入集群

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

注意:本接口支持金融区地域。由于金融区和非金融区是隔离不互通的,因此当公共参数 Region 为金融区地域(例如 ap-shanghai-fsi)时,需要同时指定带金融区地域的域名,最好和 Region 的地域保持一致,例如:tke.ap-shanghai-fsi.tencentcloudapi.com。

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeExistedInstances
Version String 公共参数,本接口取值:2018-05-25
Region String 公共参数,详见产品支持的 地域列表
ClusterId String 集群 ID,请填写查询集群列表 接口中返回的 ClusterId 字段(仅通过ClusterId获取需要过滤条件中的VPCID,比较状态时会使用该地域下所有集群中的节点进行比较。参数不支持同时指定InstanceIds和ClusterId。
InstanceIds.N Array of String 按照一个或者多个实例ID查询。实例ID形如:ins-xxxxxxxx。(此参数的具体格式可参考API简介的id.N一节)。每次请求的实例的上限为100。参数不支持同时指定InstanceIds和Filters。
Filters.N Array of Filter 过滤条件,字段和详见CVM查询实例如果设置了ClusterId,会附加集群的VPCID作为查询字段,在此情况下如果在Filter中指定了"vpc-id"作为过滤字段,指定的VPCID必须与集群的VPCID相同。
VagueIpAddress String 实例IP进行过滤(同时支持内网IP和外网IP)
VagueInstanceName String 实例名称进行过滤
Offset Integer 偏移量,默认为0。关于Offset的更进一步介绍请参考 API 简介中的相关小节。
Limit Integer 返回数量,默认为20,最大值为100。关于Limit的更进一步介绍请参考 API 简介中的相关小节。

3. 输出参数

参数名称 类型 描述
ExistedInstanceSet Array of ExistedInstance 已经存在的实例信息数组。
注意:此字段可能返回 null,表示取不到有效值。
TotalCount Integer 符合条件的实例数量。
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询已经存在的节点

查询已经存在的节点,判断是否可以加入集群

输入示例

https://tke.tencentcloudapi.com/?Action=DescribeExistedInstances
&ClusterId=cls-xxxxxxxx
&<公共请求参数>

输出示例

{
  "Response": {
    "TotalCount": 1,
    "ExistedInstanceSet": [
      {
        "Usable": true,
        "UnusableReason": "",
        "AlreadyInCluster": "",
        "InstanceId": "ins-xxxxxxxx",
        "InstanceName": "未命名",
        "PrivateIpAddresses": [
          "192.168.x.x"
        ],
        "PublicIpAddresses": [
          "118.24.x.x"
        ],
        "CreatedTime": "2019-05-13T03:37:24Z",
        "CPU": 2,
        "Memory": 4,
        "OsName": "Ubuntu xxxxxxxxx",
        "InstanceType": "Sxxxxxx"
      }
    ],
    "RequestId": "f12a6e20-f950-4af9-8f8b-b6329a4961c2"
  }
}

5. 开发者资源

API Explorer

该工具提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力,能显著降低使用云 API 的难度,推荐使用。

SDK

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

命令行工具

6. 错误码

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

错误码 描述
FailedOperation 操作失败
InternalError 内部错误
InternalError.AccountUserNotAuthenticated 账户未通过认证。
InternalError.CreateMasterFailed 创建集群失败。
InternalError.CvmCommon cvm创建节点报错。
InternalError.CvmNotFound cvm不存在。
InternalError.Db db错误。
InternalError.DbAffectivedRows DB影响函数错误。
InternalError.DbRecordNotFound 记录未找到。
InternalError.ImageIdNotFound 镜像未找到。
InternalError.InitMasterFailed 初始化master失败。
InternalError.InvalidPrivateNetworkCidr 无效CIDR。
InternalError.OsNotSupport 镜像OS不支持。
InternalError.Param Param。
InternalError.UnexceptedInternal UnexceptedInternal。
InternalError.VpcCommon VPC报错。
InternalError.VpcRecodrNotFound 未发现vpc记录。
InvalidParameter 参数错误
LimitExceeded 超过配额限制
MissingParameter 缺少参数错误
ResourceInUse 资源被占用
ResourceNotFound 资源不存在
ResourceUnavailable 资源不可用
UnauthorizedOperation 未授权操作
UnknownParameter 未知参数错误
UnsupportedOperation 操作不支持