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

volcengine.redis.getBigKeys

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

    Use this data source to query detailed information of redis big keys

    Example Usage

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

const fooZones = volcengine.ecs.getZones({});
const fooVpc = new volcengine.vpc.Vpc("fooVpc", {
    vpcName: "acc-test-vpc",
    cidrBlock: "172.16.0.0/16",
});
const fooSubnet = new volcengine.vpc.Subnet("fooSubnet", {
    subnetName: "acc-test-subnet",
    cidrBlock: "172.16.0.0/24",
    zoneId: fooZones.then(fooZones => fooZones.zones?.[0]?.id),
    vpcId: fooVpc.id,
});
const fooInstance = new volcengine.redis.Instance("fooInstance", {
    zoneIds: [fooZones.then(fooZones => fooZones.zones?.[0]?.id)],
    instanceName: "acc-test-tf-redis",
    shardedCluster: 1,
    password: "1qaz!QAZ12",
    nodeNumber: 2,
    shardCapacity: 1024,
    shardNumber: 2,
    engineVersion: "5.0",
    subnetId: fooSubnet.id,
    deletionProtection: "disabled",
    vpcAuthMode: "close",
    chargeType: "PostPaid",
    port: 6381,
    projectName: "default",
});
const fooBigKeys = volcengine.redis.getBigKeysOutput({
    instanceId: fooInstance.id,
});

    import pulumi
import pulumi_volcengine as volcengine

foo_zones = volcengine.ecs.get_zones()
foo_vpc = volcengine.vpc.Vpc("fooVpc",
    vpc_name="acc-test-vpc",
    cidr_block="172.16.0.0/16")
foo_subnet = volcengine.vpc.Subnet("fooSubnet",
    subnet_name="acc-test-subnet",
    cidr_block="172.16.0.0/24",
    zone_id=foo_zones.zones[0].id,
    vpc_id=foo_vpc.id)
foo_instance = volcengine.redis.Instance("fooInstance",
    zone_ids=[foo_zones.zones[0].id],
    instance_name="acc-test-tf-redis",
    sharded_cluster=1,
    password="1qaz!QAZ12",
    node_number=2,
    shard_capacity=1024,
    shard_number=2,
    engine_version="5.0",
    subnet_id=foo_subnet.id,
    deletion_protection="disabled",
    vpc_auth_mode="close",
    charge_type="PostPaid",
    port=6381,
    project_name="default")
foo_big_keys = volcengine.redis.get_big_keys_output(instance_id=foo_instance.id)

    package main

