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

Server Load Balancer:SetLoadBalancerHTTPSListenerAttribute

最終更新日:Sep 08, 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

任意

Classic Load Balancer (CLB) インスタンスのリージョン ID。

DescribeRegions 操作を呼び出してリージョン ID を照会できます。

cn-hangzhou

LoadBalancerId

string

必須

Classic Load Balancer (CLB) インスタンスの ID。

lb-sjhfdji****

ListenerPort

integer

必須

Classic Load Balancer (CLB) インスタンスが使用するフロントエンドポート。

有効な値: 1 ~ 65535。

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: クッキーの挿入。

クライアントが初めて Server Load Balancer にアクセスすると、Server Load Balancer は応答に Cookie を挿入します (HTTP/HTTPS 応答に SERVERID を挿入)。次回、クライアントがこの Cookie を含むリクエストを送信すると、Server Load Balancer は以前に記録されたバックエンドサーバーにリクエストを転送します。

  • server: Cookie の書き換え。

Server Load Balancer は、ユーザーがカスタム Cookie を定義していることを検出すると、元の Cookie を書き換えます。次回、クライアントが新しい Cookie を含むリクエストを送信すると、Server Load Balancer は以前に記録されたバックエンドサーバーにリクエストを転送します。

説明

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

挿入

CookieTimeout

integer

任意

Cookie のタイムアウト期間。

有効な値: 1 ~ 86400 (秒)。

説明

このパラメーターは、StickySession が on に設定され、StickySessionType が insert (挿入) に設定されている場合に必須です。

500

Cookie

string

任意

サーバーで設定された Cookie。

値の長さは 1 ~ 200 文字で、ASCII 文字と数字のみを含めることができます。コンマ (,)、セミコロン (;)、またはスペースを含めることはできず、ドル記号 ($) で始めることはできません。

説明

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

testCookie

HealthCheck

string

任意

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

  • on: はい。

  • off: いいえ。

on

HealthCheckMethod

string

任意

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

説明

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

get

HealthCheckDomain

string

任意

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

  • $_ip: バックエンドサーバーの非公開 IP アドレス。$_ip を指定するか、このパラメーターを指定しない場合、Server Load Balancer は各バックエンドサーバーの非公開 IP アドレスをヘルスチェックのドメイン名として使用します。

  • domain: ドメイン名は 1 ~ 80 文字の長さで、文字、数字、ピリオド (.)、およびハイフン (-) のみを含めることができます。

説明

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

172.XX.XX.16

HealthCheckURI

string

任意

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

