volcenginecc.redis.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: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>: Allowlist ID list. If left empty, the new instance will not be added to any allowlist by default. You can call the DescribeAllowLists API to query all IP allowlist information, including allowlist IDs, for the specified region under your account. Each instance supports binding up to 100 allowlists, and you can batch bind up to 100 allowlists at a time. Each instance supports binding up to 1000 IP addresses or CIDR-format IP address ranges.
AutoRenew bool: Whether to enable auto-renewal. Value options: false (default): Disabled; true: Enabled.
BackupPointName string: Set a backup name for the full backup created before changes.
BlueGreenRole string: Blue-green deployment role of the instance. Valid values: Blue: blue instance. Green: green instance. This parameter is returned only for Redis instances that have used the blue-green deployment feature.
Capacity Volcengine.GetInstanceCapacity: Capacity information of the instance.
ChargeType string: Instance billing type. Value options: PrePaid: Subscription (also called prepaid). PostPaid: Pay-as-you-go (also called postpaid).
ConfigureNodes List<Volcengine.GetInstanceConfigureNode>: Set the list of availability zones to which the node belongs.
CreateBackup bool: Whether to create a backup before making changes.
CreateTime string: Creation time of the instance.
DataLayout string: Data storage type of the instance. This parameter is only relevant for Enterprise Edition instances (ServiceType=Enterprise). Community Edition instances (ServiceType=Basic) do not involve data storage type, and DataLayout is always set to RAM. If this parameter is left empty, data storage type is not used as a filter.
DeletionProtection string: Enable or disable instance deletion protection.
EngineVersion string: Database version number.
ExpiredTime string: Instance expiration time.
Id string: Uniquely identifies the resource.
InstanceClass string: Type of Redis instance. Valid values: PrimarySecondary: primary-secondary instance; Standalone: single-node instance. If this parameter is left empty, instance type is not used as a filter. For more information about instance types, see Product Architecture.
InstanceId string: Instance ID.
InstanceName string: Instance name. Naming rules: Cannot start with a digit or hyphen (-); can only contain Chinese characters, letters, digits, underscores (_), and hyphens (-); length must be 1–128 characters.
InstanceShards List<Volcengine.GetInstanceInstanceShard>: Detailed list of all shards in the instance.
MaintenanceTime string: Maintenance window for the instance, format: HH:mm-HH:mm (UTC+8).
MaxConnections int: Current maximum connections per shard for the instance. The default connection limit per shard is 10,000. You can also call the ModifyDBInstanceMaxConn API to adjust the maximum connections per shard based on your business needs.
MultiAz string: Set the deployment scheme for the instance's availability zone.
NoAuthMode string: Enable or disable password-free access for new instances. Valid values: open: enable password-free access; close (default): disable password-free access.
NodeIds List<string>: List of Proxy and Server node IDs.
NodeNumber int: Number of nodes in each shard. Value range: 1–6. By default, each account can create up to 4 nodes of 256 MiB specification per region. To increase the quota limit to 10, see Account Quotas. A value of 1 creates a single-node instance; a value greater than 1 creates a primary-secondary instance. For details on the differences between these two types of instances, see Feature Differences.
ParameterGroupId string: The parameter template to be applied to the new instance. Redis for Cache Database creates a default system parameter template for each database version, which includes all parameters supported by that version and their default values. If this parameter is left blank, the system will select and apply the corresponding version's system parameter template for the new instance based on the database version you set (i.e., EngineVersion). You can call the DescribeParameterGroups API to query basic information about all parameter templates under your account and region, including the parameter template ID.
Password string: Set the password for the default account of the default database.
Port int: Custom port number for the private network connection address. Value range: 1024~65535. If this parameter is left blank, the private network connection address uses port 6379 by default. After the instance is created, you can also modify the port number of the private network address. For instructions, see Modify Port Number.
PrivateAddress string: The domain name for the instance's private network connection address.
PrivatePort string: Port number for the instance's private network connection address.
ProjectName string: Project to which the instance belongs.
PurchaseMonths int: Purchase duration, unit: month. Value options: Monthly purchase: 1, 2, 3, 4, 5, 6, 7, 8, 9. Annual purchase: 12, 24, 36. When ChargeType is PrePaid, this parameter is required.
ReserveAdditionalBandwidth bool: Set whether to reserve additional bandwidth
ServiceType string: Service type of the instance
ShardCapacity int: Memory capacity of each shard in the instance. Unit: MiB.
ShardNumber int: Number of shards in the instance. Value range: 2–256. Specify this parameter only when ShardedCluster is set to 1 (enabled).
ShardedCluster int: Whether to enable sharded cluster. Value options: 0: Disabled. 1: Enabled.
Status string: Service type of the instance. Value options: Basic (default): Community Edition; Enterprise: Enterprise Edition.
SubnetId string: Set the subnet ID for the instance. Subnets have availability zone attributes; you must select a subnet in the target private network that belongs to the same availability zone as the instance. A subnet is an IP address block within a private network. All cloud resources in the private network must be deployed in a subnet. The subnet assigns private IP addresses to cloud resources. You can call the CreateSubnet API to create a subnet. You can call the DescribeSubnets API to query the list of all subnets in a specified availability zone, including subnet IDs.
Tags List<Volcengine.GetInstanceTag>: Set the tag list for the instance.
ViPv6 string: The IPv6 address corresponding to the instance's private network connection address. This parameter is returned only if the instance uses an IPv6 address.
Vip string: IPv4 address corresponding to the instance's private network connection address.
VisitAddrs List<Volcengine.GetInstanceVisitAddr>: Connection address information.
VpcAuthMode string: Enable or disable password-free access. Valid values: open: enable password-free access; close: disable password-free access. Values are case-insensitive.
VpcId string: Set the private network ID for the instance. It is recommended that the Redis instance and the ECS instance you want to connect to are in the same private network; otherwise, they cannot communicate optimally via the internal network. You can call the CreateVpc API to create a private network. You can call the DescribeVpcs API to query private network information that meets specified conditions, including the private network ID.
ZoneIds List<string>: List of available zones where the instance is located.

