指定したリージョンのelastic IPアドレス (EIP) を照会します。

使用上の注意

このAPIを呼び出して、指定したリージョンのEIPに関する情報 (最大帯域幅、課金方法、関連するインスタンスなど) を照会できます。

デバッグ

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

リクエストパラメーター

パラメーター データ型 必須／任意 例 説明
操作 String 必須 DescribeEipAddresses

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

RegionId String 必須 cn-hangzhou

EIPのリージョンID。

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

IncludeReservationData Boolean 任意 true

保留中の注文に関する情報を返すかどうかを指定します。 設定可能な値は以下のとおりです。

  • false (デフォルト): 保留中の注文に関する情報は返されません。
  • true: 保留中の注文に関する情報を返します。
ステータス String 任意 Available

EIPのステータス。 設定可能な値は以下のとおりです。

  • Associating: 関連付けられている
  • 関連付け解除: 関連付け解除中
  • InUse: 割り当て済み
  • 利用可能: 利用可能
EipAddress String 任意 47.75.XX.XX

照会するEIPのIPアドレス。

最大50個のEIPアドレスを入力できます。 IPアドレスはコンマ (,) で区切ります。

説明 EipAddressパラメーターとAllocationIdパラメーターの両方を設定した場合、EipAddressに最大50個のEIPアドレスを入力し、AllocationIdに最大50個のEIP IDを入力できます。
AllocationId String 任意 eip-2zeerraiwb7ujxscd****

照会するEIPのID。

最大50個のEIP IDを入力できます。 IDはコンマ (,) で区切ります。

説明 EipAddressパラメーターとAllocationIdパラメーターの両方を設定した場合、AllocationIdに最大50個のEIP IDを入力し、EipAddressに最大50個のEIPアドレスを入力できます。
SegmentInstanceId String 任意 eipsg-t4nr90yik5oy38xdy****

隣接するEIPグループのID。

ResourceGroupId String 任意 rg-acfmxazb4pcdvf****

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

PageNumber Integer 任意 10

返されるページ数。 既定値：1

PageSize Integer 任意 10

各ページで返されるエントリ数。 最大値: 100。 既定値：10。

ISP String 任意 BGP

ラインタイプ。 設定可能な値は以下のとおりです。

  • BGP: BGP (マルチISP) 。

    最大89の高品質BGPラインが世界中で利用可能です。 China Telecom、China Unicom、China Mobile、China Mobile Tietong、China Netcom、CERNET、China Broadcast Network、Dr. Peng Group、Founderなど、複数のインターネットサービスプロバイダー (ISP) との直接接続は、中国本土。

  • BGP_PRO: BGP (マルチISP) プロ。

    BGP (マルチISP) Proラインは、中国本土へのデータ伝送を最適化し、国際サービスの接続品質を向上させます。 BGP (Multi-ISP) と比較して、BGP (Multi-ISP) Pro回線が中国本土 (データセンターを除く) のユーザーにサービスを提供する場合、中国本土のISPサービスを使用して国境を越えた接続が確立されます。 これにより、ネットワークの待ち時間が減少する。

BGP (マルチISP) 回線はすべてのリージョンでサポートされています。 BGP (マルチISP) Pro回線は、中国 (香港) リージョンでのみサポートされています。

説明 アカウントがBGP (単一ISP) ホワイトリストに含まれている場合、ISPパラメーターをChinaTelecom、ChinaUnicom、またはChinaMobileに設定できます。 ワークロードがChina East 1 Financeにデプロイされている場合、このパラメーターは必須であり、値をBGP_FinanceCloudに設定する必要があります。
Filter.1.Key String 任意 CreationStartTime

リソースのクエリに使用されるフィルターキー。 値をCreationStartTimeに設定します。これは、システムがリソースの作成を開始した時刻です。

Filter.2.Key String 任意 CreationEndTime

リソースのクエリに使用されるフィルターキー。 値をCreationEndTimeに設定します。これは、システムがリソースの作成を完了した時刻です。

Filter.1.Value String 任意 2021-05-22T09:12:00Z

