volcenginecc v0.0.4, Nov 3 25

volcenginecc v0.0.4 published on Monday, Nov 3, 2025 by Volcengine

volcenginecc.redis.getInstance

Start a Neo task

Explain and create a volcenginecc.redis.getInstance resource

volcenginecc v0.0.4 published on Monday, Nov 3, 2025 by Volcengine

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:redis/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>: 白名单 ID 列表。若该参数留空，新建实例默认不加入任何白名单。您可以调用 DescribeAllowLists 接口查询当前账号下指定地域内的所有 IP 白名单信息，包括白名单 ID 信息。每个实例最多支持绑定 100 个白名单，每次可最多批量绑定 100 个白名单。每个实例最多支持绑定 1000 个 IP 地址或 CIDR 格式的 IP 地址段。
AutoRenew bool: 是否开启自动续费。取值范围如下：false（默认值）：不开启。true：开启。
BackupPointName string: 为变更前创建的全量备份设置备份名称。
Capacity Volcengine.GetInstanceCapacity: 实例的容量信息。
ChargeType string: 实例计费类型。取值范围如下：PrePaid：包年包月（也称预付费）。PostPaid：按量计费（也称后付费）。
ConfigureNodes List<Volcengine.GetInstanceConfigureNode>: 设置节点所属的可用区列表。
CreateBackup bool: 是否在变更前创建备份。
CreateTime string: 实例的创建时间。
DataLayout string: 实例的数据存储形态。该参数仅对企业版（即ServiceType为Enterprise）实例有意义；社区版（即ServiceType为Basic）实例不涉及数据存储形态，DataLayout取值固定为RAM。若该参数留空，表示不使用数据存储形态进行筛选。
DeletionProtection string: 开启或关闭实例删除保护功能。
EngineVersion string: 数据库版本号。
ExpiredTime string: 实例到期时间。
Id string: Uniquely identifies the resource.
InstanceClass string: Redis 实例的类型。取值范围如下：PrimarySecondary：主备实例；Standalone：单节点实例。若该参数留空，表示不使用实例类型条件进行筛选。关于实例类型的更多信息，请参见产品架构。
InstanceId string: 实例 ID。
InstanceName string: 实例名称。命名规则：不能以数字、中划线（-）开头；只能包含中文、字母、数字、下划线（_）和中划线（-）；长度需要在1~128个字符内。
InstanceShards List<Volcengine.GetInstanceInstanceShard>: 实例中所有 Shard 分片的详情列表。
MaintenanceTime string: 实例的可维护时间段，格式为HH:mm-HH:mm（UTC+8）。
MaxConnections int: 实例当前单分片最大连接数。每分片的默认连接数为10000，您也可以根据业务需要调用ModifyDBInstanceMaxConn接口修改单分片的最大连接数。
MultiAz string: 设置实例的可用区部署方案。
NoAuthMode string: 为新建实例开启或关闭免密访问功能。取值范围如下：open：开启免密访问。close（默认值）：关闭免密访问。
NodeIds List<string>: Proxy 和 Server 节点 ID 列表。
NodeNumber int: 每个分片中的节点数。取值范围为1~6。每个账号在每个地域下默认最多可创建4个256MiB规格的节点，若需要调整配额上限为10个，请参见账号配额。取值为1时表示创建单节点实例；取值大于1时表示创建主备实例。关于两种类型实例的功能特性差异详情，请参见功能特性差异。
ParameterGroupId string: 需要应用到新实例的参数模板。缓存数据库 Redis 版为每个数据库版本都创建了一份默认的系统参数模板，模板中包含了该版本支持设置的所有参数和默认参数值。若该参数留空，默认会根据您设置的数据库版本（即 EngineVersion）为新建实例选择并应用对应版本的系统参数模板。您可以调用 DescribeParameterGroups 接口查询当前账号和地域下的所有参数模板的基本信息，包括参数模板 ID。
Password string: 设置默认数据库 default 账号的密码。
Port int: 自定义私网连接地址的端口号。取值范围：1024~65535。若该参数留空，私网连接地址默认使用6379端口。实例创建成功后，还可以修改私网地址的端口号，修改方法请参见修改端口号。
PrivateAddress string: 实例私网连接地址的域名。
ProjectName string: 实例所属的项目。
PurchaseMonths int: 购买时长，单位：月。取值范围如下：按月购买：1，2，3，4，5，6，7，8，9。按年购买：12，24，36。当ChargeType为PrePaid时，该参数必填。
ReserveAdditionalBandwidth bool: 设置是否保留额外带宽
ServiceType string: 实例的服务类型
ShardCapacity int: 实例中每个分片的内存容量。单位：MiB。
ShardNumber int: 实例中的分片数量。取值范围为 2~256。仅当 ShardedCluster 取值为 1（即启用分片集群）时，需要指定该参数。
ShardedCluster int: 是否启用分片集群。取值范围如下：0：不启用。1：启用。
Status string: 实例的服务类型，取值范围如下：Basic（默认值）：社区版；Enterprise：企业版。
SubnetId string: 设置实例的子网ID。子网具有可用区属性，必须选择目标私有网络中与实例属于同一可用区下的子网。子网是私有网络内的IP地址块私有网络中的所有云资源都必须部署在子网内，子网为云资源分配私网IP地址，您可以调用CreateSubnet接口创建子网。您可以调用DescribeSubnets接口查询指定可用区内的所有子网列表信息，包括子网ID。
Tags List<Volcengine.GetInstanceTag>: 设置实例的标签列表。
ViPv6 string: 实例私网连接地址所对应的 IPv6 地址。仅当实例使用了 IPv6 地址时才会返回该参数。
Vip string: 实例私网连接地址所对应的 IPv4 地址。
VisitAddrs List<Volcengine.GetInstanceVisitAddr>: 连接地址信息。
VpcAuthMode string: 开启或关闭免密访问功能。取值范围如下：open：开启免密访问；close：关闭免密访问。参数取值不区分大小写。
VpcId string: 设置实例的私有网络ID。建议Redis实例与需要连接的ECS实例在同一私有网络，否则它们无法通过内网互通来实现最佳性能。您可以调用CreateVpc接口创建私有网络。您可以调用DescribeVpcs接口查询符合指定条件的私有网络信息，包括私有网络ID。
ZoneIds List<string>: 实例所在的可用区列表。

