AllocateEipAddress - Elastic IP Address - Alibaba Cloud ドキュメントセンター

Elastic IP アドレス (EIP) を申請します。

操作説明

この操作を呼び出す前に、EIP の課金方法および料金についてご確認ください。詳細については、「課金概要」をご参照ください。

この操作を呼び出すと、指定されたリージョンで Available 状態の EIP がランダムに割り当てられます。EIP はトランスポートレイヤーで ICMP、TCP、UDP のみをサポートしています。IGMP および SCTP はサポートされていません。

今すぐお試しください

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

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

vpc:AllocateEipAddress

create

*Address。

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

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
RegionId	string	必須	EIP のリージョン ID。 DescribeRegions 操作を呼び出してリージョン ID をクエリできます。列挙値: cn-beijing : cn-beijing。	cn-hangzhou
Bandwidth	string	任意	EIP の帯域幅の最大値。単位: Mbit/s。 InstanceChargeType が PostPaid にセットされ、InternetChargeType が PayByBandwidth にセットされている場合、Bandwidth の有効な値は 1 ～ 500 です。 InstanceChargeType が PostPaid にセットされ、InternetChargeType が PayByTraffic にセットされている場合、Bandwidth の有効な値は 1 ～ 200 です。 InstanceChargeType が PrePaid にセットされている場合、Bandwidth の有効な値は 1 ～ 1000 です。デフォルト値: 5 Mbit/s。	5
Period	integer	任意	サブスクリプションの持続時間。 PricingCycle が Month にセットされている場合、Period の有効な値は 1 ～ 9 です。 PricingCycle が Year にセットされている場合、Period の有効な値は 1 ～ 5 です。 InstanceChargeType が PrePaid にセットされている場合、このパラメーターは必須です。InstanceChargeType が PostPaid にセットされている場合、このパラメーターは不要です。	1
ISP	string	任意	回線タイプ。有効な値: BGP (デフォルト): BGP (マルチ ISP) 回線。すべてのリージョンで BGP (マルチ ISP) 回線の EIP がサポートされています。 BGP_PRO: BGP (マルチ ISP) プロ版回線。BGP (マルチ ISP) プロ版回線の EIP は、香港 (中国)、シンガポール、日本 (東京)、マレーシア (クアラルンプール)、フィリピン (マニラ)、インドネシア (ジャカルタ)、タイ (バンコク) のリージョンでのみサポートされています。 BGP (マルチ ISP) 回線および BGP (マルチ ISP) プロ版回線の詳細については、「EIP の回線タイプ」をご参照ください。シングル ISP 帯域幅のホワイトリストユーザーである場合は、以下のタイプも選択できます。 ChinaTelecom: China Telecom ChinaUnicom: China Unicom ChinaMobile: China Mobile ChinaTelecom_L2: China Telecom L2 ChinaUnicom_L2: China Unicom L2 ChinaMobile_L2: China Mobile L2 中国 (杭州) 金融クラウドユーザーの場合、このフィールドは必須です。値を BGP_FinanceCloud に設定してください。	BGP
ActivityId	integer	任意	特別アクティビティ ID。このパラメーターを設定する必要はありません。	123456
Netmode	string	任意	ネットワークタイプ。値は public (デフォルト) に設定されており、パブリックネットワークを示します。	public
AutoPay	boolean	任意	自動支払いを有効にするかどうかを指定します。有効な値: false (デフォルト): 自動支払いが無効になっています。注文が生成された後、注文センターに移動して支払いを完了してください。 true: 自動支払いが有効になっています。注文は自動的に支払われます。 InstanceChargeType が PrePaid にセットされている場合、このパラメーターは必須です。InstanceChargeType が PostPaid にセットされている場合、このパラメーターは任意です。	false
PricingCycle	string	任意	サブスクリプションの課金サイクル。有効な値: Month (デフォルト): 月額課金。 Year: 年額課金。 InstanceChargeType が PrePaid に設定されている場合、このパラメーターは必須です。InstanceChargeType が PostPaid に設定されている場合、このパラメーターは任意です。	Month
InstanceChargeType	string	任意	EIP の課金メソッド。有効な値: PrePaid: サブスクリプション。 PostPaid (デフォルト): 従量課金。 InstanceChargeType が PrePaid にセットされている場合、InternetChargeType は PayByBandwidth にセットする必要があります。InstanceChargeType が PostPaid にセットされている場合、InternetChargeType は PayByBandwidth または PayByTraffic にセットできます。	PostPaid
InternetChargeType	string	任意	EIP の課金メソッド。有効な値: PayByBandwidth (デフォルト): 帯域幅課金。 PayByTraffic: データ転送量課金。 InstanceChargeType が PrePaid にセットされている場合、InternetChargeType は PayByBandwidth にセットする必要があります。 InstanceChargeType が PostPaid にセットされている場合、InternetChargeType は PayByBandwidth または PayByTraffic にセットできます。	PayByTraffic
ResourceGroupId	string	任意	リソースグループの ID。	rg-acfmxazffggds****
ClientToken	string	任意	リクエストのべき等性を確保するために使用されるクライアントトークン。異なるリクエスト間で一意性を確保するため、クライアント側で値を生成してください。ClientToken は ASCII 文字のみをサポートしています。説明このパラメーターを指定しない場合、システムは API リクエストの RequestId を ClientToken として使用します。RequestId は API リクエストごとに異なる場合があります。	0c593ea1-3bea-11e9-b96b-88e9fe637760
Name	string	任意	EIP インスタンスの名前。名前の長さは 0 ～ 128 文字で、`http://` または `https://` で始まることはできません。説明サブスクリプション EIP インスタンスを作成する場合、このパラメーターはサポートされていません。	EIP1
Description	string	任意	EIP インスタンスの説明。説明の長さは 0 ～ 256 文字で、`http://` または `https://` で始まることはできません。説明サブスクリプション EIP インスタンスを作成する場合、このパラメーターはサポートされていません。	test
SecurityProtectionTypes	array	任意	セキュリティ保護レベル。このパラメーターが空の場合、デフォルト値は Anti-DDoS Basic です。このパラメーターが AntiDDoS_Enhanced にセットされている場合、値は DDoS 攻撃 (Enhanced) を示します。セキュリティ保護レベルは最大 1 つまで指定できます。	AntiDDoS_Enhanced
	string	任意	セキュリティ保護レベル。このパラメーターが空の場合、デフォルト値は Anti-DDoS Basic です。このパラメーターが AntiDDoS_Enhanced にセットされている場合、値は DDoS 攻撃 (Enhanced) を示します。	AntiDDoS_Enhanced
