すべてのプロダクト
Search
ドキュメントセンター

Resource Orchestration Service:ALIYUN::SAG::QosPolicy

最終更新日:Jan 16, 2025

ALIYUN::SAG::QosPolicy は、サービス品質 (QoS) ポリシーのトラフィック分類ルールを作成するために使用されます。

構文

{
  "Type": "ALIYUN::SAG::QosPolicy",
  "Properties": {
    "Description": String,
    "EndTime": String,
    "SourcePortRange": String,
    "SourceCidr": String,
    "Priority": Integer,
    "StartTime": String,
    "DestPortRange": String,
    "DpiGroupIds": List,
    "Name": String,
    "DestCidr": String,
    "DpiSignatureIds": List,
    "QosId": String,
    "IpProtocol": String
  }
}

プロパティ

プロパティ

タイプ

必須

編集可能

説明

制約

Description

String

いいえ

はい

トラフィック分類ルールの説明。

説明は 1 ~ 512 文字で、文字、数字、アンダースコア (_)、およびハイフン (-) を使用できます。説明は文字で始める必要があります。

EndTime

String

いいえ

はい

トラフィック分類ルールが無効になる時刻。

ISO 8601 標準の YYYY-MM-DDThh:mm:ss+0800 形式で時刻を指定します。時刻は UTC+8 でなければなりません。

SourcePortRange

String

はい

はい

送信元ポートの範囲。

有効な値: -1、および 1 ~ 65535。

例:

  • 1/200: ポート 1 ~ ポート 200

  • 80/80: ポート 80

  • -1/-1: すべてのポート

SourceCidr

String

はい

はい

送信元 CIDR ブロック。

例: 192.168.1.0/24。

Priority

Integer

はい

はい

トラフィック分類ルールが属するトラフィック調整ルールの優先度。

有効な値: 1 ~ 3。

値が小さいほど、優先度が高くなります。

StartTime

String

いいえ

はい

トラフィック分類ルールが有効になる開始時刻。

ISO 8601 標準の YYYY-MM-DDThh:mm:ss+0800 形式で時刻を指定します。時刻は UTC+8 でなければなりません。

DestPortRange

String

はい

はい

宛先ポートの範囲。

有効な値: -1、および 1 ~ 65535。

例:

  • 1/200: ポート 1 ~ ポート 200

  • 80/80: ポート 80

  • -1/-1: すべてのポート

DpiGroupIds

List

いいえ

はい

アプリケーショングループの ID。

有効な値: 1 ~ 100。

ListDpiGroups オペレーションを呼び出して、アプリケーショングループの ID をクエリできます。

Name

String

いいえ

はい

トラフィック分類ルールの名前。

名前は 2 ~ 100 文字で、文字、数字、ハイフン (-)、およびアンダースコア (_) を使用できます。名前は文字で始める必要があります。

DestCidr

String

はい

はい

宛先 CIDR ブロック。

このプロパティには CIDR ブロックを指定します。例: 192.168.1.0/24。

DpiSignatureIds

List

いいえ

はい

アプリケーションの ID。

有効な値: 1 ~ 100。

ListDpiSignatures オペレーションを呼び出して、アプリケーション ID をクエリできます。

QosId

String

はい

いいえ

QoS ポリシーの ID。

なし。

IpProtocol

String

はい

はい

トラフィック分類ルールに適用されるプロトコルのタイプ。

SAG コンソールで提供されているプロトコルタイプに基づいて、このプロパティを指定できます。

戻り値

Fn::GetAtt

QosPolicyId: トラフィック分類ルールの ID。