リソースのクエリに使用されるフィルター値。 YYYY-MM-DDThh:mm:ssZ形式で時刻を指定します。 時間は UTC にする必要があります。

Filter.2.Value String 任意 2021-05-22T09:15:00Z

リソースのクエリに使用されるフィルター値。 YYYY-MM-DDThh:mm:ssZ形式で時刻を指定します。 時間は UTC にする必要があります。

LockReason String 任意 financial

EIPがロックされている理由。 設定可能な値は以下のとおりです。

  • financial: 料金滞納のため、EIPはロックされています。
  • security: セキュリティ上の理由からEIPはロックされています。
AssociatedInstanceType String 任意 EcsInstance

EIPを関連付けるクラウドリソースのタイプ。 設定可能な値は以下のとおりです。

  • EcsInstance (デフォルト): 仮想プライベートクラウド (VPC) のECS (Elastic Compute Service) インスタンス
  • SlbInstance: VPCのServer Load Balancer (SLB) インスタンス
  • Nat: NATゲートウェイ
  • HaVip: 高可用性仮想IPアドレス (HAVIP)
  • NetworkInterface: セカンダリelastic network interface (ENI)
    説明 各ECSインスタンス、SLBインスタンス、またはHAVIPに関連付けることができるEIPは1つだけです。 各NATゲートウェイに複数のEIPを関連付けることができます。 セカンダリENIに関連付けることができるEIPの数は、関連付けモードによって異なります。 詳細については、「EIPの概要」をご参照ください。
AssociatedInstanceId String 任意 i-2zebb08phyccdvf****

クラウドリソースのID。

ChargeType String 任意 PostPaid

EIP の課金方法。

値をPostPaid (従量課金) に設定します。

DryRun Boolean 任意 false

操作を実行せずにリクエストのみをチェックするかどうかを指定します。 設定可能な値は以下のとおりです。

  • true: EIPを照会せずにリクエストをチェックします。 システムは、必要なパラメーター、要求構文、および制限をチェックします。 要求がチェックに失敗した場合、エラーメッセージが返されます。 リクエストがチェックに合格すると、DryRunOperationエラーコードが返されます。
  • false (デフォルト): APIリクエストを送信します。 リクエストがチェックに合格すると、2xx HTTPステータスコードが返され、操作が実行されます。
EipName String 任意 EIP-01

EIP の名前。

名前は1 ~ 128文字で、英数字、アンダースコア (_) 、ハイフン (-) を使用できます。 先頭は英字とする必要があります。

SecurityProtectionEnabled Boolean 任意 false

Anti-DDoS Pro/Premiumを有効にするかどうかを指定します。 設定可能な値は以下のとおりです。

  • false (デフォルト): Anti-DDoS Pro/Premiumを無効にします。
  • true: Anti-DDoS Pro/Premiumを有効にします。

レスポンスパラメーター

パラメーター データ型 例 説明
PageSize Integer 10

1 ページあたりで返されるエントリ数。

RequestId String 4EC47282-1B74-4534-BD0E-403F3EE64CAF

リクエストの ID です。

PageNumber Integer 10

返されたページのページ番号を示します。

TotalCount Integer 10

返されたエントリの数。

EipAddresses EipAddressの配列

EIPについての詳細。

EipAddress
ReservationActiveTime String 2021-05-23T16:00:00Z

更新が有効になる時刻。 時刻はYYYY-MM-DDThh:mm:ssZ形式で表示されます。

ステータス String Available

EIPのステータス。 有効な値: 有効な値:

  • Associating: 関連付けられている
  • 関連付け解除: 関連付け解除中
  • InUse: 割り当て済み
  • 利用可能: 利用可能
ReservationOrderType String RENEWCHANGE

更新注文のタイプ。 設定可能な値は以下のとおりです。

  • RENEWCHANGE: アップグレードまたはダウングレードによる更新
  • TEMP_UPGRADE: 一時的なアップグレード
  • アップグレード: アップグレード
割り当て時間 String 2021-04-23T01:37:38Z