AllowListIds []string: 白名单 ID 列表。若该参数留空，新建实例默认不加入任何白名单。您可以调用 DescribeAllowLists 接口查询当前账号下指定地域内的所有 IP 白名单信息，包括白名单 ID 信息。每个实例最多支持绑定 100 个白名单，每次可最多批量绑定 100 个白名单。每个实例最多支持绑定 1000 个 IP 地址或 CIDR 格式的 IP 地址段。
AutoRenew bool: 是否开启自动续费。取值范围如下：false（默认值）：不开启。true：开启。
BackupPointName string: 为变更前创建的全量备份设置备份名称。
Capacity GetInstanceCapacity: 实例的容量信息。
ChargeType string: 实例计费类型。取值范围如下：PrePaid：包年包月（也称预付费）。PostPaid：按量计费（也称后付费）。
ConfigureNodes []GetInstanceConfigureNode: 设置节点所属的可用区列表。
CreateBackup bool: 是否在变更前创建备份。
CreateTime string: 实例的创建时间。
DataLayout string: 实例的数据存储形态。该参数仅对企业版（即ServiceType为Enterprise）实例有意义；社区版（即ServiceType为Basic）实例不涉及数据存储形态，DataLayout取值固定为RAM。若该参数留空，表示不使用数据存储形态进行筛选。
DeletionProtection string: 开启或关闭实例删除保护功能。
EngineVersion string: 数据库版本号。
ExpiredTime string: 实例到期时间。
Id string: Uniquely identifies the resource.
InstanceClass string: Redis 实例的类型。取值范围如下：PrimarySecondary：主备实例；Standalone：单节点实例。若该参数留空，表示不使用实例类型条件进行筛选。关于实例类型的更多信息，请参见产品架构。
InstanceId string: 实例 ID。
InstanceName string: 实例名称。命名规则：不能以数字、中划线（-）开头；只能包含中文、字母、数字、下划线（_）和中划线（-）；长度需要在1~128个字符内。
InstanceShards []GetInstanceInstanceShard: 实例中所有 Shard 分片的详情列表。
MaintenanceTime string: 实例的可维护时间段，格式为HH:mm-HH:mm（UTC+8）。
MaxConnections int: 实例当前单分片最大连接数。每分片的默认连接数为10000，您也可以根据业务需要调用ModifyDBInstanceMaxConn接口修改单分片的最大连接数。
MultiAz string: 设置实例的可用区部署方案。
NoAuthMode string: 为新建实例开启或关闭免密访问功能。取值范围如下：open：开启免密访问。close（默认值）：关闭免密访问。
NodeIds []string: Proxy 和 Server 节点 ID 列表。
NodeNumber int: 每个分片中的节点数。取值范围为1~6。每个账号在每个地域下默认最多可创建4个256MiB规格的节点，若需要调整配额上限为10个，请参见账号配额。取值为1时表示创建单节点实例；取值大于1时表示创建主备实例。关于两种类型实例的功能特性差异详情，请参见功能特性差异。
ParameterGroupId string: 需要应用到新实例的参数模板。缓存数据库 Redis 版为每个数据库版本都创建了一份默认的系统参数模板，模板中包含了该版本支持设置的所有参数和默认参数值。若该参数留空，默认会根据您设置的数据库版本（即 EngineVersion）为新建实例选择并应用对应版本的系统参数模板。您可以调用 DescribeParameterGroups 接口查询当前账号和地域下的所有参数模板的基本信息，包括参数模板 ID。
Password string: 设置默认数据库 default 账号的密码。
Port int: 自定义私网连接地址的端口号。取值范围：1024~65535。若该参数留空，私网连接地址默认使用6379端口。实例创建成功后，还可以修改私网地址的端口号，修改方法请参见修改端口号。
PrivateAddress string: 实例私网连接地址的域名。
ProjectName string: 实例所属的项目。
PurchaseMonths int: 购买时长，单位：月。取值范围如下：按月购买：1，2，3，4，5，6，7，8，9。按年购买：12，24，36。当ChargeType为PrePaid时，该参数必填。
ReserveAdditionalBandwidth bool: 设置是否保留额外带宽
ServiceType string: 实例的服务类型
ShardCapacity int: 实例中每个分片的内存容量。单位：MiB。
ShardNumber int: 实例中的分片数量。取值范围为 2~256。仅当 ShardedCluster 取值为 1（即启用分片集群）时，需要指定该参数。
ShardedCluster int: 是否启用分片集群。取值范围如下：0：不启用。1：启用。
Status string: 实例的服务类型，取值范围如下：Basic（默认值）：社区版；Enterprise：企业版。
SubnetId string: 设置实例的子网ID。子网具有可用区属性，必须选择目标私有网络中与实例属于同一可用区下的子网。子网是私有网络内的IP地址块私有网络中的所有云资源都必须部署在子网内，子网为云资源分配私网IP地址，您可以调用CreateSubnet接口创建子网。您可以调用DescribeSubnets接口查询指定可用区内的所有子网列表信息，包括子网ID。
Tags []GetInstanceTag: 设置实例的标签列表。
ViPv6 string: 实例私网连接地址所对应的 IPv6 地址。仅当实例使用了 IPv6 地址时才会返回该参数。
Vip string: 实例私网连接地址所对应的 IPv4 地址。
VisitAddrs []GetInstanceVisitAddr: 连接地址信息。
VpcAuthMode string: 开启或关闭免密访问功能。取值范围如下：open：开启免密访问；close：关闭免密访问。参数取值不区分大小写。
VpcId string: 设置实例的私有网络ID。建议Redis实例与需要连接的ECS实例在同一私有网络，否则它们无法通过内网互通来实现最佳性能。您可以调用CreateVpc接口创建私有网络。您可以调用DescribeVpcs接口查询符合指定条件的私有网络信息，包括私有网络ID。
ZoneIds []string: 实例所在的可用区列表。

