You need to enable JavaScript to run this app.
文档中心
公网IP

公网IP

复制全文
下载 pdf
公网IP
DescribeEipAddressesAll - 查询已创建的公网IP地址详细信息
复制全文
下载 pdf
DescribeEipAddressesAll - 查询已创建的公网IP地址详细信息
调用 DescribeEipAddressesAll接口 ,按条件查询已创建的公网IPv4与公网IPv6地址的详细信息。​
调试​
API Explorer
您可以通过 API Explorer 在线发起调用,无需关注签名生成过程,快速获取调用结果。
​
请求参数​
下方仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。​
Action String 必选 示例值:DescribeEipAddressesAll​
要执行的操作,取值:DescribeEipAddressesAll。​
​
Version String 必选 示例值:2020-04-01​
API的版本信息,当前版本为 2020-04-01。​
​
ProjectName String 可选 示例值:Project_1​
公网IP所属项目的名称。​
​
Status String 可选 示例值:Attaching​
公网IP的状态,取值如下:​
  • Attaching:绑定中。​
  • Detaching:解绑中。​
  • Attached:已分配。​
  • Available:可用。​
  • Deleting:删除中。​
​
EipAddresses.N String 可选 示例值:12.XX.XX.89​
公网IP地址。​
  • 参数 - N:表示公网IP地址的序号,单次调用数量上限100个。​
  • 多个公网IP地址之间用&分隔。​
您可以调用 DescribeEipAddresses 接口,查询公网IP的IP地址。​
​
AllocationIds.N String 可选 示例值:eip-2ze7ujxscd****​
查询的公网IP ID。​
  • 参数 - N:表示公网IP ID的序号,单次调用数量上限100个ID。​
  • 多个公网IP ID之间请使用&分隔。​
您可以调用DescribeEipAddresses接口查询公网IP的ID。​
​
PageNumber Integer 可选 示例值:1​
列表的页码。默认值为1。​
本参数即将下线,建议您使用NextToken和MaxResults进行分页查询。​
​
PageSize Integer 可选 示例值:20​
分页查询时每页的行数。最大值为100,默认值为20。​
本参数即将下线,建议您使用NextToken和MaxResults进行分页查询。​
​
NextToken String 可选 示例值:caeba0bbb2be03f84eb48b699f0a****​
分页查询凭证,用于标记分页的位置。​
  • 不填则从头开始查询。​
  • 传入之前调用本API返回的NextToken,则从该次API调用标记分页的位置往后开始查询。​
​
MaxResults Integer 可选 示例值:50​
查询的数量,默认为 10,最大为100。​
​
Name String 可选 示例值:eip-01​
公网IP的名称。​
​
ISP String 可选 示例值:BGP​
公网IP的线路类型。取值如下:​
  • BGP:BGP(多线)。​
  • 若您的账号已申请并开通了静态单线权限,则可传入如下取值:​
  • ChinaMobile:中国移动静态单线。​
  • ChinaTelecom:中国电信静态单线。​
  • ChinaUnicom:中国联通静态单线。​
  • 若您的账号已申请并开通了BGP单线权限,则可传入SingleLine_BGP。​
  • 若您的账号已申请并开通了融合BGP权限,则可传入Fusion_BGP。​
  • 若您的账号已申请并开通了惠选型静态单线权限,则可传入如下取值:​
  • ChinaMobile_Value:中国移动惠选型静态单线。​
  • ChinaUnicom_Value:中国联通惠选型静态单线。​
  • ChinaTelecom_Value:中国电信惠选型静态单线。​
​
AssociatedInstanceType String 可选 示例值:EcsInstance​
公网IP绑定云产品的类型,取值如下:​
  • Nat:NAT网关。​
  • NetworkInterface: 辅助网卡。​
  • ClbInstance:负载均衡。​
  • EcsInstance:云服务器。​
  • HaVip:高可用虚拟IP。​
​
AssociatedInstanceId String 可选 示例值:i-2zebbhyczzaweeval****​
公网IP绑定云产品的ID。​
​
BillingType Integer 可选 示例值:3​
公网IP的计费方式,取值如下:​
  • 1:包年包月计费。​
  • 2:按量计费-按带宽上限计费。​
  • 3:按量计费-按实际流量计费。​
​
TagFilters.N.Key String 可选 示例值:k1​
标签的标签键。仅支持查询IPv4协议公网IP的标签键。​
  • 参数 - N:表示标签键的序号,取值范围:1~10。​
  • 多个标签键之间用&分隔。多个标签键之间的关系为逻辑“与(AND)”,即查询同时添加多个标签键的公网IP。​