EIPが作成された時刻。 時刻はYYYY-MM-DDThh:mm:ssZ形式で表示されます。

Netmode String パブリック

ネットワークタイプを示します。

ChargeType String PostPaid

EIP の課金方法。 設定可能な値は以下のとおりです。

  • PrePaid：サブスクリプション
  • PostPaid： 従量課金
説明 String abc

EIPの説明。

SegmentInstanceId String eipsg-t4nr90yik5oy38xd****

隣接するEIPグループのID。

この値は、隣接するEIPグループをクエリした場合にのみ返されます。

ReservationInternetChargeType String 帯域幅課金

更新後に使用される計測方法が有効になります。 設定可能な値は以下のとおりです。

  • PayByBandwidth: 帯域幅課金
  • PayByTraffic: データ転送による支払い
BandwidthPackageId String cbwp-bp1ego3i4j07ccdvf****

EIP帯域幅プランのID。

IpAddress String 47.75.XX.XX

EIPのIPアドレス。

帯域幅 String 5

EIPの最大帯域幅。 単位：Mbit/秒

ReservationBandwidth String 12

更新後の最大帯域幅が有効になります。 単位：Mbit/秒

EipBandwidth String 101

EIP帯域幅プランに関連付けられていない場合のEIPの最大帯域幅。 単位：Mbit/秒

パラメーター名 String EIP-01

EIP の名前。

InstanceRegionId String cn-hangzhou

関連付けられているインスタンスのリージョンID。

DeletionProtection Boolean true

削除保護が有効かどうかを示します。 設定可能な値は以下のとおりです。

  • true: 有効
  • false: 無効
InstanceId String i-bp15zckdt37cdvf****

関連付けられたインスタンスのID。

SecondLimited Boolean false

レベル2スロットリングが設定されているかどうかを示します。 設定可能な値は以下のとおりです。

  • true: はい
  • false: いいえ
InstanceType String EcsInstance

関連付けられているインスタンスのタイプ。 設定可能な値は以下のとおりです。

  • EcsInstance: VPC内のECSインスタンス
  • SlbInstance: VPC内のSLBインスタンス
  • Nat: NATゲートウェイ
  • HaVip: HAVIP
  • NetworkInterface: セカンダリENI
HDMonitorStatus String false

EIPに対して詳細なモニタリングが有効になっているかどうかを示します。 設定可能な値は以下のとおりです。

  • false: 無効
  • true: 有効
RegionId String cn-hangzhou

EIPのリージョンID。

BandwidthPackageBandwidth String 50

EIPが関連付けられているEIP帯域幅プランの最大帯域幅。 単位：Mbit/秒

ServiceManaged Integer 0

EIPがサービスアカウントによって作成されているかどうかを示します。 設定可能な値は以下のとおりです。

  • 0: なし
  • 1: はい
ExpiredTime String 2021-05-23T02:00:00Z

EIPの有効期限が切れる時刻。 時刻はYYYY-MM-DDThh:mm:ssZ形式で表示されます。

ResourceGroupId String rg-acfmxazcdxs****

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

AllocationId String eip-2zeerraiwb7ujcdvf****

EIP の ID 。

InternetChargeType String 帯域幅課金

EIPの計量方法。 有効な値: 有効な値:

  • PayByBandwidth: 帯域幅課金
  • PayByTraffic: データ転送による支払い
BusinessStatus String 通常

EIPのステータス。 設定可能な値は以下のとおりです。

  • Normal: normal
  • FinancialLocked: ロック
BandwidthPackageType String CommonBandwidthPackage

帯域幅プランのタイプ。 CommonBandwidthPackage (EIP帯域幅プラン) のみが返されます。

HasReservationData String false

更新データが含まれるかどうかを示します。

このパラメーターは、IncludeReservationDataパラメーターがtrueに設定され、一部の注文が有効になっていない場合にのみtrueを返します。

ISP String BGP

ISP。

OperationLocks LockReasonの配列

ロックされたEIPに関する詳細。

LockReason
LockReason String financial