allowListIds List<String>: 白名单 ID 列表。若该参数留空，新建实例默认不加入任何白名单。您可以调用 DescribeAllowLists 接口查询当前账号下指定地域内的所有 IP 白名单信息，包括白名单 ID 信息。每个实例最多支持绑定 100 个白名单，每次可最多批量绑定 100 个白名单。每个实例最多支持绑定 1000 个 IP 地址或 CIDR 格式的 IP 地址段。
autoRenew Boolean: 是否开启自动续费。取值范围如下：false（默认值）：不开启。true：开启。
backupPointName String: 为变更前创建的全量备份设置备份名称。
capacity GetInstanceCapacity: 实例的容量信息。
chargeType String: 实例计费类型。取值范围如下：PrePaid：包年包月（也称预付费）。PostPaid：按量计费（也称后付费）。
configureNodes List<GetInstanceConfigureNode>: 设置节点所属的可用区列表。
createBackup Boolean: 是否在变更前创建备份。
createTime String: 实例的创建时间。
dataLayout String: 实例的数据存储形态。该参数仅对企业版（即ServiceType为Enterprise）实例有意义；社区版（即ServiceType为Basic）实例不涉及数据存储形态，DataLayout取值固定为RAM。若该参数留空，表示不使用数据存储形态进行筛选。
deletionProtection String: 开启或关闭实例删除保护功能。
engineVersion String: 数据库版本号。
expiredTime String: 实例到期时间。
id String: Uniquely identifies the resource.
instanceClass String: Redis 实例的类型。取值范围如下：PrimarySecondary：主备实例；Standalone：单节点实例。若该参数留空，表示不使用实例类型条件进行筛选。关于实例类型的更多信息，请参见产品架构。
instanceId String: 实例 ID。
instanceName String: 实例名称。命名规则：不能以数字、中划线（-）开头；只能包含中文、字母、数字、下划线（_）和中划线（-）；长度需要在1~128个字符内。
instanceShards List<GetInstanceInstanceShard>: 实例中所有 Shard 分片的详情列表。
maintenanceTime String: 实例的可维护时间段，格式为HH:mm-HH:mm（UTC+8）。
maxConnections Integer: 实例当前单分片最大连接数。每分片的默认连接数为10000，您也可以根据业务需要调用ModifyDBInstanceMaxConn接口修改单分片的最大连接数。
multiAz String: 设置实例的可用区部署方案。
noAuthMode String: 为新建实例开启或关闭免密访问功能。取值范围如下：open：开启免密访问。close（默认值）：关闭免密访问。
nodeIds List<String>: Proxy 和 Server 节点 ID 列表。
nodeNumber Integer: 每个分片中的节点数。取值范围为1~6。每个账号在每个地域下默认最多可创建4个256MiB规格的节点，若需要调整配额上限为10个，请参见账号配额。取值为1时表示创建单节点实例；取值大于1时表示创建主备实例。关于两种类型实例的功能特性差异详情，请参见功能特性差异。
parameterGroupId String: 需要应用到新实例的参数模板。缓存数据库 Redis 版为每个数据库版本都创建了一份默认的系统参数模板，模板中包含了该版本支持设置的所有参数和默认参数值。若该参数留空，默认会根据您设置的数据库版本（即 EngineVersion）为新建实例选择并应用对应版本的系统参数模板。您可以调用 DescribeParameterGroups 接口查询当前账号和地域下的所有参数模板的基本信息，包括参数模板 ID。
password String: 设置默认数据库 default 账号的密码。
port Integer: 自定义私网连接地址的端口号。取值范围：1024~65535。若该参数留空，私网连接地址默认使用6379端口。实例创建成功后，还可以修改私网地址的端口号，修改方法请参见修改端口号。
privateAddress String: 实例私网连接地址的域名。
projectName String: 实例所属的项目。
purchaseMonths Integer: 购买时长，单位：月。取值范围如下：按月购买：1，2，3，4，5，6，7，8，9。按年购买：12，24，36。当ChargeType为PrePaid时，该参数必填。
reserveAdditionalBandwidth Boolean: 设置是否保留额外带宽
serviceType String: 实例的服务类型
shardCapacity Integer: 实例中每个分片的内存容量。单位：MiB。
shardNumber Integer: 实例中的分片数量。取值范围为 2~256。仅当 ShardedCluster 取值为 1（即启用分片集群）时，需要指定该参数。
shardedCluster Integer: 是否启用分片集群。取值范围如下：0：不启用。1：启用。
status String: 实例的服务类型，取值范围如下：Basic（默认值）：社区版；Enterprise：企业版。
subnetId String: 设置实例的子网ID。子网具有可用区属性，必须选择目标私有网络中与实例属于同一可用区下的子网。子网是私有网络内的IP地址块私有网络中的所有云资源都必须部署在子网内，子网为云资源分配私网IP地址，您可以调用CreateSubnet接口创建子网。您可以调用DescribeSubnets接口查询指定可用区内的所有子网列表信息，包括子网ID。
tags List<GetInstanceTag>: 设置实例的标签列表。
viPv6 String: 实例私网连接地址所对应的 IPv6 地址。仅当实例使用了 IPv6 地址时才会返回该参数。
vip String: 实例私网连接地址所对应的 IPv4 地址。
visitAddrs List<GetInstanceVisitAddr>: 连接地址信息。
vpcAuthMode String: 开启或关闭免密访问功能。取值范围如下：open：开启免密访问；close：关闭免密访问。参数取值不区分大小写。
vpcId String: 设置实例的私有网络ID。建议Redis实例与需要连接的ECS实例在同一私有网络，否则它们无法通过内网互通来实现最佳性能。您可以调用CreateVpc接口创建私有网络。您可以调用DescribeVpcs接口查询符合指定条件的私有网络信息，包括私有网络ID。
zoneIds List<String>: 实例所在的可用区列表。