AllowListIds []string: Allowlist ID list. If left empty, the new instance will not be added to any allowlist by default. You can call the DescribeAllowLists API to query all IP allowlist information, including allowlist IDs, for the specified region under your account. Each instance supports binding up to 100 allowlists, and you can batch bind up to 100 allowlists at a time. Each instance supports binding up to 1000 IP addresses or CIDR-format IP address ranges.
AutoRenew bool: Whether to enable auto-renewal. Value options: false (default): Disabled; true: Enabled.
BackupPointName string: Set a backup name for the full backup created before changes.
BlueGreenRole string: Blue-green deployment role of the instance. Valid values: Blue: blue instance. Green: green instance. This parameter is returned only for Redis instances that have used the blue-green deployment feature.
Capacity GetInstanceCapacity: Capacity information of the instance.
ChargeType string: Instance billing type. Value options: PrePaid: Subscription (also called prepaid). PostPaid: Pay-as-you-go (also called postpaid).
ConfigureNodes []GetInstanceConfigureNode: Set the list of availability zones to which the node belongs.
CreateBackup bool: Whether to create a backup before making changes.
CreateTime string: Creation time of the instance.
DataLayout string: Data storage type of the instance. This parameter is only relevant for Enterprise Edition instances (ServiceType=Enterprise). Community Edition instances (ServiceType=Basic) do not involve data storage type, and DataLayout is always set to RAM. If this parameter is left empty, data storage type is not used as a filter.
DeletionProtection string: Enable or disable instance deletion protection.
EngineVersion string: Database version number.
ExpiredTime string: Instance expiration time.
Id string: Uniquely identifies the resource.
InstanceClass string: Type of Redis instance. Valid values: PrimarySecondary: primary-secondary instance; Standalone: single-node instance. If this parameter is left empty, instance type is not used as a filter. For more information about instance types, see Product Architecture.
InstanceId string: Instance ID.
InstanceName string: Instance name. Naming rules: Cannot start with a digit or hyphen (-); can only contain Chinese characters, letters, digits, underscores (_), and hyphens (-); length must be 1–128 characters.
InstanceShards []GetInstanceInstanceShard: Detailed list of all shards in the instance.
MaintenanceTime string: Maintenance window for the instance, format: HH:mm-HH:mm (UTC+8).
MaxConnections int: Current maximum connections per shard for the instance. The default connection limit per shard is 10,000. You can also call the ModifyDBInstanceMaxConn API to adjust the maximum connections per shard based on your business needs.
MultiAz string: Set the deployment scheme for the instance's availability zone.
NoAuthMode string: Enable or disable password-free access for new instances. Valid values: open: enable password-free access; close (default): disable password-free access.
NodeIds []string: List of Proxy and Server node IDs.
NodeNumber int: Number of nodes in each shard. Value range: 1–6. By default, each account can create up to 4 nodes of 256 MiB specification per region. To increase the quota limit to 10, see Account Quotas. A value of 1 creates a single-node instance; a value greater than 1 creates a primary-secondary instance. For details on the differences between these two types of instances, see Feature Differences.
ParameterGroupId string: The parameter template to be applied to the new instance. Redis for Cache Database creates a default system parameter template for each database version, which includes all parameters supported by that version and their default values. If this parameter is left blank, the system will select and apply the corresponding version's system parameter template for the new instance based on the database version you set (i.e., EngineVersion). You can call the DescribeParameterGroups API to query basic information about all parameter templates under your account and region, including the parameter template ID.
Password string: Set the password for the default account of the default database.
Port int: Custom port number for the private network connection address. Value range: 1024~65535. If this parameter is left blank, the private network connection address uses port 6379 by default. After the instance is created, you can also modify the port number of the private network address. For instructions, see Modify Port Number.
PrivateAddress string: The domain name for the instance's private network connection address.
PrivatePort string: Port number for the instance's private network connection address.
ProjectName string: Project to which the instance belongs.
PurchaseMonths int: Purchase duration, unit: month. Value options: Monthly purchase: 1, 2, 3, 4, 5, 6, 7, 8, 9. Annual purchase: 12, 24, 36. When ChargeType is PrePaid, this parameter is required.
ReserveAdditionalBandwidth bool: Set whether to reserve additional bandwidth
ServiceType string: Service type of the instance
ShardCapacity int: Memory capacity of each shard in the instance. Unit: MiB.
ShardNumber int: Number of shards in the instance. Value range: 2–256. Specify this parameter only when ShardedCluster is set to 1 (enabled).
ShardedCluster int: Whether to enable sharded cluster. Value options: 0: Disabled. 1: Enabled.
Status string: Service type of the instance. Value options: Basic (default): Community Edition; Enterprise: Enterprise Edition.
SubnetId string: Set the subnet ID for the instance. Subnets have availability zone attributes; you must select a subnet in the target private network that belongs to the same availability zone as the instance. A subnet is an IP address block within a private network. All cloud resources in the private network must be deployed in a subnet. The subnet assigns private IP addresses to cloud resources. You can call the CreateSubnet API to create a subnet. You can call the DescribeSubnets API to query the list of all subnets in a specified availability zone, including subnet IDs.
Tags []GetInstanceTag: Set the tag list for the instance.
ViPv6 string: The IPv6 address corresponding to the instance's private network connection address. This parameter is returned only if the instance uses an IPv6 address.
Vip string: IPv4 address corresponding to the instance's private network connection address.
VisitAddrs []GetInstanceVisitAddr: Connection address information.
VpcAuthMode string: Enable or disable password-free access. Valid values: open: enable password-free access; close: disable password-free access. Values are case-insensitive.
VpcId string: Set the private network ID for the instance. It is recommended that the Redis instance and the ECS instance you want to connect to are in the same private network; otherwise, they cannot communicate optimally via the internal network. You can call the CreateVpc API to create a private network. You can call the DescribeVpcs API to query private network information that meets specified conditions, including the private network ID.
ZoneIds []string: List of available zones where the instance is located.

