ALIYUN::ApiGateway::TrafficControlBinding is used to configure user-defined throttling policies for APIs.
Syntax
{
"Type": "ALIYUN::ApiGateway::TrafficControlBinding",
"Properties": {
"ApiIds": List,
"TrafficControlId": String,
"StageName": String,
"GroupId": String
}
}
Properties
Property | Type | Required | Editable | Description | Constraint |
---|---|---|---|---|---|
ApiIds | List | Yes | Yes | The IDs of the specified APIs. | You can specify up to 100 API IDs. |
TrafficControlId | String | Yes | Yes | The ID of the throttling policy that you want to bind to APIs. | None. |
StageName | String | Yes | Yes | The API environment. | Valid values:
|
GroupId | String | Yes | Yes | The ID of the API group to which the API belongs. | None. |
Response parameters
Fn::GetAtt
None.
Examples
{
"ROSTemplateFormatVersion": "2015-09-01",
"Parameters": {
"TrafficControlId": {
"Type": "String",
"Description": "The ID of the throttling policy"
},
"GroupId": {
"Type": "String",
"Description": "The ID of the API group"
},
"ApiId": {
"Type": "String",
"Description": "The ID of the API to which the throttling policy is bound"
}
},
"Resources": {
"TrafficControlBinding": {
"Type": "ALIYUN::ApiGateway::TrafficControlBinding",
"Properties": {
"TrafficControlId": {
"Ref": "TrafficControlId"
},
"GroupId": {
"Ref": "GroupId"
},
"ApiIds": [
{
"Ref": "ApiId"
}
],
"StageName": "RELEASE"
}
}
}
}