ALIYUN::ApiGateway::TrafficControl類型用於建立使用者自訂的流控策略。
文法
{
"Type": "ALIYUN::ApiGateway::TrafficControl",
"Properties": {
"TrafficControlName": String,
"Description": String,
"UserDefault": String,
"AppDefault": String,
"TrafficControlUnit": String,
"Special": List,
"ApiDefault": Integer
}
}屬性
屬性名稱 | 類型 | 必須 | 允許更新 | 描述 | 約束 |
ApiDefault | Integer | 是 | 是 | 每個API預設的流控值 | 無 |
TrafficControlName | String | 是 | 是 | 流控策略名稱稱 | 長度為4~50個字元，不能以底線（_）開頭，可包含英文字元、中文字元、數字和底線（_）。 |
TrafficControlUnit | String | 是 | 是 | 流控策略單位 | 取值：
|
AppDefault | String | 否 | 是 | 每 App預設的流控值 | 無 |
Description | String | 否 | 是 | 流控描述資訊 | 無 |
Special | List | 否 | 是 | 設定使用者自訂的特殊流控策略 | 無 |
UserDefault | String | 否 | 是 | 每個使用者預設的流控值 | 無 |
Special 文法
"Special": {
"SpecialType" : String,
"SpecialKey" : String,
"TrafficValue" : Integer
}Special 屬性
屬性名稱 | 類型 | 必須 | 允許更新 | 描述 | 約束 |
SpecialKey | String | 是 | 否 | 根據SpecialType填寫對應的AppId或者阿里雲帳號ID | 無 |
SpecialType | String | 是 | 否 | 特殊流控類型 | 取值：
|
TrafficValue | Integer | 是 | 否 | 特殊流控值 | 無 |
傳回值
Fn::GetAtt
TrafficControlId：使用者自訂流控的ID。
樣本
說明
請您根據實際情況更改脫敏的參數取值。
YAML格式
ROSTemplateFormatVersion: '2015-09-01'
Parameters:
AppId:
Type: String
Description: 特殊的APP ID
Resources:
TrafficControl:
Type: ALIYUN::ApiGateway::TrafficControl
Properties:
TrafficControlName: test_traffic_cont****
TrafficControlUnit: MINUTE
ApiDefault: 400
UserDefault: 200
AppDefault: 100
Description: demo2
Special:
- SpecialType: APP
SpecialKey:
Ref: AppId
TrafficValue: 80JSON格式
{
"ROSTemplateFormatVersion": "2015-09-01",
"Parameters": {
"AppId": {
"Type": "String",
"Description": "特殊的APP ID"
}
},
"Resources": {
"TrafficControl": {
"Type": "ALIYUN::ApiGateway::TrafficControl",
"Properties": {
"TrafficControlName": "test_traffic_cont****",
"TrafficControlUnit": "MINUTE",
"ApiDefault": 400,
"UserDefault": 200,
"AppDefault": 100,
"Description": "demo2",
"Special": [
{
"SpecialType": "APP",
"SpecialKey": {
"Ref": "AppId"
},
"TrafficValue": 80
}
]
}
}
}
}