allowListIds List<String>: Allowlist ID list. If left empty, the new instance will not be added to any allowlist by default. You can call the DescribeAllowLists API to query all IP allowlist information, including allowlist IDs, for the specified region under your account. Each instance supports binding up to 100 allowlists, and you can batch bind up to 100 allowlists at a time. Each instance supports binding up to 1000 IP addresses or CIDR-format IP address ranges.
autoRenew Boolean: Whether to enable auto-renewal. Value options: false (default): Disabled; true: Enabled.
backupPointName String: Set a backup name for the full backup created before changes.
blueGreenRole String: Blue-green deployment role of the instance. Valid values: Blue: blue instance. Green: green instance. This parameter is returned only for Redis instances that have used the blue-green deployment feature.
capacity GetInstanceCapacity: Capacity information of the instance.
chargeType String: Instance billing type. Value options: PrePaid: Subscription (also called prepaid). PostPaid: Pay-as-you-go (also called postpaid).
configureNodes List<GetInstanceConfigureNode>: Set the list of availability zones to which the node belongs.
createBackup Boolean: Whether to create a backup before making changes.
createTime String: Creation time of the instance.
dataLayout String: Data storage type of the instance. This parameter is only relevant for Enterprise Edition instances (ServiceType=Enterprise). Community Edition instances (ServiceType=Basic) do not involve data storage type, and DataLayout is always set to RAM. If this parameter is left empty, data storage type is not used as a filter.
deletionProtection String: Enable or disable instance deletion protection.
engineVersion String: Database version number.
expiredTime String: Instance expiration time.
id String: Uniquely identifies the resource.
instanceClass String: Type of Redis instance. Valid values: PrimarySecondary: primary-secondary instance; Standalone: single-node instance. If this parameter is left empty, instance type is not used as a filter. For more information about instance types, see Product Architecture.
instanceId String: Instance ID.
instanceName String: Instance name. Naming rules: Cannot start with a digit or hyphen (-); can only contain Chinese characters, letters, digits, underscores (_), and hyphens (-); length must be 1–128 characters.
instanceShards List<GetInstanceInstanceShard>: Detailed list of all shards in the instance.
maintenanceTime String: Maintenance window for the instance, format: HH:mm-HH:mm (UTC+8).
maxConnections Integer: Current maximum connections per shard for the instance. The default connection limit per shard is 10,000. You can also call the ModifyDBInstanceMaxConn API to adjust the maximum connections per shard based on your business needs.
multiAz String: Set the deployment scheme for the instance's availability zone.
noAuthMode String: Enable or disable password-free access for new instances. Valid values: open: enable password-free access; close (default): disable password-free access.
nodeIds List<String>: List of Proxy and Server node IDs.
nodeNumber Integer: Number of nodes in each shard. Value range: 1–6. By default, each account can create up to 4 nodes of 256 MiB specification per region. To increase the quota limit to 10, see Account Quotas. A value of 1 creates a single-node instance; a value greater than 1 creates a primary-secondary instance. For details on the differences between these two types of instances, see Feature Differences.
parameterGroupId String: The parameter template to be applied to the new instance. Redis for Cache Database creates a default system parameter template for each database version, which includes all parameters supported by that version and their default values. If this parameter is left blank, the system will select and apply the corresponding version's system parameter template for the new instance based on the database version you set (i.e., EngineVersion). You can call the DescribeParameterGroups API to query basic information about all parameter templates under your account and region, including the parameter template ID.
password String: Set the password for the default account of the default database.
port Integer: Custom port number for the private network connection address. Value range: 1024~65535. If this parameter is left blank, the private network connection address uses port 6379 by default. After the instance is created, you can also modify the port number of the private network address. For instructions, see Modify Port Number.
privateAddress String: The domain name for the instance's private network connection address.
privatePort String: Port number for the instance's private network connection address.
projectName String: Project to which the instance belongs.
purchaseMonths Integer: Purchase duration, unit: month. Value options: Monthly purchase: 1, 2, 3, 4, 5, 6, 7, 8, 9. Annual purchase: 12, 24, 36. When ChargeType is PrePaid, this parameter is required.
reserveAdditionalBandwidth Boolean: Set whether to reserve additional bandwidth
serviceType String: Service type of the instance
shardCapacity Integer: Memory capacity of each shard in the instance. Unit: MiB.
shardNumber Integer: Number of shards in the instance. Value range: 2–256. Specify this parameter only when ShardedCluster is set to 1 (enabled).
shardedCluster Integer: Whether to enable sharded cluster. Value options: 0: Disabled. 1: Enabled.
status String: Service type of the instance. Value options: Basic (default): Community Edition; Enterprise: Enterprise Edition.
subnetId String: Set the subnet ID for the instance. Subnets have availability zone attributes; you must select a subnet in the target private network that belongs to the same availability zone as the instance. A subnet is an IP address block within a private network. All cloud resources in the private network must be deployed in a subnet. The subnet assigns private IP addresses to cloud resources. You can call the CreateSubnet API to create a subnet. You can call the DescribeSubnets API to query the list of all subnets in a specified availability zone, including subnet IDs.
tags List<GetInstanceTag>: Set the tag list for the instance.
viPv6 String: The IPv6 address corresponding to the instance's private network connection address. This parameter is returned only if the instance uses an IPv6 address.
vip String: IPv4 address corresponding to the instance's private network connection address.
visitAddrs List<GetInstanceVisitAddr>: Connection address information.
vpcAuthMode String: Enable or disable password-free access. Valid values: open: enable password-free access; close: disable password-free access. Values are case-insensitive.
vpcId String: Set the private network ID for the instance. It is recommended that the Redis instance and the ECS instance you want to connect to are in the same private network; otherwise, they cannot communicate optimally via the internal network. You can call the CreateVpc API to create a private network. You can call the DescribeVpcs API to query private network information that meets specified conditions, including the private network ID.
zoneIds List<String>: List of available zones where the instance is located.

