文档

DescribeAddons - 查询集群组件详情

更新时间:
目前该API接口已标记为弃用,推荐使用替代API:CS(2015-12-15) - ListAddons

查询平台支持的所有组件的详情。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
cs:DescribeAddonsRead
  • 全部资源
    *

请求语法

GET /clusters/components/metadata

请求参数

名称类型必填描述示例值
regionstring

集群所在地域 ID。

cn-beijing
cluster_typestring
  • Kubernetes: ACK 专有集群。

  • ManagedKubernetes:ACK 托管类的集群,包括 ACK 托管集群(ACK 集群 Pro 版、ACK 集群基础版)、ACK Serverless 集群(Pro 版、基础版)、ACK Edge 集群(Pro 版、基础版)、ACK 灵骏集群(Pro 版)。

  • ExternalKubernetes:注册集群。

ManagedKubernetes
cluster_profilestring

集群类型,取值:

  • Default:托管版集群。
  • Serverless:Serverless 集群。
  • Edge:边缘集群。
Default
cluster_specstring

当您选择cluster_typeManagedKubernetes并配置profile后,您可以进一步指定集群的规格。

  • ack.pro.small:集群 Pro 版。

  • ack.standard:集群基础版(取值为空时默认选择)。

ack.pro.small
cluster_versionstring

集群版本。

1.24.6-aliyun.1

返回参数

名称类型描述示例值
object

返回体参数。

ComponentGroupsobject []

组件分组列表。

group_namestring

组件分组名称。

storage
itemsobject []

该分组内包含的组件名称。

namestring

组件名称。

flexvolume
StandardComponentsobject

标准组件。

object

标准组件的详细信息。

namestring

组件名称。

ack-arena
versionstring

组件版本。

0.5.0
descriptionstring

组件功能说明。

***
requiredstring

是否为集群必需组件。取值:

  • true:必需组件,集群创建时必须要安装的组件。

  • false:非必需组件,集群创建完成后,可通过组件管理进行安装。

false
disabledboolean

是否禁止默认安装,集群创建时除了安装集群所需的组件外,还会额外安装一些与日志或者路由相关的组件(例如:Ingress),如果您不想默认安装,可通过设置该字段禁止默认安装。取值:

  • true:禁止默认安装。
  • false:默认安装。
false

示例

正常返回示例

JSON格式

{
  "ComponentGroups": [
    {
      "group_name": "storage",
      "items": [
        {
          "name": "flexvolume"
        }
      ]
    }
  ],
  "StandardComponents": {
    "key": {
      "name": "ack-arena",
      "version": "0.5.0",
      "description": "***",
      "required": "false",
      "disabled": false
    }
  }
}

错误码

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2024-01-12OpenAPI 变更为 deprecated,即将下线看变更集
变更项变更内容
API 弃用说明(deprecated)OpenAPI 变更为 deprecated,即将下线
  • 本页导读 (1)