DescribeEipAddresses - 查询指定地域的 EIP-云服务器 ECS(ECS)-阿里云帮助中心

DescribeEipAddresses

说明

目前该API接口已标记为弃用，推荐使用替代API：Vpc(2016-04-28) - DescribeEipAddresses。

调试

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

调试

授权信息

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

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

操作

访问级别

资源类型

条件关键字

关联操作

vpc:DescribeEipAddresses

get

*Address

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

无

请求参数

名称	类型	必填	描述	示例值
RegionId	string	是	EIP 所在地域的 ID。您可以调用 DescribeRegions 查询地域 ID。	cn-hangzhou
Status	string	否	EIP 的状态。取值包括 Associating、Unassociating、InUse、Available 和 Releasing。	Available
EipAddress	string	否	要查询的 EIP 地址，最多可输入 50 个，多个地址使用半角逗号分隔。	47.75.XX.XX
AllocationId	string	否	要查询的 EIP 实例 ID，最多可输入 50 个，多个 ID 使用半角逗号分隔。	eip-2zeerraiwb7ujxscd****
ISP	string	否	线路类型。常用取值包括 BGP 和 BGP_PRO。	BGP
PageNumber	integer	否	分页查询的页码。起始值：1。默认值：1。	1
PageSize	integer	否	分页查询时每页的条目数。取值范围：1～100。默认值：10。	10
Filter.1.Key	string	否	第一个筛选键，取值为 CreationStartTime，表示资源创建的开始时间。	CreationStartTime
Filter.2.Key	string	否	第二个筛选键，取值为 CreationEndTime，表示资源创建的结束时间。	CreationEndTime
Filter.1.Value	string	否	第一个筛选值，采用 UTC 时间，格式为 YYYY-MM-DDThh:mmZ。	2023-01-01T01:00Z
Filter.2.Value	string	否	第二个筛选值，采用 UTC 时间，格式为 YYYY-MM-DDThh:mmZ。	2023-01-06T02:00Z
LockReason	string	否	锁定类型。financial 表示欠费锁定，security 表示安全原因锁定。	financial
AssociatedInstanceType	string	否	绑定的云产品实例类型，例如 EcsInstance、SlbInstance、Nat、HaVip、NetworkInterface 或 IpAddress。	EcsInstance
AssociatedInstanceId	string	否	云产品实例 ID。	i-2zebb08phyccdvf****
ChargeType	string	否	EIP 的付费模式。PostPaid 表示按量计费，PrePaid 表示包年包月。	PostPaid

返回参数

名称	类型	描述	示例值
	object	响应数据。
PageSize	integer	每页包含的条目数。
RequestId	string	请求 ID。	4EC47282-1B74-4534-BD0E-403F3EE64CAF
PageNumber	integer	当前页码。
TotalCount	integer	列表条目数。
EipAddresses	object
EipAddress	array<object>	EIP 的详细信息列表。
	array<object>	EIP 详情。
Status	string	EIP 的状态。	Available
AllocationTime	string	EIP 的创建时间，格式为 YYYY-MM-DDThh:mm:ssZ。	2021-04-23T01:37:38Z
ChargeType	string	EIP 的付费模式。PostPaid 表示按量计费，PrePaid 表示包年包月。	PostPaid
InstanceId	string	当前绑定实例的 ID。	i-bp15zckdt37cdvf****
InstanceType	string	当前绑定的实例类型。	EcsInstance
RegionId	string	EIP 所在地域的 ID。	cn-hangzhou
IpAddress	string	EIP 的 IP 地址。	47.75.XX.XX
Bandwidth	string	EIP 的带宽峰值，单位为 Mbps。	5
ExpiredTime	string	到期时间，格式为 YYYY-MM-DDThh:mm:ssZ。	2021-05-23T02:00:00Z
AllocationId	string	EIP 实例 ID。	eip-2zeerraiwb7ujcdvf****
InternetChargeType	string	EIP 的计费方式。PayByBandwidth 表示按固定带宽计费，PayByTraffic 表示按使用流量计费。	PayByBandwidth
EipBandwidth	string	EIP 加入共享带宽之前或退出共享带宽之后的带宽，单位为 Mbps。	101
OperationLocks	object
LockReason	array<object>	锁定详情。
	object	锁定信息。
LockReason	string	锁定类型。financial 表示欠费锁定，security 表示安全原因锁定。	financial

示例

正常返回示例

JSON格式

{
  "PageSize": 0,
  "RequestId": "4EC47282-1B74-4534-BD0E-403F3EE64CAF",
  "PageNumber": 0,
  "TotalCount": 0,
  "EipAddresses": {
    "EipAddress": [
      {
        "Status": "Available",
        "AllocationTime": "2021-04-23T01:37:38Z",
        "ChargeType": "PostPaid",
        "InstanceId": "i-bp15zckdt37cdvf****",
        "InstanceType": "EcsInstance",
        "RegionId": "cn-hangzhou",
        "IpAddress": "47.75.XX.XX",
        "Bandwidth": "5",
        "ExpiredTime": "2021-05-23T02:00:00Z",
        "AllocationId": "eip-2zeerraiwb7ujcdvf****",
        "InternetChargeType": "PayByBandwidth",
        "EipBandwidth": "101",
        "OperationLocks": {
          "LockReason": [
            {
              "LockReason": "financial"
            }
          ]
        }
      }
    ]
  }
}

错误码

HTTP status code	错误码	错误信息	描述
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	ResourceQueryError	The specified resource is queried error.
400	InstanceType.Invalid	InstanceType is not null
400	InvalidParameter	Parameter exceed max length
400	OperationUnsupported.ResourceGroupId	ResourceGroup is not supported in this region.
400	IellgalParameter.OwnerAccount	The specified parameter OwnerAccount is not valid.
400	InvalidResourceGroupId	The specified ResourceGroupId does not exist.
400	OperationFailed.Endpoint	Operation failed because the RegionId is unavailable in this endpoint.
500	InternalError	The request processing has failed due to some unknown error, exception or failure.	内部错误，请重试。
404	Forbidden.RegionNotFound	Specified region is not found during access authentication.
404	InvalidFilterKey.NotFound
404	InvalidFilterValue
404	InvalidLockReason.NotFound	The specified LockReason is not found	指定的锁定类型不存在。

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

变更历史

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