CreateVServerGroup - - Alibaba Cloud ドキュメントセンター

vServer グループを作成し、バックエンドサーバーを 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:CreateVServerGroup

create

Instance

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

*LoadBalancer

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

slb:tag
slb:tag
slb:tag

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
Tag	array<object>	任意	タグ。
	object	任意	タグ。
Key	string	任意	タグ N のキー。N の有効値：1～20。タグキーを空の文字列にすることはできません。タグキーは最大 64 文字で、`http://` または `https://` を含めることはできません。タグキーは `aliyun` または `acs:` で始めることはできません。	TestKey
Value	string	任意	タグ値。N の有効値：1～20。タグ値は空の文字列にすることができます。タグ値は最大 128 文字で、`acs:` または `aliyun` で始めることはできません。タグ値に `http://` または `https://` を含めることはできません。	TestValue
RegionId	string	必須	SLB インスタンスがデプロイされているリージョンの ID。	cn-hangzhou
LoadBalancerId	string	必須	Server Load Balancer (SLB) インスタンスの ID。	lb-bp1qjwo61pqz3ahl******
VServerGroupName	string	任意	vServer グループの名前。名前は 1～80 文字で、文字、数字、ハイフン (-)、スラッシュ (/)、ピリオド (.)、アンダースコア (_) を使用できます。	Group1
BackendServers	string	任意	追加するバックエンドサーバー。次のパラメーターを設定します： ServerId：必須。バックエンドサーバーの ID。文字列で ID を指定します。Elastic Compute Service (ECS) インスタンス、エラスティックネットワークインターフェース (ENI)、またはエラスティックコンテナインスタンスの ID を指定できます。ServerId を ENI またはエラスティックコンテナインスタンスの ID に設定する場合は、Type パラメーターを設定する必要があります。 Weight：バックエンドサーバーの重み。有効値：0～100。デフォルト値：100。バックエンドサーバーの重みを 0 に設定した場合、そのバックエンドサーバーにリクエストは転送されません。 Description：任意。バックエンドサーバーの説明。文字列で説明を指定します。説明は 1～80 文字で、文字、数字、ハイフン (-)、スラッシュ (/)、ピリオド (.)、アンダースコア (_) を使用できます。 Type：バックエンドサーバーのタイプ。有効値： ecs (デフォルト)：ECS インスタンス eni：ENI。 eci：エラスティックコンテナインスタンス。説明 ENI とエラスティックコンテナインスタンスは、パフォーマンス専有型 SLB インスタンスのバックエンドサーバーとしてのみ指定できます。 ServerIp：ECS インスタンスまたは 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" }]` 説明実行中のバックエンドサーバーのみを SLB インスタンスに追加できます。最大 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-cige6******
RequestId	string	リクエスト ID。	9DEC9C28-AB05-4DDF-9A78-6B08EC9CE18C
BackendServers	object
BackendServer	array<object>	バックエンドサーバーのリスト。
	object	バックエンドサーバー。
Type	string	バックエンドサーバーのタイプ。有効値： ecs (デフォルト)：ECS インスタンス eni：エラスティックネットワークインターフェース (ENI) eci：エラスティックコンテナインスタンス	eni
Weight	integer	バックエンドサーバーの重み。	100
Description	string	vServer グループの説明。	backend server
Port	integer	バックエンドサーバーが使用するポート。	70
ServerId	string	ECS インスタンスまたは ENI の ID。	eni-hhshhs****

例

成功レスポンス

JSONJSON

{
  "VServerGroupId": "rsp-cige6******",
  "RequestId": "9DEC9C28-AB05-4DDF-9A78-6B08EC9CE18C",
  "BackendServers": {
    "BackendServer": [
      {
        "Type": "eni",
        "Weight": 100,
        "Description": "后端服务器组",
        "Port": 70,
        "ServerId": "eni-hhshhs****"
      }
    ]
  }
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ
400	LBNotSupportIpv6Backend	The specified loadbalancer does not support ipv6 backend.
400	Mismatched.ZoneId	The zone of the server is not matched with the cloud box loadbalancer.
400	InvalidBackendServers.ServerIpConflict	%s.
400	OperationUnsupported.CreateVServerGroup	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	NetworkConflict	%s.
400	InvalidParam.TagValue	%s.
400	InvalidParam.TagKey	%s.
400	SizeLimitExceeded.Tag	%s.
400	MissingParam.TagKey	The param MissingParam.TagKey is missing.
400	VpcSystemBusy	Invoke vpc system busy, please retry later.
400	OperationFailed.Endpoint	The operation failed because of the RegionId is unavailable in this endpoint.
403	UnauthorizedRegion	The specified region of is not authorized.

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

変更履歴

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