DescribeExistedInstances
最近更新时间: 2025-10-20 17:05:58
1. 接口描述
接口请求域名： tke.api3.fincloud.tencent.cn。
查询已经存在的节点，判断是否可以加入集群
默认接口请求频率限制：20次/秒。
接口更新时间：2021-04-09 10:37:29。
接口既验签名又鉴权。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。
| 参数名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Action | 是 | 否 | String | 公共参数，本接口取值：DescribeExistedInstances |
| Version | 是 | 否 | String | 公共参数，本接口取值：2018-05-25 |
| Region | 是 | 否 | String | 公共参数，地域信息可通过DescribeRegions接口查看产品支持的地域列表 |
| ClusterId | 否 | 否 | String | 集群 ID，请填写查询集群列表 接口中返回的 ClusterId 字段（仅通过ClusterId获取需要过滤条件中的VPCID。节点状态比较时会使用该地域下所有集群中的节点进行比较。参数不支持同时指定InstanceIds和ClusterId。 |
| InstanceIds | 否 | 否 | Array of String | 按照一个或者多个实例ID查询。实例ID形如：ins-xxxxxxxx。（此参数的具体格式可参考API简介的id.N一节）。每次请求的实例的上限为100。参数不支持同时指定InstanceIds和Filters。 |
| Filters | 否 | 否 | Array of Filter | 过滤条件,字段和详见DescribeInstances如果设置了ClusterId，会附加集群的VPCID作为查询字段，在此情况下如果在Filter中指定了"vpc-id"作为过滤字段，指定的VPCID必须与集群的VPCID相同。 |
| VagueIpAddress | 否 | 否 | String | 实例IP进行过滤(同时支持内网IP和外网IP) |
| VagueInstanceName | 否 | 否 | String | 实例名称进行过滤 |
| Offset | 否 | 否 | Uint64 | 偏移量，默认为0。用来控制分页的参数；Limit 为单次返回的最多条目数量，Offset 为偏移量。当相应结果是列表形式时，如果数量超过了 Limit 所限定的值，那么只返回 Limit 个值。 |
| Limit | 否 | 否 | Uint64 | 返回数量，默认为20，最大值为100。用来控制分页的参数；Limit 为单次返回的最多条目数量，Offset 为偏移量。当相应结果是列表形式时，如果数量超过了 Limit 所限定的值，那么只返回 Limit 个值。 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| ExistedInstanceSet | ExistedInstance | 已经存在的实例信息数组。 |
| TotalCount | Uint64 | 符合条件的实例数量。 |
| RequestId | String | 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。
| 错误码 | 描述 |
|---|---|
| InternalError | 内部错误 |
| InternalError.DbAffectivedRows | DB错误 |
| InternalError.DbRecordNotFound | 记录未找到。 |
| InvalidParameter | 参数错误 |
| InternalError.CreateMasterFailed | 创建集群失败。 |
| InternalError.OsNotSupport | 镜像OS不支持。 |
| LimitExceeded | 超过配额限制 |
| InternalError.ImageIdNotFound | 镜像未找到。 |
| InternalError.Db | db错误。 |
| InternalError.VpcRecodrNotFound | 未发现vpc记录。 |
| UnauthorizedOperation | 未授权操作 |
| FailedOperation | 操作失败 |
| InternalError.AccountUserNotAuthenticated | 账户未通过认证。 |
| InternalError.CvmCommon | cvm创建节点报错。 |
| MissingParameter | 缺少参数错误 |
| ResourceUnavailable | 资源不可用 |
| UnsupportedOperation | 操作不支持 |
| InternalError.CvmNotFound | cvm不存在。 |
| InternalError.InitMasterFailed | 初始化master失败。 |
| InternalError.InvalidPrivateNetworkCidr | 无效CIDR。 |
| InternalError.Param | Param。 |
| InternalError.UnexceptedInternal | 内部错误 |
| InternalError.VpcCommon | VPC报错。 |
| ResourceInUse | 资源被占用 |
| UnknownParameter | 未知参数错误 |
| ResourceNotFound | 资源不存在 |