HTTPSリスナーの構成情報を照会します。
リクエストパラメータ
名前 | データ型 | 必須 | Description |
---|---|---|---|
Action | String | はい | 実行する操作。 有効値:
DescribeLoadBalancerHTTPSListenerAttribute |
RegionId | String | はい | Server Load Balancerインスタンスの存在するリージョン。
DescribeRegionsAPIを呼び出してリージョンIDを取得できます。 |
LoadBalancerId | String | はい | Sever Load BalancerインスタンスのID。 |
ListenerPort | Integer | はい | Server Load Balancerインスタンスフロントエンドに使用されるポート。
有効値:1-65535 |
リターンパラメータ
名前 | データ型 | 説明 |
---|---|---|
RequestId | String | リクエストのID。 |
ListenerPort | Integer | 着信トラフィックを受信し、トラフィックをバックエンドサーバーに配信するために使用されるリスナーのフロントエンドポート。 |
BackendServerPort | Integer | リクエストを受け取るためにバックエンドサーバーで開かれたポート。 |
Bandwidth | Integer | リスナーのピーク帯域幅。 |
Status | String | リスナーのステータス。 有効値:
starting | running | configuring | stopping | |
XForwardedFor | String | XForwardedForヘッダーを使用してクライアントの物理IDアドレスを取得します/しない。 |
XForwardedFor_SLBIP | String | XForwardedFor_SLBIPヘッダーを使用してクライアントリクエストの物理IDアドレスを取得します/しない。 |
XForwardedFor_SLBID | String | XForwardedFor_SLBIDヘッダーを使用してSLBインスタンスのIDを取得します/しない。 |
XForwardedFor_proto | String | XForwardedFor_protoヘッダーを使用してリスナーに使用さえるプロトコルを取得します/しない。 |
Scheduler | String | トラフィックを配信するために使用されるアルゴリズム。 |
StickySession | String | セッション維持を有効にする/しない。 |
StickySessionType | String | Cookieを処理するために使用される方式。 |
CookieTimeout | Integer | Cookieのタイムアウト期間。 |
Cookie | String | バックエンドサーバー上で構成されたCookie。 |
AclStatus | String | アクセス制御を有効にする/しない。
有効値:on | off (デフォルト) |
AclType | String | アクセス制御機能を有効にして、アクセス制御方式を選択してください:
このパラメータは、 AclStatus パラエータの値をonに設定している場合に必要です。 |
AclId | String | アクセス制御リストをホワイトリストやブラックリストとして選択します。
このパラメータは、AclStatus パラメータの値をon に設定している場合に必要です。 |
HealthCheck | String | ヘルスチェックを有効にする/しない。 |
HealthCheckDomain | String | ヘルスチェックに使用されるドメイン名。 |
HealthCheckURI | String | ヘルスチェックに使用されるURI。 |
HealthyThreshold | Integer | ヘルスチェックの連続成功の回数。 |
UnhealthyThreshold | Integer | ヘルスチェックの連続失敗の回数。 |
HealthCheckTimeout | Integer | ヘルスチェックからの応答を待機する最大時間(秒単位)。 |
HealthCheckInterval | Integer | 連続2回のヘルスチェックの時間間隔。 |
HealthCheckHttpCode | String | ヘルスチェックが正常であるかどうかを示すHTTPステータスコード。 |
HealthCheckConnectPort | Integer | ヘルスチェックに使用されるポート。 |
VServerGroupId | String | VServerグループのID。 |
ServerCertificateId | String | サーバー証明書のID。 |
CACertificateId | String | CA証明書のID。 |
Gzip | String | Gzip圧縮を有効にする/しない。 |
RuleList | List | 転送ルールのリスト 詳細は次を参照してくださいRuleList。 |
DomainExtensionList | List | ドメイン名拡張子のリスト。 詳細については、次を参照してください |
TLSCipherPolicy | String |
パフォーマンス専有型のみにTLSCipherPolicyパラメータを指定することができます。 各セキュリティポリシーには、HTTPSおよび対応する暗号スイートにより選択可能なTLSプロトコルバージョンが含まれています。 現時点で対応されている4つのセキュリティポリシーは次の通りです。 詳細は次を参照してください#section_ppb_3nw_32b。 実際の状況に合わせてポリシーを選択します。
|
RuleList
名前 | データ型 | 説明 |
---|---|---|
RuleId | String | 転送ルールのID。 |
RuleName | String | 転送ルールの名前。 |
Domain | String | ドメイン名。 |
Url | String | URL |
VServerGroupId | String | 転送ルールの対象VServerグループのID。 |
例
リクエストの例
https://slb.aliyuncs.com/?Action=DescribeLoadBalancerHTTPSListenerAttribute
&LoadBalancerId=lb-t4nj5vuz8ish9emfk1f20
&ListenerPort=443
&CommonParameters
戻り値の例
- XML形式
<? xml version="1.0" encoding="UTF-8"? > <DescribeLoadBalancerHTTPSListenerAttributeResponse> <RequestId>11F52428-64ED-40F7-98C2-DBB6D0BB0AD7</RequestId> <HealthCheckHttpCode>http_2xx,http_3xx</HealthCheckHttpCode> <HealthCheckTimeout>5</HealthCheckTimeout> <ServerCertificateId>1231579085529****_15dbf6ff26f_1991415478_2054196746</ServerCertificateId> <XForwardedFor_SLBID>off</XForwardedFor_SLBID> <Gzip>on</Gzip> <HealthyThreshold>3</HealthyThreshold> <Scheduler>wrr</Scheduler> <StickySession>off</StickySession> <UnhealthyThreshold>3</UnhealthyThreshold> <XForwardedFor_SLBIP>off</XForwardedFor_SLBIP> <XForwardedFor_proto>off</XForwardedFor_proto> <Bandwidth>-1</Bandwidth> <HealthCheckURI>/</HealthCheckURI> <VServerGroupId>rsp-0xiju72xwnr93</VServerGroupId> <HealthCheck>on</HealthCheck> <ListenerPort>443</ListenerPort> <Status>running</Status> <XForwardedFor>on</XForwardedFor> <HealthCheckDomain></HealthCheckDomain> <HealthCheckInterval>2</HealthCheckInterval> <BackendServerPort>443</BackendServerPort> </DescribeLoadBalancerHTTPSListenerAttributeResponse>
- JSON形式
{ "RequestId":"11F52428-64ED-40F7-98C2-DBB6D0BB0AD7", "HealthCheckHttpCode":"http_2xx,http_3xx", "HealthCheckTimeout":5, "ServerCertificateId":"123157908552****_15dbf6ff26f_1991415478_2054196746", "XForwardedFor_SLBID":"off", "Gzip":"on", "HealthyThreshold":3, "Scheduler":"wrr", "StickySession":"off", "UnhealthyThreshold":3, "XForwardedFor_SLBIP":"off", "XForwardedFor_proto":"off", "Bandwidth":-1, "HealthCheckURI":"/", "VServerGroupId":"rsp-0xiju72xwnr93", "HealthCheck":"on", "ListenerPort":443, "Status":"running", "XForwardedFor":"on", "HealthCheckDomain":"", "HealthCheckInterval":2, "BackendServerPort":443 }