API による CLB vServer グループへのバックエンドサーバー追加 - Classic Load Balancer

vServer グループにバックエンドサーバーを追加します。

今すぐお試しください

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

create

Instance

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

*LoadBalancer

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

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
RegionId	string	必須	Server Load Balancer (SLB) インスタンスのリージョン ID です。	cn-hangzhou
VServerGroupId	string	必須	vServer グループの ID です。	rsp-cige6******
BackendServers	string	必須	追加するバックエンドサーバーを指定します。以下のパラメーターを設定してください。 ServerId：必須。バックエンドサーバーの ID です。文字列で指定します。Elastic Compute Service (ECS) インスタンス、ENI（Elastic Network Interface）、または Elastic Container Instance の ID を指定できます。ENI または Elastic Container Instance の ID を ServerId として指定する場合は、Type パラメーターも設定する必要があります。 Weight：バックエンドサーバーの重みです。有効な値は 0～100 で、デフォルト値は 100 です。バックエンドサーバーの重みを 0 に設定すると、そのサーバーにはリクエストが転送されません。 Description：任意。バックエンドサーバーの説明です。文字列で指定します。長さは 1～80 文字で、英字、数字、ハイフン (-)、スラッシュ (/)、ピリオド (.)、アンダースコア (_) を含めることができます。 Type：バックエンドサーバーの種類です。有効な値は以下のとおりです。 ecs（デフォルト）：ECS インスタンス eni：ENI eci：Elastic Container Instance 説明 ENI および Elastic Container Instance をバックエンドサーバーとして指定できるのは、パフォーマンス専有型 SLB インスタンスのみです。 ServerIp：ENI または Elastic Container Instance の 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" }]` Elastic Container Instance を追加する場合： `[{ "ServerId": "eci-xxxxxxxxx", "Weight": "100", "Type": "eci", "ServerIp": "192.168..", "Port":"80","Description":"test-114" }]` 説明 SLB インスタンスに追加できるのは、実行中のバックエンドサーバーのみです。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
VServerGroupId	string	vServer グループの ID です。	rsp-cige6j******
RequestId	string	リクエスト ID です。	9DEC9C28-AB05-4DDF-9A78-6B******
BackendServers	object
BackendServer	array<object>	バックエンドサーバーです。
	object
Type	string	バックエンドサーバーの種類です。有効な値は以下のとおりです。 ecs（デフォルト）：ECS インスタンス eni：ENI eci：Elastic Container Instance	eni
Weight	integer	バックエンドサーバーの重みです。	100
Description	string	vServer グループの説明です。	The description of the vServer group.
Port	integer	バックエンドサーバーで使用されるポートです。	70
ServerId	string	ECS インスタンスまたは ENI の ID です。	eni-hhshhs****

例

成功レスポンス

JSONJSON

{
  "VServerGroupId": "rsp-cige6j******",
  "RequestId": "9DEC9C28-AB05-4DDF-9A78-6B******",
  "BackendServers": {
    "BackendServer": [
      {
        "Type": "eni",
        "Weight": 100,
        "Description": "The description of the vServer group.",
        "Port": 70,
        "ServerId": "eni-hhshhs****"
      }
    ]
  }
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ
400	InvalidBackendServers.ServerIpConflict	%s.
400	Mismatched.ZoneId	The zone of the server is not matched with the cloud box loadbalancer.
400	OperationUnsupported.AddVServerGroupBackendServers	This type of backend server is not allowed to attached to singleTunnel or anyTunnel lb.
400	IncorrectStatus.RSByPassToas	%s.
400	BackendServer.InvalidType	The specified Type is invalid.
400	BackendServer.ServerRegionIdNotEqual	The specified ServerRegionId must be equal.
400	OperationFailed.InvalidCen	The cen related with this loadbalancer is invalid.
400	IncorrectStatus.CenNotAssociated	The action is invalid because the loadbalancer is not associated with cen.
400	InvalidBackendServers.MissingCenBandWidth	The bandwidth is missing between loadbalancer and backendServers in cen.
400	InvalidBackendServers.VpcNotInCen	The BackendServers is not in the cen associated with the loadbalancer.
400	InvalidServerId.NotExist	The specified ServerId is not exist.
400	MissingParameter.ServerRegionId	The parameter ServerRegionId is required.
400	MissingParameter.VbrId	The parameter VbrId is required.
400	InvalidParameter.ServerRegionId	The parameter ServerRegionId is invalid for crossborder.
400	InvalidVbrId.NotInCen	The VbrId is not in the cen associated with the loadbalancer.
400	InvalidParameter.ZoneNotSupport	The zone does not support the parameter %s.
400	MasterSlaveServerConflict	The servers are conflict for MasterSlaveGroup.
400	OperationFailed.ServiceGroupProcessing	The specified service group is processing.
400	NetworkConflict	%s.
400	SystemBusy	The system is busy.
400	SignatureNonceUsed	Specified signature nonce was used already.
400	VpcSystemBusy	Invoke vpc system busy, please retry later.
400	OperationDeny.LbNotSupportIPv6Server	The specified loadbalancer does not support ipv6 server.
400	OperationBusy	The operation is busy.
404	ResourceNotFound.vServers	The specified enis %s does not exist.
404	ResourceNotFound.Cen	The specified resource Cen %s not Exists.

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

変更履歴

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