describeScalingActivities

描述

查询高可用组中一个或多个弹性伸缩活动。

接口说明

• 无论高可用组是否开启弹性伸缩功能，都可以调用本接口。

• 本接口以分页形式返回活动列表。

请求方式

GET

请求地址

https://ag.jdcloud-api.com/v1/regions/{regionId}/autoScaling/{agId}:describeScalingActivities

名称	类型	是否必需	示例值	描述
regionId	String	是	cn-north-1	地域ID。可参考地域及可用区。
agId	String	是	ag-fljk****tt	高可用组 ID。

请求参数

名称	类型	是否必需	示例值	描述
pageNumber	Integer	否	1	页码，默认值为1。
pageSize	Integer	否	20	分页大小，默认值为20；取值范围[10-100]。
filters	Filter[]	否	-	beginTime 开始时间，精确匹配，查询大于等于这个时间的记录。 endTime 结束时间，精确匹配，查询小于等于这个时间的记录。 status 活动当前状态，精确匹配 。 可选值： SUCCESS 成功。 REJECTED 拒绝。 FAILED 失败。 RUNNING 执行中。 WARN 部分成功。 以上每个filter项仅支持单个值查询,如果传多个值仅取第一个值。
sorts	Sort[]	否	-	排序条件列表，目前只支持单个排序条件，不支持多个排序条件，默认按照 startTime 降序排序 支持使用以下关键字进行排序 - startTime: 活动开始时间。

Sort

名称	类型	是否必需	示例值	描述
name	String	是	startTime	排序条件的名称。
direction	String	否	desc	排序条件的方向，默认值为desc，取值范围：[asc-desc]。

Filter

名称	类型	是否必需	示例值	描述
name	String	是	status	过滤条件的名称。
operator	String	否	eq	过滤条件的操作符，目前只支持 eq 操作符。
values	String[]	是	SUCCESS	过滤条件的值。

返回参数

名称	类型	示例值	描述
result	Result	-	请求结果。
requestId	String	c2hmmaan8w06w19qcdfuic4w03****2d	请求ID。

Result

名称	类型	示例值	描述
scalingActivities	Activity[]	-	弹性伸缩活动。
totalCount	Integer	1	获取结果数。

Activity

名称	类型	示例值	描述
activityId	String	asactivity-asfr****fg	伸缩活动ID。
status	String	SUCCESS	活动状态，可能值： SUCCESS 成功。 REJECTED 拒绝。 FAILED 失败。 RUNNING 执行中。 WARN 部分成功。
targetTotal	Integer	10	变化后实例总数。
startTime	String	2023-05-10 10:10:00	开始时间。
endTime	String	2023-05-10 11:10:00	结束时间。
description	String	对伸缩活动的描述	伸缩活动描述，展示期望实例数、最大最小数变化至多少，或展示活动应增加移出多少实例。
cause	String	手动添加实例	活动起因，包括但不限于下述起因： 手动添加实例。 手动移出/删除实例。 手动修改期望实例数/最大实例数/最小实例数。 健康检查失败。 手动执行伸缩规则。 定时任务触发 。 报警任务触发。
detail	ActivityDetail	参见描述	详细信息，包括但不限于下述信息： 若活动执行成功，展示具体哪些实例（ID）被添加或移出。 若活动执行失败，则展示失败原因。 若活动执行部分成功，展示哪些实例（ID）被成功添加或移出，并展示其余资源失败原因 。

ActivityDetail

名称	类型	示例值	描述
title	String	activity-detail-test	标题
value	String	关于资源的详细信息	资源详细信息

示例

GET
调用方法、签名算法及公共请求参数请参考京东云OpenAPI公共说明。

• 请求示例

v1/regions/cn-north-1/autoScaling/ag-fljk****tt:describeScalingActivities
{
    "pageNumber": 1,
    "pageSize": 20,
    "filters": [
        {
            "status": "SUCCESS"
        }
    ],
    "sorts": [
        {
            "name": "startTime",
            "direction": "desc"
        }
    ]
}

• 返回示例

{
    "result": {
        "scalingActivities": [
            {
                "activityId": "asactivity-asfr****fg",
                "status": "SUCCESS",
                "targetTotal": 10,
                "startTime": "2023-05-10 10:10:00",
                "endTime": "2023-05-10 11:10:00",
                "description": "对伸缩活动的描述",
                "cause": "手动添加实例",
                "detail": {
                    "title": "activity-detail-test",
                    "value": "关于资源的详细信息"
                }
            }
        ],
        "totalcout": 1
    },
    "requestId": "c2i8w4g6fiqocr2fetqf8ef59k****ir"
}

返回码

HTTP状态码	错误码	描述	错误解析
200		OK