すべてのプロダクト
Search
ドキュメントセンター

ENS:DescribeLoadBalancerHTTPSListenerAttribute

最終更新日:Mar 20, 2026

HTTPS リスナーの構成を照会します。

操作説明

  • この操作は、アカウント単位で 1 秒あたり最大 100 回まで呼び出すことができます。

  • この操作は、ユーザー単位で 1 秒あたり最大 10 回まで呼び出すことができます。

今すぐお試しください

この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

テスト

RAM 認証

下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

  • アクション:特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。

  • API:アクションを具体的に実行するための API。

  • アクセスレベル:各 API に対して事前定義されているアクセスの種類。有効な値:create、list、get、update、delete。

  • リソースタイプ:アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。

    • リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。

    • リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。

  • 条件キー:サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。

  • 依存アクション:ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

ens:DescribeLoadBalancerHTTPSListenerAttribute

get

*All Resource

*

なし なし

リクエストパラメーター

パラメーター

必須 / 任意

説明

ListenerPort

integer

必須

照会対象のリスニングポートです。有効な値: 165535

443

LoadBalancerId

string

必須

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

lb-5qoxu2rsr0ytanpn4r3i****

レスポンスフィールド

フィールド

説明

object

レスポンスのスキーマ

RequestId

string

リクエストの ID です。

473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E

ListenerPort

integer

ELB インスタンスが使用するフロントエンドポートです。有効な値: 165535

8080

Status

string

リスナーのステータスです。有効な値:

  • Running

  • Stopped

  • Starting

  • Configuring

  • Stopping

Running

Bandwidth

integer

Edge Load Balancer (ELB) のピーク帯域幅です。デフォルト値は -1 で、帯域幅に制限がないことを示します。

50

Scheduler

string

ルーティングアルゴリズムです。有効な値:

  • wrr:重みの高いバックエンドサーバーほど、より多くのリクエストを受信します。

  • wlc:各バックエンドサーバーの重みと負荷(接続数)に基づいてリクエストを分散します。重みが同じ場合、接続数が少ないバックエンドサーバーほど、より多くのリクエストを受信します。

  • rr:バックエンドサーバーに順次リクエストを分散します。

  • sch:送信元 IP アドレスに基づく一貫したハッシュ。同一の送信元 IP アドレスからのリクエストは、同一のバックエンドサーバーに分散されます。

  • qch:QUIC 接続 ID に基づく一貫したハッシュ。同一の QUIC 接続 ID を含むリクエストは、同一のバックエンドサーバーに分散されます。

  • iqch:iQUIC CID の特定の 3 バイト(2~4 バイト目)に基づく一貫したハッシュ。2~4 バイト目が同一のリクエストは、同一のバックエンドサーバーに分散されます。

wrr

HealthCheck

string

ヘルスチェック機能が有効かどうかを示します。有効な値:

  • on

  • off

on

HealthyThreshold

integer

不健全かつアクセス不能なバックエンドサーバーを健全かつアクセス可能と判断するために必要な、連続成功ヘルスチェック回数です。有効な値: 210

説明

このパラメーターは、HealthCheck パラメーターが on に設定されている場合のみ返されます。

3

UnhealthyThreshold

integer

健全かつアクセス可能なバックエンドサーバーを不健全かつアクセス不能と判断するために必要な、連続失敗ヘルスチェック回数です。有効な値: 210

説明

このパラメーターは、HealthCheck パラメーターが on に設定されている場合のみ返されます。

3

HealthCheckTimeout

integer

ヘルスチェック応答のタイムアウト期間です。バックエンドサーバーが指定されたタイムアウト期間内に応答しない場合、ヘルスチェックは失敗と判定されます。

  • デフォルト値:5。

  • 有効な値: 1300

  • 単位:秒。

説明
  • このパラメーターは、HealthCheck パラメーターが on に設定されている場合にのみ有効です。

  • HealthCheckTimeout の値が HealthCheckInterval の値より小さい場合、HealthCheckTimeout で指定されたタイムアウト期間は無効となり、HealthCheckInterval の値がタイムアウト期間として使用されます。

5

HealthCheckConnectPort

integer

ヘルスチェックに使用されるポートです。有効な値: 165535。このパラメーターの値が空文字列の場合、BackendServerPort で指定されたポートがヘルスチェックに使用されます。

説明

このパラメーターは、HealthCheck パラメーターが on に設定されている場合のみ返されます。

9902

HealthCheckInterval

integer

ヘルスチェックを実行する間隔です。有効な値: 150。単位:秒。

説明

このパラメーターは、HealthCheck パラメーターが on に設定されている場合のみ返されます。

5

Description

string

リスナーの説明です。長さは 180 文字である必要があります。

abc

ListenerForward

string

HTTP から HTTPS へのリダイレクトが有効かどうかを示します。有効な値:

  • on

  • off

off

ForwardPort

integer

HTTP リクエストを HTTPS にリダイレクトするために使用されるリスナーのポートです。

0

RequestTimeout

integer

リクエストのタイムアウト期間です。デフォルト値:60。有効な値: 1180。単位:秒。

説明

指定されたタイムアウト期間内にバックエンドサーバーから応答が得られない場合、ELB はクライアントに対して HTTP 504 エラーコードを返します。

60

IdleTimeout

integer

アイドル接続のタイムアウト期間です。デフォルト値:15。有効な値: 160。単位:秒。

説明

指定されたタイムアウト期間内にリクエストが受信されない場合、ELB は接続を閉じます。その後、別のリクエストが受信されると、CLB が新しい接続を確立します。

15

HealthCheckHttpCode

string

ヘルスチェック成功時の HTTP ステータスコードです。有効な値:

  • http_2xx(デフォルト)

  • http_3xx

  • http_4xx

  • http_5xx

説明

このパラメーターは、HealthCheck パラメーターが on に設定されている場合のみ返されます。

http_2xx

HealthCheckDomain

string

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

説明

このパラメーターは、HealthCheck パラメーターが on に設定されている場合のみ返されます。

www.test.com

HealthCheckURI

string

ヘルスチェックに使用される URI です。長さは 180 文字である必要があります。

  • URL は / で始まり、/ 以外の文字を含む必要があります。

  • このパラメーターは、HealthCheck パラメーターが on に設定されている場合のみ返されます。

/checkpreload.htm

ServerCertificateId

string

サーバー証明書の ID です。

60276**

HealthCheckMethod

string

HTTP ヘルスチェックで使用されるヘルスチェック方法です。有効な値:

  • head:ページのヘッダーを要求します。

  • get:ページの指定部分を要求し、エンティティ本文を返します。

説明

このパラメーターは、HealthCheck パラメーターが on に設定されている場合のみ返されます。

head

BackendServerPort

integer

ELB インスタンスのバックエンドサーバーで使用されるポートです。有効な値: 165535

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.

完全なリストについては、「エラーコード」をご参照ください。

変更履歴

完全なリストについては、「変更履歴」をご参照ください。