TCP リスナーの設定情報を照会します。

デバッグ

OpenAPI Explorer を使用して、デバッグ操作を実行し、SDK コード例を生成します。

リクエストパラメータ

パラメータ データ型 必須/省略可能 値の例 説明
Action String 必須 DescribeLoadBalancerTCPListenerAttribute

この操作の名前です。 値:DescribeLoadBalancerTCPListenerAttribute

ListenerPort Integer 省略可能 80

SLB インスタンスに使用されるフロントエンドポートです。 値の範囲:1〜65535

LoadBalancerId String 必須 lb-bp1ygod3yctvg1y7wezms

SLB インスタンスの ID です。

RegionId String 必須 cn-hangzhou

SLB インスタンスが属するリージョンです。

リージョン ID を照会するには、リージョンとゾーン のリストを参照するか、または DescribeRegions API を呼び出します。

レスポンスパラメータ

パラメータ データ型 値の例 説明
ListenerPort Integer 443

SLB インスタンスに使用されるフロントエンドポートです。

BackendServerPort Integer 443

SLB インスタンスに使用されるフロントエンドポートです。

バックエンドサーバーグループが仮想サーバーグループの場合、このパラメーターは表示されません。
帯域幅 Integer -1

リスナーのピーク帯域幅です。

ステータス String stopped

リスナーのステータスです。

有効値:starting | running | configuring | stopping | stopped

SynProxy String enable

SynProxy を有効にするかどうかを示します。 SynProxy は SLB を攻撃から守ります。

このパラメータで SLB によって設定された値を保持することを推奨します。

  • enable:SynProxy を有効にします。
  • disable :SynProxyを無効にします。
Scheduler String wrr

トラフィックを配信するために使用されるアルゴリズムです。

  • wrr (デフォルト):重みの大きいバックエンドサーバーは、重みの小さいバックエンドサーバーよりも多くのリクエストを受け取ります。
  • wlc:重みの大きいサーバーほど多くの接続を受け取ります。 2 つのバックエンドサーバーの重み値が同じ場合は、接続数が少ないバックエンドサーバーがポーリングされる可能性が高くなります。
  • rr:リクエストは均等かつ順番にバックエンドサーバーに配信されます。
PersistenceTimeout Integer 0

セッション維持を有効にするかしないかを選択します。

値が 0 の場合、セッション持続性は無効になります。

HealthCheckType String tcp

TCP リスナーのヘルスチェック方法です。

有効値: tcp | http

HealthCheck String on

ヘルスチェック機能を有効にするかどうかを示します。

有効値: on | off

HealthyThreshold Integer 4

バックエンドサーバーが正常だとみなされるまでのヘルスチェックの連続成功回数です (失敗から成功へ)。

UnhealthyThreshold Integer 4

バックエンドサーバーが異常と宣言されるまでのヘルスチェックの連続失敗回数です (成功から失敗へ)。

HealthCheckConnectPort Integer 8080

ヘルスチェックからのレスポンスを待機する最大時間です (単位:秒)。

HealthCheckInterval Integer 5

連続した 2 回のヘルスチェックの時間間隔です (単位:秒)。

HealthCheckDomain String $ _ip

ヘルスチェックに使用されるドメイン名です。

HealthCheckURI String /test/index.html

ヘルスチェックに使用される URI です。

HealthCheckHttpCode String http_2xx,http_3xx

ヘルスチェックが正常であるかどうかを示す HTTP ステータスコードです。

VServerGroupId String rsp-cige6j5e7p

VServer グループの ID です。

AclId String 12

アクセス制御リストをホワイトリストやブラックリストとして選択します。

AclStatus パラメータの 値 が [on] の場合、このパラメータが必要になります。

AclStatus String off

アクセス制御を有効にするかどうかを示します。

有効値:on | off。 デフォルト値:off

AclType String white

アクセス制御のタイプ:

  • ホワイト :ホワイトリストを示します。 アクセス制御リストの IP アドレスや CIDR ブロックからのリクエストのみが転送されます。 アプリケーションが特定の IP アドレスからのアクセスのみを許可するシナリオに適用されます。

    ホワイトリストを有効にすると、サービスにリスクが発生します。 ホワイトリストの設定後、リスト内の IP アドレスのみがリスナーにアクセスできます。

    リストに IP アドレスを追加せずにホワイトリストを有効にした場合、リクエストは転送されません。

  • black:ブラックリストを示します。 選択したアクセス制御リスト内の IP アドレスまたは CIDR ブロックからのリクエストは転送されません (つまり、それらはブロックされます)。 特定の IP アドレスからのアクセスのみをアプリケーションで拒否するシナリオに利用します。

    リストに IP アドレスを追加せずにブラックリストを有効にすると、すべてのリクエストが転送されます。

AclStatusパラメータの値が onの場合、このパラメータが必要になります。

Description String 説明

リスナーの説明です。

EstablishedTimeout Integer 500

TCP 接続のタイムアウト値です (単位:秒)。

HealthCheckConnectTimeout Integer 100

タイムアウトの値です。

MasterSlaveServerGroupId String rsp-0bfucwuotx

アクティブ/スタンバイサーバーグループの ID です。

RequestId String 365F4154-92F6-4AE4-92F8-7FF34B540710

リクエストの ID です。

リクエストの例


http(s)://[Endpoint]/? Action=DescribeLoadBalancerTCPListenerAttribute
&ListenerPort=80 
&LoadBalancerId=lb-bp1ygod3yctvg1y7wezms 
&<CommonParameters>

レスポンスの例

XML 形式

<DescribeLoadBalancerTCPListenerAttributeResponse> 
  <HealthCheckHttpCode>http_2xx,http_3xx</HealthCheckHttpCode> 
  <PersistenceTimeout>0</PersistenceTimeout> 
  <HealthCheckType>tcp</HealthCheckType> 
  <HealthyThreshold>3</HealthyThreshold> 
  <Scheduler>wrr</Scheduler> 
  <UnhealthyThreshold>3</UnhealthyThreshold> 
  <Bandwidth>-1</Bandwidth> 
  <Description>tcp_80</Description> 
  <AclStatus>off</AclStatus>
  <HealthCheckURI>/</HealthCheckURI>
  <HealthCheck>on</HealthCheck>
  <HealthCheckConnectTimeout>5</HealthCheckConnectTimeout> 
  <ListenerPort>80</ListenerPort> 
  <Status>running</Status> 
  <EstablishedTimeout>900</EstablishedTimeout> 
  <HealthCheckDomain/> 
  <HealthCheckInterval>2</HealthCheckInterval> 
  <RequestId>9A113A8C-BB8F-475E-9533-7819ECA2FFC1</RequestId> 
  <BackendServerPort>80</BackendServerPort> 
</DescribeLoadBalancerTCPListenerAttributeResponse> 

JSON 形式

{
	"HealthCheckHttpCode":"http_2xx,http_3xx",
	"Description":"tcp_80",
	"AclStatus":"off",
	"HealthCheckURI":"/",
	"HealthCheck":"on",
	"HealthCheckConnectTimeout":5,
	"PersistenceTimeout":0,
	"ListenerPort":80,
	"Status":"running",
	"EstablishedTimeout":900,
	"HealthCheckType":"tcp",
	"HealthCheckInterval":2,
	"HealthCheckDomain":"",
	"HealthyThreshold":3,
	"Scheduler":"wrr",
	"RequestId":"9A113A8C-BB8F-475E-9533-7819ECA2FFC1",
	"UnhealthyThreshold":3,
	"BackendServerPort":80,
	"Bandwidth":-1
}

エラーコード

一般的なエラーコードをご参照ください。