1. Packages
  2. Volcengine
  3. API Docs
  4. rds_mysql
  5. getEndpoints
Volcengine v0.0.38 published on Friday, Oct 31, 2025 by Volcengine
Schema (JSON)
volcengine/pulumi-volcengine

volcengine.rds_mysql.getEndpoints

volcengine logo
Volcengine v0.0.38 published on Friday, Oct 31, 2025 by Volcengine
Schema (JSON)
volcengine/pulumi-volcengine

    Use this data source to query detailed information of rds mysql endpoints

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as volcengine from "@pulumi/volcengine";

const foo = volcengine.rds_mysql.getEndpoints({
    instanceId: "mysql-38c3d4f05f6e",
});

    import pulumi
import pulumi_volcengine as volcengine

foo = volcengine.rds_mysql.get_endpoints(instance_id="mysql-38c3d4f05f6e")

    package main

import (
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
	"github.com/volcengine/pulumi-volcengine/sdk/go/volcengine/rds_mysql"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := rds_mysql.GetEndpoints(ctx, &rds_mysql.GetEndpointsArgs{
			InstanceId: "mysql-38c3d4f05f6e",
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Volcengine = Pulumi.Volcengine;

return await Deployment.RunAsync(() => 
{
    var foo = Volcengine.Rds_mysql.GetEndpoints.Invoke(new()
    {
        InstanceId = "mysql-38c3d4f05f6e",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.volcengine.rds_mysql.Rds_mysqlFunctions;
import com.pulumi.volcengine.rds_mysql.inputs.GetEndpointsArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var foo = Rds_mysqlFunctions.getEndpoints(GetEndpointsArgs.builder()
            .instanceId("mysql-38c3d4f05f6e")
            .build());

    }
}

    variables:
  foo:
    fn::invoke:
      Function: volcengine:rds_mysql:getEndpoints
      Arguments:
        instanceId: mysql-38c3d4f05f6e

    Using getEndpoints

    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 getEndpoints(args: GetEndpointsArgs, opts?: InvokeOptions): Promise<GetEndpointsResult>
function getEndpointsOutput(args: GetEndpointsOutputArgs, opts?: InvokeOptions): Output<GetEndpointsResult>
    def get_endpoints(instance_id: Optional[str] = None,
                  output_file: Optional[str] = None,
                  opts: Optional[InvokeOptions] = None) -> GetEndpointsResult
def get_endpoints_output(instance_id: Optional[pulumi.Input[str]] = None,
                  output_file: Optional[pulumi.Input[str]] = None,
                  opts: Optional[InvokeOptions] = None) -> Output[GetEndpointsResult]
    func GetEndpoints(ctx *Context, args *GetEndpointsArgs, opts ...InvokeOption) (*GetEndpointsResult, error)
func GetEndpointsOutput(ctx *Context, args *GetEndpointsOutputArgs, opts ...InvokeOption) GetEndpointsResultOutput

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

    public static class GetEndpoints 
{
    public static Task<GetEndpointsResult> InvokeAsync(GetEndpointsArgs args, InvokeOptions? opts = null)
    public static Output<GetEndpointsResult> Invoke(GetEndpointsInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetEndpointsResult> getEndpoints(GetEndpointsArgs args, InvokeOptions options)
public static Output<GetEndpointsResult> getEndpoints(GetEndpointsArgs args, InvokeOptions options)

    fn::invoke:
  function: volcengine:rds_mysql/getEndpoints:getEndpoints
  arguments:
    # arguments dictionary

    The following arguments are supported:

    InstanceId string
    The id of the mysql instance.
    OutputFile string
    File name where to save data source results.
    InstanceId string
    The id of the mysql instance.
    OutputFile string
    File name where to save data source results.
    instanceId String
    The id of the mysql instance.
    outputFile String
    File name where to save data source results.
    instanceId string
    The id of the mysql instance.
    outputFile string
    File name where to save data source results.
    instance_id str
    The id of the mysql instance.
    output_file str
    File name where to save data source results.
    instanceId String
    The id of the mysql instance.
    outputFile String
    File name where to save data source results.

    getEndpoints Result

    The following output properties are available:

    Endpoints List<GetEndpointsEndpoint>
    The collection of query.
    Id string
    The provider-assigned unique ID for this managed resource.
    InstanceId string
    TotalCount int
    The total count of query.
    OutputFile string
    Endpoints []GetEndpointsEndpoint
    The collection of query.
    Id string
    The provider-assigned unique ID for this managed resource.
    InstanceId string
    TotalCount int
    The total count of query.
    OutputFile string
    endpoints List<GetEndpointsEndpoint>
    The collection of query.
    id String
    The provider-assigned unique ID for this managed resource.
    instanceId String
    totalCount Integer
    The total count of query.
    outputFile String
    endpoints GetEndpointsEndpoint[]
    The collection of query.
    id string
    The provider-assigned unique ID for this managed resource.
    instanceId string
    totalCount number
    The total count of query.
    outputFile string
    endpoints Sequence[GetEndpointsEndpoint]
    The collection of query.
    id str
    The provider-assigned unique ID for this managed resource.
    instance_id str
    total_count int
    The total count of query.
    output_file str
    endpoints List<Property Map>
    The collection of query.
    id String
    The provider-assigned unique ID for this managed resource.
    instanceId String
    totalCount Number
    The total count of query.
    outputFile String

    Supporting Types

    GetEndpointsEndpoint

    Addresses List<GetEndpointsEndpointAddress>
    Address list.
    AutoAddNewNodes string
    When the terminal type is read-write terminal or read-only terminal, it supports setting whether new nodes are automatically added.
    Description string
    The description of the mysql endpoint.
    EnableReadOnly string
    Whether global read-only is enabled, value: Enable: Enable. Disable: Disabled.
    EnableReadWriteSplitting string
    Whether read-write separation is enabled, value: Enable: Enable. Disable: Disabled.
    EndpointId string
    The id of the mysql endpoint.
    EndpointName string
    The name of the mysql endpoint.
    EndpointType string
    The endpoint type of the mysql endpoint.
    Id string
    The id of the mysql endpoint.
    ReadOnlyNodeWeights List<GetEndpointsEndpointReadOnlyNodeWeight>
    The list of nodes configured by the connection terminal and the corresponding read-only weights.
    ReadWriteMode string
    The read write mode.
    Addresses []GetEndpointsEndpointAddress
    Address list.
    AutoAddNewNodes string
    When the terminal type is read-write terminal or read-only terminal, it supports setting whether new nodes are automatically added.
    Description string
    The description of the mysql endpoint.
    EnableReadOnly string
    Whether global read-only is enabled, value: Enable: Enable. Disable: Disabled.
    EnableReadWriteSplitting string
    Whether read-write separation is enabled, value: Enable: Enable. Disable: Disabled.
    EndpointId string
    The id of the mysql endpoint.
    EndpointName string
    The name of the mysql endpoint.
    EndpointType string
    The endpoint type of the mysql endpoint.
    Id string
    The id of the mysql endpoint.
    ReadOnlyNodeWeights []GetEndpointsEndpointReadOnlyNodeWeight
    The list of nodes configured by the connection terminal and the corresponding read-only weights.
    ReadWriteMode string
    The read write mode.
    addresses List<GetEndpointsEndpointAddress>
    Address list.
    autoAddNewNodes String
    When the terminal type is read-write terminal or read-only terminal, it supports setting whether new nodes are automatically added.
    description String
    The description of the mysql endpoint.
    enableReadOnly String
    Whether global read-only is enabled, value: Enable: Enable. Disable: Disabled.
    enableReadWriteSplitting String
    Whether read-write separation is enabled, value: Enable: Enable. Disable: Disabled.
    endpointId String
    The id of the mysql endpoint.
    endpointName String
    The name of the mysql endpoint.
    endpointType String
    The endpoint type of the mysql endpoint.
    id String
    The id of the mysql endpoint.
    readOnlyNodeWeights List<GetEndpointsEndpointReadOnlyNodeWeight>
    The list of nodes configured by the connection terminal and the corresponding read-only weights.
    readWriteMode String
    The read write mode.
    addresses GetEndpointsEndpointAddress[]
    Address list.
    autoAddNewNodes string
    When the terminal type is read-write terminal or read-only terminal, it supports setting whether new nodes are automatically added.
    description string
    The description of the mysql endpoint.
    enableReadOnly string
    Whether global read-only is enabled, value: Enable: Enable. Disable: Disabled.
    enableReadWriteSplitting string
    Whether read-write separation is enabled, value: Enable: Enable. Disable: Disabled.
    endpointId string
    The id of the mysql endpoint.
    endpointName string
    The name of the mysql endpoint.
    endpointType string
    The endpoint type of the mysql endpoint.
    id string
    The id of the mysql endpoint.
    readOnlyNodeWeights GetEndpointsEndpointReadOnlyNodeWeight[]
    The list of nodes configured by the connection terminal and the corresponding read-only weights.
    readWriteMode string
    The read write mode.
    addresses Sequence[GetEndpointsEndpointAddress]
    Address list.
    auto_add_new_nodes str
    When the terminal type is read-write terminal or read-only terminal, it supports setting whether new nodes are automatically added.
    description str
    The description of the mysql endpoint.
    enable_read_only str
    Whether global read-only is enabled, value: Enable: Enable. Disable: Disabled.
    enable_read_write_splitting str
    Whether read-write separation is enabled, value: Enable: Enable. Disable: Disabled.
    endpoint_id str
    The id of the mysql endpoint.
    endpoint_name str
    The name of the mysql endpoint.
    endpoint_type str
    The endpoint type of the mysql endpoint.
    id str
    The id of the mysql endpoint.
    read_only_node_weights Sequence[GetEndpointsEndpointReadOnlyNodeWeight]
    The list of nodes configured by the connection terminal and the corresponding read-only weights.
    read_write_mode str
    The read write mode.
    addresses List<Property Map>
    Address list.
    autoAddNewNodes String
    When the terminal type is read-write terminal or read-only terminal, it supports setting whether new nodes are automatically added.
    description String
    The description of the mysql endpoint.
    enableReadOnly String
    Whether global read-only is enabled, value: Enable: Enable. Disable: Disabled.
    enableReadWriteSplitting String
    Whether read-write separation is enabled, value: Enable: Enable. Disable: Disabled.
    endpointId String
    The id of the mysql endpoint.
    endpointName String
    The name of the mysql endpoint.
    endpointType String
    The endpoint type of the mysql endpoint.
    id String
    The id of the mysql endpoint.
    readOnlyNodeWeights List<Property Map>
    The list of nodes configured by the connection terminal and the corresponding read-only weights.
    readWriteMode String
    The read write mode.

    GetEndpointsEndpointAddress

    DnsVisibility bool
    DNS Visibility.
    Domain string
    Connect domain name.
    EipId string
    The ID of the EIP, only valid for Public addresses.
    IpAddress string
    The IP Address.
    NetworkType string
    Network address type, temporarily Private, Public, PublicService.
    Port string
    The Port.
    SubnetId string
    Subnet ID, valid only for private addresses.
    DnsVisibility bool
    DNS Visibility.
    Domain string
    Connect domain name.
    EipId string
    The ID of the EIP, only valid for Public addresses.
    IpAddress string
    The IP Address.
    NetworkType string
    Network address type, temporarily Private, Public, PublicService.
    Port string
    The Port.
    SubnetId string
    Subnet ID, valid only for private addresses.
    dnsVisibility Boolean
    DNS Visibility.
    domain String
    Connect domain name.
    eipId String
    The ID of the EIP, only valid for Public addresses.
    ipAddress String
    The IP Address.
    networkType String
    Network address type, temporarily Private, Public, PublicService.
    port String
    The Port.
    subnetId String
    Subnet ID, valid only for private addresses.
    dnsVisibility boolean
    DNS Visibility.
    domain string
    Connect domain name.
    eipId string
    The ID of the EIP, only valid for Public addresses.
    ipAddress string
    The IP Address.
    networkType string
    Network address type, temporarily Private, Public, PublicService.
    port string
    The Port.
    subnetId string
    Subnet ID, valid only for private addresses.
    dns_visibility bool
    DNS Visibility.
    domain str
    Connect domain name.
    eip_id str
    The ID of the EIP, only valid for Public addresses.
    ip_address str
    The IP Address.
    network_type str
    Network address type, temporarily Private, Public, PublicService.
    port str
    The Port.
    subnet_id str
    Subnet ID, valid only for private addresses.
    dnsVisibility Boolean
    DNS Visibility.
    domain String
    Connect domain name.
    eipId String
    The ID of the EIP, only valid for Public addresses.
    ipAddress String
    The IP Address.
    networkType String
    Network address type, temporarily Private, Public, PublicService.
    port String
    The Port.
    subnetId String
    Subnet ID, valid only for private addresses.

    GetEndpointsEndpointReadOnlyNodeWeight

    NodeId string
    The ID of the node.
    NodeType string
    The type of the node.
    Weight int
    The weight of the node.
    NodeId string
    The ID of the node.
    NodeType string
    The type of the node.
    Weight int
    The weight of the node.
    nodeId String
    The ID of the node.
    nodeType String
    The type of the node.
    weight Integer
    The weight of the node.
    nodeId string
    The ID of the node.
    nodeType string
    The type of the node.
    weight number
    The weight of the node.
    node_id str
    The ID of the node.
    node_type str
    The type of the node.
    weight int
    The weight of the node.
    nodeId String
    The ID of the node.
    nodeType String
    The type of the node.
    weight Number
    The weight of the node.

    Package Details

    Repository
    volcengine volcengine/pulumi-volcengine
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the volcengine Terraform Provider.
    volcengine logo
    Volcengine v0.0.38 published on Friday, Oct 31, 2025 by Volcengine
    Schema (JSON)
    volcengine/pulumi-volcengine
      Meet Neo: Your AI Platform Teammate