tencentcloud.getPostgresqlInstances

tencentcloud 1.82.64, Jan 30 26

tencentcloud 1.82.64 published on Friday, Jan 30, 2026 by tencentcloudstack

Schema (JSON)

tencentcloudstack/terraform-provider-tencentcloud

tencentcloud 1.82.64 published on Friday, Jan 30, 2026 by tencentcloudstack

Schema (JSON)

tencentcloudstack/terraform-provider-tencentcloud

Example Usage

Query all postgresql instances

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

const example = tencentcloud.getPostgresqlInstances({});

import pulumi
import pulumi_tencentcloud as tencentcloud

example = tencentcloud.get_postgresql_instances()

package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/tencentcloud/tencentcloud"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := tencentcloud.GetPostgresqlInstances(ctx, &tencentcloud.GetPostgresqlInstancesArgs{}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var example = Tencentcloud.GetPostgresqlInstances.Invoke();

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.tencentcloud.TencentcloudFunctions;
import com.pulumi.tencentcloud.inputs.GetPostgresqlInstancesArgs;
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 example = TencentcloudFunctions.getPostgresqlInstances(GetPostgresqlInstancesArgs.builder()
            .build());

    }
}

variables:
  example:
    fn::invoke:
      function: tencentcloud:getPostgresqlInstances
      arguments: {}

Query postgresql instances by filters

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

const example = tencentcloud.getPostgresqlInstances({
    id: "postgres-gngyhl9d",
    name: "tf-example",
    projectId: "1235143",
});

import pulumi
import pulumi_tencentcloud as tencentcloud

example = tencentcloud.get_postgresql_instances(id="postgres-gngyhl9d",
    name="tf-example",
    project_id="1235143")

package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/tencentcloud/tencentcloud"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := tencentcloud.GetPostgresqlInstances(ctx, &tencentcloud.GetPostgresqlInstancesArgs{
			Id:        pulumi.StringRef("postgres-gngyhl9d"),
			Name:      pulumi.StringRef("tf-example"),
			ProjectId: pulumi.StringRef("1235143"),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var example = Tencentcloud.GetPostgresqlInstances.Invoke(new()
    {
        Id = "postgres-gngyhl9d",
        Name = "tf-example",
        ProjectId = "1235143",
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.tencentcloud.TencentcloudFunctions;
import com.pulumi.tencentcloud.inputs.GetPostgresqlInstancesArgs;
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 example = TencentcloudFunctions.getPostgresqlInstances(GetPostgresqlInstancesArgs.builder()
            .id("postgres-gngyhl9d")
            .name("tf-example")
            .projectId("1235143")
            .build());

    }
}

variables:
  example:
    fn::invoke:
      function: tencentcloud:getPostgresqlInstances
      arguments:
        id: postgres-gngyhl9d
        name: tf-example
        projectId: '1235143'

Using getPostgresqlInstances

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 getPostgresqlInstances(args: GetPostgresqlInstancesArgs, opts?: InvokeOptions): Promise<GetPostgresqlInstancesResult>
function getPostgresqlInstancesOutput(args: GetPostgresqlInstancesOutputArgs, opts?: InvokeOptions): Output<GetPostgresqlInstancesResult>

def get_postgresql_instances(id: Optional[str] = None,
                             name: Optional[str] = None,
                             project_id: Optional[str] = None,
                             result_output_file: Optional[str] = None,
                             opts: Optional[InvokeOptions] = None) -> GetPostgresqlInstancesResult
def get_postgresql_instances_output(id: Optional[pulumi.Input[str]] = None,
                             name: Optional[pulumi.Input[str]] = None,
                             project_id: Optional[pulumi.Input[str]] = None,
                             result_output_file: Optional[pulumi.Input[str]] = None,
                             opts: Optional[InvokeOptions] = None) -> Output[GetPostgresqlInstancesResult]

func GetPostgresqlInstances(ctx *Context, args *GetPostgresqlInstancesArgs, opts ...InvokeOption) (*GetPostgresqlInstancesResult, error)
func GetPostgresqlInstancesOutput(ctx *Context, args *GetPostgresqlInstancesOutputArgs, opts ...InvokeOption) GetPostgresqlInstancesResultOutput

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

