UpdateListener - - Alibaba Cloud ドキュメントセンター

説明

この操作を呼び出して、ビジネス要件を満たすようにリスナーのプロトコルやポートなどの構成を変更できます。

この操作を呼び出すときは、次の項目に注意してください。

UpdateListenerは非同期操作です。リクエストを送信した後、システムはリクエストIDを返しますが、操作はシステムバックグラウンドで実行中です。 DescribeListener操作を呼び出して、リスナーの状態を照会できます。
- リスナーが更新中の状態にある場合は、その設定が変更されていることを示します。この場合、クエリ操作のみを実行できます。
- リスナーがアクティブ状態の場合は、設定が変更されていることを示します。
UpdateListener操作を繰り返し呼び出して、特定の期間内に同じGAインスタンスのリスナー設定を変更することはできません。

デバッグ

OpenAPI Explorer は署名値を自動的に計算します。この操作は、OpenAPI Explorer で呼び出すことを推奨します。 OpenAPI Explorer は、さまざまな SDK に対して操作のサンプルコードを動的に生成します。

リクエストパラメーター


項目	データ型	必須／任意	例:	説明
操作	String	必須	UpdateListener	実行する操作です。値をUpdateListenerに設定します。
RegionId	String	任意	cn-hangzhou	GAインスタンスがデプロイされているリージョンのID。値をcn-hangzhouに設定します。
ClientToken	String	任意	123e4567-e89b-12d3-a456-426655440000	リクエストのべき等性を保証するために使用されるクライアントトークン。クライアントを使用して値を生成できますが、すべてのリクエスト間で一意であることを確認する必要があります。 ClientTokenにはASCII文字のみを含めることができます。説明このパラメーターを設定しない場合、ClientTokenはRequestIdの値に設定されます。 RequestIdの値は、APIリクエストごとに異なる場合があります。
名前	String	任意	リスナー	リスナーの名前を示します。名前は2 ~ 128文字で、英数字、アンダースコア (_) 、ハイフン (-) を使用できます。先頭は英字とする必要があります。
説明	String	任意	Listener	リスナーの説明です。 The description can be at most 200 characters in length.
ClientAffinity	String	任意	SOURCE_IP	リスナーのクライアントアフィニティを有効にするかどうかを指定します。このパラメーターを空のままにすると、クライアントアフィニティは無効になります。クライアントアフィニティが無効化された後、特定のクライアントIPアドレスからの要求は、異なるエンドポイントに転送され得る。クライアントアフィニティを有効にするには、このパラメーターをSOURCE_IPに設定します。この場合、クライアントがステートフルアプリケーションにアクセスすると、同一クライアントからのリクエストは、ソースポートやプロトコルに関係なく、常に同じエンドポイントに転送されます。
プロトコル	String	任意	tcp	リスナーが使用するネットワーク伝送プロトコル。有効な値： tcp: TCP udp: UDP http: HTTP https: HTTPS
ListenerId	String	必須	lsr-bp1bpn0kn908w4nbw****	リスナーの ID を示します。
ProxyProtocol	String	任意	false	クライアントIPアドレスを予約するかどうかを指定します。デフォルト値：false 有効な値： true: クライアントIPアドレスを予約します。クライアントIPアドレスが予約された後、バックエンドサービスを介してクライアントのソースIPアドレスを表示できます。 false: クライアントIPアドレスを予約しません。説明このパラメーターは、リスナーの設定に使用されるAPI操作では中止されます。 API操作を呼び出してエンドポイントグループを設定するときに、このパラメーターを設定することを推奨します。 ProxyProtocolパラメーターの詳細については、「CreateEndpointGroup」および「UpdateEndpointGroup」をご参照ください。
PortRanges.N.FromPort	Integer	〇	20	エンドポイントへのリクエストを受信し転送するために使用されるリスナーポート範囲の開始ポートです。有効な値: 1〜65499。 The FromPort value must be smaller than or equal to the ToPort value. 設定できるポートの最大数は、リスナーのルーティングタイプとプロトコルに依存します。詳細については、「リスナーの概要」をご参照ください。説明 HTTPまたはHTTPSリスナーに設定できるリスナーポートは1つだけです。この場合、開始ポートは終了ポートと同じである。
PortRanges.N.ToPort	Integer	〇	21	リクエストを受信してエンドポイントに転送するために使用されるリスナーポート範囲の終了ポート。有効な値: 1〜65499。 FromPort値はToPort値以下である必要があります。設定できるポートの最大数は、リスナーのルーティングタイプとプロトコルに依存します。詳細については、「リスナーの概要」をご参照ください。説明 HTTPまたはHTTPSリスナーに設定できるリスナーポートは1つだけです。この場合、開始ポートは終了ポートと同じである。
証明書. N.Id	String	任意	449 ****-cn-hangzhou	SSL証明書のID。説明このパラメーターは、HTTPSリスナーを設定する場合にのみ必要です。
BackendPorts.N.FromPort	Integer	いいえ	80	バックエンドサーバーがリクエストを受信するために使用するポートの範囲内の開始ポート。説明このパラメーターは、HTTPSまたはHTTPリスナーを設定し、リスナーポートがバックエンドサーバーがサービスを提供するポートと異なる場合にのみ必要です。この場合、バックエンドサーバーのリクエストを受信するために使用される開始ポートは、終了ポートと同じである必要があります。
BackendPorts.N.ToPort	Integer	いいえ	80	バックエンドサーバーがリクエストを受信するために使用するポートの範囲内の終了ポート。説明このパラメーターは、HTTPSまたはHTTPリスナーを設定し、リスナーポートがバックエンドサーバーがサービスを提供するポートと異なる場合にのみ必要です。この場合、バックエンドサーバーのリクエストを受信するために使用される開始ポートは、終了ポートと同じである必要があります。
XForwardedForConfig	オブジェクト	いいえ		`XForward`ヘッダーの設定。
XForwardedForGaIdEnabled	Boolean	いいえ	false	`GA-ID`ヘッダーを使用してGAインスタンスのIDを取得するかどうかを指定します。デフォルト値：false 有効な値： true: はい false: いいえ説明このパラメーターは、HTTPおよびHTTPSリスナーに対してのみ指定できます。
XForwardedForProtoEnabled	Boolean	いいえ	false	`GA-X-Forward-Proto`ヘッダーを使用してGAインスタンスのリスナープロトコルを取得するかどうかを指定します。デフォルト値：false 有効な値： true: はい false: いいえ説明このパラメーターは、HTTPおよびHTTPSリスナーに対してのみ指定できます。
XForwardedForPortEnabled	Boolean	いいえ	false	`GA-X-Forward-Port`ヘッダーを使用してGAインスタンスのリスナーポートを取得するかどうかを指定します。デフォルト値：false 有効な値： true: はい false: いいえ説明このパラメーターは、HTTPおよびHTTPSリスナーに対してのみ指定できます。
XRealIpEnabled	Boolean	いいえ	false	`X-Real-IP`ヘッダーを使用してクライアントIPアドレスを取得するかどうかを指定します。デフォルト値：false 有効な値： true: はい false: いいえ説明このパラメーターは、HTTPおよびHTTPSリスナーに対してのみ指定できます。
XForwardedForGaApEnabled	Boolean	いいえ	false	`GA-AP`ヘッダーを使用してアクセラレーションリージョンに関する情報を取得するかどうかを指定します。デフォルト値：false 有効な値： true: はい false: いいえ説明このパラメーターは、HTTPおよびHTTPSリスナーに対してのみ指定できます。
SecurityPolicyId	String	任意	tls_cipher_policy_1_0	セキュリティポリシーのID。有効な値： 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 Supported暗号スイート: 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 説明このパラメーターは、HTTPSリスナーに対してのみ指定できます。