import (
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
	"github.com/volcengine/pulumi-volcengine/sdk/go/volcengine/ecs"
	"github.com/volcengine/pulumi-volcengine/sdk/go/volcengine/redis"
	"github.com/volcengine/pulumi-volcengine/sdk/go/volcengine/vpc"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		fooZones, err := ecs.GetZones(ctx, nil, nil)
		if err != nil {
			return err
		}
		fooVpc, err := vpc.NewVpc(ctx, "fooVpc", &vpc.VpcArgs{
			VpcName:   pulumi.String("acc-test-vpc"),
			CidrBlock: pulumi.String("172.16.0.0/16"),
		})
		if err != nil {
			return err
		}
		fooSubnet, err := vpc.NewSubnet(ctx, "fooSubnet", &vpc.SubnetArgs{
			SubnetName: pulumi.String("acc-test-subnet"),
			CidrBlock:  pulumi.String("172.16.0.0/24"),
			ZoneId:     pulumi.String(fooZones.Zones[0].Id),
			VpcId:      fooVpc.ID(),
		})
		if err != nil {
			return err
		}
		fooInstance, err := redis.NewInstance(ctx, "fooInstance", &redis.InstanceArgs{
			ZoneIds: pulumi.StringArray{
				pulumi.String(fooZones.Zones[0].Id),
			},
			InstanceName:       pulumi.String("acc-test-tf-redis"),
			ShardedCluster:     pulumi.Int(1),
			Password:           pulumi.String("1qaz!QAZ12"),
			NodeNumber:         pulumi.Int(2),
			ShardCapacity:      pulumi.Int(1024),
			ShardNumber:        pulumi.Int(2),
			EngineVersion:      pulumi.String("5.0"),
			SubnetId:           fooSubnet.ID(),
			DeletionProtection: pulumi.String("disabled"),
			VpcAuthMode:        pulumi.String("close"),
			ChargeType:         pulumi.String("PostPaid"),
			Port:               pulumi.Int(6381),
			ProjectName:        pulumi.String("default"),
		})
		if err != nil {
			return err
		}
		_ = redis.GetBigKeysOutput(ctx, redis.GetBigKeysOutputArgs{
			InstanceId: fooInstance.ID(),
		}, nil)
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var fooZones = Volcengine.Ecs.GetZones.Invoke();

    var fooVpc = new Volcengine.Vpc.Vpc("fooVpc", new()
    {
        VpcName = "acc-test-vpc",
        CidrBlock = "172.16.0.0/16",
    });

    var fooSubnet = new Volcengine.Vpc.Subnet("fooSubnet", new()
    {
        SubnetName = "acc-test-subnet",
        CidrBlock = "172.16.0.0/24",
        ZoneId = fooZones.Apply(getZonesResult => getZonesResult.Zones[0]?.Id),
        VpcId = fooVpc.Id,
    });

    var fooInstance = new Volcengine.Redis.Instance("fooInstance", new()
    {
        ZoneIds = new[]
        {
            fooZones.Apply(getZonesResult => getZonesResult.Zones[0]?.Id),
        },
        InstanceName = "acc-test-tf-redis",
        ShardedCluster = 1,
        Password = "1qaz!QAZ12",
        NodeNumber = 2,
        ShardCapacity = 1024,
        ShardNumber = 2,
        EngineVersion = "5.0",
        SubnetId = fooSubnet.Id,
        DeletionProtection = "disabled",
        VpcAuthMode = "close",
        ChargeType = "PostPaid",
        Port = 6381,
        ProjectName = "default",
    });

    var fooBigKeys = Volcengine.Redis.GetBigKeys.Invoke(new()
    {
        InstanceId = fooInstance.Id,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.volcengine.ecs.EcsFunctions;
import com.pulumi.volcengine.ecs.inputs.GetZonesArgs;
import com.pulumi.volcengine.vpc.Vpc;
import com.pulumi.volcengine.vpc.VpcArgs;
import com.pulumi.volcengine.vpc.Subnet;
import com.pulumi.volcengine.vpc.SubnetArgs;
import com.pulumi.volcengine.redis.Instance;
import com.pulumi.volcengine.redis.InstanceArgs;
import com.pulumi.volcengine.redis.RedisFunctions;
import com.pulumi.volcengine.redis.inputs.GetBigKeysArgs;
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 fooZones = EcsFunctions.getZones();

        var fooVpc = new Vpc("fooVpc", VpcArgs.builder()        
            .vpcName("acc-test-vpc")
            .cidrBlock("172.16.0.0/16")
            .build());

        var fooSubnet = new Subnet("fooSubnet", SubnetArgs.builder()        
            .subnetName("acc-test-subnet")
            .cidrBlock("172.16.0.0/24")
            .zoneId(fooZones.applyValue(getZonesResult -> getZonesResult.zones()[0].id()))
            .vpcId(fooVpc.id())
            .build());

        var fooInstance = new Instance("fooInstance", InstanceArgs.builder()        
            .zoneIds(fooZones.applyValue(getZonesResult -> getZonesResult.zones()[0].id()))
            .instanceName("acc-test-tf-redis")
            .shardedCluster(1)
            .password("1qaz!QAZ12")
            .nodeNumber(2)
            .shardCapacity(1024)
            .shardNumber(2)
            .engineVersion("5.0")
            .subnetId(fooSubnet.id())
            .deletionProtection("disabled")
            .vpcAuthMode("close")
            .chargeType("PostPaid")
            .port(6381)
            .projectName("default")
            .build());

        final var fooBigKeys = RedisFunctions.getBigKeys(GetBigKeysArgs.builder()
            .instanceId(fooInstance.id())
            .build());

    }
}

    resources:
  fooVpc:
    type: volcengine:vpc:Vpc
    properties:
      vpcName: acc-test-vpc
      cidrBlock: 172.16.0.0/16
  fooSubnet:
    type: volcengine:vpc:Subnet
    properties:
      subnetName: acc-test-subnet
      cidrBlock: 172.16.0.0/24
      zoneId: ${fooZones.zones[0].id}
      vpcId: ${fooVpc.id}
  fooInstance:
    type: volcengine:redis:Instance
    properties:
      zoneIds:
        - ${fooZones.zones[0].id}
      instanceName: acc-test-tf-redis
      shardedCluster: 1
      password: 1qaz!QAZ12
      nodeNumber: 2
      shardCapacity: 1024
      shardNumber: 2
      engineVersion: '5.0'
      subnetId: ${fooSubnet.id}
      deletionProtection: disabled
      vpcAuthMode: close
      chargeType: PostPaid
      port: 6381
      projectName: default
variables:
  fooZones:
    fn::invoke:
      Function: volcengine:ecs:getZones
      Arguments: {}
  fooBigKeys:
    fn::invoke:
      Function: volcengine:redis:getBigKeys
      Arguments:
        instanceId: ${fooInstance.id}

    Using getBigKeys

    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 getBigKeys(args: GetBigKeysArgs, opts?: InvokeOptions): Promise<GetBigKeysResult>
function getBigKeysOutput(args: GetBigKeysOutputArgs, opts?: InvokeOptions): Output<GetBigKeysResult>
    def get_big_keys(instance_id: Optional[str] = None,
                 key_type: Optional[str] = None,
                 name_regex: Optional[str] = None,
                 order_by: Optional[str] = None,
                 output_file: Optional[str] = None,
                 query_end_time: Optional[str] = None,
                 query_start_time: Optional[str] = None,
                 opts: Optional[InvokeOptions] = None) -> GetBigKeysResult
def get_big_keys_output(instance_id: Optional[pulumi.Input[str]] = None,
                 key_type: Optional[pulumi.Input[str]] = None,
                 name_regex: Optional[pulumi.Input[str]] = None,
                 order_by: Optional[pulumi.Input[str]] = None,
                 output_file: Optional[pulumi.Input[str]] = None,
                 query_end_time: Optional[pulumi.Input[str]] = None,
                 query_start_time: Optional[pulumi.Input[str]] = None,
                 opts: Optional[InvokeOptions] = None) -> Output[GetBigKeysResult]
    func GetBigKeys(ctx *Context, args *GetBigKeysArgs, opts ...InvokeOption) (*GetBigKeysResult, error)
func GetBigKeysOutput(ctx *Context, args *GetBigKeysOutputArgs, opts ...InvokeOption) GetBigKeysResultOutput

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

    public static class GetBigKeys 
{
    public static Task<GetBigKeysResult> InvokeAsync(GetBigKeysArgs args, InvokeOptions? opts = null)
    public static Output<GetBigKeysResult> Invoke(GetBigKeysInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetBigKeysResult> getBigKeys(GetBigKeysArgs args, InvokeOptions options)
public static Output<GetBigKeysResult> getBigKeys(GetBigKeysArgs args, InvokeOptions options)

    fn::invoke:
  function: volcengine:redis/getBigKeys:getBigKeys
  arguments:
    # arguments dictionary

    The following arguments are supported:

    InstanceId string
    The ID of Instance.
    KeyType string
    Specify the data type used to filter the query results of hot keys.
    NameRegex string
    A Name Regex of Resource.
    OrderBy string
    Specify the sorting conditions of the query results.
    OutputFile string
    File name where to save data source results.
    QueryEndTime string
    Query the end time in the format of yyyy-MM-ddTHH:mm:ssZ (UTC).
    QueryStartTime string
    Query the start time in the format of yyyy-MM-ddTHH:mm:ssZ (UTC).
    InstanceId string
    The ID of Instance.
    KeyType string
    Specify the data type used to filter the query results of hot keys.
    NameRegex string
    A Name Regex of Resource.
    OrderBy string
    Specify the sorting conditions of the query results.
    OutputFile string
    File name where to save data source results.
    QueryEndTime string
    Query the end time in the format of yyyy-MM-ddTHH:mm:ssZ (UTC).
    QueryStartTime string
    Query the start time in the format of yyyy-MM-ddTHH:mm:ssZ (UTC).
    instanceId String
    The ID of Instance.
    keyType String
    Specify the data type used to filter the query results of hot keys.
    nameRegex String
    A Name Regex of Resource.
    orderBy String
    Specify the sorting conditions of the query results.
    outputFile String
    File name where to save data source results.
    queryEndTime String
    Query the end time in the format of yyyy-MM-ddTHH:mm:ssZ (UTC).
    queryStartTime String
    Query the start time in the format of yyyy-MM-ddTHH:mm:ssZ (UTC).
    instanceId string
    The ID of Instance.
    keyType string
    Specify the data type used to filter the query results of hot keys.
    nameRegex string
    A Name Regex of Resource.
    orderBy string
    Specify the sorting conditions of the query results.
    outputFile string
    File name where to save data source results.
    queryEndTime string
    Query the end time in the format of yyyy-MM-ddTHH:mm:ssZ (UTC).
    queryStartTime string
    Query the start time in the format of yyyy-MM-ddTHH:mm:ssZ (UTC).
    instance_id str
    The ID of Instance.
    key_type str
    Specify the data type used to filter the query results of hot keys.
    name_regex str
    A Name Regex of Resource.
    order_by str
    Specify the sorting conditions of the query results.
    output_file str
    File name where to save data source results.
    query_end_time str
    Query the end time in the format of yyyy-MM-ddTHH:mm:ssZ (UTC).
    query_start_time str
    Query the start time in the format of yyyy-MM-ddTHH:mm:ssZ (UTC).
    instanceId String
    The ID of Instance.
    keyType String
    Specify the data type used to filter the query results of hot keys.
    nameRegex String
    A Name Regex of Resource.
    orderBy String
    Specify the sorting conditions of the query results.
    outputFile String
    File name where to save data source results.
    queryEndTime String
    Query the end time in the format of yyyy-MM-ddTHH:mm:ssZ (UTC).
    queryStartTime String
    Query the start time in the format of yyyy-MM-ddTHH:mm:ssZ (UTC).

    getBigKeys Result

    The following output properties are available:

    BigKeys List<GetBigKeysBigKey>
    Details of the big Key.
    Id string
    The provider-assigned unique ID for this managed resource.
    InstanceId string
    TotalCount int
    The total count of query.
    KeyType string
    The type of big Key.
    NameRegex string
    OrderBy string
    OutputFile string
    QueryEndTime string
    QueryStartTime string
    BigKeys []GetBigKeysBigKey
    Details of the big Key.
    Id string
    The provider-assigned unique ID for this managed resource.
    InstanceId string
    TotalCount int
    The total count of query.
    KeyType string
    The type of big Key.
    NameRegex string
    OrderBy string
    OutputFile string
    QueryEndTime string
    QueryStartTime string
    bigKeys List<GetBigKeysBigKey>
    Details of the big Key.
    id String
    The provider-assigned unique ID for this managed resource.
    instanceId String
    totalCount Integer
    The total count of query.
    keyType String
    The type of big Key.
    nameRegex String
    orderBy String
    outputFile String
    queryEndTime String
    queryStartTime String
    bigKeys GetBigKeysBigKey[]
    Details of the big Key.
    id string
    The provider-assigned unique ID for this managed resource.
    instanceId string
    totalCount number
    The total count of query.
    keyType string
    The type of big Key.
    nameRegex string
    orderBy string
    outputFile string
    queryEndTime string
    queryStartTime string
    big_keys Sequence[GetBigKeysBigKey]
    Details of the big Key.
    id str
    The provider-assigned unique ID for this managed resource.
    instance_id str
    total_count int
    The total count of query.
    key_type str
    The type of big Key.
    name_regex str
    order_by str
    output_file str
    query_end_time str
    query_start_time str
    bigKeys List<Property Map>
    Details of the big Key.
    id String
    The provider-assigned unique ID for this managed resource.
    instanceId String
    totalCount Number
    The total count of query.
    keyType String
    The type of big Key.
    nameRegex String
    orderBy String
    outputFile String
    queryEndTime String
    queryStartTime String

    Supporting Types

    GetBigKeysBigKey

    DbName string
    The name of the database to which the big Key belongs.
    KeyInfo string
    The name of the big Key.
    KeyType string
    Specify the data type used to filter the query results of hot keys.
    ValueLen string
    The number of elements contained in the large Key.
    ValueSize string
    The memory usage of large keys, unit: Byte.
    DbName string
    The name of the database to which the big Key belongs.
    KeyInfo string
    The name of the big Key.
    KeyType string
    Specify the data type used to filter the query results of hot keys.
    ValueLen string
    The number of elements contained in the large Key.
    ValueSize string
    The memory usage of large keys, unit: Byte.
    dbName String
    The name of the database to which the big Key belongs.
    keyInfo String
    The name of the big Key.
    keyType String
    Specify the data type used to filter the query results of hot keys.
    valueLen String
    The number of elements contained in the large Key.
    valueSize String
    The memory usage of large keys, unit: Byte.
    dbName string
    The name of the database to which the big Key belongs.
    keyInfo string
    The name of the big Key.
    keyType string
    Specify the data type used to filter the query results of hot keys.
    valueLen string
    The number of elements contained in the large Key.
    valueSize string
    The memory usage of large keys, unit: Byte.
    db_name str
    The name of the database to which the big Key belongs.
    key_info str
    The name of the big Key.
    key_type str
    Specify the data type used to filter the query results of hot keys.
    value_len str
    The number of elements contained in the large Key.
    value_size str
    The memory usage of large keys, unit: Byte.
    dbName String
    The name of the database to which the big Key belongs.
    keyInfo String
    The name of the big Key.
    keyType String
    Specify the data type used to filter the query results of hot keys.
    valueLen String
    The number of elements contained in the large Key.
    valueSize String
    The memory usage of large keys, unit: Byte.

    Package Details

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