阅读377 返回首页    go windows go Office

查询弹性公网IP列表__弹性公网IP相关接口_API参考_专有网络 VPC-阿里云

描述

查询指定地域的EIP列表。此接口支持分页查询，每页的数量默认为10条。

  • 此接口不会校验参数之间的依赖关系，返回结果是所有条件的“交集”。

请求参数

名称 类型 是否必须 描述
Action String 是 系统规定参数，取值：DescribeEipAddresses
RegionId String 是 需要查询的地域
Status String 否 Eip状态，包括Associating | Unassociating | InUse | Available
EipAddress String 否 EIP
AllocationId String 否 申请Id
AssociatedInstanceType String 否 绑定的资源的类型；
这是一个过滤器性质的参数，若不指定，则表示不使用该条件对结果进行过滤。
取值范围：EcsInstance|HaVip
AssociatedInstanceId String 否 绑定的资源的Id。
这是一个过滤器性质的参数，若不指定，则表示不适用该条件对结果进行过滤。
如果要使用该过滤器，必须同时使用AssociatedInstanceType。
如果AssociatedInstanceType是HaVipId，则该参数填写HaVipId；若AssociatedInstanceType是EcsInstance，则该参数填写EcsInstancdId。
PageNumber Integer 否 实例状态列表的页码，起始值为1，默认值为1
PageSize Integer 否 分页查询时设置的每页行数，最大值50行，默认为10

返回参数

名称 类型 描述
EipAddresses EipAddressSetType 弹性IP地址详情EipAddressSetType组成的集合
TotalCount Integer 列表条条目数
PageNumber Integer 当前页码
PageSize Integer 当前分页包含多少条目

错误码

错误代码 描述 Http 状态码 语义
Forbidden.RegionNotFound Specified region is not found during access authentication. 404 指定的region不存在
InvalidIAssociatedInstanceType.ValueNotSupported The specified value of AssociatedInstanceType is not supported. 400 AssociatedInstanceType的输入值不合法。

示例

请求示例

  1. https://vpc.aliyuncs.com/?Action=DescribeEipAddresses
  2. &RegionId=cn-hangzhou-1
  3. &<公共请求参数>

返回示例

XML格式

  1. <DescribeEipAddresses>
  2.     <RequestId>51BE7822-4121-428A-88F3-262AE4FD868D</RequestId>
  3. <EipAddresses>
  4.     <EipAddress>
  5.         <RegionId>cn-beijing</RegionId>
  6.         <AllocationId> eip-2578g5v5a </AllocationId>
  7.         <IpAddress>123.56.0.36</IpAddress>
  8.         <Status>Available</Status>
  9.         <OperationLocks>
  10.             <LockReason></LockReason>
  11. </OperationLocks>
  12.         <Bandwidth>5</Bandwidth>
  13.         <InternetChargeType>PayByBandwidth</InternetChargeType>
  14.         <AllocationTime>2014-05-28T03:03:16Z</AllocationTime>
  15.     </EipAddress>
  16. </EipAddresses>
  17. </DescribeEipAddresses>

JSON格式

  1. {
  2.   "EipAddresses": {
  3.     "EipAddress": [
  4.       {
  5.         "AllocationId": "eip-2578g5v5a",
  6.         "AllocationTime": "2014-05-28T03:03:16Z ",
  7.         "Bandwidth": "1",
  8.         "InstanceId": "",
  9.         "InternetChargeType": " PayByBandwidth ",
  10.         "IpAddress": "123.56.0.36",
  11.         "OperationLocks": {
  12.           "LockReason": []
  13.         },
  14.         "RegionId": "cn-beijing",
  15.         "Status": "Available"
  16.       }
  17.     ]
  18.   },
  19.   "PageNumber": 1,
  20.   "PageSize": 10,
  21.   "RequestId": "51BE7822-4121-428A-88F3-262AE4FD868D",
  22.   "TotalCount": 1
  23. }

最后更新：2016-11-23 16:04:14

  上一篇：go 解绑弹性公网IP__弹性公网IP相关接口_API参考_专有网络 VPC-阿里云
  下一篇：go 修改弹性公网IP属性__弹性公网IP相关接口_API参考_专有网络 VPC-阿里云