public static class GetPostgresqlInstances 
{
    public static Task<GetPostgresqlInstancesResult> InvokeAsync(GetPostgresqlInstancesArgs args, InvokeOptions? opts = null)
    public static Output<GetPostgresqlInstancesResult> Invoke(GetPostgresqlInstancesInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetPostgresqlInstancesResult> getPostgresqlInstances(GetPostgresqlInstancesArgs args, InvokeOptions options)
public static Output<GetPostgresqlInstancesResult> getPostgresqlInstances(GetPostgresqlInstancesArgs args, InvokeOptions options)

fn::invoke:
  function: tencentcloud:index/getPostgresqlInstances:getPostgresqlInstances
  arguments:
    # arguments dictionary

The following arguments are supported:

Id string: ID of the postgresql instance to be query.
Name string: Name of the postgresql instance to be query.
ProjectId string: Project ID of the postgresql instance to be query.
ResultOutputFile string: Used to save results.

Id string: ID of the postgresql instance to be query.
Name string: Name of the postgresql instance to be query.
ProjectId string: Project ID of the postgresql instance to be query.
ResultOutputFile string: Used to save results.

id String: ID of the postgresql instance to be query.
name String: Name of the postgresql instance to be query.
projectId String: Project ID of the postgresql instance to be query.
resultOutputFile String: Used to save results.

id string: ID of the postgresql instance to be query.
name string: Name of the postgresql instance to be query.
projectId string: Project ID of the postgresql instance to be query.
resultOutputFile string: Used to save results.

id str: ID of the postgresql instance to be query.
name str: Name of the postgresql instance to be query.
project_id str: Project ID of the postgresql instance to be query.
result_output_file str: Used to save results.

id String: ID of the postgresql instance to be query.
name String: Name of the postgresql instance to be query.
projectId String: Project ID of the postgresql instance to be query.
resultOutputFile String: Used to save results.

getPostgresqlInstances Result

The following output properties are available:

DbInstanceSets List<GetPostgresqlInstancesDbInstanceSet>: Instance details set.
InstanceLists List<GetPostgresqlInstancesInstanceList>: (Deprecated) It has been deprecated from version 1.82.64. Please use db_instance_set instead. A list of postgresql instances. Each element contains the following attributes.
Deprecated: Deprecated
Id string: ID of the postgresql instance.
Name string: Name of the postgresql instance.
ProjectId string: Project id, default value is 0.
ResultOutputFile string

DbInstanceSets []GetPostgresqlInstancesDbInstanceSet: Instance details set.
InstanceLists []GetPostgresqlInstancesInstanceList: (Deprecated) It has been deprecated from version 1.82.64. Please use db_instance_set instead. A list of postgresql instances. Each element contains the following attributes.
Deprecated: Deprecated
Id string: ID of the postgresql instance.
Name string: Name of the postgresql instance.
ProjectId string: Project id, default value is 0.
ResultOutputFile string

dbInstanceSets List<GetPostgresqlInstancesDbInstanceSet>: Instance details set.
instanceLists List<GetPostgresqlInstancesInstanceList>: (Deprecated) It has been deprecated from version 1.82.64. Please use db_instance_set instead. A list of postgresql instances. Each element contains the following attributes.
Deprecated: Deprecated
id String: ID of the postgresql instance.
name String: Name of the postgresql instance.
projectId String: Project id, default value is 0.
resultOutputFile String

dbInstanceSets GetPostgresqlInstancesDbInstanceSet[]: Instance details set.
instanceLists GetPostgresqlInstancesInstanceList[]: (Deprecated) It has been deprecated from version 1.82.64. Please use db_instance_set instead. A list of postgresql instances. Each element contains the following attributes.
Deprecated: Deprecated
id string: ID of the postgresql instance.
name string: Name of the postgresql instance.
projectId string: Project id, default value is 0.
resultOutputFile string

db_instance_sets Sequence[GetPostgresqlInstancesDbInstanceSet]: Instance details set.
instance_lists Sequence[GetPostgresqlInstancesInstanceList]: (Deprecated) It has been deprecated from version 1.82.64. Please use db_instance_set instead. A list of postgresql instances. Each element contains the following attributes.
Deprecated: Deprecated
id str: ID of the postgresql instance.
name str: Name of the postgresql instance.
project_id str: Project id, default value is 0.
result_output_file str

dbInstanceSets List<Property Map>: Instance details set.
instanceLists List<Property Map>: (Deprecated) It has been deprecated from version 1.82.64. Please use db_instance_set instead. A list of postgresql instances. Each element contains the following attributes.
Deprecated: Deprecated
id String: ID of the postgresql instance.
name String: Name of the postgresql instance.
projectId String: Project id, default value is 0.
resultOutputFile String

Supporting Types

GetPostgresqlInstancesDbInstanceSet

AppId double: User AppId.
AutoRenew double: Auto-renewal or not:
CreateTime string: Create time of the postgresql instance.
DbCharset string: Instance character set, which currently supports only:
DbEngine string: Database engine, which supports:
DbEngineConfig string: Configuration information for the database engine, and the configuration format is as follows:. {$key1:$value1, $key2:$value2} Supported engines include:. mssql_compatible engine:.
DbInstanceClass string: Purchasable specification ID.
DbInstanceCpu double: Number of assigned CPUs.
DbInstanceId string: Instance ID.
DbInstanceMemory double: Assigned instance memory size in GB.
DbInstanceName string: Instance name.
DbInstanceNetInfos List<GetPostgresqlInstancesDbInstanceSetDbInstanceNetInfo>: Instance network connection information.
DbInstanceStatus string: Instance status, including: applying (applying), init (to be initialized), initing (initializing), running (running), limited run (restricted operation), isolating (isolating), isolated (isolated), disisolating (de-isolating), recycling (recycling), recycled (recycled), job running (task executing), offline (offline), migrating (migrating), expanding (scaling out), waitSwitch (waiting to switch), switching (switching), readonly (readonly), restarting (restarting), network changing (network modification in progress), upgrading (kernel version upgrading), audit-switching (audit status changing), primary-switching (primary-secondary switching), offlining (offline), deployment changing (modify az), cloning (restoring data), parameter modifying (parameter modification in progress), log-switching (log status change), restoring (recovering), and expanding (scaling out).
DbInstanceStorage double: Assigned instance storage capacity in GB.
DbInstanceType string: Instance type, which includes:
DbInstanceVersion string: Instance version. Valid value: standard (dual-server high-availability; one-primary-one-standby).
DbKernelVersion string: PostgreSQL kernel version number.
DbMajorVersion string: PostgreSQL major version number.
DbNodeSets List<GetPostgresqlInstancesDbInstanceSetDbNodeSet>: Instance node information Note: This field may return null, indicating that no valid values can be obtained.
DbVersion string: Number of the major PostgreSQL community version and minor version, such as 12.4, which can be queried by the DescribeDBVersions API.
DeletionProtection bool: Specifies whether to enable deletion protection for the instance. valid values as follows:. -Specifies whether to enable deletion protection. valid values: true (enable deletion protection). -Specifies whether to disable deletion protection. valid values: false (disable deletion protection).
ExpandedCpu double: Number of cpu cores that have been elastically scaled out.
ExpireTime string: Instance expiration time.
IsSupportTde double: Whether the instance supports TDE data encryption.
IsolatedTime string: Instance isolation time.
MasterDbInstanceId string: Primary instance information. returned only when the instance is a read-only instance.
NetworkAccessLists List<GetPostgresqlInstancesDbInstanceSetNetworkAccessList>: Network access list of the instance (this field has been deprecated) Note: this field may return null, indicating that no valid values can be obtained.
OfflineTime string: Decommissioning time.
PayType string: Billing mode:
ProjectId double: Project ID of the postgresql instance to be query.
ReadOnlyInstanceNum double: Specifies the number of read-only instances.
Region string: Instance region such as ap-guangzhou, which corresponds to theRegion field in RegionSet.
RootUser string: Instance root account name, default value is root.
StatusInReadonlyGroup string: Describes the state of the read-only instance in the read-only group.
SubnetId string: ID of subnet.
SupportIpv6 double: Whether the instance supports IPv6:
TagLists List<GetPostgresqlInstancesDbInstanceSetTagList>: Describes the Tag information associated with the instance.
Type string: Machine type.
Uid double: Instance Uid.
UpdateTime string: Last updated time of the instance attribute.
VpcId string: ID of VPC.
Zone string: Instance AZ such as ap-guangzhou-3, which corresponds to the Zone field of ZoneSet.

AppId float64: User AppId.
AutoRenew float64: Auto-renewal or not:
CreateTime string: Create time of the postgresql instance.
DbCharset string: Instance character set, which currently supports only:
DbEngine string: Database engine, which supports:
DbEngineConfig string: Configuration information for the database engine, and the configuration format is as follows:. {$key1:$value1, $key2:$value2} Supported engines include:. mssql_compatible engine:.
DbInstanceClass string: Purchasable specification ID.
DbInstanceCpu float64: Number of assigned CPUs.
DbInstanceId string: Instance ID.
DbInstanceMemory float64: Assigned instance memory size in GB.
DbInstanceName string: Instance name.
DbInstanceNetInfos []GetPostgresqlInstancesDbInstanceSetDbInstanceNetInfo: Instance network connection information.
DbInstanceStatus string: Instance status, including: applying (applying), init (to be initialized), initing (initializing), running (running), limited run (restricted operation), isolating (isolating), isolated (isolated), disisolating (de-isolating), recycling (recycling), recycled (recycled), job running (task executing), offline (offline), migrating (migrating), expanding (scaling out), waitSwitch (waiting to switch), switching (switching), readonly (readonly), restarting (restarting), network changing (network modification in progress), upgrading (kernel version upgrading), audit-switching (audit status changing), primary-switching (primary-secondary switching), offlining (offline), deployment changing (modify az), cloning (restoring data), parameter modifying (parameter modification in progress), log-switching (log status change), restoring (recovering), and expanding (scaling out).
DbInstanceStorage float64: Assigned instance storage capacity in GB.
DbInstanceType string: Instance type, which includes:
DbInstanceVersion string: Instance version. Valid value: standard (dual-server high-availability; one-primary-one-standby).
DbKernelVersion string: PostgreSQL kernel version number.
DbMajorVersion string: PostgreSQL major version number.
DbNodeSets []GetPostgresqlInstancesDbInstanceSetDbNodeSet: Instance node information Note: This field may return null, indicating that no valid values can be obtained.
DbVersion string: Number of the major PostgreSQL community version and minor version, such as 12.4, which can be queried by the DescribeDBVersions API.
DeletionProtection bool: Specifies whether to enable deletion protection for the instance. valid values as follows:. -Specifies whether to enable deletion protection. valid values: true (enable deletion protection). -Specifies whether to disable deletion protection. valid values: false (disable deletion protection).
ExpandedCpu float64: Number of cpu cores that have been elastically scaled out.
ExpireTime string: Instance expiration time.
IsSupportTde float64: Whether the instance supports TDE data encryption.
IsolatedTime string: Instance isolation time.
MasterDbInstanceId string: Primary instance information. returned only when the instance is a read-only instance.
NetworkAccessLists []GetPostgresqlInstancesDbInstanceSetNetworkAccessList: Network access list of the instance (this field has been deprecated) Note: this field may return null, indicating that no valid values can be obtained.
OfflineTime string: Decommissioning time.
PayType string: Billing mode:
ProjectId float64: Project ID of the postgresql instance to be query.
ReadOnlyInstanceNum float64: Specifies the number of read-only instances.
Region string: Instance region such as ap-guangzhou, which corresponds to theRegion field in RegionSet.
RootUser string: Instance root account name, default value is root.
StatusInReadonlyGroup string: Describes the state of the read-only instance in the read-only group.
SubnetId string: ID of subnet.
SupportIpv6 float64: Whether the instance supports IPv6:
TagLists []GetPostgresqlInstancesDbInstanceSetTagList: Describes the Tag information associated with the instance.
Type string: Machine type.
Uid float64: Instance Uid.
UpdateTime string: Last updated time of the instance attribute.
VpcId string: ID of VPC.
Zone string: Instance AZ such as ap-guangzhou-3, which corresponds to the Zone field of ZoneSet.

appId Double: User AppId.
autoRenew Double: Auto-renewal or not:
createTime String: Create time of the postgresql instance.
dbCharset String: Instance character set, which currently supports only:
dbEngine String: Database engine, which supports:
dbEngineConfig String: Configuration information for the database engine, and the configuration format is as follows:. {$key1:$value1, $key2:$value2} Supported engines include:. mssql_compatible engine:.
dbInstanceClass String: Purchasable specification ID.
dbInstanceCpu Double: Number of assigned CPUs.
dbInstanceId String: Instance ID.
dbInstanceMemory Double: Assigned instance memory size in GB.
dbInstanceName String: Instance name.
dbInstanceNetInfos List<GetPostgresqlInstancesDbInstanceSetDbInstanceNetInfo>: Instance network connection information.
dbInstanceStatus String: Instance status, including: applying (applying), init (to be initialized), initing (initializing), running (running), limited run (restricted operation), isolating (isolating), isolated (isolated), disisolating (de-isolating), recycling (recycling), recycled (recycled), job running (task executing), offline (offline), migrating (migrating), expanding (scaling out), waitSwitch (waiting to switch), switching (switching), readonly (readonly), restarting (restarting), network changing (network modification in progress), upgrading (kernel version upgrading), audit-switching (audit status changing), primary-switching (primary-secondary switching), offlining (offline), deployment changing (modify az), cloning (restoring data), parameter modifying (parameter modification in progress), log-switching (log status change), restoring (recovering), and expanding (scaling out).
dbInstanceStorage Double: Assigned instance storage capacity in GB.
dbInstanceType String: Instance type, which includes:
dbInstanceVersion String: Instance version. Valid value: standard (dual-server high-availability; one-primary-one-standby).
dbKernelVersion String: PostgreSQL kernel version number.
dbMajorVersion String: PostgreSQL major version number.
dbNodeSets List<GetPostgresqlInstancesDbInstanceSetDbNodeSet>: Instance node information Note: This field may return null, indicating that no valid values can be obtained.
dbVersion String: Number of the major PostgreSQL community version and minor version, such as 12.4, which can be queried by the DescribeDBVersions API.
deletionProtection Boolean: Specifies whether to enable deletion protection for the instance. valid values as follows:. -Specifies whether to enable deletion protection. valid values: true (enable deletion protection). -Specifies whether to disable deletion protection. valid values: false (disable deletion protection).
expandedCpu Double: Number of cpu cores that have been elastically scaled out.
expireTime String: Instance expiration time.
isSupportTde Double: Whether the instance supports TDE data encryption.
isolatedTime String: Instance isolation time.
masterDbInstanceId String: Primary instance information. returned only when the instance is a read-only instance.
networkAccessLists List<GetPostgresqlInstancesDbInstanceSetNetworkAccessList>: Network access list of the instance (this field has been deprecated) Note: this field may return null, indicating that no valid values can be obtained.
offlineTime String: Decommissioning time.
payType String: Billing mode:
projectId Double: Project ID of the postgresql instance to be query.
readOnlyInstanceNum Double: Specifies the number of read-only instances.
region String: Instance region such as ap-guangzhou, which corresponds to theRegion field in RegionSet.
rootUser String: Instance root account name, default value is root.
statusInReadonlyGroup String: Describes the state of the read-only instance in the read-only group.
subnetId String: ID of subnet.
supportIpv6 Double: Whether the instance supports IPv6:
tagLists List<GetPostgresqlInstancesDbInstanceSetTagList>: Describes the Tag information associated with the instance.
type String: Machine type.
uid Double: Instance Uid.
updateTime String: Last updated time of the instance attribute.
vpcId String: ID of VPC.
zone String: Instance AZ such as ap-guangzhou-3, which corresponds to the Zone field of ZoneSet.

appId number: User AppId.
autoRenew number: Auto-renewal or not:
createTime string: Create time of the postgresql instance.
dbCharset string: Instance character set, which currently supports only:
dbEngine string: Database engine, which supports:
dbEngineConfig string: Configuration information for the database engine, and the configuration format is as follows:. {$key1:$value1, $key2:$value2} Supported engines include:. mssql_compatible engine:.
dbInstanceClass string: Purchasable specification ID.
dbInstanceCpu number: Number of assigned CPUs.
dbInstanceId string: Instance ID.
dbInstanceMemory number: Assigned instance memory size in GB.
dbInstanceName string: Instance name.
dbInstanceNetInfos GetPostgresqlInstancesDbInstanceSetDbInstanceNetInfo[]: Instance network connection information.
dbInstanceStatus string: Instance status, including: applying (applying), init (to be initialized), initing (initializing), running (running), limited run (restricted operation), isolating (isolating), isolated (isolated), disisolating (de-isolating), recycling (recycling), recycled (recycled), job running (task executing), offline (offline), migrating (migrating), expanding (scaling out), waitSwitch (waiting to switch), switching (switching), readonly (readonly), restarting (restarting), network changing (network modification in progress), upgrading (kernel version upgrading), audit-switching (audit status changing), primary-switching (primary-secondary switching), offlining (offline), deployment changing (modify az), cloning (restoring data), parameter modifying (parameter modification in progress), log-switching (log status change), restoring (recovering), and expanding (scaling out).
dbInstanceStorage number: Assigned instance storage capacity in GB.
dbInstanceType string: Instance type, which includes:
dbInstanceVersion string: Instance version. Valid value: standard (dual-server high-availability; one-primary-one-standby).
dbKernelVersion string: PostgreSQL kernel version number.
dbMajorVersion string: PostgreSQL major version number.
dbNodeSets GetPostgresqlInstancesDbInstanceSetDbNodeSet[]: Instance node information Note: This field may return null, indicating that no valid values can be obtained.
dbVersion string: Number of the major PostgreSQL community version and minor version, such as 12.4, which can be queried by the DescribeDBVersions API.
deletionProtection boolean: Specifies whether to enable deletion protection for the instance. valid values as follows:. -Specifies whether to enable deletion protection. valid values: true (enable deletion protection). -Specifies whether to disable deletion protection. valid values: false (disable deletion protection).
expandedCpu number: Number of cpu cores that have been elastically scaled out.
expireTime string: Instance expiration time.
isSupportTde number: Whether the instance supports TDE data encryption.
isolatedTime string: Instance isolation time.
masterDbInstanceId string: Primary instance information. returned only when the instance is a read-only instance.
networkAccessLists GetPostgresqlInstancesDbInstanceSetNetworkAccessList[]: Network access list of the instance (this field has been deprecated) Note: this field may return null, indicating that no valid values can be obtained.
offlineTime string: Decommissioning time.
payType string: Billing mode:
projectId number: Project ID of the postgresql instance to be query.
readOnlyInstanceNum number: Specifies the number of read-only instances.
region string: Instance region such as ap-guangzhou, which corresponds to theRegion field in RegionSet.
rootUser string: Instance root account name, default value is root.
statusInReadonlyGroup string: Describes the state of the read-only instance in the read-only group.
subnetId string: ID of subnet.
supportIpv6 number: Whether the instance supports IPv6:
tagLists GetPostgresqlInstancesDbInstanceSetTagList[]: Describes the Tag information associated with the instance.
type string: Machine type.
uid number: Instance Uid.
updateTime string: Last updated time of the instance attribute.
vpcId string: ID of VPC.
zone string: Instance AZ such as ap-guangzhou-3, which corresponds to the Zone field of ZoneSet.

app_id float: User AppId.
auto_renew float: Auto-renewal or not:
create_time str: Create time of the postgresql instance.
db_charset str: Instance character set, which currently supports only:
db_engine str: Database engine, which supports:
db_engine_config str: Configuration information for the database engine, and the configuration format is as follows:. {$key1:$value1, $key2:$value2} Supported engines include:. mssql_compatible engine:.
db_instance_class str: Purchasable specification ID.
db_instance_cpu float: Number of assigned CPUs.
db_instance_id str: Instance ID.
db_instance_memory float: Assigned instance memory size in GB.
db_instance_name str: Instance name.
db_instance_net_infos Sequence[GetPostgresqlInstancesDbInstanceSetDbInstanceNetInfo]: Instance network connection information.
db_instance_status str: Instance status, including: applying (applying), init (to be initialized), initing (initializing), running (running), limited run (restricted operation), isolating (isolating), isolated (isolated), disisolating (de-isolating), recycling (recycling), recycled (recycled), job running (task executing), offline (offline), migrating (migrating), expanding (scaling out), waitSwitch (waiting to switch), switching (switching), readonly (readonly), restarting (restarting), network changing (network modification in progress), upgrading (kernel version upgrading), audit-switching (audit status changing), primary-switching (primary-secondary switching), offlining (offline), deployment changing (modify az), cloning (restoring data), parameter modifying (parameter modification in progress), log-switching (log status change), restoring (recovering), and expanding (scaling out).
db_instance_storage float: Assigned instance storage capacity in GB.
db_instance_type str: Instance type, which includes:
db_instance_version str: Instance version. Valid value: standard (dual-server high-availability; one-primary-one-standby).
db_kernel_version str: PostgreSQL kernel version number.
db_major_version str: PostgreSQL major version number.
db_node_sets Sequence[GetPostgresqlInstancesDbInstanceSetDbNodeSet]: Instance node information Note: This field may return null, indicating that no valid values can be obtained.
db_version str: Number of the major PostgreSQL community version and minor version, such as 12.4, which can be queried by the DescribeDBVersions API.
deletion_protection bool: Specifies whether to enable deletion protection for the instance. valid values as follows:. -Specifies whether to enable deletion protection. valid values: true (enable deletion protection). -Specifies whether to disable deletion protection. valid values: false (disable deletion protection).
expanded_cpu float: Number of cpu cores that have been elastically scaled out.
expire_time str: Instance expiration time.
is_support_tde float: Whether the instance supports TDE data encryption.
isolated_time str: Instance isolation time.
master_db_instance_id str: Primary instance information. returned only when the instance is a read-only instance.
network_access_lists Sequence[GetPostgresqlInstancesDbInstanceSetNetworkAccessList]: Network access list of the instance (this field has been deprecated) Note: this field may return null, indicating that no valid values can be obtained.
offline_time str: Decommissioning time.
pay_type str: Billing mode:
project_id float: Project ID of the postgresql instance to be query.
read_only_instance_num float: Specifies the number of read-only instances.
region str: Instance region such as ap-guangzhou, which corresponds to theRegion field in RegionSet.
root_user str: Instance root account name, default value is root.
status_in_readonly_group str: Describes the state of the read-only instance in the read-only group.
subnet_id str: ID of subnet.
support_ipv6 float: Whether the instance supports IPv6:
tag_lists Sequence[GetPostgresqlInstancesDbInstanceSetTagList]: Describes the Tag information associated with the instance.
type str: Machine type.
uid float: Instance Uid.
update_time str: Last updated time of the instance attribute.
vpc_id str: ID of VPC.
zone str: Instance AZ such as ap-guangzhou-3, which corresponds to the Zone field of ZoneSet.

appId Number: User AppId.
autoRenew Number: Auto-renewal or not:
createTime String: Create time of the postgresql instance.
dbCharset String: Instance character set, which currently supports only:
dbEngine String: Database engine, which supports:
dbEngineConfig String: Configuration information for the database engine, and the configuration format is as follows:. {$key1:$value1, $key2:$value2} Supported engines include:. mssql_compatible engine:.
dbInstanceClass String: Purchasable specification ID.
dbInstanceCpu Number: Number of assigned CPUs.
dbInstanceId String: Instance ID.
dbInstanceMemory Number: Assigned instance memory size in GB.
dbInstanceName String: Instance name.
dbInstanceNetInfos List<Property Map>: Instance network connection information.
dbInstanceStatus String: Instance status, including: applying (applying), init (to be initialized), initing (initializing), running (running), limited run (restricted operation), isolating (isolating), isolated (isolated), disisolating (de-isolating), recycling (recycling), recycled (recycled), job running (task executing), offline (offline), migrating (migrating), expanding (scaling out), waitSwitch (waiting to switch), switching (switching), readonly (readonly), restarting (restarting), network changing (network modification in progress), upgrading (kernel version upgrading), audit-switching (audit status changing), primary-switching (primary-secondary switching), offlining (offline), deployment changing (modify az), cloning (restoring data), parameter modifying (parameter modification in progress), log-switching (log status change), restoring (recovering), and expanding (scaling out).
dbInstanceStorage Number: Assigned instance storage capacity in GB.
dbInstanceType String: Instance type, which includes:
dbInstanceVersion String: Instance version. Valid value: standard (dual-server high-availability; one-primary-one-standby).
dbKernelVersion String: PostgreSQL kernel version number.
dbMajorVersion String: PostgreSQL major version number.
dbNodeSets List<Property Map>: Instance node information Note: This field may return null, indicating that no valid values can be obtained.
dbVersion String: Number of the major PostgreSQL community version and minor version, such as 12.4, which can be queried by the DescribeDBVersions API.
deletionProtection Boolean: Specifies whether to enable deletion protection for the instance. valid values as follows:. -Specifies whether to enable deletion protection. valid values: true (enable deletion protection). -Specifies whether to disable deletion protection. valid values: false (disable deletion protection).
expandedCpu Number: Number of cpu cores that have been elastically scaled out.
expireTime String: Instance expiration time.
isSupportTde Number: Whether the instance supports TDE data encryption.
isolatedTime String: Instance isolation time.
masterDbInstanceId String: Primary instance information. returned only when the instance is a read-only instance.
networkAccessLists List<Property Map>: Network access list of the instance (this field has been deprecated) Note: this field may return null, indicating that no valid values can be obtained.
offlineTime String: Decommissioning time.
payType String: Billing mode:
projectId Number: Project ID of the postgresql instance to be query.
readOnlyInstanceNum Number: Specifies the number of read-only instances.
region String: Instance region such as ap-guangzhou, which corresponds to theRegion field in RegionSet.
rootUser String: Instance root account name, default value is root.
statusInReadonlyGroup String: Describes the state of the read-only instance in the read-only group.
subnetId String: ID of subnet.
supportIpv6 Number: Whether the instance supports IPv6:
tagLists List<Property Map>: Describes the Tag information associated with the instance.
type String: Machine type.
uid Number: Instance Uid.
updateTime String: Last updated time of the instance attribute.
vpcId String: ID of VPC.
zone String: Instance AZ such as ap-guangzhou-3, which corresponds to the Zone field of ZoneSet.

GetPostgresqlInstancesDbInstanceSetDbInstanceNetInfo

Address string: DNS domain name.
Ip string: Ip.
NetType string: Network type. 1: inner (private network address), 2: public (public network address).
Port double: Connection port address.
ProtocolType string: Specifies the protocol type to connect to the database. currently supported: postgresql, mssql (mssql compatible syntax).
Status string: Network connection status. Valid values: initing (never enabled before), opened (enabled), closed (disabled), opening (enabling), closing (disabling).
SubnetId string: ID of subnet.
VpcId string: ID of VPC.

Address string: DNS domain name.
Ip string: Ip.
NetType string: Network type. 1: inner (private network address), 2: public (public network address).
Port float64: Connection port address.
ProtocolType string: Specifies the protocol type to connect to the database. currently supported: postgresql, mssql (mssql compatible syntax).
Status string: Network connection status. Valid values: initing (never enabled before), opened (enabled), closed (disabled), opening (enabling), closing (disabling).
SubnetId string: ID of subnet.
VpcId string: ID of VPC.

address String: DNS domain name.
ip String: Ip.
netType String: Network type. 1: inner (private network address), 2: public (public network address).
port Double: Connection port address.
protocolType String: Specifies the protocol type to connect to the database. currently supported: postgresql, mssql (mssql compatible syntax).
status String: Network connection status. Valid values: initing (never enabled before), opened (enabled), closed (disabled), opening (enabling), closing (disabling).
subnetId String: ID of subnet.
vpcId String: ID of VPC.

address string: DNS domain name.
ip string: Ip.
netType string: Network type. 1: inner (private network address), 2: public (public network address).
port number: Connection port address.
protocolType string: Specifies the protocol type to connect to the database. currently supported: postgresql, mssql (mssql compatible syntax).
status string: Network connection status. Valid values: initing (never enabled before), opened (enabled), closed (disabled), opening (enabling), closing (disabling).
subnetId string: ID of subnet.
vpcId string: ID of VPC.

address str: DNS domain name.
ip str: Ip.
net_type str: Network type. 1: inner (private network address), 2: public (public network address).
port float: Connection port address.
protocol_type str: Specifies the protocol type to connect to the database. currently supported: postgresql, mssql (mssql compatible syntax).
status str: Network connection status. Valid values: initing (never enabled before), opened (enabled), closed (disabled), opening (enabling), closing (disabling).
subnet_id str: ID of subnet.
vpc_id str: ID of VPC.

address String: DNS domain name.
ip String: Ip.
netType String: Network type. 1: inner (private network address), 2: public (public network address).
port Number: Connection port address.
protocolType String: Specifies the protocol type to connect to the database. currently supported: postgresql, mssql (mssql compatible syntax).
status String: Network connection status. Valid values: initing (never enabled before), opened (enabled), closed (disabled), opening (enabling), closing (disabling).
subnetId String: ID of subnet.
vpcId String: ID of VPC.

GetPostgresqlInstancesDbInstanceSetDbNodeSet

DedicatedClusterId string
Role string: Node type. Valid values: Primary; Standby.
Zone string: Instance AZ such as ap-guangzhou-3, which corresponds to the Zone field of ZoneSet.

DedicatedClusterId string
Role string: Node type. Valid values: Primary; Standby.
Zone string: Instance AZ such as ap-guangzhou-3, which corresponds to the Zone field of ZoneSet.

dedicatedClusterId String
role String: Node type. Valid values: Primary; Standby.
zone String: Instance AZ such as ap-guangzhou-3, which corresponds to the Zone field of ZoneSet.

dedicatedClusterId string
role string: Node type. Valid values: Primary; Standby.
zone string: Instance AZ such as ap-guangzhou-3, which corresponds to the Zone field of ZoneSet.

dedicated_cluster_id str
role str: Node type. Valid values: Primary; Standby.
zone str: Instance AZ such as ap-guangzhou-3, which corresponds to the Zone field of ZoneSet.

dedicatedClusterId String
role String: Node type. Valid values: Primary; Standby.
zone String: Instance AZ such as ap-guangzhou-3, which corresponds to the Zone field of ZoneSet.

GetPostgresqlInstancesDbInstanceSetNetworkAccessList

ResourceId string: Network resource id, instance id, or RO group id.
ResourceType double: Resource type. valid values: 1 (instance), 2 (RO group).
SubnetId string: ID of subnet.
Vip string: IPv4 Address.
Vip6 string: IPv6 Address.
VpcId string: ID of VPC.
VpcStatus double: Network status. valid values: 1-applying, 2-active, 3-deleting, 4-deleted.
Vport double: Specifies the access port.

ResourceId string: Network resource id, instance id, or RO group id.
ResourceType float64: Resource type. valid values: 1 (instance), 2 (RO group).
SubnetId string: ID of subnet.
Vip string: IPv4 Address.
Vip6 string: IPv6 Address.
VpcId string: ID of VPC.
VpcStatus float64: Network status. valid values: 1-applying, 2-active, 3-deleting, 4-deleted.
Vport float64: Specifies the access port.

resourceId String: Network resource id, instance id, or RO group id.
resourceType Double: Resource type. valid values: 1 (instance), 2 (RO group).
subnetId String: ID of subnet.
vip String: IPv4 Address.
vip6 String: IPv6 Address.
vpcId String: ID of VPC.
vpcStatus Double: Network status. valid values: 1-applying, 2-active, 3-deleting, 4-deleted.
vport Double: Specifies the access port.

resourceId string: Network resource id, instance id, or RO group id.
resourceType number: Resource type. valid values: 1 (instance), 2 (RO group).
subnetId string: ID of subnet.
vip string: IPv4 Address.
vip6 string: IPv6 Address.
vpcId string: ID of VPC.
vpcStatus number: Network status. valid values: 1-applying, 2-active, 3-deleting, 4-deleted.
vport number: Specifies the access port.

resource_id str: Network resource id, instance id, or RO group id.
resource_type float: Resource type. valid values: 1 (instance), 2 (RO group).
subnet_id str: ID of subnet.
vip str: IPv4 Address.
vip6 str: IPv6 Address.
vpc_id str: ID of VPC.
vpc_status float: Network status. valid values: 1-applying, 2-active, 3-deleting, 4-deleted.
vport float: Specifies the access port.

resourceId String: Network resource id, instance id, or RO group id.
resourceType Number: Resource type. valid values: 1 (instance), 2 (RO group).
subnetId String: ID of subnet.
vip String: IPv4 Address.
vip6 String: IPv6 Address.
vpcId String: ID of VPC.
vpcStatus Number: Network status. valid values: 1-applying, 2-active, 3-deleting, 4-deleted.
vport Number: Specifies the access port.

GetPostgresqlInstancesDbInstanceSetTagList

TagKey string: Tag key.
TagValue string: Tag value.

TagKey string: Tag key.
TagValue string: Tag value.

tagKey String: Tag key.
tagValue String: Tag value.

tagKey string: Tag key.
tagValue string: Tag value.

tag_key str: Tag key.
tag_value str: Tag value.

tagKey String: Tag key.
tagValue String: Tag value.

GetPostgresqlInstancesInstanceList

AutoRenewFlag double: Auto renew flag.
AvailabilityZone string: Availability zone.
ChargeType string: Pay type of the postgresql instance.
Charset string: Charset of the postgresql instance.
CreateTime string: Create time of the postgresql instance.
DbKernelVersion string: PostgreSQL kernel version number.
DbMajorVersion string: PostgreSQL major version number.
EngineVersion string: Version of the postgresql database engine.
Id string: ID of the postgresql instance to be query.
Memory double: Memory size(in GB).
Name string: Name of the postgresql instance to be query.
PrivateAccessIp string: IP address for private access.
PrivateAccessPort double: Port for private access.
ProjectId double: Project ID of the postgresql instance to be query.
PublicAccessHost string: Host for public access.
PublicAccessPort double: Port for public access.
PublicAccessSwitch bool: Indicates whether to enable the access to an instance from public network or not.
RootUser string: Instance root account name, default value is root.
Storage double: Volume size(in GB).
SubnetId string: ID of subnet.
Tags Dictionary<string, string>: The available tags within this postgresql.
VpcId string: ID of VPC.

AutoRenewFlag float64: Auto renew flag.
AvailabilityZone string: Availability zone.
ChargeType string: Pay type of the postgresql instance.
Charset string: Charset of the postgresql instance.
CreateTime string: Create time of the postgresql instance.
DbKernelVersion string: PostgreSQL kernel version number.
DbMajorVersion string: PostgreSQL major version number.
EngineVersion string: Version of the postgresql database engine.
Id string: ID of the postgresql instance to be query.
Memory float64: Memory size(in GB).
Name string: Name of the postgresql instance to be query.
PrivateAccessIp string: IP address for private access.
PrivateAccessPort float64: Port for private access.
ProjectId float64: Project ID of the postgresql instance to be query.
PublicAccessHost string: Host for public access.
PublicAccessPort float64: Port for public access.
PublicAccessSwitch bool: Indicates whether to enable the access to an instance from public network or not.
RootUser string: Instance root account name, default value is root.
Storage float64: Volume size(in GB).
SubnetId string: ID of subnet.
Tags map[string]string: The available tags within this postgresql.
VpcId string: ID of VPC.

autoRenewFlag Double: Auto renew flag.
availabilityZone String: Availability zone.
chargeType String: Pay type of the postgresql instance.
charset String: Charset of the postgresql instance.
createTime String: Create time of the postgresql instance.
dbKernelVersion String: PostgreSQL kernel version number.
dbMajorVersion String: PostgreSQL major version number.
engineVersion String: Version of the postgresql database engine.
id String: ID of the postgresql instance to be query.
memory Double: Memory size(in GB).
name String: Name of the postgresql instance to be query.
privateAccessIp String: IP address for private access.
privateAccessPort Double: Port for private access.
projectId Double: Project ID of the postgresql instance to be query.
publicAccessHost String: Host for public access.
publicAccessPort Double: Port for public access.
publicAccessSwitch Boolean: Indicates whether to enable the access to an instance from public network or not.
rootUser String: Instance root account name, default value is root.
storage Double: Volume size(in GB).
subnetId String: ID of subnet.
tags Map<String,String>: The available tags within this postgresql.
vpcId String: ID of VPC.

autoRenewFlag number: Auto renew flag.
availabilityZone string: Availability zone.
chargeType string: Pay type of the postgresql instance.
charset string: Charset of the postgresql instance.
createTime string: Create time of the postgresql instance.
dbKernelVersion string: PostgreSQL kernel version number.
dbMajorVersion string: PostgreSQL major version number.
engineVersion string: Version of the postgresql database engine.
id string: ID of the postgresql instance to be query.
memory number: Memory size(in GB).
name string: Name of the postgresql instance to be query.
privateAccessIp string: IP address for private access.
privateAccessPort number: Port for private access.
projectId number: Project ID of the postgresql instance to be query.
publicAccessHost string: Host for public access.
publicAccessPort number: Port for public access.
publicAccessSwitch boolean: Indicates whether to enable the access to an instance from public network or not.
rootUser string: Instance root account name, default value is root.
storage number: Volume size(in GB).
subnetId string: ID of subnet.
tags {[key: string]: string}: The available tags within this postgresql.
vpcId string: ID of VPC.

auto_renew_flag float: Auto renew flag.
availability_zone str: Availability zone.
charge_type str: Pay type of the postgresql instance.
charset str: Charset of the postgresql instance.
create_time str: Create time of the postgresql instance.
db_kernel_version str: PostgreSQL kernel version number.
db_major_version str: PostgreSQL major version number.
engine_version str: Version of the postgresql database engine.
id str: ID of the postgresql instance to be query.
memory float: Memory size(in GB).
name str: Name of the postgresql instance to be query.
private_access_ip str: IP address for private access.
private_access_port float: Port for private access.
project_id float: Project ID of the postgresql instance to be query.
public_access_host str: Host for public access.
public_access_port float: Port for public access.
public_access_switch bool: Indicates whether to enable the access to an instance from public network or not.
root_user str: Instance root account name, default value is root.
storage float: Volume size(in GB).
subnet_id str: ID of subnet.
tags Mapping[str, str]: The available tags within this postgresql.
vpc_id str: ID of VPC.

autoRenewFlag Number: Auto renew flag.
availabilityZone String: Availability zone.
chargeType String: Pay type of the postgresql instance.
charset String: Charset of the postgresql instance.
createTime String: Create time of the postgresql instance.
dbKernelVersion String: PostgreSQL kernel version number.
dbMajorVersion String: PostgreSQL major version number.
engineVersion String: Version of the postgresql database engine.
id String: ID of the postgresql instance to be query.
memory Number: Memory size(in GB).
name String: Name of the postgresql instance to be query.
privateAccessIp String: IP address for private access.
privateAccessPort Number: Port for private access.
projectId Number: Project ID of the postgresql instance to be query.
publicAccessHost String: Host for public access.
publicAccessPort Number: Port for public access.
publicAccessSwitch Boolean: Indicates whether to enable the access to an instance from public network or not.
rootUser String: Instance root account name, default value is root.
storage Number: Volume size(in GB).
subnetId String: ID of subnet.
tags Map<String>: The available tags within this postgresql.
vpcId String: ID of VPC.

Package Details

Repository: tencentcloud tencentcloudstack/terraform-provider-tencentcloud
License
Notes: This Pulumi package is based on the tencentcloud Terraform Provider.

tencentcloud 1.82.64 published on Friday, Jan 30, 2026 by tencentcloudstack

Schema (JSON)

tencentcloudstack/terraform-provider-tencentcloud

tencentcloud.getPostgresqlInstances

On this page

On this page

Example Usage

Query all postgresql instances

Query postgresql instances by filters

Using getPostgresqlInstances

getPostgresqlInstances Result

Supporting Types

GetPostgresqlInstancesDbInstanceSet

GetPostgresqlInstancesDbInstanceSetDbInstanceNetInfo

GetPostgresqlInstancesDbInstanceSetDbNodeSet

GetPostgresqlInstancesDbInstanceSetNetworkAccessList

GetPostgresqlInstancesDbInstanceSetTagList

GetPostgresqlInstancesInstanceList

Package Details

On this page

On this page