文档

DescribeEnsEipAddresses - 查询EIP列表

更新时间:

调用DescribeEnsEipAddresses查询弹性公网IP(EIP)。

调试

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

授权信息

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

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

请求参数

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

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

eip-5q9uwkd9bznjpxz8hr6cirnjk
EipAddressstring

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

120.XXX.XXX.4
AssociatedInstanceIdstring

云产品的实例 ID

lb-5t18quoohsrc3xkf86spmnu77
AssociatedInstanceTypestring

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

  • EnsInstance:VPC 类型的 ENS 实例。

  • SlbInstance:负载均衡实例。

SlbInstance
EnsRegionIdstring

ENS 的节点 ID。

cn-chengdu-telecom
EipNamestring

EIP 的名称。

test
Standbystring

是否备用弹性 IP。取值:

  • true:备用。

  • false:非备用。

true
PageNumberinteger

列表的页码,默认值为 1。

1
PageSizeinteger

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

50

返回参数

名称类型描述示例值
object

Schema of Response

RequestIdstring

请求 ID。

8629F679-B51D-4194-A1CC-5D8F504C362B
EipAddressesobject []

EIP 的详细信息。

AllocationIdstring

EIP 的实例 ID。

eip-5sainglpw7qfem3icir4s****
AllocationTimestring

EIP 的创建时间

1624885274000
Bandwidthinteger

EIP 的带宽峰值,默认值为 5。取值范围:5~10000,单位:Mbps。

50
ChargeTypestring

EIP 的计费模式。

  • PrePaid:包年包月。

  • PostPaid:按量计费。

PostPaid
Descriptionstring

EIP 的描述信息。

example
InstanceIdstring

当前绑定的实例的 ID。

lb-5sc3kum2e0sz34wbqrws9****
InstanceTypestring

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

  • EnsInstance:VPC 类型的 ENS 实例。

  • SlbInstance:负载均衡实例。

SlbInstance
InternetChargeTypestring

EIP 的计费方式。

  • 95BandwidthByMonth:月 95 峰值带宽。

  • PayByBandwidth:固定带宽计费。

95BandwidthByMonth
IpAddressstring

EIP 的 IP 地址。

120.XXX.XXX.4
Namestring

EIP 实例名称。

test
EnsRegionIdstring

ENS 节点 ID。

cn-xian-telecom
Statusstring

EIP 的状态。

  • Associating:绑定中。

  • Unassociating:解绑中。

  • InUse:已分配。

  • Available:可用。

Available
Ispstring

运营商,取值:

  • cmcc:中国移动。
  • unicom:中国联通。
  • telecom:中国电信。
cmcc
Standbyboolean

该 EIP 是否是备用。

true
IpStatusstring

如果该弹性 IP 是备用 EIP 时,表示当前 EIP 的运行状态。

  • Stopped:已停止。
  • Running:运行中。
  • Starting:启动中。
  • Stopping:停止中。
Stopped
PageNumberinteger

查询列表的页码。取值:>0,默认查询第 1 页。

1
PageSizeinteger

分页查询时设置的每页行数。默认值:10,取值:10~100

50
TotalCountinteger

列表条目数。

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

错误码

HTTP status code错误码错误信息描述
400ens.interface.errorAn error occurred while call the API.-
400NoPermissionPermission denied.没有足够的权限,请联系云账号管理员授予您相应权限。
400InvalidParameter.%sThe specified field %s invalid. Please check it again.-

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

变更历史

变更时间变更内容概要操作
2023-07-18OpenAPI 错误码发生变更、OpenAPI 入参发生变更、OpenAPI 返回结构发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
入参OpenAPI 入参发生变更
    新增入参:Standby
出参OpenAPI 返回结构发生变更
2023-03-02OpenAPI 错误码发生变更、OpenAPI 入参发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
入参OpenAPI 入参发生变更
    新增入参:EipName
  • 本页导读 (1)
文档反馈