API で Gateway Load Balancer インスタンスを作成 - Gateway Load Balancer

Gateway Load Balancer (GWLB) インスタンスを作成します。

操作説明

この操作を呼び出す前に、GWLB の課金方法と料金を十分に理解していることを確認してください。

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

今すぐお試しください

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

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

gwlb:CreateLoadBalancer

create

*LoadBalancer

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

*VSwitch

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

*VPC

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

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
AddressIpVersion	string	任意	IP バージョン。有効な値： Ipv4 (デフォルト)：IPv4	IPv4
LoadBalancerName	string	任意	GWLB インスタンス名。名前は 2～128 文字で、英字、数字、ピリオド (.)、アンダースコア (_)、ハイフン (-) を使用できます。先頭は英字である必要があります。	testGwlbName
VpcId	string	必須	Virtual Private Cloud (VPC) ID。	vpc-uf6qcgpv22ttrnnjh****
ZoneMappings	array<object>	必須	ゾーンと vSwitch 間のマッピング。少なくとも 1 つのゾーンを指定する必要があります。最大 20 のゾーンを指定できます。リージョンが 2 つ以上のゾーンをサポートしている場合は、少なくとも 2 つのゾーンを指定してください。
	object	任意
VSwitchId	string	必須	ゾーン内の vSwitch の ID。GWLB インスタンスの各ゾーンに指定できる vSwitch (サブネット) は 1 つだけです。	vsw-2f0eb020****
ZoneId	string	必須	ゾーン ID。DescribeZones 操作を呼び出して、最新のゾーンリストを照会できます。	cn-hangzhou-a
Tag	array<object>	任意	インスタンスに追加されるタグ。
	object	任意	タグ。各呼び出しで最大 20 個のタグを指定できます。
Key	string	任意	タグキー。タグキーは空の文字列にできません。最大 128 文字で、`aliyun` または `acs:` で始めることはできず、`http://` または `https://` を含めることはできません。	testTagKey
Value	string	任意	タグ値。最大 256 文字で、`http://` または `https://` を含めることはできません。	testTagValue
ResourceGroupId	string	任意	リソースグループ ID。	rg-acfmwbufq6q3****
DryRun	boolean	任意	実際のリクエストを実行せずに、ドライランを実行するかどうかを指定します。有効な値： true：ドライランのみを実行します。システムは、不足しているパラメーター値、不正なリクエスト構文、サービスの制限など、リクエストの潜在的な問題をチェックします。リクエストがドライランに失敗した場合、エラーコードが返されます。リクエストがドライランに合格した場合、`DryRunOperation` エラーコードが返されます。 false (デフォルト)：ドライランを実行し、実際のリクエストを実行します。リクエストがドライランに合格した場合、2xx HTTP ステータスコードが返され、操作が実行されます。	false
ClientToken	string	任意	リクエストのべき等性を保証するために使用されるクライアントトークンです。クライアントを使用してトークンを生成できますが、トークンが異なるリクエスト間で一意であることを確認する必要があります。クライアントトークンには ASCII 文字のみを含めることができます。説明このパラメーターを指定しない場合、システムは自動的にリクエスト ID をクライアントトークンとして使用します。リクエスト ID はリクエストごとに異なる場合があります。	123e4567-e89b-12d3-a456-426655440000

レスポンスフィールド

フィールド	型	説明	例
	object
LoadBalancerId	string	GWLB インスタンス ID。	gwlb-9njtjmqt7zfcqm****
RequestId	string	リクエスト ID。	00B19438-66BB-58C3-8C2F-DA5B6F95CBDA

例

成功レスポンス

JSONJSON

{
  "LoadBalancerId": "gwlb-9njtjmqt7zfcqm****",
  "RequestId": "00B19438-66BB-58C3-8C2F-DA5B6F95CBDA"
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ
400	DuplicatedParam.ZoneId	The param of ZoneId is duplicated.
400	OperationDenied.VSwitchNotSupportIpv6	The operation is not allowed because of VSwitchNotSupportIpv6.
400	ResourceNotEnough.VSwitchIp	The specified resource of VSwitchIp is not enough.
400	DuplicatedParam.VSwitchId	The param of VSwitchId is duplicated.
400	IllegalParamSize.ZoneMappings	The param size of ZoneMappings is illegal.
400	Mismatch.ZoneIdAndVSwitchId	The ZoneId and VSwitchId are mismatched.
400	QuotaExceeded.LoadBalancersNum	The quota of %s is exceeded for resource %s, usage %s/%s.
400	DuplicatedParam.TagKey	The param of %s is duplicated.
400	IllegalParam.TagKey	The param of %s is illegal.

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

変更履歴

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