使用GetScalingRules获取扩缩容规则。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求头

该接口使用公共请求头,无特殊请求头。请参见公共请求参数文档。

请求语法

GET /pop/v5/app/scalingRules HTTP/1.1

请求参数

名称 类型 位置 是否必选 示例值 描述
AppId String Query 33e39be9-3e5f-*********

应用ID。

GroupId String Query d8bb9d60-9**************

部署分组ID。

Mode String Query SCALE_IN

可不传或指定规则类型:

  • SCALE_IN表示缩容。
  • SCALE_OUT表示扩容。

返回数据

名称 类型 示例值 描述
Code Integer 200

HTTP状态码。

Data Struct

数据详情。

ClusterType Integer 2

集群类型。

  • 0:普通Docker集群
  • 1:Swarm集群(已废弃)
  • 2:ECS集群
  • 3:EDAS自建K8s集群
  • 4:Pandora自动注册应用集群类型
  • 5:容器服务K8s集群
OversoldFactor Integer 1

Docker集群支持超卖比例。

  • 1:1:1比例,不超卖
  • 2:1:2比例超卖
  • 4:1:4比例超卖
  • 8:1:8比例超卖
RuleList Array of Rule

规则列表。

Rule
AppId String 33e39be9-3e5f-*********

应用ID。

Cond String OR

触发条件。

  • OR:满足任一条件即触发。
  • AND:满足所有条件才触发。
Cpu Integer 1

触发指标CPU使用率。

CreateTime Long 1574251601801

创建时间的时间戳。

Duration Integer 1574251601

持续时间的时间戳。

Enable Boolean true

是否启用弹性扩容或缩容。

  • true:启用。
  • false:不启用。
GroupId String d8bb9d60-91b5-4cdf-****-************

应用实例分组ID。

InstNum Integer 2

扩容时表示分组内的最大实例数,缩容时表示分组内最小实例数。

LoadNum Integer 1

触发指标:系统负载,即指当前正在被CPU执行和等待被CPU执行的进程数。

MetricType String HSF

Metric类型。

Mode String SCALE_OUT

规则类型。

  • SCALE_IN:缩容
  • SCALE_OUT:扩容
MultiAzPolicy String PRIORITY

多可用区扩缩容策略。

  • PRIORITY:优先级策略
  • BALANCE:均衡分布策略
ResourceFrom String AVAILABLE

实例来源。

  • NEW:弹性资源
  • AVAILABLE:已有资源
  • AVAILABLE_FIRST:已有资源优先
Rt Integer 1

触发指标:服务时延,单位为ms。

SpecId String 03f493c0-xxxx-xxxx-xxxx-12e85cadeb41

Spec ID。

Step Integer 1

每次扩容或缩容的实例数。

TemplateId String lt-bp1xxxxn73pxxxxf83l

启动模版ID

TemplateVersion Integer 1143542

启动模版的版本号。

UpdateTime Long 1574251601785

修改时间的时间戳。

VSwitchIds String vsw-mxxxxkxxxx4xxxxwbionj

VSwitch ID列表。如果设置了多个,以半角逗号(,)分割。

VpcId String vpc-wz9b246z******

VPC ID。

UpdateTime Long 1574251601785

更新时间的时间戳

VpcId String vpc-wz9b246z******

VPC ID。

Message String success

返回信息。

RequestId String D16979DC-4D42-***********

请求ID。

UpdateTime Long 1574251601785

更新时间的时间戳。

示例

请求示例

GET /pop/v5/app/scalingRules HTTP/1.1
公共请求头
{
"AppId": "33e39be9-3e5f-*********",
"GroupId": "d8bb9d60-9**************"
}

正常返回示例

XML格式

<Data>
    <RuleList>
        <Rule>
            <Step>1</Step>
            <SpecId/>
            <AppId>33e39be9-3e5f-4028-****-************</AppId>
            <MultiAzPolicy/>
            <UpdateTime>1574251601785</UpdateTime>
            <MetricType>HSF</MetricType>
            <Mode>SCALE_OUT</Mode>
            <GroupId>d8bb9d60-91b5-4cdf-****-************</GroupId>
            <VpcId/>
            <TemplateId/>
            <Rt>1</Rt>
            <ResourceFrom>AVAILABLE</ResourceFrom>
            <Cpu>1</Cpu>
            <VSwitchIds/>
            <Cond>OR</Cond>
            <InstNum>2</InstNum>
            <Enable>true</Enable>
            <CreateTime>1574251601801</CreateTime>
            <Duration>1</Duration>
            <LoadNum>1</LoadNum>
        </Rule>
    </RuleList>
    <OversoldFactor>1</OversoldFactor>
    <ClusterType>2</ClusterType>
    <VpcId>vpc-wz9b246z******</VpcId>
</Data>
<Message>success</Message>
<Code>200</Code>

JSON格式

{
	"Data": {
		"RuleList": {
			"Rule": [
				{
    "Step": 1,
    "SpecId": "",
    "AppId": "33e39be9-3e5f-4028-****-************",
    "MultiAzPolicy": "",
    "UpdateTime": 1574251601785,
    "MetricType": "HSF",
    "Mode": "SCALE_OUT",
    "GroupId": "d8bb9d60-91b5-4cdf-****-************",
    "VpcId": "",
    "TemplateId": "",
    "Rt": 1,
    "ResourceFrom": "AVAILABLE",
    "Cpu": 1,
    "VSwitchIds": "",
    "Cond": "OR",
    "InstNum": 2,
    "Enable": true,
    "CreateTime": 1574251601801,
    "Duration": 1,
    "LoadNum": 1
}
			]
		},
		"OversoldFactor": 1,
		"ClusterType": 2,
		"VpcId": "vpc-wz9b246z******"
	},
	"Message": "success",
	"Code": 200
}

错误码

访问错误中心查看更多错误码。