1. Packages
  2. Bytepluscc Provider
  3. API Docs
  4. natgateway
  5. getNatIp
Viewing docs for bytepluscc v0.0.16
published on Monday, Mar 9, 2026 by Byteplus
Schema (JSON)
byteplus-sdk/pulumi-bytepluscc

bytepluscc.natgateway.getNatIp

bytepluscc logo
Viewing docs for bytepluscc v0.0.16
published on Monday, Mar 9, 2026 by Byteplus
Schema (JSON)
byteplus-sdk/pulumi-bytepluscc

    Data Source schema for Byteplus::NatGateway::NatIp

    Using getNatIp

    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 getNatIp(args: GetNatIpArgs, opts?: InvokeOptions): Promise<GetNatIpResult>
function getNatIpOutput(args: GetNatIpOutputArgs, opts?: InvokeOptions): Output<GetNatIpResult>
    def get_nat_ip(id: Optional[str] = None,
               opts: Optional[InvokeOptions] = None) -> GetNatIpResult
def get_nat_ip_output(id: Optional[pulumi.Input[str]] = None,
               opts: Optional[InvokeOptions] = None) -> Output[GetNatIpResult]
    func LookupNatIp(ctx *Context, args *LookupNatIpArgs, opts ...InvokeOption) (*LookupNatIpResult, error)
