ListSupportedAddons--容器服务-火山引擎

文档中心

立即注册

导航

ListSupportedAddons

最近更新时间：2024.09.23 14:30:51首次发布时间：2022.11.03 15:53:53

查询容器服务当前支持的组件详情列表。

请求说明

请求方式：POST
请求地址：https://open.volcengineapi.com/?Action=ListSupportedAddons&Version=2022-05-12

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

调用该 API 时的请求参数如下，除此之外还需传入公共请求参数。公共请求参数说明，请参见公共参数。

参数	类型	是否必选	示例值	描述
Action	String	是	ListSupportedAddons	接口名称。当前 API 的名称为 `ListSupportedAddons`。
Version	String	是	2022-05-12	接口版本。当前 API 的版本为 `2022-05-12`。
Filter	Object of ListSupportedAddonsFilter	否	-	查询组件的过滤条件。

ListSupportedAddonsFilter

参数	类型	是否必选	示例值	描述
Name	String	否	ingress-nginx	待查询组件的名称。
PodNetworkModes	Array of String	否	["Flannel"]	组件支持的容器（Pod）网络模型（CNI），取值： Flannel：Flannel 网络模型，独立的 Underlay 容器网络方案，配合私有网络（VPC）的全局路由能力，实现集群高性能的网络体验。 VpcCniShared：VPC-CNI 网络模型，基于私有网络的弹性网卡 ENI 实现的 Underlay 容器网络方案，具有较高的网络通信性能。
DeployModes	Array of String	否	["Managed"]	支持的部署模式，取值： Unmanaged：获取非托管模式部署的组件。 Managed：获取托管模式部署的组件。为空：获取全部部署模式的组件。
DeployNodeTypes	Array of String	否	["Node"]	部署节点类型。仅`DeployMode=Unmanaged`时，才需要指定。取值： Node：获取以节点（云服务器）方式部署的组件。 VirtualNode：获取以虚拟节点（弹性容器实例）方式部署的组件。为空：获取全部部署节点类型的组件。
Necessaries	Array of String	否	["Required"]	组件的安装必要性，取值： Required：系统必装 Recommended：推荐安装 OnDemand：可选安装
Categories	Array of String	否	["Storage"]	组件的分类，取值： Storage：存储 Network：网络 Monitor：监控 Scheduler：调度 Dns：DNS Security：安全 Gpu：GPU Image：镜像
Versions.Compatibilities.KubernetesVersions	Array of String	否	["v1.20.4"]	组件支持的 Kubernetes 版本。容器服务发布 Kubernetes 版本，请参见 Kubernetes 版本发布记录。

请求示例

POST https://open.volcengineapi.com/?Action=ListSupportedAddons&Version=2022-05-12 HTTP/1.1
Content-Type:application/json
{
    "Filter": {
        "Name": "ingress-nginx",
        "PodNetworkModes": ["Flannel"],
        "DeployModes": ["Unmanaged"],
        "DeployNodeTypes": ["Node"],
        "Necessaries": ["OnDemand"],
        "Categories": ["Network"]
    }
}

返回参数

本接口返回参数如下表所示，公共返回参数请参见返回结果。

参数	类型	示例值	描述
Items	Array of SupportedAddon	[]	容器服务支持的组件的详细信息。
TotalCount	Integer	10	容器服务支持的组件总数。

SupportedAddon

参数	类型	示例值	描述
Name	String	ingress-nginx	组件名称。
Versions	Array of AddonVersion	[{"Versoin":"v1.0.0","CompatibleVersions":["v0.9.0"]}]	组件支持的版本。
PodNetworkModes	Array of String	["Flannel"]	组件的容器（Pod）网络模型（CNI），参数值有： Flannel：Flannel 网络模型，独立的 Underlay 容器网络模型。 VpcCniShared：VPC-CNI 网络模型，基于私有网络的弹性网卡 ENI 实现的 Underlay 容器网络模型。
DeployMode	String	Unmanaged	组件部署模式，参数值有： Unmanaged：非托管模式部署。 Managed：托管模式部署。
DeployNodeTypes	Array of String	["Node"]	部署节点的类型，参数值有： Node：以节点方（云服务器）式部署。 VirtualNode：以虚拟节点（弹性容器实例）方式部署。仅`DeployModes=Unmanaged`时，才返回该参数。
Necessary	String	Required	组件的安装必要性，参数值有： Required：系统必装 Recommended：推荐安装 OnDemand：可选安装
Categories	Array of String	["Storage"]	组件的分类，参数值有： Network：网络 Monitor：监控 Scheduler：调度 Dns：DNS Security：安全 Gpu：GPU Image：镜像为空：返回空数组，表示该组件没有分类。

AddonVersion

参数	类型	示例值	描述
Version	String	v0.44.0	组件的版本。
CompatibleVersions	Array of String	["v0.42.0", "v0.43.0"]	可以兼容升级到当前版本的低版本列表。

返回示例

HTTP/1.1 200 OK
Content-Type:application/json
{
    "ResponseMetadata": {
        "RequestId": "20230509****",
        "Action": "ListSupportedAddons",
        "Version": "2022-05-12",
        "Service": "vke",
        "Region": "cn-beijing"
    },
    "Result": {
        "Items": [
            {
                "Name": "ingress-nginx",
                "Versions": [
                    {
                        "Version": "v1.2.1-vke.2",
                        "CompatibleVersions": [
                            "v0.44.1",
                            "v0.44.0",
                            "v0.49.3",
                            "v0.49.3-vke.1",
                            "v0.49.3-vke.2"
                        ],
                        "Compatibilities": [
                            {
                                "KubernetesVersion": "<v1.24-0"
                            }
                        ]
                    }
                ],
                "PodNetworkModes": [
                    "CalicoVxlan",
                    "Flannel",
                    "VpcCniHybrid",
                    "VpcCniShared"
                ],
                "DeployMode": "Unmanaged",
                "DeployNodeTypes": [
                    "Node",
                    "VirtualNode"
                ],
                "Necessary": "OnDemand",
                "Categories": [
                    "Network"
                ]
            }
        ],
        "TotalCount": 1
    }
}

错误码

本接口无专有错误码，公共错误码请参见公共错误码。