指定されたリスナーに設定されている転送ルールを照会します。
デバッグ
OpenAPI Explorer を使ってデバッグ操作を実行し、SDK コード例を生成します。
リクエストパラメータ
パラメータ | データ型 | 必須/省略可能 | 値の例 | 説明 |
---|---|---|---|---|
Action | String | 必須 | DescribeRules |
この操作の名前です。 値:DescribeRules |
ListenerPort | Integer | 省略可能 | 90 |
SLB インスタンスに使用されるフロントエンドリスナーのポートです。 値の範囲:1〜65535 |
LoadBalancerId | String | 必須 | lb-bp1ca0zt07t934wxezyxo |
SLB インスタンスの ID です。 |
RegionId | String | 必須 | cn-hangzhou |
SLB インスタンスが属するリージョンの ID です。 リージョン ID を照会するには、DescribeRegions を呼び出します。 |
レスポンスパラメータ
パラメータ | データ型 | 値の例 | 説明 |
---|---|---|---|
RequestId | String | 9DEC9C28-AB05-4DDF-9A78-6B08EC9CE18C |
リクエスト ID です。 |
ルール |
転送ルールのリストです。 |
||
└RuleId | String | rule-tybqi6qkp8 |
転送ルールの ID です。 |
└RuleName | String | Rule2 |
説明の長さは 1〜80 文字で、文字、数字、ハイフン ( - )、スラッシュ ( / )、ピリオド ( . )、アンダースコア ( _ ) を使用できます。 注 リスナーでは、各ルールの名前は一意である必要があります。
|
└Domain | String | test.com |
転送ルールに関連付けられている要求ドメイン名です。 |
└Url | String | /cache |
転送ルールに関連付けられているリクエストパスです。 |
└VServerGroupId | String | rsp-6cejjzlld7 |
転送ルールに関連付けられた VServer グループの ID です。 |
└Cookie | String | 23 |
サーバーに設定された Cookie です。 Cookie は 1〜200 文字の文字列でなければならず、ASCII 文字と数字のみを含めることができます。 コンマ ( , )、セミコロン ( ; )、またはスペースを含めることはできません。また、先頭文字をドル記号 ( $ ) にすることはできません。 注 このパラメータは StickySessionが[on] に設定され、StickySessionType が serverに設定されている時のみ有効になります。
|
└CookieTimeout | Integer | 56 |
クッキーの有効期限です。 値の範囲: 1〜86400単位:秒 注 このパラメータは StickySessionが[on]に設定され、 StickySessionType がinsertに設定されている場合のみ有効になります。
|
└HealthCheck | String | off |
ヘルスチェック機能を有効にするかどうかを示します。 有効値:on | off 注 このパラメータは、 ListenerSyncが [off] に設定されている場合のみ有効になります。 リスナーの設定は、このパラメータが[on]に設定されている場合に有効になります。
|
└HealthCheckConnectPort | Integer | 45 |
ヘルスチェックに使用されるバックエンドサーバーのポートです。 値の範囲:1〜65535 注 このパラメーターは、 HealthCheckが[on] に設定されている場合に有効になります。 このパラメータが空のままで、HealthCheckが[on]に設定されている場合、デフォルトで、バックエンドのリスナーの設定が有効になります。
|
└HealthCheckDomain | String | domain |
ヘルスチェックに使用されるドメイン名です。 有効値:
注 このパラメーターは、 HealthCheckが[on] に設定されている場合に有効になります。
|
└HealthCheckHttpCode | String | http_3xx |
ヘルスチェックが正常であるかどうかを示す HTTP ステータスコードです。 コンマ(、)を使用して複数の状況コードを区切ります。 デフォルト値:http_2xx 有効値:http_2xx | http_3xx | http_4xx | http_5xx 注 このパラメーターは、 HealthCheckが[on] の場合に有効になります。
|
└HealthCheckInterval | Integer | 5 |
連続した 2 回のヘルスチェックの時間間隔です。 値の範囲:1 ~ 50 単位:秒 注 このパラメーターは、 HealthCheck が[on] にの場合に有効になります。
|
└HealthCheckTimeout | Integer | 34 |
ヘルスチェックからのレスポンスを待機する時間 (秒単位) です。 指定した時間内にバックエンド ECS インスタンスが正しくレスポンスしなかった場合、ヘルスチェックは失敗したと判断します。 値の範囲:1 ~ 300単位:秒 注 HealthCheckTimeout の値が HealthCheckInterval の値よりも小さい場合、パラメータ HealthCheckTimeout は無効になり、 タイムアウトは HealthCheckInterval の値に設定されます。 このパラメーターは、 HealthCheckが[on] に設定されている場合に有効になります。
|
└HealthCheckURI | String | /example |
ヘルスチェックに使用される URI です。 注 このパラメーターは、 HealthCheckが[on] に設定されている場合に有効になります。
|
└HealthyThreshold | Integer | 5 |
バックエンドサーバーが正常と宣言されるまでの、ヘルスチェックの連続成功回数です ( 失敗から成功)。 値の範囲: 2 ~ 10 注 このパラメーターは、 HealthCheckが[on] に設定されている場合に有効になります。
|
└ListenerSync | String | off |
転送ルールがヘルスチェック、セッション持続性、およびスケジューリングアルゴリズムの設定をリスナーから継承するかどうかを示します。 有効値:on | off
|
└Scheduler | String | wrr |
トラフィックを配信するために使用されるアルゴリズムです。 有効値:
注 このパラメータは ListenerSync が off に設定されている場合に有効になります。 リスナーの設定は、このパラメータが on に設定されている場合に有効になります。
|
└StickySession | String | off |
セッション維持を有効にするかしないかを選択します。 有効値:on | off 注 このパラメーターは、 ListenerSyncがoff に設定されている場合に有効にになります。 リスナーの設定は、このパラメータが[on]に設定されている場合に有効にになります。
|
└StickySessionType | String | insert |
Cookie を処理するために使用される方式です。 有効値:
注 このパラメータは StickySession が [on]に設定されている場合に有効になります。
|
└UnhealthyThreshold | Integer | 2 |
バックエンドサーバーが異常と宣言されるまでの、同じ ECS 上でのヘルスチェックの連続失敗回数です (成功 から 失敗)。 値の範囲: 2 ~ 10 注 このパラメーターは、 HealthCheck が [on] に設定されている場合に有効になります。
|
例
リクエストの例
http(s)://[Endpoint]/? Action=DescribeRules
&ListenerPort=90
&LoadBalancerId=lb-bp1ca0zt07t934wxezyxo
&RegionId=cn-hangzhou
&<CommonParameters>
レスポンスの例
XML
形式
<DescribeRulesResponse>
<RequestId>11D87D83-741B-4F8A-8AAD-FD6867FDE7B2</RequestId>
<Rules>
<Rule>
<Url>/image</Url>
<Domain>example.com</Domain>
<VServerGroupId>rsp-bp16rt0dzbm23</VServerGroupId>
<RuleId>rule-bp16ryrpwbg01</RuleId>
<RuleName>auto_named_rule</RuleName>
<ListenerSync>on</ListenerSync>
</Rule>
<Rule>
<Domain>test.com</Domain>
<VServerGroupId>rsp-bp114nimo4kl9</VServerGroupId>
<RuleId>rule-bp1efemp9suk5</RuleId>
<RuleName>Rule2</RuleName>
<ListenerSync>on</ListenerSync>
</Rule>
<Rule>
<Domain>test.com</Domain>
<VServerGroupId>rsp-bp16rt0dzbm23</VServerGroupId>
<RuleId>rule-bp16ryrpwbg01</RuleId>
<RuleName>Rule3</RuleName>
<ListenerSync>on</ListenerSync>
</Rule>
</Rules>
</DescribeRulesResponse>
JSON
形式
{
"RequestId":"11D87D83-741B-4F8A-8AAD-FD6867FDE7B2",
"Rules": {
"Rule": [
{
"Domain":"example.com",
"Url":"/image",
"RuleId":"rule-bp1supbxos2u3",
"VServerGroupId":"rsp-bp114nimo4kl9",
"RuleName":"auto_named_rule",
"ListenerSync":"on"
},
{
"Domain":"test.com",
"RuleId":"rule-bp1efemp9suk5",
"VServerGroupId":"rsp-bp114nimo4kl9",
"RuleName":"Rule2",
"ListenerSync":"on"
},
{
"Domain":"test2.com",
"RuleId":"rule-bp12jzy0hvio3",
"VServerGroupId":"rsp-bp114nimo4kl9",
"RuleName":"Rule3",
"ListenerSync":"on"
}
]
}
}