EIPがロックされている理由。 設定可能な値は以下のとおりです。

  • financial: 料金滞納のため、EIPはロックされています。
  • security: セキュリティ上の理由からEIPはロックされています。
AvailableRegions 文字列の配列 cn-hangzhou

EIPのリージョンID。

SecurityProtectionTypes 文字列の配列 AntiDDoS_Enhanced

Anti-DDoSのエディション。

  • このパラメーターが空の場合、Anti-DDoS Originが使用されていることを示します。
  • AntiDDoS_Enhancedが返された場合は、Anti-DDoS Pro/Premiumが使用されていることを示します。

例

リクエストの例

http(s)://[Endpoint]/?Action=DescribeEipAddresses
&RegionId=cn-hangzhou
&IncludeReservationData=true
&ステータス=利用可能
&EipAddress=47.75.XX.XX
&AllocationId=eip-2zeerraiwb7ujxscd ****
&SegmentInstanceId=eipsg-t4nr90yik5oy38xdy ****
&ResourceGroupId=rg-acfmxazb4pcdvf ****
&ページ番号=10
&PageSize=10
&ISP=BGP
&Filter.1.Key=CreationStartTime
&Filter.2.Key=CreationEndTime
&Filter.1.Value=2021-05-22T09:12:00Z
&Filter.2.Value=2021-05-22T09:15:00Z
&LockReason=金融
&AssociatedInstanceType=EcsInstance
&AssociatedInstanceId=i-2zebb08phyccdvf ****
&ChargeType=PostPaid
&DryRun=false
&EipName=EIP-01
&SecurityProtectionEnabled=false
&<共通リクエストパラメーター>

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

XML 形式 

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

<DescribeEipAddressesResponse>
    <PageSize>10</PageSize>
    <RequestId>4EC47282-1B74-4534-BD0E-403F3EE64CAF</RequestId>
    <PageNumber>10</PageNumber>
    <TotalCount>10</TotalCount>
    <EipAddresses>
        <ReservationActiveTime>2021-05-23T16:00:00Z</ReservationActiveTime>
        <Status>Available</Status>
        <ReservationOrderType>RENEWCHANGE</ReservationOrderType>
        <AllocationTime>2021-04-23T01:37:38Z</AllocationTime>
        <Netmode>public</Netmode>
        <ChargeType>PostPaid</ChargeType>
        <説明> abc</説明>
        <SegmentInstanceId>eipsg-t4nr90yik5oy38xd ****</SegmentInstanceId>
        <ReservationInternetChargeType>PayByBandwidth</ReservationInternetChargeType>
        <BandwidthPackageId>cbwp-bp1ego3i4j07ccdvf ****</BandwidthPackageId>
        <IpAddress>47.75.XX.XX</IpAddress>
        <Bandwidth>5</Bandwidth>
        <ReservationBandwidth>12</ReservationBandwidth>
        <EipBandwidth>101</EipBandwidth>
        <名前> EIP-01</名前>
        <InstanceRegionId> cn-hangzhou</InstanceRegionId>
        <DeletionProtection>true</DeletionProtection>
        <InstanceId>i-bp15zckdt37cdvf ****</InstanceId>
        <SecondLimited>false</SecondLimited>
        <InstanceType>EcsInstance</InstanceType>
        <HDMonitorStatus>false</HDMonitorStatus>
        <RegionId>cn-hangzhou</RegionId>
        <BandwidthPackageBandwidth>50</BandwidthPackageBandwidth>
        <ServiceManaged>0</ServiceManaged>
        <ExpiredTime>2021-05-23T02:00:00Z</ExpiredTime>
        <ResourceGroupId>rg-acfmxazcdxs ****</ResourceGroupId>
        <AllocationId>eip-2zeerraiwb7ujcdvf ****</AllocationId>
        <InternetChargeType>PayByBandwidth</InternetChargeType>
        <BusinessStatus>Normal</BusinessStatus>
        <BandwidthPackageType>CommonBandwidthPackage</BandwidthPackageType>
        <HasReservationData>false</HasReservationData>
        <ISP>BGP</ISP>
        <OperationLocks>
            <LockReason> 金融 </LockReason>
        </OperationLocks>
        <AvailableRegions>cn-hangzhou</AvailableRegions>
        <SecurityProtectionTypes>AntiDDoS_Enhanced</SecurityProtectionTypes>
    </EipAddresses>
