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

指定されたリージョンで作成された EIP を照会します。

操作説明

この操作は、指定されたリージョンで作成された EIP の情報を照会します。これには、最大帯域幅、課金方法、および各 EIP に現在関連付けられているインスタンスのタイプが含まれます。頻繁にディープページングやページスキップを実行すると、Throttling.DeepPageSkip エラーコードが返される場合があります。クエリの周波数を減らすか、順次ページングを使用してください。

今すぐお試しください

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

list

*Address。

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

vpc:tag

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
RegionId	string	必須	EIP のリージョン ID。	cn-hangzhou
IncludeReservationData	boolean	任意	まだ有効になっていないサブスクリプションデータを含めるかどうかを指定します。有効な値:	false
Status	string	任意	EIP のステータス。有効な値:	Available
EipAddress	string	任意	クエリする EIP の IP アドレス。	47.75.XX.XX
AllocationId	string	任意	クエリする EIP インスタンスの ID。	eip-2zeerraiwb7ujxscd****
SegmentInstanceId	string	任意	連続 EIP グループのインスタンス ID。	eipsg-t4nr90yik5oy38xdy****
ResourceGroupId	string	任意	EIP が属するリソースグループの ID。	rg-acfmxazb4pcdvf****
PageNumber	integer	任意	リストのページ番号。デフォルト値: 1。	10
PageSize	integer	任意	ページングクエリにおける 1 ページあたりのエントリ数。最大値: 100。デフォルト値: 10。	10
ISP	string	任意	回線タイプ。有効な値:	BGP
Filter.1.Key	string	任意	リソースをクエリするためのフィルターキー。値は CreationStartTime である必要があり、リソースが作成された開始時刻を指定します。	CreationStartTime
Filter.2.Key	string	任意	リソースをクエリするためのフィルターキー。値は CreationEndTime である必要があり、リソースが作成された終了時刻を指定します。	CreationEndTime
Filter.1.Value	string	任意	リソースをクエリするためのフィルター値。`YYYY-MM-DDThh:mmZ` フォーマットの協定世界時 (UTC) で値を指定します。	2023-01-01T01:00Z
Filter.2.Value	string	任意	リソースをクエリするためのフィルター値。`YYYY-MM-DDThh:mmZ` フォーマットの協定世界時 (UTC) で値を指定します。	2023-01-06T02:00Z
LockReason	string	任意	ロックタイプ。有効な値:	financial
AssociatedInstanceType	string	任意	関連付けるクラウドリソースインスタンスのタイプ。有効な値:	EcsInstance
AssociatedInstanceId	string	任意	クラウドリソースのインスタンス ID。	i-2zebb08phyccdvf****
ChargeType	string	任意	EIP の課金方法。有効な値:	PostPaid
DryRun	boolean	任意	ドライランのみを実行するかどうかを指定します。有効な値:	false
EipName	string	任意	EIP の名前。	EIP-01
Tag	array<object>	任意	EIP をフィルター処理するために使用されるタグ。
	object	任意	EIP をフィルター処理するために使用されるタグ。
Key	string	任意	タグキー。最大 20 個のタグキーを指定できます。タグキーを空文字列にすることはできません。	FinanceDept
Value	string	任意	タグ値。最大 20 個のタグ値を指定できます。タグ値は空文字列でも構いません。	FinanceJoshua
SecurityProtectionEnabled	boolean	任意	Anti-DDoS 攻撃 (Enhanced) が有効かどうかを指定します。有効な値:	false
PublicIpAddressPoolId	string	任意	クエリする EIP が属する IP アドレスプールの ID。	pippool-2vc0kxcedhquybdsz****
ServiceManaged	boolean	任意	インスタンスがホストインスタンスであるかどうかを指定します。有効な値:	false

レスポンスフィールド

フィールド	型	説明	例
	object	返される情報のリスト。
PageSize	integer	1 ページあたりのエントリ数。	10
RequestId	string	リクエスト ID。	4EC47282-1B74-4534-BD0E-403F3EE64CAF
PageNumber	integer	現在のページ番号。	10
TotalCount	integer	エントリの総数。	1
EipAddresses	object
EipAddress	array<object>	EIP の詳細。
	array<object>	EIP の詳細。
