AllocateEipAddressPro を呼び出して、カスタムネットワーク構成で使用するための指定された Elastic IP Address (EIP) を割り当てます。
今すぐお試しください
テスト
RAM 認証
リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| RegionId |
string |
必須 |
EIP を割り当てるリージョンの ID です。 最新のリージョン一覧を照会するには、DescribeRegions 操作を呼び出します。 |
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 のピーク帯域幅です。単位：Mbps。
デフォルト値：5。 |
5 |
| Period |
integer |
任意 |
サブスクリプション期間です。
InstanceChargeType が PrePaid に設定されている場合、このパラメーターは必須です。
|
1 |
| ISP |
string |
任意 |
回線タイプです。有効な値は次のとおりです。
BGP（マルチ ISP）および BGP（マルチ ISP）Pro 回線の詳細については、「EIP 回線タイプ」をご参照ください。
|
BGP |
| Netmode |
string |
任意 |
ネットワークタイプです。有効な値は public（デフォルト）のみで、パブリックネットワークを示します。 |
public |
| AutoPay |
boolean |
任意 |
自動支払いを有効にするかどうかを指定します。有効な値は次のとおりです。
このパラメーターは、InstanceChargeType が PrePaid に設定されている場合にのみ必要です。 |
true |
| PricingCycle |
string |
任意 |
サブスクリプション EIP の課金サイクルです。有効な値は次のとおりです。
このパラメーターは、InstanceChargeType が PrePaid（サブスクリプション）に設定されている場合にのみ必要です。 |
Month |
| InstanceChargeType |
string |
任意 |
EIP の課金方法です。有効な値は次のとおりです。
InstanceChargeType が PrePaid に設定されている場合、InternetChargeType は PayByBandwidth に設定する必要があります。 InstanceChargeType が PostPaid に設定されている場合、InternetChargeType は PayByBandwidth または PayByTraffic に設定できます。 |
PostPaid |
| InternetChargeType |
string |
任意 |
EIP の課金方法です。有効な値は次のとおりです。
InstanceChargeType が PrePaid に設定されている場合、InternetChargeType は PayByBandwidth に設定する必要があります。 InstanceChargeType が PostPaid に設定されている場合、InternetChargeType は PayByBandwidth または PayByTraffic に設定できます。 |
PayByBandwidth |
| ResourceGroupId |
string |
任意 |
EIP のリソースグループ ID です。 |
rg-resourcegroup**** |
| Tag |
array<object> |
任意 |
EIP に追加するタグです。 |
|
|
object |
任意 |
|||
| Key |
string |
任意 |
タグキーです。 |
|
| Value |
string |
任意 |
タグ値です。 |
|
| ClientToken |
string |
任意 |
リクエストのべき等性を保証するために使用されるトークンです。 このトークンがリクエスト間で一意であることを保証する必要があります。トークンには ASCII 文字のみを使用できます。 説明
このパラメーターを指定しない場合、システムは自動的にリクエストの RequestId を ClientToken として使用します。RequestId は各 API リクエストごとに異なります。 |
0c593ea1-3bea-11e9-b96b-88e9fe6**** |
| SecurityProtectionTypes |
array |
任意 |
セキュリティ保護レベルです。
|
|
|
string |
任意 |
セキュリティ保護レベルです。
|
||
| PublicIpAddressPoolId |
string |
任意 |
EIP を割り当てる IP アドレスプールの ID です。 この機能はデフォルトで無効になっています。この機能を使用するには、クォータセンターで必要な権限を申請してください。詳細については、「クォータセンターを使用してクォータを増やす」をご参照ください。 |
pippool-2vc0kxcedhquybdsz**** |
レスポンスフィールド
|
フィールド |
型 |
説明 |
例 |
|
object |
レスポンスパラメーターです。 |
||
| RequestId |
string |
リクエスト ID です。 |
4EC47282-1B74-4534-BD0E-403F3EE64CAF |
| OrderId |
integer |
注文 ID です。
|
20190000 |
| ResourceGroupId |
string |
リソースグループ ID です。このパラメーターは、InstanceChargeType が PostPaid に設定されている場合にのみ返されます。 |
rg-resourcegroup**** |
| EipAddress |
string |
EIP の IP アドレスです。このパラメーターは、InstanceChargeType が PostPaid に設定されている場合にのみ返されます。 |
192.0.XX.XX |
| AllocationId |
string |
Elastic IP Address (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 | COMMODITY_NO_EXIST | commodity is not exist | |
| 400 | QuotaExceeded.Eip | Elastic IP address quota exceeded | |
| 400 | InvalidParameter | Specified value of "InternetChargeType" is not valid | |
| 400 | InsufficientBalance | Your account does not have enough balance. | |
| 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 | SYSTEM.UNKNOWN.ERROR | The Account failed to create order. | |
| 400 | TokenVerfiy.Failed | token verify failed. | |
| 400 | OrderFailed | The Account failed to create order. | |
| 400 | QuotaExceeded.LargeSpecEip | Elastic IP address with large spec quota exceeded. | |
| 400 | InvalidResourceGroupId | The specified ResourceGroupId does not exist. | |
| 400 | Invalid.Reserve.Ip | The reserve ip is invalid. | |
| 400 | Ip.Allocated | The reserve ip has been allocated. | |
| 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. | |
| 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 | OrderError.EIP | The Account failed to create order. | |
| 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. | |
| 400 | OperationDenied.IpBelongToOtherUser | The operation is not allowed because of ip belong to other user. | |
| 400 | IncorrectStatus.Ip | The status of ip is incorrect. | |
| 400 | OperationFailed.IpIsLocked | The operation is failed because of ip is locked. | |
| 400 | Mismatch.IpAndIsp | The specified IP address does not match the ISP. | |
| 400 | IncorrectStatus.PublicIpAddressPool | The status of PublicIpAddressPool is incorrect. | |
| 400 | IllegalParam.IpAddress | The specified IpAddress (%s) is illegal. | |
| 400 | OperationFailed.ResourceNotEnough | The resources you have applied for are insufficient. | |
| 400 | Mismatch.EipSecurityProtectionTypeAndPoolSecurityProtectionType | The EipSecurityProtectionType and PoolSecurityProtectionType are mismatched. | |
| 400 | IllegalParam.Isp | The param of Isp [%s] is illegal. | |
| 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. | |
| 404 | InvalidRegionId.NotFound | Specified value of "RegionId" is not supported. | |
| 404 | FUWU_BIZ_COMMODITY_VERIFY_FAIL | ????????, ????????PD. |
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。