UpdateListenerLogConfig を呼び出してリスナーのログ設定を変更 - SLB

操作説明

UpdateListenerLogConfig は非同期操作です。リクエストの送信後、システムはリクエスト ID を返し、バックグラウンドでタスクを実行します。 GetListenerAttribute を呼び出して、タスクのステータスをクエリできます。

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

説明

アクセスログ機能を有効にした後でのみ、リスナーのログ設定を更新できます。

今すぐお試しください

この 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:UpdateListenerLogConfig

update

*LoadBalancer

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

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
ListenerId	string	必須	Application Load Balancer (ALB) リスナーの ID。	lsn-o4u54y73wq7b******
ClientToken	string	任意	リクエストのべき等性を保証するために使用されるクライアントトークン。クライアントを使用してトークンを生成できますが、トークンが異なるリクエスト間で一意であることを確認する必要があります。トークンには ASCII 文字のみを含めることができます。説明このパラメーターを指定しない場合、システムは自動的にリクエスト ID をクライアントトークンとして使用します。リクエスト ID はリクエストごとに異なる場合があります。	5A2CFF0E-5718-45B5-9D4D-70B******
DryRun	boolean	任意	リクエストの実体を送信せずに、ドライランのみを実行するかどうかを指定します。有効な値： true：ドライランのみを実行します。システムは、パラメーター値の不足、不正なリクエスト構文、サービス制限など、リクエストに潜在的な問題がないか確認します。リクエストがドライランに失敗すると、エラーメッセージが返されます。リクエストがドライランに成功すると、`DryRunOperation` エラーコードが返されます。 false： (デフォルト) ドライランを実行し、実際のリクエストを送信します。リクエストがドライランに成功すると、2xx HTTP ステータスコードが返され、操作が実行されます。	true
AccessLogRecordCustomizedHeadersEnabled	boolean	任意	アクセスログにカスタムヘッダーを記録するかどうかを指定します。有効な値： true false (デフォルト) 説明 AccessLogEnabled を指定してアクセスログ機能が有効になっている場合にのみ、このパラメーターを true に設定できます。	true
AccessLogTracingConfig	object	任意	Xtrace 機能に関する設定情報。
TracingEnabled	boolean	必須	Xtrace 機能を有効にするかどうかを指定します。有効な値： true false (デフォルト) 説明 AccessLogEnabled を指定してアクセスログ機能が有効になっている場合にのみ、このパラメーターを true に設定できます。	true
TracingSample	integer	任意	Xtrace 機能のサンプリングレート。有効な値：1～10000。説明このパラメーターは、TracingEnabled を true に設定した場合にのみ有効になります。	100
TracingType	string	任意	Xtrace のタイプ。値を Zipkin に設定します。説明このパラメーターは、TracingEnabled を true に設定した場合にのみ有効になります。	Zipkin

レスポンスフィールド

フィールド	型	説明	例
	object	リスナーの設定を更新する操作。
JobId	string	非同期タスク ID。	72dcd26b-f12d-4c27-b3af-18f6aed5****
RequestId	string	リクエスト ID。	365F4154-92F6-4AE4-92F8-7FF3******

例

成功レスポンス

JSONJSON

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

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ
400	IncorrectBusinessStatus.LoadBalancer	The business status of %s [%s] is incorrect.
400	IncorrectStatus.LoadBalancer	The status of %s [%s] is incorrect.
400	IncorrectStatus.Listener	The status of %s [%s] is incorrect.
400	OperationDenied.AccessLogDisabled	The operation is not allowed because of %s.
400	ResourceInConfiguring.Listener	The specified resource of %s is being configured, please try again later.
404	ResourceNotFound.Listener	The specified resource %s is not found.

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

変更履歴

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