文档

DescribeEipAddresses - 查询指定地域已创建的EIP

更新时间:

查询指定地域已创建的EIP。

接口说明

本接口可以查询指定地域已创建的 EIP 信息,包括 EIP 的带宽峰值、计费方式,当前绑定的实例类型等。

调试

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

授权信息

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

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
vpc:DescribeEipAddressesList
  • Address
    acs:vpc:{#regionId}:{#accountId}:eip/*
  • vpc:tag

请求参数

名称类型必填描述示例值
RegionIdstring

EIP 所在的地域 ID。

您可以通过调用 DescribeRegions 接口获取地域 ID。

cn-hangzhou
IncludeReservationDataboolean

是否包含未生效的订购数据,取值:

  • false(默认值):不包含未生效的订购数据。

  • true:包含未生效的订购数据。

false
Statusstring

EIP 的状态,取值:

  • Associating:绑定中。

  • Unassociating:解绑中。

  • InUse:已分配。

  • Available:可用。

  • Releasing:释放中。

Available
EipAddressstring

要查询的 EIP 的 IP 地址。

最多支持输入 50 个 EIP 的 IP 地址,IP 地址之间用半角逗号(,)分隔。

说明 如果同时传入 EipAddressAllocationId 参数,EipAddress 可输入 50 个 EIP 的 IP 地址,AllocationId 也可同时输入 50 个 EIP 的实例 ID。
47.75.XX.XX
AllocationIdstring

要查询的 EIP 实例的 ID。

最多支持输入 50 个 EIP 实例 ID,实例 ID 之间用半角逗号(,)分隔。

说明 如果同时传入 EipAddressAllocationId 参数,AllocationId 可输入 50 个 EIP 的实例 ID,EipAddress 也可同时输入 50 个 EIP 的 IP 地址。
eip-2zeerraiwb7ujxscd****
SegmentInstanceIdstring

连续 EIP 的实例 ID。

eipsg-t4nr90yik5oy38xdy****
ResourceGroupIdstring

EIP 所属的资源组的 ID。

rg-acfmxazb4pcdvf****
PageNumberinteger

列表的页码。默认值:1

10
PageSizeinteger

分页查询时每页的行数。最大值:100。默认值:10

10
ISPstring

线路类型。取值:

  • BGP(默认值):BGP(多线)线路。目前全部地域都支持 BGP(多线)线路 EIP。
  • BGP_PRO:BGP(多线)_精品线路。目前仅中国香港、新加坡、日本(东京)、马来西亚(吉隆坡)、菲律宾(马尼拉)、印度尼西亚(雅加达)和泰国(曼谷)地域支持 BGP(多线)_精品线路 EIP。

关于 BGP(多线)线路和 BGP(多线)_精品线路的更多信息,请参见 EIP 线路类型

如果您是单线带宽的白名单用户,您还可以选择以下类型:

  • ChinaTelecom:中国电信
  • ChinaUnicom:中国联通
  • ChinaMobile:中国移动
  • ChinaTelecom_L2:中国电信 L2
  • ChinaUnicom_L2:中国联通 L2
  • ChinaMobile_L2:中国移动 L2

如果您是杭州金融云用户,该字段必填,取值:BGP_FinanceCloud

BGP
Filter.1.Keystring

查询资源时的筛选键,必须取值为 CreationStartTime(资源创建的开始时间)。

CreationStartTime
Filter.2.Keystring

查询资源时的筛选键,必须取值为 CreationEndTime(资源创建的结束时间)。

CreationEndTime
Filter.1.Valuestring

查询资源时的筛选值。使用 UTC 时间,格式为YYYY-MM-DDThh:mmZ

2023-01-01T01:00Z
Filter.2.Valuestring

查询资源时的筛选值。使用 UTC 时间,格式为YYYY-MM-DDThh:mmZ

2023-01-06T02:00Z
LockReasonstring

锁定类型,取值:

  • financial:因欠费被锁定。

  • security:因安全原因被锁定。

financial
AssociatedInstanceTypestring

要绑定的云产品实例的类型,取值:

  • EcsInstance(默认值):VPC 类型的 ECS 实例。
  • SlbInstance:VPC 类型的 CLB 实例。
  • Nat:NAT 网关。
  • HaVip:高可用虚拟 IP。
  • NetworkInterface:辅助弹性网卡。
  • IpAddress:IP 地址。
说明 每个 ECS 实例、CLB 实例、高可用虚拟 IP 和 IP 地址同时只能绑定一个 EIP,NAT 网关可以绑定多个 EIP。辅助弹性网卡可以绑定 EIP 的个数受 EIP 绑定模式影响,更多信息,请参见弹性公网 IP 概述
EcsInstance
AssociatedInstanceIdstring

云产品的实例 ID。

i-2zebb08phyccdvf****
ChargeTypestring

EIP 的付费模式,取值:

  • PostPaid:按量计费。
  • PrePaid:包年包月。
PostPaid
DryRunboolean

是否只预检此次请求,取值:

  • true:发送检查请求,不会查询资源状况。检查项包括是否填写了必需参数、请求格式、业务限制。如果检查不通过,则返回对应错误。如果检查通过,则返回错误码DryRunOperation

  • false(默认值):发送正常请求,通过检查后返回 HTTP 2xx 状态码并直接进行操作。

false
EipNamestring

EIP 的名称。

长度为 1~128 个字符,必须以字母或中文开头,可包含数字、下划线(_)和短划线(-)。

EIP-01
Tagobject []

指定标签筛选 EIP。

Keystring

标签键。最多支持输入 20 个标签键。一旦传入该值,则不允许为空字符串。

一个标签键最多支持 128 个字符,不能以aliyunacs:开头,不能包含http://或者https://

FinanceDept
Valuestring

标签值。最多支持输入 20 个标签值。一旦传入该值,可以为空字符串。

一个标签值最多支持 128 个字符,不能以aliyunacs:开头,不能包含http://或者https://

FinanceJoshua
SecurityProtectionEnabledboolean

是否开启了 DDoS 防护(增强版)。取值:

  • false:未开启。
  • true:已开启。
false
PublicIpAddressPoolIdstring

要查询的 EIP 所属 IP 地址池 ID。

pippool-2vc0kxcedhquybdsz****
ServiceManagedboolean

是否为托管实例。取值:

  • true:是托管实例。
  • false:不是托管实例。

不填默认查询所有实例。

false

返回参数

名称类型描述示例值
object

返回信息列表。

PageSizeinteger

每页包含的条目数。

10
RequestIdstring

请求 ID。

4EC47282-1B74-4534-BD0E-403F3EE64CAF
PageNumberinteger

当前页码。

10
TotalCountinteger

列表条目数。

1
EipAddressesobject []

EIP 的详细信息。

ReservationActiveTimestring

续费生效时间,格式为YYYY-MM-DDThh:mm:ssZ

2021-05-23T16:00:00Z
Statusstring

EIP 的状态。

  • Associating:绑定中。

  • Unassociating:解绑中。

  • InUse:已分配。

  • Available:可用。

  • Releasing:释放中。

Available
ReservationOrderTypestring

续费订单类型。

  • RENEWCHANGE:续费变配。
  • TEMP_UPGRADE:短时升配。
  • UPGRADE :升级。
RENEWCHANGE
AllocationTimestring

EIP 的创建时间,格式为YYYY-MM-DDThh:mm:ssZ

2021-04-23T01:37:38Z
Netmodestring

网络类型。仅取值:public,表示公网。

public
ChargeTypestring

EIP 的付费模式,取值:

  • PostPaid:按量计费。
  • PrePaid:包年包月。
PostPaid
Descriptionstring

EIP 的描述信息。

abc
Modestring

绑定模式,取值:

  • NAT:NAT 模式(普通模式)。

  • MULTI_BINDED:多 EIP 网卡可见模式。

  • BINDED:EIP 网卡可见模式。

NAT
SegmentInstanceIdstring

连续 EIP 的实例 ID。

仅 EIP 属于连续 EIP 时才会返回该参数值。

eipsg-t4nr90yik5oy38xd****
ReservationInternetChargeTypestring

续费付费类型。

  • PayByBandwidth:按固定带宽计费。

  • PayByTraffic:按使用流量计费。

PayByBandwidth
BandwidthPackageIdstring

加入的共享带宽 ID。

cbwp-bp1ego3i4j07ccdvf****
IpAddressstring

EIP 的 IP 地址。

47.75.XX.XX
Bandwidthstring

EIP 的带宽峰值。单位:Mbps。

5
ReservationBandwidthstring

续费带宽。单位:Mbps。

12
EipBandwidthstring

EIP 加入共享带宽之前或退出共享带宽之后的带宽。单位:Mbps。

101
Namestring

EIP 的名称。

EIP-01
PrivateIpAddressstring

EIP 所绑定的辅助弹性网卡实例的私网 IP 地址。

192.168.XX.XX
InstanceRegionIdstring

当前绑定的资源的地域 ID。

cn-hangzhou
DeletionProtectionboolean

是否开启了删除保护功能。

  • true:已开启。

  • false:未开启。

true
InstanceIdstring

当前绑定的实例的 ID。

i-bp15zckdt37cdvf****
SecondLimitedboolean

是否配置了二级限速。

  • true:已配置。

  • false:未配置。

false
InstanceTypestring

当前绑定的实例类型。

  • EcsInstance:VPC 类型的 ECS 实例。

  • SlbInstance:VPC 类型的 CLB 实例。

  • Nat:NAT 网关。

  • HaVip:高可用虚拟 IP。

  • NetworkInterface:辅助弹性网卡。

  • IpAddress:IP 地址。

EcsInstance
HDMonitorStatusstring

EIP 是否开启了秒级监控。

  • false:未开启。

  • true:已开启。

false
RegionIdstring

EIP 所在的地域 ID。

cn-hangzhou
BandwidthPackageBandwidthstring

EIP 加入的共享带宽的带宽值。单位:Mbps。

50
ServiceManagedinteger

是否为托管实例。取值:

  • 1:是托管实例。

  • 0:不是托管实例。

0
ExpiredTimestring

到期时间,格式为YYYY-MM-DDThh:mm:ssZ

2021-05-23T02:00:00Z
ResourceGroupIdstring

资源组 ID。

rg-acfmxazcdxs****
AllocationIdstring

EIP 的实例 ID。

eip-2zeerraiwb7ujcdvf****
InternetChargeTypestring

EIP 的计费方式。

  • PayByBandwidth:按固定带宽计费。

  • PayByTraffic:按使用流量计费。

PayByBandwidth
BusinessStatusstring

EIP 实例的业务状态。

  • Normal:正常。
  • FinancialLocked:被锁定。
Normal
BandwidthPackageTypestring

带宽的类型,仅支持返回 CommonBandwidthPackage(共享带宽)。

CommonBandwidthPackage
HasReservationDatastring

是否有续费数据。

  • false:无续费数据。
  • true:有续费数据。只有在入参 IncludeReservationDatatrue,且有未生效订购数据时才会为 true
false
ISPstring

线路类型。

  • BGP:BGP(多线)线路。目前全部地域都支持 BGP(多线)线路 EIP。
  • BGP_PRO:BGP(多线)_精品线路。目前仅中国香港、新加坡、日本(东京)、马来西亚(吉隆坡)、菲律宾(马尼拉)、印度尼西亚(雅加达)和泰国(曼谷)地域支持 BGP(多线)_精品线路 EIP。

关于 BGP(多线)线路和 BGP(多线)_精品线路的更多信息,请参见 EIP 线路类型

如果您是单线带宽的白名单用户,返回类型还可能为:

  • ChinaTelecom:中国电信
  • ChinaUnicom:中国联通
  • ChinaMobile:中国移动
  • ChinaTelecom_L2:中国电信 L2
  • ChinaUnicom_L2:中国联通 L2
  • ChinaMobile_L2:中国移动 L2

如果您是杭州金融云用户,返回BGP_FinanceCloud

BGP
OperationLocksobject []

锁定详情。

LockReasonstring

锁定类型。

  • financial:因欠费被锁定。

  • security:因安全原因被锁定。

financial
Tagsobject []

EIP 的标签列表。

Keystring

EIP 的标签键。

KeyTest
Valuestring

EIP 的标签值。

ValueTest
SecurityProtectionTypesarray

安全防护级别。

  • 返回为空时,表示 DDoS 防护(基础版)。

  • 返回AntiDDoS_Enhanced时,表示 DDoS 防护(增强版)。

string

安全防护级别。

  • 返回为空时,表示 DDoS 防护(基础版)。

  • 返回AntiDDoS_Enhanced时,表示 DDoS 防护(增强版)。

AntiDDoS_Enhanced
PublicIpAddressPoolIdstring

EIP 所属的 IP 地址池 ID。

pippool-2vc0kxcedhquybdsz****
VpcIdstring

开通了 IPv4 网关功能且与 EIP 同地域的 VPC ID。

EIP 绑定 IP 地址时,系统可以根据该 VPC 的路由配置,使绑定的 IP 地址具备公网访问能力。

说明 InstanceTypeIpAddress 时,即绑定 EIP 的实例类型为 IP 地址时,返回该参数。
vpc-bp15zckdt37pq72zv****
Zonestring

EIP 的可用区。

仅当 EIP 业务类型为云盒时,返回该参数。

ap-southeast-1-lzdvn-cb
BizTypestring

EIP 的业务类型。

  • CloudBox:云盒。仅云盒用户支持该类型。
  • Default(默认值):默认,表示非特殊类型。
CloudBox

示例

正常返回示例

JSON格式

{
  "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"
      }
    ]
  }
}