PublicIpAddressPoolId	string	任意	IP アドレスプールの ID。 EIP は指定された IP アドレスプールから割り当てられます。 IP アドレスプール機能はデフォルトでは有効になっていません。この機能を使用するには、クォータセンターで IP アドレスプールの特典クォータを申請してください。詳細については、「クォータセンターでのクォータの引き上げ」をご参照ください。	pippool-2vc0kxcedhquybdsz****
Zone	string	任意	EIP のゾーン。 PublicIpAddressPoolId で指定された IP アドレスプールが CloudBox タイプである場合、このパラメーターはデフォルトで IP アドレスプールのゾーンになります。 IP アドレスプールのビジネスタイプをビューするフォーマットについては、「 ListPublicIpAddressPools 」をご参照ください。	ap-southeast-1-lzdvn-cb
IpAddress	string	任意	申請する EIP の IP アドレス。 IpAddress と InstanceId のいずれか一方のみを指定する必要があります。どちらも指定されていない場合、システムは EIP をランダムに割り当てます。	192.0.XX.XX
InstanceId	string	任意	申請する EIP のインスタンス ID。 IpAddress と InstanceId のいずれか一方のみを指定する必要があります。どちらも指定されていない場合、システムは EIP をランダムに割り当てます。	eip-25877c70gddh****
Tag	array<object>	任意	リソースのタグ。
	object	任意
Key	string	任意	リソースのタグキー。タグキーは最大 20 個まで指定できます。タグキーを空文字列にすることはできません。タグキーの長さは最大 128 文字です。`aliyun` または `acs:` で始まることはできず、`http://` または `https://` を含めることはできません。	TestKey
Value	string	任意	タグ値。Tag.N.Value フォーマットで値を指定してください。N の有効な値: 1 ～ 20。タグ値を空文字列にすることはできません。タグ値の長さは最大 128 文字です。aliyun または acs: で始まることはできず、http:// または https:// を含めることはできません。	FinanceJoshua

レスポンスフィールド

フィールド	型	説明	例
	object	応答パラメーター。
RequestId	string	リクエスト ID。	4EC47282-1B74-4534-BD0E-403F3EE64CAF
OrderId	integer	注文 ID。このパラメーターは、InstanceChargeType (EIP の課金メソッド) が PrePaid (サブスクリプション) にセットされている場合に返されます。AutoPay (自動支払い) が有効になっていない場合は、注文センターに移動して支払いを完了してください。	10
ResourceGroupId	string	リソースグループの ID。このパラメーターは、InstanceChargeType が PostPaid に設定されている場合にのみ返されます。	rg-acfmxazfdgdg****
EipAddress	string	割り当てられた EIP。このパラメーターは、InstanceChargeType が PostPaid に設定されている場合にのみ返されます。	192.0.XX.XX
AllocationId	string	EIP インスタンスの ID。	eip-25877c70gddh****

例

成功レスポンス

JSONJSON