allowListIds string[]: 白名单 ID 列表。若该参数留空，新建实例默认不加入任何白名单。您可以调用 DescribeAllowLists 接口查询当前账号下指定地域内的所有 IP 白名单信息，包括白名单 ID 信息。每个实例最多支持绑定 100 个白名单，每次可最多批量绑定 100 个白名单。每个实例最多支持绑定 1000 个 IP 地址或 CIDR 格式的 IP 地址段。
autoRenew boolean: 是否开启自动续费。取值范围如下：false（默认值）：不开启。true：开启。
backupPointName string: 为变更前创建的全量备份设置备份名称。
capacity GetInstanceCapacity: 实例的容量信息。
chargeType string: 实例计费类型。取值范围如下：PrePaid：包年包月（也称预付费）。PostPaid：按量计费（也称后付费）。
configureNodes GetInstanceConfigureNode[]: 设置节点所属的可用区列表。
createBackup boolean: 是否在变更前创建备份。
createTime string: 实例的创建时间。
dataLayout string: 实例的数据存储形态。该参数仅对企业版（即ServiceType为Enterprise）实例有意义；社区版（即ServiceType为Basic）实例不涉及数据存储形态，DataLayout取值固定为RAM。若该参数留空，表示不使用数据存储形态进行筛选。
deletionProtection string: 开启或关闭实例删除保护功能。
engineVersion string: 数据库版本号。
expiredTime string: 实例到期时间。
id string: Uniquely identifies the resource.
instanceClass string: Redis 实例的类型。取值范围如下：PrimarySecondary：主备实例；Standalone：单节点实例。若该参数留空，表示不使用实例类型条件进行筛选。关于实例类型的更多信息，请参见产品架构。
instanceId string: 实例 ID。
instanceName string: 实例名称。命名规则：不能以数字、中划线（-）开头；只能包含中文、字母、数字、下划线（_）和中划线（-）；长度需要在1~128个字符内。
instanceShards GetInstanceInstanceShard[]: 实例中所有 Shard 分片的详情列表。
maintenanceTime string: 实例的可维护时间段，格式为HH:mm-HH:mm（UTC+8）。
maxConnections number: 实例当前单分片最大连接数。每分片的默认连接数为10000，您也可以根据业务需要调用ModifyDBInstanceMaxConn接口修改单分片的最大连接数。
multiAz string: 设置实例的可用区部署方案。
noAuthMode string: 为新建实例开启或关闭免密访问功能。取值范围如下：open：开启免密访问。close（默认值）：关闭免密访问。
nodeIds string[]: Proxy 和 Server 节点 ID 列表。
nodeNumber number: 每个分片中的节点数。取值范围为1~6。每个账号在每个地域下默认最多可创建4个256MiB规格的节点，若需要调整配额上限为10个，请参见账号配额。取值为1时表示创建单节点实例；取值大于1时表示创建主备实例。关于两种类型实例的功能特性差异详情，请参见功能特性差异。
parameterGroupId string: 需要应用到新实例的参数模板。缓存数据库 Redis 版为每个数据库版本都创建了一份默认的系统参数模板，模板中包含了该版本支持设置的所有参数和默认参数值。若该参数留空，默认会根据您设置的数据库版本（即 EngineVersion）为新建实例选择并应用对应版本的系统参数模板。您可以调用 DescribeParameterGroups 接口查询当前账号和地域下的所有参数模板的基本信息，包括参数模板 ID。
password string: 设置默认数据库 default 账号的密码。
port number: 自定义私网连接地址的端口号。取值范围：1024~65535。若该参数留空，私网连接地址默认使用6379端口。实例创建成功后，还可以修改私网地址的端口号，修改方法请参见修改端口号。
privateAddress string: 实例私网连接地址的域名。
projectName string: 实例所属的项目。
purchaseMonths number: 购买时长，单位：月。取值范围如下：按月购买：1，2，3，4，5，6，7，8，9。按年购买：12，24，36。当ChargeType为PrePaid时，该参数必填。
reserveAdditionalBandwidth boolean: 设置是否保留额外带宽
serviceType string: 实例的服务类型
shardCapacity number: 实例中每个分片的内存容量。单位：MiB。
shardNumber number: 实例中的分片数量。取值范围为 2~256。仅当 ShardedCluster 取值为 1（即启用分片集群）时，需要指定该参数。
shardedCluster number: 是否启用分片集群。取值范围如下：0：不启用。1：启用。
status string: 实例的服务类型，取值范围如下：Basic（默认值）：社区版；Enterprise：企业版。
subnetId string: 设置实例的子网ID。子网具有可用区属性，必须选择目标私有网络中与实例属于同一可用区下的子网。子网是私有网络内的IP地址块私有网络中的所有云资源都必须部署在子网内，子网为云资源分配私网IP地址，您可以调用CreateSubnet接口创建子网。您可以调用DescribeSubnets接口查询指定可用区内的所有子网列表信息，包括子网ID。
tags GetInstanceTag[]: 设置实例的标签列表。
viPv6 string: 实例私网连接地址所对应的 IPv6 地址。仅当实例使用了 IPv6 地址时才会返回该参数。
vip string: 实例私网连接地址所对应的 IPv4 地址。
visitAddrs GetInstanceVisitAddr[]: 连接地址信息。
vpcAuthMode string: 开启或关闭免密访问功能。取值范围如下：open：开启免密访问；close：关闭免密访问。参数取值不区分大小写。
vpcId string: 设置实例的私有网络ID。建议Redis实例与需要连接的ECS实例在同一私有网络，否则它们无法通过内网互通来实现最佳性能。您可以调用CreateVpc接口创建私有网络。您可以调用DescribeVpcs接口查询符合指定条件的私有网络信息，包括私有网络ID。
zoneIds string[]: 实例所在的可用区列表。

