云主机 > API 文档 > EIP >弹性公网 IP 列表

弹性公网 IP 列表

最近更新时间: 2020-12-29 17:34:42

请求路径

GET /v1/vm/eip

请求参数

名称	类型	位置	必须	描述
region_id	string	query	否	地域 ID。您可以调用 DescribeRegions 查看最新的七牛云地域列表
allocation_id	string	query	否	要查询的 EIP 实例的 ID
allocation_name	string	query	否	要查询的 EIP 实例的名称
ip_address	string	query	否	要查询的 EIP 实例的 IP
status	string	query	否	EIP 状态: Creating, Associating, Unassociating, InUse, Available
instance_id	string	query	否	实例 ID
page	integer	query	否	页码。默认：1
size	integer	query	否	分页大小，最大100。默认20

返回值

名称	类型	描述
request_id	string	请求 ID
page	integer	页码
size	integer	分页大小
total	integer	EIP 总量
data	[]EIPInfo	EIP 列表

EIPInfo

名称	类型	描述
allocation_id	string	弹性公网 IP 的 ID
allocation_name	string	弹性公网 IP 的名称
charge_type	string	弹性公网 IP 的计费模式。 PrePaid：包年包月。 PostPaid：按量计费。
status	string	EIP 的状态。 Associating：绑定中。 Unassociating：解绑中。 InUse：已分配。 Available：可用。
instance_id	string	当前绑定的实例的 ID
instance_name	string	当前绑定的实例的名称
region_id	string	EIP 所在的地域
ip_address	string	弹性公网 IP 的 IP 地址
isp	string	服务提供商 `BGP_PRO`: BGP（多线）精品线路 `BGP`: BGP（多线）线路 `5_telcom`: 电信 `5_union`: 联通 `5_bgp`: 全动态BGP `5_sbgp`: 静态BGP
internet_charge_type	string	EIP 的计量方式，取值： PayByBandwidth（默认值）：按带宽计费。 PayByTraffic：按流量计费。当 InstanceChargeType 取值为 PrePaid 时，InternetChargeType 必须取值 PayByBandwidth。当 InstanceChargeType 取值为 PostPaid 时，InternetChargeType 可取值 PayByBandwidth 或 PayByTraffic。
instance_type	string	EIP 的实例的类型，取值： `Nat`：NAT 网关。 `SlbInstance`：负载均衡 SLB。 `EcsInstance`：云服务器 ECS。 `NetworkInterface`：辅助弹性网卡。 `HaVip`：高可用虚拟 IP。
bandwidth	string	EIP 的带宽峰值，单位为 Mbps 如果加入带宽包，则为被分配的带宽大小
pricing_cycle	string	包年包月的计费周期，取值： Month（默认值）：按月付费。 Year：按年付费。
period	string	购买时长。当 PricingCycle 取值 Month 时，Period 取值范围为 1~9。当 PricingCycle 取值 Year 时，Period 取值范围为 1~3。
bandwidth_package_bandwidth	string	EIP 加入的共享带宽的带宽值
bandwidth_package_id	string	加入的共享带宽 ID
bandwidth_package_type	string	带宽的类型，仅支持返回 CommonBandwidthPackage（共享带宽）
eip_bandwidth	string	EIP 加入共享带宽之前或退出共享带宽之后的带宽
expired_time	string	到期时间
created_at	string	创建时间
updated_at	string	更新时间
auto_renew_info	AutoRenew	自动续费信息注：仅限于已开启自动续费的包年包月 EIP
customized_expire_time	string	自定义过期时间
cost_charge_type	string	付费方式
cost_charge_mode	string	按什么计费

AutoRenew

名称	类型	描述
region_id	string	EIP 所在的地域
resource_type	string	资源类别
resource_id	string	资源 ID
cost_params	object	计费参数
updated_at	string	创建时间
created_at	string	更新时间

返回值示例

{
  "data": [
    {
      "allocation_id": "eip-j6ct5x5x63h6x8",
      "allocation_name": "ssss",
      "charge_type": "PostPaid",
      "status": "InUse",
      "instance_id": "i-j6ci4wx78lgqewyxihx1",
      "instance_name": "ss",
      "region_id": "cn-hongkong",
      "ip_address": "123.123.123.123",
      "isp": "BGP",
      "internet_charge_type": "PayByTraffic",
      "instance_type": "EcsInstance",
      "bandwidth": "10",
      "pricing_cycle": "",
      "period": "",
      "auto_pay": "true",
      "bandwidth_package_bandwidth": "",
      "bandwidth_package_id": "",
      "bandwidth_package_type": "",
      "eip_bandwidth": "",
      "allocation_time": "2020-11-09T19:58:57+08:00",
      "expired_time": "2120-12-25T23:54:00+08:00",
      "updated_at": "2020-12-25T15:54:08.202+08:00",
      "created_at": "2020-11-09T19:58:58.633+08:00",
      "customized_expire_time": null,
      "cost_charge_type": "PostPaid",
      "cost_charge_mode": "PayByTraffic",
    }
  ],
  "page": 1,
  "size": 10,
  "total": 1,
  "request_id": "ScKvEURLnxF751MW"
}

以上内容是否对您有帮助？