All Products
Search

This Product

    Resource Orchestration Service:ALIYUN::ApiGateway::TrafficControlBinding

    Document Center

    Resource Orchestration Service:ALIYUN::ApiGateway::TrafficControlBinding

    Last Updated:Jun 10, 2026

    Binds a custom throttling policy to 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 APIs.

    Maximum: 100.

    GroupId

    String

    Yes

    Yes

    The API group ID.

    None.

    StageName

    String

    Yes

    Yes

    The environment for the throttling policy binding.

    Valid values:

    • TEST

    • PRE

    • RELEASE

    TrafficControlId

    String

    Yes

    Yes

    The ID of the throttling policy.

    None.

    Return values

    Fn::GetAtt

    None.

    Examples

    YAML format

    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 custom throttling policy is bound.
Resources:
  TrafficControlBinding:
    Type: ALIYUN::ApiGateway::TrafficControlBinding
    Properties:
      TrafficControlId:
        Ref: TrafficControlId
      GroupId:
        Ref: GroupId
      ApiIds:
        - Ref: ApiId
      StageName: RELEASE

    JSON format

    {
  "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 custom throttling policy is bound."
    }
  },
  "Resources": {
    "TrafficControlBinding": {
      "Type": "ALIYUN::ApiGateway::TrafficControlBinding",
      "Properties": {
        "TrafficControlId": {
          "Ref": "TrafficControlId"
        },
        "GroupId": {
          "Ref": "GroupId"
        },
        "ApiIds": [
          {
            "Ref": "ApiId"
          }
        ],
        "StageName": "RELEASE"
      }
    }
  }
}