TKE 标准集群指南

最佳实践

API 文档

诚邀爱技术、爱分享的你,成为文档内容共建者> HOT

1. 接口描述

可以查询边缘集群升级信息,包含可以升级的组件,当前升级状态和升级错误信息接口请求域名: tke.tencentcloudapi.com 。

默认接口请求频率限制:20次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeEdgeClusterUpgradeInfo。
Version String 公共参数,本接口取值:2018-05-25。
Region String 公共参数,详见产品支持的 地域列表,本接口仅支持其中的: ap-beijing, ap-guangzhou, ap-nanjing, ap-shanghai, ap-singapore 。
ClusterId String 集群ID
EdgeVersion String 要升级到的TKEEdge版本

3. 输出参数

参数名称 类型 描述
ComponentVersion String 可升级的集群组件和
注意:此字段可能返回 null,表示取不到有效值。
EdgeVersionCurrent String 边缘集群当前版本
注意:此字段可能返回 null,表示取不到有效值。
RegistryPrefix String 边缘组件镜像仓库地址前缀,包含域名和命名空间
注意:此字段可能返回 null,表示取不到有效值。
ClusterUpgradeStatus String 集群升级状态,可能值:running、updating、failed
注意:此字段可能返回 null,表示取不到有效值。
ClusterUpgradeStatusReason String 集群升级中状态或者失败原因
注意:此字段可能返回 null,表示取不到有效值。
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询边缘集群升级信息

输入示例

POST / HTTP/1.1
Host: tke.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeEdgeClusterUpgradeInfo
<公共请求参数>

{
    "EdgeVersion": "1.0.2",
    "ClusterId": "cls-xxxxxx"
}

输出示例

{
    "Response": {
        "RequestId": "67a0dd10-ef28-49a1-8834-7a5fa7a9bac0",
        "EdgeVersionCurrent": "1.1.0",
        "ComponentVersion": "{\"hyperkube\":{},\"kube-proxy\":{},\"coredns\":{\"InitImageName\":\"\",\"InitImageVersion\":\"\",\"ImageName\":\"\",\"ImageVersion\":\"1.6.7\"},\"flannel\":{\"InitImageName\":\"\",\"InitImageVersion\":\"\",\"ImageName\":\"\",\"ImageVersion\":\"v0.12.0-edge-2.0\"},\"gpu-plugin\":{\"ImageName\":\"\",\"ImageVersion\":\"v0.9.0\"},\"site-manager\":{\"ImageName\":\"\",\"ImageVersion\":\"v0.6.0\"},\"application-grid-controller\":{\"ImageName\":\"\",\"ImageVersion\":\"1.21.1\"},\"application-grid-wrapper\":{\"ImageName\":\"\",\"ImageVersion\":\"1.20.3\"},\"tunnel\":{\"ImageName\":\"\",\"ImageVersion\":\"v0.8.0\"},\"edge-health\":{\"ImageName\":\"\",\"ImageVersion\":\"\"},\"edge-health-admission\":{\"ImageName\":\"\",\"ImageVersion\":\"\"},\"event\":{\"ImageName\":\"\",\"ImageVersion\":\"\"},\"griddaemon\":{\"ImageName\":\"\",\"ImageVersion\":\"\"},\"metric-server\":{\"ImageName\":\"\",\"ImageVersion\":\"\"},\"standalone-metrics\":{\"ImageName\":\"\",\"ImageVersion\":\"\"},\"hpa-metrics-server\":{\"ImageName\":\"\",\"ImageVersion\":\"\"},\"tke-monitor-agent\":{\"ImageName\":\"\",\"ImageVersion\":\"20220714-3b31e8d2\"}}",
        "RegistryPrefix": "",
        "ClusterUpgradeStatus": "updating",
        "ClusterUpgradeStatusReason": "component application-grid-controller:Back-off pulling image \"ccr.ccs.tencentyun.com/tkeedge/application-grid-controller:1.21.1-x\""
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

错误码 描述
FailedOperation 操作失败。
MissingParameter 缺少参数错误。
UnknownParameter 未知参数错误。
目录