UpdateLoadBalancerAttribute API による ALB 属性の更新 - Application Load Balancer - Alibaba Cloud - Server Load Balancer

操作説明

UpdateLoadBalancerAttribute API は非同期です。リクエストを送信すると、システムはリクエスト ID を返し、バックグラウンドでタスクを実行します。Application Load Balancer インスタンスのプロパティは、タスクが完了するまで変更されません。GetLoadBalancerAttribute を呼び出して、更新のステータスをクエリできます。

Application Load Balancer インスタンスが Configuring 状態の場合、インスタンスは更新中です。
Application Load Balancer インスタンスが Active 状態の場合、更新は完了しています。

今すぐお試しください

この 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 文字のみを含めることができます。クライアントから値を生成し、異なるリクエスト間で値が一意であることを確認してください。トークンには ASCII 文字のみを含めることができます。説明このパラメータを指定しない場合、システムは RequestId を ClientToken として使用します。各 API リクエストの RequestId は一意です。	5A2CFF0E-5718-45B5-9D4D-70B3FF3898
DryRun	boolean	任意	ドライランを実行するかどうかを指定します。有効な値： true：ドライランを実行します。システムは、必須パラメータ、リクエスト形式、およびビジネス制限をチェックします。リクエストがチェックに失敗した場合、エラーメッセージが返されます。リクエストがチェックに合格した場合、`DryRunOperation` エラーコードが返されます。Application Load Balancer インスタンスのプロパティは変更されません。 false（デフォルト）：通常のリクエストを送信します。リクエストがチェックに合格すると、`2xx` ステータスコードが返され、操作が実行されます。	true
LoadBalancerId	string	必須	Application Load Balancer インスタンス ID です。	alb-o9ulmq5hgn68jk****
LoadBalancerName	string	任意	Application Load Balancer インスタンスの名前は、2 文字から 128 文字の長さにする必要があります。名前は英字、中国語文字、または数字で始まる必要があります。名前には、数字、ピリオド (.)、アンダースコア (_)、ハイフン (-)、およびスペースを含めることができます。	alb-instance-test
ModificationProtectionConfig	object	任意	変更保護設定です。
Reason	string	任意	変更保護を有効にする理由です。理由は 2 文字から 128 文字の長さにする必要があります。英字で始まる必要があり、英字、数字、ピリオド (.)、アンダースコア (_)、およびハイフン (-) を含めることができます。このパラメータは、Status が ConsoleProtection に設定されている場合にのみ有効です。	Managed Instance
Status	string	任意	Application Load Balancer インスタンスの変更保護ステータスです。有効な値： NonProtection：変更保護を無効にします。Reason に値を指定した場合、その値はクリアされます。 ConsoleProtection：コンソールでの変更保護を有効にします。Reason に値を指定した場合、その値が有効になります。説明値を ConsoleProtection に設定した場合、Application Load Balancer コンソールでインスタンス設定を変更することはできません。ただし、API を呼び出してインスタンス設定を変更することは可能です。	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.

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

変更履歴

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