{
  "RequestId": "4EC47282-1B74-4534-BD0E-403F3EE64CAF",
  "OrderId": 10,
  "ResourceGroupId": "rg-acfmxazfdgdg****",
  "EipAddress": "192.0.XX.XX",
  "AllocationId": "eip-25877c70gddh****"
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ	説明
400	QuotaExceeded.Eip	Elastic IP address quota exceeded
400	InsufficientBalance	Your account does not have enough balance.
400	InvalidParameter	Specified value of "InternetChargeType" is not valid
400	ReserveIpFail	Reserve eip failed.
400	InvalidRegion.NotSupport	The specified region does not support.
400	InvalidBandwidth.Malformed	The specified Bandwidth is invalid.
400	INSTANCE_TYPE_NOT_SUPPORT	The instance type is invalid.
400	QueryParameter.Illegal	query parameter illegal
400	QuotaExceeded.LargeSpecEip	Elastic IP address with large spec quota exceeded.
400	InvalidResourceGroupId	The specified ResourceGroupId does not exist.	リソースグループ ID が存在しません。
400	OperationFailed.InsufficientEIP	Eip resource is not enough.
400	FrequentPurchase.EIP	eip frequent purchase
400	IellgalParameter.OwnerAccount	The specified parameter OwnerAccount is not valid.	指定された OwnerAccount パラメーターが無効です。
400	ResourceNotFound.PublicIpAddressPool	The specified resource of PublicIpAddressPool is not found.
400	ResourceNotEnough.PublicIpAddressPool	The specified resource of PublicIpAddressPool is not enough.
400	Mismatch.IpAndPublicIpAddressPool	The Ip and PublicIpAddressPool are mismatched.
400	OperationDenied.NotOpenDdosOriginProtectService	The operation is not allowed because of you do not open Ddos Origin Protection Service	Anti-DDoS Origin サービスが購入されていないため、DDoS 攻撃 (Enhanced) が有効な EIP を作成できません。
400	IncorrectStatus.PublicIpAddressPool	The status of PublicIpAddressPool is incorrect.	IP アドレスプールのステータスが無効なため、EIP を割り当てられません。
400	IllegalParam.Isp	The param of %s is illegal.	ISP パラメーターが無効なため、EIP を割り当てられません。
400	ExclusiveParam.ZoneAndPublicIpAddressPoolId	The Zone and PublicIpAddressPoolId parameters are mutually exclusive.	Zone パラメーターと PublicIpAddressPoolId パラメーターを同時に指定することはできません。
400	IllegalParam.Zone	The specified zone is invalid.	Zone パラメーターが無効です。
400	OperationFailed.AllocateUnfamiliarIp	The operation failed because only IP addresses used within the last seven days can be allocated.	指定された EIP のアプリケーションでは、過去 7 日以内に使用された IP アドレスのみを申請できます。
400	Ip.Allocated	The reserve ip has been allocated.	予約済み IP アドレスは既に割り当てられています。
400	IncorrectStatus.Ip	The status of ip is incorrect.	IP アドレスのステータスが正しくありません。
400	UnsupportedFeature.AllocateEipAddressWithZone	The feature of AllocateEipAddressWithZone is not supported.	指定されたゾーンは、現在のリージョンでのインスタンス作成をサポートしていません。
400	ResourceNotFound.Ip	The specified ip is not found.	指定された IP アドレスが見つかりません。
400	OperationFailed.ResourceNotEnough	The resources you have applied for are insufficient.	リクエストされたリソースが不足しています。リクエストを続行するには、チケットを提出してください。
400	IllegalParam.Bandwidth	The param of bandwidth is illegal.	指定された帯域幅が無効です。
400	OperationFailed.IpIsLocked	The operation is failed because of ip is locked.	IP アドレスがロック済みであるため、リクエストに失敗しました。
400	Mismatch.EipSecurityProtectionTypeAndPoolSecurityProtectionType	The EipSecurityProtectionType and PoolSecurityProtectionType are mismatched.	EIP のセキュリティ保護タイプがアドレスプールのセキュリティ保護タイプと一致しません。
400	IllegalParam.SecurityProtectionTypes	The param of securityProtectionTypes is illegal.	指定された SecurityProtectionTypes パラメーターが無効です。
400	IllegalParam.ServiceLocation	The param of serviceLocation is illegal.	ServiceLocation パラメーターが無効です。
400	UnsupportedFeature.Isp	The feature of Isp is not supported.	指定された ISP はサポートされていません。
400	ExclusiveParam.ZoneAndIpAddress	The specified param Zone and IpAddress or InstanceId are mutually exclusive.	指定された Zone パラメーターが IpAddress または InstanceId パラメーターと競合しています。
400	InvalidDescription.Malformed	The Description is illeagl.	指定されたリソースの説明のフォーマットが無効です。説明は 2～256 文字で、http:// または https:// で始まることはできません。
400	InvalidName.Malformed	The attribute name is illegal.	指定された名前のフォーマットが無効です。
400	OperationFailed.UpgradeCdtServiceFirst	The operation is failed because of cdt is not upgraded.	指定されたインスタンスタイプには、Cloud Data Transfer (CDT) の課金スペックアップが必要です。CDT をスペックアップしてから再試行してください。
400	OperationFailed.TokenExpired	The operation is failed because of TokenExpired.	指定された EIP 割り当てトークンは期限切れです。
400	QuotaExceeded.LocalISPBasicEip	The quota for Local ISP Provider EIP has been exceeded.	LocalISPBasic EIP のクォータを超えています。
400	QuotaExceeded.LocalISPEip	The quota for Local ISP EIPs has been exceeded.	LocalISP のクォータを超えています。
403	Forbidden	User not authorized to operate on the specified resource.	指定されたリソースを操作する権限がありません。必須の権限を申請してから、もう一度お試しください。

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

変更履歴

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