allowListIds string[]: Allowlist ID list. If left empty, the new instance will not be added to any allowlist by default. You can call the DescribeAllowLists API to query all IP allowlist information, including allowlist IDs, for the specified region under your account. Each instance supports binding up to 100 allowlists, and you can batch bind up to 100 allowlists at a time. Each instance supports binding up to 1000 IP addresses or CIDR-format IP address ranges.
autoRenew boolean: Whether to enable auto-renewal. Value options: false (default): Disabled; true: Enabled.
backupPointName string: Set a backup name for the full backup created before changes.
blueGreenRole string: Blue-green deployment role of the instance. Valid values: Blue: blue instance. Green: green instance. This parameter is returned only for Redis instances that have used the blue-green deployment feature.
capacity GetInstanceCapacity: Capacity information of the instance.
chargeType string: Instance billing type. Value options: PrePaid: Subscription (also called prepaid). PostPaid: Pay-as-you-go (also called postpaid).
configureNodes GetInstanceConfigureNode[]: Set the list of availability zones to which the node belongs.
createBackup boolean: Whether to create a backup before making changes.
createTime string: Creation time of the instance.
dataLayout string: Data storage type of the instance. This parameter is only relevant for Enterprise Edition instances (ServiceType=Enterprise). Community Edition instances (ServiceType=Basic) do not involve data storage type, and DataLayout is always set to RAM. If this parameter is left empty, data storage type is not used as a filter.
deletionProtection string: Enable or disable instance deletion protection.
engineVersion string: Database version number.
expiredTime string: Instance expiration time.
id string: Uniquely identifies the resource.
instanceClass string: Type of Redis instance. Valid values: PrimarySecondary: primary-secondary instance; Standalone: single-node instance. If this parameter is left empty, instance type is not used as a filter. For more information about instance types, see Product Architecture.
instanceId string: Instance ID.
instanceName string: Instance name. Naming rules: Cannot start with a digit or hyphen (-); can only contain Chinese characters, letters, digits, underscores (_), and hyphens (-); length must be 1–128 characters.
instanceShards GetInstanceInstanceShard[]: Detailed list of all shards in the instance.
maintenanceTime string: Maintenance window for the instance, format: HH:mm-HH:mm (UTC+8).
maxConnections number: Current maximum connections per shard for the instance. The default connection limit per shard is 10,000. You can also call the ModifyDBInstanceMaxConn API to adjust the maximum connections per shard based on your business needs.
multiAz string: Set the deployment scheme for the instance's availability zone.
noAuthMode string: Enable or disable password-free access for new instances. Valid values: open: enable password-free access; close (default): disable password-free access.
nodeIds string[]: List of Proxy and Server node IDs.
nodeNumber number: Number of nodes in each shard. Value range: 1–6. By default, each account can create up to 4 nodes of 256 MiB specification per region. To increase the quota limit to 10, see Account Quotas. A value of 1 creates a single-node instance; a value greater than 1 creates a primary-secondary instance. For details on the differences between these two types of instances, see Feature Differences.
parameterGroupId string: The parameter template to be applied to the new instance. Redis for Cache Database creates a default system parameter template for each database version, which includes all parameters supported by that version and their default values. If this parameter is left blank, the system will select and apply the corresponding version's system parameter template for the new instance based on the database version you set (i.e., EngineVersion). You can call the DescribeParameterGroups API to query basic information about all parameter templates under your account and region, including the parameter template ID.
password string: Set the password for the default account of the default database.
port number: Custom port number for the private network connection address. Value range: 1024~65535. If this parameter is left blank, the private network connection address uses port 6379 by default. After the instance is created, you can also modify the port number of the private network address. For instructions, see Modify Port Number.
privateAddress string: The domain name for the instance's private network connection address.
privatePort string: Port number for the instance's private network connection address.
projectName string: Project to which the instance belongs.
purchaseMonths number: Purchase duration, unit: month. Value options: Monthly purchase: 1, 2, 3, 4, 5, 6, 7, 8, 9. Annual purchase: 12, 24, 36. When ChargeType is PrePaid, this parameter is required.
reserveAdditionalBandwidth boolean: Set whether to reserve additional bandwidth
serviceType string: Service type of the instance
shardCapacity number: Memory capacity of each shard in the instance. Unit: MiB.
shardNumber number: Number of shards in the instance. Value range: 2–256. Specify this parameter only when ShardedCluster is set to 1 (enabled).
shardedCluster number: Whether to enable sharded cluster. Value options: 0: Disabled. 1: Enabled.
status string: Service type of the instance. Value options: Basic (default): Community Edition; Enterprise: Enterprise Edition.
subnetId string: Set the subnet ID for the instance. Subnets have availability zone attributes; you must select a subnet in the target private network that belongs to the same availability zone as the instance. A subnet is an IP address block within a private network. All cloud resources in the private network must be deployed in a subnet. The subnet assigns private IP addresses to cloud resources. You can call the CreateSubnet API to create a subnet. You can call the DescribeSubnets API to query the list of all subnets in a specified availability zone, including subnet IDs.
tags GetInstanceTag[]: Set the tag list for the instance.
viPv6 string: The IPv6 address corresponding to the instance's private network connection address. This parameter is returned only if the instance uses an IPv6 address.
vip string: IPv4 address corresponding to the instance's private network connection address.
visitAddrs GetInstanceVisitAddr[]: Connection address information.
vpcAuthMode string: Enable or disable password-free access. Valid values: open: enable password-free access; close: disable password-free access. Values are case-insensitive.
vpcId string: Set the private network ID for the instance. It is recommended that the Redis instance and the ECS instance you want to connect to are in the same private network; otherwise, they cannot communicate optimally via the internal network. You can call the CreateVpc API to create a private network. You can call the DescribeVpcs API to query private network information that meets specified conditions, including the private network ID.
zoneIds string[]: List of available zones where the instance is located.

