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

特定のネットワーク構成要件に合わせて、指定された EIP を割り当てます。

今すぐお試しください

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

create

*Address

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

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
RegionId	string	必須	割り当てる EIP のリージョン ID。 DescribeRegions 操作を呼び出して、リージョン ID をクエリできます。	cn-hangzhou
IpAddress	string	任意	割り当てる EIP の IP アドレス。 IpAddress パラメーターと InstanceId パラメーターのいずれか一方のみを指定する必要があります。どちらも指定しない場合、システムはランダムに EIP を割り当てます。	192.0.XX.XX
InstanceId	string	任意	割り当てる EIP のインスタンス ID。 IpAddress パラメーターと InstanceId パラメーターのいずれか一方のみを指定する必要があります。どちらも指定しない場合、システムはランダムに EIP を割り当てます。	eip-25877c70gddh****
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 ～ 3 です。このパラメーターは、InstanceChargeType が PrePaid にセットされている場合に必須です。 InstanceChargeType が PostPaid にセットされている場合は、このパラメーターをセットしないでください。	1
ISP	string	任意	回線タイプ。有効な値: BGP (デフォルト): BGP (マルチ ISP) 回線。すべてのリージョンで BGP (マルチ ISP) EIP がサポートされています。 BGP_PRO: BGP (マルチ ISP) Pro 回線。BGP (マルチ ISP) Pro EIP は、中国 (香港)、シンガポール、マレーシア (クアラルンプール)、フィリピン (マニラ)、インドネシア (ジャカルタ)、タイ (バンコク) のリージョンでのみサポートされています。 BGP (マルチ ISP) および BGP (マルチ ISP) Pro 回線の詳細については、「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
Netmode	string	任意	ネットワークタイプ。値は public (デフォルト) のみで、パブリックネットワークを示します。	public
AutoPay	boolean	任意	自動支払いを有効にするかどうかを指定します。有効な値: false: 自動支払いを無効にします。注文が生成された後、注文センターに移動して支払いを完了してください。 true: 自動支払いを有効にします。注文は自動的に支払われます。このパラメーターは、InstanceChargeType が PrePaid にセットされている場合に必須です。InstanceChargeType が PostPaid にセットされている場合は任意です。	true
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 にセットできます。	PayByBandwidth
ResourceGroupId	string	任意	EIP が属するリソースグループの ID。	rg-resourcegroup****
Tag	array<object>	任意
	object	任意
Key	string	任意
Value	string	任意
ClientToken	string	任意	リクエストのべき等性を確保するために使用されるクライアントトークン。異なるリクエスト間で一意性を確保するため、クライアント側でパラメーター値を生成してください。ClientToken は ASCII 文字のみをサポートします。説明このパラメーターを指定しない場合、システムは API リクエストの RequestId を ClientToken として使用します。RequestId は API リクエストごとに異なる場合があります。	0c593ea1-3bea-11e9-b96b-88e9fe6****
SecurityProtectionTypes	array	任意	セキュリティ保護レベル。このパラメーターが空の場合、デフォルトで DDoS 攻撃対策 (Basic) が使用されます。このパラメーターが AntiDDoS_Enhanced にセットされている場合、DDoS 攻撃対策 (Enhanced) が使用されます。
	string	任意	セキュリティ保護レベル。このパラメーターが空の場合、デフォルトで DDoS 攻撃対策 (Basic) が使用されます。このパラメーターが AntiDDoS_Enhanced にセットされている場合、DDoS 攻撃対策 (Enhanced) が使用されます。
PublicIpAddressPoolId	string	任意	IP アドレスプールの ID。 EIP は指定された IP アドレスプールから割り当てられます。 IP アドレスプール機能はデフォルトでは利用できません。この機能を使用するには、クォータセンターで IP アドレスプールの特典クォータを申請してください。詳細については、「クォータセンターでのクォータの引き上げ」をご参照ください。	pippool-2vc0kxcedhquybdsz****

レスポンスフィールド

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

例

成功レスポンス

JSONJSON

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

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ	説明
400	FrequentPurchase.EIP	eip frequent purchase
400	QuotaExceeded.Eip	Elastic IP address quota exceeded
400	InvalidParameter	Specified value of "InternetChargeType" is not valid
400	ReserveIpFail	Reserve eip failed.
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	Invalid.Reserve.Ip	The reserve ip is invalid.
400	Ip.Allocated	The reserve ip has been allocated.	予約済み IP アドレスはすでに割り当てられています。
400	Ip.Keeped	The reserve ip been keeped in an hour.
400	OperationFailed.AllocateUnfamiliarIp	The operation failed because only IP addresses used within the last seven days can be allocated.	EIP をリクエストする際は、過去 7 日以内に使用された IP アドレスのみを指定できます。
400	INVALID_INSTANCE_STATUS	The instance status is invalid.
400	OperationFailed.InstanceNotExist	Eip instanceId does not exist.
400	InvalidStatus.ValueNotSupported	The specified status is not supported.
400	OperationFailed.RiskControl	Risk control check failed.	支払メソッドでセキュリティリスクが検出されました。メールまたはコンソールのメッセージ内のリンクから検証を続行し、検証後に注文を再提出してください。
400	ResourceNotEnough.PublicIpAddressPool	The specified resource of PublicIpAddressPool is not enough.
400	Mismatch.IpAndPublicIpAddressPool	The Ip and PublicIpAddressPool are mismatched.
400	ResourceNotFound.PublicIpAddressPool	The specified resource of PublicIpAddressPool is not found.
400	ResourceNotFound.Ip	The specified ip is not found.	指定された IP アドレスが見つかりません。
400	OperationDenied.IpBelongToOtherUser	The operation is not allowed because of ip belong to other user.	リクエストは失敗しました。IP アドレスは他のユーザーに属しています。
400	IncorrectStatus.Ip	The status of ip is incorrect.	IP アドレスの状態が正しくありません。
400	OperationFailed.IpIsLocked	The operation is failed because of ip is locked.	IP アドレスがロック済みであるため、リクエストに失敗しました。
400	Mismatch.IpAndIsp	The specified IP address does not match the ISP.	指定された IP アドレスのリクエストに失敗しました。ISP と IP パラメーターが一致しません。
400	IncorrectStatus.PublicIpAddressPool	The status of PublicIpAddressPool is incorrect.	アドレスプールインスタンスが安定した状態ではありません。EIP の割り当ては許可されていません。
400	IllegalParam.IpAddress	The specified IpAddress (%s) is illegal.	指定された IpAddress が有効ではありません。
400	OperationFailed.ResourceNotEnough	The resources you have applied for are insufficient.	リクエストされたリソースが不足しています。引き続き申請が必要な場合は、チケットを提出してください。
400	Mismatch.EipSecurityProtectionTypeAndPoolSecurityProtectionType	The EipSecurityProtectionType and PoolSecurityProtectionType are mismatched.	EIP のセキュリティ保護タイプがアドレスプールのセキュリティ保護タイプと一致しません。
400	IllegalParam.Isp	The param of Isp [%s] is illegal.	Isp パラメーターが無効です。リクエストパラメーターで指定されている有効な値を入力してください。
500	InternalError	The request processing has failed due to some unknown error, exception or failure.	内部システムエラーが発生しました。
403	Forbidden	User not authorized to operate on the specified resource.	EIP が現在の呼び出し元に属していません。この EIP を使用する権限があるかどうかを確認してください。

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

変更履歴

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