您可以调用ListAddons接口,根据指定地域、集群类型、集群子类型(profile)、集群版本等参数获取可用组件的列表,并查询组件的详细信息,包括组件托管与否、支持的自定义参数Schema、兼容的操作系统架构等。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
|
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
|
cs:ListAddons |
list |
*全部资源
|
无 | 无 |
请求语法
GET /addons HTTP/1.1
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| region_id |
string |
否 |
地域。 如果传入了 cluster_id,该参数将被忽略。 region_id、cluster_type、profile、cluster_spec、cluster_version 五个参数需要同时传入。 |
cn-hangzhou |
| cluster_type |
string |
否 |
集群类型。 如果传入了 cluster_id,该参数将被忽略。 region_id、cluster_type、profile、cluster_spec、cluster_version 五个参数需要同时传入。 |
ManagedKubernetes |
| profile |
string |
否 |
集群子类型。 如果传入了 cluster_id,该参数将被忽略。 region_id、cluster_type、profile、cluster_spec、cluster_version 五个参数需要同时传入。 |
Default |
| cluster_spec |
string |
否 |
集群规格。 如果传入了 cluster_id,该参数将被忽略。 region_id、cluster_type、profile、cluster_spec、cluster_version 五个参数需要同时传入。 |
ack.pro.small |
| cluster_version |
string |
否 |
集群版本。 如果传入了 cluster_id,该参数将被忽略。 region_id、cluster_type、profile、cluster_spec、cluster_version 五个参数需要同时传入。 |
1.32.1-aliyun.1 |
| cluster_id |
string |
否 |
集群 ID。 指定集群 ID 时,查询该集群可用的组件列表,此时其他参数将会被忽略。 |
c02b3e03be10643e8a644a843ffcb**** |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
返回体。 |
||
| addons |
array<object> |
可用组件列表。 |
|
|
object |
|||
| name |
string |
组件名称。 |
arms-prometheus |
| version |
string |
组件版本。 |
1.1.9 |
| managed |
boolean |
是否为托管组件。
|
false |
| install_by_default |
boolean |
是否默认安装。
|
false |
| category |
string |
组件分类。
返回内容为空表示组件类型为其他。 |
monitor |
| config_schema |
string |
组件自定义参数的 schema。 |
{} |
| supported_actions |
array |
组件支持的操作。 |
|
|
string |
组件支持的操作,取值:
|
Install |
|
| architecture |
array |
组件支持的 CPU 架构。 |
|
|
string |
组件支持的 CPU 架构,取值:
|
amd64 |
示例
正常返回示例
JSON格式
{
"addons": [
{
"name": "arms-prometheus",
"version": "1.1.9",
"managed": false,
"install_by_default": false,
"category": "monitor",
"config_schema": "{}",
"supported_actions": [
"Install"
],
"architecture": [
"amd64"
]
}
]
}
错误码
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。