You need to enable JavaScript to run this app.
导航
容器服务
  • 文档首页
    • /容器服务/API 参考/组件管理/ListAddons
ListAddons
最近更新时间：2024.09.23 14:30:51首次发布时间：2022.11.03 15:53:53
我的收藏

查询符合条件的已安装组件详情列表。

请求说明

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

调试

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

请求参数

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

参数类型是否必选示例值描述
ActionString是ListAddons接口名称。当前 API 的名称为 ListAddons。
VersionString是2022-05-12接口版本。当前 API 的版本为 2022-05-12。
FilterObject of ListAddonsFilter否-待查询组件的筛选条件。
PageNumberInteger否1分页查询时的起始页码，从 1 开始，默认为 1。

PageSize

Integer

否

10

分页查询时每页显示的记录数，取值：

  • 最小值：1
  • 最大值：100
  • 默认值：10

ListAddonsFilter

参数类型是否必选示例值描述

ClusterIds

Array of String

否

["cc5silumrsfeq****"]

集群 ID 列表。
可以调用 ListClusters 接口，获取集群 ID。单次最多填写 100 个集群 ID。

说明

此参数为空数组时，基于账号下指定地域的所有集群进行筛选。

Names

Array of String

否

["ingress-nginx"]

组件名称列表。
可以调用 ListSupportedAddons 接口，获取集群组件名称。单次最多填写 100 个组件名称。

说明

此参数为空数组时，基于指定集群下的所有组件进行筛选。

DeployModes

Array of String

否

["Unmanaged"]

支持的部署模式，取值：

  • Unmanaged：查询非托管模式部署的组件。
  • Managed：查询托管模式部署的组件。
  • 为空：查询全部部署模式的组件。

DeployNodeTypes

Array of String

否

["VirtualNode"]

部署节点类型。仅DeployMode=Unmanaged时，才需要指定。取值：

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

Statuses

Array of AddonStatusFilter

否

[{"Phase":"Running","Conditions.Type":"Ok"}]

组件状态。
单次最多填写 15 个数组元素。传入多个状态时，状态间是逻辑「或」关系。

CreateClientTokenString否ed6b1190-dc17-11ec-9519-eb58a7******创建成功时的 ClientToken。 ClientToken 是保证请求幂等性的字符串。该字符串由调用方传入。

UpdateClientToken

String

否

BC028527-33B9-4990-A633-54A859******

按更新幂等token过滤，精确查询
最后一次更新成功时 ClientToken。 ClientToken 是保证请求幂等性的字符串。该字符串由调用方传入。

AddonStatusFilter

参数类型是否必选示例值描述

Phase

String

否

Running

组件的状态，取值：

  • Running
  • Failed
  • Creating
  • Deleting
  • Updating

注意

Phase 和 Conditions.Type 两者至少有一个参数必填，否则为无效数组元素。合法的 Phase 和 Conditions.Type 组合请参见 资源状态说明。

Conditions.Type

String

否

Ok

组件当前主状态下的状态条件，即进入该主状态的原因，可以有多个原因，取值：

  • Unknown
  • ClusterNotRunning
  • CrashLoopBackOff
  • ImagePullBackOff
  • SchedulingFailed
  • NameConflict
  • ResourceCleanupFailed
  • ClusterVersionUpgrading
  • Ok
  • Degraded
  • Progressing

注意

Phase 和 Conditions.Type 两者至少有一个参数必填，否则为无效数组元素。合法的 Phase 和 Conditions.Type 组合请参见 资源状态说明。

请求示例

POST https://open.volcengineapi.com/?Action=ListAddons&Version=2022-05-12 HTTP/1.1
Content-Type:application/json
{
    "Filter": {
        "ClusterIds": ["cc5silumrsf******"],
        "Names": ["ingress-nginx"],
        "DeployModes": ["Unmanaged"],
        "DeployNodeTypes": ["VirtualNode"],
        "Statuses": [{
            "Phase": "Running",
            "Conditions.Type": "Ok"
        }],
        "CreateClientToken": "ed6b1190-dc17-11ec-9519-eb58a7******",
        "UpdateClientToken": "BC028527-33B9-4990-A633-54A859******"
    },
    "PageNumber": 1,
    "PageSize": 10
}

