文档中心

DescribeEipAddressAttributes

最近更新时间：2024.04.18 17:01:41

首次发布时间：2021.07.31 07:47:47

调用 DescribeEipAddressAttributes 接口，查看指定公网IP的详情。

调试

API Explorer

您可以通过API Explorer在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

参数名称	类型	是否必选	示例值	描述
Action	String	是	DescribeEipAddressAttributes	要执行的操作，取值：DescribeEipAddressAttributes。
Version	String	是	2020-04-01	API的版本信息，当前版本为2020-04-01。
AllocationId	String	是	eip-2ze7ujxscd****	要查询的公网IP的ID。

返回数据

参数名称	类型	示例值	描述
RequestId	String	2021062415303301022514515207C4****	请求ID。
AllocationId	String	eip-2ze7ujxscd****	公网IP的ID。
EipAddress	String	10.XX.XX.50	公网IP地址。
Name	String	eip-1	公网IP的名称。
Description	String	This is an eip	公网IP的描述信息。
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	List	["AntiDDoS_Enhanced"]	防护类型。 AntiDDoS_Enhanced：增强防护类型的公网IP，可以加入到DDoS原生防护（企业版）实例。空值：默认防护类型的公网IP。说明此功能正在邀测中，如需试用，请联系客户经理。
ProjectName	String	Project_1	公网IP所属项目的名称。
Tags	Array of struct	-	公网IP的标签信息。具体请参见下表“Tags结构”。
InstanceType	String	EcsInstance	当前绑定的实例类型。 Nat：公网NAT网关。 NetworkInterface: 弹性网卡。 ClbInstance: 负载均衡。 Albinstance：应用型负载均衡。 EcsInstance：云服务器。 HaVip：高可用虚拟IP。
InstanceId	String	i-2zebbhyczzaweeval****	当前绑定的实例ID。
IsBlocked	Boolean	true	是否被封禁。 true：是。 false：否。
ReleaseWithInstance	Boolean	true	是否随云服务器实例删除。仅按量计费公网IP有效。开启后，当云服务器实例被系统自动回收（退订24小时后、到期回收、欠费回收）或被调用DeleteInstances接口时，公网IP随其一同释放。 true：是。 false：否。说明该功能当前仅华东2（上海）地域发布，其他地域陆续上线中，最晚将于2024年04月03日完成全地域上线，敬请期待。
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: 欠费关停后充值恢复过程中。空值 : 没有被锁定。
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，仅欠费冻结时，此参数有返回值。

Tags结构

参数名称	类型	示例值	描述
Key	String	k1	标签键。
Value	String	v1	标签值。

请求示例

GET /?Action=DescribeEipAddressAttributes&Version=2020-04-01&AllocationId=eip-2ze7ujxscd**** HTTP/1.1
Host: open.volcengineapi.com
Service: vpc
Region: cn-beijing

返回示例

{
    "ResponseMetadata": {
        "RequestId": "2021062415303301022514515207C4****",
        "Action": "DescribeEipAddressAttributes",
        "Version": "2020-04-01",
        "Service": "vpc",
        "Region": "cn-beijing"
    },
    "Result":{
        "RequestId": "2021062415303301022514515207C4****",
        "AllocationId": "eip-2ze7ujxscd****",
        "EipAddress": "10.XX.XX.50",
        "Name": "eip-1",
        "Description": "This  is an eip",
        "ISP": "BGP",
        "BillingType": 2,
        "Bandwidth": 1,
        "SecurityProtectionTypes": [
            "AntiDDoS_Enhanced"
        ],
        "ProjectName": "Project_1",
        "Tags":[
            {
                "Key":"k1",
                "Value":"v1"
            },
            {
                "Key":"k2",
                "Value":""
            }
        ],
        "InstanceType": "EcsInstance",
        "InstanceId": "i-2zebbhyczzaweeval****",
        "IsBlocked": true,
        "ReleaseWithInstance": true,
        "BandwidthPackageId": "bwp-2zeo05qre24nhrqpy****",
        "Status": "Attached", 
        "BusinessStatus": "Normal", 
        "LockReason": "",
        "AllocationTime": "2019-04-29T01:37:38+08:00",
        "UpdatedAt": "2021-07-21T19:54:56+08:00",        
        "ExpiredTime": "",
        "OverdueTime": "",
        "DeletedTime": ""
    }
}

错误码

当前API无专用错误码，公共错误码，请参见公共错误码。

调试

请求参数

返回数据

请求示例

返回示例

错误码