Global Accelerator (GA) インスタンスのリスナーの設定を変更します。
操作説明
この操作を呼び出して、ビジネス要件に合わせてリスナーのプロトコルやポートなどの設定を変更できます。
この操作を呼び出す際は、次の点にご注意ください。
-
UpdateListener は非同期操作です。 リクエストを送信すると、システムはリクエスト ID を返し、バックグラウンドでタスクを実行します。 DescribeListener 操作を呼び出して、リスナーのステータスをクエリできます。
リスナーが updating 状態の場合、その設定が変更中であることを示します。 この場合、クエリ操作のみを実行できます。
リスナーが active 状態の場合、その設定が変更されたことを示します。
-
特定の期間内に同じ GA インスタンスのリスナー設定を変更するために、UpdateListener 操作を繰り返し呼び出すことはできません。
今すぐお試しください
テスト
RAM 認証
|
アクション |
アクセスレベル |
リソースタイプ |
条件キー |
依存アクション |
|
ga:UpdateListener |
update |
*Listener
|
なし | なし |
リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| RegionId |
string |
任意 |
Global Accelerator (GA) インスタンスがデプロイされているリージョンの ID。 値を cn-hangzhou に設定します。 |
cn-hangzhou |
| ClientToken |
string |
任意 |
リクエストのべき等性を保証するために使用されるクライアントトークンです。 クライアントを使用してトークンを生成できますが、トークンが異なるリクエスト間で一意であることを確認する必要があります。 クライアントトークンには ASCII 文字のみを含めることができます。 説明
このパラメーターを指定しない場合、システムは自動的にリクエスト ID をクライアントトークンとして使用します。 リクエスト ID はリクエストごとに異なる場合があります。 |
123e4567-e89b-12d3-a456-426655440000 |
| Name |
string |
任意 |
リスナーの名前。 名前は長さが 1~128 文字で、英字、数字、ピリオド (.)、アンダースコア (_)、ハイフン (-) を使用できます。 名前は英字で始まる必要があります。 |
Listener |
| Description |
string |
任意 |
リスナーの説明。 説明は最大 200 文字で、 |
Listener |
| ClientAffinity |
string |
任意 |
リスナーに対してクライアントアフィニティが有効になっているかどうかを示します。 有効な値:
|
SOURCE_IP |
| Protocol |
string |
任意 |
リスナーが使用するネットワーク伝送プロトコル。 有効な値:
|
tcp |
| ListenerId |
string |
必須 |
リスナーの ID。 |
lsr-bp1bpn0kn908w4nbw**** |
ProxyProtocol
deprecated
|
string |
任意 |
クライアントのソース IP アドレスを保持するかどうかを指定します。
説明
このパラメーターは、リスナーを設定するために使用される API 操作では廃止される予定です。 エンドポイントグループを設定するために API 操作を呼び出すときに、このパラメーターを設定することを推奨します。 ProxyProtocol パラメーターの詳細については、「CreateEndpointGroup」および「UpdateEndpointGroup」をご参照ください。 |
false |
| PortRanges |
array<object> |
任意 |
リクエストを受信し、エンドポイントに転送するために使用されるリスナーポート。 有効な値:1~65499。 設定可能なポートの最大数は、リスナーのルーティングタイプとプロトコルによって異なります。 詳細については、「リスナーの概要」をご参照ください。 |
|
|
object |
任意 |
リクエストを受信し、エンドポイントに転送するために使用されるリスナーポート。 有効な値:1~65499。 設定可能なポートの最大数は、リスナーのルーティングタイプとプロトコルによって異なります。 詳細については、「リスナーの概要」をご参照ください。 |
||
| FromPort |
integer |
必須 |
リクエストを受信してエンドポイントに転送するために使用されるリスナーポート範囲の最初のポート。 有効な値:1~65499。 FromPort の値は ToPort の値以下である必要があります。 設定可能なポートの最大数は、リスナーのルーティングタイプとプロトコルによって異なります。 詳細については、「リスナーの概要」をご参照ください。 説明
HTTP または HTTPS リスナーには、リスナーポートを 1 つだけ設定できます。 この場合、最初のポートは最後のポートと同じです。 |
20 |
| ToPort |
integer |
必須 |
リクエストを受信してエンドポイントに転送するために使用されるリスナーポート範囲の最後のポート。 有効な値:1~65499。 FromPort の値は ToPort の値以下である必要があります。 設定可能なポートの最大数は、リスナーのルーティングタイプとプロトコルによって異なります。 詳細については、「リスナーの概要」をご参照ください。 説明
HTTP または HTTPS リスナーには、リスナーポートを 1 つだけ設定できます。 この場合、最初のポートは最後のポートと同じです。 |
21 |
| Certificates |
array<object> |
任意 |
SSL 証明書。 |
|
|
object |
任意 |
SSL 証明書。 |
||
| Id |
string |
任意 |
SSL 証明書の ID。 説明
このパラメーターは、HTTPS リスナーを設定する場合にのみ必要です。 |
449****-cn-hangzhou |
| BackendPorts |
array<object> |
任意 |
バックエンドサーバーがリクエストを受信するために使用するポートの範囲。 |
|
|
object |
任意 |
バックエンドサーバーがリクエストを受信するために使用するポートの範囲。 |
||
| FromPort |
integer |
任意 |
バックエンドサーバーがリクエストを受信するために使用するポート範囲の最初のポート。 説明
このパラメーターは、HTTPS または HTTP リスナーを設定し、リスナーポートがバックエンドサーバーのサービスポートと異なる場合にのみ必要です。 この場合、バックエンドサーバーがリクエストを受信するために使用する最初のポートは、最後のポートと同じでなければなりません。 |
80 |
| ToPort |
integer |
任意 |
バックエンドサーバーがリクエストを受信するために使用するポート範囲の最後のポート。 説明
このパラメーターは、HTTPS または HTTP リスナーを設定し、リスナーポートがバックエンドサーバーのサービスポートと異なる場合にのみ必要です。 この場合、バックエンドサーバーがリクエストを受信するために使用する最初のポートは、最後のポートと同じでなければなりません。 |
80 |
| XForwardedForConfig |
object |
任意 |
|
|
| XForwardedForGaIdEnabled |
boolean |
任意 |
説明
このパラメーターは、HTTPS または HTTP リスナーを作成する場合にのみ使用できます。 |
false |
| XForwardedForProtoEnabled |
boolean |
任意 |
説明
このパラメーターは、HTTPS または HTTP リスナーを作成する場合にのみ使用できます。 |
false |
| XForwardedForPortEnabled |
boolean |
任意 |
説明
このパラメーターは、HTTPS または HTTP リスナーを作成する場合にのみ使用できます。 |
false |
| XRealIpEnabled |
boolean |
任意 |
説明
このパラメーターは、HTTPS または HTTP リスナーを作成する場合にのみ使用できます。 |
false |
| XForwardedForGaApEnabled |
boolean |
任意 |
説明
このパラメーターは、HTTPS または HTTP リスナーを作成する場合にのみ使用できます。 |
false |
| SecurityPolicyId |
string |
任意 |
セキュリティポリシーの ID。 有効な値:
説明
このパラメーターは、HTTPS リスナーを作成する場合にのみ使用できます。 |
tls_cipher_policy_1_0 |
| IdleTimeout |
integer |
任意 |
アイドル接続のタイムアウト期間。 単位:秒。
|
900 |
| RequestTimeout |
integer |
任意 |
HTTP または HTTPS リクエストのタイムアウト期間。 有効な値:1~180。 デフォルト値:60。 単位:秒。 説明
このパラメーターは、HTTP または HTTPS リスナーに対してのみ有効です。 バックエンドサーバーがタイムアウト期間内に応答しない場合、GA は HTTP 504 エラーコードをクライアントに返します。 |
60 |
| HttpVersion |
string |
任意 |
HTTP プロトコルの最大バージョン。 有効な値:
説明
HTTPS リスナーのみがこのパラメーターをサポートします。 |
http2 |
レスポンスフィールド
|
フィールド |
型 |
説明 |
例 |
|
object |
返された情報。 |
||
| RequestId |
string |
リクエストの ID。 |
6FEA0CF3-D3B9-43E5-A304-D217037876A8 |
例
成功レスポンス
JSONJSON
{
"RequestId": "6FEA0CF3-D3B9-43E5-A304-D217037876A8\t"
}
エラーコード
|
HTTP ステータスコード |
エラーコード |
エラーメッセージ |
説明 |
|---|---|---|---|
| 400 | NotActive.Listener | The state of the listener is not active. | The state of the listener is not active. |
| 400 | PortRangeIllegal.Listener | The specified listener port range is invalid. | The specified listener port range is invalid. |
| 400 | PortConflict.Listener | The listener port configuration is in conflict. | The listener port configuration is in conflict. |
| 400 | QuotaExceeded.ListenerPort | The maximum number of listener ports is exceeded. | The maximum number of listener ports is exceeded. |
| 400 | NotExist.Accelerator | The accelerated instance does not exist. | The accelerated instance does not exist. |
| 400 | StateError.Accelerator | The state of the accelerated instance is invalid. | |
| 400 | Exist.PortOverride | Port override exists. | |
| 400 | RegionNotSupportHugePort.Listener | The current ipSet or listener region does not support hugePort. | |
| 400 | PortRanges.MustOne | The portRanges must be one for HTTPS and HTTP type listener. | |
| 400 | SecurityPolicyIdIllegal.Listener | The listener security policy ID %s is illegal. | |
| 400 | SecurityPolicyId.NotNeed | No security policy ID is required for the listener. | |
| 500 | UnknownError | An error occurred while processing your request. Please try again. If the error persists, please submit a ticket. | |
| 403 | Forbbiden.SubUser | You are not authorized to operate on the specified resource because your account was created by another user. | |
| 403 | Forbidden | The user is not authorized to operate on the specified resource. |
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。