指定されたelastic IPアドレス (EIP) を要求します。

デバッグ

OpenAPI Explorer は署名値を自動的に計算します。 この操作は、OpenAPI Explorer で呼び出すことを推奨します。 OpenAPI Explorer は、さまざまな SDK に対して操作のサンプルコードを動的に生成します。

リクエストパラメーター

項目 データ型 必須／任意 例: 説明　
操作 String 必須 AllocateEipAddressPro

実行する操作です。 値をAllocateEipAddressProに設定します。

RegionId String 必須 cn-hangzhou

指定したEIPを要求するリージョンのID。

DescribeRegions を呼び出して、最新のリージョンリストをクエリできます。

IpAddress String 任意 192.0.XX.XX

要求するEIPのIPアドレス。

IpAddressまたはInstanceIdを設定します。 両方のパラメータを空のままにすると、システムはランダムにEIPを割り当てます。

InstanceId String 任意 eip-25877c70gddh****

EIP の ID 。

IpAddressまたはInstanceIdを設定します。 両方のパラメータを空のままにすると、システムはランダムにEIPを割り当てます。

帯域幅 String 任意 5

指定されたEIPの最大帯域幅。 単位：Mbit/秒。

  • InstanceChargeTypeがPostPaidに設定され、InternetChargeTypeがPayByBandwidthに設定されている場合、Bandwidthの有効な値は500に1されます。
  • InstanceChargeTypeがPostPaidに設定され、InternetChargeTypeがPayByTrafficに設定されている場合、帯域幅の有効な値は200に1されます。
  • InstanceChargeTypeがPrePaidに設定されている場合、帯域幅の有効な値は1000に1されます。

デフォルト値: 5 単位：Mbit/秒。

期間 Integer いいえ 1

サブスクリプション期間です。

  • PricingCycleがMonthに設定されている場合、Periodを1〜9の値に設定します。
  • PricingCycleがYearに設定されている場合、Periodを1 ~ 3の値に設定します。

InstanceChargeTypeがPrePaidに設定されている場合、このパラメーターは必須です。

InstanceChargeTypeがPostPaidに設定されている場合、このパラメーターは無視します。

ISP String 任意 BGP

ラインタイプ。 デフォルト値: BGP。

  • BGP (シングルISP) の使用が許可されている場合、有効な値はChinaTelecom、ChinaUnicom、およびChinaMobileです。
  • サービスがChina East 1 Financeにデプロイされている場合、このパラメーターは必須であり、値をBGP_FinanceCloudに設定する必要があります。
Netmode String 任意 パブリック

ネットワークタイプ。 値をインターネットを指定するpublicに設定します。

AutoPay Boolean いいえ 真実

自動支払いを有効にするかどうかを指定します。 有効な値：

  • false: 自動支払いを無効にします。 注文が生成されたら、注文センターにアクセスして支払いを完了する必要があります。
  • true: 自動支払いを有効にします。 支払いは自動的に完了します。

InstanceChargeTypeがPrePaidに設定されている場合、このパラメーターは必須です。 InstanceChargeTypeがPostPaidに設定されている場合、このパラメーターは不要です。

PricingCycle String 任意 月

サブスクリプションEIPの課金サイクル。 有効な値：

  • Month (デフォルト): EIPは月単位で課金されます。
  • 年: EIPは毎年請求されます。

InstanceChargeTypeがPrePaidに設定されている場合、このパラメーターは必須です。 InstanceChargeTypeがPostPaidに設定されている場合、このパラメーターは不要です。

InstanceChargeType String 任意 PostPaid

指定されたEIPの課金方法。 有効な値：

  • PrePaid：サブスクリプション
  • PostPaid (デフォルト): 従量課金

InstanceChargeTypeがPrePaidに設定されている場合、InternetChargeTypeをPayByBandwidthに設定する必要があります。

InstanceChargeTypeがPostPaidに設定されている場合、InternetChargeTypeをPayByBandwidthまたはPayByTrafficに設定します。

InternetChargeType String 任意 帯域幅課金

指定されたEIPの計測方法。 有効な値：

  • PayByBandwidth (デフォルト): 帯域幅課金
  • PayByTraffic: データ転送による支払い

InstanceChargeTypeがPrePaidに設定されている場合、InternetChargeTypeをPayByBandwidthに設定する必要があります。

InstanceChargeTypeがPostPaidに設定されている場合、InternetChargeTypeをPayByBandwidthまたはPayByTrafficに設定します。

ResourceGroupId String 任意 rg-resourcegroup ****

EIPが属するリソースグループのID。

ClientToken String 任意 0c593ea1-3bea-11e9-b96b-88e9fe6 ****

リクエストのべき等性を保証するために使用されるクライアントトークン。

クライアントを使用して値を生成できますが、異なるリクエスト間で一意であることを確認する必要があります。 トークンにはASCII文字のみを含めることができます。