allow_list_ids Sequence[str]: Allowlist ID list. If left empty, the new instance will not be added to any allowlist by default. You can call the DescribeAllowLists API to query all IP allowlist information, including allowlist IDs, for the specified region under your account. Each instance supports binding up to 100 allowlists, and you can batch bind up to 100 allowlists at a time. Each instance supports binding up to 1000 IP addresses or CIDR-format IP address ranges.
auto_renew bool: Whether to enable auto-renewal. Value options: false (default): Disabled; true: Enabled.
backup_point_name str: Set a backup name for the full backup created before changes.
blue_green_role str: Blue-green deployment role of the instance. Valid values: Blue: blue instance. Green: green instance. This parameter is returned only for Redis instances that have used the blue-green deployment feature.
capacity GetInstanceCapacity: Capacity information of the instance.
charge_type str: Instance billing type. Value options: PrePaid: Subscription (also called prepaid). PostPaid: Pay-as-you-go (also called postpaid).
configure_nodes Sequence[GetInstanceConfigureNode]: Set the list of availability zones to which the node belongs.
create_backup bool: Whether to create a backup before making changes.
create_time str: Creation time of the instance.
data_layout str: Data storage type of the instance. This parameter is only relevant for Enterprise Edition instances (ServiceType=Enterprise). Community Edition instances (ServiceType=Basic) do not involve data storage type, and DataLayout is always set to RAM. If this parameter is left empty, data storage type is not used as a filter.
deletion_protection str: Enable or disable instance deletion protection.
engine_version str: Database version number.
expired_time str: Instance expiration time.
id str: Uniquely identifies the resource.
instance_class str: Type of Redis instance. Valid values: PrimarySecondary: primary-secondary instance; Standalone: single-node instance. If this parameter is left empty, instance type is not used as a filter. For more information about instance types, see Product Architecture.
instance_id str: Instance ID.
instance_name str: Instance name. Naming rules: Cannot start with a digit or hyphen (-); can only contain Chinese characters, letters, digits, underscores (_), and hyphens (-); length must be 1–128 characters.
instance_shards Sequence[GetInstanceInstanceShard]: Detailed list of all shards in the instance.
maintenance_time str: Maintenance window for the instance, format: HH:mm-HH:mm (UTC+8).
max_connections int: Current maximum connections per shard for the instance. The default connection limit per shard is 10,000. You can also call the ModifyDBInstanceMaxConn API to adjust the maximum connections per shard based on your business needs.
multi_az str: Set the deployment scheme for the instance's availability zone.
no_auth_mode str: Enable or disable password-free access for new instances. Valid values: open: enable password-free access; close (default): disable password-free access.
node_ids Sequence[str]: List of Proxy and Server node IDs.
node_number int: Number of nodes in each shard. Value range: 1–6. By default, each account can create up to 4 nodes of 256 MiB specification per region. To increase the quota limit to 10, see Account Quotas. A value of 1 creates a single-node instance; a value greater than 1 creates a primary-secondary instance. For details on the differences between these two types of instances, see Feature Differences.
parameter_group_id str: The parameter template to be applied to the new instance. Redis for Cache Database creates a default system parameter template for each database version, which includes all parameters supported by that version and their default values. If this parameter is left blank, the system will select and apply the corresponding version's system parameter template for the new instance based on the database version you set (i.e., EngineVersion). You can call the DescribeParameterGroups API to query basic information about all parameter templates under your account and region, including the parameter template ID.
password str: Set the password for the default account of the default database.
port int: Custom port number for the private network connection address. Value range: 1024~65535. If this parameter is left blank, the private network connection address uses port 6379 by default. After the instance is created, you can also modify the port number of the private network address. For instructions, see Modify Port Number.
private_address str: The domain name for the instance's private network connection address.
private_port str: Port number for the instance's private network connection address.
project_name str: Project to which the instance belongs.
purchase_months int: Purchase duration, unit: month. Value options: Monthly purchase: 1, 2, 3, 4, 5, 6, 7, 8, 9. Annual purchase: 12, 24, 36. When ChargeType is PrePaid, this parameter is required.
reserve_additional_bandwidth bool: Set whether to reserve additional bandwidth
service_type str: Service type of the instance
shard_capacity int: Memory capacity of each shard in the instance. Unit: MiB.
shard_number int: Number of shards in the instance. Value range: 2–256. Specify this parameter only when ShardedCluster is set to 1 (enabled).
sharded_cluster int: Whether to enable sharded cluster. Value options: 0: Disabled. 1: Enabled.
status str: Service type of the instance. Value options: Basic (default): Community Edition; Enterprise: Enterprise Edition.
subnet_id str: Set the subnet ID for the instance. Subnets have availability zone attributes; you must select a subnet in the target private network that belongs to the same availability zone as the instance. A subnet is an IP address block within a private network. All cloud resources in the private network must be deployed in a subnet. The subnet assigns private IP addresses to cloud resources. You can call the CreateSubnet API to create a subnet. You can call the DescribeSubnets API to query the list of all subnets in a specified availability zone, including subnet IDs.
tags Sequence[GetInstanceTag]: Set the tag list for the instance.
vi_pv6 str: The IPv6 address corresponding to the instance's private network connection address. This parameter is returned only if the instance uses an IPv6 address.
vip str: IPv4 address corresponding to the instance's private network connection address.
visit_addrs Sequence[GetInstanceVisitAddr]: Connection address information.
vpc_auth_mode str: Enable or disable password-free access. Valid values: open: enable password-free access; close: disable password-free access. Values are case-insensitive.
vpc_id str: Set the private network ID for the instance. It is recommended that the Redis instance and the ECS instance you want to connect to are in the same private network; otherwise, they cannot communicate optimally via the internal network. You can call the CreateVpc API to create a private network. You can call the DescribeVpcs API to query private network information that meets specified conditions, including the private network ID.
zone_ids Sequence[str]: List of available zones where the instance is located.

