1. 接口描述
接口请求域名: as.tencentcloudapi.com 。
本接口(DescribeAutoScalingInstances)用于查询弹性伸缩关联实例的信息。
- 可以根据实例ID、伸缩组ID等信息来查询实例的详细信息。过滤信息详细请见过滤器
Filter
。 - 如果参数为空,返回当前用户一定数量(
Limit
所指定的数量,默认为20)的实例。
默认接口请求频率限制:60次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DescribeAutoScalingInstances。 |
Version | 是 | String | 公共参数,本接口取值:2018-04-19。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
InstanceIds.N | 否 | Array of String | 待查询云服务器(CVM)的实例ID。每次请求的上限为100。参数不支持同时指定InstanceIds和Filters。 示例值:["ins-1fswxz1m"] |
Filters.N | 否 | Array of Filter | 过滤条件。 每次请求的 Filters 的上限为10,Filter.Values 的上限为5。参数不支持同时指定InstanceIds 和Filters 。示例值:[{"Name": "auto-scaling-group-id", "Values": ["asg-ewdpp04x"]}] |
Offset | 否 | Integer | 偏移量,默认为0。关于Offset 的更进一步介绍请参考 API 简介中的相关小节。示例值:0 |
Limit | 否 | Integer | 返回数量,默认为20,最大值为100。关于Limit 的更进一步介绍请参考 API 简介中的相关小节。示例值:20 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
AutoScalingInstanceSet | Array of Instance | 实例详细信息列表。 示例值:[{"ProtectedFromScaleIn": true, "Zone": "sa-saopaulo-1", "CreationType": "AUTO_CREATION", "AutoScalingGroupId": "asg-f7rsts7d", "AddTime": "2024-07-25T13:16:42Z", "WarmupStatus": "NO_NEED_WARMUP", "LaunchConfigurationId": "asc-m4usv5o3", "AutoScalingGroupName": "tke-np-ss", "InstanceId": "ins-kajsxfzp", "VersionNumber": 1, "HealthStatus": "HEALTHY", "LifeCycleState": "IN_SERVICE", "LaunchConfigurationName": "tke-np-sd", "InstanceType": "S5.2XLARGE32"}] |
TotalCount | Integer | 符合条件的实例数量。 示例值:1 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询实例
根据指定实例 ID 或过滤条件查询实例的相关信息。
输入示例
POST / HTTP/1.1
Host: as.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeAutoScalingInstances
<公共请求参数>
{
"InstanceIds": [
"ins-1fswxz1m"
]
}
输出示例
{
"Response": {
"TotalCount": 1,
"AutoScalingInstanceSet": [
{
"ProtectedFromScaleIn": false,
"Zone": "ap-guangzhou-3",
"LaunchConfigurationId": "asc-5fzsm72a",
"InstanceId": "ins-1fswxz1m",
"VersionNumber": 1,
"DisasterRecoverGroupIds": [],
"AddTime": "2018-08-21T12:05:12Z",
"CreationType": "AUTO_CREATION",
"AutoScalingGroupName": "asgname",
"AutoScalingGroupId": "asg-4o61gsxi",
"HealthStatus": "HEALTHY",
"LifeCycleState": "IN_SERVICE",
"LaunchConfigurationName": "系列2本地盘",
"InstanceType": "S2.SMALL2",
"WarmupStatus": "IN_WARMUP"
}
],
"RequestId": "2ae3e836-d47a-431c-b54b-4e1c2f419e5b"
}
}
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. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
InternalError | 内部错误。 |
InvalidParameter.ActionNotFound | 无效的Action请求。 |
InvalidParameter.Conflict | 参数冲突,指定的多个参数冲突,不能同时存在。 |
InvalidParameterValue.Filter | 无效的过滤器。 |
InvalidParameterValue.InvalidAutoScalingGroupId | 伸缩组ID无效。 |
InvalidParameterValue.InvalidFilter | 过滤条件无效。 |
InvalidParameterValue.InvalidInstanceId | 实例ID无效。 |
InvalidParameterValue.LimitExceeded | 取值超出限制。 |
LimitExceeded.FilterValuesTooLong | 特定过滤器的值过多。 |