调用EnableFlowRule接口开启流控规则。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | EnableFlowRule |
系统规定参数。取值:EnableFlowRule。 |
RuleId | Long | 是 | 123 |
流控规则ID。 |
AhasRegionId | String | 否 | cn-hangzhou |
地域 |
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
Message | String | null |
错误信息。 |
RequestId | String | 3FEEAD12-CE22-4EDE-A729-CE94EC070610 |
请求ID。 |
Data | Object |
流控规则数据。 |
|
RefResource | String | handleServiceB |
关联接口名、入口资源名。 |
ClusterFallbackThreshold | Integer | 30 |
退化单机阈值,当退化策略为退化到单机(ClusterFallbackStrategy=0)时返回。 |
Namespace | String | default |
命名空间。 |
LimitOrigin | String | default |
来源应用。 |
StatDurationMs | Integer | 5000 |
集群模式下统计窗口时长。 |
ClusterThresholdType | Integer | 0 |
阈值模式,0表示单机均摊阈值,1表示集群阈值。 |
RuleId | Long | 123 |
流控规则ID。 |
RelationStrategy | Integer | 0 |
统计维度。 |
AppName | String | ahas-demo |
应用名,若为EDAS应用,则AppName为EDAS中的App ID,可在EDAS控制台“应用管理>基本信息”中查看对应的ID。 |
Resource | String | handleServiceA |
接口资源名。 |
MaxQueueingTimeMs | Integer | 2000 |
超时时间。 |
ClusterEstimatedMaxQps | Float | 3000 |
集群接口预估最大QPS。 |
ControlBehavior | Integer | 0 |
流控效果。0表示快速失败,1表示预热启动,2表示排队等待。 |
WarmUpPeriodSec | Integer | 30 |
预热时间。 |
ClusterFallbackStrategy | Integer | 1 |
集群流控通信失败退化策略,0表示退化到单机,1表示直接通过。 |
Threshold | Float | 50 |
流控阈值。 |
ClusterMode | Boolean | true |
是否为集群模式。 |
Enable | Boolean | true |
规则是否开启。 |
Code | String | 200 |
返回码。 |
Success | Boolean | true |
是否成功。 |
示例
请求示例
http(s)://[Endpoint]/?Action=EnableFlowRule
&RuleId=123
&<公共请求参数>
正常返回示例
XML
格式
HTTP/1.1 200 OK
Content-Type:application/xml
<EnableFlowRuleResponse>
<Message>null</Message>
<RequestId>3FEEAD12-CE22-4EDE-A729-CE94EC070610</RequestId>
<Data>
<RefResource>handleServiceB</RefResource>
<ClusterFallbackThreshold>30</ClusterFallbackThreshold>
<Namespace>default</Namespace>
<LimitOrigin>default</LimitOrigin>
<StatDurationMs>5000</StatDurationMs>
<ClusterThresholdType>0</ClusterThresholdType>
<RuleId>123</RuleId>
<RelationStrategy>0</RelationStrategy>
<AppName>ahas-demo</AppName>
<Resource>handleServiceA</Resource>
<MaxQueueingTimeMs>2000</MaxQueueingTimeMs>
<ClusterEstimatedMaxQps>3000</ClusterEstimatedMaxQps>
<ControlBehavior>0</ControlBehavior>
<WarmUpPeriodSec>30</WarmUpPeriodSec>
<ClusterFallbackStrategy>1</ClusterFallbackStrategy>
<Threshold>50</Threshold>
<ClusterMode>true</ClusterMode>
<Enable>true</Enable>
</Data>
<Code>200</Code>
<Success>true</Success>
</EnableFlowRuleResponse>
JSON
格式
HTTP/1.1 200 OK
Content-Type:application/json
{
"Message" : "null",
"RequestId" : "3FEEAD12-CE22-4EDE-A729-CE94EC070610",
"Data" : {
"RefResource" : "handleServiceB",
"ClusterFallbackThreshold" : 30,
"Namespace" : "default",
"LimitOrigin" : "default",
"StatDurationMs" : 5000,
"ClusterThresholdType" : 0,
"RuleId" : 123,
"RelationStrategy" : 0,
"AppName" : "ahas-demo",
"Resource" : "handleServiceA",
"MaxQueueingTimeMs" : 2000,
"ClusterEstimatedMaxQps" : 3000,
"ControlBehavior" : 0,
"WarmUpPeriodSec" : 30,
"ClusterFallbackStrategy" : 1,
"Threshold" : 50,
"ClusterMode" : true,
"Enable" : true
},
"Code" : "200",
"Success" : true
}
错误码
访问错误中心查看更多错误码。