allow_list_ids Sequence[str]: 白名单 ID 列表。若该参数留空，新建实例默认不加入任何白名单。您可以调用 DescribeAllowLists 接口查询当前账号下指定地域内的所有 IP 白名单信息，包括白名单 ID 信息。每个实例最多支持绑定 100 个白名单，每次可最多批量绑定 100 个白名单。每个实例最多支持绑定 1000 个 IP 地址或 CIDR 格式的 IP 地址段。
auto_renew bool: 是否开启自动续费。取值范围如下：false（默认值）：不开启。true：开启。
backup_point_name str: 为变更前创建的全量备份设置备份名称。
capacity GetInstanceCapacity: 实例的容量信息。
charge_type str: 实例计费类型。取值范围如下：PrePaid：包年包月（也称预付费）。PostPaid：按量计费（也称后付费）。
configure_nodes Sequence[GetInstanceConfigureNode]: 设置节点所属的可用区列表。
create_backup bool: 是否在变更前创建备份。
create_time str: 实例的创建时间。
data_layout str: 实例的数据存储形态。该参数仅对企业版（即ServiceType为Enterprise）实例有意义；社区版（即ServiceType为Basic）实例不涉及数据存储形态，DataLayout取值固定为RAM。若该参数留空，表示不使用数据存储形态进行筛选。
deletion_protection str: 开启或关闭实例删除保护功能。
engine_version str: 数据库版本号。
expired_time str: 实例到期时间。
id str: Uniquely identifies the resource.
instance_class str: Redis 实例的类型。取值范围如下：PrimarySecondary：主备实例；Standalone：单节点实例。若该参数留空，表示不使用实例类型条件进行筛选。关于实例类型的更多信息，请参见产品架构。
instance_id str: 实例 ID。
instance_name str: 实例名称。命名规则：不能以数字、中划线（-）开头；只能包含中文、字母、数字、下划线（_）和中划线（-）；长度需要在1~128个字符内。
instance_shards Sequence[GetInstanceInstanceShard]: 实例中所有 Shard 分片的详情列表。
maintenance_time str: 实例的可维护时间段，格式为HH:mm-HH:mm（UTC+8）。
max_connections int: 实例当前单分片最大连接数。每分片的默认连接数为10000，您也可以根据业务需要调用ModifyDBInstanceMaxConn接口修改单分片的最大连接数。
multi_az str: 设置实例的可用区部署方案。
no_auth_mode str: 为新建实例开启或关闭免密访问功能。取值范围如下：open：开启免密访问。close（默认值）：关闭免密访问。
node_ids Sequence[str]: Proxy 和 Server 节点 ID 列表。
node_number int: 每个分片中的节点数。取值范围为1~6。每个账号在每个地域下默认最多可创建4个256MiB规格的节点，若需要调整配额上限为10个，请参见账号配额。取值为1时表示创建单节点实例；取值大于1时表示创建主备实例。关于两种类型实例的功能特性差异详情，请参见功能特性差异。
parameter_group_id str: 需要应用到新实例的参数模板。缓存数据库 Redis 版为每个数据库版本都创建了一份默认的系统参数模板，模板中包含了该版本支持设置的所有参数和默认参数值。若该参数留空，默认会根据您设置的数据库版本（即 EngineVersion）为新建实例选择并应用对应版本的系统参数模板。您可以调用 DescribeParameterGroups 接口查询当前账号和地域下的所有参数模板的基本信息，包括参数模板 ID。
password str: 设置默认数据库 default 账号的密码。
port int: 自定义私网连接地址的端口号。取值范围：1024~65535。若该参数留空，私网连接地址默认使用6379端口。实例创建成功后，还可以修改私网地址的端口号，修改方法请参见修改端口号。
private_address str: 实例私网连接地址的域名。
project_name str: 实例所属的项目。
purchase_months int: 购买时长，单位：月。取值范围如下：按月购买：1，2，3，4，5，6，7，8，9。按年购买：12，24，36。当ChargeType为PrePaid时，该参数必填。
reserve_additional_bandwidth bool: 设置是否保留额外带宽
service_type str: 实例的服务类型
shard_capacity int: 实例中每个分片的内存容量。单位：MiB。
shard_number int: 实例中的分片数量。取值范围为 2~256。仅当 ShardedCluster 取值为 1（即启用分片集群）时，需要指定该参数。
sharded_cluster int: 是否启用分片集群。取值范围如下：0：不启用。1：启用。
status str: 实例的服务类型，取值范围如下：Basic（默认值）：社区版；Enterprise：企业版。
subnet_id str: 设置实例的子网ID。子网具有可用区属性，必须选择目标私有网络中与实例属于同一可用区下的子网。子网是私有网络内的IP地址块私有网络中的所有云资源都必须部署在子网内，子网为云资源分配私网IP地址，您可以调用CreateSubnet接口创建子网。您可以调用DescribeSubnets接口查询指定可用区内的所有子网列表信息，包括子网ID。
tags Sequence[GetInstanceTag]: 设置实例的标签列表。
vi_pv6 str: 实例私网连接地址所对应的 IPv6 地址。仅当实例使用了 IPv6 地址时才会返回该参数。
vip str: 实例私网连接地址所对应的 IPv4 地址。
visit_addrs Sequence[GetInstanceVisitAddr]: 连接地址信息。
vpc_auth_mode str: 开启或关闭免密访问功能。取值范围如下：open：开启免密访问；close：关闭免密访问。参数取值不区分大小写。
vpc_id str: 设置实例的私有网络ID。建议Redis实例与需要连接的ECS实例在同一私有网络，否则它们无法通过内网互通来实现最佳性能。您可以调用CreateVpc接口创建私有网络。您可以调用DescribeVpcs接口查询符合指定条件的私有网络信息，包括私有网络ID。
zone_ids Sequence[str]: 实例所在的可用区列表。