func LookupNatIpOutput(ctx *Context, args *LookupNatIpOutputArgs, opts ...InvokeOption) LookupNatIpResultOutput

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

    public static class GetNatIp 
{
    public static Task<GetNatIpResult> InvokeAsync(GetNatIpArgs args, InvokeOptions? opts = null)
    public static Output<GetNatIpResult> Invoke(GetNatIpInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetNatIpResult> getNatIp(GetNatIpArgs args, InvokeOptions options)
public static Output<GetNatIpResult> getNatIp(GetNatIpArgs args, InvokeOptions options)

    fn::invoke:
  function: bytepluscc:natgateway/getNatIp:getNatIp
  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.

    getNatIp Result

    The following output properties are available:

    Id string
    Uniquely identifies the resource.
    IsDefault bool
    是否为默认中转IP。true：是。false：否。
    NatGatewayId string
    私网NAT网关ID。
    NatIp string
    中转IP的地址。若不填，则系统自动从私网NAT网关所在子网随机分配一个空闲的IP地址。
    NatIpDescription string
    中转IP的描述。长度限制为0~ 255个字符。不填默认为空字符串。需要以字母、中文或数字开头。可包含英文逗号（,）、点号（.）、下划线（_）、空格（ ）、等号（=）、短横线（-）、中文逗号（，）、中文句号（。）。
    NatIpId string
    中转IP的ID。
    NatIpName string
    中转IP的名称。长度限制为1 ~ 128个字符。需要以字母、中文或数字开头，可包含点号（.）、下划线（_）和短划线（-）。不填默认为中转IP的ID。
    Status string
    中转IP的状态。Creating：创建中。Available：可用。Deleting：删除中。Deleted：已删除。
    UsingStatus string
    中转IP的使用状态。Idle：未使用。UsedBySnat：被SNAT规则使用。UsedByDnat：被DNAT规则使用。UsedByNat：被SNAT/DNAT规则同时使用。
    Id string
    Uniquely identifies the resource.
    IsDefault bool
    是否为默认中转IP。true：是。false：否。
    NatGatewayId string
    私网NAT网关ID。
    NatIp string
    中转IP的地址。若不填，则系统自动从私网NAT网关所在子网随机分配一个空闲的IP地址。
    NatIpDescription string
    中转IP的描述。长度限制为0~ 255个字符。不填默认为空字符串。需要以字母、中文或数字开头。可包含英文逗号（,）、点号（.）、下划线（_）、空格（ ）、等号（=）、短横线（-）、中文逗号（，）、中文句号（。）。
    NatIpId string
    中转IP的ID。
    NatIpName string
    中转IP的名称。长度限制为1 ~ 128个字符。需要以字母、中文或数字开头，可包含点号（.）、下划线（_）和短划线（-）。不填默认为中转IP的ID。
    Status string
    中转IP的状态。Creating：创建中。Available：可用。Deleting：删除中。Deleted：已删除。
    UsingStatus string
    中转IP的使用状态。Idle：未使用。UsedBySnat：被SNAT规则使用。UsedByDnat：被DNAT规则使用。UsedByNat：被SNAT/DNAT规则同时使用。
    id String
    Uniquely identifies the resource.
    isDefault Boolean
    是否为默认中转IP。true：是。false：否。
    natGatewayId String
    私网NAT网关ID。
    natIp String
    中转IP的地址。若不填，则系统自动从私网NAT网关所在子网随机分配一个空闲的IP地址。
    natIpDescription String
    中转IP的描述。长度限制为0~ 255个字符。不填默认为空字符串。需要以字母、中文或数字开头。可包含英文逗号（,）、点号（.）、下划线（_）、空格（ ）、等号（=）、短横线（-）、中文逗号（，）、中文句号（。）。
    natIpId String
    中转IP的ID。
    natIpName String
    中转IP的名称。长度限制为1 ~ 128个字符。需要以字母、中文或数字开头，可包含点号（.）、下划线（_）和短划线（-）。不填默认为中转IP的ID。
    status String
    中转IP的状态。Creating：创建中。Available：可用。Deleting：删除中。Deleted：已删除。
    usingStatus String
    中转IP的使用状态。Idle：未使用。UsedBySnat：被SNAT规则使用。UsedByDnat：被DNAT规则使用。UsedByNat：被SNAT/DNAT规则同时使用。
    id string
    Uniquely identifies the resource.
    isDefault boolean
    是否为默认中转IP。true：是。false：否。
    natGatewayId string
    私网NAT网关ID。
    natIp string
    中转IP的地址。若不填，则系统自动从私网NAT网关所在子网随机分配一个空闲的IP地址。
    natIpDescription string
    中转IP的描述。长度限制为0~ 255个字符。不填默认为空字符串。需要以字母、中文或数字开头。可包含英文逗号（,）、点号（.）、下划线（_）、空格（ ）、等号（=）、短横线（-）、中文逗号（，）、中文句号（。）。
    natIpId string
    中转IP的ID。
    natIpName string
    中转IP的名称。长度限制为1 ~ 128个字符。需要以字母、中文或数字开头，可包含点号（.）、下划线（_）和短划线（-）。不填默认为中转IP的ID。
    status string
    中转IP的状态。Creating：创建中。Available：可用。Deleting：删除中。Deleted：已删除。
    usingStatus string
    中转IP的使用状态。Idle：未使用。UsedBySnat：被SNAT规则使用。UsedByDnat：被DNAT规则使用。UsedByNat：被SNAT/DNAT规则同时使用。
    id str
    Uniquely identifies the resource.
    is_default bool
    是否为默认中转IP。true：是。false：否。
    nat_gateway_id str
    私网NAT网关ID。
    nat_ip str
    中转IP的地址。若不填，则系统自动从私网NAT网关所在子网随机分配一个空闲的IP地址。
    nat_ip_description str
    中转IP的描述。长度限制为0~ 255个字符。不填默认为空字符串。需要以字母、中文或数字开头。可包含英文逗号（,）、点号（.）、下划线（_）、空格（ ）、等号（=）、短横线（-）、中文逗号（，）、中文句号（。）。
    nat_ip_id str
    中转IP的ID。
    nat_ip_name str
    中转IP的名称。长度限制为1 ~ 128个字符。需要以字母、中文或数字开头，可包含点号（.）、下划线（_）和短划线（-）。不填默认为中转IP的ID。
    status str
    中转IP的状态。Creating：创建中。Available：可用。Deleting：删除中。Deleted：已删除。
    using_status str
    中转IP的使用状态。Idle：未使用。UsedBySnat：被SNAT规则使用。UsedByDnat：被DNAT规则使用。UsedByNat：被SNAT/DNAT规则同时使用。
    id String
    Uniquely identifies the resource.
    isDefault Boolean
    是否为默认中转IP。true：是。false：否。
    natGatewayId String
    私网NAT网关ID。
    natIp String
    中转IP的地址。若不填，则系统自动从私网NAT网关所在子网随机分配一个空闲的IP地址。
    natIpDescription String
    中转IP的描述。长度限制为0~ 255个字符。不填默认为空字符串。需要以字母、中文或数字开头。可包含英文逗号（,）、点号（.）、下划线（_）、空格（ ）、等号（=）、短横线（-）、中文逗号（，）、中文句号（。）。
    natIpId String
    中转IP的ID。
    natIpName String
    中转IP的名称。长度限制为1 ~ 128个字符。需要以字母、中文或数字开头，可包含点号（.）、下划线（_）和短划线（-）。不填默认为中转IP的ID。
    status String
    中转IP的状态。Creating：创建中。Available：可用。Deleting：删除中。Deleted：已删除。
    usingStatus String
    中转IP的使用状态。Idle：未使用。UsedBySnat：被SNAT规则使用。UsedByDnat：被DNAT规则使用。UsedByNat：被SNAT/DNAT规则同时使用。

    Package Details

    Repository
    bytepluscc byteplus-sdk/pulumi-bytepluscc
    License
    MPL-2.0
    Notes
    This Pulumi package is based on the bytepluscc Terraform Provider.
    bytepluscc logo
    Viewing docs for bytepluscc v0.0.16
    published on Monday, Mar 9, 2026 by Byteplus
    Schema (JSON)
    byteplus-sdk/pulumi-bytepluscc
      Try Pulumi Cloud free. Your team will thank you.