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

操作説明

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

ALB インスタンスが 設定中 状態の場合、ALB インスタンスは変更中です。
ALB インスタンスが アクティブ 状態の場合、ALB インスタンスは変更済みです。

今すぐお試しください

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

update

*LoadBalancer

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

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
ClientToken	string	任意	リクエストのべき等性を保証するために使用されるクライアントトークンです。クライアント側でトークンを生成できますが、異なるリクエスト間でトークンがユニークであることを確認する必要があります。トークンには ASCII 文字のみを含めることができます。説明このパラメーターを指定しない場合、システムは自動的にリクエスト ID をクライアントトークンとして使用します。リクエスト ID はリクエストごとに異なる場合があります。	5A2CFF0E-5718-45B5-9D4D-70B3FF3898
DryRun	boolean	任意	ドライランのみを実行するかどうかを指定します。有効な値： true：ドライランのみを実行します。システムは、パラメーター値の不足、リクエスト構文の誤り、サービスの制限など、リクエストに潜在的な問題がないかチェックします。リクエストがドライランに失敗すると、エラーメッセージが返されます。リクエストがドライランに成功すると、`DryRunOperation` エラーコードが返されます。 false：ドライランを実行し、リクエストを送信します。リクエストがドライランに成功すると、`2xx HTTP` ステータスコードが返され、操作が実行されます。これはデフォルト値です。	true
LoadBalancerId	string	必須	ALB インスタンスの ID。	alb-o9ulmq5hgn68jk****
LoadBalancerName	string	任意	ALB インスタンスの名前。名前は長さが 2～128 文字で、英字、数字、ピリオド (.)、アンダースコア (_)、ハイフン (-) を使用できます。名前は英字で始まる必要があります。	lb-instance-test
ModificationProtectionConfig	object	任意	設定変更保護の設定。
Reason	string	任意	設定変更保護を有効にする理由。名前は長さが 2～128 文字で、英字、数字、ピリオド (.)、アンダースコア (_)、ハイフン (-) を使用できます。英字で始まる必要があります。このパラメーターは、Status が ConsoleProtection に設定されている場合にのみ有効です。	test
Status	string	任意	設定変更保護を有効にするかどうかを指定します。有効な値： NonProtection：設定変更保護を無効にします。この場合、指定した Reason パラメーターの値は有効になりません。Reason の値を設定した場合、その値はクリアされます。 ConsoleProtection：設定変更保護を有効にします。この場合、指定した Reason パラメーターの値が有効になります。** 説明パラメーターが ConsoleProtection** に設定されている場合、設定変更保護が有効になります。ALB コンソールで ALB インスタンスの構成を変更することはできません。ただし、API 操作を呼び出して ALB インスタンスの構成を変更することはできます。	ConsoleProtection

レスポンスフィールド

フィールド	型	説明	例
	object	変更された属性。
JobId	string	同期タスクの ID です。	72dcd26b-f12d-4c27-b3af-18f6aed5****
RequestId	string	リクエスト ID。	CEF72CEB-54B6-4AE8-B225-F876FF7BA984

例

成功レスポンス

JSONJSON

{
  "JobId": "72dcd26b-f12d-4c27-b3af-18f6aed5****",
  "RequestId": "CEF72CEB-54B6-4AE8-B225-F876FF7BA984"
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ
400	IncorrectStatus.LoadBalancer	The status of %s [%s] is incorrect.
400	IncorrectBusinessStatus.LoadBalancer	The business status of %s [%s] is incorrect.
403	Forbidden.LoadBalancer	Authentication is failed for %s.
404	ResourceNotFound.LoadBalancer	The specified resource %s is not found.

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

変更履歴

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