ReservationActiveTime	string	更新のアクティブな時間。フォーマット: `YYYY-MM-DDThh:mm:ssZ`。	2021-05-23T16:00:00Z
Status	string	EIP のステータス。	Available
ReservationOrderType	string	更新注文のタイプ。	RENEWCHANGE
AllocationTime	string	EIP が作成された時間。フォーマット: `YYYY-MM-DDThh:mm:ssZ`。	2021-04-23T01:37:38Z
Netmode	string	ネットワークタイプ。値は public で、インターネットを示します。	public
ChargeType	string	EIP の課金方法。有効な値:	PostPaid
Description	string	EIP の説明。	abc
Mode	string	関連付けモード。有効な値:	NAT
SegmentInstanceId	string	連続 EIP グループのインスタンス ID。	eipsg-t4nr90yik5oy38xd****
ReservationInternetChargeType	string	更新時の課金タイプ。	PayByBandwidth
BandwidthPackageId	string	EIP が追加されているインターネット共有帯域幅インスタンスの ID。	cbwp-bp1ego3i4j07ccdvf****
IpAddress	string	EIP の IP アドレス。	47.75.XX.XX
Bandwidth	string	EIP のピーク帯域幅。単位: Mbps。	5
ReservationBandwidth	string	更新帯域幅。単位: Mbps。	12
EipBandwidth	string	EIP がインターネット共有帯域幅インスタンスに追加される前、またはそこから削除された後の帯域幅。単位: Mbps。	101
Name	string	EIP の名前。	EIP-01
PrivateIpAddress	string	EIP がバインドされているセカンダリネットワークインターフェースコントローラー (NIC) インスタンスの非公開 IP アドレス。	192.168.XX.XX
InstanceRegionId	string	現在 EIP に関連付けられているリソースのリージョン ID。	cn-hangzhou
DeletionProtection	boolean	削除保護が有効かどうかを示します。	true
InstanceId	string	現在 EIP に関連付けられているインスタンスの ID。	i-bp15zckdt37cdvf****
SecondLimited	boolean	セカンダリ帯域幅調整が設定されているかどうかを示します。	false
InstanceType	string	現在 EIP に関連付けられているインスタンスのタイプ。	EcsInstance
HDMonitorStatus	string	EIP の秒レベルモニタリングが有効かどうかを示します。	false
RegionId	string	EIP のリージョン ID。	cn-hangzhou
BandwidthPackageBandwidth	string	EIP が追加されているインターネット共有帯域幅インスタンスの帯域幅。単位: Mbps。	50
ServiceManaged	integer	インスタンスがホストインスタンスであるかどうかを指定します。有効な値:	0
ExpiredTime	string	有効期限の時間。フォーマット: `YYYY-MM-DDThh:mm:ssZ`。	2021-05-23T02:00:00Z
ResourceGroupId	string	リソースグループの ID。	rg-acfmxazcdxs****
AllocationId	string	EIP のインスタンス ID。	eip-2zeerraiwb7ujcdvf****
InternetChargeType	string	EIP の課金方法。	PayByBandwidth
BusinessStatus	string	EIP インスタンスのビジネスステータス。	Normal
BandwidthPackageType	string	帯域幅タイプ。CommonBandwidthPackage (インターネット共有帯域幅) のみが返されます。	CommonBandwidthPackage
HasReservationData	string	更新データが存在するかどうかを示します。	false
ISP	string	回線タイプ。	BGP
OperationLocks	object
LockReason	array<object>	ロックの詳細。
	object	ロックの詳細。
