该接口用于查询已经存在的云服务器实例,如果需要查询可添加到某个集群的云服务器实例,请指定集群ID参数。
参数名称 | 类型 | 必填 | 描述 |
---|
Action | String | 是 | 公共参数,本接口取值:DescribeExistedInstances。 |
Version | String | 是 | 公共参数,本接口取值:2019-08-06。 |
ClusterId | String | 否 | 集群id |
InstanceId.N | String | 否 | 云服务器id |
Marker | Int | 否 | 分页标识,单次调用未返回全部实例时,标记下次调用的返回值的起点,默认值是0。 |
MaxResults | String | 否 | 单次调用所返回的最大实例数目,默认10, 范围(0-50]。 |
Filter.N | Object | 否 | |
Name | String | 否 | 一个或者多个过滤器,有效值: |
Value.N | String | 否 | |
Search | String | 否 | 模糊匹配,可匹配如下字段: |
参数名称 | 类型 | 描述 |
---|
InstanceSet | Object[] | 存在的云服务器信息 |
InstanceId | String | 实例id 示例值:ee355b5d-79e4-4505-b0a5-xxxxxx |
InstanceName | String | 实例名称 示例值:xxxxxx |
InstanceType | String | 实例类型 示例值:N3.2B |
PrivateIpAddress | String | 主网卡私有IP地 示例值:10.0.11.xxx |
Available | Boolean | 是否支持移入容器集群 示例值:true |
UnavailableReason | String | 不支持移入集群的原因 示例值: The instance is already in a k8s cluster |
ClusterId | String | 集群id 示例值:db62b583-9e2d-97e3-7bc0-3bae41748008 |
TotalCount | Int | 实例数量 示例值:1 |
MaxResults | Int | 单次调用返回的最大数 示例值:10 |
Marker | Int | 分页标识,如果调用未返回全部实例,标记下次调用的返回值的起点,如果已返回全部实例,则其值为0。 示例值:0 |
RequestId | String | 请求id 示例值:0dd5d0de-cd9f-4ca9-b2c2-xxxxxx |
JSON格式
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见公共错误码
错误码 | 错误信息 | Http状态码 | 描述 |
---|
ClusterIdInvalid | ClusterId must match `^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{12}$` | 400 | 集群ID必须满足 `^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{12}$` |
MarkerInvalid | Marker must be greater or equal to 0 | 400 | Marker必须大于等于0 |
MaxResultsInvalid | MaxResults must be equal or less than 50 | 400 | MaxResults必须小于等于50 |
InstanceIdSizeExceed | the number of InstanceId can't exceed 100 | 400 | 实例ID数量不能超过100 |
InstanceIdInvalid | InstanceId contains repeat value | 400 | 实例ID列表包含重复值 |
ClusterNotFound | cluster xx is not found | 400 | 集群不存在 |
GetClusterError | failed to get cluster | 400 | 获取集群信息失败 |
纯净模式