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

指定されたリージョンに Network Load Balancer (NLB) インスタンスを作成します。

操作説明

NLB インスタンスを作成すると、サービスリンクロール AliyunServiceRoleForNlb が自動的に作成され、お客様に割り当てられます。
CreateLoadBalancer は非同期操作です。リクエストを送信すると、システムはインスタンス ID を返し、タスクをバックグラウンドで実行します。GetLoadBalancerAttribute を呼び出して、NLB インスタンスのステータスをクエリできます。
- NLB インスタンスが Provisioning 状態の場合、NLB インスタンスは作成中です。
- NLB インスタンスが Active 状態の場合、NLB インスタンスは作成されています。

今すぐお試しください

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

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

nlb:CreateLoadBalancer

create

*LoadBalancer

acs:nlb:{#regionId}:{#accountId}:loadbalancer/*

*VSwitch

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

EipAddress

acs:vpc:{#regionId}:{#accountId}:eip/{#AllocationId}

*VPC

acs:vpc:{#regionId}:{#accountId}:vpc/{#VpcId}

nlb:AddressType

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
LoadBalancerType	string	任意	Server Load Balancer (SLB) インスタンスのタイプ。値を network に設定します。これは NLB インスタンスを示します。	network
LoadBalancerName	string	任意	NLB インスタンスの名前。長さは 2〜128 文字で、英字、数字、ピリオド (.)、アンダースコア (_)、ハイフン (-) を使用でき、先頭は英字である必要があります。	NLB1
AddressType	string	必須	NLB インスタンスに使用される IPv4 アドレスのタイプ。有効な値は次のとおりです： Internet：インターネット向けの NLB インスタンスのノードには、パブリック IP アドレスがあります。インターネット向け NLB インスタンスの DNS 名は、ノードのパブリック IP アドレスにパブリックに解決できます。したがって、インターネット向け NLB インスタンスは、インターネット経由でクライアントからのリクエストをルーティングできます。 Intranet：内部向けの NLB インスタンスのノードには、プライベート IP アドレスのみがあります。内部向け NLB インスタンスの DNS 名は、ノードのプライベート IP アドレスにパブリックに解決できます。したがって、内部向け NLB インスタンスは、NLB インスタンスの VPC にアクセスできるクライアントからのリクエストのみをルーティングできます。説明デュアルスタック NLB インスタンスでパブリック IPv6 アドレスを有効にするには、EnableLoadBalancerIpv6Internet 操作を呼び出します。	Internet
AddressIpVersion	string	任意	NLB インスタンスに使用される IP アドレスのバージョン。有効な値： ipv4 (デフォルト) DualStack	ipv4
VpcId	string	必須	NLB インスタンスを作成する VPC の ID。	vpc-bp1b49rqrybk45nio****
ZoneMappings	array<object>	必須	ゾーンと vSwitch 間のマッピング。NLB インスタンスは最大 10 のゾーンにデプロイできます。リージョンが 2 つ以上のゾーンをサポートしている場合は、少なくとも 2 つのゾーンを指定する必要があります。
	object	任意	ゾーンと vSwitch 間のマッピング。NLB インスタンスは最大 10 のゾーンにデプロイできます。リージョンが 2 つ以上のゾーンをサポートしている場合は、少なくとも 2 つのゾーンを指定する必要があります。
VSwitchId	string	必須	ゾーン内の vSwitch の ID。NLB インスタンスの各ゾーンで指定できる vSwitch (サブネット) は 1 つだけです。NLB インスタンスは最大 10 のゾーンにデプロイできます。リージョンが 2 つ以上のゾーンをサポートしている場合は、少なくとも 2 つのゾーンを指定する必要があります。	vsw-sersdf****
ZoneId	string	必須	NLB インスタンスがデプロイされるゾーンの ID。NLB インスタンスは最大 10 のゾーンにデプロイできます。リージョンが 2 つ以上のゾーンをサポートしている場合は、少なくとも 2 つのゾーンを指定する必要があります。 DescribeZones 操作を呼び出して、最新のゾーンリストをクエリできます。	cn-hangzhou-a
PrivateIPv4Address	string	任意	IPv4 バージョンのプライベート仮想 IP アドレス (VIP)。NLB インスタンスが外部サービスを提供するために使用するプライベート IPv4 アドレス。	192.168.10.1
AllocationId	string	任意	インターネット向け NLB インスタンスに関連付けられている Elastic IP Address (EIP) の ID。各ゾーンには 1 つの EIP が割り当てられます。NLB インスタンスは最大 10 のゾーンにデプロイできます。リージョンが 2 つ以上のゾーンをサポートしている場合は、少なくとも 2 つのゾーンを指定する必要があります。	eip-bp1aedxso6u80u0qf****
Ipv6Address	string	任意	IPv6 バージョンの VIP。NLB インスタンスが外部サービスを提供するために使用する IPv6 アドレス。	2408:400a:d5:3080:b409:840a:ca:e8e5
Ipv4LocalAddresses	array	任意	ローカル IPv4 アドレス。NLB インスタンスがバックエンドサーバーと通信するために使用する IP アドレス。IP アドレスの数は偶数である必要があり、最小 2、最大 8 です。
	string	任意	ローカル IPv4 アドレス。	192.168.10.2
Ipv6LocalAddresses	array	任意	ローカル IPv6 アドレス。NLB インスタンスがバックエンドサーバーと通信するために使用する IP アドレス。IP アドレスの数は偶数である必要があり、最小 2、最大 8 です。
	string	任意	ローカル IPv6 アドレス。	2408:400a:d5:3080:b409:840a:ca:e8e6
BandwidthPackageId	string	任意	インターネット向け NLB インスタンスに関連付けられている Internet Shared Bandwidth インスタンスの ID。	cbwp-bp1vevu8h3ieh****
LoadBalancerBillingConfig	object	任意	NLB インスタンスの課金設定。
PayType	string	任意	NLB インスタンスの課金方法。値を PostPay に設定します。これは従量課金方式を指定します。	PostPay
ResourceGroupId	string	任意	インスタンスが属するリソースグループの ID。	rg-atstuj3rtop****
DryRun	boolean	任意	実際にリクエストを行わずにドライランを実行します。有効な値は次のとおりです： true：ドライランのみを実行します。システムは、パラメーター値の欠落、不正なリクエスト構文、サービスの制限など、リクエストに潜在的な問題がないかチェックします。リクエストがチェックに失敗した場合、問題を特定するエラーメッセージが返されます。リクエストが合格した場合、`DryRunOperation` エラーコードが返されます。 false (デフォルト)：リクエストをチェックして操作を実行します。リクエストがチェックに合格した場合、2xx HTTP ステータスコードが返され、操作が実行されます。	false
ClientToken	string	任意	リクエストのべき等性を保証するために使用されるクライアントトークン。クライアントを使用してトークンを生成できます。トークンが異なるリクエスト間で一意であることを確認してください。ASCII 文字のみが許可されます。説明このパラメーターを指定しない場合、RequestId の値が使用されます。** RequestId** の値はリクエストごとに異なります。	123e4567-e89b-12d3-a456-426655440000
RegionId	string	任意	NLB インスタンスがデプロイされているリージョンの ID。 DescribeRegions 操作を呼び出して、最新のリージョンリストをクエリできます。	cn-hangzhou
DeletionProtectionConfig	object	任意	削除保護機能の設定。
Enabled	boolean	任意	削除保護機能を有効にするかどうかを指定します。有効な値： true false (デフォルト)	false
Reason	string	任意	削除保護機能を有効または無効にする理由。理由は 2〜128 文字の長さで、英字、数字、ピリオド (.)、アンダースコア (_)、ハイフン (-) を含めることができ、先頭は英字である必要があります。	The instance is running
ModificationProtectionConfig	object	任意	設定変更保護の設定。
Status	string	任意	設定変更保護を有効にするかどうかを指定します。有効な値： NonProtection：設定変更保護を有効にしません。Reason パラメーターは設定できません。Reason パラメーターが設定されている場合、その値はクリアされます。 ConsoleProtection：設定変更保護を有効にします。Reason パラメーターを設定できます。説明パラメーターが ConsoleProtection に設定されている場合、設定変更保護が有効になります。NLB コンソールで NLB インスタンスの設定を変更することはできません。ただし、API 操作を呼び出して NLB インスタンスの設定を変更することはできます。	ConsoleProtection
Reason	string	任意	設定変更保護を有効にする理由。理由は 2〜128 文字の長さで、英字、数字、ピリオド (.)、アンダースコア (_)、ハイフン (-) を含めることができ、先頭は英字である必要があります。説明このパラメーターは、Status が ConsoleProtection に設定されている場合にのみ有効です。	Service guarantee period
Tag	array<object>	任意	タグ。
	object	任意	タグ。
Key	string	任意	タグのキー。タグキーは最大 64 文字で、`aliyun` または `acs:` で始めることはできず、`http://` または `https://` を含めることはできません。タグキーには、英字、数字、および次の特殊文字を含めることができます：_ . : / = + - @ 各呼び出しで最大 20 個のタグを指定できます。	env
Value	string	任意	タグの値。タグ値は最大 128 文字で、`acs:` または `aliyun` で始めることはできず、`http://` または `https://` を含めることはできません。タグ値には、英字、数字、および次の特殊文字を含めることができます：_ . : / = + - @ 各呼び出しで最大 20 個のタグを指定できます。	product

レスポンスフィールド

フィールド	型	説明	例
	object	応答
RequestId	string	リクエストの ID。	CEF72CEB-54B6-4AE8-B225-F876FF7BA984
LoadbalancerId	string	NLB インスタンスの ID。	nlb-83ckzc8d4xlp8o****
OrderId	integer	NLB インスタンスの注文 ID。	20230000

例

成功レスポンス

JSONJSON

{
  "RequestId": "CEF72CEB-54B6-4AE8-B225-F876FF7BA984",
  "LoadbalancerId": "nlb-83ckzc8d4xlp8o****",
  "OrderId": 20230000
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ	説明
400	OperationDenied.OnlyPayByTrafficSupported	The operation is not allowed because of OnlyPayByTrafficSupported.
400	OperationFailed.%s	The operation failed because of %s.
400	Mismatch.ZoneIdAndVswitchId	The ZoneIdAndVswitchId is mismatched for %s and %s.
400	QuotaExceeded.%s	The quota of %s is exceeded, usage %s/%s.
400	DryRunOperation	Request validation has been passed with DryRun flag set.	日文说明6
400	OperationDenied.OnlyPostPaidSupported	The operation is not allowed because of OnlyPostPaidSupported.
400	OperationFailed.DuplicateZones.	The operation failed because of Can not Specify duplicate zones.
400	ResourceNotEnough.VSwitchIp	The specified resource of VSwitchIp is not enough.
400	DuplicatedParam.AllocationId	The param of AllocationId is duplicated.
400	ResourceInConfiguring.VswitchId	The specified resource of VswitchId is being configured, please try again later.
400	IllegalParam	The param of %s is illegal.
400	OperationFailed.UnpaidBill	The operation failed because of UnpaidBill.
400	OperationDenied.ServiceLinkedRoleNotExist	The operation is not allowed because of ServiceLinkedRoleNotExist.
400	ResourceAlreadyAssociated.AllocationId	The specified resource of %s is already associated.
400	OperationFailed.vSwitchNotSupportIpv6	The operation failed because of vSwitchNotSupportIpv6.
400	InvalidZones	The current zone list is illegal.
400	QuotaExceeded.QuotaInsufficient	The quota of %s is exceeded, usage %s/%s.
400	ResourceInUse.IP	The specified resource of IP is in use.
400	OperationFailed.CreateOrderError	Operation failed because CreateOrderError.
400	OperationFailed.NotExist.ResourceGroup	Operation failed because ResourceGroup not exist.
400	IllegalParam.loadBalancerName	Param loadBalancerName is illegal.
400	SystemBusy	System is busy, please try again later.
400	MissingParam.%s	The parameter of %s is missing.
400	IllegalParam.DeletionProtectionConfig	DeletionProtectionConfig reason is illegal.
400	IllegalParam.ModificationProtectionConfig	ModificationProtectionConfig reason is illegal.
400	Throttling.User	Request was denied due to api flow control.	日文说明2
403	UnauthorizedZone	The specified zone of %s is not authorized.
403	Forbidden.NoPermission	Authentication is failed for NoPermission.
403	UnauthorizedRegion	The specified region of %s is not authorized.
404	ResourceNotFound.VSwitch	The specified resource of vSwitch is not found.
404	ResourceNotFound.Vpc	The specified resource of Vpc is not found.

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

変更履歴

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