1. 接口描述
接口请求域名: tke.tencentcloudapi.com 。
升级集群中已安装的应用
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:UpgradeClusterRelease。 |
Version | 是 | String | 公共参数,本接口取值:2018-05-25。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
ClusterId | 是 | String | 集群ID 示例值:cls-65r1c5nu |
Name | 是 | String | 自定义的应用名称 示例值:app-05 |
Namespace | 是 | String | 应用命名空间 示例值:lwj |
Chart | 是 | String | 制品名称或从第三方repo 安装chart时,制品压缩包下载地址, 不支持重定向类型chart 地址,结尾为*.tgz 示例值:redis |
Values | 否 | ReleaseValues | 自定义参数,覆盖chart 中values.yaml 中的参数 |
ChartFrom | 否 | String | 制品来源,范围:tke-market 或 other 默认值:tke-market,示例值:tke-market 示例值:tke-market |
ChartVersion | 否 | String | 制品版本( 从第三方安装时,不传这个参数) 示例值:10.5.3 |
ChartRepoURL | 否 | String | 制品仓库URL地址 |
Username | 否 | String | 制品访问用户名 示例值:xxx |
Password | 否 | String | 制品访问密码 示例值:yyy |
ChartNamespace | 否 | String | 制品命名空间,ChartFrom为tke-market时ChartNamespace不为空,值为DescribeProducts接口反馈的Namespace 示例值:helm-public |
ClusterType | 否 | String | 集群类型,支持传 tke, eks, tkeedge, external(注册集群) 示例值:tke |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
Release | PendingRelease | 应用详情 注意:此字段可能返回 null,表示取不到有效值。 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 集群升级应用
集群升级应用
输入示例
POST / HTTP/1.1
Host: tke.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: UpgradeClusterRelease
<公共请求参数>
{
"ChartFrom": "tke-market",
"Name": "app-05",
"ClusterId": "cls-65r1c5nu",
"Namespace": "lwj",
"Chart": "redis",
"ChartVersion": "10.5.3",
"ChartNamespace": "helm-public"
}
输出示例
{
"Response": {
"Release": {
"Condition": "",
"CreatedTime": "2020-04-15T14:44:42Z",
"ID": "0b49c73e-a2eb-41d7-8a9b-c0e61cf1aabb",
"Name": "app-05",
"Namespace": "lwj",
"Status": "pending-upgrade",
"UpdatedTime": "2020-04-15T14:44:42Z"
},
"RequestId": "33483fde-efec-4d3c-8ff6-340d9dbc2d01"
}
}
5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
FailedOperation | 操作失败。 |
FailedOperation.MarketGetAuthFailed | 获取集群认证信息失败。 |
FailedOperation.MarketReleaseOperation | 操作应用Release失败。 |
InternalError | 内部错误。 |
InternalError.MarketGetAuthFailed | 获取集群认证信息失败。 |
InternalError.MarketInternalServerError | 应用市场服务操作错误。 |
InternalError.MarketReleaseOperation | 操作应用Release失败。 |
InternalError.Param | Param。 |
InternalError.UnexpectedInternal | 未知的内部错误。 |
InvalidParameter | 参数错误。 |
InvalidParameter.Param | 参数错误。 |
MissingParameter | 缺少参数错误。 |
UnauthorizedOperation.CamNoAuth | 无该接口CAM权限。 |
UnknownParameter | 未知参数错误。 |