allowListIds List<String>: Allowlist ID list. If left empty, the new instance will not be added to any allowlist by default. You can call the DescribeAllowLists API to query all IP allowlist information, including allowlist IDs, for the specified region under your account. Each instance supports binding up to 100 allowlists, and you can batch bind up to 100 allowlists at a time. Each instance supports binding up to 1000 IP addresses or CIDR-format IP address ranges.
autoRenew Boolean: Whether to enable auto-renewal. Value options: false (default): Disabled; true: Enabled.
backupPointName String: Set a backup name for the full backup created before changes.
blueGreenRole String: Blue-green deployment role of the instance. Valid values: Blue: blue instance. Green: green instance. This parameter is returned only for Redis instances that have used the blue-green deployment feature.
capacity Property Map: Capacity information of the instance.
chargeType String: Instance billing type. Value options: PrePaid: Subscription (also called prepaid). PostPaid: Pay-as-you-go (also called postpaid).
configureNodes List<Property Map>: Set the list of availability zones to which the node belongs.
createBackup Boolean: Whether to create a backup before making changes.
createTime String: Creation time of the instance.
dataLayout String: Data storage type of the instance. This parameter is only relevant for Enterprise Edition instances (ServiceType=Enterprise). Community Edition instances (ServiceType=Basic) do not involve data storage type, and DataLayout is always set to RAM. If this parameter is left empty, data storage type is not used as a filter.
deletionProtection String: Enable or disable instance deletion protection.
engineVersion String: Database version number.
expiredTime String: Instance expiration time.
id String: Uniquely identifies the resource.
instanceClass String: Type of Redis instance. Valid values: PrimarySecondary: primary-secondary instance; Standalone: single-node instance. If this parameter is left empty, instance type is not used as a filter. For more information about instance types, see Product Architecture.
instanceId String: Instance ID.
instanceName String: Instance name. Naming rules: Cannot start with a digit or hyphen (-); can only contain Chinese characters, letters, digits, underscores (_), and hyphens (-); length must be 1–128 characters.
instanceShards List<Property Map>: Detailed list of all shards in the instance.
maintenanceTime String: Maintenance window for the instance, format: HH:mm-HH:mm (UTC+8).
maxConnections Number: Current maximum connections per shard for the instance. The default connection limit per shard is 10,000. You can also call the ModifyDBInstanceMaxConn API to adjust the maximum connections per shard based on your business needs.
multiAz String: Set the deployment scheme for the instance's availability zone.
noAuthMode String: Enable or disable password-free access for new instances. Valid values: open: enable password-free access; close (default): disable password-free access.
nodeIds List<String>: List of Proxy and Server node IDs.
nodeNumber Number: Number of nodes in each shard. Value range: 1–6. By default, each account can create up to 4 nodes of 256 MiB specification per region. To increase the quota limit to 10, see Account Quotas. A value of 1 creates a single-node instance; a value greater than 1 creates a primary-secondary instance. For details on the differences between these two types of instances, see Feature Differences.
parameterGroupId String: The parameter template to be applied to the new instance. Redis for Cache Database creates a default system parameter template for each database version, which includes all parameters supported by that version and their default values. If this parameter is left blank, the system will select and apply the corresponding version's system parameter template for the new instance based on the database version you set (i.e., EngineVersion). You can call the DescribeParameterGroups API to query basic information about all parameter templates under your account and region, including the parameter template ID.
password String: Set the password for the default account of the default database.
port Number: Custom port number for the private network connection address. Value range: 1024~65535. If this parameter is left blank, the private network connection address uses port 6379 by default. After the instance is created, you can also modify the port number of the private network address. For instructions, see Modify Port Number.
privateAddress String: The domain name for the instance's private network connection address.
privatePort String: Port number for the instance's private network connection address.
projectName String: Project to which the instance belongs.
purchaseMonths Number: Purchase duration, unit: month. Value options: Monthly purchase: 1, 2, 3, 4, 5, 6, 7, 8, 9. Annual purchase: 12, 24, 36. When ChargeType is PrePaid, this parameter is required.
reserveAdditionalBandwidth Boolean: Set whether to reserve additional bandwidth
serviceType String: Service type of the instance
shardCapacity Number: Memory capacity of each shard in the instance. Unit: MiB.
shardNumber Number: Number of shards in the instance. Value range: 2–256. Specify this parameter only when ShardedCluster is set to 1 (enabled).
shardedCluster Number: Whether to enable sharded cluster. Value options: 0: Disabled. 1: Enabled.
status String: Service type of the instance. Value options: Basic (default): Community Edition; Enterprise: Enterprise Edition.
subnetId String: Set the subnet ID for the instance. Subnets have availability zone attributes; you must select a subnet in the target private network that belongs to the same availability zone as the instance. A subnet is an IP address block within a private network. All cloud resources in the private network must be deployed in a subnet. The subnet assigns private IP addresses to cloud resources. You can call the CreateSubnet API to create a subnet. You can call the DescribeSubnets API to query the list of all subnets in a specified availability zone, including subnet IDs.
tags List<Property Map>: Set the tag list for the instance.
viPv6 String: The IPv6 address corresponding to the instance's private network connection address. This parameter is returned only if the instance uses an IPv6 address.
vip String: IPv4 address corresponding to the instance's private network connection address.
visitAddrs List<Property Map>: Connection address information.
vpcAuthMode String: Enable or disable password-free access. Valid values: open: enable password-free access; close: disable password-free access. Values are case-insensitive.
vpcId String: Set the private network ID for the instance. It is recommended that the Redis instance and the ECS instance you want to connect to are in the same private network; otherwise, they cannot communicate optimally via the internal network. You can call the CreateVpc API to create a private network. You can call the DescribeVpcs API to query private network information that meets specified conditions, including the private network ID.
zoneIds List<String>: List of available zones where the instance is located.

