HTTPS リスナーの設定を照会します。
操作説明
API 呼び出しレート制限: 1 秒あたり 100 回。
ユーザーあたりのレート制限: 1 秒あたり 10 回。
今すぐお試しください
テスト
RAM 認証
|
アクション |
アクセスレベル |
リソースタイプ |
条件キー |
依存アクション |
|
ens:DescribeLoadBalancerHTTPSListenerAttribute |
get |
*すべてのリソース。
|
なし | なし |
リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| ListenerPort |
integer |
必須 |
クエリするリスナーポート。有効な値: 1 から 65535。 |
443 |
| LoadBalancerId |
string |
必須 |
ロードバランサーインスタンスの ID。 |
lb-5qoxu2rsr0ytanpn4r3i**** |
レスポンスフィールド
|
フィールド |
型 |
説明 |
例 |
|
object |
レスポンスのスキーマ。 |
||
| BackendServerPort |
integer |
ロードバランサーインスタンスのバックエンドサーバーが使用するポート。有効な値: 1 から 65535。 |
8080 |
| Bandwidth |
integer |
ロードバランサーのピーク帯域幅。デフォルト値: -1。-1 は帯域幅が制限されていないことを示します。 |
50 |
| Description |
string |
リスナーの説明。説明の長さは 1 文字から 80 文字である必要があります。 |
abc |
| ForwardPort |
integer |
リスナーの HTTP から HTTPS への転送ポート。 |
0 |
| HealthCheck |
string |
ヘルスチェックを有効にするかどうかを指定します。有効な値:
|
on |
| HealthCheckConnectPort |
integer |
ヘルスチェックに使用されるポート。有効な値: 1 から 65535。このパラメーターが指定されていない場合、バックエンドサーバーポート (BackendServerPort) が使用されます。 説明
このパラメーターは、HealthCheck が on にセットされている場合にのみ効果があります。 |
9902 |
| HealthCheckDomain |
string |
ヘルスチェックに使用されるドメイン名。 説明
このパラメーターは、HealthCheck が on にセットされている場合にのみ効果があります。 |
www.test.com |
| HealthCheckHttpCode |
string |
ヘルスチェックの成功を示す HTTP ステータスコード。有効な値:
説明
このパラメーターは、HealthCheck が on にセットされている場合にのみ効果があります。 |
http_2xx |
| HealthCheckInterval |
integer |
2 回の連続するヘルスチェックの間隔。有効な値: 1 から 50。単位: 秒。 説明
このパラメーターは、HealthCheck が on にセットされている場合にのみ効果があります。 |
5 |
| HealthCheckMethod |
string |
ヘルスチェックに使用される HTTP メソッド。有効な値:
説明
このパラメーターは、HealthCheck が on にセットされている場合にのみ効果があります。 |
head |
| HealthCheckTimeout |
integer |
ヘルスチェックからの応答を受信するためのタイムアウト期間。バックエンド ENS インスタンスが指定されたタイムアウト期間内に応答しない場合、ヘルスチェックは失敗します。
説明
|
5 |
| HealthCheckURI |
string |
ヘルスチェックに使用される URI。URI の長さは 1 文字から 80 文字である必要があります。
|
/checkpreload.htm |
| HealthyThreshold |
integer |
バックエンドサーバーのヘルスチェックステータスを失敗 (到達不能) から成功 (到達可能) に変更するために必須の、連続して成功したヘルスチェックの回数。有効な値: 2 から 10。 説明
このパラメーターは、HealthCheck が on にセットされている場合にのみ効果があります。 |
3 |
| IdleTimeout |
integer |
アイドル接続タイムアウト期間。デフォルト値: 15。有効な値: 1 から 60。単位: 秒。 説明
タイムアウト期間内にアクセスリクエストが受信されない場合、ロードバランサーは一時的に現在の接続を中断し、次のリクエストが到着したときに新しい接続を確立します。 |
15 |
| ListenerForward |
string |
HTTP から HTTPS への転送を有効にするかどうかを指定します。有効な値:
|
off |
| ListenerPort |
integer |
ロードバランサーインスタンスが使用するフロントエンドポート。有効な値: 1 から 65535。 |
8080 |
| RequestId |
string |
リクエスト ID。 |
473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E |
| RequestTimeout |
integer |
リクエストのタイムアウト期間。デフォルト値: 60。有効な値: 1 から 180。単位: 秒。 説明
タイムアウト期間内にバックエンドサーバーから応答が受信されない場合、ロードバランサーは待機を停止し、HTTP 504 エラーコードをクライアントに返します。 |
60 |
| Scheduler |
string |
スケジューリングアルゴリズム。有効な値:
|
wrr |
| ServerCertificateId |
string |
サーバー証明書の ID。 |
60276** |
| Status |
string |
リスナーの現在のステータス。有効な値:
|
Running |
| UnhealthyThreshold |
integer |
バックエンドサーバーのヘルスチェックステータスを成功 (到達可能) から失敗 (到達不能) に変更するために必須の、連続して失敗したヘルスチェックの回数。有効な値: 2 から 10。 説明
このパラメーターは、HealthCheck が on にセットされている場合にのみ効果があります。 |
3 |
例
成功レスポンス
JSONJSON
{
"BackendServerPort": 8080,
"Bandwidth": 50,
"Description": "abc",
"ForwardPort": 0,
"HealthCheck": "on",
"HealthCheckConnectPort": 9902,
"HealthCheckDomain": "www.test.com",
"HealthCheckHttpCode": "http_2xx",
"HealthCheckInterval": 5,
"HealthCheckMethod": "head",
"HealthCheckTimeout": 5,
"HealthCheckURI": "/checkpreload.htm",
"HealthyThreshold": 3,
"IdleTimeout": 15,
"ListenerForward": "off",
"ListenerPort": 8080,
"RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
"RequestTimeout": 60,
"Scheduler": "wrr",
"ServerCertificateId": "60276**",
"Status": "Running",
"UnhealthyThreshold": 3
}
エラーコード
|
HTTP ステータスコード |
エラーコード |
エラーメッセージ |
説明 |
|---|---|---|---|
| 400 | LoadBalancerNotFound | The input parameter loadBalancerId that is not found. | |
| 400 | ens.interface.error | An error occurred while call the API. | |
| 400 | NoPermission | Permission denied. | |
| 400 | InvalidParameter.%s | The specified field %s invalid. Please check it again. |
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。