​
TagFilters.N.Values.M String 可选 示例值:v1​
标签的标签值。仅支持查询IPv4协议公网IP的标签值。​
  • 第一个N:表示标签键的序号。​
  • 第二个N:表示标签值的序号,取值范围:1~3。同一标签键多个标签值之间的关系为逻辑“或(OR)”,即查询同一标签键下添加其中一个标签值的公网IP。​
  • 多个标签值之间用&分隔。​
说明​
  • 若传入该参数,则必须先传入TagFilters.N.Key。​
  • 传入空字符串时,表示查询标签值为空的公网IP。​
​
​
返回参数​
下方仅列出本接口特有的返回参数。更多信息请参见返回结构。​
AsyncTaskId String 示例值:asynctask-13f0odozfrdvk3n6nu41lt59g​
响应ID。​
​
EipAddresses Object[] 示例值:-​
公网IP的详细信息列表​
AllocationId String 示例值:eip-2ze7ujxscd****​
公网IP的ID。​
​
EipAddress String 示例值:12.XX.XX.89​
公网IP的公网IP地址。​
​
Name String 示例值:eip-01​
公网IP的名称。​
​
Description String 示例值:This is an eip​
公网IP的描述信息。​
​
DirectMode Boolean 示例值:false​
是否开启直通模式。​
  • true:是。​
  • false:否。​
​
ISP String 示例值:BGP​
线路类型。​
  • BGP:BGP(多线)。​
  • ChinaMobile:中国移动静态单线。​
  • ChinaTelecom:中国电信静态单线。​
  • ChinaUnicom:中国联通静态单线。​
  • SingleLine_BGP:BGP单线。​
  • Fusion_BGP:融合BGP。​
  • ChinaMobile_Value:中国移动惠选型静态单线。​
  • ChinaUnicom_Value:中国联通惠选型静态单线。​
  • ChinaTelecom_Value:中国电信惠选型静态单线。​
​
BillingType Integer 示例值:2​
公网IP的计费方式。​
  • 1:包年包月计费。​
  • 2:按量计费-按带宽上限计费。​
  • 3:按量计费-按实际流量计费。​
​
Bandwidth Integer 示例值:5​
公网IP的带宽值,单位为Mbps。​
​
SecurityProtectionTypes String[] 示例值:["AntiDDoS_Enhanced"]​
安全防护类型。​
  • AntiDDoS_Enhanced:增强防护类型的公网IP(可加入到DDoS原生防护(企业版)实例)。​
  • 空值: 默认防护类型的公网IP。​
说明​
此功能正在邀测中,如需试用,请联系客户经理。
​
ProjectName String 示例值:Project_1​
公网IP所属项目的名称。​
​
Tags Object[] 示例值:-​
公网IP的标签信息。​
Key String 示例值:k1​
标签键。​
​
Value String 示例值:v1​
标签值。​
​
​
InstanceType String 示例值:EcsInstance​
当前绑定的实例类型。​
  • Nat:NAT网关。​
  • NetworkInterface: 辅助网卡。​
  • ClbInstance:负载均衡。​
  • EcsInstance:云服务器。​
  • HaVip:高可用虚拟IP。​
  • IpAddress:IP地址。​
​
InstanceId String 示例值:i-2zebbhyczzaweeval****​
当前绑定的实例ID。​
​
IpAddressPoolId String 示例值:eip-2zeerra***​
IP地址池的ID。​
​
IsBlocked Boolean 示例值:true​
实例是否被封禁。​
  • true:是。​
  • false:否。​
​
ReleaseWithInstance Boolean 示例值:true​
公网IP实例是否随云服务器实例删除。仅按量计费公网IP有效。开启后,当云服务器实例被系统自动回收(退订24小时后、到期回收、欠费回收)或被调用DeleteInstances接口时,公网IP随其一同释放。​
  • true:是。​
  • false:否。​
​
BandwidthPackageId String 示例值:bwp-2zeo05qre24nhrqpy****​
共享带宽包实例ID。​
​
Status String 示例值:Attaching​
公网IP的状态。​
  • Attaching:绑定中。​
  • Detaching:解绑中。​
  • Attached:已分配。​
  • Available:可用。​
  • Deleting:删除中。​
