使用DescribeEnsEipAddresses查询弹性公网IP列表-边缘节点服务 ENS-阿里云

调用DescribeEnsEipAddresses查询弹性公网IP（EIP）。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

ens:DescribeEnsEipAddresses

list

*全部资源

*

无

请求参数

名称	类型	必填	描述	示例值
AllocationId	string	否	要查询的 EIP 实例的 ID。最多支持输入 50 个 EIP 实例 ID，实例 ID 之间用半角逗号（,）分隔。	eip-5q9uwkd9bznjpxz8hr6cirnjk
EipAddress	string	否	要查询的 EIP 的 IP 地址。最多支持输入 50 个 EIP 的 IP 地址，IP 地址之间用半角逗号（,）分隔。	120.XXX.XXX.4
AssociatedInstanceId	string	否	云产品的实例 ID	lb-5t18quoohsrc3xkf86spmnu77
AssociatedInstanceType	string	否	要绑定的云产品实例的类型，取值： EnsInstance：VPC 类型的 ENS 实例。 SlbInstance：负载均衡实例。	SlbInstance
EnsRegionId	string	否	ENS 的节点 ID。	cn-chengdu-telecom
EipName	string	否	EIP 的名称。	test
Standby	string	否	是否备用弹性 IP。取值： true：备用。 false：非备用。	true
IcmpReplyEnabled	boolean	否	是否开启 ICMP 代回。取值： true（默认值）：开启。 false：不开启。	false
EnsRegionIds	array	否	ENS 节点 ID 数组。数组长度：1~100。
	string	否	ENS 节点 ID。	cn-chengdu-telecom-4
PageNumber	integer	否	列表的页码，默认值为 1。	1
PageSize	integer	否	分页查询时每页的行数，最大值为 100，默认值为 10。	50

返回参数

名称	类型	描述	示例值
	object	Schema of Response
RequestId	string	请求 ID。	8629F679-B51D-4194-A1CC-5D8F504C362B
EipAddresses	object
EipAddress	array<object>	EIP 的详细信息。
	array<object>	EIP 的详细信息。
AllocationId	string	EIP 的实例 ID。	eip-5sainglpw7qfem3icir4s****
AllocationTime	string	EIP 的创建时间	1624885274000
Bandwidth	integer	EIP 的带宽峰值，默认值为 5。取值范围：5~10000，单位：Mbps。	50
ChargeType	string	EIP 的计费模式。 PrePaid：包年包月。 PostPaid：按量计费。	PostPaid
Description	string	EIP 的描述信息。	example
InstanceId	string	当前绑定的实例的 ID。	lb-5sc3kum2e0sz34wbqrws9****
InstanceType	string	要绑定的云产品实例的类型，取值： EnsInstance：VPC 类型的 ENS 实例。 SlbInstance：负载均衡实例。	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：绑定中。 Unassociating：解绑中。 InUse：已分配。 Available：可用。	Available
Isp	string	运营商，取值： cmcc：中国移动。 unicom：中国联通。 telecom：中国电信。	cmcc
Standby	boolean	该 EIP 是否是备用。	true
IpStatus	string	如果该弹性 IP 是备用 EIP 时，表示当前 EIP 的运行状态。 Stopped：已停止。 Running：运行中。 Starting：启动中。 Stopping：停止中。	Stopped
Tags	object
Tag	array<object>	标签集合。
	object	标签集合。
Value	string	标签值。	TestValue
Key	string	标签键	TestKey
TagValue `deprecated`	string	标签值。	TestValue
TagKey `deprecated`	string	标签键。	TestKey
IcmpReplyEnabled	boolean	是否开启 ICMP 代回。取值： true（默认值）：开启。 false：不开启。	false
PageNumber	integer	查询列表的页码。取值：>0，默认查询第 1 页。	1
PageSize	integer	分页查询时设置的每页行数。默认值：10，取值：10~100。	50
TotalCount	integer	列表条目数。	7

示例

正常返回示例

JSON格式

{
  "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
      }
    ]
  },
  "PageNumber": 1,
  "PageSize": 50,
  "TotalCount": 7
}

错误码

HTTP status code	错误码	错误信息	描述
400	ens.interface.error	Failed to call API.	接口调用发生异常。
400	NoPermission	Permission denied.

访问错误中心查看更多错误码。

变更历史

更多信息，参考变更详情。