</DescribeEipAddressesResponse>

JSON 形式 

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

{
  "PageSize" : 10,
  "RequestId" : "4EC47282-1B74-4534-BD0E-403F3EE64CAF" 、
  "PageNumber" : 10、
  "TotalCount" : 10、
  "EipAddresses" : [ {
    "ReservationActiveTime" : "2021-05-23T16:00:00Z" 、
    "ステータス" : "利用可能" 、
    "ReservationOrderType" : "RENEWCHANGE" 、
    "AllocationTime" : "2021-04-23T01:37:38Z" 、
    "Netmode" : "public" 、
    "ChargeType" : "PostPaid" 、
    "Description" : "abc" 、
    "SegmentInstanceId" : "eipsg-t4nr90yik5oy38xd ****" 、
    "ReservationInternetChargeType" : "PayByBandwidth" 、
    "BandwidthPackageId" : "cbwp-bp1ego3i4j07ccdvf ****" 、
    "IpAddress" : "47.75.XX.XX" 、
    "帯域幅" : "5" 、
    "ReservationBandwidth" : "12" 、
    "EipBandwidth" : "101" 、
    "名前" : "EIP-01" 、
    "InstanceRegionId" : "cn-hangzhou" 、
    "DeletionProtection" : true、
    "InstanceId" : "i-bp15zckdt37cdvf ****" 、
    "SecondLimited" : false、
    "InstanceType" : "EcsInstance" 、
    "HDMonitorStatus" : "false" 、
    "RegionId" : "cn-hangzhou" 、
    "BandwidthPackageBandwidth" : "50" 、
    "ServiceManaged" : 0、
    "ExpiredTime" : "2021-05-23T02:00:00Z" 、
    "ResourceGroupId" : "rg-acfmxazcdxs ****" 、
    "AllocationId" : "eip-2zeerraiwb7ujcdvf ****" 、
    "InternetChargeType" : "PayByBandwidth" 、
    "BusinessStatus" : "Normal" 、
    "BandwidthPackageType" : "CommonBandwidthPackage" 、
    "HasReservationData" : "false" 、
    "ISP" : "BGP" 、
    "OperationLocks" : [ {
      "LockReason" : "financial"
    } ],
    "AvailableRegions" : [ "cn-hangzhou"] 、
    "SecurityProtectionTypes" : [ "AntiDDoS_Enhanced"]
  } ]
}

エラーコード

HttpCode エラーコード エラーメッセージ 説明
400 InvalidIAssociatedInstanceType.ValueNotSupported AssociatedInstanceTypeの指定された値はサポートされていません。 AssociatedInstanceTypeが無効な値に設定されている場合に返されるエラーメッセージ。 値が有効かどうかを確認します。
400 InvalidChargeType.ValueNotSupported 指定された ChargeType はサポートされていません。 指定された課金方法がサポートされていない場合に表示されるエラーメッセージ。 サポートされている課金方法を設定します。
400 InvalidResourceGroupId 指定されたResourceGroupIdは存在しません。 指定されたリソースグループIDが無効な場合に返されるエラーメッセージ。
400 OperationUnsupported.ResourceGroupId ResourceGroupはこのリージョンではサポートされていません。 リソースグループ機能が無効になっている場合に返されるエラーメッセージ。
404 Forbidden.RegionNotFound アクセス認証中に指定されたリージョンが見つかりません。 指定されたリージョンが存在しない場合に返されるエラーメッセージ。 指定されたリージョンIDが有効かどうかを確認します。
404 InvalidLockReason.NotFound 指定された LockReason が見つからない。 EIPがロックされている理由が不明な場合に返されるエラーメッセージ。

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