1. 接口描述
接口请求域名： as.tencentcloudapi.com 。
本接口（DescribeRefreshActivities）用于查询伸缩组的实例刷新活动记录。
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：DescribeRefreshActivities。 |
| Version | 是 | String | 公共参数，本接口取值：2018-04-19。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| RefreshActivityIds.N | 否 | Array of String | 刷新活动ID列表。ID形如：asr-5l2ejpfo。每次请求的上限为100。参数不支持同时指定RefreshActivityIds和Filters。示例值：["asr-aaaabbbb"] |
| Filters.N | 否 | Array of Filter | 过滤条件。 |
| Limit | 否 | Integer | 返回数量，默认为20，最大值为100。关于Limit的更进一步介绍请参考 API 简介中的相关小节。示例值：100 |
| Offset | 否 | Integer | 偏移量，默认为0。关于Offset的更进一步介绍请参考 API 简介中的相关小节。示例值：0 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| TotalCount | Integer | 符合条件的刷新活动数量。 示例值：1 |
| RefreshActivitySet | Array of RefreshActivity | 符合条件的刷新活动信息集合。 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 使用Filters查看刷新活动列表
使用Filters查询刷新活动 asr-cs0fxpcu。
输入示例
POST / HTTP/1.1
Host: as.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeRefreshActivities
<公共请求参数>
{
"Filters": [
{
"Name": "refresh-activity-id",
"Values": [
"asr-cs0fxpcu"
]
}
]
}输出示例
{
"Response": {
"TotalCount": 1,
"RefreshActivitySet": [
{
"Status": "SUCCESSFUL",
"RefreshBatchSet": [
{
"RefreshBatchNum": 3,
"EndTime": "2023-09-07T16:32:56Z",
"RefreshBatchRelatedInstanceSet": [
{
"InstanceId": "ins-w188n53l",
"InstanceStatusMessage": "success",
"LastActivityId": "asa-pb2y1bna",
"InstanceStatus": "SUCCESSFUL"
}
],
"StartTime": "2023-09-07T16:31:44Z",
"RefreshBatchStatus": "SUCCESSFUL"
},
{
"RefreshBatchNum": 2,
"EndTime": "2023-09-07T16:31:44Z",
"RefreshBatchRelatedInstanceSet": [
{
"InstanceId": "ins-w1824wre",
"InstanceStatusMessage": "success",
"LastActivityId": "asa-e8dqz8r6",
"InstanceStatus": "SUCCESSFUL"
},
{
"InstanceId": "ins-w188n53m",
"InstanceStatusMessage": "success",
"LastActivityId": "asa-e8dqz8r6",
"InstanceStatus": "SUCCESSFUL"
}
],
"StartTime": "2023-09-07T16:29:56Z",
"RefreshBatchStatus": "SUCCESSFUL"
},
{
"RefreshBatchNum": 1,
"EndTime": "2023-09-07T16:29:55Z",
"RefreshBatchRelatedInstanceSet": [
{
"InstanceId": "ins-w188n53k",
"InstanceStatusMessage": "success",
"LastActivityId": "asa-e0o3uxsu",
"InstanceStatus": "SUCCESSFUL"
},
{
"InstanceId": "ins-w188n53n",
"InstanceStatusMessage": "success",
"LastActivityId": "asa-e0o3uxsu",
"InstanceStatus": "SUCCESSFUL"
}
],
"StartTime": "2023-09-07T16:27:49Z",
"RefreshBatchStatus": "SUCCESSFUL"
}
],
"RefreshMode": "ROLLING_UPDATE_RESET",
"AutoScalingGroupId": "asg-kgujlegg",
"ActivityType": "NORMAL",
"RefreshSettings": {
"CheckInstanceTargetHealth": true,
"RollingUpdateSettings": {
"BatchNumber": 3,
"BatchPause": "AUTOMATIC"
}
},
"OriginRefreshActivityId": "",
"CurrentRefreshBatchNum": 3,
"RefreshActivityId": "asr-cs0fxpcu",
"StartTime": "2023-09-07T16:27:49Z",
"CreatedTime": "2023-09-07T16:27:49Z",
"EndTime": "2023-09-07T16:32:56Z"
}
],
"RequestId": "48869660-f1df-4085-a62c-1f9636cbe030"
}
}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.LimitExceeded | 取值超出限制。 |
| LimitExceeded.FilterValuesTooLong | 特定过滤器的值过多。 |