HTTPS リスナーの構成を照会します。
操作説明
この操作は、アカウント単位で 1 秒あたり最大 100 回まで呼び出すことができます。
この操作は、ユーザー単位で 1 秒あたり最大 10 回まで呼び出すことができます。
今すぐお試しください
テスト
RAM 認証
|
アクション |
アクセスレベル |
リソースタイプ |
条件キー |
依存アクション |
|
ens:DescribeLoadBalancerHTTPSListenerAttribute |
get |
*All Resource
|
なし | なし |
リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| ListenerPort |
integer |
必須 |
照会対象のリスニングポートです。有効な値: 1 ~ 65535。 |
443 |
| LoadBalancerId |
string |
必須 |
ELB インスタンスの ID です。 |
lb-5qoxu2rsr0ytanpn4r3i**** |
レスポンスフィールド
|
フィールド |
型 |
説明 |
例 |
|
object |
レスポンスのスキーマ |
||
| RequestId |
string |
リクエストの ID です。 |
473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E |
| ListenerPort |
integer |
ELB インスタンスが使用するフロントエンドポートです。有効な値: 1 ~ 65535。 |
8080 |
| Status |
string |
リスナーのステータスです。有効な値:
|
Running |
| Bandwidth |
integer |
Edge Load Balancer (ELB) のピーク帯域幅です。デフォルト値は -1 で、帯域幅に制限がないことを示します。 |
50 |
| Scheduler |
string |
ルーティングアルゴリズムです。有効な値:
|
wrr |
| HealthCheck |
string |
ヘルスチェック機能が有効かどうかを示します。有効な値:
|
on |
| HealthyThreshold |
integer |
不健全かつアクセス不能なバックエンドサーバーを健全かつアクセス可能と判断するために必要な、連続成功ヘルスチェック回数です。有効な値: 2 ~ 10。 説明
このパラメーターは、HealthCheck パラメーターが on に設定されている場合のみ返されます。 |
3 |
| UnhealthyThreshold |
integer |
健全かつアクセス可能なバックエンドサーバーを不健全かつアクセス不能と判断するために必要な、連続失敗ヘルスチェック回数です。有効な値: 2 ~ 10。 説明
このパラメーターは、HealthCheck パラメーターが on に設定されている場合のみ返されます。 |
3 |
| HealthCheckTimeout |
integer |
ヘルスチェック応答のタイムアウト期間です。バックエンドサーバーが指定されたタイムアウト期間内に応答しない場合、ヘルスチェックは失敗と判定されます。
説明
|
5 |
| HealthCheckConnectPort |
integer |
ヘルスチェックに使用されるポートです。有効な値: 1 ~ 65535。このパラメーターの値が空文字列の場合、BackendServerPort で指定されたポートがヘルスチェックに使用されます。 説明
このパラメーターは、HealthCheck パラメーターが on に設定されている場合のみ返されます。 |
9902 |
| HealthCheckInterval |
integer |
ヘルスチェックを実行する間隔です。有効な値: 1 ~ 50。単位:秒。 説明
このパラメーターは、HealthCheck パラメーターが on に設定されている場合のみ返されます。 |
5 |
| Description |
string |
リスナーの説明です。長さは 1 ~ 80 文字である必要があります。 |
abc |
| ListenerForward |
string |
HTTP から HTTPS へのリダイレクトが有効かどうかを示します。有効な値:
|
off |
| ForwardPort |
integer |
HTTP リクエストを HTTPS にリダイレクトするために使用されるリスナーのポートです。 |
0 |
| RequestTimeout |
integer |
リクエストのタイムアウト期間です。デフォルト値:60。有効な値: 1 ~ 180。単位:秒。 説明
指定されたタイムアウト期間内にバックエンドサーバーから応答が得られない場合、ELB はクライアントに対して HTTP 504 エラーコードを返します。 |
60 |
| IdleTimeout |
integer |
アイドル接続のタイムアウト期間です。デフォルト値:15。有効な値: 1 ~ 60。単位:秒。 説明
指定されたタイムアウト期間内にリクエストが受信されない場合、ELB は接続を閉じます。その後、別のリクエストが受信されると、CLB が新しい接続を確立します。 |
15 |
| HealthCheckHttpCode |
string |
ヘルスチェック成功時の HTTP ステータスコードです。有効な値:
説明
このパラメーターは、HealthCheck パラメーターが on に設定されている場合のみ返されます。 |
http_2xx |
| HealthCheckDomain |
string |
ヘルスチェックに使用されるドメイン名です。 説明
このパラメーターは、HealthCheck パラメーターが on に設定されている場合のみ返されます。 |
www.test.com |
| HealthCheckURI |
string |
ヘルスチェックに使用される URI です。長さは 1 ~ 80 文字である必要があります。
|
/checkpreload.htm |
| ServerCertificateId |
string |
サーバー証明書の ID です。 |
60276** |
| HealthCheckMethod |
string |
HTTP ヘルスチェックで使用されるヘルスチェック方法です。有効な値:
説明
このパラメーターは、HealthCheck パラメーターが on に設定されている場合のみ返されます。 |
head |
| BackendServerPort |
integer |
ELB インスタンスのバックエンドサーバーで使用されるポートです。有効な値: 1 ~ 65535。 |
8080 |
例
成功レスポンス
JSONJSON
{
"RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
"ListenerPort": 8080,
"Status": "Running",
"Bandwidth": 50,
"Scheduler": "wrr",
"HealthCheck": "on",
"HealthyThreshold": 3,
"UnhealthyThreshold": 3,
"HealthCheckTimeout": 5,
"HealthCheckConnectPort": 9902,
"HealthCheckInterval": 5,
"Description": "abc",
"ListenerForward": "off",
"ForwardPort": 0,
"RequestTimeout": 60,
"IdleTimeout": 15,
"HealthCheckHttpCode": "http_2xx",
"HealthCheckDomain": "www.test.com",
"HealthCheckURI": "/checkpreload.htm",
"ServerCertificateId": "60276**",
"HealthCheckMethod": "head",
"BackendServerPort": 8080
}
エラーコード
|
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. |
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。