DescribeRuleAttribute API を呼び出して、指定した転送ルールの設定を照会できます。
デバッグ
こちらを をクリックして、OpenAPI Explorer でデバッグ操作を実行し、SDK コードの例を自動生成します。
リクエストパラメータ
名前 | データ型 | 必須/省略可能 | 値の例 | 説明 |
---|---|---|---|---|
Action | String | 必須 | DescribeRuleAttribute |
実行する操作です。 有効値:DescribeRuleAttribute |
RegionId | String | 必須 | cn-hangzhou |
SLB インスタンスが属するリージョンの ID です。 リージョン ID を照会するには DescribeRegions API を呼び出します。 |
RuleId | String | 必須 | rule-bp1efemp9suk5 |
転送ルールの ID です。 |
レスポンスパラメータ
名前 | データ型 | 値の例 | 説明 |
---|---|---|---|
RuleName | String | Rule1 |
転送ルール名です。 |
LoadBalancerId | String | lb-bp1ca0zt07t934wxezyxo |
SLB インスタンスの ID です。 |
ListenerPort | String | 90 |
SLBインスタンスに使用されるフロントエンドリスナーのポートです。 |
Domain | String | test.com |
転送ルール名です。 |
Url | String | /cache |
転送ルールパスです。 |
VServerGroupId | String | rsp-cige6j5e7p |
転送ルールに関連付けられた VServer グループの ID です。 |
Cookie | String | wwe |
サーバーに設定された Cookie です。 ASCII 文字と数字のみを含め、1〜200 文字を含むことができます。 コンマ ( , )、セミコロン ( ; )、またはスペースを含めることはできません。また、先頭文字をドル記号 ( $ ) にすることはできません。 このパラメータは、 StickySession が [on] に設定され、StickySessionType が server に設定されている場合のみ要求され有効になります。 |
CookieTimeout | Integer | 12 |
Cookie のタイムアウト時間 有効値:1–86400 (秒) 注 このパラメータは StickySession が [on] に設定され StickySessionType が insert に設定されている場合のみ要求され有効になります。
|
HealthCheck | String | off |
ヘルスチェックを有効にするかどうかを設定します。 有効値:on | off 注 このパラメーターは、 ListenerSync が [off] に設定されている場合に有効になります。 このパラメータが [on] に設定されている場合、リスナー設定が有効になります。
|
HealthCheckConnectPort | Integer | 23 |
ヘルスチェック用のバックエンドサーバーのポートです。 有効値:1–65535 注 このパラメーターは、 HealthCheck が [on] に設定されている場合に有効になります。 デフォルトでは、このパラメータが空で HealthCheck が [on] に設定されている場合、バックエンドリスナー設定が有効になります。
|
HealthCheckDomain | String | www.example.com |
ヘルスチェックに使用されるドメイン名です。 有効値:
注 このパラメーターは、 HealthCheckが[on] に設定されている場合に有効になります。
|
HealthCheckHttpCode | String | http_3xx |
ヘルスチェックが正常であるかどうかを示すHTTP ステータスコードです。 カンマで複数の HTTP ステータスを区切ります。 デフォルト値:http_2xx 有効値:http_2xx | http_3xx | http_4xx | http_5xx 注 このパラメータは HealthCheck が [on] に設定されているときに有効になります。
|
HealthCheckInterval | Integer | 34 |
連続した 2 回のヘルスチェックの周期時間です。 有効値:1–50 (秒) 注 このパラメーターは、 HealthCheckが [on] に設定されている場合に有効になります。
|
HealthCheckTimeout | Integer | 34 |
ヘルスチェックからのレスポンス待機時間 (秒単位) です。 指定した時間内にバックエンド ECS インスタンスが正しくレスポンスしなかった場合、ヘルスチェックは失敗です 有効値:1–300 (秒) 注 このパラメータの値がHealthCheckInterval の値よりも小さい場合、このパラメータは無効で、タイムアウトはHealthCheckIntervalの値です。 このパラメーターは、 HealthCheckが[on]に設定されている場合、バックエンドリスナー設定が優先されます。
|
HealthCheckURI | String | 10.21.22.1 |
ヘルスチェックに使用される URI です。 注 このパラメーターは、 HealthCheck が [on] に設定されている場合に有効になります。
|
HealthyThreshold | Integer | 2 |
バックエンドサーバーが正常と宣言されるまでのヘルスチェックの連続成功数 (失敗から成功)。 有効値:2–10 注 このパラメーターは、 HealthCheck が [on] に設定されている場合に有効になります。
|
ListenerSync | String | off |
転送ルールが、ヘルスチェック、セッション持続性、およびスケジューリングアルゴリズムの設定をリスナーから継承するかどうかを設定します。 有効値:on | off
|
RequestId | String | 9DEC9C28-AB05-4DDF-9A78-6B08EC9CE18C |
リクエストの ID です。 |
Scheduler | String | wrr |
トラフィックを配信するために使用されるアルゴリズムです。 有効値:
注 このパラメーターは、 ListenerSync が [off] に設定されている場合に有効になります。 このパラメータが [on] に設定されたときにリスナー設定が有効になります。
|
StickySession | String | off |
セッション維持の有効化/無効化 有効値:on | off 注 このパラメータが必要かつ有効になるのは、 ListenerSync が [off] に設定されている場合です。 このパラメータが [on] に設定されている場合にリスナー設定が有効になります。
|
StickySessionType | String | 挿入 |
Cookie を処理するために使用する方法です。 有効値:
注 このパラメータは StickySession が [on] に設定されている場合に有効になります。
|
UnhealthyThreshold | Integer | 3 |
バックエンドサーバーが失敗と宣言されるまでのヘルスチェックの連続失敗回数 (成功から失敗)。 有効値:2–10 注 このパラメーターは、 HealthCheck が [on] に設定されている場合に有効になります。
|
例
リクエストの例
http(s)://[Endpoint]/? Action=DescribeRuleAttribute
&RegionId=cn-hangzhou
&RuleId=rule-bp1efemp9suk5
&<CommonParameters>
通常のレスポンスの例
XML
形式
<DescribeRuleAttributeResponse>
<Domain>test.com</Domain>
<VServerGroupId>rsp-bp114nimo4kl9</VServerGroupId>
<LoadBalancerId>lb-bp1ca0zt07t934wxezyxo</LoadBalancerId>
<RuleName>Rule2</RuleName>
<ListenerPort>90</ListenerPort>
<RequestId>DB3C28EE-9A6C-4FFA-8759-4ED8346A675E</RequestId>
<ListenerSync>on</ListenerSync>
</DescribeRuleAttributeResponse>
JSON
形式
{
"DomainName":"test.com",
"RequestId":"DB3C28EE-9A6C-4FFA-8759-4ED8346A675E",
"VServerGroupId":"rsp-bp114nimo4kl9",
"LoadBalancerId":"lb-bp1ca0zt07t934wxezyxo",
"RuleName":"Rule2",
"ListenerSync":"on",
"ListenerPort":90
}