ListCenInterRegionTrafficQosPolicies - Cloud Enterprise Network - Alibaba Cloud ドキュメントセンター

ListCenInterRegionTrafficQosPolicies 操作を呼び出して、サービス品質 ( QoS ) ポリシーを照会できます。

操作説明

ListCenInterRegionTrafficQosPolicies 操作の呼び出し時には、次の点にご注意ください。

TransitRouterId と TrafficQosPolicyId のいずれかのパラメーターを少なくとも 1 つ指定する必要があります。
TrafficQosPolicyId パラメーターを指定しない場合、操作は、TransitRouterId、TransitRouterAttachmentId、TrafficQosPolicyName、および TrafficQosPolicyDescription パラメーターの値に基づいて QoS ポリシーに関する情報を返します。この場合、ポリシー内のキューに関する情報は返されず、TrafficQosQueues フィールドは応答に含まれません。
[TrafficQosPolicyId] パラメーターを指定した場合、QoS ポリシーとそのキューに関する情報が返されます。応答には [TrafficQosQueues] フィールドが含まれます。 [TrafficQosQueues] フィールドが空の配列である場合、QoS ポリシーにはデフォルトのキューのみが存在します。
有効なパラメーター値を入力してください。無効なパラメーターを入力すると、システムは RequestId を返しますが、 QoS ポリシーに関する情報は返しません。

今すぐお試しください

この 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 ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

cen:ListCenInterRegionTrafficQosPolicies

list

*All Resource

*

なし

リクエストパラメーター

パラメーター	タイプ	必須 / 任意	説明	例
TransitRouterId	string	任意	TransitRouter インスタンスの ID です。	tr-bp1rmwxnk221e3fas****
TransitRouterAttachmentId	string	任意	地域間接続の ID です。	tr-attach-r6g0m3epjehw57****
TrafficQosPolicyId	string	任意	QoS ポリシーの ID です。	qos-rnghap5gc8155x****
TrafficQosPolicyName	string	任意	QoS ポリシーの名前です。名前は空にするか、1 ～ 128 文字の長さにできます。 http:// または https:// で始めることはできません。	nametest
TrafficQosPolicyDescription	string	任意	QoS ポリシーの説明です。説明は空にするか、1 ～ 256 文字の長さにできます。 http:// または https:// で始めることはできません。	desctest
MaxResults	integer	任意	各ページに返すエントリの数です。有効な値: 1 ～ 100 。デフォルト値: 20 。	20
NextToken	string	任意	次の結果ページのトークンです。有効な値: これが最初のクエリであるか、次のページが存在しない場合は、このパラメーターを指定しないでください。次のページが存在する場合、値には前回の呼び出しで返された NextToken 値を設定します。	FFmyTO70tTpLG6I3FmYAXGKPd****

レスポンスパラメーター

パラメーター	タイプ	説明	例
	object	返される応答です。
NextToken	string	ページネーショントークンです。次のリクエストで使用して、新しい結果ページを取得できます。 NextToken が空の場合、次のページはありません。 [NextToken] に値が返された場合、その値は、次のクエリの開始点を決定するトークンです。	FFmyTO70tTpLG6I3FmYAXGKPd****
RequestId	string	リクエスト ID です。	113BFD47-63DF-5D9D-972C-033FB9C360CD
TotalCount	integer	返されたエントリの数です。	1
MaxResults	integer	1 ページあたりに返されるエントリの数です。	20
TrafficQosPolicies	array<object>	QoS ポリシーのリストです。
	object	QoS ポリシーに関する情報です。
TrafficQosPolicyName	string	QoS ポリシーの名前です。	nametest
TrafficQosPolicyStatus	string	QoS ポリシーのステータスです。作成中: ポリシーが作成されています。アクティブ: ポリシーはアクティブです。変更中: ポリシーが変更されています。削除中: ポリシーは削除されています。	Creating
TrafficQosPolicyId	string	QoS ポリシーの ID です。	qos-rnghap5gc8155x****
TrafficQosPolicyDescription	string	QoS ポリシーの説明です。	desctest
BandwidthGuaranteeMode	string	帯域保証タイプです。 byBandwidth: QoS キューは、絶対帯域幅値に基づいて設定されます。 byBandwidthPercent: QoS キューは、帯域幅のパーセンテージに基づいて設定されます。	byBandwidthPercent
TrafficQosQueues	array<object>	キューのリストです。
	object	キューに関する情報です。
QosQueueName	string	キューの名前です。	namtest
RemainBandwidthPercent	integer	キューによって使用される地域間接続帯域幅の割合です。このパラメーターは、帯域保証タイプが byBandwidthPercent の場合に返されます。	1
Bandwidth	string	地域間接続のキューに割り当てられた帯域幅値です。このパラメーターは、帯域保証タイプが byBandwidth の場合に返されます。	1
QosQueueId	string	キューの ID です。	qos-queue-njcrmr9fiu1jii****
QosQueueDescription	string	キューの説明です。	desctest
Dscps	array	キューと一致するトラフィックメッセージの Differentiated Services Code Point ( DSCP ) 値です。
	integer	キューと一致するトラフィックメッセージの DSCP 値です。	5
EffectiveBandwidth	string	キューの実際の帯域幅です。	1.35
TransitRouterId	string	TransitRouter インスタンスの ID です。	tr-2ze4ta4v32umj0rb***
TransitRouterAttachmentId	string	ネットワークインスタンス接続の ID です。	tr-attach-q7ct7c06jpw***

例

成功レスポンス

JSONJSON

{
  "NextToken": "FFmyTO70tTpLG6I3FmYAXGKPd****",
  "RequestId": "113BFD47-63DF-5D9D-972C-033FB9C360CD",
  "TotalCount": 1,
  "MaxResults": 20,
  "TrafficQosPolicies": [
    {
      "TrafficQosPolicyName": "nametest",
      "TrafficQosPolicyStatus": "Creating",
      "TrafficQosPolicyId": "qos-rnghap5gc8155x****",
      "TrafficQosPolicyDescription": "desctest",
      "BandwidthGuaranteeMode": "byBandwidthPercent",
      "TrafficQosQueues": [
        {
          "QosQueueName": "namtest",
          "RemainBandwidthPercent": 1,
          "Bandwidth": "1",
          "QosQueueId": "qos-queue-njcrmr9fiu1jii****",
          "QosQueueDescription": "desctest",
          "Dscps": [
            5
          ],
          "EffectiveBandwidth": "1.35"
        }
      ],
      "TransitRouterId": "tr-2ze4ta4v32umj0rb***",
      "TransitRouterAttachmentId": "tr-attach-q7ct7c06jpw***"
    }
  ]
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ
400	MissingParam.TransitRouterIdOrTrafficQosPolicyId	Either TransitRouterId or TrafficQosPolicyId must be specified.
400	InvalidDescription	Description is invalid.
400	InvalidName	Name is invalid.
400	InvalidParameter	Invalid parameter.
400	Unauthorized	The AccessKeyId is unauthorized.

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

変更履歴

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