UpdateLoadBalancer API による ESA ロードバランサー設定の変更 - Edge Security Acceleration - Alibaba Cloud - Edge Security Acceleration

既存のロードバランサーを変更するには、ロードバランサー ID を指定する必要があります。

操作説明

この操作では、ロードバランサーの名前、アクセラレーションステータス、セッション維持ポリシー、高度なトラフィックルーティング設定など、複数の設定を変更します。

重要特定のパラメーターを変更すると、既存のサービスの安定性に影響する可能性があります。慎重に操作してください。

今すぐお試しください

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

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

esa:UpdateLoadBalancer

update

*Site

acs:esa:{#regionId}:{#accountId}:site/{#SiteId}

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
Enabled	boolean	任意	ロードバランサーを有効にするかどうかを指定します。 `true`：ロードバランサーは有効です。 `false`：ロードバランサーは無効です。列挙値: true : true false : false	true
SiteId	integer	必須	サイトの ID です。この ID は、ListSites API を呼び出すことで取得できます。	1159101787****
AdaptiveRouting	object	任意	アドレスプール間のオリジンプル動作を設定します。
FailoverAcrossPools	boolean	任意	アドレスプール間でオリジンプルを実行するかどうかを指定します。 `true`：アドレスプール間のオリジンプルを有効にします。 `false`：アドレスプール間のオリジンプルを無効にします。	false
OriginLevelRetry	boolean	任意
DefaultPools	array	任意	デフォルトアドレスプールの ID のリストです。
	integer	任意	デフォルトアドレスプールの ID です。	96228666776****
FallbackPool	integer	任意	フォールバックアドレスプールの ID です。他のすべてのアドレスプールが利用できない場合、トラフィックはこのプールにルーティングされます。	96228666776****
RandomSteering	object	任意	加重ラウンドロビンの設定です。この設定は、異なるアドレスプールに分散されるトラフィックの重みを制御します。
DefaultWeight	integer	任意	特定の重みが定義されていないすべてのアドレスプールに適用されるデフォルトの重みです。値は 0 以上 100 以下の整数である必要があります。	50
PoolWeights	object	任意	プール ID とそれに対応する重みのマップです。これらの重みは、各バックエンドサーバープールにルーティングされるトラフィックの割合を決定します。
	integer	任意	単一のオリジンプールの重みです。値は 0 以上 100 以下の整数である必要があります。値が 0 の場合、このプールにトラフィックはルーティングされません。	50
Rules	array<object>	任意	特定の条件に対する動作のオーバーライドを定義するルールのリストです。
	array<object>	任意	単一のルールの設定です。
RuleName	string	任意	ルールの名前です。グローバル設定を構成する場合、このパラメーターは必須ではありません。	rule_1
Rule	string	任意	ユーザーリクエストに一致する条件式として指定する、ルールの内容です。グローバル設定を構成する場合、このパラメーターは必須ではありません。使用例：すべての受信リクエストに一致させるには、値を `true` に設定します。特定のリクエストに一致させるには、`(http.host eq "video.example.com")` などのカスタム式に設定します。	http.request.method eq "GET"
RuleEnable	string	任意	ルールが有効かどうかを指定します。グローバル設定を構成する場合、このパラメーターは必須ではありません。有効な値： `on`：有効です。 `off`：無効です。	on
FixedResponse	object	任意	ルールの条件が満たされたときに返す固定レスポンスです。
ContentType	string	任意	HTTP レスポンスヘッダーの `Content-Type` フィールドの値です。	application/json
Location	string	任意	HTTP レスポンスヘッダーの `Location` フィールドの値です。これは通常、リダイレクトに使用されます。	http://www.example.com/index.html
MessageBody	string	任意	レスポンスボディの内容です。	Hello World!
StatusCode	integer	任意	レスポンスの HTTP ステータスコードです。	200
Overrides	any	任意	このルールの条件に一致するリクエストに適用するオーバーライド設定です。これらの設定は、ロードバランサーのメイン設定より優先されます。	{ "adaptive_routing": { "failover_across_pools": true }, "sub_region_pools": { "AL,AT": [ 92298024898**, 92304347804 ], "BG,BY": [ 92298024898 ] }, "default_pools": [ 92298024898, 92304347804 ], "fallback_pool": 92298024898, "location_strategy": { "mode": "resolver_ip", "prefer_ecs": "always" }, "random_steering": { "default_weight": 0.3, "pool_weights": { "92298024898": 0.7, "92304347804": 0.8 } }, "region_pools": { "CN,SEAS": [ 92298024898, 92304347804 ], "SAF,SAS": [ 92304347804** ] }, "session_affinity": "ip", "steering_policy": "geo", "ttl": 30 }
Sequence	integer	任意	ルールの実行優先度です。このパラメーターは省略可能です。このパラメーターを指定しない場合、ルールはリストの順序で実行されます。指定する場合、値は 0 より大きい整数である必要があります。値が大きいほど優先度が高くなります。	1
Terminates	boolean	任意	このルールが一致した後、後続のルールの処理を停止するかどうかを指定します。 `true`：後続のルールの処理を停止します。 `false`：後続のルールの処理を続行します。これがデフォルト値です。	true
SessionAffinity	string	任意	セッションアフィニティの方式です。これにより、同じクライアントからのリクエストが同じオリジンサーバーにルーティングされます。有効な値： `off`：セッションアフィニティを無効にします。 `ip`：クライアント IP アドレスに基づくセッションアフィニティを有効にします。 `cookie`：Cookie に基づくセッションアフィニティを有効にします。	ip
SteeringPolicy	string	任意	トラフィックステアリングポリシーです。これは、アドレスプール間でトラフィックがどのように分散されるかを決定します。	order
Description	string	任意	識別や管理を容易にするための、ロードバランサーの任意の説明です。	Load Balancer Description
Ttl	integer	任意	DNS レコードの TTL (Time-to-Live) です (秒単位)。デフォルトは 30 です。値は 10 以上 600 以下の整数である必要があります。	300
Monitor	object	任意	ヘルスチェックモニターの設定です。
Type	string	任意	ヘルスチェックに使用するプロトコルです (`HTTP` など)。これを `off` に設定すると、ヘルスチェックは実行されません。	HTTP
Method	string	任意	ヘルスチェックに使用する HTTP メソッドです (例: `GET`)。	GET
Port	integer	任意	ヘルスチェックに使用するオリジンサーバー上のポートです。	80
Path	string	任意	ヘルスチェックのためにリクエストするオリジンサーバー上のパスです (例: `/healthcheck`)。	/health
Interval	integer	任意	各ヘルスチェック間の間隔 (秒単位) です (例: `60`)。	100
Timeout	integer	任意	ヘルスチェックのタイムアウト (秒単位) です。値は 1 以上 10 以下の整数である必要があります。	5
ExpectedCodes	string	任意	正常なレスポンスとして期待される HTTP ステータスコードです (例: `200,202`)。	200,202
FollowRedirects	boolean	任意	ヘルスチェックモニターが HTTP リダイレクトに従うかどうかを指定します。 `true`：モニターは HTTP リダイレクトに従います。 `false`：モニターは HTTP リダイレクトに従いません。	true
ConsecutiveUp	integer	任意	オリジンサーバーを正常とみなすために必要な、連続で成功したヘルスチェックの回数です (例: `3`)。	3
ConsecutiveDown	integer	任意	オリジンサーバーを異常とみなすために必要な、連続で失敗したヘルスチェックの回数です (例: `5`)。	5
Header	any	任意	各ヘルスチェックで送信する HTTP リクエストヘッダーです。	{ "host": [ "example1.com", "example2.com" ] }
MonitoringRegion	string	任意	ヘルスチェックが実行されるリージョンです。デフォルト値は `Global` です。 `Global`：世界中のプローブロケーションから実行されます。 `ChineseMainland`：中国本土内のプローブロケーションから実行されます。 `OutsideChineseMainland`：中国本土以外のプローブロケーションから実行されます。列挙値: OutsideChineseMainland : 中国本土以外 ChineseMainland : 中国本土 Global : 全世界	Global
Id	integer	必須	ロードバランサーの ID です。この ID は、ListLoadBalancers API を呼び出すことで取得できます。	95913670174****
RegionPools	any	任意	プライマリリージョンとそれに対応するアドレスプールのマップです。	{ "ENAM": [ 12345678** ], "WNAM": [ 23456789, 23456789** ] }
SubRegionPools	any	任意	セカンダリリージョンとそれに対応するアドレスプールのマップです。複数のセカンダリリージョンに同じアドレスプールを割り当てるには、それらのコードをカンマ区切りの単一のキーに結合します。	{"AL,MO": [92298024898**],"CN-SH,CN-SX,CN-SC":[92304347804,92843536908**]}

レスポンスフィールド

フィールド	型	説明	例
	object	ロードバランサーの更新に成功した場合のレスポンス構造。
RequestId	string	リクエストの ID。	EEEBE525-F576-1196-8DAF-2D70CA3F4D2F

例

成功レスポンス

JSONJSON

{
  "RequestId": "EEEBE525-F576-1196-8DAF-2D70CA3F4D2F\n"
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ
400	InvalidParameter	The specified parameter is invalid.
400	LoadBalancerQuotaCheckFailed	Load balancer enable quota check failed.
400	LoadBalancerNumberExceedQuotaLimit	The number of load balancers you have added has reached the limit of the plan quota. Please delete the unused load balancers or upgrade the plan and try again.
400	LoadBalancerRuleQuotaCheckFailed	Your current plan does not support configuring load balancer custom rules, or the load balancer rules you have added exceed the plan quota limit. Please upgrade the plan or delete the rules that are no longer in use and try again.
400	LoadBalancerPolicyCheckFailed	Your current plan does not support the load balancer scheduling policy. Upgrade the plan and try again.
400	LoadBalancerHealthDetectionQuotaCheckFailed	Your current plan does not allow you to configure the load balancer's health detection. Upgrade the plan and try again.
400	LoadBalancerHealthDetectionIntervalCheckFailed	The configured load balancer health detection interval exceeds the quota range allowed by the plan. Please revise the interval within the range or upgrade the plan and try again.
400	InternalException	Failed to call the service. Try again later or contact technical support.
400	Instance.NotOnline	Your plan is unavailable due to an overdue payment. Complete the payment first.
400	MonitorExpectedBodyInvalid	Invalid response body. Specify a response body that does not exceed 102,400 characters in length in your custom rule.
400	MonitorExpectedCodesInvalid	Invalid expected status code for the probe.Make sure that you specify no more than 10 status codes in the probe settings, and each status code must be 3 to 4 characters in length.Examples: 200, 301, 3xx, 8000, and 88xx.
400	MonitorHeaderInvalid	Invalid request header for the probe. You can add up to 10 request headers, each with 1 to 9 values. The combined length of all headers and values cannot exceed 6,000 characters. You cannot configure the User-Agent header.
400	MonitorMethodNotSupport	Invalid HTTP method for the probe request. Valid values are GET and HEAD.
400	MonitorPathNotSupport	Invalid probe URL path.If you set the probe protocol to HTTP or HTTPS, make sure you specify a probe URL path that does not exceed 1,024 characters in length.
400	MonitorPortNotSupport	Invalid probe port. Specify a valid port from 1 to 65535 for the probe request. Then, try again.
400	MonitorRetriesInvalid	Invalid number of probe retries. Specify an integer from 0 to 5. Then, try again.
400	MonitorTimeoutInvalid	Invalid timeout for the probe. Valid values are 1 to 10.
400	MonitorTypeNotSupport	Invalid protocol. Valid values are off, HTTP, HTTPS, TCP, UDP, ICMP Ping, and SMTP.
400	OriginPoolNotExist	The specified origin pool does not exist or does not belong to your account or website. Check and try again.
400	LoadBalancerNameConflict	The load balancer name or the hostname for the origin pool already exists. Try again with a unique name.
400	LockFailed	The system is handling requests you previously submitted. Try again later.
400	SourceCircleExist	The host record of the resource to be operated on is already the source station of another resource, or the source station of the current resource has been added as a host record. To avoid loopback, modify the host record or source station and retry.
400	LoadBalancerNotExist	The specified load balancer name is invalid or load balancing is not enabled for your website.Make sure that you specify a valid load balancer name and load balancing is enabled. Then, try again.
400	MissingParameter	The specified ArgName is required for this function.
400	CompileRuleError	Rule compilation failed, please check the rule information passed in to ensure that the rule is written according to the syntax described in the document.
400	InstanceNotExist	The instance does not exist. Check whether the specified instance ID is correct or whether the instance belongs to your account.
403	QuotaExceeded	The quota is exceeded.
404	SiteNotFound	The website does not exist or does not belong to you.

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

変更履歴

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