DescribeEnsEipAddresses を使用して EIP をクエリする - ENS - Alibaba Cloud - ENS

DescribeEnsEipAddresses を呼び出して、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 ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

ens:DescribeEnsEipAddresses

list

*All Resource

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
AllocationId	string	任意	EIP インスタンスの ID です。最大 50 個の ID をカンマ区切りで指定できます。	eip-5q9uwkd9bznjpxz8hr6cirnjk
EipAddress	string	任意	EIP の IP アドレスです。最大 50 個の IP アドレスをカンマ区切りで指定できます。	120.XXX.XXX.4
AssociatedInstanceId	string	任意	関連付けられたクラウドサービスインスタンスの ID です。	lb-5t18quoohsrc3xkf86spmnu77
AssociatedInstanceType	string	任意	EIP に関連付けるクラウドサービスインスタンスのタイプです。有効な値は次のとおりです。 EnsInstance：VPC タイプの ENS インスタンス。 SlbInstance：SLB インスタンス。	SlbInstance
Status	string	任意	EIP のステータスです。有効な値は、Associating、Unassociating、InUse、Available です。	InUse
EnsRegionId	string	任意	ENS ノードの ID です。	cn-chengdu-telecom
EipName	string	任意	EIP の名前です。	test
Standby	string	任意	EIP がスタンバイ EIP かどうかを指定します。有効な値は次のとおりです。 true：EIP はスタンバイ EIP です。 false：EIP はスタンバイ EIP ではありません。	true
IcmpReplyEnabled	boolean	任意	ICMP 応答を有効にするかどうかを指定します。有効な値は次のとおりです。 true (デフォルト)：有効 false：無効	false
EnsRegionIds	array	任意	1～100 個の ENS ノード ID の配列です。
	string	任意	ENS ノードの ID です。	cn-chengdu-telecom-4
PageNumber	integer	任意	ページ番号です。デフォルト値は 1 です。	1
PageSize	integer	任意	1 ページあたりのエントリ数です。最大値は 100、デフォルト値は 10 です。	50
LockReason	string	任意	EIP がロックされた理由です。 financial：支払い遅延により EIP がロックされています。	financial

レスポンスフィールド

フィールド	型	説明	例
	object	レスポンスボディです。
RequestId	string	リクエスト ID です。	8629F679-B51D-4194-A1CC-5D8F504C362B
EipAddresses	object		[\"106.14.194.193\"]
EipAddress	array<object>	EIP の詳細です。
	array<object>	EIP の詳細です。
AllocationId	string	EIP インスタンスの ID です。	eip-5sainglpw7qfem3icir4s****
AllocationTime	string	EIP が割り当てられた時刻です。	1624885274000
Bandwidth	integer	EIP のピーク帯域幅 (Mbps) です。有効な値は 5～10000 です。デフォルト値は 5 です。	50
ChargeType	string	EIP の課金方法です。有効な値は次のとおりです。 PrePaid：サブスクリプション課金方法。 PostPaid：従量課金方法。	PostPaid
Description	string	EIP の説明です。	example
InstanceId	string	関連付けられたインスタンスの ID です。	lb-5sc3kum2e0sz34wbqrws9****
InstanceType	string	関連付けられたクラウドリソースのタイプです。有効な値は次のとおりです。 EnsInstance：VPC タイプの ENS インスタンス。 SlbInstance：SLB インスタンス。	SlbInstance
InternetChargeType	string	EIP の課金方法です。有効な値は次のとおりです。 95BandwidthByMonth：95 パーセンタイル帯域幅課金。 PayByBandwidth：帯域幅課金。	95BandwidthByMonth
IpAddress	string	EIP の IP アドレスです。	120.XXX.XXX.4
Name	string	EIP インスタンスの名前です。	test
EnsRegionId	string	ENS ノードの ID です。	cn-xian-telecom
Status	string	EIP のステータスです。有効な値は次のとおりです。 Associating：EIP がリソースに関連付けられています。 Unassociating：EIP がリソースから関連付け解除されています。 InUse：EIP がリソースに関連付けられています。 Available：EIP がリソースに関連付けられていません。	Available
Isp	string	ISP です。有効な値は次のとおりです。 cmcc：China Mobile。 unicom：China Unicom。 telecom：China Telecom。	cmcc
Standby	boolean	EIP がセカンダリ EIP かどうかを指定します。	true
IpStatus	string	EIP の実行ステータスです。このパラメーターは、セカンダリ EIP (`Standby` パラメーターが `true` に設定されている場合) のみ返されます。有効な値は次のとおりです。 Stopped：EIP は停止しています。 Running：EIP は実行中です。 Starting：EIP は起動中です。 Stopping：EIP は停止中です。	Stopped
Tags	object
Tag	array<object>	EIP に追加されたタグです。
	object	キーと値のペアで構成されるタグです。
Value	string	タグ値です。	TestValue
Key	string	タグキーです。	TestKey
TagValue `deprecated`	string	タグ値です。	TestValue
TagKey `deprecated`	string	タグキーです。	TestKey
IcmpReplyEnabled	boolean	ICMP 応答が有効かどうかを指定します。有効な値は次のとおりです。 true：ICMP 応答が有効です。これがデフォルトです。 false：ICMP 応答が無効です。	false
BandwidthPackageBandwidth	integer	関連付けられた共有帯域幅パッケージの帯域幅 (Mbps) です。	100
BandwidthPackageId	string	共有帯域幅パッケージの ID です。	cbwp-5***
OperationLocks	object
Lock	array<object>	EIP のロックです。
	object	ロックの詳細です。
LockReason	string	ロックの理由です。有効な値は次のとおりです。 financial：支払い遅延により EIP がロックされています。	financial
PageNumber	integer	返されたページ番号です。値は 0 より大きい必要があります。デフォルト値は 1 です。	1
PageSize	integer	1 ページあたりの返されたエントリ数です。有効な値は 10～100 です。デフォルト値は 10 です。	50
TotalCount	integer	一致するエントリの総数です。	7

例

成功レスポンス

JSONJSON

{
  "RequestId": "8629F679-B51D-4194-A1CC-5D8F504C362B",
  "EipAddresses": {
    "EipAddress": [
      {
        "AllocationId": "eip-5sainglpw7qfem3icir4s****",
        "AllocationTime": "1624885274000",
        "Bandwidth": 50,
        "ChargeType": "PostPaid",
        "Description": "example",
        "InstanceId": "lb-5sc3kum2e0sz34wbqrws9****",
        "InstanceType": "SlbInstance",
        "InternetChargeType": "95BandwidthByMonth",
        "IpAddress": "120.XXX.XXX.4",
        "Name": "test",
        "EnsRegionId": "cn-xian-telecom",
        "Status": "Available",
        "Isp": "cmcc",
        "Standby": true,
        "IpStatus": "Stopped",
        "Tags": {
          "Tag": [
            {
              "Value": "TestValue",
              "Key": "TestKey",
              "TagValue": "TestValue",
              "TagKey": "TestKey"
            }
          ]
        },
        "IcmpReplyEnabled": false,
        "BandwidthPackageBandwidth": 100,
        "BandwidthPackageId": "cbwp-5***",
        "OperationLocks": {
          "Lock": [
            {
              "LockReason": "financial"
            }
          ]
        }
      }
    ]
  },
  "PageNumber": 1,
  "PageSize": 50,
  "TotalCount": 7
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ	説明
400	ens.interface.error	Failed to call API.
400	NoPermission	Permission denied.

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

変更履歴

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