文档首页/云容器引擎 CCE/API参考/API/配置管理/获取集群支持的可配置参数列表 - GetClusterSupportConfiguration
更新时间：2025-11-28 GMT+08:00
在线调试
CLI示例
查看PDF
分享

获取集群支持的可配置参数列表 - GetClusterSupportConfiguration

功能介绍

该API用于根据集群版本类型等查询集群支持的详细配置项，用于集群创建时指定。

调用方法

请参见如何调用API。

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。

  • 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
  • 如果使用身份策略授权，当前API调用无需身份策略权限。

URI

GET /api/v3/clusters/configuration/detail

表1 Query参数

参数

是否必选

参数类型

描述

clusterType

否

String

参数解释：

该参数用于过滤集群架构

约束限制：

不涉及

取值范围：

  • ARM64: 仅获取鲲鹏集群支持的配置项

默认取值：

不涉及

clusterVersion

否

String

参数解释：

该参数用于获取指定集群版本支持的配置项

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

clusterID

否

String

参数解释：

该参数用于获取指定集群支持的配置项

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

networkMode

否

String

参数解释：

该参数用于过滤掉集群网络模型相关配置项

约束限制：

不涉及

取值范围：

  • eni: 过滤掉云原生网络2.0模型相关配置

默认取值：

不涉及

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

Content-Type

是

String

参数解释：

消息体的类型（格式）

约束限制：

GET方法不做校验

取值范围：

  • application/json

  • application/json;charset=utf-8

  • application/x-pem-file

  • multipart/form-data（注：存在FormData参数时使用）

默认取值：

不涉及

X-Auth-Token

是

String

参数解释：

调用接口的认证方式分为Token和AK/SK两种，如果您使用的Token方式，此参数为必填，请填写Token的值，获取方式请参见获取token。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

响应参数

状态码：200

表3 响应Body参数

参数

参数类型

描述

{自定义key}

Map<String,Array<PackageOptions>>

参数解释：

集群支持的配置项详情

表4 PackageOptions

参数

参数类型

描述

name

String

参数解释：

参数名称

取值范围：

不涉及

default

Object

参数解释：

参数默认值，不指定时按默认值生效, 参数类型以实际返回为准，可能为integer,string或者boolean

取值范围：

不涉及

validAt

String

参数解释：

参数生效方式

取值范围：

  • static：集群、节点池创建时生效，后续不可修改

  • immediately：集群、节点池运行中时可以修改，修改后生效

empty

Boolean

参数解释：

配置项是否可以为空

取值范围：

  • true：配置项为空时，不使用默认值，为空值

  • false：配置项为空时，使用默认值

schema

String

参数解释：

参数分类

取值范围：

不涉及

type

String

参数解释：

参数类型

取值范围：

不涉及

请求示例

无

响应示例

状态码：200

表示获取集群支持的可配置参数列表成功。

{
  "eni" : [ {
    "name" : "nic-minimum-target",
    "default" : 10,
    "validAt" : "immediately",
    "empty" : false,
    "schema" : "network",
    "type" : "str"
  }, {
    "name" : "nic-warm-target",
    "default" : 2,
    "validAt" : "immediately",
    "empty" : false,
    "schema" : "network",
    "type" : "str"
  } ],
  "kube-apiserver" : [ {
    "name" : "default-not-ready-toleration-seconds",
    "default" : 300,
    "validAt" : "immediately",
    "empty" : true,
    "schema" : "kubernetes",
    "type" : "int"
  } ]
}

状态码

状态码

描述

200

表示获取集群支持的可配置参数列表成功。

错误码

请参见错误码。

父主题： 配置管理