调用 DescribeEipAddresses 接口,查询满足指定条件的公网IP。
传入多个请求参数,按照传入的参数进行查询,返回符合所有条件的公网IP,若没有符合条件的公网IP,则返回空值。
若请求参数非必选参数均未传入,则按照当前登录账号查询,返回当前账号下的所有公网IP。
使用标签过滤公网IP实例时,最多可查询指定标签关联的1000个公网IP实例。如果指定标签关联的公网IP实例超过1000个,则请您使用 ListTagsForResources 接口查询。
参数名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | DescribeEipAddresses | 要执行的操作,取值:DescribeEipAddresses。 |
Version | String | 是 | 2020-04-01 | API的版本信息,当前版本为2020-04-01。 |
EipAddresses.N | String | 否 | EipAddresses.1=12.XX.XX.89&EipAddresses.2=12.XX.XX.35 | 公网IP地址。
|
AllocationIds.N | String | 否 | AllocationIds.1=eip-2zeewb7ujxscd****&AllocationIds.2=eip-2wrfgeb3efghxs**** | 要查询的公网IP的ID。
|
Name | String | 否 | eip-1 | 公网IP的名称,支持模糊查询。 |
ISP | String | 否 | BGP | 线路类型。取值如下:
|
IpAddressPoolId | String | 否 | ippool-2zeerra*** | IP地址池的ID。 说明 IP地址池正在邀测中,如需试用,请联系客户经理。 |
BillingType | Integer | 否 | 2 | 公网IP的计费方式。取值如下:
|
SecurityProtectionEnabled | Boolean | 否 | true | 安全防护。取值如下:
说明 此功能正在邀测中,如需试用,请联系客户经理。 |
ProjectName | String | 否 | Project_1 | 公网IP所属项目的名称。 |
TagFilters.N.Key | String | 否 | TagFilters.1.Key=k1&TagFilters.2.Key=k2&TagFilters.3.Key=k3 | 标签的标签键。
|
TagFilters.N.Values.N | String | 否 | TagFilters.1.Values.1=v1&TagFilters.1.Values.2=v2&TagFilters.3.Values.1=v1 | 标签的标签值。
说明
|
AssociatedInstanceType | String | 否 | EcsInstance | 当前绑定云产品的类型。取值如下:
说明 高可用虚拟IP正在邀测中,如需使用,请联系客户经理。 |
AssociatedInstanceId | String | 否 | i-2zebbhyczzaweeval**** | 当前绑定云产品实例ID。 |
Status | String | 否 | Available | 公网IP的状态。取值如下:
|
PageNumber | Integer | 否 | 1 | 列表的页码。默认值为1。 说明 本参数即将下线,建议您使用 |
PageSize | Integer | 否 | 20 | 分页查询时每页的行数。最大值为100,默认值为20。 说明 本参数即将下线,建议您使用 |
NextToken | String | 否 | caeba0bbb2be03f84eb48b699f0a**** | 分页查询凭证,用于标记分页的位置。
|
MaxResults | Integer | 否 | 50 | 查询的数量,默认为 10,最大为100。 |
参数名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
RequestId | String | 2021062415303301022514515207C4**** | 请求ID。 |
TotalCount | Integer | 2 | 符合条件的公网IP总数。 说明 本参数即将下线,使用 |
PageNumber | Integer | 1 | 当前页码。 说明 本参数即将下线,建议您使用 |
PageSize | Integer | 10 | 当前分页的行数。 说明 本参数即将下线,建议您使用 |
NextToken | String | caeba0bbb2be03f84eb48b699f0a**** | 本次API调用返回的查询凭证,标记分页的位置,用于下一次查询。返回为空表示没有下一页。 |
EipAddresses | Array of struct | - | 公网IP的详细信息列表,具体请见下表“ EipAddresses结构 ”。 |
EipAddresses结构
参数名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
AllocationId | String | eip-2ze7ujxscd**** | 公网IP的ID。 |
EipAddress | String | 12.XX.XX.89 | 公网IP的公网IP地址。 |
Name | String | eip-1 | 公网IP的名称。 |
Description | String | This is an eip | 公网IP的描述信息。 |
ISP | String | BGP | 线路类型。 |
BillingType | Integer | 2 | 公网IP的计费方式。 |
Bandwidth | Integer | 5 | 公网IP的带宽值,单位为Mbps。 |
SecurityProtectionTypes | List | ["AntiDDoS_Enhanced"] | 安全防护类型。
说明 此功能正在邀测中,如需试用,请联系客户经理。 |
ProjectName | String | Project_1 | 公网IP所属项目的名称。 |
Tags | Array of struct | - | 公网IP的标签信息。具体请参见下表“Tags结构”。 |
InstanceType | String | EcsInstance | 当前绑定的实例类型。 |
InstanceId | String | i-2zebbhyczzaweeval**** | 当前绑定的实例ID。 |
IpAddressPoolId | String | eip-2zeerra*** | IP地址池的ID。 |
IsBlocked | Boolean | true | 是否被封禁。
|
ReleaseWithInstance | Boolean | true | 是否随云服务器实例删除。仅按量计费公网IP有效。开启后,当云服务器实例被系统自动回收(退订24小时后、到期回收、欠费回收)或被调用DeleteInstances接口时,公网IP随其一同释放。
|
BandwidthPackageId | String | bwp-2zeo05qre24nhrqpy**** | 共享带宽包实例ID。 |
Status | String | Attaching | 公网IP的状态。 |
BusinessStatus | String | FinancialLocked | 公网IP是否被锁定。
|
LockReason | String | financial | 公网IP被锁定的原因。
|
AllocationTime | String | 2021-07-15T21:46:15+08:00 | 公网IP的创建时间。 |
UpdatedAt | String | 2021-07-23T11:55:12+08:00 | 更新公网IP的时间。 |
ExpiredTime | String | 2021-05-07 23:59:59 | 公网IP的到期时间。
|
OverdueTime | String | 2021-04-29 01:00:00 | 资源冻结时间。仅当资源因为欠费冻结,此参数才会有返回值。 |
DeletedTime | String | 2021-04-30 01:00:00 | 预期资源强制回收时间。
|
Tags结构
参数名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
Key | String | k1 | 标签键。 |
Value | String | v1 | 标签值。 |
GET /?Action=DescribeEipAddresses&Version=2020-04-01&BillingType=2&PageNumber=1&PageSize=20 HTTP/1.1 Host: open.volcengineapi.com Service: vpc Region: cn-beijing
{ "ResponseMetadata": { "RequestId": "2021062415303301022514515207C4****", "Action": "DescribeEipAddresses", "Version": "2020-04-01", "Service": "vpc", "Region": "cn-beijing" }, "Result":{ "RequestId": "2021062415303301022514515207C4****", "TotalCount":2, "PageNumber": 1, "PageSize": 20, "NextToken": "caeba0bbb2be03f84eb48b699f0a****", "EipAddresses": [ { "AllocationId": "eip-2ze7ujxscd****", "EipAddress": "12.XX.XX.89", "Name": "eip-1", "Description": "This is an eip", "ISP": "BGP", "BillingType": 2, "Bandwidth": 112, "SecurityProtectionTypes": [ "AntiDDoS_Enhanced" ], "ProjectName": "Project_1", "Tags":[ { "Key":"k1", "Value":"v1" }, { "Key":"k2", "Value":"" } ], "InstanceType": "EcsInstance", "InstanceId": "i-2zebbhyczzaweeval****", "IpAddressPoolId":"eip-2zeerra***", "IsBlocked": true, "ReleaseWithInstance": true, "BandwidthPackageId": "bwp-2zeo05qre24nhrqpy****", "Status": "Attached", "BusinessStatus": "Normal", "LockReason": "", "AllocationTime": "2021-07-22T10:51:41+08:00", "UpdatedAt": "2021-07-23T11:55:12+08:00", "ExpiredTime": "2021-05-07 23:59:59", "OverdueTime": "", "DeletedTime": "" } ] } }
公共错误码,请参见 公共错误码 。
HttpCode | 错误码 | 错误信息 | 描述 |
---|---|---|---|
400 | InvalidMaxResults.Malformed | The specified parameter MaxResults is malformed. | 查询数量不合法。 |
400 | InvalidNextToken.Malformed | The specified parameter NextToken is invalid. | 查询 NextToken 不合法。 |
400 | InvalidTagFilter.Disorder | The specified index order of tag filter is malformed. | 指定标签过滤项的索引顺序参数格式不合法。 |
400 | InvalidTagFilterKey.Malformed | The specified parameter tag filter key is invalid. | 过滤标签键不合法。 |
400 | InvalidTagFilterValue.Malformed | The specified parameter tag filter value is invalid. | 过滤标签值不合法。 |
400 | LimitExceeded.AllocationId | You've reached the limit on the number of allocation IDs that you can describe. | 已达到可查询的Allocation ID数量上限。 |
400 | LimitExceeded.EipAddresses | You've reached the limit on the number of elastic IP addresses that you can describe. | 已达到可查询的弹性IP数量上限。 |
400 | LimitExceeded.TagFilterKey | You've reached the limit on the number of tag keys that you can filter. | 已达到单次可指定过滤标签键数量的上限。 |
400 | LimitExceeded.TagFilterValue | You've reached the limit on the number of tag values that you can filter. | 已达到单次可指定过滤标签值数量的上限。 |
400 | InvalidName.Malformed | The specified name is malformed. Ensure the maximum length of name is 128. | 指定的名称格式不合法。名称长度不能超过128个字符。 |
400 | InvalidName.Malformed | The specified name is malformed. | 指定的名称格式不合法。请修复名称格式后重试。 |
400 | InvalidParameter | A parameter specified in the request is not valid, is unsupported, or cannot be used. Specified resource with maximum limit 100. | 该请求传入了非法或不支持的参数。资源查询数目最大限制100。 |