查询指定地域已创建的EIP。
接口说明
本接口可以查询指定地域已创建的 EIP 信息,包括 EIP 的带宽峰值、计费方式,当前绑定的实例类型等。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
vpc:DescribeEipAddresses | list |
|
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
RegionId | string | 是 | EIP 所在的地域 ID。 您可以通过调用 DescribeRegions 接口获取地域 ID。 | cn-hangzhou |
IncludeReservationData | boolean | 否 | 是否包含未生效的订购数据,取值:
| false |
Status | string | 否 | EIP 的状态,取值:
| Available |
EipAddress | string | 否 | 要查询的 EIP 的 IP 地址。 最多支持输入 50 个 EIP 的 IP 地址,IP 地址之间用半角逗号(,)分隔。 说明
如果同时传入 EipAddress 和 AllocationId 参数,EipAddress 可输入 50 个 EIP 的 IP 地址,AllocationId 也可同时输入 50 个 EIP 的实例 ID。
| 47.75.XX.XX |
AllocationId | string | 否 | 要查询的 EIP 实例的 ID。 最多支持输入 50 个 EIP 实例 ID,实例 ID 之间用半角逗号(,)分隔。 说明
如果同时传入 EipAddress 和 AllocationId 参数,AllocationId 可输入 50 个 EIP 的实例 ID,EipAddress 也可同时输入 50 个 EIP 的 IP 地址。
| eip-2zeerraiwb7ujxscd**** |
SegmentInstanceId | string | 否 | 连续 EIP 的实例 ID。 | eipsg-t4nr90yik5oy38xdy**** |
ResourceGroupId | string | 否 | EIP 所属的资源组的 ID。 | rg-acfmxazb4pcdvf**** |
PageNumber | integer | 否 | 列表的页码。默认值:1。 | 10 |
PageSize | integer | 否 | 分页查询时每页的行数。最大值:100。默认值:10。 | 10 |
ISP | string | 否 | 线路类型。取值:
关于 BGP(多线)线路和 BGP(多线)_精品线路的更多信息,请参见 EIP 线路类型。 如果您是单线带宽的白名单用户,您还可以选择以下类型:
如果您是杭州金融云用户,该字段必填,取值:BGP_FinanceCloud。 | BGP |
Filter.1.Key | string | 否 | 查询资源时的筛选键,必须取值为 CreationStartTime(资源创建的开始时间)。 | CreationStartTime |
Filter.2.Key | string | 否 | 查询资源时的筛选键,必须取值为 CreationEndTime(资源创建的结束时间)。 | CreationEndTime |
Filter.1.Value | string | 否 | 查询资源时的筛选值。使用 UTC 时间,格式为 | 2023-01-01T01:00Z |
Filter.2.Value | string | 否 | 查询资源时的筛选值。使用 UTC 时间,格式为 | 2023-01-06T02:00Z |
LockReason | string | 否 | 锁定类型,取值:
| financial |
AssociatedInstanceType | string | 否 | 要绑定的云产品实例的类型,取值:
说明
每个 ECS 实例、CLB 实例、高可用虚拟 IP 和 IP 地址同时只能绑定一个 EIP,NAT 网关可以绑定多个 EIP。辅助弹性网卡可以绑定 EIP 的个数受 EIP 绑定模式影响,更多信息,请参见弹性公网 IP 概述。
| EcsInstance |
AssociatedInstanceId | string | 否 | 云产品的实例 ID。 | i-2zebb08phyccdvf**** |
ChargeType | string | 否 | EIP 的付费模式,取值:
| PostPaid |
DryRun | boolean | 否 | 是否只预检此次请求,取值:
| false |
EipName | string | 否 | EIP 的名称。 长度为 1~128 个字符,必须以字母或中文开头,可包含数字、下划线(_)和短划线(-)。 | EIP-01 |
Tag | array<object> | 否 | 指定标签筛选 EIP。 | |
object | 否 | 指定标签筛选 EIP。 | ||
Key | string | 否 | 标签键。最多支持输入 20 个标签键。一旦传入该值,则不允许为空字符串。 一个标签键最多支持 128 个字符,不能以 | FinanceDept |
Value | string | 否 | 标签值。最多支持输入 20 个标签值。一旦传入该值,可以为空字符串。 一个标签值最多支持 128 个字符,不能以 | FinanceJoshua |
SecurityProtectionEnabled | boolean | 否 | 是否开启了 DDoS 防护(增强版)。取值:
| false |
PublicIpAddressPoolId | string | 否 | 要查询的 EIP 所属 IP 地址池 ID。 | pippool-2vc0kxcedhquybdsz**** |
ServiceManaged | boolean | 否 | 是否为托管实例。取值:
不填默认查询所有实例。 | false |
返回参数
示例
正常返回示例
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 | 错误码 | 错误信息 | 描述 |
---|---|---|---|
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 | InvalidResourceGroupId | The specified ResourceGroupId does not exist. | 资源组ID不存在。 |
400 | InstanceType.Invalid | InstanceType is not null | - |
400 | InstanceIdLength.Exceed | InstanceId length is exceed | - |
400 | InvalidTagKey | The tag keys are not valid. | 无效的标签索引 |
400 | InvalidTagValue | The tag values are not valid. | 无效的标签值 |
400 | OperationUnsupported.ResourceGroupId | ResourceGroup is not supported in this region. | 资源组功能未打开。 |
400 | IellgalParameter.OwnerAccount | The specified parameter OwnerAccount is not valid. | - |
404 | InvalidFilterValue | The specified FilterValue is not supported. | - |
404 | Forbidden.RegionNotFound | Specified region is not found during access authentication. | 指定 Region 不存在,请您检查该 Region 是否正确。 |
404 | InvalidFilterKey.NotFound | The specified Filterkey is not supported. | - |
404 | InvalidLockReason.NotFound | The specified LockReason is not found | 锁定原因未找到。 |
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 |
---|---|---|
2024-03-14 | OpenAPI 错误码发生变更、OpenAPI 入参发生变更 | 查看变更详情 |
2023-12-07 | OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更 | 查看变更详情 |
2023-08-09 | OpenAPI 错误码发生变更 | 查看变更详情 |
2023-08-09 | OpenAPI 描述信息更新、OpenAPI 错误码发生变更、OpenAPI 入参发生变更 | 查看变更详情 |
2023-08-08 | OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更 | 查看变更详情 |
2022-12-02 | OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更 | 查看变更详情 |