UpdateListenerAttribute を使用してリスナー属性を更新 - SLB - Alibaba Cloud - Server Load Balancer

リスナーの名前やデフォルト操作などの構成を更新します。

操作説明

UpdateListenerAttribute は非同期操作です。リクエスト ID が返された後、リスナー構成の更新はバックグラウンドで引き続き処理されます。 GetListenerAttribute を呼び出して、リスナー構成の更新ステータスをクエリできます。

リスナーが Configuring 状態の場合、リスナー構成は更新中です。
リスナーが Running 状態の場合、リスナー構成の更新は完了しています。

今すぐお試しください

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

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

alb:UpdateListenerAttribute

update

*LoadBalancer

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

*SecurityPolicy

acs:alb:{#regionId}:{#accountId}:securitypolicy/{#securitypolicyId}

*ServerGroup

acs:alb:{#regionId}:{#accountId}:servergroup/{#servergroupId}

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
ListenerId	string	必須	Application Load Balancing (ALB) インスタンスのリスナー ID。	lsn-o4u54y73wq7b******
ClientToken	string	任意	リクエストのべき等性を確保するために使用されるクライアントトークン。クライアントを使用してトークンを生成できますが、異なるリクエスト間でトークンが一意であることを確認する必要があります。トークンには ASCII 文字のみを使用できます。説明このパラメーターを指定しない場合、システムは自動的に RequestId を ClientToken として使用します。RequestId は API の呼び出しごとに異なる場合があります。	5A2CFF0E-5718-45B5-9D4D-70B******
DryRun	boolean	任意	実際のリクエストを実行せずに、ドライランのみを実行するかどうかを指定します。有効な値: true: ドライランのみを実行します。システムは、パラメーター値の欠落、不正なリクエスト構文、サービスの制限など、リクエストに潜在的な問題がないかをチェックします。ドライランに失敗した場合、エラーコードが返されます。ドライランに成功した場合、`DryRunOperation` エラーコードが返されます。 false (デフォルト): ドライランを実行し、実際のリクエストを実行します。ドライランに成功した場合、`HTTP 2xx` 状態コードが返され、操作が実行されます。	false
ListenerDescription	string	任意	カスタムリスナー名。名前は 2～256 文字で、英数字、漢字、コンマ (,)、ピリオド (.)、セミコロン (;)、転送 (/)、アットマーク (@)、アンダースコア (_)、ハイフン (-) を使用できます。	HTTP_80
RequestTimeout	integer	任意	リクエストのタイムアウト期間。単位: 秒。有効な値: 1～600。タイムアウト期間内にバックエンドサーバーから応答を受信しない場合、負荷分散はクライアントに `HTTP 504` エラーコードを返します。	60
IdleTimeout	integer	任意	アイドル接続のタイムアウト期間。単位: 秒。有効な値: 1～600。タイムアウト期間内にアクセスリクエストを受信しない場合、負荷分散は現在の接続を一時的に切断し、次のリクエストが到着したときに接続を復元します。	15
GzipEnabled	boolean	任意	特定の種類のファイルを圧縮するために Gzip 圧縮を有効にするかどうかを指定します。有効な値: true: 有効。 false: 無効。	true
Http2Enabled	boolean	任意	HTTP/2 を有効にするかどうかを指定します。有効な値: true: 有効。 false: 無効。説明このパラメーターは HTTPS リスナーのみでサポートされています。	true
SecurityPolicyId	string	任意	セキュリティポリシー。システムセキュリティポリシーおよびカスタムセキュリティポリシーがサポートされています。説明このパラメーターは HTTPS リスナーのみでサポートされています。	tls_cipher_policy_1_0
CaEnabled	boolean	任意	相互認証を有効にするかどうかを指定します。有効な値: true: 有効。 false: 無効。	false
XForwardedForConfig	object	任意	XForwardedFor 特徴の構成。
XForwardedForClientCertClientVerifyAlias	string	任意	カスタムヘッダーフィールド名。このパラメーターは、XForwardedForClientCertClientVerifyEnabled が true にセットされている場合にのみ効果が得られます。名前は 1～40 文字で、小文字の a～z、ハイフン (-)、アンダースコア (_)、数字を使用できます。説明このパラメーターは HTTPS リスナーのみでサポートされています。	test_client-verify-alias_123456
XForwardedForClientCertClientVerifyEnabled	boolean	任意	`X-Forwarded-Clientcert-clientverify` ヘッダーフィールドを使用して、負荷分散インスタンスにアクセスするクライアント証明書の検証結果を取得するかどうかを指定します。有効な値: true: 有効。 false: 無効。説明このパラメーターは HTTPS リスナーのみでサポートされています。	false
XForwardedForClientCertFingerprintAlias	string	任意	カスタムヘッダーフィールド名。このパラメーターは、XForwardedForClientCertFingerprintEnabled が true にセットされている場合にのみ効果が得られます。名前は 1～40 文字で、小文字の a～z、ハイフン (-)、アンダースコア (_)、数字を使用できます。説明このパラメーターは HTTPS リスナーのみでサポートされています。	test_finger-print-alias_123456
XForwardedForClientCertFingerprintEnabled	boolean	任意	`X-Forwarded-Clientcert-fingerprint` ヘッダーフィールドを使用して、負荷分散インスタンスにアクセスするクライアント証明書の指紋を取得するかどうかを指定します。有効な値: true: 有効。 false: 無効。説明このパラメーターは HTTPS リスナーのみでサポートされています。	false
XForwardedForClientCertIssuerDNAlias	string	任意	カスタムヘッダーフィールド名。このパラメーターは、XForwardedForClientCertIssuerDNEnabled が true にセットされている場合にのみ効果が得られます。名前は 1～40 文字で、小文字の a～z、ハイフン (-)、アンダースコア (_)、数字を使用できます。説明このパラメーターは HTTPS リスナーのみでサポートされています。	test_issue-dn-alias_123456
XForwardedForClientCertIssuerDNEnabled	boolean	任意	`X-Forwarded-Clientcert-issuerdn` ヘッダーフィールドを使用して、負荷分散インスタンスにアクセスするクライアント証明書の発行者情報を取得するかどうかを指定します。有効な値: true: 有効。 false: 無効。説明このパラメーターは HTTPS リスナーのみでサポートされています。	false
XForwardedForClientCertSubjectDNAlias	string	任意	カスタムヘッダーフィールド名。このパラメーターは、XForwardedForClientCertSubjectDNEnabled が true にセットされている場合にのみ効果が得られます。名前は 1～40 文字で、小文字の a～z、ハイフン (-)、アンダースコア (_)、数字を使用できます。説明このパラメーターは HTTPS リスナーのみでサポートされています。	test_subject-dn-alias_123456
XForwardedForClientCertSubjectDNEnabled	boolean	任意	`X-Forwarded-Clientcert-subjectdn` ヘッダーフィールドを使用して、負荷分散インスタンスにアクセスするクライアント証明書のオーナー情報を取得するかどうかを指定します。有効な値: true: 有効。 false: 無効。説明このパラメーターは HTTPS リスナーのみでサポートされています。	false
XForwardedForClientSrcPortEnabled	boolean	任意	`X-Forwarded-Client-srcport` ヘッダーフィールドを使用して、負荷分散インスタンスにアクセスするクライアントのポートを取得するかどうかを指定します。有効な値: true: 有効。 false: 無効。説明このパラメーターは HTTP および HTTPS リスナーでサポートされています。	false
XForwardedForEnabled	boolean	任意	`X-Forwarded-For` ヘッダーフィールドを使用して、クライアントの実 IP アドレスを取得するかどうかを指定します。有効な値: true (デフォルト): 有効。 false: 無効。説明このパラメーターを true にセットすると、XForwardedForProcessingMode のデフォルト値は append になり、remove に変更できます。このパラメーターを false にセットすると、リクエストがバックエンドサーバーに送信される前に、`X-Forwarded-For` ヘッダーフィールドは追加処理なしで保持されます。このパラメーターは HTTP および HTTPS リスナーでサポートされています。	true
XForwardedForProcessingMode	string	任意	`X-Forwarded-For` ヘッダーフィールドの処理モード。このパラメーターは、XForwardedForEnabled が true にセットされている場合にのみ効果が得られます。有効な値: append (デフォルト): 追加。 remove: 削除。説明このパラメーターを append にセットすると、リクエストがバックエンドサーバーに送信される前に、最後のホップの IP アドレスが `X-Forwarded-For` ヘッダーフィールドに追加されます。このパラメーターを remove にセットすると、リクエストに `X-Forwarded-For` ヘッダーフィールドが含まれているかどうかに関係なく、リクエストがバックエンドサーバーに送信される前に `X-Forwarded-For` ヘッダーが削除されます。このパラメーターは HTTP および HTTPS リスナーでサポートされています。	append
XForwardedForProtoEnabled	boolean	任意	`X-Forwarded-Proto` ヘッダーフィールドを使用して、負荷分散インスタンスのリスナープロトコルを取得するかどうかを指定します。有効な値: true: 有効。 false: 無効。説明このパラメーターは HTTP、HTTPS、および QUIC リスナーでサポートされています。	false
XForwardedForSLBIdEnabled	boolean	任意	`SLB-ID` ヘッダーフィールドを使用して、負荷分散インスタンス ID を取得するかどうかを指定します。有効な値: true: 有効。 false: 無効。説明このパラメーターは HTTP、HTTPS、および QUIC リスナーでサポートされています。	false
XForwardedForSLBPortEnabled	boolean	任意	`X-Forwarded-Port` ヘッダーフィールドを使用して、負荷分散インスタンスのリスナーポートを取得するかどうかを指定します。有効な値: true: 有効。 false: 無効。説明このパラメーターは HTTP、HTTPS、および QUIC リスナーでサポートされています。	false
XForwardedForClientSourceIpsEnabled	boolean	任意	ALB が X-Forwarded-For ヘッダーフィールドからクライアントの実 IP アドレスを取得することを許可するかどうかを指定します。有効な値: true: 有効。 false: 無効。説明このパラメーターは HTTP および HTTPS リスナーでサポートされています。	false
XForwardedForClientSourceIpsTrusted	string	任意	信頼されたプロキシ IP アドレス。 Application Load Balancing (ALB) は `X-Forwarded-For` ヘッダーフィールドを右から左へ走査し、信頼された IP リストに含まれない最初の IP アドレスをクライアントの実 IP アドレスとして選択します。この IP アドレスは、ソース IP ベースのレート制限に使用されます。	10.1.1.0/24
XForwardedForHostEnabled	boolean	任意	`X-Forwarded-Host` ヘッダーフィールドを使用して、負荷分散インスタンスにアクセスするクライアントのドメイン名を取得するかどうかを指定します。有効な値: true: 有効。 false (デフォルト): 無効。説明このパラメーターは HTTP、HTTPS、および QUIC リスナーでサポートされています。	false
QuicConfig	object	任意	関連付けられた QUIC リスナーが有効な場合の構成情報。
QuicListenerId	string	任意	関連付ける QUIC リスナーの ID。このパラメーターは、QuicUpgradeEnabled が true にセットされている場合に必須です。このパラメーターは HTTPS リスナーでのみ有効です。説明元のリスナーと関連付ける QUIC リスナーは同じ ALB インスタンスに属している必要があり、QUIC リスナーは以前に関連付けられていない必要があります。	lsn-333
QuicUpgradeEnabled	boolean	任意	QUIC スペックアップを有効にするかどうかを指定します。有効な値: true: 有効。 false: 無効。説明このパラメーターは HTTPS リスナーでのみ有効です。	false
Certificates	array<object>	任意	証明書リスト。
	object	任意	証明書構造体。
CertificateId	string	任意	デフォルトの証明書 ID。デフォルトのサーバー証明書は 1 つのみサポートされています。説明このパラメーターは、リスナーのプロトコルタイプが HTTPS または QUIC の場合に必須です。サーバー証明書をさらに追加するには、リスナーの作成後に AssociateAdditionalCertificatesWithListener を呼び出して拡張証明書を設定します。	123157******
CaCertificates	array<object>	任意	CA 証明書リスト。CA 証明書は 1 つのみサポートされています。
	object	任意	CA 証明書構造体。
CertificateId	string	任意	CA 証明書 ID。説明このパラメーターは、CaEnabled が true に設定されている場合に必須です。	123359******
DefaultActions	array<object>	任意	デフォルトルール操作のリスト。
	array<object>	任意	デフォルトルール操作の構造体。
ForwardGroupConfig	object	任意	操作の転送構成。このパラメーターは、Type が ForwardGroup にセットされている場合にのみ必須かつ有効です。最大 20 個の転送操作構成を追加できます。
ServerGroupTuples	array<object>	必須	転送送信先サーバーグループタプルのリスト。
	object	任意	転送送信先サーバーグループタプル構造体。
ServerGroupId	string	必須	リクエストの転送送信先サーバーグループの ID。	sgp-i5qt20******
Type	string	必須	操作タイプ。最大 1 つの操作タイプを追加できます。有効な値: ForwardGroup。リクエストが複数のサーバーグループに転送されることを示します。	ForwardGroup

レスポンスフィールド

フィールド	型	説明	例
	object	レスポンス構造体。
JobId	string	非同期タスクの ID。	72dcd26b-f12d-4c27-b3af-18f6aed5****
RequestId	string	リクエストの ID。	365F4154-92F6-4AE4-92F8-7FF******

例

成功レスポンス

JSONJSON

{
  "JobId": "72dcd26b-f12d-4c27-b3af-18f6aed5****",
  "RequestId": "365F4154-92F6-4AE4-92F8-7FF******"
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ	説明
400	IncorrectStatus.LoadBalancer	The status of %s [%s] is incorrect.	インスタンスの現在のステータスでは、この操作はサポートされていません。
400	IncorrectBusinessStatus.LoadBalancer	The business status of %s [%s] is incorrect.	インスタンスの現在のステータスでは、この操作はサポートされていません。
400	IncorrectStatus.Listener	The status of %s [%s] is incorrect.	リスナーの現在のステータスでは、この操作はサポートされていません。
400	OperationDenied.CrossLoadBalancerQUICListener	The operation is not allowed because of %s.	%s のため、操作が拒否されました。
400	ResourceAlreadyAssociated.Listener	The specified resource %s is already associated.	リソース %s はすでに関連付けられています。
400	OperationDenied.GRPCServerGroup	The operation is not allowed because of %s.	この gRPC サーバーグループに関連付けられたリスナーで HTTP/2.0 が有効になっていないため、操作が拒否されました。
400	ResourceAlreadyAssociated.Certificate	The specified resource %s is already associated.	証明書はすでに関連付けられています。
400	ResourceQuotaExceeded.SecurityPolicyAttachedNum	The quota of %s is exceeded for resource %s, usage %s/%s.	クォータ %s を超過しました。リソースは %s、現在の使用量は %s、クォータは %s です。
400	ResourceQuotaExceeded.ServerGroupAttachedNum	The quota of %s is exceeded for resource %s, usage %s/%s.	サーバーグループの関連付け数がクォータ制限を超えています。
400	ResourceQuotaExceeded.LoadBalancerServersNum	The quota of %s is exceeded for resource %s, usage %s/%s.	バックエンドサーバーの数がクォータ制限を超えています。
400	ResourceQuotaExceeded.ServerAddedNum	The quota of %s is exceeded for resource %s, usage %s/%s.	サーバーグループに追加されたサーバーの数がクォータ制限を超えています。
400	OperationDenied.ServerGroupProtocolNotSupport	The operation is not allowed because of ServerGroupProtocolNotSupport.	サーバーグループのプロトコルがサポートされていないため、操作が拒否されました。
400	UnsupportedFeature.FullTraceHttps	The feature of FullTraceHttps is not supported for current instance.	現在のインスタンスエディションでは、エンドツーエンドの HTTPS 機能はサポートされていません。
400	ResourceInConfiguring.Listener	The specified resource of %s is being configured, please try again later.	指定されたリソース %s は設定中です。後でもう一度お試しください。
400	Mismatch.VpcId	The %s is mismatched for %s and %s.	%s と %s の間で %s が一致しません。
400	InvalidParameter	Invalid parameter, please check the parameter input.	パラメーターが無効です。パラメーターの入力を確認してください。
400	OperationDenied.CACertificateCorrupted	The CA certificate is corrupted.	CA 証明書が破損しています。
403	Forbidden.LoadBalancer	Authentication is failed for %s.	負荷分散操作の権限検証に失敗しました。
404	ResourceNotFound.Listener	The specified resource %s is not found.	リスナーが存在しません。
404	ResourceNotFound.ServerGroup	The specified resource %s is not found.	バックエンドサーバーグループが存在しません。
404	ResourceNotFound.SecurityPolicy	The specified resource %s is not found.	リソース %s が存在しません。
404	ResourceNotFound.Certificate	The specified resource %s is not found.	指定された証明書が存在しません。

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

変更履歴

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