edit-icon download-icon

ALIYUN::ApiGateway::TrafficControlBinding

Last Updated: Jun 13, 2018

ALIYUN::ApiGateway::TrafficControlBinding can be used to set user-defined traffic throttles for APIs.

Syntax

  1. {
  2. "Type" : "ALIYUN::ApiGateway::TrafficControlBinding",
  3. "Properties" : {
  4. "ApiIds" : List,
  5. "TrafficControlId" : String,
  6. "StageName" : String,
  7. "GroupId" : String
  8. }
  9. }

Attributes

Attribute name Type Required Update allowed Description
ApiIds list Yes Yes Specify the API IDs. You can enter up to 100 IDs
TrafficControlId string Yes Yes Specify the traffic throttling strategy
StageName string Yes Yes Specify the stage for API operation. Values: TEST,PRE,and RELEASE
GroupId string Yes Yes Specify the API group ID

Example

  1. {
  2. "ROSTemplateFormatVersion": "2015-09-01",
  3. "Parameters": {
  4. "TrafficControlId": {
  5. "Type": "String",
  6. "Description": "The traffic throttling strategy ID"
  7. },
  8. "GroupId": {
  9. "Type": "String",
  10. "Description": "The API group ID"
  11. },
  12. "ApiId": {
  13. "Type": "String",
  14. "Description": "API IDs"
  15. }
  16. },
  17. "Resources": {
  18. "TrafficControlBinding": {
  19. "Type": "ALIYUN::ApiGateway::TrafficControlBinding",
  20. "Properties": {
  21. "TrafficControlId": {
  22. "Ref": "TrafficControlId"
  23. },
  24. "GroupId": {
  25. "Ref": "GroupId"
  26. },
  27. "ApiIds": [
  28. {
  29. "Ref": "ApiId"
  30. }
  31. ],
  32. "StageName": "RELEASE"
  33. }
  34. }
  35. }
  36. }
Thank you! We've received your feedback.