获取自动扩缩容规则

最近更新时间:2024-11-11 01:33:39

我的收藏

1. 接口描述

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

获取自动扩缩容规则

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeAutoScaleStrategies。
Version String 公共参数,本接口取值:2019-01-03。
Region String 公共参数,详见产品支持的 地域列表
InstanceId String 实例ID。
示例值:emr-dttol202
GroupId Integer 伸缩组id
示例值:2

3. 输出参数

参数名称 类型 描述
LoadAutoScaleStrategies Array of LoadAutoScaleStrategy 按负载伸缩规则
注意:此字段可能返回 null,表示取不到有效值。
TimeBasedAutoScaleStrategies Array of TimeAutoScaleStrategy 按时间伸缩规则
注意:此字段可能返回 null,表示取不到有效值。
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 获取自动扩缩容规则

输入示例

POST / HTTP/1.1
Host: emr.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeAutoScaleStrategies
<公共请求参数>

{
    "InstanceId": "emr-123",
    "GroupId": 0
}

输出示例

{
    "Response": {
        "LoadAutoScaleStrategies": [
            {
                "CalmDownTime": 60,
                "ConfigGroupAssigned": "",
                "GraceDownFlag": false,
                "GraceDownTime": 0,
                "LoadMetricsConditions": {
                    "LoadMetrics": [
                        {
                            "Conditions": [
                                {
                                    "CompareMethod": 1,
                                    "Threshold": 16
                                }
                            ],
                            "LoadMetrics": "AvailableVCores#root.default",
                            "MetricId": 1,
                            "StatisticPeriod": 60,
                            "TriggerThreshold": 1
                        }
                    ]
                },
                "MeasureMethod": "INSTANCE",
                "PeriodValid": "",
                "Priority": 3,
                "ProcessMethod": 3,
                "ScaleAction": 2,
                "ScaleNum": 2,
                "StrategyId": 1521,
                "StrategyName": "负载缩容",
                "StrategyStatus": 3,
                "Tags": [],
                "YarnNodeLabel": ""
            }
        ],
        "RequestId": "272c1c07-2840-44c8-8753-a761617f71fd",
        "TimeBasedAutoScaleStrategies": [
            {
                "CompensateFlag": 1,
                "ConfigGroupAssigned": "{\"HDFS-3.2.2\":-1,\"IMPALA-4.1.0\":-1,\"KYUUBI-1.6.0\":-1,\"TRINO-389\":-1,\"YARN-3.2.2\":-1}",
                "GraceDownFlag": false,
                "GraceDownTime": 0,
                "GroupId": 0,
                "IntervalTime": 300,
                "MaxUse": 0,
                "MeasureMethod": "INSTANCE",
                "Priority": 1,
                "RepeatStrategy": {
                    "DayRepeat": {
                        "ExecuteAtTimeOfDay": "08:30:00",
                        "Step": 1
                    },
                    "Expire": "2024-09-11 23:59:59",
                    "MonthRepeat": {
                        "DaysOfMonthRange": null,
                        "ExecuteAtTimeOfDay": ""
                    },
                    "NotRepeat": {
                        "ExecuteAt": ""
                    },
                    "RepeatType": "DAY",
                    "WeekRepeat": {
                        "DaysOfWeek": null,
                        "ExecuteAtTimeOfDay": ""
                    }
                },
                "RetryValidTime": 300,
                "ScaleAction": 1,
                "ScaleNum": 1,
                "ServiceNodeInfo": [
                    7
                ],
                "SoftDeployInfo": [
                    1,
                    2
                ],
                "StrategyId": 1274,
                "StrategyName": "时间伸缩扩容周期性",
                "StrategyStatus": 3,
                "Tags": [
                    {
                        "TagKey": "key09993",
                        "TagValue": "value1"
                    },
                    {
                        "TagKey": "key09991",
                        "TagValue": "value1"
                    }
                ],
                "TerminatePolicy": "DEFAULT"
            },
            {
                "CompensateFlag": 0,
                "ConfigGroupAssigned": "",
                "GraceDownFlag": true,
                "GraceDownTime": 180,
                "GroupId": 0,
                "IntervalTime": 60,
                "MaxUse": 0,
                "MeasureMethod": "INSTANCE",
                "Priority": 2,
                "RepeatStrategy": {
                    "DayRepeat": {
                        "ExecuteAtTimeOfDay": "09:30:00",
                        "Step": 1
                    },
                    "Expire": "2024-09-11 23:59:59",
                    "MonthRepeat": {
                        "DaysOfMonthRange": null,
                        "ExecuteAtTimeOfDay": ""
                    },
                    "NotRepeat": {
                        "ExecuteAt": ""
                    },
                    "RepeatType": "DAY",
                    "WeekRepeat": {
                        "DaysOfWeek": null,
                        "ExecuteAtTimeOfDay": ""
                    }
                },
                "RetryValidTime": 60,
                "ScaleAction": 2,
                "ScaleNum": 1,
                "ServiceNodeInfo": null,
                "SoftDeployInfo": null,
                "StrategyId": 1275,
                "StrategyName": "时间伸缩缩容周期性-开启优雅缩容",
                "StrategyStatus": 3,
                "Tags": [],
                "TerminatePolicy": "DEFAULT"
            }
        ]
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

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

命令行工具

6. 错误码

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

错误码 描述
FailedOperation 操作失败。
InternalError.CamCgwError 内部服务调用异常。
InternalError.WoodServerError 内部服务调用异常。
InvalidParameter.InvalidStrategyType 不支持的扩缩容策略类型。
ResourceNotFound.InstanceNotFound 无法找到该实例。