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

bytepluscc.vpn.getCustomerGateway

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::VPN::CustomerGateway

    Using getCustomerGateway

    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 getCustomerGateway(args: GetCustomerGatewayArgs, opts?: InvokeOptions): Promise<GetCustomerGatewayResult>
function getCustomerGatewayOutput(args: GetCustomerGatewayOutputArgs, opts?: InvokeOptions): Output<GetCustomerGatewayResult>
    def get_customer_gateway(id: Optional[str] = None,
                         opts: Optional[InvokeOptions] = None) -> GetCustomerGatewayResult
def get_customer_gateway_output(id: Optional[pulumi.Input[str]] = None,
                         opts: Optional[InvokeOptions] = None) -> Output[GetCustomerGatewayResult]
    func LookupCustomerGateway(ctx *Context, args *LookupCustomerGatewayArgs, opts ...InvokeOption) (*LookupCustomerGatewayResult, error)
func LookupCustomerGatewayOutput(ctx *Context, args *LookupCustomerGatewayOutputArgs, opts ...InvokeOption) LookupCustomerGatewayResultOutput

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

    public static class GetCustomerGateway 
{
    public static Task<GetCustomerGatewayResult> InvokeAsync(GetCustomerGatewayArgs args, InvokeOptions? opts = null)
    public static Output<GetCustomerGatewayResult> Invoke(GetCustomerGatewayInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetCustomerGatewayResult> getCustomerGateway(GetCustomerGatewayArgs args, InvokeOptions options)
public static Output<GetCustomerGatewayResult> getCustomerGateway(GetCustomerGatewayArgs args, InvokeOptions options)

    fn::invoke:
  function: bytepluscc:vpn/getCustomerGateway:getCustomerGateway
  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.

    getCustomerGateway Result

    The following output properties are available:

    AccountId string
    用户网关所属账户的ID。
    Asn int
    用户网关的ASN（Autonomous System Number）。如需使用BGP功能，则此参数必须填写。ASN有效范围1～4294967295（137718 、150436、65533除外）。
    ConnectionCount int
    用户网关关联的IPsec连接的数量。
    CreatedTime string
    创建用户网关的时间。
    CustomerGatewayId string
    网关ID。
    CustomerGatewayName string
    用户网关的名称。以中文、字母、数字开头，只能包含中文、字母、数字、点号（.）、下划线（_）和短划线（-）。长度限制为1 ~ 128个字符。不填默认为用户网关的ID。
    Description string
    用户网关的描述信息。以中文、字母、数字开头，只能包含中文、字母、数字、点号（.）、空格（ ）、下划线（_）、中划线（-）、等号（=）、英文逗号（,）、中文逗号（，）、中文句号（。）。长度限制为0 ~ 255个字符。不填默认为空字符串。
    Id string
    Uniquely identifies the resource.
    IpAddress string
    对端本地数据中心网关的静态公网IP地址或其他VPC的VPN网关出口IP地址。若对端为非固定静态公网IP，此处需传入0.0.0.0。
    IpVersion string
    VPN网关的IP地址协议类型，取值如下：ipv4 （默认值）ipv6
    ProjectName string
    用户网关所属的项目。不填默认为default，即创建的资源属于default项目。
    Status string
    用户网关的状态。Creating: 创建中。Deleting: 删除中。Pending：配置中。Available：可用。
    Tags List<Byteplus.GetCustomerGatewayTag>
    标签列表。
    UpdatedTime string
    更新用户网关的时间。
    AccountId string
    用户网关所属账户的ID。
    Asn int
    用户网关的ASN（Autonomous System Number）。如需使用BGP功能，则此参数必须填写。ASN有效范围1～4294967295（137718 、150436、65533除外）。
    ConnectionCount int
    用户网关关联的IPsec连接的数量。
    CreatedTime string
    创建用户网关的时间。
    CustomerGatewayId string
    网关ID。
    CustomerGatewayName string
    用户网关的名称。以中文、字母、数字开头，只能包含中文、字母、数字、点号（.）、下划线（_）和短划线（-）。长度限制为1 ~ 128个字符。不填默认为用户网关的ID。
    Description string
    用户网关的描述信息。以中文、字母、数字开头，只能包含中文、字母、数字、点号（.）、空格（ ）、下划线（_）、中划线（-）、等号（=）、英文逗号（,）、中文逗号（，）、中文句号（。）。长度限制为0 ~ 255个字符。不填默认为空字符串。
    Id string
    Uniquely identifies the resource.
    IpAddress string
    对端本地数据中心网关的静态公网IP地址或其他VPC的VPN网关出口IP地址。若对端为非固定静态公网IP，此处需传入0.0.0.0。
    IpVersion string
    VPN网关的IP地址协议类型，取值如下：ipv4 （默认值）ipv6
    ProjectName string
    用户网关所属的项目。不填默认为default，即创建的资源属于default项目。
    Status string
    用户网关的状态。Creating: 创建中。Deleting: 删除中。Pending：配置中。Available：可用。
    Tags []GetCustomerGatewayTag
    标签列表。
    UpdatedTime string
    更新用户网关的时间。
    accountId String
    用户网关所属账户的ID。
    asn Integer
    用户网关的ASN（Autonomous System Number）。如需使用BGP功能，则此参数必须填写。ASN有效范围1～4294967295（137718 、150436、65533除外）。
    connectionCount Integer
    用户网关关联的IPsec连接的数量。
    createdTime String
    创建用户网关的时间。
    customerGatewayId String
    网关ID。
    customerGatewayName String
    用户网关的名称。以中文、字母、数字开头，只能包含中文、字母、数字、点号（.）、下划线（_）和短划线（-）。长度限制为1 ~ 128个字符。不填默认为用户网关的ID。
    description String
    用户网关的描述信息。以中文、字母、数字开头，只能包含中文、字母、数字、点号（.）、空格（ ）、下划线（_）、中划线（-）、等号（=）、英文逗号（,）、中文逗号（，）、中文句号（。）。长度限制为0 ~ 255个字符。不填默认为空字符串。
    id String
    Uniquely identifies the resource.
    ipAddress String
    对端本地数据中心网关的静态公网IP地址或其他VPC的VPN网关出口IP地址。若对端为非固定静态公网IP，此处需传入0.0.0.0。
    ipVersion String
    VPN网关的IP地址协议类型，取值如下：ipv4 （默认值）ipv6
    projectName String
    用户网关所属的项目。不填默认为default，即创建的资源属于default项目。
    status String
    用户网关的状态。Creating: 创建中。Deleting: 删除中。Pending：配置中。Available：可用。
    tags List<GetCustomerGatewayTag>
    标签列表。
    updatedTime String
    更新用户网关的时间。
    accountId string
    用户网关所属账户的ID。
    asn number
    用户网关的ASN（Autonomous System Number）。如需使用BGP功能，则此参数必须填写。ASN有效范围1～4294967295（137718 、150436、65533除外）。
    connectionCount number
    用户网关关联的IPsec连接的数量。
    createdTime string
    创建用户网关的时间。
    customerGatewayId string
    网关ID。
    customerGatewayName string
    用户网关的名称。以中文、字母、数字开头，只能包含中文、字母、数字、点号（.）、下划线（_）和短划线（-）。长度限制为1 ~ 128个字符。不填默认为用户网关的ID。
    description string
    用户网关的描述信息。以中文、字母、数字开头，只能包含中文、字母、数字、点号（.）、空格（ ）、下划线（_）、中划线（-）、等号（=）、英文逗号（,）、中文逗号（，）、中文句号（。）。长度限制为0 ~ 255个字符。不填默认为空字符串。
    id string
    Uniquely identifies the resource.
    ipAddress string
    对端本地数据中心网关的静态公网IP地址或其他VPC的VPN网关出口IP地址。若对端为非固定静态公网IP，此处需传入0.0.0.0。
    ipVersion string
    VPN网关的IP地址协议类型，取值如下：ipv4 （默认值）ipv6
    projectName string
    用户网关所属的项目。不填默认为default，即创建的资源属于default项目。
    status string
    用户网关的状态。Creating: 创建中。Deleting: 删除中。Pending：配置中。Available：可用。
    tags GetCustomerGatewayTag[]
    标签列表。
    updatedTime string
    更新用户网关的时间。
    account_id str
    用户网关所属账户的ID。
    asn int
    用户网关的ASN（Autonomous System Number）。如需使用BGP功能，则此参数必须填写。ASN有效范围1～4294967295（137718 、150436、65533除外）。
    connection_count int
    用户网关关联的IPsec连接的数量。
    created_time str
    创建用户网关的时间。
    customer_gateway_id str
    网关ID。
    customer_gateway_name str
    用户网关的名称。以中文、字母、数字开头，只能包含中文、字母、数字、点号（.）、下划线（_）和短划线（-）。长度限制为1 ~ 128个字符。不填默认为用户网关的ID。
    description str
    用户网关的描述信息。以中文、字母、数字开头，只能包含中文、字母、数字、点号（.）、空格（ ）、下划线（_）、中划线（-）、等号（=）、英文逗号（,）、中文逗号（，）、中文句号（。）。长度限制为0 ~ 255个字符。不填默认为空字符串。
    id str
    Uniquely identifies the resource.
    ip_address str
    对端本地数据中心网关的静态公网IP地址或其他VPC的VPN网关出口IP地址。若对端为非固定静态公网IP，此处需传入0.0.0.0。
    ip_version str
    VPN网关的IP地址协议类型，取值如下：ipv4 （默认值）ipv6
    project_name str
    用户网关所属的项目。不填默认为default，即创建的资源属于default项目。
    status str
    用户网关的状态。Creating: 创建中。Deleting: 删除中。Pending：配置中。Available：可用。
    tags Sequence[GetCustomerGatewayTag]
    标签列表。
    updated_time str
    更新用户网关的时间。
    accountId String
    用户网关所属账户的ID。
    asn Number
    用户网关的ASN（Autonomous System Number）。如需使用BGP功能，则此参数必须填写。ASN有效范围1～4294967295（137718 、150436、65533除外）。
    connectionCount Number
    用户网关关联的IPsec连接的数量。
    createdTime String
    创建用户网关的时间。
    customerGatewayId String
    网关ID。
    customerGatewayName String
    用户网关的名称。以中文、字母、数字开头，只能包含中文、字母、数字、点号（.）、下划线（_）和短划线（-）。长度限制为1 ~ 128个字符。不填默认为用户网关的ID。
    description String
    用户网关的描述信息。以中文、字母、数字开头，只能包含中文、字母、数字、点号（.）、空格（ ）、下划线（_）、中划线（-）、等号（=）、英文逗号（,）、中文逗号（，）、中文句号（。）。长度限制为0 ~ 255个字符。不填默认为空字符串。
    id String
    Uniquely identifies the resource.
    ipAddress String
    对端本地数据中心网关的静态公网IP地址或其他VPC的VPN网关出口IP地址。若对端为非固定静态公网IP，此处需传入0.0.0.0。
    ipVersion String
    VPN网关的IP地址协议类型，取值如下：ipv4 （默认值）ipv6
    projectName String
    用户网关所属的项目。不填默认为default，即创建的资源属于default项目。
    status String
    用户网关的状态。Creating: 创建中。Deleting: 删除中。Pending：配置中。Available：可用。
    tags List<Property Map>
    标签列表。
    updatedTime String
    更新用户网关的时间。

    Supporting Types

    GetCustomerGatewayTag

    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.
    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.