UpdateLoadBalancerZones で GWLB ゾーンを追加または削除 - SLB

Gateway Load Balancer (GWLB) インスタンスのゾーンを更新します。

操作説明

この API を使用する前に、Gateway Load Balancer (GWLB) の課金方法と料金について十分に理解していることを確認してください。

UpdateLoadBalancerZones は非同期操作です。リクエストを送信すると、リクエスト ID が返されますが、インスタンスのゾーンとゾーン属性の変更はまだ完了していません。変更タスクはバックグラウンドで実行されています。GetLoadBalancerAttribute を呼び出して、GWLB インスタンスの更新ステータスを照会できます：

GWLB インスタンスが Configuring 状態の場合、インスタンスが更新中であることを示します。
GWLB インスタンスが Active 状態の場合、インスタンスの更新が成功したことを示します。

重要この操作を呼び出す際は、既存のゾーンと新しく追加するゾーンを含め、GWLB インスタンスのすべてのゾーンを指定してください。既存のゾーンを指定しなかった場合、そのゾーンは削除されます。インスタンスの現在のゾーンは、GetLoadBalancerAttribute 操作を呼び出して照会できます。

今すぐお試しください

この 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 ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

gwlb:UpdateLoadBalancerZones

update

*LoadBalancer

acs:gwlb:{#regionId}:{#accountId}:loadbalancer/{#LoadBalancerId}

*VSwitch

acs:vpc:{#regionId}:{#accountId}:vswitch/{#VSwitchId}

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
LoadBalancerId	string	必須	GWLB インスタンスの ID。	gwlb-9njtjmqt7zfcqm****
ZoneMappings	array<object>	必須	ゾーンと vSwitch 間のマッピング。少なくとも 1 つのゾーンを指定する必要があります。最大 20 のゾーンを指定できます。リージョンが 2 つ以上のゾーンをサポートしている場合は、2 つ以上のゾーンを選択することを推奨します。
	object	任意
VSwitchId	string	必須	ゾーン内の vSwitch の ID。GWLB インスタンスの各ゾーンには、1 つの vSwitch (サブネット) のみ指定できます。	vsw-bp1n75pbs77v5q6p3****
ZoneId	string	必須	ゾーン ID。DescribeZones 操作を呼び出して、最新のゾーンリストを照会できます。	cn-hangzhou-h
DryRun	boolean	任意	リクエストのドライランを実行するかどうかを指定します。実際のりクエストは送信されません。有効な値： true：ドライランチェックのみを実行します。システムは、必須パラメーター、リクエスト構文、サービス制限など、リクエストに潜在的な問題がないか確認します。リクエストがドライランに失敗すると、エラーコードが返されます。リクエストがドライランに成功すると、`DryRunOperation` エラーコードが返されます。 false (デフォルト)：ドライランチェックを実行し、チェックに成功すると実際のリクエストを送信します。リクエストがドライランに成功すると、2xx HTTP ステータスコードが返され、操作が実行されます。	false
ClientToken	string	任意	リクエストのべき等性を保証するために使用されるクライアントトークン。クライアントを使用してトークンを生成できますが、異なるリクエスト間でトークンが一意であることを確認する必要があります。クライアントトークンには ASCII 文字のみを含めることができます。説明このパラメーターを指定しない場合、システムは自動的にリクエスト ID をクライアントトークンとして使用します。リクエスト ID はリクエストごとに異なる場合があります。	123e4567-e89b-12d3-a456-42665544****

レスポンスフィールド

フィールド	型	説明	例
	object
RequestId	string	リクエスト ID。	ED8905C2-A4F6-5E43-87B7-6A5DC8757146

例

成功レスポンス

JSONJSON

{
  "RequestId": "ED8905C2-A4F6-5E43-87B7-6A5DC8757146"
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ
400	OperationDenied.VSwitchChangeNotSupport	The operation is not allowed because of VSwitchChangeNotSupport.
400	DuplicatedParam.VSwitchId	The param of VSwitchId is duplicated.
400	DuplicatedParam.ZoneId	The param of ZoneId is duplicated.
400	IllegalParamSize.ZoneMappings	The param size of ZoneMappings is illegal.
400	IncorrectBusinessStatus.LoadBalancer	The business status of %s [%s] is incorrect.
400	IncorrectStatus.LoadBalancer	The status of %s [%s] is incorrect.
400	Mismatch.ZoneIdAndVSwitchId	The ZoneId and VSwitchId are mismatched.
400	MissingParam.LoadBalancerId	The param of LoadBalancerId is missing.
400	OperationDenied.VSwitchNotSupportIpv6	The operation is not allowed because of VSwitchNotSupportIpv6.
400	ResourceAlreadyAssociated.GwlbeAssociated	The specified resource of %s is already associated.
400	ResourceNotEnough.VSwitchIp	The specified resource of VSwitchIp is not enough.
400	ResourceNotFound.LoadBalancer	The specified resource of %s is not found.

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

変更履歴

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