すべてのプロダクト
Search

このプロダクト

    Smart Access Gateway:GetQosAttribute

    ドキュメントセンター

    Smart Access Gateway:GetQosAttribute

    最終更新日:Dec 21, 2025

    QoS (Quality of Service) ポリシーの属性を照会します。

    今すぐお試しください

    この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

    テスト

    RAM 認証

    下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

    • アクション：特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。

    • API：アクションを具体的に実行するための API。

    • アクセスレベル：各 API に対して事前定義されているアクセスの種類。有効な値：create、list、get、update、delete。

    • リソースタイプ：アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。

      • リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。

      • リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。

    • 条件キー：サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。

    • 依存アクション：ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

    アクション

    アクセスレベル

    リソースタイプ

    条件キー

    依存アクション

    smartag:GetQosAttribute

    get

    *Qos

    acs:smartag:{#regionId}:{#accountId}:qos/{#QosId}

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    RegionId

    string

    必須

    QoS ポリシーがデプロイされているリージョンの ID。

    DescribeRegions 操作を呼び出して、最新のリージョンリストを照会できます。

    cn-shanghai
    QosId

    string

    必須

    QoS ポリシーの ID。

    qos-1iqifund3gcno5****

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    QosPolicies

    array<object>

    5 次元ルールに基づく QoS ポリシーのリスト。

    object

    EndTime

    integer

    5 次元ルールの有効期間の終了時刻。

    時刻は UTC+08:00 である必要があります。

    2021-07-29T00:00:00+0800
    StartTime

    integer

    5 次元ルールの有効期間の開始時刻。

    2021-06-21T00:00:00+0800
    DestCidr

    string

    宛先 CIDR ブロックの範囲。

    0.0.0.0/0
    DestPortRange

    string

    宛先ポートの範囲。

    有効な値：1～65535 および -1。

    宛先ポート範囲のフォーマット例：

    • 1/200：1～200 のポート範囲。

    • 80/80：ポート 80。

    • -1/-1：すべてのポート。

    -1/-1
    IpProtocol

    string

    5 次元ルールに適用されるプロトコルのタイプ。

    ALL
    Priority

    integer

    5 次元ルールに適用されるトラフィック速度制限ルールの優先度。

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

    1
    QosPolicieDescription

    string

    5 次元ルールの説明。

    test
    SourceCidr

    string

    送信元 CIDR ブロックの範囲。

    0.0.0.0/0
    QosPolicieName

    string

    5 次元ルールの名前。

    test
    SourcePortRange

    string

    送信元ポートの範囲。

    有効な値：1～65535 および -1。

    送信元ポート範囲のフォーマット例：

    • 1/200：1～200 のポート範囲。

    • 80/80：ポート 80。

    • -1/-1：すべてのポート。

    -1/-1
    QosCars

    array<object>

    例外構成を持つ QoS ポリシーに適用されるトラフィック速度制限ルール。

    object

    MaxBandwidthAbs

    integer

    最大帯域幅。単位：Mbit/s。

    2
    QosCarName

    string

    トラフィック速度制限ルールの名前。

    test
    PercentSourceType

    string

    トラフィックがネットワークの合計帯域幅の割合に制限される場合の帯域幅タイプ。

    • CcnBandwidth：クラウド相互接続ネットワーク (CCN) の帯域幅。

    • InternetUpBandwidth：インターネットアップストリーム帯域幅。

    InternetUpBandwidth
    MinBandwidthAbs

    integer

    最小帯域幅。単位：Mbit/s。

    1
    MaxBandwidthPercent

    integer

    トラフィックが制限される最大帯域幅の割合。

    20
    QosCarDescription

    string

    トラフィック速度制限ルールの説明。

    test
    LimitType

    string

    トラフィック速度制限のタイプ。有効な値：

    • Absolute：特定の帯域幅範囲に基づいてトラフィックを制限します。

    • Percent：特定の帯域幅の割合の範囲に基づいてトラフィックを制限します。

    Absolute
    Priority

    integer

    トラフィック速度制限ルールの優先度。

    有効な値は 1～3 です。値が小さいほど、優先度が高くなります。

    1
    MinBandwidthPercent

    integer

    最小帯域幅の割合。

    10
    QosCarId

    string

    トラフィック速度制限ルールの ID。

    qoscar-xir1apa8ayjp56ei****
    RequestId

    string

    リクエスト ID。

    91058E01-1806-45D5-B305-19E4D0A5CE04
    ErrorConfigSmartAGCount

    integer

    例外構成を持つ Smart Access Gateway (SAG) インスタンスの数。

    1
    QosName

    string

    QoS ポリシーの名前。

    test
    QosDescription

    string

    QoS ポリシーの説明。

    test

    例

    成功レスポンス

    JSONJSON

    {
  "QosPolicies": [
    {
      "EndTime": 0,
      "StartTime": 0,
      "DestCidr": "0.0.0.0/0",
      "DestPortRange": "-1/-1",
      "IpProtocol": "ALL",
      "Priority": 1,
      "QosPolicieDescription": "test",
      "SourceCidr": "0.0.0.0/0",
      "QosPolicieName": "test",
      "SourcePortRange": "-1/-1"
    }
  ],
  "QosCars": [
    {
      "MaxBandwidthAbs": 2,
      "QosCarName": "test",
      "PercentSourceType": "InternetUpBandwidth",
      "MinBandwidthAbs": 1,
      "MaxBandwidthPercent": 20,
      "QosCarDescription": "test",
      "LimitType": "Absolute",
      "Priority": 1,
      "MinBandwidthPercent": 10,
      "QosCarId": "qoscar-xir1apa8ayjp56ei****"
    }
  ],
  "RequestId": "91058E01-1806-45D5-B305-19E4D0A5CE04",
  "ErrorConfigSmartAGCount": 1,
  "QosName": "test",
  "QosDescription": "test"
}

    エラーコード

    完全なリストについては、「エラーコード」をご参照ください。

    変更履歴

    完全なリストについては、「変更履歴」をご参照ください。