allowListIds List<String>: 白名单 ID 列表。若该参数留空，新建实例默认不加入任何白名单。您可以调用 DescribeAllowLists 接口查询当前账号下指定地域内的所有 IP 白名单信息，包括白名单 ID 信息。每个实例最多支持绑定 100 个白名单，每次可最多批量绑定 100 个白名单。每个实例最多支持绑定 1000 个 IP 地址或 CIDR 格式的 IP 地址段。
autoRenew Boolean: 是否开启自动续费。取值范围如下：false（默认值）：不开启。true：开启。
backupPointName String: 为变更前创建的全量备份设置备份名称。
capacity Property Map: 实例的容量信息。
chargeType String: 实例计费类型。取值范围如下：PrePaid：包年包月（也称预付费）。PostPaid：按量计费（也称后付费）。
configureNodes List<Property Map>: 设置节点所属的可用区列表。
createBackup Boolean: 是否在变更前创建备份。
createTime String: 实例的创建时间。
dataLayout String: 实例的数据存储形态。该参数仅对企业版（即ServiceType为Enterprise）实例有意义；社区版（即ServiceType为Basic）实例不涉及数据存储形态，DataLayout取值固定为RAM。若该参数留空，表示不使用数据存储形态进行筛选。
deletionProtection String: 开启或关闭实例删除保护功能。
engineVersion String: 数据库版本号。
expiredTime String: 实例到期时间。
id String: Uniquely identifies the resource.
instanceClass String: Redis 实例的类型。取值范围如下：PrimarySecondary：主备实例；Standalone：单节点实例。若该参数留空，表示不使用实例类型条件进行筛选。关于实例类型的更多信息，请参见产品架构。
instanceId String: 实例 ID。
instanceName String: 实例名称。命名规则：不能以数字、中划线（-）开头；只能包含中文、字母、数字、下划线（_）和中划线（-）；长度需要在1~128个字符内。
instanceShards List<Property Map>: 实例中所有 Shard 分片的详情列表。
maintenanceTime String: 实例的可维护时间段，格式为HH:mm-HH:mm（UTC+8）。
maxConnections Number: 实例当前单分片最大连接数。每分片的默认连接数为10000，您也可以根据业务需要调用ModifyDBInstanceMaxConn接口修改单分片的最大连接数。
multiAz String: 设置实例的可用区部署方案。
noAuthMode String: 为新建实例开启或关闭免密访问功能。取值范围如下：open：开启免密访问。close（默认值）：关闭免密访问。
nodeIds List<String>: Proxy 和 Server 节点 ID 列表。
nodeNumber Number: 每个分片中的节点数。取值范围为1~6。每个账号在每个地域下默认最多可创建4个256MiB规格的节点，若需要调整配额上限为10个，请参见账号配额。取值为1时表示创建单节点实例；取值大于1时表示创建主备实例。关于两种类型实例的功能特性差异详情，请参见功能特性差异。
parameterGroupId String: 需要应用到新实例的参数模板。缓存数据库 Redis 版为每个数据库版本都创建了一份默认的系统参数模板，模板中包含了该版本支持设置的所有参数和默认参数值。若该参数留空，默认会根据您设置的数据库版本（即 EngineVersion）为新建实例选择并应用对应版本的系统参数模板。您可以调用 DescribeParameterGroups 接口查询当前账号和地域下的所有参数模板的基本信息，包括参数模板 ID。
password String: 设置默认数据库 default 账号的密码。
port Number: 自定义私网连接地址的端口号。取值范围：1024~65535。若该参数留空，私网连接地址默认使用6379端口。实例创建成功后，还可以修改私网地址的端口号，修改方法请参见修改端口号。
privateAddress String: 实例私网连接地址的域名。
projectName String: 实例所属的项目。
purchaseMonths Number: 购买时长，单位：月。取值范围如下：按月购买：1，2，3，4，5，6，7，8，9。按年购买：12，24，36。当ChargeType为PrePaid时，该参数必填。
reserveAdditionalBandwidth Boolean: 设置是否保留额外带宽
serviceType String: 实例的服务类型
shardCapacity Number: 实例中每个分片的内存容量。单位：MiB。
shardNumber Number: 实例中的分片数量。取值范围为 2~256。仅当 ShardedCluster 取值为 1（即启用分片集群）时，需要指定该参数。
shardedCluster Number: 是否启用分片集群。取值范围如下：0：不启用。1：启用。
status String: 实例的服务类型，取值范围如下：Basic（默认值）：社区版；Enterprise：企业版。
subnetId String: 设置实例的子网ID。子网具有可用区属性，必须选择目标私有网络中与实例属于同一可用区下的子网。子网是私有网络内的IP地址块私有网络中的所有云资源都必须部署在子网内，子网为云资源分配私网IP地址，您可以调用CreateSubnet接口创建子网。您可以调用DescribeSubnets接口查询指定可用区内的所有子网列表信息，包括子网ID。
tags List<Property Map>: 设置实例的标签列表。
viPv6 String: 实例私网连接地址所对应的 IPv6 地址。仅当实例使用了 IPv6 地址时才会返回该参数。
vip String: 实例私网连接地址所对应的 IPv4 地址。
visitAddrs List<Property Map>: 连接地址信息。
vpcAuthMode String: 开启或关闭免密访问功能。取值范围如下：open：开启免密访问；close：关闭免密访问。参数取值不区分大小写。
vpcId String: 设置实例的私有网络ID。建议Redis实例与需要连接的ECS实例在同一私有网络，否则它们无法通过内网互通来实现最佳性能。您可以调用CreateVpc接口创建私有网络。您可以调用DescribeVpcs接口查询符合指定条件的私有网络信息，包括私有网络ID。
zoneIds List<String>: 实例所在的可用区列表。

