TCP リスナーの設定情報を変更します。
デバッグ
OpenAPI Explorer を使用して、デバッグ操作を実行し、SDK コード例を生成します。
リクエストパラメータ
パラメータ | データ型 | 必須/省略可能 | 値の例 | 説明 |
---|---|---|---|---|
Action | String | 必須 | SetLoadBalancerTCPListenerAttribute |
この操作の名前です。 値: SetLoadBalancerTCPListenerAttribute |
ListenerPort | Integer | 必須 | 80 |
SLB インスタンスに使用されるフロントエンドポートです。 値の範囲:1〜65535 |
LoadBalancerId | String | 必須 | lb-bp1ygod3yctvg1y7wezms |
SLB インスタンスの ID です。 |
RegionId | String | 必須 | cn-hangzhou |
SLB インスタンスが属するリージョンです。 リージョン ID を照会するには、リージョンとゾーンのリスト を参照するか、DescribeRegions API を呼び出します。 |
AclId | String | 省略可能 | 12333 |
任意。 アクセス制御リストをホワイトリストやブラックリストとして選択します。 このパラメータは AclStatus パラメータの値を [on] に 設定している場合に必要です。 |
AclStatus | String | 省略可能 | off |
任意。 アクセス制御を有効にするかどうかを示します。 有効値: on | off |
AclType | String | 省略可能 | white |
任意。 アクセス制御方法です。
AclStatus パラメータの値が [on] の場合、このパラメータが必要になります。 |
帯域幅 | Integer | 省略可能 | 43 |
任意。 リスナーのピーク帯域幅です。 単位:Mbit/s 有効値: -1 | 1〜5120
|
説明 | String | 省略可能 | test |
任意。 TCP リスナーの説明です。 |
EstablishedTimeout | Integer | 省略可能 | 500 |
任意。 TCP 接続のタイムアウト値 (秒)。 値の範囲: 10~900。 単位:秒 |
HealthCheckConnectPort | Integer | 省略可能 | 8080 |
任意。 ヘルスチェックに使用されるポートです。 値の範囲:1 ~ 65535 このパラメータを設定しない場合 、バックエンドサーバのポート (BackendServerPort) が使用されます。 |
HealthCheckConnectTimeout | Integer | 省略可能 | 100 |
任意。 ヘルスチェックからの応答を待機する時間(秒単位)。 指定した時間内にバックエンド ECS インスタンスが正しく応答しなかった場合、ヘルスチェックは失敗したと判断します。 値の範囲: 1 ~ 300。 単位:秒 注 HealthCheckInterval の値が HealthCheckConnectTimeout の値よりも大きい場合、HealthCheckConnectTimeout パラメータは無効であり、タイムアウトは HealthCheckInterval の値に設定さされます。
|
HealthCheckDomain | String | 省略可能 | $ _ip |
任意。 ヘルスチェックに使用されるドメイン名です。 TCPリスナーが HTTP ヘルスチェックを必要とするときに、このパラメータを設定できます。 このパラメータを設定しないと、TCP ヘルスチェックが実行されます。
|
HealthCheckHttpCode | String | 省略可能 | http_2xx、http_3xx |
任意。 ヘルスチェックが正常であるかどうかを示すHTTPステータスコード。 複数の HTTP ステータスコードはコンマ ( , ) で区切ります。 有効値:http_2xx | http_3xx | http_4xx | http_5xx |
HealthCheckInterval | Integer | 省略可能 | 5 |
任意。 連続した 2 回のヘルスチェックの時間間隔です。 値の範囲: 1 ~ 50。 単位:秒 |
HealthCheckType | String | 省略可能。 | tcp |
任意。 ヘルスチェックタイプ 有効値:tcp | http |
HealthCheckURI | String | 省略可能 | /test/index.html |
任意。 ヘルスチェックに使用される URI です。 TCP リスナーが HTTP ヘルスチェックを必要とするときに、このパラメータを設定できます。 このパラメータを設定しないと、TCP ヘルスチェックが実行されます。 |
HealthyThreshold | Integer | 省略可能 | 4 |
任意。 バックエンドサーバーが正常だとみなされるまでの連続したヘルスチェックの回数 ( 失敗 から 成功まで)。 値の範囲: 2 ~ 10 |
MasterSlaveServerGroup | String | 省略可能 | on |
任意。 アクティブ/スタンバイサーバーグループを使用するかどうかを示します。 有効値:on | off VServerGroup の値 とMasterSlaveServerGroup の値を同時に [on] にすることはできません。 |
MasterSlaveServerGroupId | String | 省略可能 | rsp-cige6j5e7p |
任意。 アクティブ/スタンバイサーバーグループの ID です。 注 VServerGroupId または MasterSlaveServerGroupId のいずれかのみから選択します。
|
PersistenceTimeout | Integer | 省略可能 | 0 |
任意。 セッション持続のタイムアウト値です。 値の範囲:0〜3600 。 単位:秒 デフォルト値:0です。セッション持続性が無効であることを示します。 |
Scheduler | String | 省略可能 | wrr |
任意。 トラフィックを配信するために使用されるアルゴリズムです。 有効値:
注 パフォーマンス専有型 SLB インスタンスのみが ENI を追加できます。
|
SynProxy | String | 省略可能 | 有効 |
任意。 SynProxy を有効にするかどうかを示します。 SynProxy は SLB を攻撃から守ります。 このパラメータで SLB によって設定された値の保持を推奨します。 有効値:有効 | 無効 |
UnhealthyThreshold | Integer | 省略可能 | 4 |
任意。 バックエンドサーバーの異常が示されるまでにヘルスチェックが連続して失敗した回数です ( 成功 から 失敗)。 値の範囲: 2 ~ 10 |
VServerGroup | String | 省略可能 | on |
任意。 VServer グループを使用するかどうかを示します。 有効値:on | off VServerGroup の値とMasterSlaveServerGroup の値を同時に [on] にすることはできません。 |
VServerGroupId | String | 省略可能 | rsp-cige6j5e7p |
任意。 VServer グループの ID です。 |
レスポンスパラメータ
Parameter | データ型 | 値の例 | 説明 |
---|---|---|---|
RequestId | String | CEF72CEB-54B6-4AE8-B225-F876FF7BA984 |
リクエストの ID です。 |
例
リクエストの例
http(s)://[Endpoint]/? Action=SetLoadBalancerTCPListenerAttribute
&ListenerPort=80
&LoadBalancerId=lb-bp1ygod3yctvg1y7wezms
&<CommonParameters>
レスポンスの例
XML
形式
<SetLoadBalancerTCPListenerAttributeResponse>
<RequestId>59B41B53-BC4B-481A-9D8D-2A0D20B3FCD1</RequestId>
</SetLoadBalancerTCPListenerAttributeResponse>
JSON
形式
{
"RequestId":"59B41B53-BC4B-481A-9D8D-2A0D20B3FCD1"
}