すべてのプロダクト
Search

このプロダクト

    Resource Orchestration Service:ALIYUN::ApiGateway::TrafficControlBinding

    ドキュメントセンター

    Resource Orchestration Service:ALIYUN::ApiGateway::TrafficControlBinding

    最終更新日:Jan 16, 2025

    ALIYUN::ApiGateway::TrafficControlBinding は、API にカスタムスロットリングポリシーをバインドするために使用されます。

    構文

    {
  "Type": "ALIYUN::ApiGateway::TrafficControlBinding",
  "Properties": {
    "ApiIds": List,
    "TrafficControlId": String,
    "StageName": String,
    "GroupId": String
  }
}

    プロパティ

    プロパティ

    タイプ

    必須

    編集可能

    説明

    制約

    ApiIds

    List

    はい

    はい

    API の ID。

    最大 100 個の API ID を指定できます。

    GroupId

    String

    はい

    はい

    API が属する API グループの ID。

    なし。

    StageName

    String

    はい

    はい

    API にカスタムスロットリングポリシーをバインドする環境。

    有効な値:

    • TEST

    • PRE

    • RELEASE

    TrafficControlId

    String

    はい

    はい

    スロットリングポリシーの ID。

    なし。

    戻り値

    Fn::GetAtt

    なし。

    例

    YAML 形式

    ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  TrafficControlId:
    Type: String
    Description: スロットリングポリシーの ID。
  GroupId:
    Type: String
    Description: API グループの ID。
  ApiId:
    Type: String
    Description: カスタムスロットリングポリシーがバインドされる API の ID。
Resources:
  TrafficControlBinding:
    Type: ALIYUN::ApiGateway::TrafficControlBinding
    Properties:
      TrafficControlId:
        Ref: TrafficControlId
      GroupId:
        Ref: GroupId
      ApiIds:
        - Ref: ApiId
      StageName: RELEASE

    JSON 形式

    {
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "TrafficControlId": {
      "Type": "String",
      "Description": "スロットリングポリシーの ID。"  // the ID of the throttling policy.
    },
    "GroupId": {
      "Type": "String",
      "Description": "API グループの ID。" // the ID of the API group.
    },
    "ApiId": {
      "Type": "String",
      "Description": "カスタムスロットリングポリシーがバインドされる API の ID。" // 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"
      }
    }
  }
}