错误码

HTTP status code错误码错误信息描述
400InvalidIAssociatedInstanceType.ValueNotSupportedThe specified value of AssociatedInstanceType is not supported.AssociatedInstanceType的值不合法,请您检查该参数是否正确。
400InvalidChargeType.ValueNotSupportedThe specified ChargeType is not supported.该计费方式不支持,请您重新选择计费方式。
400InvalidAliuidUser Id is not valid.-
400InvalidResourceGroupIdThe specified ResourceGroupId does not exist.资源组ID不存在。
400InstanceType.InvalidInstanceType is not null-
400InstanceIdLength.ExceedInstanceId length is exceed-
400InvalidTagKeyThe tag keys are not valid.无效的标签索引
400InvalidTagValueThe tag values are not valid.无效的标签值
400OperationUnsupported.ResourceGroupIdResourceGroup is not supported in this region.资源组功能未打开。
400IellgalParameter.OwnerAccountThe specified parameter OwnerAccount is not valid.-
404InvalidFilterValueThe specified FilterValue is not supported.-
404Forbidden.RegionNotFoundSpecified region is not found during access authentication.指定 Region 不存在,请您检查该 Region 是否正确。
404InvalidFilterKey.NotFoundThe specified Filterkey is not supported.-
404InvalidLockReason.NotFoundThe specified LockReason is not found锁定原因未找到。

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

变更历史

变更时间变更内容概要操作
2024-03-14OpenAPI 错误码发生变更、OpenAPI 入参发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
    删除错误码:404
入参OpenAPI 入参发生变更
    新增入参:ServiceManaged
2023-12-07OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
    删除错误码:404
出参OpenAPI 返回结构发生变更
2023-08-09OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
    删除错误码:404
2023-08-09OpenAPI 描述信息更新、OpenAPI 错误码发生变更、OpenAPI 入参发生变更看变更集
变更项变更内容
API 描述OpenAPI 描述信息更新
错误码OpenAPI 错误码发生变更
    删除错误码:400
    删除错误码:404
入参OpenAPI 入参发生变更
    新增入参:Tag
2023-08-08OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
    删除错误码:404
出参OpenAPI 返回结构发生变更
2022-12-02OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
    删除错误码:404
出参OpenAPI 返回结构发生变更
  • 本页导读 (1)