返回参数

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

参数类型示例值描述
ItemsArray of Addon-组件列表。
PageNumberInteger1当前页码。
PageSizeInteger10每页显示的组件数。
TotalCountInteger100返回数据列表的总量。

Addon

参数类型示例值描述
ClusterIdStringcc5sil****组件所在集群 ID。
NameStringingress-nginx组件名称。
VersionStringv0.44.0组件版本。

DeployMode

String

Unmanaged

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

  • Unmanaged：非托管模式部署。
  • Managed：托管模式部署。

DeployNodeType

String

VirtualNode

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

  • Node：以节点方式部署。
  • VirtualNode：以虚拟节点方式部署。
    仅DeployModes=Unmanaged时，才返回该参数。
ConfigString{"xxx":"true"}组件配置。详细的参数说明，请参见 组件配置信息。

CreateTime

String

2021-10-27T10:33:30Z

安装组件的时间。
标准 RFC3339 格式的 UTC+0 时间。

UpdateTime

String

2021-10-29T10:33:30Z

更新组件的时间。
标准 RFC3339 格式的 UTC+0 时间。

StatusObject of AddonStatus{"Status":"Running","Conditions":["Type":"Ok"]}组件状态。
CreateClientTokenStringed6b1190-dc17-11ec-9519-eb58a7******建成功时的 ClientToken。
UpdateClientTokenStringBC028527-33B9-4990-A633-54A859******最后一次更新成功时的 ClientToken。

AddonStatus

参数类型示例值描述

Phase

String

Running

组件的状态，参数值有：

  • Running
  • Failed
  • Creating
  • Deleting
  • Updating

说明

合法的 Phase 和 Conditions.Type 组合说明，请参见 资源状态说明。

Conditions

Array of AddonCondition

["Type":"Ok"]

组件当前主状态下的状态条件，即进入该主状态的原因。

说明

合法的 Phase 和 Conditions.Type 组合说明，请参见 资源状态说明。

AddonCondition

参数类型示例值描述

Type

String

Ok

组件当前主状态下的状态条件，即进入该主状态的原因，可以有多个原因，参数值有：

  • Progressing
  • ClusterVersionUpgrading
  • Unknown
  • Degraded
  • NameConflict
  • ClusterNotRunning
  • CrashLoopBackOff
  • SchedulingFailed
  • ResourceCleanupFailed

返回示例

HTTP/1.1 200 OK
Content-Type:application/json
{
    "ResponseMetadata": {
        "RequestId": "202***",
        "Action": "ListAddons",
        "Version": "2022-05-12",
        "Service": "vke",
        "Region": "cn-beijing"
    },
    "Result": {
        "Items": [
            {
                "ClusterId": "cc**",
                "Name": "ingress-nginx",
                "Version": "v1.3.1-vke.5",
                "DeployMode": "Unmanaged",
                "DeployNodeType": "Node",
                "Config": "{\"Replica\":1,\"Resource\":{\"Request\":{\"Cpu\":\"0.25\",\"Memory\":\"512Mi\"},\"Limit\":{\"Cpu\":\"0.5\",\"Memory\":\"1024Mi\"}},\"PrivateNetwork\":{\"SubnetId\":\"subnet-2d61qn69iji****\",\"IpVersion\":\"IPV4\"}}",
                "CreateTime": "2022-10-31 07:45:16.19943 +0000 UTC",
                "UpdateTime": "2023-04-25 01:50:16.68753 +0000 UTC",
                "Status": {
                    "Phase": "Running",
                    "Conditions": [
                        {
                            "Type": "Ok"
                        }
                    ]
                },
                "CreateClientToken": "",
                "UpdateClientToken": "",
                "ClusterType": ""
            }
        ],
        "PageNumber": 1,
        "PageSize": 10,
        "TotalCount": 1
    }
}

错误码

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