1. 接口描述
接口请求域名: tke.tencentcloudapi.com 。
查询集群在应用市场中已安装应用列表
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DescribeClusterReleases。 |
Version | 是 | String | 公共参数,本接口取值:2018-05-25。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
ClusterId | 是 | String | 集群id 示例值:cls-65r1c5nu |
Limit | 否 | Integer | 每页数量限制 示例值:20 |
Offset | 否 | Integer | 页偏移量 示例值:10 |
ClusterType | 否 | String | 集群类型, 目前支持传入 tke, eks, tkeedge, external 示例值:tke |
Namespace | 否 | String | helm Release 安装的namespace 示例值:default |
ReleaseName | 否 | String | helm Release 的名字 示例值:test-coredns |
ChartName | 否 | String | helm Chart 的名字 示例值:coredns |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
Limit | Integer | 数量限制 注意:此字段可能返回 null,表示取不到有效值。 示例值:0 |
Offset | Integer | 偏移量 注意:此字段可能返回 null,表示取不到有效值。 示例值:0 |
ReleaseSet | Array of Release | 已安装应用列表 注意:此字段可能返回 null,表示取不到有效值。 |
Total | Integer | 已安装应用总数量 注意:此字段可能返回 null,表示取不到有效值。 示例值:1 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询集群已安装应用列表
展示应用列表
输入示例
POST / HTTP/1.1
Host: tke.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeClusterReleases
<公共请求参数>
{
"ClusterId": "cls-65r1c5nu"
}
输出示例
{
"Response": {
"Limit": 0,
"Offset": 0,
"ReleaseSet": [
{
"Name": "app-name",
"Namespace": "default",
"Revision": "1",
"Status": "deployed",
"ChartName": "redis",
"ChartVersion": "10.5.3",
"AppVersion": "5.0.7",
"UpdatedTime": "2020-04-09 15:28:28.707549 +0800 CST"
}
],
"RequestId": "f12a6e20-f950-4af9-8f8b-b6329a4961c2",
"Total": 1
}
}
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 | 未知参数错误。 |