1. 接口描述
接口请求域名: thpc.tencentcloudapi.com 。
本接口(BindAutoScalingGroup)用于为集群队列绑定弹性伸缩组
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:BindAutoScalingGroup。 |
Version | 是 | String | 公共参数,本接口取值:2022-04-01。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
ClusterId | 是 | String | 集群ID。 示例值:hpc-5lyv94lq |
LaunchConfigurationId | 是 | String | 弹性伸缩启动配置ID。 示例值:asc-jhf9c1gi |
AutoScalingGroupId | 是 | String | 弹性伸缩组ID。 示例值:asg-aesc6pcq |
QueueName | 否 | String | 队列名称。 示例值:all.q |
ExpansionBusyTime | 否 | Integer | 任务连续等待时间,队列的任务处于连续等待的时间。单位秒。默认值120。 示例值:120 |
ShrinkIdleTime | 否 | Integer | 节点连续空闲(未运行作业)时间,一个节点连续处于空闲状态时间。单位秒。默认值300。 示例值:300 |
EnableAutoExpansion | 否 | Boolean | 是否开启自动扩容,默认值true。 示例值:True |
EnableAutoShrink | 否 | Boolean | 是否开启自动缩容,默认值true。 示例值:True |
DryRun | 否 | Boolean | 是否只预检此次请求。 true:发送检查请求,不会绑定弹性伸缩组。检查项包括是否填写了必需参数,请求格式,业务限制。 如果检查不通过,则返回对应错误码; 如果检查通过,则返回RequestId。 false(默认):发送正常请求,通过检查后直接绑定弹性伸缩组。 示例值:False |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 绑定弹性伸缩组
输入示例
https://thpc.tencentcloudapi.com/?Action=BindAutoScalingGroup
&ClusterId=hpc-5lyv94lq
&LaunchConfigurationId=asc-jhf9c1gi
&AutoScalingGroupId=asg-aesc6pcq
&ExpansionBusyTime=120
&ShrinkIdleTime=300
&DryRun=false
&<公共请求参数>
输出示例
{
"Response": {
"RequestId": "f4d90874-f565-463d-ba1d-c707517eeaa1"
}
}
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. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
InvalidParameter.Malformed | 参数格式有误。 |
InvalidParameterValue.TooSmall | 参数值过小。 |
ResourceNotFound.AutoScalingGroupId | 无法找到弹性伸缩组ID。 |
ResourceNotFound.ClusterId | 集群不存在。 |
ResourceNotFound.LaunchConfigurationId | 无法找到ID对应的弹性伸缩启动配置。 |
UnsupportedOperation.AutoScalingGroupAlreadyBinded | 该伸缩组已绑定集群,请更换伸缩组。 |
UnsupportedOperation.ClusterStatusNotSupport | 该集群当前状态不支持该操作。 |