1. Packages
  2. Packages
  3. Volcenginecc Provider
  4. API Docs
  5. privatelink
  6. getVpcEndpoint
Viewing docs for volcenginecc v0.0.32
published on Thursday, Apr 23, 2026 by Volcengine
volcenginecc logo
Viewing docs for volcenginecc v0.0.32
published on Thursday, Apr 23, 2026 by Volcengine

    Data Source schema for Volcengine::PrivateLink::VpcEndpoint

    Using getVpcEndpoint

    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 getVpcEndpoint(args: GetVpcEndpointArgs, opts?: InvokeOptions): Promise<GetVpcEndpointResult>
    function getVpcEndpointOutput(args: GetVpcEndpointOutputArgs, opts?: InvokeOptions): Output<GetVpcEndpointResult>
    def get_vpc_endpoint(id: Optional[str] = None,
                         opts: Optional[InvokeOptions] = None) -> GetVpcEndpointResult
    def get_vpc_endpoint_output(id: Optional[pulumi.Input[str]] = None,
                         opts: Optional[InvokeOptions] = None) -> Output[GetVpcEndpointResult]
    func LookupVpcEndpoint(ctx *Context, args *LookupVpcEndpointArgs, opts ...InvokeOption) (*LookupVpcEndpointResult, error)
    func LookupVpcEndpointOutput(ctx *Context, args *LookupVpcEndpointOutputArgs, opts ...InvokeOption) LookupVpcEndpointResultOutput

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

    public static class GetVpcEndpoint 
    {
        public static Task<GetVpcEndpointResult> InvokeAsync(GetVpcEndpointArgs args, InvokeOptions? opts = null)
        public static Output<GetVpcEndpointResult> Invoke(GetVpcEndpointInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetVpcEndpointResult> getVpcEndpoint(GetVpcEndpointArgs args, InvokeOptions options)
    public static Output<GetVpcEndpointResult> getVpcEndpoint(GetVpcEndpointArgs args, InvokeOptions options)
    
    fn::invoke:
      function: volcenginecc:privatelink/getVpcEndpoint:getVpcEndpoint
      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.

    getVpcEndpoint Result

    The following output properties are available:

    Bps int
    Maximum bandwidth limit for the endpoint node connection, in Mbps.
    BusinessStatus string
    Whether the endpoint is locked. Normal: Normal. FinancialLocked: Locked. If this parameter is empty, the endpoint is not locked.
    ConnectionStatus string
    Status of the endpoint node connection. PendingAcceptance: waiting for connection. Connecting: connecting. Connected: connected. Disconnecting: disconnecting. Rejected: connection rejected. Failed: connection failed. PartialFailed: partial connection failure. ServiceDeleted: service deleted.
    CreationTime string
    Creation time of the endpoint.
    DeletedTime string
    Deletion time of the endpoint.
    Description string
    Description of the endpoint node. The default value is an empty string. It must start with a letter, number, or Chinese character, and can include letters, numbers, Chinese characters, and the following special characters: comma (,), period (.), underscore (_), space ( ), equals sign (=), hyphen (-), Chinese comma (,), and Chinese period (。). Length limit: 0–255 characters.
    EndpointDomain string
    Domain name of the endpoint.
    EndpointId string
    ID of the endpoint node.
    EndpointIndex int
    Endpoint index
    EndpointName string
    Endpoint name. Must start with a letter, number, or Chinese character. Can include letters, numbers, Chinese characters, and the following special characters: period (.), underscore (_), and hyphen (-). Length must be between 1 and 128 characters. If not specified, defaults to the endpoint ID.
    EndpointType string
    Type of the endpoint node. Interface: interface endpoint node.
    Id string
    Uniquely identifies the resource.
    IpAddressVersions List<string>
    IP protocol type for the interface endpoint. Options are ipv4 and ipv6. The default for interface endpoints is ipv4. If only ipv4 is used, do not provide this parameter. If the interface endpoint is dual stack (ipv4 & ipv6), you must provide this parameter. Before providing it, ensure the following: your account has enabled IPv6 for private network connections; the subnet associated with the interface endpoint has enabled the IPv6 segment; the endpoint service associated with the interface endpoint is dual stack. Parameter -N: indicates the sequence number of the IP protocol type for the interface endpoint, with a range of 1–2. Use & to separate the sequence numbers of the two IP protocol types. Currently, only providing IPv6 is not supported.
    Payer string
    Billing account for the private network connection. Endpoint: endpoint account. EndpointService: endpoint service account.
    PrivateDnsEnabled bool
    Enable private DNS name. false (default): disabled. true: enabled.
    PrivateDnsName string
    The private DNS name of the endpoint node. If the parameter PrivateDNSEnabled returns false, this parameter is empty.
    ProjectName string
    Name of the project to which the endpoint node belongs.
    SecurityGroupIds List<string>
    ID of the security group to be bound to the endpoint. You can call the DescribeSecurityGroups API to obtain the security group ID. Parameter -N: Indicates the sequence number of the security group ID, value range: 1–5. Separate multiple security group IDs with &.
    ServiceId string
    ID of the endpoint service to be associated. You can call the DescribeVpcEndpointServices API to obtain the endpoint service ID.
    ServiceManaged bool
    Whether the endpoint is managed. false: Unmanaged endpoint. true: Managed endpoint.
    ServiceName string
    Name of the endpoint service to be associated.
    Status string
    Status of the endpoint. Creating: Creating. Pending: Modifying configuration. Available: Available. Deleting: Deleting.
    Tags List<Volcengine.GetVpcEndpointTag>
    Endpoint user tag.
    UpdateTime string
    Most recent operation time of the endpoint.
    VpcId string
    ID of the VPC to which the endpoint belongs. You can call the DescribeVpcs API to obtain the VPC ID.
    Zones List<Volcengine.GetVpcEndpointZone>
    Availability zone of the endpoint node.
    Bps int
    Maximum bandwidth limit for the endpoint node connection, in Mbps.
    BusinessStatus string
    Whether the endpoint is locked. Normal: Normal. FinancialLocked: Locked. If this parameter is empty, the endpoint is not locked.
    ConnectionStatus string
    Status of the endpoint node connection. PendingAcceptance: waiting for connection. Connecting: connecting. Connected: connected. Disconnecting: disconnecting. Rejected: connection rejected. Failed: connection failed. PartialFailed: partial connection failure. ServiceDeleted: service deleted.
    CreationTime string
    Creation time of the endpoint.
    DeletedTime string
    Deletion time of the endpoint.
    Description string
    Description of the endpoint node. The default value is an empty string. It must start with a letter, number, or Chinese character, and can include letters, numbers, Chinese characters, and the following special characters: comma (,), period (.), underscore (_), space ( ), equals sign (=), hyphen (-), Chinese comma (,), and Chinese period (。). Length limit: 0–255 characters.
    EndpointDomain string
    Domain name of the endpoint.
    EndpointId string
    ID of the endpoint node.
    EndpointIndex int
    Endpoint index
    EndpointName string
    Endpoint name. Must start with a letter, number, or Chinese character. Can include letters, numbers, Chinese characters, and the following special characters: period (.), underscore (_), and hyphen (-). Length must be between 1 and 128 characters. If not specified, defaults to the endpoint ID.
    EndpointType string
    Type of the endpoint node. Interface: interface endpoint node.
    Id string
    Uniquely identifies the resource.
    IpAddressVersions []string
    IP protocol type for the interface endpoint. Options are ipv4 and ipv6. The default for interface endpoints is ipv4. If only ipv4 is used, do not provide this parameter. If the interface endpoint is dual stack (ipv4 & ipv6), you must provide this parameter. Before providing it, ensure the following: your account has enabled IPv6 for private network connections; the subnet associated with the interface endpoint has enabled the IPv6 segment; the endpoint service associated with the interface endpoint is dual stack. Parameter -N: indicates the sequence number of the IP protocol type for the interface endpoint, with a range of 1–2. Use & to separate the sequence numbers of the two IP protocol types. Currently, only providing IPv6 is not supported.
    Payer string
    Billing account for the private network connection. Endpoint: endpoint account. EndpointService: endpoint service account.
    PrivateDnsEnabled bool
    Enable private DNS name. false (default): disabled. true: enabled.
    PrivateDnsName string
    The private DNS name of the endpoint node. If the parameter PrivateDNSEnabled returns false, this parameter is empty.
    ProjectName string
    Name of the project to which the endpoint node belongs.
    SecurityGroupIds []string
    ID of the security group to be bound to the endpoint. You can call the DescribeSecurityGroups API to obtain the security group ID. Parameter -N: Indicates the sequence number of the security group ID, value range: 1–5. Separate multiple security group IDs with &.
    ServiceId string
    ID of the endpoint service to be associated. You can call the DescribeVpcEndpointServices API to obtain the endpoint service ID.
    ServiceManaged bool
    Whether the endpoint is managed. false: Unmanaged endpoint. true: Managed endpoint.
    ServiceName string
    Name of the endpoint service to be associated.
    Status string
    Status of the endpoint. Creating: Creating. Pending: Modifying configuration. Available: Available. Deleting: Deleting.
    Tags []GetVpcEndpointTag
    Endpoint user tag.
    UpdateTime string
    Most recent operation time of the endpoint.
    VpcId string
    ID of the VPC to which the endpoint belongs. You can call the DescribeVpcs API to obtain the VPC ID.
    Zones []GetVpcEndpointZone
    Availability zone of the endpoint node.
    bps Integer
    Maximum bandwidth limit for the endpoint node connection, in Mbps.
    businessStatus String
    Whether the endpoint is locked. Normal: Normal. FinancialLocked: Locked. If this parameter is empty, the endpoint is not locked.
    connectionStatus String
    Status of the endpoint node connection. PendingAcceptance: waiting for connection. Connecting: connecting. Connected: connected. Disconnecting: disconnecting. Rejected: connection rejected. Failed: connection failed. PartialFailed: partial connection failure. ServiceDeleted: service deleted.
    creationTime String
    Creation time of the endpoint.
    deletedTime String
    Deletion time of the endpoint.
    description String
    Description of the endpoint node. The default value is an empty string. It must start with a letter, number, or Chinese character, and can include letters, numbers, Chinese characters, and the following special characters: comma (,), period (.), underscore (_), space ( ), equals sign (=), hyphen (-), Chinese comma (,), and Chinese period (。). Length limit: 0–255 characters.
    endpointDomain String
    Domain name of the endpoint.
    endpointId String
    ID of the endpoint node.
    endpointIndex Integer
    Endpoint index
    endpointName String
    Endpoint name. Must start with a letter, number, or Chinese character. Can include letters, numbers, Chinese characters, and the following special characters: period (.), underscore (_), and hyphen (-). Length must be between 1 and 128 characters. If not specified, defaults to the endpoint ID.
    endpointType String
    Type of the endpoint node. Interface: interface endpoint node.
    id String
    Uniquely identifies the resource.
    ipAddressVersions List<String>
    IP protocol type for the interface endpoint. Options are ipv4 and ipv6. The default for interface endpoints is ipv4. If only ipv4 is used, do not provide this parameter. If the interface endpoint is dual stack (ipv4 & ipv6), you must provide this parameter. Before providing it, ensure the following: your account has enabled IPv6 for private network connections; the subnet associated with the interface endpoint has enabled the IPv6 segment; the endpoint service associated with the interface endpoint is dual stack. Parameter -N: indicates the sequence number of the IP protocol type for the interface endpoint, with a range of 1–2. Use & to separate the sequence numbers of the two IP protocol types. Currently, only providing IPv6 is not supported.
    payer String
    Billing account for the private network connection. Endpoint: endpoint account. EndpointService: endpoint service account.
    privateDnsEnabled Boolean
    Enable private DNS name. false (default): disabled. true: enabled.
    privateDnsName String
    The private DNS name of the endpoint node. If the parameter PrivateDNSEnabled returns false, this parameter is empty.
    projectName String
    Name of the project to which the endpoint node belongs.
    securityGroupIds List<String>
    ID of the security group to be bound to the endpoint. You can call the DescribeSecurityGroups API to obtain the security group ID. Parameter -N: Indicates the sequence number of the security group ID, value range: 1–5. Separate multiple security group IDs with &.
    serviceId String
    ID of the endpoint service to be associated. You can call the DescribeVpcEndpointServices API to obtain the endpoint service ID.
    serviceManaged Boolean
    Whether the endpoint is managed. false: Unmanaged endpoint. true: Managed endpoint.
    serviceName String
    Name of the endpoint service to be associated.
    status String
    Status of the endpoint. Creating: Creating. Pending: Modifying configuration. Available: Available. Deleting: Deleting.
    tags List<GetVpcEndpointTag>
    Endpoint user tag.
    updateTime String
    Most recent operation time of the endpoint.
    vpcId String
    ID of the VPC to which the endpoint belongs. You can call the DescribeVpcs API to obtain the VPC ID.
    zones List<GetVpcEndpointZone>
    Availability zone of the endpoint node.
    bps number
    Maximum bandwidth limit for the endpoint node connection, in Mbps.
    businessStatus string
    Whether the endpoint is locked. Normal: Normal. FinancialLocked: Locked. If this parameter is empty, the endpoint is not locked.
    connectionStatus string
    Status of the endpoint node connection. PendingAcceptance: waiting for connection. Connecting: connecting. Connected: connected. Disconnecting: disconnecting. Rejected: connection rejected. Failed: connection failed. PartialFailed: partial connection failure. ServiceDeleted: service deleted.
    creationTime string
    Creation time of the endpoint.
    deletedTime string
    Deletion time of the endpoint.
    description string
    Description of the endpoint node. The default value is an empty string. It must start with a letter, number, or Chinese character, and can include letters, numbers, Chinese characters, and the following special characters: comma (,), period (.), underscore (_), space ( ), equals sign (=), hyphen (-), Chinese comma (,), and Chinese period (。). Length limit: 0–255 characters.
    endpointDomain string
    Domain name of the endpoint.
    endpointId string
    ID of the endpoint node.
    endpointIndex number
    Endpoint index
    endpointName string
    Endpoint name. Must start with a letter, number, or Chinese character. Can include letters, numbers, Chinese characters, and the following special characters: period (.), underscore (_), and hyphen (-). Length must be between 1 and 128 characters. If not specified, defaults to the endpoint ID.
    endpointType string
    Type of the endpoint node. Interface: interface endpoint node.
    id string
    Uniquely identifies the resource.
    ipAddressVersions string[]
    IP protocol type for the interface endpoint. Options are ipv4 and ipv6. The default for interface endpoints is ipv4. If only ipv4 is used, do not provide this parameter. If the interface endpoint is dual stack (ipv4 & ipv6), you must provide this parameter. Before providing it, ensure the following: your account has enabled IPv6 for private network connections; the subnet associated with the interface endpoint has enabled the IPv6 segment; the endpoint service associated with the interface endpoint is dual stack. Parameter -N: indicates the sequence number of the IP protocol type for the interface endpoint, with a range of 1–2. Use & to separate the sequence numbers of the two IP protocol types. Currently, only providing IPv6 is not supported.
    payer string
    Billing account for the private network connection. Endpoint: endpoint account. EndpointService: endpoint service account.
    privateDnsEnabled boolean
    Enable private DNS name. false (default): disabled. true: enabled.
    privateDnsName string
    The private DNS name of the endpoint node. If the parameter PrivateDNSEnabled returns false, this parameter is empty.
    projectName string
    Name of the project to which the endpoint node belongs.
    securityGroupIds string[]
    ID of the security group to be bound to the endpoint. You can call the DescribeSecurityGroups API to obtain the security group ID. Parameter -N: Indicates the sequence number of the security group ID, value range: 1–5. Separate multiple security group IDs with &.
    serviceId string
    ID of the endpoint service to be associated. You can call the DescribeVpcEndpointServices API to obtain the endpoint service ID.
    serviceManaged boolean
    Whether the endpoint is managed. false: Unmanaged endpoint. true: Managed endpoint.
    serviceName string
    Name of the endpoint service to be associated.
    status string
    Status of the endpoint. Creating: Creating. Pending: Modifying configuration. Available: Available. Deleting: Deleting.
    tags GetVpcEndpointTag[]
    Endpoint user tag.
    updateTime string
    Most recent operation time of the endpoint.
    vpcId string
    ID of the VPC to which the endpoint belongs. You can call the DescribeVpcs API to obtain the VPC ID.
    zones GetVpcEndpointZone[]
    Availability zone of the endpoint node.
    bps int
    Maximum bandwidth limit for the endpoint node connection, in Mbps.
    business_status str
    Whether the endpoint is locked. Normal: Normal. FinancialLocked: Locked. If this parameter is empty, the endpoint is not locked.
    connection_status str
    Status of the endpoint node connection. PendingAcceptance: waiting for connection. Connecting: connecting. Connected: connected. Disconnecting: disconnecting. Rejected: connection rejected. Failed: connection failed. PartialFailed: partial connection failure. ServiceDeleted: service deleted.
    creation_time str
    Creation time of the endpoint.
    deleted_time str
    Deletion time of the endpoint.
    description str
    Description of the endpoint node. The default value is an empty string. It must start with a letter, number, or Chinese character, and can include letters, numbers, Chinese characters, and the following special characters: comma (,), period (.), underscore (_), space ( ), equals sign (=), hyphen (-), Chinese comma (,), and Chinese period (。). Length limit: 0–255 characters.
    endpoint_domain str
    Domain name of the endpoint.
    endpoint_id str
    ID of the endpoint node.
    endpoint_index int
    Endpoint index
    endpoint_name str
    Endpoint name. Must start with a letter, number, or Chinese character. Can include letters, numbers, Chinese characters, and the following special characters: period (.), underscore (_), and hyphen (-). Length must be between 1 and 128 characters. If not specified, defaults to the endpoint ID.
    endpoint_type str
    Type of the endpoint node. Interface: interface endpoint node.
    id str
    Uniquely identifies the resource.
    ip_address_versions Sequence[str]
    IP protocol type for the interface endpoint. Options are ipv4 and ipv6. The default for interface endpoints is ipv4. If only ipv4 is used, do not provide this parameter. If the interface endpoint is dual stack (ipv4 & ipv6), you must provide this parameter. Before providing it, ensure the following: your account has enabled IPv6 for private network connections; the subnet associated with the interface endpoint has enabled the IPv6 segment; the endpoint service associated with the interface endpoint is dual stack. Parameter -N: indicates the sequence number of the IP protocol type for the interface endpoint, with a range of 1–2. Use & to separate the sequence numbers of the two IP protocol types. Currently, only providing IPv6 is not supported.
    payer str
    Billing account for the private network connection. Endpoint: endpoint account. EndpointService: endpoint service account.
    private_dns_enabled bool
    Enable private DNS name. false (default): disabled. true: enabled.
    private_dns_name str
    The private DNS name of the endpoint node. If the parameter PrivateDNSEnabled returns false, this parameter is empty.
    project_name str
    Name of the project to which the endpoint node belongs.
    security_group_ids Sequence[str]
    ID of the security group to be bound to the endpoint. You can call the DescribeSecurityGroups API to obtain the security group ID. Parameter -N: Indicates the sequence number of the security group ID, value range: 1–5. Separate multiple security group IDs with &.
    service_id str
    ID of the endpoint service to be associated. You can call the DescribeVpcEndpointServices API to obtain the endpoint service ID.
    service_managed bool
    Whether the endpoint is managed. false: Unmanaged endpoint. true: Managed endpoint.
    service_name str
    Name of the endpoint service to be associated.
    status str
    Status of the endpoint. Creating: Creating. Pending: Modifying configuration. Available: Available. Deleting: Deleting.
    tags Sequence[GetVpcEndpointTag]
    Endpoint user tag.
    update_time str
    Most recent operation time of the endpoint.
    vpc_id str
    ID of the VPC to which the endpoint belongs. You can call the DescribeVpcs API to obtain the VPC ID.
    zones Sequence[GetVpcEndpointZone]
    Availability zone of the endpoint node.
    bps Number
    Maximum bandwidth limit for the endpoint node connection, in Mbps.
    businessStatus String
    Whether the endpoint is locked. Normal: Normal. FinancialLocked: Locked. If this parameter is empty, the endpoint is not locked.
    connectionStatus String
    Status of the endpoint node connection. PendingAcceptance: waiting for connection. Connecting: connecting. Connected: connected. Disconnecting: disconnecting. Rejected: connection rejected. Failed: connection failed. PartialFailed: partial connection failure. ServiceDeleted: service deleted.
    creationTime String
    Creation time of the endpoint.
    deletedTime String
    Deletion time of the endpoint.
    description String
    Description of the endpoint node. The default value is an empty string. It must start with a letter, number, or Chinese character, and can include letters, numbers, Chinese characters, and the following special characters: comma (,), period (.), underscore (_), space ( ), equals sign (=), hyphen (-), Chinese comma (,), and Chinese period (。). Length limit: 0–255 characters.
    endpointDomain String
    Domain name of the endpoint.
    endpointId String
    ID of the endpoint node.
    endpointIndex Number
    Endpoint index
    endpointName String
    Endpoint name. Must start with a letter, number, or Chinese character. Can include letters, numbers, Chinese characters, and the following special characters: period (.), underscore (_), and hyphen (-). Length must be between 1 and 128 characters. If not specified, defaults to the endpoint ID.
    endpointType String
    Type of the endpoint node. Interface: interface endpoint node.
    id String
    Uniquely identifies the resource.
    ipAddressVersions List<String>
    IP protocol type for the interface endpoint. Options are ipv4 and ipv6. The default for interface endpoints is ipv4. If only ipv4 is used, do not provide this parameter. If the interface endpoint is dual stack (ipv4 & ipv6), you must provide this parameter. Before providing it, ensure the following: your account has enabled IPv6 for private network connections; the subnet associated with the interface endpoint has enabled the IPv6 segment; the endpoint service associated with the interface endpoint is dual stack. Parameter -N: indicates the sequence number of the IP protocol type for the interface endpoint, with a range of 1–2. Use & to separate the sequence numbers of the two IP protocol types. Currently, only providing IPv6 is not supported.
    payer String
    Billing account for the private network connection. Endpoint: endpoint account. EndpointService: endpoint service account.
    privateDnsEnabled Boolean
    Enable private DNS name. false (default): disabled. true: enabled.
    privateDnsName String
    The private DNS name of the endpoint node. If the parameter PrivateDNSEnabled returns false, this parameter is empty.
    projectName String
    Name of the project to which the endpoint node belongs.
    securityGroupIds List<String>
    ID of the security group to be bound to the endpoint. You can call the DescribeSecurityGroups API to obtain the security group ID. Parameter -N: Indicates the sequence number of the security group ID, value range: 1–5. Separate multiple security group IDs with &.
    serviceId String
    ID of the endpoint service to be associated. You can call the DescribeVpcEndpointServices API to obtain the endpoint service ID.
    serviceManaged Boolean
    Whether the endpoint is managed. false: Unmanaged endpoint. true: Managed endpoint.
    serviceName String
    Name of the endpoint service to be associated.
    status String
    Status of the endpoint. Creating: Creating. Pending: Modifying configuration. Available: Available. Deleting: Deleting.
    tags List<Property Map>
    Endpoint user tag.
    updateTime String
    Most recent operation time of the endpoint.
    vpcId String
    ID of the VPC to which the endpoint belongs. You can call the DescribeVpcs API to obtain the VPC ID.
    zones List<Property Map>
    Availability zone of the endpoint node.

    Supporting Types

    GetVpcEndpointTag

    Key string
    Tag key of the endpoint user tag. Length limit: 1–128 characters. Case sensitive. Cannot start with 'or' or 'sys:' in any case combination. Cannot start or end with a space. Allowed characters: letters, numbers, spaces ( ), underscores (_), periods (.), colons (:), slashes (/), equal signs (=), plus signs (+), hyphens (-), and @.
    Value string
    Tag value of the endpoint user tag. Length limit: 0–256 characters. Case sensitive. Cannot start or end with a space. Allowed characters: letters, numbers, spaces ( ), underscores (_), periods (.), colons (:), slashes (/), equal signs (=), plus signs (+), hyphens (-), and @
    Key string
    Tag key of the endpoint user tag. Length limit: 1–128 characters. Case sensitive. Cannot start with 'or' or 'sys:' in any case combination. Cannot start or end with a space. Allowed characters: letters, numbers, spaces ( ), underscores (_), periods (.), colons (:), slashes (/), equal signs (=), plus signs (+), hyphens (-), and @.
    Value string
    Tag value of the endpoint user tag. Length limit: 0–256 characters. Case sensitive. Cannot start or end with a space. Allowed characters: letters, numbers, spaces ( ), underscores (_), periods (.), colons (:), slashes (/), equal signs (=), plus signs (+), hyphens (-), and @
    key String
    Tag key of the endpoint user tag. Length limit: 1–128 characters. Case sensitive. Cannot start with 'or' or 'sys:' in any case combination. Cannot start or end with a space. Allowed characters: letters, numbers, spaces ( ), underscores (_), periods (.), colons (:), slashes (/), equal signs (=), plus signs (+), hyphens (-), and @.
    value String
    Tag value of the endpoint user tag. Length limit: 0–256 characters. Case sensitive. Cannot start or end with a space. Allowed characters: letters, numbers, spaces ( ), underscores (_), periods (.), colons (:), slashes (/), equal signs (=), plus signs (+), hyphens (-), and @
    key string
    Tag key of the endpoint user tag. Length limit: 1–128 characters. Case sensitive. Cannot start with 'or' or 'sys:' in any case combination. Cannot start or end with a space. Allowed characters: letters, numbers, spaces ( ), underscores (_), periods (.), colons (:), slashes (/), equal signs (=), plus signs (+), hyphens (-), and @.
    value string
    Tag value of the endpoint user tag. Length limit: 0–256 characters. Case sensitive. Cannot start or end with a space. Allowed characters: letters, numbers, spaces ( ), underscores (_), periods (.), colons (:), slashes (/), equal signs (=), plus signs (+), hyphens (-), and @
    key str
    Tag key of the endpoint user tag. Length limit: 1–128 characters. Case sensitive. Cannot start with 'or' or 'sys:' in any case combination. Cannot start or end with a space. Allowed characters: letters, numbers, spaces ( ), underscores (_), periods (.), colons (:), slashes (/), equal signs (=), plus signs (+), hyphens (-), and @.
    value str
    Tag value of the endpoint user tag. Length limit: 0–256 characters. Case sensitive. Cannot start or end with a space. Allowed characters: letters, numbers, spaces ( ), underscores (_), periods (.), colons (:), slashes (/), equal signs (=), plus signs (+), hyphens (-), and @
    key String
    Tag key of the endpoint user tag. Length limit: 1–128 characters. Case sensitive. Cannot start with 'or' or 'sys:' in any case combination. Cannot start or end with a space. Allowed characters: letters, numbers, spaces ( ), underscores (_), periods (.), colons (:), slashes (/), equal signs (=), plus signs (+), hyphens (-), and @.
    value String
    Tag value of the endpoint user tag. Length limit: 0–256 characters. Case sensitive. Cannot start or end with a space. Allowed characters: letters, numbers, spaces ( ), underscores (_), periods (.), colons (:), slashes (/), equal signs (=), plus signs (+), hyphens (-), and @

    GetVpcEndpointZone

    Ipv6ServiceStatus string
    Service status of the endpoint node's IPv6 address. Active: normal. Inactive: abnormal.
    NetworkInterfaceId string
    ID of the endpoint NIC used to connect to new service resources. If not in the process of seamless service resource replacement, this parameter returns empty.
    PrivateIpAddress string
    The private IPv4 address of the endpoint node's network interface must belong to the subnet's IPv4 CIDR block. You can call the DescribeSubnets API to obtain the subnet's CIDR block. Parameter -N: indicates the sequence number of the private IPv4 address, with a value range of 1–10. Use & to separate multiple private IPv4 addresses.
    PrivateIpv6Address string
    The private IPv6 address of the endpoint node's network interface must belong to the subnet's IPv6 CIDR block. You can call the DescribeSubnets API to obtain the subnet's CIDR block. Parameter -N: indicates the sequence number of the private IPv6 address, with a value range of 1–10. Use & to separate multiple private IPv6 addresses. If not specified, an IPv6 address will be randomly assigned within the subnet's IPv6 CIDR block by default.
    ServiceStatus string
    Service status of the endpoint IPv4 address. Active: Normal. Inactive: Abnormal.
    SubnetId string
    ID of the subnet to which the NIC of the endpoint to be created belongs. You can call the DescribeSubnets API to obtain the subnet ID. Parameter -N: Indicates the sequence number of the subnet ID, value range: 1–10. Separate multiple subnet IDs with &.
    ZoneDomain string
    Domain name of the endpoint availability zone.
    ZoneId string
    ID of the availability zone to which the NIC of the endpoint to be created belongs. For more information about availability zones, see Regions and Availability Zones. Parameter -N: Indicates the sequence number of the availability zone, value range: 1–10. Separate multiple availability zone IDs with &.
    ZoneStatus string
    Status of the endpoint node's availability zone. PendingAcceptance: waiting for connection. Connecting: connecting. Connected: connected. Disconnecting: disconnecting. Rejected: connection rejected. Failed: connection failed.
    Ipv6ServiceStatus string
    Service status of the endpoint node's IPv6 address. Active: normal. Inactive: abnormal.
    NetworkInterfaceId string
    ID of the endpoint NIC used to connect to new service resources. If not in the process of seamless service resource replacement, this parameter returns empty.
    PrivateIpAddress string
    The private IPv4 address of the endpoint node's network interface must belong to the subnet's IPv4 CIDR block. You can call the DescribeSubnets API to obtain the subnet's CIDR block. Parameter -N: indicates the sequence number of the private IPv4 address, with a value range of 1–10. Use & to separate multiple private IPv4 addresses.
    PrivateIpv6Address string
    The private IPv6 address of the endpoint node's network interface must belong to the subnet's IPv6 CIDR block. You can call the DescribeSubnets API to obtain the subnet's CIDR block. Parameter -N: indicates the sequence number of the private IPv6 address, with a value range of 1–10. Use & to separate multiple private IPv6 addresses. If not specified, an IPv6 address will be randomly assigned within the subnet's IPv6 CIDR block by default.
    ServiceStatus string
    Service status of the endpoint IPv4 address. Active: Normal. Inactive: Abnormal.
    SubnetId string
    ID of the subnet to which the NIC of the endpoint to be created belongs. You can call the DescribeSubnets API to obtain the subnet ID. Parameter -N: Indicates the sequence number of the subnet ID, value range: 1–10. Separate multiple subnet IDs with &.
    ZoneDomain string
    Domain name of the endpoint availability zone.
    ZoneId string
    ID of the availability zone to which the NIC of the endpoint to be created belongs. For more information about availability zones, see Regions and Availability Zones. Parameter -N: Indicates the sequence number of the availability zone, value range: 1–10. Separate multiple availability zone IDs with &.
    ZoneStatus string
    Status of the endpoint node's availability zone. PendingAcceptance: waiting for connection. Connecting: connecting. Connected: connected. Disconnecting: disconnecting. Rejected: connection rejected. Failed: connection failed.
    ipv6ServiceStatus String
    Service status of the endpoint node's IPv6 address. Active: normal. Inactive: abnormal.
    networkInterfaceId String
    ID of the endpoint NIC used to connect to new service resources. If not in the process of seamless service resource replacement, this parameter returns empty.
    privateIpAddress String
    The private IPv4 address of the endpoint node's network interface must belong to the subnet's IPv4 CIDR block. You can call the DescribeSubnets API to obtain the subnet's CIDR block. Parameter -N: indicates the sequence number of the private IPv4 address, with a value range of 1–10. Use & to separate multiple private IPv4 addresses.
    privateIpv6Address String
    The private IPv6 address of the endpoint node's network interface must belong to the subnet's IPv6 CIDR block. You can call the DescribeSubnets API to obtain the subnet's CIDR block. Parameter -N: indicates the sequence number of the private IPv6 address, with a value range of 1–10. Use & to separate multiple private IPv6 addresses. If not specified, an IPv6 address will be randomly assigned within the subnet's IPv6 CIDR block by default.
    serviceStatus String
    Service status of the endpoint IPv4 address. Active: Normal. Inactive: Abnormal.
    subnetId String
    ID of the subnet to which the NIC of the endpoint to be created belongs. You can call the DescribeSubnets API to obtain the subnet ID. Parameter -N: Indicates the sequence number of the subnet ID, value range: 1–10. Separate multiple subnet IDs with &.
    zoneDomain String
    Domain name of the endpoint availability zone.
    zoneId String
    ID of the availability zone to which the NIC of the endpoint to be created belongs. For more information about availability zones, see Regions and Availability Zones. Parameter -N: Indicates the sequence number of the availability zone, value range: 1–10. Separate multiple availability zone IDs with &.
    zoneStatus String
    Status of the endpoint node's availability zone. PendingAcceptance: waiting for connection. Connecting: connecting. Connected: connected. Disconnecting: disconnecting. Rejected: connection rejected. Failed: connection failed.
    ipv6ServiceStatus string
    Service status of the endpoint node's IPv6 address. Active: normal. Inactive: abnormal.
    networkInterfaceId string
    ID of the endpoint NIC used to connect to new service resources. If not in the process of seamless service resource replacement, this parameter returns empty.
    privateIpAddress string
    The private IPv4 address of the endpoint node's network interface must belong to the subnet's IPv4 CIDR block. You can call the DescribeSubnets API to obtain the subnet's CIDR block. Parameter -N: indicates the sequence number of the private IPv4 address, with a value range of 1–10. Use & to separate multiple private IPv4 addresses.
    privateIpv6Address string
    The private IPv6 address of the endpoint node's network interface must belong to the subnet's IPv6 CIDR block. You can call the DescribeSubnets API to obtain the subnet's CIDR block. Parameter -N: indicates the sequence number of the private IPv6 address, with a value range of 1–10. Use & to separate multiple private IPv6 addresses. If not specified, an IPv6 address will be randomly assigned within the subnet's IPv6 CIDR block by default.
    serviceStatus string
    Service status of the endpoint IPv4 address. Active: Normal. Inactive: Abnormal.
    subnetId string
    ID of the subnet to which the NIC of the endpoint to be created belongs. You can call the DescribeSubnets API to obtain the subnet ID. Parameter -N: Indicates the sequence number of the subnet ID, value range: 1–10. Separate multiple subnet IDs with &.
    zoneDomain string
    Domain name of the endpoint availability zone.
    zoneId string
    ID of the availability zone to which the NIC of the endpoint to be created belongs. For more information about availability zones, see Regions and Availability Zones. Parameter -N: Indicates the sequence number of the availability zone, value range: 1–10. Separate multiple availability zone IDs with &.
    zoneStatus string
    Status of the endpoint node's availability zone. PendingAcceptance: waiting for connection. Connecting: connecting. Connected: connected. Disconnecting: disconnecting. Rejected: connection rejected. Failed: connection failed.
    ipv6_service_status str
    Service status of the endpoint node's IPv6 address. Active: normal. Inactive: abnormal.
    network_interface_id str
    ID of the endpoint NIC used to connect to new service resources. If not in the process of seamless service resource replacement, this parameter returns empty.
    private_ip_address str
    The private IPv4 address of the endpoint node's network interface must belong to the subnet's IPv4 CIDR block. You can call the DescribeSubnets API to obtain the subnet's CIDR block. Parameter -N: indicates the sequence number of the private IPv4 address, with a value range of 1–10. Use & to separate multiple private IPv4 addresses.
    private_ipv6_address str
    The private IPv6 address of the endpoint node's network interface must belong to the subnet's IPv6 CIDR block. You can call the DescribeSubnets API to obtain the subnet's CIDR block. Parameter -N: indicates the sequence number of the private IPv6 address, with a value range of 1–10. Use & to separate multiple private IPv6 addresses. If not specified, an IPv6 address will be randomly assigned within the subnet's IPv6 CIDR block by default.
    service_status str
    Service status of the endpoint IPv4 address. Active: Normal. Inactive: Abnormal.
    subnet_id str
    ID of the subnet to which the NIC of the endpoint to be created belongs. You can call the DescribeSubnets API to obtain the subnet ID. Parameter -N: Indicates the sequence number of the subnet ID, value range: 1–10. Separate multiple subnet IDs with &.
    zone_domain str
    Domain name of the endpoint availability zone.
    zone_id str
    ID of the availability zone to which the NIC of the endpoint to be created belongs. For more information about availability zones, see Regions and Availability Zones. Parameter -N: Indicates the sequence number of the availability zone, value range: 1–10. Separate multiple availability zone IDs with &.
    zone_status str
    Status of the endpoint node's availability zone. PendingAcceptance: waiting for connection. Connecting: connecting. Connected: connected. Disconnecting: disconnecting. Rejected: connection rejected. Failed: connection failed.
    ipv6ServiceStatus String
    Service status of the endpoint node's IPv6 address. Active: normal. Inactive: abnormal.
    networkInterfaceId String
    ID of the endpoint NIC used to connect to new service resources. If not in the process of seamless service resource replacement, this parameter returns empty.
    privateIpAddress String
    The private IPv4 address of the endpoint node's network interface must belong to the subnet's IPv4 CIDR block. You can call the DescribeSubnets API to obtain the subnet's CIDR block. Parameter -N: indicates the sequence number of the private IPv4 address, with a value range of 1–10. Use & to separate multiple private IPv4 addresses.
    privateIpv6Address String
    The private IPv6 address of the endpoint node's network interface must belong to the subnet's IPv6 CIDR block. You can call the DescribeSubnets API to obtain the subnet's CIDR block. Parameter -N: indicates the sequence number of the private IPv6 address, with a value range of 1–10. Use & to separate multiple private IPv6 addresses. If not specified, an IPv6 address will be randomly assigned within the subnet's IPv6 CIDR block by default.
    serviceStatus String
    Service status of the endpoint IPv4 address. Active: Normal. Inactive: Abnormal.
    subnetId String
    ID of the subnet to which the NIC of the endpoint to be created belongs. You can call the DescribeSubnets API to obtain the subnet ID. Parameter -N: Indicates the sequence number of the subnet ID, value range: 1–10. Separate multiple subnet IDs with &.
    zoneDomain String
    Domain name of the endpoint availability zone.
    zoneId String
    ID of the availability zone to which the NIC of the endpoint to be created belongs. For more information about availability zones, see Regions and Availability Zones. Parameter -N: Indicates the sequence number of the availability zone, value range: 1–10. Separate multiple availability zone IDs with &.
    zoneStatus String
    Status of the endpoint node's availability zone. PendingAcceptance: waiting for connection. Connecting: connecting. Connected: connected. Disconnecting: disconnecting. Rejected: connection rejected. Failed: connection failed.

    Package Details

    Repository
    volcenginecc volcengine/pulumi-volcenginecc
    License
    MPL-2.0
    Notes
    This Pulumi package is based on the volcenginecc Terraform Provider.
    volcenginecc logo
    Viewing docs for volcenginecc v0.0.32
    published on Thursday, Apr 23, 2026 by Volcengine
      Try Pulumi Cloud free. Your team will thank you.