Supporting Types

GetInstanceCapacity

Total int: Total memory capacity of the current instance. Unit: MiB.
Used int: Used capacity of the current instance. Unit: MiB.

Total int: Total memory capacity of the current instance. Unit: MiB.
Used int: Used capacity of the current instance. Unit: MiB.

total Integer: Total memory capacity of the current instance. Unit: MiB.
used Integer: Used capacity of the current instance. Unit: MiB.

total number: Total memory capacity of the current instance. Unit: MiB.
used number: Used capacity of the current instance. Unit: MiB.

total int: Total memory capacity of the current instance. Unit: MiB.
used int: Used capacity of the current instance. Unit: MiB.

total Number: Total memory capacity of the current instance. Unit: MiB.
used Number: Used capacity of the current instance. Unit: MiB.

GetInstanceConfigureNode

Az string: The availability zone each node belongs to.

Az string: The availability zone each node belongs to.

az String: The availability zone each node belongs to.

az string: The availability zone each node belongs to.

az str: The availability zone each node belongs to.

az String: The availability zone each node belongs to.

GetInstanceInstanceShard

NodeNumber int: Number of nodes in each shard
ServerNodes List<Volcengine.GetInstanceInstanceShardServerNode>: Detailed list of all Server nodes in the shard.
ShardId string: Shard ID.