LockReason	string	ロックのタイプ。	financial
Tags	object
Tag	array<object>	EIP に関連付けられているタグのリスト。
	object	EIP に関連付けられているタグのリスト。	"Tag": [ { "Value": "000", "Key": "yyy" }, { "Value": "111","Key": "kkk" }
Key	string	EIP のタグキー。	KeyTest
Value	string	EIP のタグ値。	ValueTest
SecurityProtectionTypes	object
SecurityProtectionType	array	セキュリティ保護レベル。
	string	セキュリティ保護レベル。	AntiDDoS_Enhanced
PublicIpAddressPoolId	string	EIP が属する IP アドレスプールの ID。	pippool-2vc0kxcedhquybdsz****
VpcId	string	IPv4 ゲートウェイ特徴が有効で、EIP と同じリージョンにある VPC の ID。	vpc-bp15zckdt37pq72zv****
Zone	string	EIP のゾーン。	ap-southeast-1-lzdvn-cb
BizType	string	EIP のビジネスタイプ。	CloudBox
ServiceID	integer	クラウドサービス管理アカウントの ID。	18726XXXXXXX

例

成功レスポンス

JSONJSON

{
  "PageSize": 10,
  "RequestId": "4EC47282-1B74-4534-BD0E-403F3EE64CAF",
  "PageNumber": 10,
  "TotalCount": 1,
  "EipAddresses": {
    "EipAddress": [
      {
        "ReservationActiveTime": "2021-05-23T16:00:00Z",
        "Status": "Available",
        "ReservationOrderType": "RENEWCHANGE",
        "AllocationTime": "2021-04-23T01:37:38Z",
        "Netmode": "public",
        "ChargeType": "PostPaid",
        "Description": "abc",
        "Mode": "NAT",
        "SegmentInstanceId": "eipsg-t4nr90yik5oy38xd****",
        "ReservationInternetChargeType": "PayByBandwidth",
        "BandwidthPackageId": "cbwp-bp1ego3i4j07ccdvf****",
        "IpAddress": "47.75.XX.XX",
        "Bandwidth": "5",
        "ReservationBandwidth": "12",
        "EipBandwidth": "101",
        "Name": "EIP-01",
        "PrivateIpAddress": "192.168.XX.XX",
        "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": [
            {
              "LockReason": "financial"
            }
          ]
        },
        "Tags": {
          "Tag": [
            {
              "Key": "KeyTest",
              "Value": "ValueTest"
            }
          ]
        },
        "SecurityProtectionTypes": {
          "SecurityProtectionType": [
            "AntiDDoS_Enhanced"
          ]
        },
        "PublicIpAddressPoolId": "pippool-2vc0kxcedhquybdsz****",
        "VpcId": "vpc-bp15zckdt37pq72zv****",
        "Zone": "ap-southeast-1-lzdvn-cb",
        "BizType": "CloudBox",
        "ServiceID": 0
      }
    ]
  }
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ	説明
400	InvalidIAssociatedInstanceType.ValueNotSupported	The specified value of AssociatedInstanceType is not supported.	AssociatedInstanceType の値が無効です。このパラメーターが正しいかどうかを確認してください。
400	InvalidChargeType.ValueNotSupported	The specified ChargeType is not supported.
400	InvalidAliuid	User Id is not valid.
400	InvalidResourceGroupId	The specified ResourceGroupId does not exist.	リソースグループ ID が存在しません。
400	InstanceType.Invalid	InstanceType is not null
400	InstanceIdLength.Exceed	InstanceId length is exceed
400	InvalidTagKey	The tag keys are not valid.	タグインデックスが無効です。
400	InvalidTagValue	The tag values are not valid.	タグ値が無効です。
400	OperationUnsupported.ResourceGroupId	ResourceGroup is not supported in this region.	この操作はサポートされていません。金融クラウドではリソースグループ ID はサポートされていません。
400	IellgalParameter.OwnerAccount	The specified parameter OwnerAccount is not valid.	指定された OwnerAccount パラメーターが無効です。
400	Throttling.DeepPageSkip	Deep page skip throttled. Please reduce the page skip frequency or use sequential pagination.	ディープページネーションのページスキップ頻度が速度制限を引き起こしました。ディープページネーションのページスキップ頻度を下げるか、順次ページネーションを使用してください。
404	InvalidFilterValue	The specified FilterValue is not supported.
404	Forbidden.RegionNotFound	Specified region is not found during access authentication.
404	InvalidFilterKey.NotFound	The specified Filterkey is not supported.
404	InvalidLockReason.NotFound	The specified LockReason is not found

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

変更履歴

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