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

Server Load Balancer:SetLoadBalancerHTTPSListenerAttribute

最終更新日:Apr 16, 2026

HTTPS リスナーを設定します。

操作説明

  • Classic Load Balancer (CLB) インスタンスが作成されていること (「CreateLoadBalancer」をご参照ください)。

  • HTTPS リスナーが作成されていること (「CreateLoadBalancerHTTPSListener」をご参照ください)。

今すぐお試しください

この 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 ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

slb:SetLoadBalancerHTTPSListenerAttribute

update

acl

acs:slb:{#regionId}:{#accountId}:acl/{#aclId}

*certificate

acs:slb:{#regionId}:{#accountId}:certificate/{#certificateId}

*loadbalancer

acs:slb:{#regionId}:{#accountId}:loadbalancer/{#loadbalancerId}

  • slb:tag
  • slb:tag
  • slb:tag
なし

リクエストパラメーター

パラメーター

必須 / 任意

説明

RegionId

string

任意

CLB インスタンスが配置されているリージョン ID。

DescribeRegions 操作を呼び出して、最新のリージョンリストを照会できます。

cn-hangzhou

LoadBalancerId

string

必須

CLB インスタンスの ID。

lb-sjhfdji****

ListenerPort

integer

必須

CLB インスタンスが使用するフロントエンドポート。

有効値:165535

80

Bandwidth

integer

任意

リスナーのピーク帯域幅。単位:Mbit/s。

有効値:

  • -1:ピーク帯域幅は制限されません。

-1

XForwardedFor

string

任意

X-Forwarded-For ヘッダーを使用してクライアントのリアル IP アドレスを取得するかどうかを指定します。有効値:

  • on

  • off

on

Scheduler

string

任意

スケジューリングアルゴリズム。有効値:

  • wrr:加重ラウンドロビン。重みが大きいバックエンドサーバーが、より多くのリクエストを受信します。

  • rr:ラウンドロビン。リクエストはバックエンドサーバーに順番に分散されます。

wrr

StickySession

string

任意

スティッキーセッションを有効にするかどうかを指定します。有効値:

  • on

  • off

on

StickySessionType

string

任意

Cookie を処理するために使用されるメソッド。有効値:

  • insert:ロードバランサーは、クライアントに送信される最初の応答に Cookie (SERVERID) を挿入します。クライアントからの次のリクエストにはこの Cookie が含まれ、ロードバランサーはリクエストを同じバックエンドサーバーにリダイレクトします。

  • server:ロードバランサーはカスタム Cookie を書き換えます。ロードバランサーがユーザー定義の Cookie を検出すると、元の Cookie を新しい Cookie で上書きします。クライアントからの次のリクエストには新しい Cookie が含まれ、ロードバランサーはリクエストを同じバックエンドサーバーにリダイレクトします。

説明

このパラメーターは、StickySessionon に設定されている場合に必須です。

insert

CookieTimeout

integer

任意

Cookie のタイムアウト期間。

有効値:186400。単位:秒。

説明

このパラメーターは、StickySessionon に、StickySessionTypeinsert に設定されている場合に必須です。

500

Cookie

string

任意

バックエンドサーバーに設定されている Cookie。

Cookie 名は 1~200 文字で、ASCII 文字と数字のみ使用できます。コンマ (,)、セミコロン (;)、スペースは使用できません。ドル記号 ($) で始めることはできません。

説明

このパラメーターは、StickySessionon に、StickySessionTypeserver に設定されている場合に必須です。

testCookie

HealthCheck

string

任意

ヘルスチェックを有効にするかどうかを指定します。有効値:

  • on

  • off

on

HealthCheckMethod

string

任意

ヘルスチェックに使用される HTTP メソッド。有効値:head および get

説明

このパラメーターは、HealthCheckon に設定されている場合にのみ有効です。

get

HealthCheckDomain

string

任意

ヘルスチェックに使用されるドメイン名。有効値:

  • $_ip:バックエンドサーバーのプライベート IP アドレス。このパラメーターに IP アドレスを指定するか、このパラメーターを省略した場合、ロードバランサーは各バックエンドサーバーのプライベート IP アドレスをヘルスチェックドメインとして使用します。

  • domain:ドメイン名は 1~80 文字で、文字、数字、ピリオド (.)、ハイフン (-) のみ使用できます。

説明

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

172.XX.XX.16

HealthCheckURI

string

任意

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

URI は、長さが 1~80 文字で、スラッシュ (/) で始まる必要があります。URI には、英字、数字、および次の特殊文字 - / . % ? # & を含めることができます。URI は、スラッシュ (/) のみで構成することはできません。

説明

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

/test/index.html

HealthyThreshold

integer

任意

バックエンドサーバーのヘルスチェックステータスを異常から正常に変更するために必要な、ヘルスチェックの連続成功回数。

値の範囲:210

説明

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

4

UnhealthyThreshold

integer

任意

バックエンドサーバーのヘルスチェックステータスが正常から異常に変わるしきい値となる、連続したヘルスチェック失敗の回数です。

値の範囲:210

説明

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

4

HealthCheckTimeout

integer

任意

ヘルスチェックの応答タイムアウト期間です。 Elastic Compute Service (ECS) インスタンスなどのバックエンドサーバーが、指定されたタイムアウト期間内にヘルスチェックの応答を返さない場合、ヘルスチェックは失敗します。 単位:秒。 有効な値:1300

説明

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

3

HealthCheckInterval

integer

任意

ヘルスチェックの実行間隔。単位:秒。

有効な値:150

説明

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

5

HealthCheckConnectPort

integer

任意

ヘルスチェックに使用するポートです。

有効な値:165535

説明

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

8080

HealthCheckHttpCode

string

任意

ヘルスチェックが成功したことを示す HTTP ステータスコード。複数の HTTP ステータスコードはコンマ (,) で区切ります。

有効な値:http_2xxhttp_3xxhttp_4xxhttp_5xx

説明

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

http_2xx,http_3xx

ServerCertificateId

string

任意

サーバー証明書の ID。

idkp-123-cn-te****

CACertificateId

string

任意

CA 証明書の ID。

  • CA 証明書とサーバー証明書の両方をアップロードした場合、相互認証が使用されます。

  • サーバー証明書のみをアップロードした場合、一方向認証が使用されます。

139a00604ad-cn-east-****

VServerGroup

string

任意

vServer グループを使用するかどうかを指定します。 有効な値:

  • on

  • off

on

VServerGroupId

string

任意

vServer グループの ID。

rsp-cige6j****

XForwardedFor_SLBIP

string

任意

SLB-IP ヘッダーを使用して CLB インスタンスの仮想 IP アドレス (VIP) を取得するかどうかを指定します。有効な値:

  • on

  • off

on

XForwardedFor_SLBID

string

任意

SLB-ID ヘッダーを使用して CLB インスタンスの ID を取得するかどうかを指定します。有効値:

  • on

  • off

on

XForwardedFor_proto

string

任意

X-Forwarded-Proto ヘッダーを使用して CLB インスタンスのリスナープロトコルを取得するかどうかを指定します。有効値:

  • on

  • off

on

Gzip

string

任意

Gzip 圧縮を有効にして特定の種類のファイルを圧縮するかどうかを指定します。有効値:

  • on

  • off

on

AclId

string

任意

リスナーに関連付けられているネットワークアクセスコントロールリスト (ACL) の ID。

このパラメーターは、AclStatuson に設定されている場合に必須です。

acl-a2do9e413e0spzasx****

AclType

string

任意

ネットワーク ACL のタイプ。有効値:

  • white:ホワイトリスト。リスナーは、ネットワーク ACL で指定された IP アドレスまたは CIDR ブロックからのリクエストのみを転送します。ホワイトリストは、特定の IP アドレスからのアプリケーションへのアクセスのみを許可する場合に適しています。ホワイトリストを設定してもネットワーク ACL に IP アドレスを指定しない場合、リスナーはすべてのリクエストを転送します。

  • black:ブラックリスト。リスナーは、ネットワーク ACL で指定された IP アドレスまたは CIDR ブロックからのすべてのリクエストを拒否します。ブラックリストは、特定の IP アドレスからのアクセスを拒否する場合に適しています。ブラックリストを設定してもネットワーク ACL に IP アドレスを指定しない場合、リスナーはすべてのリクエストを転送します。

説明

このパラメーターは、AclStatuson に設定されている場合に必須です。

white

AclStatus

string

任意

アクセス制御を有効にするかどうかを指定します。有効値:

  • on

  • off

off

IdleTimeout

integer

任意

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

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

23

RequestTimeout

integer

任意

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

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

223

EnableHttp2

string

任意

HTTP/2 を有効にするかどうかを指定します。有効値:

  • on

  • off

off

TLSCipherPolicy

string

任意

Transport Layer Security (TLS) セキュリティポリシー。各セキュリティポリシーには、TLS プロトコルバージョンと暗号スイートが含まれています。

  • tls_cipher_policy_1_0

    サポートされる TLS バージョン:TLS 1.0、TLS 1.1、TLS 1.2。

    サポートされる暗号スイート:ECDHE-RSA-AES128-GCM-SHA256、ECDHE-RSA-AES256-GCM-SHA384、ECDHE-RSA-AES128-SHA256、ECDHE-RSA-AES256-SHA384、AES128-GCM-SHA256、AES256-GCM-SHA384、AES128-SHA256、AES256-SHA256、ECDHE-RSA-AES128-SHA、ECDHE-RSA-AES256-SHA、AES128-SHA、AES256-SHA、DES-CBC3-SHA。

  • tls_cipher_policy_1_1

    サポートされる TLS バージョン:TLS 1.1、TLS 1.2。

    サポートされる暗号スイート:ECDHE-RSA-AES128-GCM-SHA256、ECDHE-RSA-AES256-GCM-SHA384、ECDHE-RSA-AES128-SHA256、ECDHE-RSA-AES256-SHA384、AES128-GCM-SHA256、AES256-GCM-SHA384、AES128-SHA256、AES256-SHA256、ECDHE-RSA-AES128-SHA、ECDHE-RSA-AES256-SHA、AES128-SHA、AES256-SHA、DES-CBC3-SHA。

  • tls_cipher_policy_1_2

    サポートされる TLS バージョン:TLS 1.2。

    サポートされる暗号スイート:ECDHE-RSA-AES128-GCM-SHA256、ECDHE-RSA-AES256-GCM-SHA384、ECDHE-RSA-AES128-SHA256、ECDHE-RSA-AES256-SHA384、AES128-GCM-SHA256、AES256-GCM-SHA384、AES128-SHA256、AES256-SHA256、ECDHE-RSA-AES128-SHA、ECDHE-RSA-AES256-SHA、AES128-SHA、AES256-SHA、DES-CBC3-SHA。

  • tls_cipher_policy_1_2_strict

    サポートされる TLS バージョン:TLS 1.2。

    サポートされる暗号スイート:ECDHE-RSA-AES128-GCM-SHA256、ECDHE-RSA-AES256-GCM-SHA384、ECDHE-RSA-AES128-SHA256、ECDHE-RSA-AES256-SHA384、ECDHE-RSA-AES128-SHA、ECDHE-RSA-AES256-SHA。

  • tls_cipher_policy_1_2_strict_with_1_3

    サポートされる TLS バージョン:TLS 1.2、TLS 1.3。

    サポートされる暗号スイート:TLS_AES_128_GCM_SHA256、TLS_AES_256_GCM_SHA384、TLS_CHACHA20_POLY1305_SHA256、TLS_AES_128_CCM_SHA256、TLS_AES_128_CCM_8_SHA256、ECDHE-ECDSA-AES128-GCM-SHA256、ECDHE-ECDSA-AES256-GCM-SHA384、ECDHE-ECDSA-AES128-SHA256、ECDHE-ECDSA-AES256-SHA384、ECDHE-RSA-AES128-GCM-SHA256、ECDHE-RSA-AES256-GCM-SHA384、ECDHE-RSA-AES128-SHA256、ECDHE-RSA-AES256-SHA384、ECDHE-ECDSA-AES128-SHA、ECDHE-ECDSA-AES256-SHA、ECDHE-RSA-AES128-SHA、ECDHE-RSA-AES256-SHA。

tls_cipher_policy_1_2

Description

string

任意

リスナーの名前。

名前は 1~256 文字で、文字、数字、ハイフン (-)、スラッシュ (/)、ピリオド (.)、アンダースコア (_) を使用できます。

https_80

XForwardedFor_SLBPORT

string

任意

X-Forwarded-Port ヘッダーを使用して CLB インスタンスのリスナーポートを取得するかどうかを指定します。有効値:

  • on

  • off

off

XForwardedFor_ClientSrcPort

string

任意

X-Forwarded-Client-SrcPort ヘッダーを使用して CLB インスタンスにアクセスするクライアントの送信元ポートを取得するかどうかを指定します。有効値:

  • on

  • off

off

DryRun

boolean

任意

レスポンスフィールド

フィールド

説明

object

RequestId

string

リクエスト ID。

CEF72CEB-54B6-4AE8-B225-F876FF7BA984

成功レスポンス

JSONJSON

{
  "RequestId": "CEF72CEB-54B6-4AE8-B225-F876FF7BA984"
}

エラーコード

HTTP ステータスコード

エラーコード

エラーメッセージ

説明

400 ParamDuplicateError The specified parameter value of XForwardedFor_ClientCertSubjectDNAlias is duplicate. Please change to a different one.
400 IpVersionConflict The ip version of this LoadBalancer and the Acl is conflict.
400 InvalidParameter.IdleTimeout The specified IdleTimeout exceeds the limit.
400 InvalidParameter.RequestTimeout The specified RequestTimeout exceeds the limit.
400 ListenerForwardNotSupport X-Forward-For is not supported to a ipv6 instance.
400 InvalidParameter.RegionNotSupport The region does not support the parameter: %s.
400 InvalidParameter.SpecNotSupport The loadBalancer of shared spec does not support the parameter: %s.
400 OperationFailed.ServerGroupInUse The VServerGroup or MasterSlaveServerGroup can not be close for this listener.
400 InvalidParameter.VServerGroupId The MasterSlaveServerGroup can not be attached to HTTP or HTTPS listener.
400 MissingParam.HealthCheckDomain The HealthCheckDomain is required when HealthCheckHttpVersion is http1.1.
400 InvalidParameter.HealthCheckHttpVersion The param HealthCheckHttpVersion is invalid.
400 Duplicated.AclEntry %s.
400 CertificateNotExist The specified CertificateId does not exist.
400 InvalidTLSPolicyId.NotExist The specified TLS cipher policy does not exist.
400 TLSPolicyConfiguring The specified TLS cipher policy is configuring.
400 TLSCipherPolicyVipRelationOverLimit The number of listeners associated with a policy has exceeded.
400 TooManyCertificates The number of certificates must not be greater than one.
400 CertificateTypeMismatched The certificate type does not match.
400 MissingParam.ServerCertificates Server certificates are required.
400 CnCertificateNotSupport The cn certificate is not support.
400 InvalidParam.CertificateBindingType The param CertificateBindingType is invalid.
400 InvalidParamSize.ServerCertificates The size of param ServerCertificates is invalid.
400 TooManyCertificates.ServerCertificates The number of certificates must not be greater than one.
400 AclListenerOverLimit This acl has reached the limit of binding to listeners.
400 QuotaLimitExceeds.AclAttachedToListener The number of Acl bound listeners has reached the quota limit
400 QuotaLimitExceeds.TotalAclEntry The number of Acl entries has reached the quota limit.
400 QuotaLimitExceeds.AclListenerOverLimit This acl has reached the limit of binding to listeners.
400 DryRunOperation Request validation has been passed with DryRun flag set.
404 ResourceNotFound.Certificate The specified resource is not found.

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

変更履歴

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