NodeNumber int: Number of nodes in each shard
ServerNodes []GetInstanceInstanceShardServerNode: Detailed list of all Server nodes in the shard.
ShardId string: Shard ID.

nodeNumber Integer: Number of nodes in each shard
serverNodes List<GetInstanceInstanceShardServerNode>: Detailed list of all Server nodes in the shard.
shardId String: Shard ID.

nodeNumber number: Number of nodes in each shard
serverNodes GetInstanceInstanceShardServerNode[]: Detailed list of all Server nodes in the shard.
shardId string: Shard ID.

node_number int: Number of nodes in each shard
server_nodes Sequence[GetInstanceInstanceShardServerNode]: Detailed list of all Server nodes in the shard.
shard_id str: Shard ID.

nodeNumber Number: Number of nodes in each shard
serverNodes List<Property Map>: Detailed list of all Server nodes in the shard.
shardId String: Shard ID.

GetInstanceInstanceShardServerNode

CurrentRole string: Current role of the node. Valid values: PrimaryNode: primary node; SecondaryNode: secondary node.
NodeId string: Node ID.
Status string: Node status. Valid values: deploy: starting; running: running; loading: loading data; error: error.
ZoneId string: Availability zone where the node is located.

CurrentRole string: Current role of the node. Valid values: PrimaryNode: primary node; SecondaryNode: secondary node.
NodeId string: Node ID.
Status string: Node status. Valid values: deploy: starting; running: running; loading: loading data; error: error.
ZoneId string: Availability zone where the node is located.

currentRole String: Current role of the node. Valid values: PrimaryNode: primary node; SecondaryNode: secondary node.
nodeId String: Node ID.
status String: Node status. Valid values: deploy: starting; running: running; loading: loading data; error: error.
zoneId String: Availability zone where the node is located.

currentRole string: Current role of the node. Valid values: PrimaryNode: primary node; SecondaryNode: secondary node.
nodeId string: Node ID.
status string: Node status. Valid values: deploy: starting; running: running; loading: loading data; error: error.
zoneId string: Availability zone where the node is located.

current_role str: Current role of the node. Valid values: PrimaryNode: primary node; SecondaryNode: secondary node.
node_id str: Node ID.
status str: Node status. Valid values: deploy: starting; running: running; loading: loading data; error: error.
zone_id str: Availability zone where the node is located.

currentRole String: Current role of the node. Valid values: PrimaryNode: primary node; SecondaryNode: secondary node.
nodeId String: Node ID.
status String: Node status. Valid values: deploy: starting; running: running; loading: loading data; error: error.
zoneId String: Availability zone where the node is located.

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.

GetInstanceVisitAddr

AddrType string: Connection address type. Value options: Private: Private network connection address; Public: Public network connection address; DirectLink: Direct connection address.
Address string: IP address or domain name.
EipId string: EIP ID bound to the instance's public address. This parameter is returned only when the connection address type (AddrType) is Public.
Port string: Port number.
ViPv6 string: IPv6 address corresponding to the connection address.
Vip string: The IPv4 address corresponding to the connection address.

AddrType string: Connection address type. Value options: Private: Private network connection address; Public: Public network connection address; DirectLink: Direct connection address.
Address string: IP address or domain name.
EipId string: EIP ID bound to the instance's public address. This parameter is returned only when the connection address type (AddrType) is Public.
Port string: Port number.
ViPv6 string: IPv6 address corresponding to the connection address.
Vip string: The IPv4 address corresponding to the connection address.

addrType String: Connection address type. Value options: Private: Private network connection address; Public: Public network connection address; DirectLink: Direct connection address.
address String: IP address or domain name.
eipId String: EIP ID bound to the instance's public address. This parameter is returned only when the connection address type (AddrType) is Public.
port String: Port number.
viPv6 String: IPv6 address corresponding to the connection address.
vip String: The IPv4 address corresponding to the connection address.

addrType string: Connection address type. Value options: Private: Private network connection address; Public: Public network connection address; DirectLink: Direct connection address.
address string: IP address or domain name.
eipId string: EIP ID bound to the instance's public address. This parameter is returned only when the connection address type (AddrType) is Public.
port string: Port number.
viPv6 string: IPv6 address corresponding to the connection address.
vip string: The IPv4 address corresponding to the connection address.

addr_type str: Connection address type. Value options: Private: Private network connection address; Public: Public network connection address; DirectLink: Direct connection address.
address str: IP address or domain name.
eip_id str: EIP ID bound to the instance's public address. This parameter is returned only when the connection address type (AddrType) is Public.
port str: Port number.
vi_pv6 str: IPv6 address corresponding to the connection address.
vip str: The IPv4 address corresponding to the connection address.

addrType String: Connection address type. Value options: Private: Private network connection address; Public: Public network connection address; DirectLink: Direct connection address.
address String: IP address or domain name.
eipId String: EIP ID bound to the instance's public address. This parameter is returned only when the connection address type (AddrType) is Public.
port String: Port number.
viPv6 String: IPv6 address corresponding to the connection address.
vip String: The IPv4 address corresponding to the connection address.