Supporting Types

GetInstanceCapacity

Total int: 当前实例的内存总容量。单位：MiB。
Used int: 当前实例已用容量。单位：MiB。

Total int: 当前实例的内存总容量。单位：MiB。
Used int: 当前实例已用容量。单位：MiB。

total Integer: 当前实例的内存总容量。单位：MiB。
used Integer: 当前实例已用容量。单位：MiB。

total number: 当前实例的内存总容量。单位：MiB。
used number: 当前实例已用容量。单位：MiB。

total int: 当前实例的内存总容量。单位：MiB。
used int: 当前实例已用容量。单位：MiB。

total Number: 当前实例的内存总容量。单位：MiB。
used Number: 当前实例已用容量。单位：MiB。

GetInstanceConfigureNode

Az string: 每个节点所属的可用区。

Az string: 每个节点所属的可用区。

az String: 每个节点所属的可用区。

az string: 每个节点所属的可用区。

az str: 每个节点所属的可用区。

az String: 每个节点所属的可用区。

GetInstanceInstanceShard

NodeNumber int: 分片中的节点数量
ServerNodes List<Volcengine.GetInstanceInstanceShardServerNode>: 分片中所有 Server 节点的详情列表。
ShardId string: 分片 ID。

NodeNumber int: 分片中的节点数量
ServerNodes []GetInstanceInstanceShardServerNode: 分片中所有 Server 节点的详情列表。
ShardId string: 分片 ID。

nodeNumber Integer: 分片中的节点数量
serverNodes List<GetInstanceInstanceShardServerNode>: 分片中所有 Server 节点的详情列表。
shardId String: 分片 ID。

nodeNumber number: 分片中的节点数量
serverNodes GetInstanceInstanceShardServerNode[]: 分片中所有 Server 节点的详情列表。
shardId string: 分片 ID。

node_number int: 分片中的节点数量
server_nodes Sequence[GetInstanceInstanceShardServerNode]: 分片中所有 Server 节点的详情列表。
shard_id str: 分片 ID。

nodeNumber Number: 分片中的节点数量
serverNodes List<Property Map>: 分片中所有 Server 节点的详情列表。
shardId String: 分片 ID。

GetInstanceInstanceShardServerNode

