参数名称 | 类型 | 必填 | 描述 |
|---|
| Action | String | 是 | 公共参数，本接口取值：DescribeNodePool。 |
| Version | String | 是 | 公共参数，本接口取值：2019-08-06。 |
| ClusterId | String | 是 | 集群id |
| NodePoolId.N | String | 否 | 节点池id |
| Marker | Int | 否 | 分页标识，单次调用未返回全部实例时，标记下次调用的返回值的起点，默认值是0 |
| MaxResults | Int | 否 | 单次调用所返回的最大实例数目，默认10， 范围(0-50] |
| NodePoolName | String | 否 | 节点池名称 |
参数名称 | 类型 | 描述 |
|---|
| RequestId | String | RequestId 示例值：ed8122f2-a8d2-44ce-9ed9-9d06eafd75d2 |
| MaxResults | Int | 单次调用返回的最大数 示例值：10 |
| Marker | Int | 分页标识，如果调用未返回全部实例，标记下次调用的返回值的起点，如果已返回全部实例，则其值为0 示例值：0 |
| TotalCount | Int | 节点池数量 示例值：1 |
| NodePoolSet | Object[] | 节点池详细信息 |
| NodePoolId | String | 节点池id 示例值：858066051963105000 |
| NodePoolName | String | 节点池名称 示例值：node-pool-test |
| Status | String | 节点池状态
示例值：normal |
| EnableAutoScale | Boolean | 是否开启弹性伸缩 示例值：false |
| NodeTemplate | Object | 节点模板信息 |
| ChargeType | String | 计费方式 示例值：Daily |
| InstanceType | String | 实例类型，详情请见创建实例中InstanceType具体参数 示例值：N3.2B |
| InstanceName | String | 实例名称 示例值：AS-node-pool-test-Worker |
| InstanceNameSuffix | Int | 实例名称后缀 示例值：1 |
| SystemDisk | Object | 系统盘信息 |
| DiskType | String | 系统盘类型 示例值：Local_SSD |
| DiskSize | Int | 系统盘大小 示例值：20 |
| DataDiskGb | Int | 本地数据盘大小 示例值：20 |
| DataDisk | Object | 云盘数据盘详情 |
| DiskType | String | 数据盘类型 示例值：SSD3.0 |
| DiskSize | Int | 数据盘大小 示例值：10 |
| DeleteWithInstance | Boolean | 是否随云主机删除 示例值：true |
| ImageId | String | 镜像id 示例值：d8ede351-c700-ac9e-767d-33be5adf389d |
| VpcId | String | 节点池所在vpc的id 示例值：06e95dfb-fce1-8e53-9489-a385da61ea36 |
| SubnetIdSet | String[] | 子网id 示例值： [ "996405fd-bbfa-9703-3017-4809ad082ac1" ] |
| SubnetStrategy | String | 多子网扩展策略 示例值：balanced-distribution |
| SecurityGroupId | String | 安全组id 示例值：793fd8de-65a8-ffde-8c79-a794409a9d9d |
| ProjectId | Int | 节点池所属项目 示例值：0 |
| Password | String | 实例密码 示例值：null |
| KeyIdSet | String[] | 密钥id 示例值：["d791746a-7a91-c436-9739-9c27419417d3"] |
| AdvancedSetting | Object | 节点高级设置 |
| DataDisk | Object | 数据盘挂载设置，仅针对于第一块数据盘生效 |
| AutoFormatAndMount | Boolean | 是否对数据盘格式化并挂载，默认值；true。若此字段填写false，则 FileSystem 和 MountTarget字段不生效 示例值：false |
| FileSystem | String | 数据盘的文件系统，可选值：ext3，ext4，xfs，默认值ext4。若磁盘已有文件系统，则不进行处理，若没有文件系统，则按照用户的定义进行格式化，仅对第一块磁盘生效 示例值：null |
| MountTarget | String | 数据盘挂载点，并挂载，仅对第一块盘生效。 示例值：null |
| ContainerRuntime | String | 容器运行时，根据集群版本和需求选择 示例值：containerd |
| DockerPath | String | 容器的存储路径 示例值：/data/docker |
| ContainerPath | String | 容器的存储路径 示例值：/data/container |
| UserScript | String | base64 编码的用户脚本 示例值：null |
| PreUserScript | String | base64 编码的用户脚本 示例值：null |
| Schedulable | Boolean | 节点加入集群后是否可以正常调度 示例值：true |
| Label | Object[] | 节点加入集群时预置的标签 |
| Key | String | 标签键，校验规则：不超过63个字符，只能包含字母、数字及分隔符("-"、"_"、"."、"/")，且必须以字母、数字开头和结尾 示例值：null |
| Value | String | 标签值，校验规则：不超过63个字符，只能包含字母、数字及分隔符("-"、"_"、".")，且必须以字母、数字开头和结尾 示例值：null |
| ExtraArg | Object | 自定义节点上k8s组件的参数 |
| Kubelet | Object[] | 自定义节点上k8s组件的参数 示例值：null |
| CustomArg | String | 自定义节点上k8s组件的参数 示例值：null |
| ContainerLogMaxSize | String | 自定义容器日志采集文件大小 示例值：100 |
| ContainerLogMaxFiles | String | 自定义容器日志采集文件最大数量 示例值：10 |
| Taints | Object[] | 节点加入集群时预置污点 |
| Key | String | 污点名称，校验规则：不超过253个字符，只能包含字母、数字及分隔符("-"、"_"、"."、"/")，且必须以字母、数字开头和结尾 示例值：null |
| Value | String | 污点值，校验规则：不超过63个字符，只能包含字母、数字及分隔符("-"、"_"、"."、"/")，且必须以字母、数字开头和结尾 示例值：null |
| Effect | String | 污点效果，有效值为NoSchedule、PreferNoSchedule、NoExecute 示例值：null |
| EbsTags | Object[] | 云盘标签 |
| Key | String | 标签键 示例值：key-test |
| Value | String | 标签值 示例值：value-test |
| ScalingConfigurationId | String | 伸缩组配置ID 示例值：861325029723680768 |
| ScalingConfigurationName | String | 伸缩组配置名称 示例值：test |
| Mem | String | 内存 示例值：4 |
| RemovePolicy | String | 移除策略 示例值：RemoveNewestInstance |
| InstanceTags | Object[] | 实例标签 |
| Key | String | 标签键，校验规则：支持1-128个字符，仅支持中英文字符、数字及±=._/@: 示例值：null |
| Value | String | 标签值，校验规则：256个字符内，仅支持中英文字符、数字及±=._/@()（）【】: 示例值：null |
| DeleteDataDisk | Boolean | 是否删除数据盘 示例值：null |
| DeleteInstanceTag | Boolean | 是否删除tag 示例值：null |
| DeleteEbsTag | Boolean | 是否删除ebstag 示例值：null |
| Cpu | String | CPU核数 示例值：2 |
| Labels | Object[] | 节点标签 |
| Key | String | 标签键 示例值：ab |
| Value | String | 标签值 示例值：ab |
| Taints | Object[] | 节点污点 |
| Key | String | 污点名称 示例值：ab |
| Value | String | 污点值 示例值：ab |
| Effect | String | 有效值 示例值：NoSchedule |
| MinSize | Int | 最小节点数量 示例值：0 |
| MaxSize | Int | 最大节点数量 示例值：0 |
| DesiredCapacity | Int | 当前期望节点数量 示例值：0 |
| InstanceCount | Int | 当前实例数量 示例值：0 |
| CreateTime | String | 创建时间 示例值：2023-05-31 16:39:16 |
| ClusterId | String | 集群id 示例值：0cd009e2-582b-4f38-8844-1208aeb25067 |
| ErrorStatusMessage | String | 节点池状态错误状态信息 示例值：null |
| ScaleUpPolicy | String | 集群扩容算法 示例值：random |
| ScaleDownPolicy | Object | 集群缩容算法 |
| ScaleDownEnabled | Boolean | 是否启用自动缩容 示例值：false |
| ScaleDownDelayAfterAdd | Int | 集群扩容后多少分钟开始考虑缩容条件 示例值：10 |
| ScaleDownUnneededTime | Int | 节点满足缩容条件多少分钟后开始启动缩容 示例值：10 |
| ScaleDownUtilizationThreshold | Int | 缩容阈值百分比 示例值：50 |
| MaxEmptyBulkDelete | Int | 缩容最大并发数 示例值：10 |
JSON格式
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码
错误码 | 错误信息 | Http状态码 | 描述 |
|---|
| ClusterIdRequired | ClusterId is required | 400 | 集群ID必须填写 |
| 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}$` |
| NodePoolIdInvalid | NodePoolId contains repeat value | 400 | 节点池ID列表包含重复值 |
| MarkerInvalid | Marker must be greater or equal to 0 | 400 | Marker必须大于等于0 |
| MaxResultsInvalid | MaxResults must be greater or equal to 1 | 400 | MaxResults必须大于等于1 |
| NodePoolNotFound | node pool is not found | 400 | 节点池不存在 |
纯净模式
