SetBackendServers によるバックエンドサーバーの重み設定 - SLB

バックエンドサーバーの重みを指定します。

今すぐお試しください

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

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

slb:SetBackendServers

update

instance

acs:ecs:{#regionId}:{#accountId}:instance/{#instanceId}

*loadbalancer

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

ecs:tag
slb:tag
slb:tag

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
RegionId	string	任意	Classic Load Balancer (CLB) インスタンスが存在するリージョン ID です。	cn-hangzhou
LoadBalancerId	string	必須	CLB インスタンスの ID です。	lb-bp1qjwo61pqz3a******
BackendServers	string	任意	追加するバックエンドサーバーを指定します。以下のパラメーターを設定してください。 ServerId：必須。バックエンドサーバーの ID です。文字列で指定します。Elastic Compute Service (ECS) インスタンス、弾性ネットワークインターフェース (ENI)、または弾性コンテナーインスタンス (ECI) の ID を指定できます。ENI または ECI の ID を ServerId に指定する場合は、Type パラメーターも設定する必要があります。 Weight：バックエンドサーバーの重みです。有効な値は 0～100 で、デフォルト値は 100 です。バックエンドサーバーの重みを 0 に設定すると、そのサーバーにはリクエストが転送されません。 Description：任意。バックエンドサーバーの説明です。文字列で指定します。長さは 1～80 文字で、英字、数字、ハイフン (-)、スラッシュ (/)、ピリオド (.)、アンダースコア (_) を含めることができます。 Type：バックエンドサーバーの種類です。有効な値は以下のとおりです。 ecs（デフォルト）：ECS インスタンス eni：ENI eci：弾性コンテナーインスタンス説明 ENI および弾性コンテナーインスタンスをバックエンドサーバーとして指定できるのは、パフォーマンス専有型 CLB インスタンスのみです。 ServerIp：ENI または弾性コンテナーインスタンスの IP アドレスです。 Port：バックエンドポートです。例： ECS インスタンス： `[{ "ServerId": "i-xxxxxxxxx", "Weight": "100", "Type": "ecs", "Port":"80","Description":"test-112" }]` ENI： `[{ "ServerId": "eni-xxxxxxxxx", "Weight": "100", "Type": "eni", "ServerIp": "192.168..", "Port":"80","Description":"test-112" }]` 複数の IP アドレスを持つ ENI： `[{ "ServerId": "eni-xxxxxxxxx", "Weight": "100", "Type": "eni", "ServerIp": "192.168..", "Port":"80","Description":"test-113" },{ "ServerId": "eni-xxxxxxxxx", "Weight": "100", "Type": "eni", "ServerIp": "172.166..", "Port":"80","Description":"test-113" }]` 弾性コンテナーインスタンス： `[{ "ServerId": "eci-xxxxxxxxx", "Weight": "100", "Type": "eci", "ServerIp": "192.168..", "Port":"80","Description":"test-114" }]` 説明 CLB インスタンスに追加できるバックエンドサーバーは、実行中のものに限られます。1 回の呼び出しで指定できるバックエンドサーバーの最大数は 20 個です。	[{ "ServerId": "eni-xxxxxxxxx", "Weight": "100", "Type": "eni", "ServerIp": "192.168..", "Port":"80","Description":"test-112" },{ "ServerId": "eni-xxxxxxxxx", "Weight": "100", "Type": "eni", "ServerIp": "172.166..", "Port":"80","Description":"test-113" }]

レスポンスフィールド

フィールド	型	説明	例
	object
LoadBalancerId	string	CLB インスタンスの ID です。	lb-bp1qjwo61pqz3a******
RequestId	string	リクエスト ID です。	365F4154-92F6-4AE4-92F8-7F******
BackendServers	object
BackendServer	array<object>	バックエンドサーバーです。
	object
Type	string	バックエンドサーバーの種類です。有効な値は以下のとおりです。 ecs（デフォルト）：ECS インスタンス eni：ENI eci：弾性コンテナーインスタンス	eni
Weight	string	バックエンドサーバーの重みです。	100
Description	string	バックエンドサーバーの説明です。	The description of the backend server.
ServerId	string	サーバーグループの ID です。	eni-hhshhs****

例

成功レスポンス

JSONJSON

{
  "LoadBalancerId": "lb-bp1qjwo61pqz3a******",
  "RequestId": "365F4154-92F6-4AE4-92F8-7F******",
  "BackendServers": {
    "BackendServer": [
      {
        "Type": "eni",
        "Weight": "100",
        "Description": "The description of the backend server.",
        "ServerId": "eni-hhshhs****"
      }
    ]
  }
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ	説明
400	Mismatched.ZoneId	The zone of the server is not matched with the cloud box loadbalancer.

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

変更履歴

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