CurrentRole string: 节点当前的角色。取值范围如下：PrimaryNode：主节点。SecondaryNode：从节点。
NodeId string: 节点 ID。
Status string: 节点状态。取值范围如下：deploy：启动中。running：运行中。loading：数据加载中。error：错误。
ZoneId string: 节点所在的可用区。

CurrentRole string: 节点当前的角色。取值范围如下：PrimaryNode：主节点。SecondaryNode：从节点。
NodeId string: 节点 ID。
Status string: 节点状态。取值范围如下：deploy：启动中。running：运行中。loading：数据加载中。error：错误。
ZoneId string: 节点所在的可用区。

currentRole String: 节点当前的角色。取值范围如下：PrimaryNode：主节点。SecondaryNode：从节点。
nodeId String: 节点 ID。
status String: 节点状态。取值范围如下：deploy：启动中。running：运行中。loading：数据加载中。error：错误。
zoneId String: 节点所在的可用区。

currentRole string: 节点当前的角色。取值范围如下：PrimaryNode：主节点。SecondaryNode：从节点。
nodeId string: 节点 ID。
status string: 节点状态。取值范围如下：deploy：启动中。running：运行中。loading：数据加载中。error：错误。
zoneId string: 节点所在的可用区。

current_role str: 节点当前的角色。取值范围如下：PrimaryNode：主节点。SecondaryNode：从节点。
node_id str: 节点 ID。
status str: 节点状态。取值范围如下：deploy：启动中。running：运行中。loading：数据加载中。error：错误。
zone_id str: 节点所在的可用区。

currentRole String: 节点当前的角色。取值范围如下：PrimaryNode：主节点。SecondaryNode：从节点。
nodeId String: 节点 ID。
status String: 节点状态。取值范围如下：deploy：启动中。running：运行中。loading：数据加载中。error：错误。
zoneId String: 节点所在的可用区。

GetInstanceTag

Key string: 标签键。
Value string: 标签值。

Key string: 标签键。
Value string: 标签值。

key String: 标签键。
value String: 标签值。

key string: 标签键。
value string: 标签值。

key str: 标签键。
value str: 标签值。

key String: 标签键。
value String: 标签值。

GetInstanceVisitAddr

AddrType string: 连接地址类型，取值范围如下：Private：私网连接地址；Public：公网连接地址；DirectLink：直连地址。
Address string: IP 地址或者域名。
EipId string: 实例公网地址所绑定的EIP ID。仅当连接地址类型（即AddrType）为Public公网连接地址时，返回该参数。
Port string: 端口号。
ViPv6 string: 连接地址所对应的 IPv6 地址。
Vip string: 连接地址所对应的 IPv4 地址。

AddrType string: 连接地址类型，取值范围如下：Private：私网连接地址；Public：公网连接地址；DirectLink：直连地址。
Address string: IP 地址或者域名。
EipId string: 实例公网地址所绑定的EIP ID。仅当连接地址类型（即AddrType）为Public公网连接地址时，返回该参数。
Port string: 端口号。
ViPv6 string: 连接地址所对应的 IPv6 地址。
Vip string: 连接地址所对应的 IPv4 地址。

addrType String: 连接地址类型，取值范围如下：Private：私网连接地址；Public：公网连接地址；DirectLink：直连地址。
address String: IP 地址或者域名。
eipId String: 实例公网地址所绑定的EIP ID。仅当连接地址类型（即AddrType）为Public公网连接地址时，返回该参数。
port String: 端口号。
viPv6 String: 连接地址所对应的 IPv6 地址。
vip String: 连接地址所对应的 IPv4 地址。

addrType string: 连接地址类型，取值范围如下：Private：私网连接地址；Public：公网连接地址；DirectLink：直连地址。
address string: IP 地址或者域名。
eipId string: 实例公网地址所绑定的EIP ID。仅当连接地址类型（即AddrType）为Public公网连接地址时，返回该参数。
port string: 端口号。
viPv6 string: 连接地址所对应的 IPv6 地址。
vip string: 连接地址所对应的 IPv4 地址。

addr_type str: 连接地址类型，取值范围如下：Private：私网连接地址；Public：公网连接地址；DirectLink：直连地址。
address str: IP 地址或者域名。
eip_id str: 实例公网地址所绑定的EIP ID。仅当连接地址类型（即AddrType）为Public公网连接地址时，返回该参数。
port str: 端口号。
vi_pv6 str: 连接地址所对应的 IPv6 地址。
vip str: 连接地址所对应的 IPv4 地址。

addrType String: 连接地址类型，取值范围如下：Private：私网连接地址；Public：公网连接地址；DirectLink：直连地址。
address String: IP 地址或者域名。
eipId String: 实例公网地址所绑定的EIP ID。仅当连接地址类型（即AddrType）为Public公网连接地址时，返回该参数。
port String: 端口号。
viPv6 String: 连接地址所对应的 IPv6 地址。
vip String: 连接地址所对应的 IPv4 地址。

Package Details

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

volcenginecc v0.0.4 published on Monday, Nov 3, 2025 by Volcengine

volcengine/pulumi-volcenginecc

volcenginecc.redis.getInstance

On this page

On this page

Using getInstance

getInstance Result

Supporting Types

GetInstanceCapacity

GetInstanceConfigureNode

GetInstanceInstanceShard

GetInstanceInstanceShardServerNode

GetInstanceTag

GetInstanceVisitAddr

Package Details

On this page

On this page