ALIYUN::ApiGateway::TrafficControl类型用于创建用户自定义的流控策略。

语法

{
  "Type": "ALIYUN::ApiGateway::TrafficControl",
  "Properties": {
    "TrafficControlName": String,
    "Description": String,
    "UserDefault": String,
    "AppDefault": String,
    "TrafficControlUnit": String,
    "Special": List,
    "ApiDefault": Integer
  }
}

属性

属性名称类型必须允许更新描述约束
TrafficControlName String 流控策略名称 长度为4~50个字符,不能以下划线(_)开头,可包含英文字符、中文字符、数字和下划线(_)。
TrafficControlUnit String 流控策略单位取值:
  • MINUTE
  • HOUR
  • DAY
ApiDefault Integer 每个API默认的流控值
Description String 流控描述信息
UserDefault String 每个用户默认的流控值
AppDefault String 每 App默认的流控值
Special List 设置用户自定义的特殊流控策略

Special 语法

"Special": {
  "SpecialType" : String,
  "SpecialKey" : String,
  "TrafficValue" : Integer
}

Special 属性

属性名称类型必须允许更新描述约束
SpecialType String 特殊流控类型 取值:
  • APP
  • USER
SpecialKey String 根据SpecialType填写对应的AppId或者阿里云账号ID
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: 80
  • JSON格式

    {
      "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
              }
            ]
          }
        }
      }
    }