getEip

bytepluscc v0.0.16, Mar 9 26

Viewing docs for bytepluscc v0.0.16
published on Monday, Mar 9, 2026 by Byteplus

Schema (JSON)

byteplus-sdk/pulumi-bytepluscc

Viewing docs for bytepluscc v0.0.16
published on Monday, Mar 9, 2026 by Byteplus

Schema (JSON)

byteplus-sdk/pulumi-bytepluscc

Using getEip

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getEip(args: GetEipArgs, opts?: InvokeOptions): Promise<GetEipResult>
function getEipOutput(args: GetEipOutputArgs, opts?: InvokeOptions): Output<GetEipResult>

def get_eip(id: Optional[str] = None,
            opts: Optional[InvokeOptions] = None) -> GetEipResult
def get_eip_output(id: Optional[pulumi.Input[str]] = None,
            opts: Optional[InvokeOptions] = None) -> Output[GetEipResult]

func LookupEip(ctx *Context, args *LookupEipArgs, opts ...InvokeOption) (*LookupEipResult, error)
func LookupEipOutput(ctx *Context, args *LookupEipOutputArgs, opts ...InvokeOption) LookupEipResultOutput

> Note: This function is named LookupEip in the Go SDK.

public static class GetEip 
{
    public static Task<GetEipResult> InvokeAsync(GetEipArgs args, InvokeOptions? opts = null)
    public static Output<GetEipResult> Invoke(GetEipInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetEipResult> getEip(GetEipArgs args, InvokeOptions options)
public static Output<GetEipResult> getEip(GetEipArgs args, InvokeOptions options)

fn::invoke:
  function: bytepluscc:vpc/getEip:getEip
  arguments:
    # arguments dictionary

The following arguments are supported:

Id string: Uniquely identifies the resource.

Id string: Uniquely identifies the resource.

id String: Uniquely identifies the resource.

id string: Uniquely identifies the resource.

id str: Uniquely identifies the resource.

id String: Uniquely identifies the resource.

getEip Result

The following output properties are available:

AllocationId string: 公网IP的ID。
Bandwidth int: 公网IP的带宽上限，默认为“1”，单位：Mbps,BillingType传入1：取值范围1 ~ 500。BillingType传入2：取值范围1 ~ 500。BillingType传入3：取值范围1 ~ 200。
BandwidthPackageId string: 共享带宽包的ID，表示将公网IP加入到共享带宽包。公网IP加入到共享带宽包必须同时满足如下条件：二者的安全防护类型相同。二者的地域相同。公网IP的计费方式必须是按量计费。共享带宽包为IPv4类型。
BillingType int: 公网IP的计费方式。取值如下：1：包年包月。2：按量计费-按带宽上限计费。3：按量计费-按实际流量计费。
BusinessStatus string: 公网IP是否被锁定。Normal: 正常。FinancialLocked: 被锁定。
CreatedTime string: 公网IP的创建时间。
DeletedTime string: 预期资源强制回收时间。包年包月公网IP，此参数有返回值。按量计费公网IP，仅欠费冻结时，此参数有返回值。
Description string: 公网IP的描述信息。
DirectMode bool: 绑定公网IP时是否启用直通模式。请严格按照以下枚举值的大小写输入，不要传入其他取值。false（默认）：不使用直通模式。true：使用直通模式。
EipAddress string: 公网IP地址。
ExpiredTime string: 公网IP的到期时间。包年包月，返回值为到期时间。按量计费，返回值为空。
Id string: Uniquely identifies the resource.
InstanceId string: 当前绑定的实例ID。
InstanceType string: 当前绑定的实例类型。Nat：公网NAT网关。NetworkInterface: 弹性网卡。ClbInstance: 负载均衡。EcsInstance：云服务器。HaVip：高可用虚拟IP。
IpAddress string: 申请申请指定的公网IP地址。仅支持填写使用后释放的IP地址，不填则表示自动分配。指定的公网IP地址
IpAddressPoolId string: IP地址池的ID。
IsBlocked bool: 是否被封禁。true：是。false：否。
Isp string: 线路类型。BGP：BGP（多线）。ChinaMobile：中国移动静态单线。ChinaTelecom：中国电信静态单线。ChinaUnicom：中国联通静态单线。SingleLineBGP：BGP单线。FusionBGP：融合BGP。ChinaMobileValue：中国移动惠选型静态单线。ChinaUnicomValue：中国联通惠选型静态单线。ChinaTelecom_Value：中国电信惠选型静态单线。
LockReason string: 公网IP被锁定的原因。financial: 因欠费被锁定。unlock: 欠费关停后充值恢复过程中。空值 : 没有被锁定。
Name string: 公网IP的名称。
OverdueTime string: 资源冻结时间。仅当资源因为欠费冻结，此参数才会有返回值。
Period int: 代表购买包年包月公网IP的时长时，默认为“1”。当PeriodUnit传入1，Period取值范围：1~9、12、24、36、48、60。当PeriodUnit传入2，Period取值范围：1～5。代表临时升配的时长时：单位为小时，取值范围：1～720。
PeriodUnit int: 购买包年包月公网IP时长的单位。取值如下：1（默认值）：月。2 ：年。
PrivateIpAddress string: 要绑定公网IP的实例的私网IP地址。只支持传入云服务ECS主网卡的私网IP地址和辅助网卡IP地址。若不填写：InstanceType传入EcsInstance，则绑定云服务器ECS主网卡的主私网IP地址。InstanceType传入NetworkInterface，则绑定辅助网卡主私网IP地址。
ProjectName string: 公网IP所属项目的名称。
ReleaseWithInstance bool: 是否随云服务器实例删除。仅按量计费公网IP有效。开启后，当云服务器实例被系统自动回收（退订24小时后、到期回收、欠费回收）或被调用DeleteInstances接口时，公网IP随其一同释放。true：是。false：否。
RenewPeriodTimes int: 自动续费的时长，取值范围1、2、3、6、12，单位：月。若RenewType传入2，则必须传入RenewPeriodTimes
RenewType int: 包年包月公网IP续费的方式。取值如下：1（默认值）：手动续费。2：自动续费。3：到期不续费。
SecurityProtectionInstanceId int: DDoS原生防护（企业版）ID。您可以调用 DescInstanceList 接口，查询DDoS原生防护（企业版）的ID。当SecurityProtectionTypes传入AntiDDoS_Enhanced时，此参数必须传入。
SecurityProtectionTypes List<string>: 防护类型。AntiDDoS_Enhanced：增强防护类型的公网IP，可以加入到DDoS原生防护（企业版）实例。空值：默认防护类型的公网IP。
ServiceManaged bool: 是否由服务管理
Status string: 公网IP的状态。Attaching：绑定中。Detaching：解绑中。Attached：已绑定。Available：可用。Deleting：删除中。
Tags List<Byteplus.GetEipTag>: 公网IP的标签信息
UpdatedTime string: 更新公网IP的时间。

AllocationId string: 公网IP的ID。
Bandwidth int: 公网IP的带宽上限，默认为“1”，单位：Mbps,BillingType传入1：取值范围1 ~ 500。BillingType传入2：取值范围1 ~ 500。BillingType传入3：取值范围1 ~ 200。
BandwidthPackageId string: 共享带宽包的ID，表示将公网IP加入到共享带宽包。公网IP加入到共享带宽包必须同时满足如下条件：二者的安全防护类型相同。二者的地域相同。公网IP的计费方式必须是按量计费。共享带宽包为IPv4类型。
BillingType int: 公网IP的计费方式。取值如下：1：包年包月。2：按量计费-按带宽上限计费。3：按量计费-按实际流量计费。
BusinessStatus string: 公网IP是否被锁定。Normal: 正常。FinancialLocked: 被锁定。
CreatedTime string: 公网IP的创建时间。
DeletedTime string: 预期资源强制回收时间。包年包月公网IP，此参数有返回值。按量计费公网IP，仅欠费冻结时，此参数有返回值。
Description string: 公网IP的描述信息。
DirectMode bool: 绑定公网IP时是否启用直通模式。请严格按照以下枚举值的大小写输入，不要传入其他取值。false（默认）：不使用直通模式。true：使用直通模式。
EipAddress string: 公网IP地址。
ExpiredTime string: 公网IP的到期时间。包年包月，返回值为到期时间。按量计费，返回值为空。
Id string: Uniquely identifies the resource.
InstanceId string: 当前绑定的实例ID。
InstanceType string: 当前绑定的实例类型。Nat：公网NAT网关。NetworkInterface: 弹性网卡。ClbInstance: 负载均衡。EcsInstance：云服务器。HaVip：高可用虚拟IP。
IpAddress string: 申请申请指定的公网IP地址。仅支持填写使用后释放的IP地址，不填则表示自动分配。指定的公网IP地址
IpAddressPoolId string: IP地址池的ID。
IsBlocked bool: 是否被封禁。true：是。false：否。
Isp string: 线路类型。BGP：BGP（多线）。ChinaMobile：中国移动静态单线。ChinaTelecom：中国电信静态单线。ChinaUnicom：中国联通静态单线。SingleLineBGP：BGP单线。FusionBGP：融合BGP。ChinaMobileValue：中国移动惠选型静态单线。ChinaUnicomValue：中国联通惠选型静态单线。ChinaTelecom_Value：中国电信惠选型静态单线。
LockReason string: 公网IP被锁定的原因。financial: 因欠费被锁定。unlock: 欠费关停后充值恢复过程中。空值 : 没有被锁定。
Name string: 公网IP的名称。
OverdueTime string: 资源冻结时间。仅当资源因为欠费冻结，此参数才会有返回值。
Period int: 代表购买包年包月公网IP的时长时，默认为“1”。当PeriodUnit传入1，Period取值范围：1~9、12、24、36、48、60。当PeriodUnit传入2，Period取值范围：1～5。代表临时升配的时长时：单位为小时，取值范围：1～720。
PeriodUnit int: 购买包年包月公网IP时长的单位。取值如下：1（默认值）：月。2 ：年。
PrivateIpAddress string: 要绑定公网IP的实例的私网IP地址。只支持传入云服务ECS主网卡的私网IP地址和辅助网卡IP地址。若不填写：InstanceType传入EcsInstance，则绑定云服务器ECS主网卡的主私网IP地址。InstanceType传入NetworkInterface，则绑定辅助网卡主私网IP地址。
ProjectName string: 公网IP所属项目的名称。
ReleaseWithInstance bool: 是否随云服务器实例删除。仅按量计费公网IP有效。开启后，当云服务器实例被系统自动回收（退订24小时后、到期回收、欠费回收）或被调用DeleteInstances接口时，公网IP随其一同释放。true：是。false：否。
RenewPeriodTimes int: 自动续费的时长，取值范围1、2、3、6、12，单位：月。若RenewType传入2，则必须传入RenewPeriodTimes
RenewType int: 包年包月公网IP续费的方式。取值如下：1（默认值）：手动续费。2：自动续费。3：到期不续费。
SecurityProtectionInstanceId int: DDoS原生防护（企业版）ID。您可以调用 DescInstanceList 接口，查询DDoS原生防护（企业版）的ID。当SecurityProtectionTypes传入AntiDDoS_Enhanced时，此参数必须传入。
SecurityProtectionTypes []string: 防护类型。AntiDDoS_Enhanced：增强防护类型的公网IP，可以加入到DDoS原生防护（企业版）实例。空值：默认防护类型的公网IP。
ServiceManaged bool: 是否由服务管理
Status string: 公网IP的状态。Attaching：绑定中。Detaching：解绑中。Attached：已绑定。Available：可用。Deleting：删除中。
Tags []GetEipTag: 公网IP的标签信息
UpdatedTime string: 更新公网IP的时间。

allocationId String: 公网IP的ID。
bandwidth Integer: 公网IP的带宽上限，默认为“1”，单位：Mbps,BillingType传入1：取值范围1 ~ 500。BillingType传入2：取值范围1 ~ 500。BillingType传入3：取值范围1 ~ 200。
bandwidthPackageId String: 共享带宽包的ID，表示将公网IP加入到共享带宽包。公网IP加入到共享带宽包必须同时满足如下条件：二者的安全防护类型相同。二者的地域相同。公网IP的计费方式必须是按量计费。共享带宽包为IPv4类型。
billingType Integer: 公网IP的计费方式。取值如下：1：包年包月。2：按量计费-按带宽上限计费。3：按量计费-按实际流量计费。
businessStatus String: 公网IP是否被锁定。Normal: 正常。FinancialLocked: 被锁定。
createdTime String: 公网IP的创建时间。
deletedTime String: 预期资源强制回收时间。包年包月公网IP，此参数有返回值。按量计费公网IP，仅欠费冻结时，此参数有返回值。
description String: 公网IP的描述信息。
directMode Boolean: 绑定公网IP时是否启用直通模式。请严格按照以下枚举值的大小写输入，不要传入其他取值。false（默认）：不使用直通模式。true：使用直通模式。
eipAddress String: 公网IP地址。
expiredTime String: 公网IP的到期时间。包年包月，返回值为到期时间。按量计费，返回值为空。
id String: Uniquely identifies the resource.
instanceId String: 当前绑定的实例ID。
instanceType String: 当前绑定的实例类型。Nat：公网NAT网关。NetworkInterface: 弹性网卡。ClbInstance: 负载均衡。EcsInstance：云服务器。HaVip：高可用虚拟IP。
ipAddress String: 申请申请指定的公网IP地址。仅支持填写使用后释放的IP地址，不填则表示自动分配。指定的公网IP地址
ipAddressPoolId String: IP地址池的ID。
isBlocked Boolean: 是否被封禁。true：是。false：否。
isp String: 线路类型。BGP：BGP（多线）。ChinaMobile：中国移动静态单线。ChinaTelecom：中国电信静态单线。ChinaUnicom：中国联通静态单线。SingleLineBGP：BGP单线。FusionBGP：融合BGP。ChinaMobileValue：中国移动惠选型静态单线。ChinaUnicomValue：中国联通惠选型静态单线。ChinaTelecom_Value：中国电信惠选型静态单线。
lockReason String: 公网IP被锁定的原因。financial: 因欠费被锁定。unlock: 欠费关停后充值恢复过程中。空值 : 没有被锁定。
name String: 公网IP的名称。
overdueTime String: 资源冻结时间。仅当资源因为欠费冻结，此参数才会有返回值。
period Integer: 代表购买包年包月公网IP的时长时，默认为“1”。当PeriodUnit传入1，Period取值范围：1~9、12、24、36、48、60。当PeriodUnit传入2，Period取值范围：1～5。代表临时升配的时长时：单位为小时，取值范围：1～720。
periodUnit Integer: 购买包年包月公网IP时长的单位。取值如下：1（默认值）：月。2 ：年。
privateIpAddress String: 要绑定公网IP的实例的私网IP地址。只支持传入云服务ECS主网卡的私网IP地址和辅助网卡IP地址。若不填写：InstanceType传入EcsInstance，则绑定云服务器ECS主网卡的主私网IP地址。InstanceType传入NetworkInterface，则绑定辅助网卡主私网IP地址。
projectName String: 公网IP所属项目的名称。
releaseWithInstance Boolean: 是否随云服务器实例删除。仅按量计费公网IP有效。开启后，当云服务器实例被系统自动回收（退订24小时后、到期回收、欠费回收）或被调用DeleteInstances接口时，公网IP随其一同释放。true：是。false：否。
renewPeriodTimes Integer: 自动续费的时长，取值范围1、2、3、6、12，单位：月。若RenewType传入2，则必须传入RenewPeriodTimes
renewType Integer: 包年包月公网IP续费的方式。取值如下：1（默认值）：手动续费。2：自动续费。3：到期不续费。
securityProtectionInstanceId Integer: DDoS原生防护（企业版）ID。您可以调用 DescInstanceList 接口，查询DDoS原生防护（企业版）的ID。当SecurityProtectionTypes传入AntiDDoS_Enhanced时，此参数必须传入。
securityProtectionTypes List<String>: 防护类型。AntiDDoS_Enhanced：增强防护类型的公网IP，可以加入到DDoS原生防护（企业版）实例。空值：默认防护类型的公网IP。
serviceManaged Boolean: 是否由服务管理
status String: 公网IP的状态。Attaching：绑定中。Detaching：解绑中。Attached：已绑定。Available：可用。Deleting：删除中。
tags List<GetEipTag>: 公网IP的标签信息
updatedTime String: 更新公网IP的时间。

allocationId string: 公网IP的ID。
bandwidth number: 公网IP的带宽上限，默认为“1”，单位：Mbps,BillingType传入1：取值范围1 ~ 500。BillingType传入2：取值范围1 ~ 500。BillingType传入3：取值范围1 ~ 200。
bandwidthPackageId string: 共享带宽包的ID，表示将公网IP加入到共享带宽包。公网IP加入到共享带宽包必须同时满足如下条件：二者的安全防护类型相同。二者的地域相同。公网IP的计费方式必须是按量计费。共享带宽包为IPv4类型。
billingType number: 公网IP的计费方式。取值如下：1：包年包月。2：按量计费-按带宽上限计费。3：按量计费-按实际流量计费。
businessStatus string: 公网IP是否被锁定。Normal: 正常。FinancialLocked: 被锁定。
createdTime string: 公网IP的创建时间。
deletedTime string: 预期资源强制回收时间。包年包月公网IP，此参数有返回值。按量计费公网IP，仅欠费冻结时，此参数有返回值。
description string: 公网IP的描述信息。
directMode boolean: 绑定公网IP时是否启用直通模式。请严格按照以下枚举值的大小写输入，不要传入其他取值。false（默认）：不使用直通模式。true：使用直通模式。
eipAddress string: 公网IP地址。
expiredTime string: 公网IP的到期时间。包年包月，返回值为到期时间。按量计费，返回值为空。
id string: Uniquely identifies the resource.
instanceId string: 当前绑定的实例ID。
instanceType string: 当前绑定的实例类型。Nat：公网NAT网关。NetworkInterface: 弹性网卡。ClbInstance: 负载均衡。EcsInstance：云服务器。HaVip：高可用虚拟IP。
ipAddress string: 申请申请指定的公网IP地址。仅支持填写使用后释放的IP地址，不填则表示自动分配。指定的公网IP地址
ipAddressPoolId string: IP地址池的ID。
isBlocked boolean: 是否被封禁。true：是。false：否。
isp string: 线路类型。BGP：BGP（多线）。ChinaMobile：中国移动静态单线。ChinaTelecom：中国电信静态单线。ChinaUnicom：中国联通静态单线。SingleLineBGP：BGP单线。FusionBGP：融合BGP。ChinaMobileValue：中国移动惠选型静态单线。ChinaUnicomValue：中国联通惠选型静态单线。ChinaTelecom_Value：中国电信惠选型静态单线。
lockReason string: 公网IP被锁定的原因。financial: 因欠费被锁定。unlock: 欠费关停后充值恢复过程中。空值 : 没有被锁定。
name string: 公网IP的名称。
overdueTime string: 资源冻结时间。仅当资源因为欠费冻结，此参数才会有返回值。
period number: 代表购买包年包月公网IP的时长时，默认为“1”。当PeriodUnit传入1，Period取值范围：1~9、12、24、36、48、60。当PeriodUnit传入2，Period取值范围：1～5。代表临时升配的时长时：单位为小时，取值范围：1～720。
periodUnit number: 购买包年包月公网IP时长的单位。取值如下：1（默认值）：月。2 ：年。
privateIpAddress string: 要绑定公网IP的实例的私网IP地址。只支持传入云服务ECS主网卡的私网IP地址和辅助网卡IP地址。若不填写：InstanceType传入EcsInstance，则绑定云服务器ECS主网卡的主私网IP地址。InstanceType传入NetworkInterface，则绑定辅助网卡主私网IP地址。
projectName string: 公网IP所属项目的名称。
releaseWithInstance boolean: 是否随云服务器实例删除。仅按量计费公网IP有效。开启后，当云服务器实例被系统自动回收（退订24小时后、到期回收、欠费回收）或被调用DeleteInstances接口时，公网IP随其一同释放。true：是。false：否。
renewPeriodTimes number: 自动续费的时长，取值范围1、2、3、6、12，单位：月。若RenewType传入2，则必须传入RenewPeriodTimes
renewType number: 包年包月公网IP续费的方式。取值如下：1（默认值）：手动续费。2：自动续费。3：到期不续费。
securityProtectionInstanceId number: DDoS原生防护（企业版）ID。您可以调用 DescInstanceList 接口，查询DDoS原生防护（企业版）的ID。当SecurityProtectionTypes传入AntiDDoS_Enhanced时，此参数必须传入。
securityProtectionTypes string[]: 防护类型。AntiDDoS_Enhanced：增强防护类型的公网IP，可以加入到DDoS原生防护（企业版）实例。空值：默认防护类型的公网IP。
serviceManaged boolean: 是否由服务管理
status string: 公网IP的状态。Attaching：绑定中。Detaching：解绑中。Attached：已绑定。Available：可用。Deleting：删除中。
tags GetEipTag[]: 公网IP的标签信息
updatedTime string: 更新公网IP的时间。

allocation_id str: 公网IP的ID。
bandwidth int: 公网IP的带宽上限，默认为“1”，单位：Mbps,BillingType传入1：取值范围1 ~ 500。BillingType传入2：取值范围1 ~ 500。BillingType传入3：取值范围1 ~ 200。
bandwidth_package_id str: 共享带宽包的ID，表示将公网IP加入到共享带宽包。公网IP加入到共享带宽包必须同时满足如下条件：二者的安全防护类型相同。二者的地域相同。公网IP的计费方式必须是按量计费。共享带宽包为IPv4类型。
billing_type int: 公网IP的计费方式。取值如下：1：包年包月。2：按量计费-按带宽上限计费。3：按量计费-按实际流量计费。
business_status str: 公网IP是否被锁定。Normal: 正常。FinancialLocked: 被锁定。
created_time str: 公网IP的创建时间。
deleted_time str: 预期资源强制回收时间。包年包月公网IP，此参数有返回值。按量计费公网IP，仅欠费冻结时，此参数有返回值。
description str: 公网IP的描述信息。
direct_mode bool: 绑定公网IP时是否启用直通模式。请严格按照以下枚举值的大小写输入，不要传入其他取值。false（默认）：不使用直通模式。true：使用直通模式。
eip_address str: 公网IP地址。
expired_time str: 公网IP的到期时间。包年包月，返回值为到期时间。按量计费，返回值为空。
id str: Uniquely identifies the resource.
instance_id str: 当前绑定的实例ID。
instance_type str: 当前绑定的实例类型。Nat：公网NAT网关。NetworkInterface: 弹性网卡。ClbInstance: 负载均衡。EcsInstance：云服务器。HaVip：高可用虚拟IP。
ip_address str: 申请申请指定的公网IP地址。仅支持填写使用后释放的IP地址，不填则表示自动分配。指定的公网IP地址
ip_address_pool_id str: IP地址池的ID。
is_blocked bool: 是否被封禁。true：是。false：否。
isp str: 线路类型。BGP：BGP（多线）。ChinaMobile：中国移动静态单线。ChinaTelecom：中国电信静态单线。ChinaUnicom：中国联通静态单线。SingleLineBGP：BGP单线。FusionBGP：融合BGP。ChinaMobileValue：中国移动惠选型静态单线。ChinaUnicomValue：中国联通惠选型静态单线。ChinaTelecom_Value：中国电信惠选型静态单线。
lock_reason str: 公网IP被锁定的原因。financial: 因欠费被锁定。unlock: 欠费关停后充值恢复过程中。空值 : 没有被锁定。
name str: 公网IP的名称。
overdue_time str: 资源冻结时间。仅当资源因为欠费冻结，此参数才会有返回值。
period int: 代表购买包年包月公网IP的时长时，默认为“1”。当PeriodUnit传入1，Period取值范围：1~9、12、24、36、48、60。当PeriodUnit传入2，Period取值范围：1～5。代表临时升配的时长时：单位为小时，取值范围：1～720。
period_unit int: 购买包年包月公网IP时长的单位。取值如下：1（默认值）：月。2 ：年。
private_ip_address str: 要绑定公网IP的实例的私网IP地址。只支持传入云服务ECS主网卡的私网IP地址和辅助网卡IP地址。若不填写：InstanceType传入EcsInstance，则绑定云服务器ECS主网卡的主私网IP地址。InstanceType传入NetworkInterface，则绑定辅助网卡主私网IP地址。
project_name str: 公网IP所属项目的名称。
release_with_instance bool: 是否随云服务器实例删除。仅按量计费公网IP有效。开启后，当云服务器实例被系统自动回收（退订24小时后、到期回收、欠费回收）或被调用DeleteInstances接口时，公网IP随其一同释放。true：是。false：否。
renew_period_times int: 自动续费的时长，取值范围1、2、3、6、12，单位：月。若RenewType传入2，则必须传入RenewPeriodTimes
renew_type int: 包年包月公网IP续费的方式。取值如下：1（默认值）：手动续费。2：自动续费。3：到期不续费。
security_protection_instance_id int: DDoS原生防护（企业版）ID。您可以调用 DescInstanceList 接口，查询DDoS原生防护（企业版）的ID。当SecurityProtectionTypes传入AntiDDoS_Enhanced时，此参数必须传入。
security_protection_types Sequence[str]: 防护类型。AntiDDoS_Enhanced：增强防护类型的公网IP，可以加入到DDoS原生防护（企业版）实例。空值：默认防护类型的公网IP。
service_managed bool: 是否由服务管理
status str: 公网IP的状态。Attaching：绑定中。Detaching：解绑中。Attached：已绑定。Available：可用。Deleting：删除中。
tags Sequence[GetEipTag]: 公网IP的标签信息
updated_time str: 更新公网IP的时间。

allocationId String: 公网IP的ID。
bandwidth Number: 公网IP的带宽上限，默认为“1”，单位：Mbps,BillingType传入1：取值范围1 ~ 500。BillingType传入2：取值范围1 ~ 500。BillingType传入3：取值范围1 ~ 200。
bandwidthPackageId String: 共享带宽包的ID，表示将公网IP加入到共享带宽包。公网IP加入到共享带宽包必须同时满足如下条件：二者的安全防护类型相同。二者的地域相同。公网IP的计费方式必须是按量计费。共享带宽包为IPv4类型。
billingType Number: 公网IP的计费方式。取值如下：1：包年包月。2：按量计费-按带宽上限计费。3：按量计费-按实际流量计费。
businessStatus String: 公网IP是否被锁定。Normal: 正常。FinancialLocked: 被锁定。
createdTime String: 公网IP的创建时间。
deletedTime String: 预期资源强制回收时间。包年包月公网IP，此参数有返回值。按量计费公网IP，仅欠费冻结时，此参数有返回值。
description String: 公网IP的描述信息。
directMode Boolean: 绑定公网IP时是否启用直通模式。请严格按照以下枚举值的大小写输入，不要传入其他取值。false（默认）：不使用直通模式。true：使用直通模式。
eipAddress String: 公网IP地址。
expiredTime String: 公网IP的到期时间。包年包月，返回值为到期时间。按量计费，返回值为空。
id String: Uniquely identifies the resource.
instanceId String: 当前绑定的实例ID。
instanceType String: 当前绑定的实例类型。Nat：公网NAT网关。NetworkInterface: 弹性网卡。ClbInstance: 负载均衡。EcsInstance：云服务器。HaVip：高可用虚拟IP。
ipAddress String: 申请申请指定的公网IP地址。仅支持填写使用后释放的IP地址，不填则表示自动分配。指定的公网IP地址
ipAddressPoolId String: IP地址池的ID。
isBlocked Boolean: 是否被封禁。true：是。false：否。
isp String: 线路类型。BGP：BGP（多线）。ChinaMobile：中国移动静态单线。ChinaTelecom：中国电信静态单线。ChinaUnicom：中国联通静态单线。SingleLineBGP：BGP单线。FusionBGP：融合BGP。ChinaMobileValue：中国移动惠选型静态单线。ChinaUnicomValue：中国联通惠选型静态单线。ChinaTelecom_Value：中国电信惠选型静态单线。
lockReason String: 公网IP被锁定的原因。financial: 因欠费被锁定。unlock: 欠费关停后充值恢复过程中。空值 : 没有被锁定。
name String: 公网IP的名称。
overdueTime String: 资源冻结时间。仅当资源因为欠费冻结，此参数才会有返回值。
period Number: 代表购买包年包月公网IP的时长时，默认为“1”。当PeriodUnit传入1，Period取值范围：1~9、12、24、36、48、60。当PeriodUnit传入2，Period取值范围：1～5。代表临时升配的时长时：单位为小时，取值范围：1～720。
periodUnit Number: 购买包年包月公网IP时长的单位。取值如下：1（默认值）：月。2 ：年。
privateIpAddress String: 要绑定公网IP的实例的私网IP地址。只支持传入云服务ECS主网卡的私网IP地址和辅助网卡IP地址。若不填写：InstanceType传入EcsInstance，则绑定云服务器ECS主网卡的主私网IP地址。InstanceType传入NetworkInterface，则绑定辅助网卡主私网IP地址。
projectName String: 公网IP所属项目的名称。
releaseWithInstance Boolean: 是否随云服务器实例删除。仅按量计费公网IP有效。开启后，当云服务器实例被系统自动回收（退订24小时后、到期回收、欠费回收）或被调用DeleteInstances接口时，公网IP随其一同释放。true：是。false：否。
renewPeriodTimes Number: 自动续费的时长，取值范围1、2、3、6、12，单位：月。若RenewType传入2，则必须传入RenewPeriodTimes
renewType Number: 包年包月公网IP续费的方式。取值如下：1（默认值）：手动续费。2：自动续费。3：到期不续费。
securityProtectionInstanceId Number: DDoS原生防护（企业版）ID。您可以调用 DescInstanceList 接口，查询DDoS原生防护（企业版）的ID。当SecurityProtectionTypes传入AntiDDoS_Enhanced时，此参数必须传入。
securityProtectionTypes List<String>: 防护类型。AntiDDoS_Enhanced：增强防护类型的公网IP，可以加入到DDoS原生防护（企业版）实例。空值：默认防护类型的公网IP。
serviceManaged Boolean: 是否由服务管理
status String: 公网IP的状态。Attaching：绑定中。Detaching：解绑中。Attached：已绑定。Available：可用。Deleting：删除中。
tags List<Property Map>: 公网IP的标签信息
updatedTime String: 更新公网IP的时间。

Supporting Types

GetEipTag

Key string: 标签键。
Value string: 标签值。

Key string: 标签键。
Value string: 标签值。

key String: 标签键。
value String: 标签值。

key string: 标签键。
value string: 标签值。

key str: 标签键。
value str: 标签值。

key String: 标签键。
value String: 标签值。

Package Details

Repository: bytepluscc byteplus-sdk/pulumi-bytepluscc
License: MPL-2.0
Notes: This Pulumi package is based on the bytepluscc Terraform Provider.

Viewing docs for bytepluscc v0.0.16
published on Monday, Mar 9, 2026 by Byteplus

Schema (JSON)

byteplus-sdk/pulumi-bytepluscc

bytepluscc.vpc.getEip

On this page

On this page

Using getEip

getEip Result

Supporting Types

GetEipTag

Package Details

On this page

On this page