1. 接口描述
接口请求域名: tke.tencentcloudapi.com 。
集群关联的伸缩组列表
默认接口请求频率限制:20次/秒。
注意:本接口支持金融区地域。由于金融区和非金融区是隔离不互通的,因此当公共参数 Region 为金融区地域(例如 ap-shanghai-fsi)时,需要同时指定带金融区地域的域名,最好和 Region 的地域保持一致,例如:tke.ap-shanghai-fsi.tencentcloudapi.com。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DescribeClusterAsGroups。 |
Version | 是 | String | 公共参数,本接口取值:2018-05-25。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
ClusterId | 是 | String | 集群ID |
AutoScalingGroupIds.N | 否 | Array of String | 伸缩组ID列表,如果为空,表示拉取集群关联的所有伸缩组。 |
Offset | 否 | Integer | 偏移量,默认为0。关于Offset的更进一步介绍请参考 API 简介中的相关小节。 |
Limit | 否 | Integer | 返回数量,默认为20,最大值为100。关于Limit的更进一步介绍请参考 API 简介中的相关小节。 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
TotalCount | Integer | 集群关联的伸缩组总数 |
ClusterAsGroupSet | Array of ClusterAsGroup | 集群关联的伸缩组列表 |
RequestId | String | 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 集群关联的伸缩组列表
输入示例
https://tke.tencentcloudapi.com/?Action=DescribeClusterAsGroups
&ClusterId=cls-xxxxxx
&<公共请求参数>
输出示例
{
"Response": {
"RequestId": "82f2fe9c-c5fa-4077-9236-f1341180a696"
}
}
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
- Tencent Cloud SDK 3.0 for Java
- Tencent Cloud SDK 3.0 for PHP
- Tencent Cloud SDK 3.0 for Go
- Tencent Cloud SDK 3.0 for NodeJS
- Tencent Cloud SDK 3.0 for .NET
- Tencent Cloud SDK 3.0 for C++
- Tencent Cloud SDK 3.0 for Ruby
命令行工具
- Tencent Cloud CLI 3.0
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
FailedOperation | 操作失败。 |
InternalError | 内部错误。 |
InternalError.AccountUserNotAuthenticated | 账户未通过认证。 |
InternalError.AsCommon | 伸缩组资源创建报错。 |
InternalError.ClusterNotFound | 集群未找到。 |
InternalError.ClusterState | 集群状态错误。 |
InternalError.Db | db错误。 |
InternalError.Param | Param。 |
InternalError.PodNotFound | Pod未找到。 |
InternalError.VpcCommon | VPC报错。 |
InternalError.VpcPeerNotFound | 对等连接不存在。 |
InternalError.VpcRecodrNotFound | 未发现vpc记录。 |