查询伸缩活动

最近更新时间:2019-03-14 16:31:56

1. 接口描述

接口请求域名: as.tencentcloudapi.com 。

本接口(DescribeAutoScalingActivities)用于查询伸缩组的伸缩活动记录。

默认接口请求频率限制:20次/秒。

注意:本接口支持金融区地域。由于金融区和非金融区是隔离不互通的,因此当公共参数 Region 为金融区地域(例如 ap-shanghai-fsi)时,需要同时指定带金融区地域的域名,最好和 Region 的地域保持一致,例如:as.ap-shanghai-fsi.tencentcloudapi.com 。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeAutoScalingActivities
Version String 公共参数,本接口取值:2018-04-19
Region String 公共参数,详见产品支持的地域列表
ActivityIds.N Array of String 按照一个或者多个伸缩活动ID查询。伸缩活动ID形如:asa-5l2ejpfo。每次请求的上限为100。参数不支持同时指定ActivityIdsFilters
Filters.N Array of Filter 过滤条件。
  • auto-scaling-group-id - String - 是否必填:否 -(过滤条件)按照伸缩组ID过滤。
  • activity-status-code - String - 是否必填:否 -(过滤条件)按照伸缩活动状态过滤。(INIT:初始化中|RUNNING:运行中|SUCCESSFUL:活动成功|PARTIALLY_SUCCESSFUL:活动部分成功|FAILED:活动失败|CANCELLED:活动取消)
  • activity-type - String - 是否必填:否 -(过滤条件)按照伸缩活动类型过滤。(SCALE_OUT:扩容活动|SCALE_IN:缩容活动|ATTACH_INSTANCES:添加实例|REMOVE_INSTANCES:销毁实例|DETACH_INSTANCES:移出实例|TERMINATE_INSTANCES_UNEXPECTEDLY:实例在CVM控制台被销毁|REPLACE_UNHEALTHY_INSTANCE:替换不健康实例|UPDATE_LOAD_BALANCERS:更新负载均衡器)
  • activity-id - String - 是否必填:否 -(过滤条件)按照伸缩活动ID过滤。

  • 每次请求的Filters的上限为10,Filter.Values的上限为5。参数不支持同时指定ActivityIdsFilters
    Limit Integer 返回数量,默认为20,最大值为100。关于Limit的更进一步介绍请参考 API 简介中的相关小节。
    Offset Integer 偏移量,默认为0。关于Offset的更进一步介绍请参考 API 简介中的相关小节。
    StartTime Timestamp 伸缩活动最早的开始时间,如果指定了ActivityIds,此参数将被忽略。取值为UTC时间,按照ISO8601标准,格式:YYYY-MM-DDThh:mm:ssZ
    EndTime Timestamp 伸缩活动最晚的结束时间,如果指定了ActivityIds,此参数将被忽略。取值为UTC时间,按照ISO8601标准,格式:YYYY-MM-DDThh:mm:ssZ

    3. 输出参数

    参数名称 类型 描述
    TotalCount Integer 符合条件的伸缩活动数量。
    ActivitySet Array of Activity 符合条件的伸缩活动信息集合。
    RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

    4. 示例

    示例1 使用Filters查看伸缩活动列表

    输入示例

    https://as.tencentcloudapi.com/?Action=DescribeAutoScalingActivities
    &Filters.0.Name=activity-id
    &Filters.0.Values.0=asa-o4v87ae9
    &<公共请求参数>

    输出示例

    {
        "Response": {
            "TotalCount": 1,
            "ActivitySet": [
                {
                    "Description": "Activity was launched in response to a difference between desired capacity and actual capacity, scale out 1 instance(s).",
                    "AutoScalingGroupId": "asg-2umy3jbd",
                    "ActivityRelatedInstanceSet": [
                        {
                            "InstanceId": "ins-q3ss14yo",
                            "InstanceStatus": "SUCCESSFUL"
                        }
                    ],
                    "ActivityType": "SCALE_OUT",
                    "ActivityId": "asa-o4v87ae9",
                    "StartTime": "2018-11-20T08:33:56Z",
                    "CreatedTime": "2018-11-20T08:33:56Z",
                    "EndTime": "2018-11-20T08:34:52Z",
                    "Cause": "Activity was launched in response to a difference between desired capacity and actual capacity.",
                    "StatusMessageSimplified": "Success",
                    "StatusMessage": "Success",
                    "StatusCode": "SUCCESSFUL"
                }
            ],
            "RequestId": "1082ab5d-c985-4d8c-bb9d-0d05e282b4a7"
        }
    }

    示例2 根据伸缩活动ID查询伸缩活动列表

    输入示例

    https://as.tencentcloudapi.com/?Action=DescribeAutoScalingActivities
    &ActivityIds.0=asa-o4v87ae9
    &<公共请求参数>

    输出示例

    {
        "Response": {
            "TotalCount": 1,
            "ActivitySet": [
                {
                    "Description": "Activity was launched in response to a difference between desired capacity and actual capacity, scale out 1 instance(s).",
                    "AutoScalingGroupId": "asg-2umy3jbd",
                    "ActivityRelatedInstanceSet": [
                        {
                            "InstanceId": "ins-q3ss14yo",
                            "InstanceStatus": "SUCCESSFUL"
                        }
                    ],
                    "ActivityType": "SCALE_OUT",
                    "ActivityId": "asa-o4v87ae9",
                    "StartTime": "2018-11-20T08:33:56Z",
                    "CreatedTime": "2018-11-20T08:33:56Z",
                    "EndTime": "2018-11-20T08:34:52Z",
                    "Cause": "Activity was launched in response to a difference between desired capacity and actual capacity.",
                    "StatusMessageSimplified": "Success",
                    "StatusMessage": "Success",
                    "StatusCode": "SUCCESSFUL"
                }
            ],
            "RequestId": "1082ab5d-c985-4d8c-bb9d-0d05e282b4a7"
        }
    }

    5. 开发者资源

    API Explorer

    该工具提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力,能显著降低使用云 API 的难度,推荐使用。

    SDK

    云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

    命令行工具

    6. 错误码

    以下仅列出了接口业务逻辑相关的错误码,其他错误码详见公共错误码

    错误码 描述
    InternalError 内部错误
    InvalidParameter.Conflict 参数冲突,指定的多个参数冲突,不能同时存在。
    InvalidParameterValue.Filter 无效的过滤器。
    InvalidParameterValue.LimitExceeded 取值超出限制。