レスポンスパラメーター


項目	データ型	例:	説明
RequestId	String	6FEA0CF3-D3B9-43E5-A304-D217037876A8	リクエストの ID です。

例

リクエストの例

http(s)://[Endpoint]/?Action=UpdateListener
&RegionId=cn-hangzhou
&ClientToken=123e4567-e89b-12d3-a456-426655440000
&名前=リスナー
&Description=リスナー
&ClientAffinity=SOURCE_IP
&プロトコル=tcp
&ListenerId=lsr-bp1bpn0kn908w4nbw ****
&ProxyProtocol=false
&PortRanges=[{"FromPort":20,"ToPort":21}]
&Certificates=[{"Id":"449 ****-cn-hangzhou"}]
&BackendPorts=[{"FromPort":80,"ToPort":80}]
&XForwardedForConfig={"XForwardedForGaIdEnabled":false,"XForwardedForProtoEnabled":false,"XForwardedForPortEnabled":false,"XRealIpEnabled":false,"XForwardedForGaApEnabled":false}
&SecurityPolicyId=tls_cipher_policy_1_0
&<共通リクエストパラメーター>

正常に処理された場合のレスポンス例

XML 形式

HTTP/1.1 200 OK
Content-Type:application/xml

<UpdateListenerResponse>
    <RequestId>6FEA0CF3-D3B9-43E5-A304-D217037876A8 </RequestId>
</UpdateListenerResponse>

JSON 形式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "6FEA0CF3-D3B9-43E5-A304-D217037876A8\t"
}

エラーコード


HttpCode	エラーコード	エラーメッセージ	説明
400	NotActive.Listener	リスナーの状態がアクティブではありません。	指定されたリスナーが不安定な場合に返されるエラーメッセージ。
400	PortRangeIllegal. リスナー	指定されたリスナーポート範囲は無効です。	リスナーのポート範囲が無効な場合に返されるエラーメッセージ。
400	PortConflict.Listener	リスナーポートの設定が競合しています。	指定されたリスナーポートの構成が別のリスナーポートの構成と競合する場合に返されるエラーメッセージ。
400	QuotaExceeded.ListenerPort	リスナーポートの最大数を超えています。	リスナーポートの数が上限に達した場合に返されるエラーメッセージ。
400	NotExist.Accelerator	高速化されたインスタンスは存在しません。	GAインスタンスが存在しない場合に返されるエラーメッセージ。
400	PortRanges.MustOne	portRangesはHTTPSとHTTPタイプのリスナーの1つである必要があります。	HTTPまたはHTTPSリスナーが1つのポートのみをサポートしている場合に返されるエラーメッセージ。
400	SecurityPolicyIdIllegal.Listener	リスナーのセキュリティポリシーID % sは不正です。	リスナーのセキュリティポリシーIDが無効な場合に返されるエラーメッセージ。
400	SecurityPolicyId.NotNeed	リスナーにはセキュリティポリシーIDは必要ありません。	リスナーにセキュリティポリシーIDが必要ない場合に返されるエラーメッセージ。

エラーコードリストについては、「API エラーセンター」をご参照ください。