JSON 形式

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "EndTime": {
      "Type": "String",
      "Description": "トラフィック分類ルールが無効になる時刻。\nISO 8601 標準の YYYY-MM-DDThh:mm:ss+0800 形式で時刻を指定します。\n時刻は UTC+8 でなければなりません。", // 翻訳済
      "Default": "2019-09-14T16:41:33+0800"
    },
    "SourcePortRange": {
      "Type": "String",
      "Description": "送信元ポートの範囲。\n有効な値: 1 ~ 65535 および -1。\nこのパラメータを次のいずれかの形式で設定します。\n1/200: 1 ~ 200 のポート範囲\n80/80: ポート 80\n-1/-1: すべてのポート", // 翻訳済
      "Default": "80/80"
    },
    "SourceCidr": {
      "Type": "String",
      "Description": "送信元 IP アドレスの範囲。\nCIDR 表記でこのパラメータの値を指定します。例: 192.168.1.0/24。", // 翻訳済
      "Default": "10.10.10.0/24"
    },
    "Priority": {
      "Type": "Number",
      "Description": "トラフィック分類ルールが属するトラフィック調整ポリシーの優先度。", // 翻訳済
      "Default": 3
    },
    "StartTime": {
      "Type": "String",
      "Description": "トラフィック分類ルールが有効になる時刻。\nISO 8601 標準の YYYY-MM-DDThh:mm:ss+0800 形式で時刻を指定します。\n時刻は UTC+8 でなければなりません。", // 翻訳済
      "Default": "2019-07-14T16:41:33+0800"
    },
    "DestPortRange": {
      "Type": "String",
      "Description": "宛先ポートの範囲。\n有効な値: 1 ~ 65535 および -1。\nこのパラメータを次のいずれかの形式で設定します。\n1/200: 1 ~ 200 のポート範囲\n80/80: ポート 80\n-1/-1: すべてのポート", // 翻訳済
      "Default": "80/80"
    },
    "DpiGroupIds": {
      "Type": "Json",
      "Description": "アプリケーショングループの ID。\n一度に最大 100 個のアプリケーショングループ ID を入力できます。\nListDpiGroups オペレーションを呼び出して、アプリケーショングループ ID とアプリケーションに関する情報をクエリできます。", // 翻訳済
      "MaxLength": 100,
      "Default": ["20"]
    },
    "Name": {
      "Type": "String",
      "Description": "トラフィック分類ルールの名前。\n名前は 2 ~ 100 文字で、数字、アンダースコア (_)、およびハイフン (-) を使用できます。文字で始める必要があります。", // 翻訳済
      "Default": "test"
    },
    "DestCidr": {
      "Type": "String",
      "Description": "宛先 IP アドレスの範囲。\nCIDR 表記でこのパラメータの値を指定します。例: 192.168.10.0/24。", // 翻訳済
      "Default": "10.10.20.0/24"
    },
    "DpiSignatureIds": {
      "Type": "Json",
      "Description": "アプリケーションの ID。\n一度に最大 100 個のアプリケーション ID を入力できます。\nListDpiSignatures オペレーションを呼び出して、アプリケーション ID とアプリケーションに関する情報をクエリできます。", // 翻訳済
      "MaxLength": 100,
      "Default": ["1"]
    },
    "QosId": {
      "Type": "String",
      "Description": "QoS ポリシーの ID。", // 翻訳済
      "Default": "qos-xitd8690ucu8ro****"
    },
    "IpProtocol": {
      "Type": "String",
      "Description": "トラフィック分類ルールに適用されるプロトコルのタイプ。\nこのトピックで提供されているサポートされているプロトコルは参照用です。コンソールの実際\nのプロトコルが優先されます。", // 翻訳済
      "Default": "TCP"
    }
  },
  "Resources": {
    "QosPolicy": {
      "Type": "ALIYUN::SAG::QosPolicy",
      "Properties": {
        "EndTime": {
          "Ref": "EndTime"
        },
        "SourcePortRange": {
          "Ref": "SourcePortRange"
        },
        "SourceCidr": {
          "Ref": "SourceCidr"
        },
        "Priority": {
          "Ref": "Priority"
        },
        "StartTime": {
          "Ref": "StartTime"
        },
        "DestPortRange": {
          "Ref": "DestPortRange"
        },
        "DpiGroupIds": {
          "Ref": "DpiGroupIds"
        },
        "Name": {
          "Ref": "Name"
        },
        "DestCidr": {
          "Ref": "DestCidr"
        },
        "DpiSignatureIds": {
          "Ref": "DpiSignatureIds"
        },
        "QosId": {
          "Ref": "QosId"
        },
        "IpProtocol": {
          "Ref": "IpProtocol"
        }
      }
    }
  },
  "Outputs": {
    "QosPolicyId": {
      "Description": "トラフィック分類ルールの ID。", // 翻訳済
      "Value": {
        "Fn::GetAtt": [
          "QosPolicy",
          "QosPolicyId"
        ]
      }
    }
  }
}