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

リスナー名やデフォルトアクションなど、リスナーの属性を更新します。

操作説明

UpdateListenerAttribute は非同期操作です。リクエストの送信後、システムはリクエスト ID を返し、バックグラウンドでタスクを実行します。リスナーの設定はすぐには更新されません。操作を呼び出して、リスナーの更新ステータスをクエリできます。

リスナーが 設定中 状態の場合、更新中です。
リスナーが 実行中 状態の場合、更新済みです。

今すぐお試しください

この 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 Balancer (ALB) リスナーの ID。	lsn-o4u54y73wq7b******
ClientToken	string	任意	リクエストのべき等性を保証するために使用されるクライアントトークン。トークンはリクエスト間で一意である必要があり、ASCII 文字のみを含めることができます。説明このパラメーターを指定しない場合、システムはリクエストの RequestId を ClientToken として使用します。各 API リクエストの RequestId は異なる場合があります。	5A2CFF0E-5718-45B5-9D4D-70B******
DryRun	boolean	任意	ドライランを実行するかどうかを指定します。有効な値： true: ドライランを実行します。システムは必須パラメーター、リクエストフォーマット、およびサービスの制限を確認します。リクエストがドライランに失敗すると、エラーメッセージが返されます。リクエストがドライランに成功すると、システムは `DryRunOperation` エラーコードを返します。 false (デフォルト): 通常のリクエストを実行します。リクエストがチェックに成功すると、システムは 2xx HTTP ステータスコードを返し、操作を実行します。	false
ListenerDescription	string	任意	リスナーの名前。名前は長さが 2～256 文字で、文字、数字、漢字、カンマ (,)、ピリオド (.)、セミコロン (;)、スラッシュ (/)、アットマーク (@)、アンダースコア (_)、ハイフン (-) を使用できます。	HTTP_80
RequestTimeout	integer	任意	リクエストのタイムアウト期間。単位：秒。有効な値：1～180。タイムアウト期間中にバックエンドサーバーから応答がない場合、ALB はクライアントに `HTTP 504` エラーコードを送信します。	3
IdleTimeout	integer	任意	アイドルタイムアウト期間。単位：秒。有効な値：1～60。タイムアウト期間中にリクエストが受信されない場合、ALB は現在の接続を閉じます。新しいリクエストが受信されると、ALB は新しい接続を確立します。	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	任意	X-Forwarded-For ヘッダーの設定。
XForwardedForClientCertClientVerifyAlias	string	任意	カスタムヘッダーの名前。このパラメーターは、XForwardedForClientCertClientVerifyEnabled が true に設定されている場合にのみ有効です。名前は長さが 1～40 文字で、文字、数字、アンダースコア (_)、ハイフン (-) を使用できます。説明このパラメーターは HTTPS リスナーでのみ使用できます。	test_client-verify-alias_123456
XForwardedForClientCertClientVerifyEnabled	boolean	任意	`X-Forwarded-Clientcert-Clientverify` ヘッダーを使用してクライアント証明書の検証結果を取得するかどうかを指定します。有効な値： true false 説明このパラメーターは HTTPS リスナーでのみ使用できます。	false
XForwardedForClientCertFingerprintAlias	string	任意	カスタムヘッダーの名前。このパラメーターは、XForwardedForClientCertFingerprintEnabled が true に設定されている場合にのみ有効です。名前は長さが 1～40 文字で、文字、数字、アンダースコア (_)、ハイフン (-) を使用できます。説明このパラメーターは HTTPS リスナーでのみ使用できます。	test_finger-print-alias_123456
XForwardedForClientCertFingerprintEnabled	boolean	任意	`X-Forwarded-Clientcert-Fingerprint` ヘッダーを使用してクライアント証明書の指紋を取得するかどうかを指定します。有効な値： true false 説明このパラメーターは HTTPS リスナーでのみ使用できます。	false
XForwardedForClientCertIssuerDNAlias	string	任意	カスタムヘッダーの名前。このパラメーターは、XForwardedForClientCertIssuerDNEnabled が true に設定されている場合にのみ有効です。名前は長さが 1～40 文字で、文字、数字、アンダースコア (_)、ハイフン (-) を使用できます。説明このパラメーターは HTTPS リスナーでのみ使用できます。	test_issue-dn-alias_123456
XForwardedForClientCertIssuerDNEnabled	boolean	任意	`X-Forwarded-Clientcert-Issuerdn` ヘッダーを使用してクライアント証明書の発行者に関する情報を取得するかどうかを指定します。有効な値： true false 説明このパラメーターは HTTPS リスナーでのみ使用できます。	false
XForwardedForClientCertSubjectDNAlias	string	任意	カスタムヘッダーの名前。このパラメーターは、XForwardedForClientCertSubjectDNEnabled が true に設定されている場合にのみ有効です。名前は長さが 1～40 文字で、文字、数字、アンダースコア (_)、ハイフン (-) を使用できます。説明このパラメーターは 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 (デフォルト): IP アドレスを追加します。 remove: IP アドレスを削除します。説明このパラメーターを append に設定すると、リクエストがバックエンドサービスに送信される前に、最終ホップの IP アドレスが `X-Forwarded-For` ヘッダーに追加されます。このパラメーターを remove に設定すると、リクエストに `X-Forwarded-For` ヘッダーが含まれているかどうかに関係なく、リクエストがバックエンドサービスに送信される前に `X-Forwarded-For` ヘッダーが削除されます。このパラメーターは HTTP および HTTPS リスナーで使用できます。	append
XForwardedForProtoEnabled	boolean	任意	`X-Forwarded-Proto` ヘッダーを使用して ALB インスタンスのリスナープロトコルを取得するかどうかを指定します。有効な値： true false 説明このパラメーターは、HTTP、HTTPS、および QUIC リスナーで使用できます。	false
XForwardedForSLBIdEnabled	boolean	任意	`SLB-ID` ヘッダーを使用して ALB インスタンスの ID を取得するかどうかを指定します。有効な値： true false 説明このパラメーターは、HTTP、HTTPS、および QUIC リスナーで使用できます。	false
XForwardedForSLBPortEnabled	boolean	任意	`X-Forwarded-Port` ヘッダーを使用して ALB インスタンスのリスナーポートを取得するかどうかを指定します。有効な値： true false 説明このパラメーターは、HTTP、HTTPS、および QUIC リスナーで使用できます。	false
XForwardedForClientSourceIpsEnabled	boolean	任意	ALB が `X-Forwarded-For` ヘッダーからクライアントのリアル IP アドレスを検索できるようにするかどうかを指定します。有効な値： true false 説明このパラメーターは HTTP および HTTPS リスナーで使用できます。	false
XForwardedForClientSourceIpsTrusted	string	任意	信頼できるプロキシ IP アドレス。 ALB は `X-Forwarded-For` ヘッダーを末尾から先頭に向かって走査します。ALB は、信頼できる IP アドレスリストに含まれていない最初の IP アドレスをクライアントのリアル IP アドレスとして選択します。この IP アドレスは速度制限に使用されます。	10.1.1.0/24
XForwardedForHostEnabled	boolean	任意	`X-Forwarded-Host` ヘッダーを使用して、クライアントが ALB インスタンスへのアクセスに使用したドメイン名を取得するかどうかを指定します。有効な値： 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 の場合に必須です。サーバー証明書を追加するには、リスナーを作成した後に操作を呼び出します。	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.
400	ResourceAlreadyAssociated.Listener	The specified resource %s is already associated.
400	OperationDenied.GRPCServerGroup	The operation is not allowed because of %s.
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.
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.
400	ResourceInConfiguring.Listener	The specified resource of %s is being configured, please try again later.
400	Mismatch.VpcId	The %s is mismatched for %s and %s.
400	InvalidParameter	Invalid parameter, please check the parameter input.
400	OperationDenied.CACertificateCorrupted	The CA certificate is corrupted.
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.
404	ResourceNotFound.Certificate	The specified resource %s is not found.

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

変更履歴

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