説明 このパラメーターを設定しない場合、システムは自動的にRequestIdをClientTokenとして使用します。 RequestIdは、APIリクエストごとに異なる場合があります。
SecurityProtectionTypes.N String 任意 AntiDDoS_Enhanced

Anti-DDoSのエディション。

  • このパラメーターを設定しない場合、デフォルトでAnti-DDoS Origin Basicが使用されます。
  • 値をAntiDDoS_Enhancedに設定した場合、Anti-DDoS Pro/Premiumが使用されます。

最大10個のEIPに対してAnti-DDoSを設定できます。

PublicIpAddressPoolId String 任意 pippool-2vc0kxcedhquybdsz ****

IPアドレスプールのID。

EIPはIPアドレスプールから割り当てられます。

IPアドレスプール機能は、ホワイトリストにアカウントが含まれているユーザーのみが使用できます。 この機能を使用する場合は、チケットを起票してください。

レスポンスパラメーター

項目 データ型 例: 説明　
RequestId String 4EC47282-1B74-4534-BD0E-403F3EE64CAF

リクエストの ID です。

OrderId Long 20190000

オーダーナンバー。 このパラメーターは、InstanceChargeTypeがPrePaidに設定されている場合にのみ返されます。

ResourceGroupId String rg-resourcegroup ****

リソースグループの ID です。

EipAddress String 192.0.XX.XX

要求されたEIPのIPアドレス。

AllocationId String eip-25877c70gddh****

指定されたEIPのID。

例

リクエストの例

http(s)://[Endpoint]/?Action=AllocateEipAddressPro
&RegionId=cn-hangzhou
&IpAddress=192.0.XX.XX
&InstanceId=eip-25877c70gddh ****
&帯域幅=5
&期間=1
&ISP=BGP
&Netmode=public
&AutoPay=true
&PricingCycle=月
&InstanceChargeType=PostPaid
&InternetChargeType=PayByBandwidth
&ResourceGroupId=rg-resourcegroup ****
&ClientToken=0c593ea1-3bea-11e9-b96b-88e9fe6 ****
&SecurityProtectionTypes=["AntiDDoS_Enhanced"]
&PublicIpAddressPoolId=pippool-2vc0kxcedhquybdsz ****
&共通リクエストパラメータ

正常に処理された場合のレスポンス例

XML 形式 

HTTP/1.1 200 OK
Content-Type:application/xml

<AllocateEipAddressProResponse>
    <RequestId>4EC47282-1B74-4534-BD0E-403F3EE64CAF</RequestId>
    <OrderId>20190000</OrderId>
    <ResourceGroupId>rg-resourcegroup ****</ResourceGroupId>
    <EipAddress>192.0.XX.XX</EipAddress>
    <AllocationId>eip-25877c70gddh ****</AllocationId>
</AllocateEipAddressProResponse>

JSON 形式 

HTTP/1.1 200 OK
Content-Type:application/json

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

エラーコード

HttpCode エラーコード エラーメッセージ 説明　
400 InvalidParameter 指定された "Bandwidth" の値は無効です。 指定された帯域幅の値が無効な場合に返されるエラーメッセージ。
400 InsufficientBalance Your account does not have enough balance. Alibaba Cloudアカウントに十分な残高がない場合に返されるエラーメッセージ。 Alibaba Cloudアカウントを追加して、もう一度お試しください。
400 QuotaExceeded.Eip Elastic IP アドレスの上限を超えました。 EIPの数が上限に達した場合に返されるエラーメッセージ。 より多くのEIPを使用する場合は、NAT Gatewayの使用を推奨します。
400 ReserveIpFail Reserve eip に失敗しました。 システムが指定されたEIPの予約に失敗した場合に返されるエラーメッセージ。
400 InvalidRegion.NotSupport 指定されたリージョンはサポートされていません。 指定されたリージョンで操作がサポートされていない場合に返されるエラーメッセージ。
400 InvalidResourceGroupId 指定されたResourceGroupIdは存在しません。 指定されたリソースグループIDが無効な場合に返されるエラーメッセージ。
400 OperationFailed.AllocateUnfamiliarIp 過去7日間に使用されたIPアドレスのみを割り当てることができるため、操作に失敗しました。 この操作を呼び出して、過去7日間に使用されたEIPを要求できる場合に返されるエラーメッセージ。
400 OrderError.EIP アカウントが注文を作成できませんでした。 システムが注文の生成に失敗した場合に返されるエラーメッセージ。
403 Forbbiden 指定されたリソースで操作する権限のないユーザー。 指定されたリソースに対してこの操作を実行する権限がない場合に返されるエラーメッセージ。 必要な権限を申請し、もう一度お試しください。

エラーコードリストについては、「API エラーセンター」をご参照ください。