You need to enable JavaScript to run this app.
导航
边缘计算节点
  • 文档首页
    • /
  • 边缘计算节点

获取组件列表及详情

最近更新时间：2023.10.08 19:44:29

首次发布时间：2023.08.24 19:59:29

我的收藏

本接口用于查询当前边缘托管支持的组件。

使用说明

建议您在调用安装组件接口前，通过此接口确认创建组件的一些基本属性，以提高调用的成功率，避免不必要的安装失败。

请求参数

下表列出了接口特定的请求参数以及公共请求参数 Action 和 Version。 其他公共参数，请参见公共参数。

参数名称

类型

是否必选

示例值

描述

Action

String

是

ListSupportedAddons

公共参数。该参数表示接口名称。 本接口取值为ListSupportedAddons。

Version

String

是

2022-05-12

公共参数。该参数表示接口版本。 本接口取值为2022-05-12。

Filter

ListSupportedAddonsFilter

否

{}

查询组件的过滤条件。

ListSupportedAddonsFilter

参数名称

类型

是否必选

示例值

描述

Name

String

否

"ingress-nginx"

待查询组件的名称。支持模糊匹配。

PodNetworkModes

[]String

否

["Flannel"]

组件支持的容器（Pod）网络模型（CNI），取值：

  • Flannel：Flannel 网络模型，独立的 Underlay 容器网络方案，配合私有网络（VPC）的全局路由能力，实现集群高性能的网络体验。
  • VpcCniShared：VPC-CNI 网络模型，基于私有网络的弹性网卡 ENI 实现的 Underlay 容器网络方案，具有较高的网络通信性能。

DeployModes

[]String

否

["Managed"]

支持的部署模式，取值：

  • Unmanaged：获取非托管模式部署的组件。
  • Managed：获取托管模式部署的组件。
  • Either：获取非托管模式部署和托管模式部署都支持的组件。
  • 为空：获取全部部署模式的组件。

DeployNodeTypes

[]String

否

["Node"]

部署节点类型。仅 DeployModes 包含 Unmanaged/Either 时，才需要指定。取值：

  • Node：获取以节点（云服务器）方式部署的组件。
  • VirtualNode：获取以虚拟节点（弹性容器实例）方式部署的组件。
  • 为空：获取全部部署节点类型的组件。

Necessaries

[]String

否

["Required"]

组件的安装必要性，取值：

  • Required：系统必装
  • Recommended：推荐安装
  • OnDemand：可选安装

Categories

[]String

否

["Storage"]

组件的分类，取值：

  • Monitor：监控
  • Scheduler：调度
  • Gpu：GPU
  • Image：镜像

Versions.Compatibilities.KubernetesVersions

[]String

否

["v1.20.4", "v1.24.1"]

支持的 Kubernetes 版本

请求示例

POST /?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

[]SupportedAddon

[]

边缘托管支持的组件的详细信息。

TotalCount

Integer

10

边缘托管支持的组件总数。

SupportedAddon

参数名称

类型

示例值

描述

Name

String

"ingress-nginx"

组件名称。

Versions

[]AddonVersion

[{"Versoin":"v1.0.0","CompatibleVersions":["v0.9.0"]}]

组件支持的版本。

PodNetworkModes

[]String

["Flannel"]

组件的容器（Pod）网络模型（CNI），参数值有：

  • Flannel：Flannel 网络模型，独立的 Underlay 容器网络模型。
  • VpcCniShared：VPC-CNI 网络模型，基于私有网络的弹性网卡 ENI 实现的 Underlay 容器网络模型。

DeployModes

[]String

"Unmanaged"

组件部署模式，参数值有：

  • Unmanaged：非托管模式部署。
  • Managed：托管模式部署。
  • Either：非托管模式和托管模式都支持部署。

DeployNodeTypes

[]String

["Node"]

部署节点的类型，参数值有：

  • Node：以节点方（云服务器）式部署。
  • VirtualNode：以虚拟节点（弹性容器实例）方式部署。

仅DeployModes=Unmanaged时，才返回该参数。

Necessary

String

"Required"

组件的安装必要性，参数值有：

  • Required：系统必装
  • Recommended：推荐安装
  • OnDemand：可选安装

Categories

[]String

["Storage"]

组件的分类，参数值有：

  • Monitor：监控
  • Scheduler：调度
  • Gpu：GPU
  • Image：镜像
  • 为空：返回空数组，表示该组件没有分类

AddonVersion

参数名称

类型

示例值

描述

Version

String

"v0.44.0"

组件的版本。

CompatibleVersions

[]String

["v0.42.0", "v0.43.0"]

可以兼容升级到当前版本的低版本列表。

返回示例

HTTP/1.1 200 OK
Content-Type:application/json
{
    "ResponseMetadata": {
        "RequestId": "20230509180645C6****",
        "Action": "ListSupportedAddons",
        "Version": "2022-05-12",
        "Service": "veecp_openapi",
        "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
    }
}

错误码

本接口无特有错误码，错误码请参见错误码。