HTTP リスナーの設定情報を照会します
デバッグ
OpenAPI Explorer を使用して、デバッグ動作を実行し、SDK コード例を生成します。
リクエストパラメータ
パラメータ | データ型 | 必須/省略可能 | 値の例 | 説明 |
---|---|---|---|---|
Action | String | 必須 | DescribeLoadBalancerHTTPListenerAttribute |
この操作の名前です。 値:DescribeLoadBalancerHTTPListenerAttribute |
ListenerPort | Integer | 省略可能 | 80 |
SLB インスタンスに使用されるフロントエンドポートです。 値の範囲:1〜65535 |
LoadBalancerId | String | 必須 | lb-bp1o94dp5i6earr9g6d1l-cn-east-hangzhou-01 |
SLB インスタンスの ID です。 |
RegionId | String | 必須 | cn-hangzhou |
SLB インスタンスが属するリージョンです。 リージョン ID を照会するには、リージョンとゾーンを参照するか、DescribeRegions API を呼び出します。 |
OwnerAccount | String | 省略可能 | testuser@aliyun.com |
任意。 ご自分のアカウントです。 |
レスポンスパラメータ
パラメータ | データ型 | 値の例 | 説明 |
---|---|---|---|
ListenerPort | Integer | 80 |
SLB インスタンスに使用されるフロントエンドポートです。 |
帯域幅 | Integer | -1 |
リスナーのピーク帯域幅です。 |
ステータス | String | stopped |
リスナーのステータスです。 有効値:starting | running | configuring | stopping | stopped |
XForwardedFor | String | on |
訪問者の実際の IP アドレスを取得するために X-Forwarded-For を使用するかどうかを示します。 有効値:on | off |
Scheduler | String | wrr |
トラフィックを配信するために使用されるアルゴリズムです。 有効値:wrr | wlc | rr |
StickySession | String | on |
セッション維持を有効にするかしないかを選択します。 有効値:on | off、 デフォルト値:off |
StickySessionType | String | on |
Cookie を処理するために使用される方式です。 StickySession の値が [on]の場合、このパラメータが必要になります。 有効な値: insert | server |
CookieTimeout | Integer | 500 |
Cookie のタイムアウト時間です。 |
Cookie | String | B490B5EBF6F3CD402E515D22BCDA1598 |
バックエンドサーバー上に設定されている Cookie です。 |
HealthCheck | String | on |
ヘルスチェック機能を有効にするかどうかを示します。 有効値: on | off |
HealthCheckDomain | String | $ _ip |
ヘルスチェックに使用されるドメイン名です。 |
HealthCheckURI | String | /test/index.html |
ヘルスチェックに使用される URI です。 |
HealthyThreshold | Integer | 4 |
バックエンドサーバーの異常が示されるまでにヘルスチェックが連続して成功した回数です。 |
UnhealthyThreshold | Integer | 4 |
バックエンドサーバーの異常が示されるまでにヘルスチェックが連続して失敗した回数です。 |
HealthCheckTimeout | Integer | 3 |
ヘルスチェックからのレスポンスを待機する最大時間 (秒単位) です。 |
HealthCheckInterval | Integer | 5 |
連続した 2 回のヘルスチェックの時間間隔です。 |
HealthCheckHttpCode | String | http_2xx、http_3xx |
ヘルスチェックが正常であるかどうかを示す HTTP ステータスコードです。 |
HealthCheckConnectPort | Integer | 8080 |
ヘルスチェックに使用するポートです。 |
VServerGroupId | String | rsp-cige6j5e7p |
VServer グループに使用する ID です。 |
Gzip | String | on |
Gzip 圧縮を有効にする かどうかを示します。 有効値:on | off |
AclId | String | on |
リスナーと関連づけられたアクセス制御リストの ID です。 AclStatus の 値 が [on]の場合、このパラメータが必要になります。 |
AclStatus | String | off |
アクセス制御を有効にするかどうかを示します。 有効値:on | off、 デフォルト値:off |
AclType | String | white |
アクセス制御のタイプ:
AclStatusの値が[on]の場合、このパラメータが必要になります。 |
BackendServerPort | Integer | 80 |
SLB インスタンスに使用されるフロントエンドポートです。 |
Description | String | test |
HTTP リスナーの説明です。 |
ForwardPort | Integer | 80 |
HTTP から HTTPS へのリダイレクトに使用するポートです。 注 ListenerForwardの値 が offの場合、このパラメータは表示されません。
|
IdleTimeout | Integer | 2 |
接続のアイドルタイムアウトを指定します (秒単位)。 値の範囲:1 to 60、 デフォルト値 :15 指定されたタイムアウト期間中にリクエストが受信されない場合、Server Load Balancer は一時的に接続を終了し、次のリクエストが受信されると接続を再開します。 |
ListenerForward | String | on |
HTTP から HTTPS へのリダイレクトを有効にするかどうかを示します。
|
RequestId | String | 365F4154-92F6-4AE4-92F8-7FF34B540710 |
リクエストの ID です。 |
RequestTimeout | Integer | 34 |
リクエストのタイムアウト期間を指定します (秒単位) 。 値の範囲:1〜180、 値の範囲:60 指定されたタイムアウト期間中にバックエンドサーバーから応答がない場合、Server Load Balancer は待機を停止し、HTTP 504 エラーをクライアントに送信します。 |
ルール |
転送ルールの説明です。 |
||
└Domain | String | www.example.com |
ドメイン名です。 |
└RuleId | String | 1234 |
転送ルールの ID です。 |
└RuleName | String | test |
転送ルールの名前です。 |
└Url | String | /example |
アクセスパス |
└VServerGroupId | String | 123 |
転送ルールの対象 VServer グループの ID です。 |
SecurityStatus | String | on |
セキュリティステータスです。 |
XForwardedFor_SLBID | String | on |
SLB インスタンス ID を取得するために |
XForwardedFor_SLBIP | String | on |
SLB-IP ヘッダフィールドを使用してクライアント要求の実際の IP アドレスを取得するかどうかを示します。 |
XForwardedFor_proto | String | on |
SLB インスタンスで使用されるリスニングプロトコルを取得するために X-Forwarded-Proto ヘッダーフィールドを使用するかどうかを示します。 |
例
リクエストの例
http(s)://[Endpoint]/? Action=DescribeLoadBalancerHTTPListenerAttribute
&ListenerPort=80
&LoadBalancerId=lb-bp1o94dp5i6earr9g6d1l-cn-east-hangzhou-01
&<CommonParameters>
レスポンスの例
XML
形式
<DescribeLoadBalancerHTTPListenerAttributeResponse>
<ForwardPort>443</ForwardPort>
<ListenerPort>80</ListenerPort>
<Status>Enabled</Status>
<RequestId>99439CEF-192C-4B01-A45A-2D5BD5BCDA62</RequestId>
<ListenerForward>on</ListenerForward>
</DescribeLoadBalancerHTTPListenerAttributeResponse>
JSON
形式
{
"Status":"stopped",
"RequestId":"99439CEF-192C-4B01-A45A-2D5BD5BCDA62",
"ForwardPort":443,
"ListenerForward":"on",
"ListenerPort":80
}