値の長さは 1 ~ 80 文字で、文字、数字、ハイフン (-)、スラッシュ (/)、ピリオド (.)、パーセント記号 (%)、疑問符 (?)、ナンバー記号 (#)、およびアンパサンド (&) を含めることができます。URI はスラッシュ (/) のみを含めることはできませんが、スラッシュ (/) で始める必要があります。

説明

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

/test/index.html

HealthyThreshold

integer

任意

バックエンドサーバーが正常 (fail から success) と見なされるまでに必要な連続したヘルスチェック成功回数。

有効な値: 2 ~ 10。

説明

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

4

UnhealthyThreshold

integer

任意

バックエンドサーバーが異常 (success から fail) と見なされるまでに必要な連続したヘルスチェック失敗回数。

有効な値: 2 ~ 10。

説明

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

4

HealthCheckTimeout

integer

任意

ヘルスチェックからの応答を待機する時間。バックエンド ECS インスタンスが指定された時間内に応答しない場合、ヘルスチェックは失敗します。単位: 秒。有効な値: 1 ~ 300。

説明

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

3

HealthCheckInterval

integer

任意

2 回の連続するヘルスチェックの間隔。単位: 秒。

有効な値: 1 ~ 50。

説明

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

5

HealthCheckConnectPort

integer

任意

ヘルスチェックに使用されるポート。

有効な値: 1 ~ 65535。

説明

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

8080

HealthCheckHttpCode

string

任意

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

有効な値: http_2xx、http_3xx、http_4xx、および http_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 ヘッダーフィールドを使用してクライアントリクエストの仮想 IP アドレス (VIP) を取得するかどうかを指定します。有効な値:

  • on: はい。

  • off: いいえ。

on

XForwardedFor_SLBID

string

任意

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

  • on: はい。

  • off: いいえ。

on

XForwardedFor_proto

string

任意

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

  • on: はい。

  • off: いいえ。

on

Gzip

string

任意

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

  • on: はい。

  • off: いいえ。

on

AclId

string

任意

リスナーにバインドされているアクセスコントロールリスト (ACL) の ID。

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

acl-a2do9e413e0spzasx****

AclType

string

任意

アクセスの制御のタイプ。有効な値:

  • white: 選択したコントロールポリシーグループ内の IP アドレスまたは CIDR ブロックからのリクエストのみが転送されます。ホワイトリストは、特定の IP アドレスからのみサービスへのアクセスを許可したいシナリオに適用されます。ホワイトリストを有効にすると、いくつかのリスクが生じます。ホワイトリストを有効にすると、ホワイトリスト内の IP アドレスのみが SLB リスナーにアクセスできます。

ホワイトリストが有効になっているが、コントロールポリシーグループに IP アドレスが追加されていない場合、SLB リスナーはすべてのリクエストを転送します。

  • black: 選択したコントロールポリシーグループ内の IP アドレスまたは CIDR ブロックからのすべてのリクエストが拒否されます。ブラックリストは、特定の IP アドレスからのアクセスをブロックしたいシナリオに適用されます。

ブラックリストが有効になっているが、コントロールポリシーグループに IP アドレスが追加されていない場合、SLB リスナーはすべてのリクエストを転送します。

説明

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

white

AclStatus

string

任意

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

  • on: はい。

  • off: いいえ。

off

IdleTimeout

integer

任意

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

指定されたタイムアウト期間中にアクセスリクエストが受信されない場合、Server Load Balancer は現在の接続を一時的に切断し、次のリクエストが到着したときに新しい接続を再確立します。

23

RequestTimeout

integer

任意

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

指定されたタイムアウト期間中にバックエンドサーバーから応答が受信されない場合、Server Load Balancer は待機を停止し、HTTP 504 エラーコードをクライアントに返します。

223

EnableHttp2

string

任意

HTTP 2.0 特徴を有効にするかどうかを指定します。有効な値:

  • on: はい。

  • off: いいえ。

off

TLSCipherPolicy

string

任意

HTTPS で利用可能な TLS プロトコルバージョンとサポートされている暗号化アルゴリズムスイートを含むセキュリティポリシー。

  • tls_cipher_policy_1_0:

    サポートされている TLS バージョン: TLSv1.0、TLSv1.1、および TLSv1.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 バージョン: TLSv1.1 および TLSv1.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 バージョン: TLSv1.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 バージョン: TLSv1.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 バージョン: TLSv1.2 および TLSv1.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_ポリシー_1_2

Description

string

任意

カスタムリスナー名。

名前の長さは 1 ~ 256 文字で、中国語の文字、英字、数字、ハイフン (-)、スラッシュ (/)、ピリオド (.)、およびアンダースコア (_) を含めることができます。

https_80

XForwardedFor_SLBPORT

string

任意

XForwardedFor_SLBPORT ヘッダーフィールドを使用して SLB インスタンスのリスナーポートを取得するかどうかを指定します。有効な値:

  • on: はい。

  • off: いいえ。

off

XForwardedFor_ClientSrcPort

string

任意

XForwardedFor_ClientSrcPort ヘッダーフィールドを使用して SLB インスタンスにアクセスするクライアントのポートを取得するかどうかを指定します。有効な値:

  • 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. XForwardedFor_ClientCertClientVerifyAlias パラメーターが重複しています。
400 IpVersionConflict The ip version of this LoadBalancer and the Acl is conflict. 指定された SLB インスタンスの IP バージョンは、ACL でサポートされている IP タイプと競合しています。
400 InvalidParameter.IdleTimeout The specified IdleTimeout exceeds the limit. 指定された IdleTimeout が無効です。パラメーターの制約を確認し、修正後に再試行してください。
400 InvalidParameter.RequestTimeout The specified RequestTimeout exceeds the limit. 指定された RequestTimeout は無効です。パラメーターの制約を確認して、再試行してください。
400 ListenerForwardNotSupport X-Forward-For is not supported to a ipv6 instance. IPv6 SLB インスタンスは X-Forwarded-For をサポートしていません。
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. 指定されたパラメーターは、共有リソース SLB インスタンスではサポートされていません。
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. HTTP または HTTPS リスナーは、プライマリ/セカンダリサーバーグループをサポートしていません。
400 MissingParam.HealthCheckDomain The HealthCheckDomain is required when HealthCheckHttpVersion is http1.1. HealthCheckDomain パラメーターがありません。
400 InvalidParameter.HealthCheckHttpVersion The param HealthCheckHttpVersion is invalid. 指定された HealthCheckHttpVersion が無効です。パラメーターの制約を確認し、修正後に再試行してください。
400 Duplicated.AclEntry %s. %s
400 CertificateNotExist The specified CertificateId does not exist. 指定された証明書は存在しません。
400 InvalidTLSPolicyId.NotExist The specified TLS cipher policy does not exist. 指定された TLS セキュリティポリシーは存在しません。
400 TLSPolicyConfiguring The specified TLS cipher policy is configuring. 指定された TLSCipherPolicy は変更中です。
400 TLSCipherPolicyVipRelationOverLimit The number of listeners associated with a policy has exceeded. リスナーに関連付けられている TLSCipherPolicy インスタンスの数がクォータ制限に達しました。
400 TooManyCertificates The number of certificates must not be greater than one. 指定できる証明書の数は 1 つまでです。
400 CertificateTypeMismatched The certificate type does not match. 指定された証明書のタイプが一致しません。
400 MissingParam.ServerCertificates Server certificates are required. ServerCertificates パラメーターがありません。
400 CnCertificateNotSupport The cn certificate is not support. 中国国密アルゴリズム (SM) 証明書はサポートされていません。
400 InvalidParam.CertificateBindingType The param CertificateBindingType is invalid. 指定された CertificateBindingType は無効です。パラメーターの制約を確認し、修正してから再試行してください。
400 InvalidParamSize.ServerCertificates The size of param ServerCertificates is invalid. 指定された ServerCertificates の長さは無効です。パラメーターの制約を確認して、再試行してください。
400 TooManyCertificates.ServerCertificates The number of certificates must not be greater than one. 指定できる証明書の数は 1 つまでです。
400 AclListenerOverLimit This acl has reached the limit of binding to listeners. 指定された ACL に関連付けられるリスナーの数がクォータ制限に達しました。
400 QuotaLimitExceeds.AclAttachedToListener The number of Acl bound listeners has reached the quota limit ACL に関連付けられているリスナーの数がクォータ制限に達しました。
400 QuotaLimitExceeds.TotalAclEntry The number of Acl entries has reached the quota limit. ACL エントリの数がクォータ制限に達しました。
400 QuotaLimitExceeds.AclListenerOverLimit This acl has reached the limit of binding to listeners. 指定された ACL に関連付け可能なリスナーの数がクォータ制限に達しました。
400 DryRunOperation Request validation has been passed with DryRun flag set. ドライランリクエストの検証に合格しました。
404 ResourceNotFound.Certificate The specified resource is not found.

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

変更履歴

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