DescribeEipAddresses_专有网络_API文档-阿里云OpenAPI开发者门户

接口说明

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

流控信息

请求速率为600/60(s)。

授权信息

如下是此API对应的授权信息，用于RAM权限策略语句的Action元素中，为RAM用户或RAM角色授予调用此API的权限。请通过 RAM 访问控制设置，使用方法可参考访问控制帮助文档。

具体说明如下：展开详情

操作	访问级别	资源类型	条件关键字	关联操作

vpc:DescribeEipAddresses	List	Address acs:vpc:{#regionId}:{#accountId}:eip/*	vpc:tag	无

请求参数

字段名称	字段详情
RegionIdstring	EIP 所在的地域 ID。展开详情示例值:cn-hangzhou参考取值来源: DescribeRegions
IncludeReservationDataboolean	是否包含未生效的订购数据，取值：展开详情示例值:false
Statusstring	EIP 的状态，取值：展开详情示例值:Available
EipAddressstring	要查询的 EIP 的 IP 地址。展开详情示例值:47.75.XX.XX参考取值来源: AllocateEipAddress
AllocationIdstring	要查询的 EIP 实例的 ID。展开详情示例值:eip-2zeerraiwb7ujxscd****
SegmentInstanceIdstring	连续 EIP 的实例 ID。示例值:eipsg-t4nr90yik5oy38xdy****
ResourceGroupIdstring	EIP 所属的资源组的 ID。示例值:rg-acfmxazb4pcdvf****
PageNumberinteger<int32>	列表的页码。默认值：1。示例值:10取值 >= 1
PageSizeinteger<int32>	分页查询时每页的行数。最大值：100。默认值：10。示例值:10取值 <= 100
ISPstring	线路类型。取值：展开详情示例值: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
AssociatedInstanceTypestring	要绑定的云产品实例的类型，取值：展开详情示例值:EcsInstance
AssociatedInstanceIdstring	云产品的实例 ID。示例值:i-2zebb08phyccdvf****
ChargeTypestring	EIP 的付费模式，取值：展开详情示例值:PostPaid
DryRunboolean	是否只预检此次请求，取值：展开详情示例值:false
EipNamestring	EIP 的名称。展开详情示例值:EIP-01
Tagarray<object>	指定标签筛选 EIP。子级条数 <= 20
SecurityProtectionEnabledboolean	是否开启了 DDoS 防护（增强版）。取值：展开详情示例值:false
PublicIpAddressPoolIdstring	要查询的 EIP 所属 IP 地址池 ID。示例值:pippool-2vc0kxcedhquybdsz****参考取值来源: ListPublicIpAddressPools CreatePublicIpAddressPool AddPublicIpAddressPoolCidrBlock TransformEipSegmentToPublicIpAddressPool
ServiceManagedboolean	是否为托管实例。取值：展开详情示例值:false

返回参数

字段名称	字段详情
PageSizeinteger<int32>	每页包含的条目数。示例值:10
RequestIdstring	请求 ID。示例值:4EC47282-1B74-4534-BD0E-403F3EE64CAF
PageNumberinteger<int32>	当前页码。示例值:10
TotalCountinteger<int32>	列表条目数。示例值:1
EipAddressesobject

返回示例

错误码

没有我想要的错误码, 点击反馈

全局错误码

HTTP 状态码	错误码	错误信息	操作

400	InvalidIAssociatedInstanceType.ValueNotSupported	The specified value of AssociatedInstanceType is not supported.	诊断
400	InvalidChargeType.ValueNotSupported	The specified ChargeType is not supported.	诊断
400	InvalidAliuid	User Id is not valid.	诊断
400	InvalidResourceGroupId	The specified ResourceGroupId does not exist.	诊断
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.	诊断
404	InvalidFilterKey.NotFound	The specified Filterkey is not supported.	诊断
404	InvalidLockReason.NotFound	The specified LockReason is not found	诊断

变更历史

	变更时间	变更内容概要	操作
	2025-02-10	变更返回参数
	2024-03-14	新增请求参数ServiceManaged
	2023-12-07	变更返回参数
	2023-08-09	变更请求参数Tag
	2023-08-09	新增请求参数Tag
	2023-08-08	删除返回参数
	2022-12-02	变更返回参数
	2022-11-14	变更返回参数

1
2
10 条/页

DescribeEipAddresses_专有网络_API文档

接口说明

流控信息

授权信息

请求参数

返回参数

返回示例

错误码

变更历史

相关示例