volcenginecc.rdspostgresql.getInstance

volcenginecc v0.0.32, Apr 23 26

Viewing docs for volcenginecc v0.0.32
published on Thursday, Apr 23, 2026 by Volcengine

Schema (JSON)

volcengine/pulumi-volcenginecc

Viewing docs for volcenginecc v0.0.32
published on Thursday, Apr 23, 2026 by Volcengine

Schema (JSON)

volcengine/pulumi-volcenginecc

Using getInstance

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 getInstance(args: GetInstanceArgs, opts?: InvokeOptions): Promise<GetInstanceResult>
function getInstanceOutput(args: GetInstanceOutputArgs, opts?: InvokeOptions): Output<GetInstanceResult>

def get_instance(id: Optional[str] = None,
                 opts: Optional[InvokeOptions] = None) -> GetInstanceResult
def get_instance_output(id: Optional[pulumi.Input[str]] = None,
                 opts: Optional[InvokeOptions] = None) -> Output[GetInstanceResult]

func LookupInstance(ctx *Context, args *LookupInstanceArgs, opts ...InvokeOption) (*LookupInstanceResult, error)
func LookupInstanceOutput(ctx *Context, args *LookupInstanceOutputArgs, opts ...InvokeOption) LookupInstanceResultOutput

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

public static class GetInstance 
{
    public static Task<GetInstanceResult> InvokeAsync(GetInstanceArgs args, InvokeOptions? opts = null)
    public static Output<GetInstanceResult> Invoke(GetInstanceInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetInstanceResult> getInstance(GetInstanceArgs args, InvokeOptions options)
public static Output<GetInstanceResult> getInstance(GetInstanceArgs args, InvokeOptions options)

fn::invoke:
  function: volcenginecc:rdspostgresql/getInstance:getInstance
  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.

getInstance Result

The following output properties are available:

AllowListIds List<string>: Allowlist ID. To bind multiple allowlists, separate allowlist IDs with commas (,). An instance can bind up to 100 allowlists.
ChargeDetail Volcengine.GetInstanceChargeDetail: Payment method
CreateTime string: Instance creation time
DataSyncMode string: Synchronization mode. Value: Async (asynchronous synchronization)
DbEngineVersion string: Compatible version
Endpoints List<Volcengine.GetInstanceEndpoint>: Instance connection information
Id string: Uniquely identifies the resource.
InstanceId string: Instance ID
InstanceName string: Instance name
InstanceStatus string: Instance status
InstanceType string: Instance type. Value: HA (high availability edition)
MaintenanceWindow Volcengine.GetInstanceMaintenanceWindow: Instance maintenance window
Memory double: Memory size, unit: GB
NodeInfos List<Volcengine.GetInstanceNodeInfo>: Instance specification configuration
NodeNumber double: Number of nodes
NodeSpec string: Primary node specification
ProjectName string: Project. Default value: default project
StorageDataUse double: Data file space used by the primary node. Unit: Byte
StorageLogUse double: Log file space used by the primary node. Unit: Byte
StorageSpace double: Instance storage space. Value range: [20, 3000], unit: GB, increment: 10GB. Default value is 100
StorageTempUse double: Temporary file space used by the primary node. Unit: Byte
StorageType string: Instance storage type, fixed value LocalSSD (local SSD disk)
StorageUse double: Used storage space of the instance. Unit: Byte
StorageWalUse double: Used WAL file space of the instance's primary node. Unit: Byte
SubnetId string: Subnet ID
Tags List<Volcengine.GetInstanceTag>: Tag information of the cloud disk
UpdateTime string: Instance update time
Vcpu double: CPU size. For example: 1 means 1U
VpcId string: Use this parameter to specify the private network for the instance
ZoneId string: Availability zone ID

AllowListIds []string: Allowlist ID. To bind multiple allowlists, separate allowlist IDs with commas (,). An instance can bind up to 100 allowlists.
ChargeDetail GetInstanceChargeDetail: Payment method
CreateTime string: Instance creation time
DataSyncMode string: Synchronization mode. Value: Async (asynchronous synchronization)
DbEngineVersion string: Compatible version
Endpoints []GetInstanceEndpoint: Instance connection information
Id string: Uniquely identifies the resource.
InstanceId string: Instance ID
InstanceName string: Instance name
InstanceStatus string: Instance status
InstanceType string: Instance type. Value: HA (high availability edition)
MaintenanceWindow GetInstanceMaintenanceWindow: Instance maintenance window
Memory float64: Memory size, unit: GB
NodeInfos []GetInstanceNodeInfo: Instance specification configuration
NodeNumber float64: Number of nodes
NodeSpec string: Primary node specification
ProjectName string: Project. Default value: default project
StorageDataUse float64: Data file space used by the primary node. Unit: Byte
StorageLogUse float64: Log file space used by the primary node. Unit: Byte
StorageSpace float64: Instance storage space. Value range: [20, 3000], unit: GB, increment: 10GB. Default value is 100
StorageTempUse float64: Temporary file space used by the primary node. Unit: Byte
StorageType string: Instance storage type, fixed value LocalSSD (local SSD disk)
StorageUse float64: Used storage space of the instance. Unit: Byte
StorageWalUse float64: Used WAL file space of the instance's primary node. Unit: Byte
SubnetId string: Subnet ID
Tags []GetInstanceTag: Tag information of the cloud disk
UpdateTime string: Instance update time
Vcpu float64: CPU size. For example: 1 means 1U
VpcId string: Use this parameter to specify the private network for the instance
ZoneId string: Availability zone ID

allowListIds List<String>: Allowlist ID. To bind multiple allowlists, separate allowlist IDs with commas (,). An instance can bind up to 100 allowlists.
chargeDetail GetInstanceChargeDetail: Payment method
createTime String: Instance creation time
dataSyncMode String: Synchronization mode. Value: Async (asynchronous synchronization)
dbEngineVersion String: Compatible version
endpoints List<GetInstanceEndpoint>: Instance connection information
id String: Uniquely identifies the resource.
instanceId String: Instance ID
instanceName String: Instance name
instanceStatus String: Instance status
instanceType String: Instance type. Value: HA (high availability edition)
maintenanceWindow GetInstanceMaintenanceWindow: Instance maintenance window
memory Double: Memory size, unit: GB
nodeInfos List<GetInstanceNodeInfo>: Instance specification configuration
nodeNumber Double: Number of nodes
nodeSpec String: Primary node specification
projectName String: Project. Default value: default project
storageDataUse Double: Data file space used by the primary node. Unit: Byte
storageLogUse Double: Log file space used by the primary node. Unit: Byte
storageSpace Double: Instance storage space. Value range: [20, 3000], unit: GB, increment: 10GB. Default value is 100
storageTempUse Double: Temporary file space used by the primary node. Unit: Byte
storageType String: Instance storage type, fixed value LocalSSD (local SSD disk)
storageUse Double: Used storage space of the instance. Unit: Byte
storageWalUse Double: Used WAL file space of the instance's primary node. Unit: Byte
subnetId String: Subnet ID
tags List<GetInstanceTag>: Tag information of the cloud disk
updateTime String: Instance update time
vcpu Double: CPU size. For example: 1 means 1U
vpcId String: Use this parameter to specify the private network for the instance
zoneId String: Availability zone ID

allowListIds string[]: Allowlist ID. To bind multiple allowlists, separate allowlist IDs with commas (,). An instance can bind up to 100 allowlists.
chargeDetail GetInstanceChargeDetail: Payment method
createTime string: Instance creation time
dataSyncMode string: Synchronization mode. Value: Async (asynchronous synchronization)
dbEngineVersion string: Compatible version
endpoints GetInstanceEndpoint[]: Instance connection information
id string: Uniquely identifies the resource.
instanceId string: Instance ID
instanceName string: Instance name
instanceStatus string: Instance status
instanceType string: Instance type. Value: HA (high availability edition)
maintenanceWindow GetInstanceMaintenanceWindow: Instance maintenance window
memory number: Memory size, unit: GB
nodeInfos GetInstanceNodeInfo[]: Instance specification configuration
nodeNumber number: Number of nodes
nodeSpec string: Primary node specification
projectName string: Project. Default value: default project
storageDataUse number: Data file space used by the primary node. Unit: Byte
storageLogUse number: Log file space used by the primary node. Unit: Byte
storageSpace number: Instance storage space. Value range: [20, 3000], unit: GB, increment: 10GB. Default value is 100
storageTempUse number: Temporary file space used by the primary node. Unit: Byte
storageType string: Instance storage type, fixed value LocalSSD (local SSD disk)
storageUse number: Used storage space of the instance. Unit: Byte
storageWalUse number: Used WAL file space of the instance's primary node. Unit: Byte
subnetId string: Subnet ID
tags GetInstanceTag[]: Tag information of the cloud disk
updateTime string: Instance update time
vcpu number: CPU size. For example: 1 means 1U
vpcId string: Use this parameter to specify the private network for the instance
zoneId string: Availability zone ID

allow_list_ids Sequence[str]: Allowlist ID. To bind multiple allowlists, separate allowlist IDs with commas (,). An instance can bind up to 100 allowlists.
charge_detail GetInstanceChargeDetail: Payment method
create_time str: Instance creation time
data_sync_mode str: Synchronization mode. Value: Async (asynchronous synchronization)
db_engine_version str: Compatible version
endpoints Sequence[GetInstanceEndpoint]: Instance connection information
id str: Uniquely identifies the resource.
instance_id str: Instance ID
instance_name str: Instance name
instance_status str: Instance status
instance_type str: Instance type. Value: HA (high availability edition)
maintenance_window GetInstanceMaintenanceWindow: Instance maintenance window
memory float: Memory size, unit: GB
node_infos Sequence[GetInstanceNodeInfo]: Instance specification configuration
node_number float: Number of nodes
node_spec str: Primary node specification
project_name str: Project. Default value: default project
storage_data_use float: Data file space used by the primary node. Unit: Byte
storage_log_use float: Log file space used by the primary node. Unit: Byte
storage_space float: Instance storage space. Value range: [20, 3000], unit: GB, increment: 10GB. Default value is 100
storage_temp_use float: Temporary file space used by the primary node. Unit: Byte
storage_type str: Instance storage type, fixed value LocalSSD (local SSD disk)
storage_use float: Used storage space of the instance. Unit: Byte
storage_wal_use float: Used WAL file space of the instance's primary node. Unit: Byte
subnet_id str: Subnet ID
tags Sequence[GetInstanceTag]: Tag information of the cloud disk
update_time str: Instance update time
vcpu float: CPU size. For example: 1 means 1U
vpc_id str: Use this parameter to specify the private network for the instance
zone_id str: Availability zone ID

allowListIds List<String>: Allowlist ID. To bind multiple allowlists, separate allowlist IDs with commas (,). An instance can bind up to 100 allowlists.
chargeDetail Property Map: Payment method
createTime String: Instance creation time
dataSyncMode String: Synchronization mode. Value: Async (asynchronous synchronization)
dbEngineVersion String: Compatible version
endpoints List<Property Map>: Instance connection information
id String: Uniquely identifies the resource.
instanceId String: Instance ID
instanceName String: Instance name
instanceStatus String: Instance status
instanceType String: Instance type. Value: HA (high availability edition)
maintenanceWindow Property Map: Instance maintenance window
memory Number: Memory size, unit: GB
nodeInfos List<Property Map>: Instance specification configuration
nodeNumber Number: Number of nodes
nodeSpec String: Primary node specification
projectName String: Project. Default value: default project
storageDataUse Number: Data file space used by the primary node. Unit: Byte
storageLogUse Number: Log file space used by the primary node. Unit: Byte
storageSpace Number: Instance storage space. Value range: [20, 3000], unit: GB, increment: 10GB. Default value is 100
storageTempUse Number: Temporary file space used by the primary node. Unit: Byte
storageType String: Instance storage type, fixed value LocalSSD (local SSD disk)
storageUse Number: Used storage space of the instance. Unit: Byte
storageWalUse Number: Used WAL file space of the instance's primary node. Unit: Byte
subnetId String: Subnet ID
tags List<Property Map>: Tag information of the cloud disk
updateTime String: Instance update time
vcpu Number: CPU size. For example: 1 means 1U
vpcId String: Use this parameter to specify the private network for the instance
zoneId String: Availability zone ID

Supporting Types

GetInstanceChargeDetail

AutoRenew bool: Enable auto-renewal for prepaid scenarios
ChargeEndTime string: Billing expiration time for yearly/monthly instances
ChargeStartTime string: Instance billing start time
ChargeStatus string: Payment status. Value: - Normal: Normal - Overdue: Overdue and suspended - Unpaid: Unpaid
ChargeType string: Payment type. Value: - PostPaid: Postpaid - PrePaid: Prepaid
OverdueReclaimTime string: Estimated release time after instance suspension due to overdue payment
OverdueTime string: Instance shutdown time due to overdue payment
Period double: Purchase duration for prepaid scenarios
PeriodUnit string: Purchase period for prepaid scenarios. Values: - Month: month - Year: year
TempModifyEndTime string: Rollback time for temporary upgrade
TempModifyStartTime string: Start time of temporary scaling

AutoRenew bool: Enable auto-renewal for prepaid scenarios
ChargeEndTime string: Billing expiration time for yearly/monthly instances
ChargeStartTime string: Instance billing start time
ChargeStatus string: Payment status. Value: - Normal: Normal - Overdue: Overdue and suspended - Unpaid: Unpaid
ChargeType string: Payment type. Value: - PostPaid: Postpaid - PrePaid: Prepaid
OverdueReclaimTime string: Estimated release time after instance suspension due to overdue payment
OverdueTime string: Instance shutdown time due to overdue payment
Period float64: Purchase duration for prepaid scenarios
PeriodUnit string: Purchase period for prepaid scenarios. Values: - Month: month - Year: year
TempModifyEndTime string: Rollback time for temporary upgrade
TempModifyStartTime string: Start time of temporary scaling

autoRenew Boolean: Enable auto-renewal for prepaid scenarios
chargeEndTime String: Billing expiration time for yearly/monthly instances
chargeStartTime String: Instance billing start time
chargeStatus String: Payment status. Value: - Normal: Normal - Overdue: Overdue and suspended - Unpaid: Unpaid
chargeType String: Payment type. Value: - PostPaid: Postpaid - PrePaid: Prepaid
overdueReclaimTime String: Estimated release time after instance suspension due to overdue payment
overdueTime String: Instance shutdown time due to overdue payment
period Double: Purchase duration for prepaid scenarios
periodUnit String: Purchase period for prepaid scenarios. Values: - Month: month - Year: year
tempModifyEndTime String: Rollback time for temporary upgrade
tempModifyStartTime String: Start time of temporary scaling

autoRenew boolean: Enable auto-renewal for prepaid scenarios
chargeEndTime string: Billing expiration time for yearly/monthly instances
chargeStartTime string: Instance billing start time
chargeStatus string: Payment status. Value: - Normal: Normal - Overdue: Overdue and suspended - Unpaid: Unpaid
chargeType string: Payment type. Value: - PostPaid: Postpaid - PrePaid: Prepaid
overdueReclaimTime string: Estimated release time after instance suspension due to overdue payment
overdueTime string: Instance shutdown time due to overdue payment
period number: Purchase duration for prepaid scenarios
periodUnit string: Purchase period for prepaid scenarios. Values: - Month: month - Year: year
tempModifyEndTime string: Rollback time for temporary upgrade
tempModifyStartTime string: Start time of temporary scaling

auto_renew bool: Enable auto-renewal for prepaid scenarios
charge_end_time str: Billing expiration time for yearly/monthly instances
charge_start_time str: Instance billing start time
charge_status str: Payment status. Value: - Normal: Normal - Overdue: Overdue and suspended - Unpaid: Unpaid
charge_type str: Payment type. Value: - PostPaid: Postpaid - PrePaid: Prepaid
overdue_reclaim_time str: Estimated release time after instance suspension due to overdue payment
overdue_time str: Instance shutdown time due to overdue payment
period float: Purchase duration for prepaid scenarios
period_unit str: Purchase period for prepaid scenarios. Values: - Month: month - Year: year
temp_modify_end_time str: Rollback time for temporary upgrade
temp_modify_start_time str: Start time of temporary scaling

autoRenew Boolean: Enable auto-renewal for prepaid scenarios
chargeEndTime String: Billing expiration time for yearly/monthly instances
chargeStartTime String: Instance billing start time
chargeStatus String: Payment status. Value: - Normal: Normal - Overdue: Overdue and suspended - Unpaid: Unpaid
chargeType String: Payment type. Value: - PostPaid: Postpaid - PrePaid: Prepaid
overdueReclaimTime String: Estimated release time after instance suspension due to overdue payment
overdueTime String: Instance shutdown time due to overdue payment
period Number: Purchase duration for prepaid scenarios
periodUnit String: Purchase period for prepaid scenarios. Values: - Month: month - Year: year
tempModifyEndTime String: Rollback time for temporary upgrade
tempModifyStartTime String: Start time of temporary scaling

GetInstanceEndpoint

Addresses List<Volcengine.GetInstanceEndpointAddress>: Address list.
AutoAddNewNodes string: When the terminal type is read-write or read-only, you can set whether new nodes join automatically. Values: - Enable: join automatically - Disable: do not join automatically (default)
Description string: Address description.
EnableReadOnly string: Enable global read-only mode. - Enable: enabled - Disable: not enabled
EnableReadWriteSplitting string: Enable read-write separation. Values: - Enable: enabled - Disable: not enabled
EndpointId string: Instance connection terminal ID
EndpointName string: Instance connection terminal name
EndpointType string: Endpoint type: - Cluster: Default endpoint (created by default) - Custom: Custom endpoint
ReadOnlyNodeDistributionType string: Read-only weight allocation mode. Options: - Default: Standard weight allocation (default). - Custom: Custom weight allocation
ReadOnlyNodeMaxDelayTime double: Maximum latency threshold for read-only nodes. If a read-only node's latency exceeds this value, read traffic will not be sent to that node. Unit: seconds. Range: 0~3600. Default: 30. Note: This parameter can be set for the default endpoint when read/write splitting is enabled.
ReadOnlyNodeWeights List<Volcengine.GetInstanceEndpointReadOnlyNodeWeight>: List of nodes configured for the endpoint and their corresponding read-only weights.
ReadWriteMode string: Read/write mode: - ReadWrite: Read/write - ReadOnly: Read-only
ReadWriteProxyConnection double: After read/write splitting is enabled for the terminal, set the number of proxy connections for the terminal. - The minimum value for proxy connections is 20. - The maximum value depends on the specification of the instance's primary node. Different specifications support different maximum proxy connections. For details, see [Product Specifications]
WriteNodeHaltWriting bool: Whether the endpoint sends write requests to the write node (currently, only the primary node is the write node). Value: - true: Yes. (Default) - false: No

Addresses []GetInstanceEndpointAddress: Address list.
AutoAddNewNodes string: When the terminal type is read-write or read-only, you can set whether new nodes join automatically. Values: - Enable: join automatically - Disable: do not join automatically (default)
Description string: Address description.
EnableReadOnly string: Enable global read-only mode. - Enable: enabled - Disable: not enabled
EnableReadWriteSplitting string: Enable read-write separation. Values: - Enable: enabled - Disable: not enabled
EndpointId string: Instance connection terminal ID
EndpointName string: Instance connection terminal name
EndpointType string: Endpoint type: - Cluster: Default endpoint (created by default) - Custom: Custom endpoint
ReadOnlyNodeDistributionType string: Read-only weight allocation mode. Options: - Default: Standard weight allocation (default). - Custom: Custom weight allocation
ReadOnlyNodeMaxDelayTime float64: Maximum latency threshold for read-only nodes. If a read-only node's latency exceeds this value, read traffic will not be sent to that node. Unit: seconds. Range: 0~3600. Default: 30. Note: This parameter can be set for the default endpoint when read/write splitting is enabled.
ReadOnlyNodeWeights []GetInstanceEndpointReadOnlyNodeWeight: List of nodes configured for the endpoint and their corresponding read-only weights.
ReadWriteMode string: Read/write mode: - ReadWrite: Read/write - ReadOnly: Read-only
ReadWriteProxyConnection float64: After read/write splitting is enabled for the terminal, set the number of proxy connections for the terminal. - The minimum value for proxy connections is 20. - The maximum value depends on the specification of the instance's primary node. Different specifications support different maximum proxy connections. For details, see [Product Specifications]
WriteNodeHaltWriting bool: Whether the endpoint sends write requests to the write node (currently, only the primary node is the write node). Value: - true: Yes. (Default) - false: No

addresses List<GetInstanceEndpointAddress>: Address list.
autoAddNewNodes String: When the terminal type is read-write or read-only, you can set whether new nodes join automatically. Values: - Enable: join automatically - Disable: do not join automatically (default)
description String: Address description.
enableReadOnly String: Enable global read-only mode. - Enable: enabled - Disable: not enabled
enableReadWriteSplitting String: Enable read-write separation. Values: - Enable: enabled - Disable: not enabled
endpointId String: Instance connection terminal ID
endpointName String: Instance connection terminal name
endpointType String: Endpoint type: - Cluster: Default endpoint (created by default) - Custom: Custom endpoint
readOnlyNodeDistributionType String: Read-only weight allocation mode. Options: - Default: Standard weight allocation (default). - Custom: Custom weight allocation
readOnlyNodeMaxDelayTime Double: Maximum latency threshold for read-only nodes. If a read-only node's latency exceeds this value, read traffic will not be sent to that node. Unit: seconds. Range: 0~3600. Default: 30. Note: This parameter can be set for the default endpoint when read/write splitting is enabled.
readOnlyNodeWeights List<GetInstanceEndpointReadOnlyNodeWeight>: List of nodes configured for the endpoint and their corresponding read-only weights.
readWriteMode String: Read/write mode: - ReadWrite: Read/write - ReadOnly: Read-only
readWriteProxyConnection Double: After read/write splitting is enabled for the terminal, set the number of proxy connections for the terminal. - The minimum value for proxy connections is 20. - The maximum value depends on the specification of the instance's primary node. Different specifications support different maximum proxy connections. For details, see [Product Specifications]
writeNodeHaltWriting Boolean: Whether the endpoint sends write requests to the write node (currently, only the primary node is the write node). Value: - true: Yes. (Default) - false: No

addresses GetInstanceEndpointAddress[]: Address list.
autoAddNewNodes string: When the terminal type is read-write or read-only, you can set whether new nodes join automatically. Values: - Enable: join automatically - Disable: do not join automatically (default)
description string: Address description.
enableReadOnly string: Enable global read-only mode. - Enable: enabled - Disable: not enabled
enableReadWriteSplitting string: Enable read-write separation. Values: - Enable: enabled - Disable: not enabled
endpointId string: Instance connection terminal ID
endpointName string: Instance connection terminal name
endpointType string: Endpoint type: - Cluster: Default endpoint (created by default) - Custom: Custom endpoint
readOnlyNodeDistributionType string: Read-only weight allocation mode. Options: - Default: Standard weight allocation (default). - Custom: Custom weight allocation
readOnlyNodeMaxDelayTime number: Maximum latency threshold for read-only nodes. If a read-only node's latency exceeds this value, read traffic will not be sent to that node. Unit: seconds. Range: 0~3600. Default: 30. Note: This parameter can be set for the default endpoint when read/write splitting is enabled.
readOnlyNodeWeights GetInstanceEndpointReadOnlyNodeWeight[]: List of nodes configured for the endpoint and their corresponding read-only weights.
readWriteMode string: Read/write mode: - ReadWrite: Read/write - ReadOnly: Read-only
readWriteProxyConnection number: After read/write splitting is enabled for the terminal, set the number of proxy connections for the terminal. - The minimum value for proxy connections is 20. - The maximum value depends on the specification of the instance's primary node. Different specifications support different maximum proxy connections. For details, see [Product Specifications]
writeNodeHaltWriting boolean: Whether the endpoint sends write requests to the write node (currently, only the primary node is the write node). Value: - true: Yes. (Default) - false: No

addresses Sequence[GetInstanceEndpointAddress]: Address list.
auto_add_new_nodes str: When the terminal type is read-write or read-only, you can set whether new nodes join automatically. Values: - Enable: join automatically - Disable: do not join automatically (default)
description str: Address description.
enable_read_only str: Enable global read-only mode. - Enable: enabled - Disable: not enabled
enable_read_write_splitting str: Enable read-write separation. Values: - Enable: enabled - Disable: not enabled
endpoint_id str: Instance connection terminal ID
endpoint_name str: Instance connection terminal name
endpoint_type str: Endpoint type: - Cluster: Default endpoint (created by default) - Custom: Custom endpoint
read_only_node_distribution_type str: Read-only weight allocation mode. Options: - Default: Standard weight allocation (default). - Custom: Custom weight allocation
read_only_node_max_delay_time float: Maximum latency threshold for read-only nodes. If a read-only node's latency exceeds this value, read traffic will not be sent to that node. Unit: seconds. Range: 0~3600. Default: 30. Note: This parameter can be set for the default endpoint when read/write splitting is enabled.
read_only_node_weights Sequence[GetInstanceEndpointReadOnlyNodeWeight]: List of nodes configured for the endpoint and their corresponding read-only weights.
read_write_mode str: Read/write mode: - ReadWrite: Read/write - ReadOnly: Read-only
read_write_proxy_connection float: After read/write splitting is enabled for the terminal, set the number of proxy connections for the terminal. - The minimum value for proxy connections is 20. - The maximum value depends on the specification of the instance's primary node. Different specifications support different maximum proxy connections. For details, see [Product Specifications]
write_node_halt_writing bool: Whether the endpoint sends write requests to the write node (currently, only the primary node is the write node). Value: - true: Yes. (Default) - false: No

addresses List<Property Map>: Address list.
autoAddNewNodes String: When the terminal type is read-write or read-only, you can set whether new nodes join automatically. Values: - Enable: join automatically - Disable: do not join automatically (default)
description String: Address description.
enableReadOnly String: Enable global read-only mode. - Enable: enabled - Disable: not enabled
enableReadWriteSplitting String: Enable read-write separation. Values: - Enable: enabled - Disable: not enabled
endpointId String: Instance connection terminal ID
endpointName String: Instance connection terminal name
endpointType String: Endpoint type: - Cluster: Default endpoint (created by default) - Custom: Custom endpoint
readOnlyNodeDistributionType String: Read-only weight allocation mode. Options: - Default: Standard weight allocation (default). - Custom: Custom weight allocation
readOnlyNodeMaxDelayTime Number: Maximum latency threshold for read-only nodes. If a read-only node's latency exceeds this value, read traffic will not be sent to that node. Unit: seconds. Range: 0~3600. Default: 30. Note: This parameter can be set for the default endpoint when read/write splitting is enabled.
readOnlyNodeWeights List<Property Map>: List of nodes configured for the endpoint and their corresponding read-only weights.
readWriteMode String: Read/write mode: - ReadWrite: Read/write - ReadOnly: Read-only
readWriteProxyConnection Number: After read/write splitting is enabled for the terminal, set the number of proxy connections for the terminal. - The minimum value for proxy connections is 20. - The maximum value depends on the specification of the instance's primary node. Different specifications support different maximum proxy connections. For details, see [Product Specifications]
writeNodeHaltWriting Boolean: Whether the endpoint sends write requests to the write node (currently, only the primary node is the write node). Value: - true: Yes. (Default) - false: No

GetInstanceEndpointAddress

CrossRegionDomain string: Private network address accessible across regions
DnsVisibility bool: Enable public network resolution. Values: - false: default, private network resolution - true: private and public network resolution
Domain string: Connection domain name
DomainVisibilitySetting string: Private network address type. Values: LocalDomain: local region domain name CrossRegionDomain: cross-region accessible domain name
EipId string: EIP ID, valid only for Public addresses
IpAddress string: IP address
NetworkType string: Network address type. Value: - Private: Private network address - Public: Public network address - Inner: Public service zone address
Port string: Port.
SubnetId string: Subnet ID

CrossRegionDomain string: Private network address accessible across regions
DnsVisibility bool: Enable public network resolution. Values: - false: default, private network resolution - true: private and public network resolution
Domain string: Connection domain name
DomainVisibilitySetting string: Private network address type. Values: LocalDomain: local region domain name CrossRegionDomain: cross-region accessible domain name
EipId string: EIP ID, valid only for Public addresses
IpAddress string: IP address
NetworkType string: Network address type. Value: - Private: Private network address - Public: Public network address - Inner: Public service zone address
Port string: Port.
SubnetId string: Subnet ID

crossRegionDomain String: Private network address accessible across regions
dnsVisibility Boolean: Enable public network resolution. Values: - false: default, private network resolution - true: private and public network resolution
domain String: Connection domain name
domainVisibilitySetting String: Private network address type. Values: LocalDomain: local region domain name CrossRegionDomain: cross-region accessible domain name
eipId String: EIP ID, valid only for Public addresses
ipAddress String: IP address
networkType String: Network address type. Value: - Private: Private network address - Public: Public network address - Inner: Public service zone address
port String: Port.
subnetId String: Subnet ID

crossRegionDomain string: Private network address accessible across regions
dnsVisibility boolean: Enable public network resolution. Values: - false: default, private network resolution - true: private and public network resolution
domain string: Connection domain name
domainVisibilitySetting string: Private network address type. Values: LocalDomain: local region domain name CrossRegionDomain: cross-region accessible domain name
eipId string: EIP ID, valid only for Public addresses
ipAddress string: IP address
networkType string: Network address type. Value: - Private: Private network address - Public: Public network address - Inner: Public service zone address
port string: Port.
subnetId string: Subnet ID

cross_region_domain str: Private network address accessible across regions
dns_visibility bool: Enable public network resolution. Values: - false: default, private network resolution - true: private and public network resolution
domain str: Connection domain name
domain_visibility_setting str: Private network address type. Values: LocalDomain: local region domain name CrossRegionDomain: cross-region accessible domain name
eip_id str: EIP ID, valid only for Public addresses
ip_address str: IP address
network_type str: Network address type. Value: - Private: Private network address - Public: Public network address - Inner: Public service zone address
port str: Port.
subnet_id str: Subnet ID

crossRegionDomain String: Private network address accessible across regions
dnsVisibility Boolean: Enable public network resolution. Values: - false: default, private network resolution - true: private and public network resolution
domain String: Connection domain name
domainVisibilitySetting String: Private network address type. Values: LocalDomain: local region domain name CrossRegionDomain: cross-region accessible domain name
eipId String: EIP ID, valid only for Public addresses
ipAddress String: IP address
networkType String: Network address type. Value: - Private: Private network address - Public: Public network address - Inner: Public service zone address
port String: Port.
subnetId String: Subnet ID

GetInstanceEndpointReadOnlyNodeWeight

NodeId string: Read-only nodes require NodeId
NodeType string: Node type
Weight double: Node read weight, increases by 100, maximum value is 10000

NodeId string: Read-only nodes require NodeId
NodeType string: Node type
Weight float64: Node read weight, increases by 100, maximum value is 10000

nodeId String: Read-only nodes require NodeId
nodeType String: Node type
weight Double: Node read weight, increases by 100, maximum value is 10000

nodeId string: Read-only nodes require NodeId
nodeType string: Node type
weight number: Node read weight, increases by 100, maximum value is 10000

node_id str: Read-only nodes require NodeId
node_type str: Node type
weight float: Node read weight, increases by 100, maximum value is 10000

nodeId String: Read-only nodes require NodeId
nodeType String: Node type
weight Number: Node read weight, increases by 100, maximum value is 10000

GetInstanceMaintenanceWindow

DayKind string: Granularity of the maintenance cycle. Value: Week (week)
DayOfWeekMaintenanceTimes List<Volcengine.GetInstanceMaintenanceWindowDayOfWeekMaintenanceTime>: Detailed information about the instance's maintenance window.

DayKind string: Granularity of the maintenance cycle. Value: Week (week)
DayOfWeekMaintenanceTimes []GetInstanceMaintenanceWindowDayOfWeekMaintenanceTime: Detailed information about the instance's maintenance window.

dayKind String: Granularity of the maintenance cycle. Value: Week (week)
dayOfWeekMaintenanceTimes List<GetInstanceMaintenanceWindowDayOfWeekMaintenanceTime>: Detailed information about the instance's maintenance window.

dayKind string: Granularity of the maintenance cycle. Value: Week (week)
dayOfWeekMaintenanceTimes GetInstanceMaintenanceWindowDayOfWeekMaintenanceTime[]: Detailed information about the instance's maintenance window.

day_kind str: Granularity of the maintenance cycle. Value: Week (week)
day_of_week_maintenance_times Sequence[GetInstanceMaintenanceWindowDayOfWeekMaintenanceTime]: Detailed information about the instance's maintenance window.

dayKind String: Granularity of the maintenance cycle. Value: Week (week)
dayOfWeekMaintenanceTimes List<Property Map>: Detailed information about the instance's maintenance window.

GetInstanceMaintenanceWindowDayOfWeekMaintenanceTime

DayOfWeek string: Specify maintenance days for the instance each week. Multiple selections allowed. Monday: Monday. Tuesday: Tuesday. Wednesday: Wednesday. Thursday: Thursday. Friday: Friday. Saturday: Saturday. Sunday: Sunday. Note: If not specified or left blank, all seven days are enabled by default.
MaintenanceWindowStartTime string: Start time of the maintenance window on the maintenance day. Format: HH:mmZ (UTC time). Currently, only start times between 16:00Z and 20:00Z are supported.
Period int: Duration of the maintenance window on the maintenance day. Minimum duration is 2 hours, maximum is 6 hours.

DayOfWeek string: Specify maintenance days for the instance each week. Multiple selections allowed. Monday: Monday. Tuesday: Tuesday. Wednesday: Wednesday. Thursday: Thursday. Friday: Friday. Saturday: Saturday. Sunday: Sunday. Note: If not specified or left blank, all seven days are enabled by default.
MaintenanceWindowStartTime string: Start time of the maintenance window on the maintenance day. Format: HH:mmZ (UTC time). Currently, only start times between 16:00Z and 20:00Z are supported.
Period int: Duration of the maintenance window on the maintenance day. Minimum duration is 2 hours, maximum is 6 hours.

dayOfWeek String: Specify maintenance days for the instance each week. Multiple selections allowed. Monday: Monday. Tuesday: Tuesday. Wednesday: Wednesday. Thursday: Thursday. Friday: Friday. Saturday: Saturday. Sunday: Sunday. Note: If not specified or left blank, all seven days are enabled by default.
maintenanceWindowStartTime String: Start time of the maintenance window on the maintenance day. Format: HH:mmZ (UTC time). Currently, only start times between 16:00Z and 20:00Z are supported.
period Integer: Duration of the maintenance window on the maintenance day. Minimum duration is 2 hours, maximum is 6 hours.

dayOfWeek string: Specify maintenance days for the instance each week. Multiple selections allowed. Monday: Monday. Tuesday: Tuesday. Wednesday: Wednesday. Thursday: Thursday. Friday: Friday. Saturday: Saturday. Sunday: Sunday. Note: If not specified or left blank, all seven days are enabled by default.
maintenanceWindowStartTime string: Start time of the maintenance window on the maintenance day. Format: HH:mmZ (UTC time). Currently, only start times between 16:00Z and 20:00Z are supported.
period number: Duration of the maintenance window on the maintenance day. Minimum duration is 2 hours, maximum is 6 hours.

day_of_week str: Specify maintenance days for the instance each week. Multiple selections allowed. Monday: Monday. Tuesday: Tuesday. Wednesday: Wednesday. Thursday: Thursday. Friday: Friday. Saturday: Saturday. Sunday: Sunday. Note: If not specified or left blank, all seven days are enabled by default.
maintenance_window_start_time str: Start time of the maintenance window on the maintenance day. Format: HH:mmZ (UTC time). Currently, only start times between 16:00Z and 20:00Z are supported.
period int: Duration of the maintenance window on the maintenance day. Minimum duration is 2 hours, maximum is 6 hours.

dayOfWeek String: Specify maintenance days for the instance each week. Multiple selections allowed. Monday: Monday. Tuesday: Tuesday. Wednesday: Wednesday. Thursday: Thursday. Friday: Friday. Saturday: Saturday. Sunday: Sunday. Note: If not specified or left blank, all seven days are enabled by default.
maintenanceWindowStartTime String: Start time of the maintenance window on the maintenance day. Format: HH:mmZ (UTC time). Currently, only start times between 16:00Z and 20:00Z are supported.
period Number: Duration of the maintenance window on the maintenance day. Minimum duration is 2 hours, maximum is 6 hours.

GetInstanceNodeInfo

CreateTime string: Node creation time. Format: yyyy-MM-ddTHH:mm:ss.sssZ (UTC time)
InstanceId string: Instance ID
Memory double: Memory size, unit: GB
NodeId string: Node ID
NodeSpec string: Node specification
NodeStatus string: Node status
NodeType string: Node type
RegionId string: Region ID
UpdateTime string: Node update time. Format: yyyy-MM-ddTHH:mm:ss.sssZ (UTC time)
Vcpu double: CPU size. For example: 1 means 1U
ZoneId string: Availability zone of the node

CreateTime string: Node creation time. Format: yyyy-MM-ddTHH:mm:ss.sssZ (UTC time)
InstanceId string: Instance ID
Memory float64: Memory size, unit: GB
NodeId string: Node ID
NodeSpec string: Node specification
NodeStatus string: Node status
NodeType string: Node type
RegionId string: Region ID
UpdateTime string: Node update time. Format: yyyy-MM-ddTHH:mm:ss.sssZ (UTC time)
Vcpu float64: CPU size. For example: 1 means 1U
ZoneId string: Availability zone of the node

createTime String: Node creation time. Format: yyyy-MM-ddTHH:mm:ss.sssZ (UTC time)
instanceId String: Instance ID
memory Double: Memory size, unit: GB
nodeId String: Node ID
nodeSpec String: Node specification
nodeStatus String: Node status
nodeType String: Node type
regionId String: Region ID
updateTime String: Node update time. Format: yyyy-MM-ddTHH:mm:ss.sssZ (UTC time)
vcpu Double: CPU size. For example: 1 means 1U
zoneId String: Availability zone of the node

createTime string: Node creation time. Format: yyyy-MM-ddTHH:mm:ss.sssZ (UTC time)
instanceId string: Instance ID
memory number: Memory size, unit: GB
nodeId string: Node ID
nodeSpec string: Node specification
nodeStatus string: Node status
nodeType string: Node type
regionId string: Region ID
updateTime string: Node update time. Format: yyyy-MM-ddTHH:mm:ss.sssZ (UTC time)
vcpu number: CPU size. For example: 1 means 1U
zoneId string: Availability zone of the node

create_time str: Node creation time. Format: yyyy-MM-ddTHH:mm:ss.sssZ (UTC time)
instance_id str: Instance ID
memory float: Memory size, unit: GB
node_id str: Node ID
node_spec str: Node specification
node_status str: Node status
node_type str: Node type
region_id str: Region ID
update_time str: Node update time. Format: yyyy-MM-ddTHH:mm:ss.sssZ (UTC time)
vcpu float: CPU size. For example: 1 means 1U
zone_id str: Availability zone of the node

createTime String: Node creation time. Format: yyyy-MM-ddTHH:mm:ss.sssZ (UTC time)
instanceId String: Instance ID
memory Number: Memory size, unit: GB
nodeId String: Node ID
nodeSpec String: Node specification
nodeStatus String: Node status
nodeType String: Node type
regionId String: Region ID
updateTime String: Node update time. Format: yyyy-MM-ddTHH:mm:ss.sssZ (UTC time)
vcpu Number: CPU size. For example: 1 means 1U
zoneId String: Availability zone of the node

GetInstanceTag

Key string: Tag key
Value string: Tag value

Key string: Tag key
Value string: Tag value

key String: Tag key
value String: Tag value

key string: Tag key
value string: Tag value

key str: Tag key
value str: Tag value

key String: Tag key
value String: Tag value

Package Details

Repository: volcenginecc volcengine/pulumi-volcenginecc
License: MPL-2.0
Notes: This Pulumi package is based on the volcenginecc Terraform Provider.

Viewing docs for volcenginecc v0.0.32
published on Thursday, Apr 23, 2026 by Volcengine

Schema (JSON)

volcengine/pulumi-volcenginecc

volcenginecc.rdspostgresql.getInstance

On this page

On this page

Using getInstance

getInstance Result

Supporting Types

GetInstanceChargeDetail

GetInstanceEndpoint

GetInstanceEndpointAddress

GetInstanceEndpointReadOnlyNodeWeight

GetInstanceMaintenanceWindow

GetInstanceMaintenanceWindowDayOfWeekMaintenanceTime

GetInstanceNodeInfo

GetInstanceTag

Package Details

On this page

On this page