弹性伸缩查询告警触发策略-告警触发策略相关接口-API 中心-腾讯云

1. 接口描述

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

本接口（DescribeScalingPolicies）用于查询告警触发策略。

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

推荐使用 API Explorer

点击调试

API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：DescribeScalingPolicies。
Version	是	String	公共参数，本接口取值：2018-04-19。
Region	是	String	公共参数，详见产品支持的地域列表。
AutoScalingPolicyIds.N	否	Array of String	按照一个或者多个告警策略ID查询。告警策略ID形如：asp-i9vkg894。每次请求的实例的上限为100。参数不支持同时指定`AutoScalingPolicyIds`和`Filters`。示例值：["asp-5zffv598"]
Filters.N	否	Array of Filter	过滤条件。 auto-scaling-policy-id - String - 是否必填：否 -（过滤条件）按照告警策略ID过滤。 auto-scaling-group-id - String - 是否必填：否 -（过滤条件）按照伸缩组ID过滤。 scaling-policy-name - String - 是否必填：否 -（过滤条件）按照告警策略名称过滤。 scaling-policy-type - String - 是否必填：否 -（过滤条件）按照告警策略类型过滤，取值范围为SIMPLE，TARGET_TRACKING。每次请求的`Filters`的上限为10，`Filter.Values`的上限为5。参数不支持同时指定`AutoScalingPolicyIds`和`Filters`。示例值：[{"Name": "auto-scaling-group-id", "Values": ["asg-ewdpp04x"]}]
Limit	否	Integer	返回数量，默认为20，最大值为100。关于`Limit`的更进一步介绍请参考 API 简介中的相关小节。示例值：20
Offset	否	Integer	偏移量，默认为0。关于`Offset`的更进一步介绍请参考 API 简介中的相关小节。示例值：0

3. 输出参数

参数名称	类型	描述
ScalingPolicySet	Array of ScalingPolicy	弹性伸缩告警触发策略详细信息列表。
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: DescribeScalingPolicies
<公共请求参数>

{
    "AutoScalingPolicyIds": [
        "asp-7mme2ule"
    ]
}

输出示例

{
    "Response": {
        "TotalCount": 1,
        "ScalingPolicySet": [
            {
                "EstimatedInstanceWarmup": null,
                "MetricAlarms": null,
                "AutoScalingGroupId": "asg-9dn1a5y6",
                "PredefinedMetricType": null,
                "ScalingPolicyType": "SIMPLE",
                "DisableScaleIn": null,
                "AutoScalingPolicyId": "asp-7mme2ule",
                "NotificationUserGroupIds": [],
                "Cooldown": 666,
                "ScalingPolicyName": "simple_policy_test",
                "AdjustmentType": "CHANGE_IN_CAPACITY",
                "MetricAlarm": {
                    "ComparisonOperator": "GREATER_THAN",
                    "Period": 60,
                    "ContinuousTime": 5,
                    "Threshold": 20,
                    "Statistic": "AVERAGE",
                    "PreciseThreshold": 20,
                    "MetricName": "CPU_UTILIZATION"
                },
                "TargetValue": null,
                "AdjustmentValue": 3
            }
        ],
        "RequestId": "297c6ed3-aa1c-43f4-be0f-10e513a86e6e"
    }
}

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

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

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

错误码	描述
InternalError.CallMonitorError	Monitor接口调用失败。
InternalError.RequestError	内部请求错误。
InvalidParameter.ActionNotFound	无效的Action请求。
InvalidParameter.Conflict	参数冲突，指定的多个参数冲突，不能同时存在。
InvalidParameterValue.InvalidAutoScalingGroupId	伸缩组ID无效。
InvalidParameterValue.InvalidAutoScalingPolicyId	告警策略ID无效。
InvalidParameterValue.InvalidFilter	过滤条件无效。
LimitExceeded	超过配额限制。

查询告警触发策略

本页目录：