​
BusinessStatus String 示例值:FinancialLocked​
公网IP是否被锁定。​
  • Normal: 正常。​
  • FinancialLocked: 被锁定。​
​
LockReason String 示例值:financial​
公网IP被锁定的原因。​
  • financial: 因欠费被锁定。​
  • unlock:欠费关停后充值恢复过程中。​
  • 空值:没有被锁定。​
​
VpcId String 示例值:vpc-257gqcdfvx6n****​
与公网IP绑定的VPC ID。​
仅当公网IP的 InstanceType 参数取值为 IpAddress 时返回该参数。​
​
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​
预期资源强制回收时间。​
  • 包年包月公网IP,此参数有返回值。​
  • 按量计费公网IP,仅欠费冻结时,此参数有返回值。​
​
Protocol String 示例值:IPv4​
公网IP的协议类型。​
  • IPv4:IPv4公网IP。​
  • IPv6:IPv6公网IP。​
​
​
NextToken String 示例值:IiAgICAgICAgICAxMjM0NTY3ODkwIg==​
分页查询凭证,用于标记分页的位置。​
​
PageNumber Integer 示例值:1​
列表的页码。​
​
PageSize Integer 示例值:10​
分页查询时每页的行数。​
​
RequestId String 示例值:0ED8D006-F706-4D23-88ED-E11ED28DCAC0​
请求ID。​
​
TotalCount Integer 示例值:2​
查询结果数。​
​
​
请求示例​
​
GET /?Action=DescribeEipAddressesAll&Version=2020-04-01&ProjectName=Project_1&Status=Attaching&EipAddresses.N=12.XX.XX.89&AllocationIds.N=eip-2ze7ujxscd****&PageNumber=1&PageSize=20&NextToken=caeba0bbb2be03f84eb48b699f0a****&MaxResults=50&Name=eip-01&ISP=BGP&AssociatedInstanceType=Nat&AssociatedInstanceId=nawg-2zebbhyczzaweeval****&BillingType=3&TagFilters.N.Key=k1&TagFilters.N.Values.M=v1 HTTP/1.1​
Host: vpc.cn-beijing.volcengineapi.com​
X-Date: 20250804T033538Z​
Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20250804/cn-beijing/vpc/request, SignedHeaders=host;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f​
​
返回示例​
​
{​
"ResponseMetadata": {​
"RequestId": "20230604110420****100232280022D31",​
"Action": "DescribeEipAddressesAll",​
"Version": "2020-04-01",​
"Service": "vpc",​
"Region": "cn-north-1"​
},​
"Result": {​
"AsyncTaskId": "asynctask-13f0odozfrdvk3n6nu41lt59g",​
"EipAddresses": [​
{​
"ISP": "BGP",​
"Name": "eip-01",​
"Tags": [​
{​
"Key": "k1",​
"Value": "v1"​
}​
],​
"Status": "Attaching",​
"Protocol": "IPv4",​
"Bandwidth": 5,​
"IsBlocked": true,​
"UpdatedAt": "2021-07-23T11:55:12+08:00",​
"DirectMode": true,​
"EipAddress": "12.XX.XX.89",​
"InstanceId": "i-2zebbhyczzaweeval****",​
"LockReason": "financial",​
"BillingType": 2,​
"DeletedTime": "2021-04-30 01:00:00",​
"Description": "This is an eip",​
"ExpiredTime": "2021-05-07 23:59:59",​
"OverdueTime": "2021-04-29 01:00:00",​
"ProjectName": "Project_1",​
"AllocationId": "eip-2ze7ujxscd****",​
"InstanceType": "EcsInstance",​
"AllocationTime": "2021-07-15T21:46:15+08:00",​
"BusinessStatus": "FinancialLocked",​
"IpAddressPoolId": "eip-2zeerra***",​
"BandwidthPackageId": "bwp-2zeo05qre24nhrqpy****",​
"ReleaseWithInstance": true,​
"SecurityProtectionTypes": [​
"AntiDDoS_Enhanced"​
]​
}​
],​
"NextToken": "IiAgICAgICAgICAxMjM0NTY3ODkwIg==",​
"PageNumber": 1,​
"PageSize": 10,​
"RequestId": "0ED8D006-F706-4D23-88ED-E11ED28DCAC0",​
"TotalCount": 2​
}​
}​
​
错误码​
公共错误码请参见公共错误码。​
最近更新时间:2026.10.14 16:39:11
这个页面对您有帮助吗?
有用
有用
无用
无用