1. Packages
  2. Volcengine
  3. API Docs
  4. redis
  5. getBackups
Volcengine v0.0.34 published on Wednesday, Jul 2, 2025 by Volcengine

volcengine.redis.getBackups

Explore with Pulumi AI

volcengine logo
Volcengine v0.0.34 published on Wednesday, Jul 2, 2025 by Volcengine

    Use this data source to query detailed information of redis backups

    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 fooBackup: volcengine.redis.Backup[] = [];
    for (const range = {value: 0}; range.value < 3; range.value++) {
        fooBackup.push(new volcengine.redis.Backup(`fooBackup-${range.value}`, {instanceId: fooInstance.id}));
    }
    const fooBackups = volcengine.redis.getBackupsOutput({
        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_backup = []
    for range in [{"value": i} for i in range(0, 3)]:
        foo_backup.append(volcengine.redis.Backup(f"fooBackup-{range['value']}", instance_id=foo_instance.id))
    foo_backups = volcengine.redis.get_backups_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
    		}
    		var fooBackup []*redis.Backup
    		for index := 0; index < 3; index++ {
    			key0 := index
    			_ := index
    			__res, err := redis.NewBackup(ctx, fmt.Sprintf("fooBackup-%v", key0), &redis.BackupArgs{
    				InstanceId: fooInstance.ID(),
    			})
    			if err != nil {
    				return err
    			}
    			fooBackup = append(fooBackup, __res)
    		}
    		_ = redis.GetBackupsOutput(ctx, redis.GetBackupsOutputArgs{
    			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 fooBackup = new List<Volcengine.Redis.Backup>();
        for (var rangeIndex = 0; rangeIndex < 3; rangeIndex++)
        {
            var range = new { Value = rangeIndex };
            fooBackup.Add(new Volcengine.Redis.Backup($"fooBackup-{range.Value}", new()
            {
                InstanceId = fooInstance.Id,
            }));
        }
        var fooBackups = Volcengine.Redis.GetBackups.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.Backup;
    import com.pulumi.volcengine.redis.BackupArgs;
    import com.pulumi.volcengine.redis.RedisFunctions;
    import com.pulumi.volcengine.redis.inputs.GetBackupsArgs;
    import com.pulumi.codegen.internal.KeyedValue;
    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());
    
            for (var i = 0; i < 3; i++) {
                new Backup("fooBackup-" + i, BackupArgs.builder()            
                    .instanceId(fooInstance.id())
                    .build());
    
            
    }
            final var fooBackups = RedisFunctions.getBackups(GetBackupsArgs.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
      fooBackup:
        type: volcengine:redis:Backup
        properties:
          instanceId: ${fooInstance.id}
        options: {}
    variables:
      fooZones:
        fn::invoke:
          Function: volcengine:ecs:getZones
          Arguments: {}
      fooBackups:
        fn::invoke:
          Function: volcengine:redis:getBackups
          Arguments:
            instanceId: ${fooInstance.id}
    

    Using getBackups

    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 getBackups(args: GetBackupsArgs, opts?: InvokeOptions): Promise<GetBackupsResult>
    function getBackupsOutput(args: GetBackupsOutputArgs, opts?: InvokeOptions): Output<GetBackupsResult>
    def get_backups(backup_point_id: Optional[str] = None,
                    backup_point_name: Optional[str] = None,
                    backup_strategy_lists: Optional[Sequence[str]] = None,
                    end_time: Optional[str] = None,
                    instance_id: Optional[str] = None,
                    output_file: Optional[str] = None,
                    project_name: Optional[str] = None,
                    scope: Optional[str] = None,
                    start_time: Optional[str] = None,
                    opts: Optional[InvokeOptions] = None) -> GetBackupsResult
    def get_backups_output(backup_point_id: Optional[pulumi.Input[str]] = None,
                    backup_point_name: Optional[pulumi.Input[str]] = None,
                    backup_strategy_lists: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
                    end_time: Optional[pulumi.Input[str]] = None,
                    instance_id: Optional[pulumi.Input[str]] = None,
                    output_file: Optional[pulumi.Input[str]] = None,
                    project_name: Optional[pulumi.Input[str]] = None,
                    scope: Optional[pulumi.Input[str]] = None,
                    start_time: Optional[pulumi.Input[str]] = None,
                    opts: Optional[InvokeOptions] = None) -> Output[GetBackupsResult]
    func GetBackups(ctx *Context, args *GetBackupsArgs, opts ...InvokeOption) (*GetBackupsResult, error)
    func GetBackupsOutput(ctx *Context, args *GetBackupsOutputArgs, opts ...InvokeOption) GetBackupsResultOutput

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

    public static class GetBackups 
    {
        public static Task<GetBackupsResult> InvokeAsync(GetBackupsArgs args, InvokeOptions? opts = null)
        public static Output<GetBackupsResult> Invoke(GetBackupsInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetBackupsResult> getBackups(GetBackupsArgs args, InvokeOptions options)
    public static Output<GetBackupsResult> getBackups(GetBackupsArgs args, InvokeOptions options)
    
    fn::invoke:
      function: volcengine:redis/getBackups:getBackups
      arguments:
        # arguments dictionary

    The following arguments are supported:

    BackupPointId string
    The id of backup point.
    BackupPointName string
    Backup name, supporting fuzzy query.
    BackupStrategyLists List<string>
    The list of backup strategy, support AutomatedBackup and ManualBackup.
    EndTime string
    Query end time.
    InstanceId string
    Id of instance.
    OutputFile string
    File name where to save data source results.
    ProjectName string
    Back up the project to which it belongs.
    Scope string
    The query scope of the backup.
    StartTime string
    Query start time.
    BackupPointId string
    The id of backup point.
    BackupPointName string
    Backup name, supporting fuzzy query.
    BackupStrategyLists []string
    The list of backup strategy, support AutomatedBackup and ManualBackup.
    EndTime string
    Query end time.
    InstanceId string
    Id of instance.
    OutputFile string
    File name where to save data source results.
    ProjectName string
    Back up the project to which it belongs.
    Scope string
    The query scope of the backup.
    StartTime string
    Query start time.
    backupPointId String
    The id of backup point.
    backupPointName String
    Backup name, supporting fuzzy query.
    backupStrategyLists List<String>
    The list of backup strategy, support AutomatedBackup and ManualBackup.
    endTime String
    Query end time.
    instanceId String
    Id of instance.
    outputFile String
    File name where to save data source results.
    projectName String
    Back up the project to which it belongs.
    scope String
    The query scope of the backup.
    startTime String
    Query start time.
    backupPointId string
    The id of backup point.
    backupPointName string
    Backup name, supporting fuzzy query.
    backupStrategyLists string[]
    The list of backup strategy, support AutomatedBackup and ManualBackup.
    endTime string
    Query end time.
    instanceId string
    Id of instance.
    outputFile string
    File name where to save data source results.
    projectName string
    Back up the project to which it belongs.
    scope string
    The query scope of the backup.
    startTime string
    Query start time.
    backup_point_id str
    The id of backup point.
    backup_point_name str
    Backup name, supporting fuzzy query.
    backup_strategy_lists Sequence[str]
    The list of backup strategy, support AutomatedBackup and ManualBackup.
    end_time str
    Query end time.
    instance_id str
    Id of instance.
    output_file str
    File name where to save data source results.
    project_name str
    Back up the project to which it belongs.
    scope str
    The query scope of the backup.
    start_time str
    Query start time.
    backupPointId String
    The id of backup point.
    backupPointName String
    Backup name, supporting fuzzy query.
    backupStrategyLists List<String>
    The list of backup strategy, support AutomatedBackup and ManualBackup.
    endTime String
    Query end time.
    instanceId String
    Id of instance.
    outputFile String
    File name where to save data source results.
    projectName String
    Back up the project to which it belongs.
    scope String
    The query scope of the backup.
    startTime String
    Query start time.

    getBackups Result

    The following output properties are available:

    Backups List<GetBackupsBackup>
    Information of backups.
    Id string
    The provider-assigned unique ID for this managed resource.
    TotalCount int
    The total count of backup query.
    BackupPointId string
    The id of backup point.
    BackupPointName string
    BackupStrategyLists List<string>
    EndTime string
    End time of backup.
    InstanceId string
    Id of instance.
    OutputFile string
    ProjectName string
    Project name of instance.
    Scope string
    StartTime string
    Start time of backup.
    Backups []GetBackupsBackup
    Information of backups.
    Id string
    The provider-assigned unique ID for this managed resource.
    TotalCount int
    The total count of backup query.
    BackupPointId string
    The id of backup point.
    BackupPointName string
    BackupStrategyLists []string
    EndTime string
    End time of backup.
    InstanceId string
    Id of instance.
    OutputFile string
    ProjectName string
    Project name of instance.
    Scope string
    StartTime string
    Start time of backup.
    backups List<GetBackupsBackup>
    Information of backups.
    id String
    The provider-assigned unique ID for this managed resource.
    totalCount Integer
    The total count of backup query.
    backupPointId String
    The id of backup point.
    backupPointName String
    backupStrategyLists List<String>
    endTime String
    End time of backup.
    instanceId String
    Id of instance.
    outputFile String
    projectName String
    Project name of instance.
    scope String
    startTime String
    Start time of backup.
    backups GetBackupsBackup[]
    Information of backups.
    id string
    The provider-assigned unique ID for this managed resource.
    totalCount number
    The total count of backup query.
    backupPointId string
    The id of backup point.
    backupPointName string
    backupStrategyLists string[]
    endTime string
    End time of backup.
    instanceId string
    Id of instance.
    outputFile string
    projectName string
    Project name of instance.
    scope string
    startTime string
    Start time of backup.
    backups Sequence[GetBackupsBackup]
    Information of backups.
    id str
    The provider-assigned unique ID for this managed resource.
    total_count int
    The total count of backup query.
    backup_point_id str
    The id of backup point.
    backup_point_name str
    backup_strategy_lists Sequence[str]
    end_time str
    End time of backup.
    instance_id str
    Id of instance.
    output_file str
    project_name str
    Project name of instance.
    scope str
    start_time str
    Start time of backup.
    backups List<Property Map>
    Information of backups.
    id String
    The provider-assigned unique ID for this managed resource.
    totalCount Number
    The total count of backup query.
    backupPointId String
    The id of backup point.
    backupPointName String
    backupStrategyLists List<String>
    endTime String
    End time of backup.
    instanceId String
    Id of instance.
    outputFile String
    projectName String
    Project name of instance.
    scope String
    startTime String
    Start time of backup.

    Supporting Types

    GetBackupsBackup

    BackupPointDownloadUrls List<GetBackupsBackupBackupPointDownloadUrl>
    The download address information of the backup file to which the current backup point belongs.
    BackupPointId string
    The id of backup point.
    BackupStrategy string
    Backup strategy.
    BackupType string
    Backup type.
    EndTime string
    Query end time.
    InstanceDetails List<GetBackupsBackupInstanceDetail>
    (Deprecated) Replaced by instance_info. Information of instance.

    Deprecated: Replaced by instance_info.

    InstanceId string
    Id of instance.
    InstanceInfos List<GetBackupsBackupInstanceInfo>
    Information of instance.
    ProjectName string
    Back up the project to which it belongs.
    Size int
    Size in MiB.
    StartTime string
    Query start time.
    Status string
    Status of backup (Creating/Available/Unavailable/Deleting).
    Ttl int
    Backup retention days.
    BackupPointDownloadUrls []GetBackupsBackupBackupPointDownloadUrl
    The download address information of the backup file to which the current backup point belongs.
    BackupPointId string
    The id of backup point.
    BackupStrategy string
    Backup strategy.
    BackupType string
    Backup type.
    EndTime string
    Query end time.
    InstanceDetails []GetBackupsBackupInstanceDetail
    (Deprecated) Replaced by instance_info. Information of instance.

    Deprecated: Replaced by instance_info.

    InstanceId string
    Id of instance.
    InstanceInfos []GetBackupsBackupInstanceInfo
    Information of instance.
    ProjectName string
    Back up the project to which it belongs.
    Size int
    Size in MiB.
    StartTime string
    Query start time.
    Status string
    Status of backup (Creating/Available/Unavailable/Deleting).
    Ttl int
    Backup retention days.
    backupPointDownloadUrls List<GetBackupsBackupBackupPointDownloadUrl>
    The download address information of the backup file to which the current backup point belongs.
    backupPointId String
    The id of backup point.
    backupStrategy String
    Backup strategy.
    backupType String
    Backup type.
    endTime String
    Query end time.
    instanceDetails List<GetBackupsBackupInstanceDetail>
    (Deprecated) Replaced by instance_info. Information of instance.

    Deprecated: Replaced by instance_info.

    instanceId String
    Id of instance.
    instanceInfos List<GetBackupsBackupInstanceInfo>
    Information of instance.
    projectName String
    Back up the project to which it belongs.
    size Integer
    Size in MiB.
    startTime String
    Query start time.
    status String
    Status of backup (Creating/Available/Unavailable/Deleting).
    ttl Integer
    Backup retention days.
    backupPointDownloadUrls GetBackupsBackupBackupPointDownloadUrl[]
    The download address information of the backup file to which the current backup point belongs.
    backupPointId string
    The id of backup point.
    backupStrategy string
    Backup strategy.
    backupType string
    Backup type.
    endTime string
    Query end time.
    instanceDetails GetBackupsBackupInstanceDetail[]
    (Deprecated) Replaced by instance_info. Information of instance.

    Deprecated: Replaced by instance_info.

    instanceId string
    Id of instance.
    instanceInfos GetBackupsBackupInstanceInfo[]
    Information of instance.
    projectName string
    Back up the project to which it belongs.
    size number
    Size in MiB.
    startTime string
    Query start time.
    status string
    Status of backup (Creating/Available/Unavailable/Deleting).
    ttl number
    Backup retention days.
    backup_point_download_urls Sequence[GetBackupsBackupBackupPointDownloadUrl]
    The download address information of the backup file to which the current backup point belongs.
    backup_point_id str
    The id of backup point.
    backup_strategy str
    Backup strategy.
    backup_type str
    Backup type.
    end_time str
    Query end time.
    instance_details Sequence[GetBackupsBackupInstanceDetail]
    (Deprecated) Replaced by instance_info. Information of instance.

    Deprecated: Replaced by instance_info.

    instance_id str
    Id of instance.
    instance_infos Sequence[GetBackupsBackupInstanceInfo]
    Information of instance.
    project_name str
    Back up the project to which it belongs.
    size int
    Size in MiB.
    start_time str
    Query start time.
    status str
    Status of backup (Creating/Available/Unavailable/Deleting).
    ttl int
    Backup retention days.
    backupPointDownloadUrls List<Property Map>
    The download address information of the backup file to which the current backup point belongs.
    backupPointId String
    The id of backup point.
    backupStrategy String
    Backup strategy.
    backupType String
    Backup type.
    endTime String
    Query end time.
    instanceDetails List<Property Map>
    (Deprecated) Replaced by instance_info. Information of instance.

    Deprecated: Replaced by instance_info.

    instanceId String
    Id of instance.
    instanceInfos List<Property Map>
    Information of instance.
    projectName String
    Back up the project to which it belongs.
    size Number
    Size in MiB.
    startTime String
    Query start time.
    status String
    Status of backup (Creating/Available/Unavailable/Deleting).
    ttl Number
    Backup retention days.

    GetBackupsBackupBackupPointDownloadUrl

    PrivateDownloadUrl string
    The private network download address for RDB files.
    PublicDownloadUrl string
    The public network download address for RDB files.
    RdbFileSize int
    RDB file size, unit: Byte.
    ShardId string
    The shard ID where the RDB file is located.
    PrivateDownloadUrl string
    The private network download address for RDB files.
    PublicDownloadUrl string
    The public network download address for RDB files.
    RdbFileSize int
    RDB file size, unit: Byte.
    ShardId string
    The shard ID where the RDB file is located.
    privateDownloadUrl String
    The private network download address for RDB files.
    publicDownloadUrl String
    The public network download address for RDB files.
    rdbFileSize Integer
    RDB file size, unit: Byte.
    shardId String
    The shard ID where the RDB file is located.
    privateDownloadUrl string
    The private network download address for RDB files.
    publicDownloadUrl string
    The public network download address for RDB files.
    rdbFileSize number
    RDB file size, unit: Byte.
    shardId string
    The shard ID where the RDB file is located.
    private_download_url str
    The private network download address for RDB files.
    public_download_url str
    The public network download address for RDB files.
    rdb_file_size int
    RDB file size, unit: Byte.
    shard_id str
    The shard ID where the RDB file is located.
    privateDownloadUrl String
    The private network download address for RDB files.
    publicDownloadUrl String
    The public network download address for RDB files.
    rdbFileSize Number
    RDB file size, unit: Byte.
    shardId String
    The shard ID where the RDB file is located.

    GetBackupsBackupInstanceDetail

    AccountId int
    Id of account.
    ArchType string
    Arch type of instance(Standard/Cluster).
    ChargeType string
    Charge type of instance(Postpaid/Prepaid).
    EngineVersion string
    Engine version of instance.
    ExpiredTime string
    Expired time of instance.
    InstanceId string
    Id of instance.
    InstanceName string
    Name of instance.
    MaintenanceTime string
    The maintainable period (in UTC) of the instance.
    NetworkType string
    Network type of instance.
    ProjectName string
    Back up the project to which it belongs.
    RegionId string
    Id of region.
    Replicas int
    Count of replica in which shard.
    ServerCpu int
    Count of cpu cores of instance.
    ShardCapacity int
    Capacity of shard.
    ShardCount int
    Count of shard.
    TotalCapacity int
    Total capacity of instance.
    UsedCapacity int
    Capacity used of this instance.
    VpcInfos List<GetBackupsBackupInstanceDetailVpcInfo>
    Information of vpc.
    ZoneIds List<string>
    List of id of zone.
    AccountId int
    Id of account.
    ArchType string
    Arch type of instance(Standard/Cluster).
    ChargeType string
    Charge type of instance(Postpaid/Prepaid).
    EngineVersion string
    Engine version of instance.
    ExpiredTime string
    Expired time of instance.
    InstanceId string
    Id of instance.
    InstanceName string
    Name of instance.
    MaintenanceTime string
    The maintainable period (in UTC) of the instance.
    NetworkType string
    Network type of instance.
    ProjectName string
    Back up the project to which it belongs.
    RegionId string
    Id of region.
    Replicas int
    Count of replica in which shard.
    ServerCpu int
    Count of cpu cores of instance.
    ShardCapacity int
    Capacity of shard.
    ShardCount int
    Count of shard.
    TotalCapacity int
    Total capacity of instance.
    UsedCapacity int
    Capacity used of this instance.
    VpcInfos []GetBackupsBackupInstanceDetailVpcInfo
    Information of vpc.
    ZoneIds []string
    List of id of zone.
    accountId Integer
    Id of account.
    archType String
    Arch type of instance(Standard/Cluster).
    chargeType String
    Charge type of instance(Postpaid/Prepaid).
    engineVersion String
    Engine version of instance.
    expiredTime String
    Expired time of instance.
    instanceId String
    Id of instance.
    instanceName String
    Name of instance.
    maintenanceTime String
    The maintainable period (in UTC) of the instance.
    networkType String
    Network type of instance.
    projectName String
    Back up the project to which it belongs.
    regionId String
    Id of region.
    replicas Integer
    Count of replica in which shard.
    serverCpu Integer
    Count of cpu cores of instance.
    shardCapacity Integer
    Capacity of shard.
    shardCount Integer
    Count of shard.
    totalCapacity Integer
    Total capacity of instance.
    usedCapacity Integer
    Capacity used of this instance.
    vpcInfos List<GetBackupsBackupInstanceDetailVpcInfo>
    Information of vpc.
    zoneIds List<String>
    List of id of zone.
    accountId number
    Id of account.
    archType string
    Arch type of instance(Standard/Cluster).
    chargeType string
    Charge type of instance(Postpaid/Prepaid).
    engineVersion string
    Engine version of instance.
    expiredTime string
    Expired time of instance.
    instanceId string
    Id of instance.
    instanceName string
    Name of instance.
    maintenanceTime string
    The maintainable period (in UTC) of the instance.
    networkType string
    Network type of instance.
    projectName string
    Back up the project to which it belongs.
    regionId string
    Id of region.
    replicas number
    Count of replica in which shard.
    serverCpu number
    Count of cpu cores of instance.
    shardCapacity number
    Capacity of shard.
    shardCount number
    Count of shard.
    totalCapacity number
    Total capacity of instance.
    usedCapacity number
    Capacity used of this instance.
    vpcInfos GetBackupsBackupInstanceDetailVpcInfo[]
    Information of vpc.
    zoneIds string[]
    List of id of zone.
    account_id int
    Id of account.
    arch_type str
    Arch type of instance(Standard/Cluster).
    charge_type str
    Charge type of instance(Postpaid/Prepaid).
    engine_version str
    Engine version of instance.
    expired_time str
    Expired time of instance.
    instance_id str
    Id of instance.
    instance_name str
    Name of instance.
    maintenance_time str
    The maintainable period (in UTC) of the instance.
    network_type str
    Network type of instance.
    project_name str
    Back up the project to which it belongs.
    region_id str
    Id of region.
    replicas int
    Count of replica in which shard.
    server_cpu int
    Count of cpu cores of instance.
    shard_capacity int
    Capacity of shard.
    shard_count int
    Count of shard.
    total_capacity int
    Total capacity of instance.
    used_capacity int
    Capacity used of this instance.
    vpc_infos Sequence[GetBackupsBackupInstanceDetailVpcInfo]
    Information of vpc.
    zone_ids Sequence[str]
    List of id of zone.
    accountId Number
    Id of account.
    archType String
    Arch type of instance(Standard/Cluster).
    chargeType String
    Charge type of instance(Postpaid/Prepaid).
    engineVersion String
    Engine version of instance.
    expiredTime String
    Expired time of instance.
    instanceId String
    Id of instance.
    instanceName String
    Name of instance.
    maintenanceTime String
    The maintainable period (in UTC) of the instance.
    networkType String
    Network type of instance.
    projectName String
    Back up the project to which it belongs.
    regionId String
    Id of region.
    replicas Number
    Count of replica in which shard.
    serverCpu Number
    Count of cpu cores of instance.
    shardCapacity Number
    Capacity of shard.
    shardCount Number
    Count of shard.
    totalCapacity Number
    Total capacity of instance.
    usedCapacity Number
    Capacity used of this instance.
    vpcInfos List<Property Map>
    Information of vpc.
    zoneIds List<String>
    List of id of zone.

    GetBackupsBackupInstanceDetailVpcInfo

    Id string
    Id of vpc.
    Name string
    Name of vpc.
    Id string
    Id of vpc.
    Name string
    Name of vpc.
    id String
    Id of vpc.
    name String
    Name of vpc.
    id string
    Id of vpc.
    name string
    Name of vpc.
    id str
    Id of vpc.
    name str
    Name of vpc.
    id String
    Id of vpc.
    name String
    Name of vpc.

    GetBackupsBackupInstanceInfo

    AccountId int
    Id of account.
    ArchType string
    Arch type of instance(Standard/Cluster).
    ChargeType string
    Charge type of instance(Postpaid/Prepaid).
    DeletionProtection string
    The status of the deletion protection function of the instance.
    EngineVersion string
    Engine version of instance.
    ExpiredTime string
    Expired time of instance.
    InstanceId string
    Id of instance.
    InstanceName string
    Name of instance.
    MaintenanceTime string
    The maintainable period (in UTC) of the instance.
    NetworkType string
    Network type of instance.
    RegionId string
    Id of region.
    Replicas int
    Count of replica in which shard.
    ShardCapacity int
    Capacity of shard.
    ShardNumber int
    The number of shards in the instance.
    TotalCapacity int
    Total capacity of instance.
    VpcId string
    The private network ID of the instance.
    ZoneIds List<string>
    List of id of zone.
    AccountId int
    Id of account.
    ArchType string
    Arch type of instance(Standard/Cluster).
    ChargeType string
    Charge type of instance(Postpaid/Prepaid).
    DeletionProtection string
    The status of the deletion protection function of the instance.
    EngineVersion string
    Engine version of instance.
    ExpiredTime string
    Expired time of instance.
    InstanceId string
    Id of instance.
    InstanceName string
    Name of instance.
    MaintenanceTime string
    The maintainable period (in UTC) of the instance.
    NetworkType string
    Network type of instance.
    RegionId string
    Id of region.
    Replicas int
    Count of replica in which shard.
    ShardCapacity int
    Capacity of shard.
    ShardNumber int
    The number of shards in the instance.
    TotalCapacity int
    Total capacity of instance.
    VpcId string
    The private network ID of the instance.
    ZoneIds []string
    List of id of zone.
    accountId Integer
    Id of account.
    archType String
    Arch type of instance(Standard/Cluster).
    chargeType String
    Charge type of instance(Postpaid/Prepaid).
    deletionProtection String
    The status of the deletion protection function of the instance.
    engineVersion String
    Engine version of instance.
    expiredTime String
    Expired time of instance.
    instanceId String
    Id of instance.
    instanceName String
    Name of instance.
    maintenanceTime String
    The maintainable period (in UTC) of the instance.
    networkType String
    Network type of instance.
    regionId String
    Id of region.
    replicas Integer
    Count of replica in which shard.
    shardCapacity Integer
    Capacity of shard.
    shardNumber Integer
    The number of shards in the instance.
    totalCapacity Integer
    Total capacity of instance.
    vpcId String
    The private network ID of the instance.
    zoneIds List<String>
    List of id of zone.
    accountId number
    Id of account.
    archType string
    Arch type of instance(Standard/Cluster).
    chargeType string
    Charge type of instance(Postpaid/Prepaid).
    deletionProtection string
    The status of the deletion protection function of the instance.
    engineVersion string
    Engine version of instance.
    expiredTime string
    Expired time of instance.
    instanceId string
    Id of instance.
    instanceName string
    Name of instance.
    maintenanceTime string
    The maintainable period (in UTC) of the instance.
    networkType string
    Network type of instance.
    regionId string
    Id of region.
    replicas number
    Count of replica in which shard.
    shardCapacity number
    Capacity of shard.
    shardNumber number
    The number of shards in the instance.
    totalCapacity number
    Total capacity of instance.
    vpcId string
    The private network ID of the instance.
    zoneIds string[]
    List of id of zone.
    account_id int
    Id of account.
    arch_type str
    Arch type of instance(Standard/Cluster).
    charge_type str
    Charge type of instance(Postpaid/Prepaid).
    deletion_protection str
    The status of the deletion protection function of the instance.
    engine_version str
    Engine version of instance.
    expired_time str
    Expired time of instance.
    instance_id str
    Id of instance.
    instance_name str
    Name of instance.
    maintenance_time str
    The maintainable period (in UTC) of the instance.
    network_type str
    Network type of instance.
    region_id str
    Id of region.
    replicas int
    Count of replica in which shard.
    shard_capacity int
    Capacity of shard.
    shard_number int
    The number of shards in the instance.
    total_capacity int
    Total capacity of instance.
    vpc_id str
    The private network ID of the instance.
    zone_ids Sequence[str]
    List of id of zone.
    accountId Number
    Id of account.
    archType String
    Arch type of instance(Standard/Cluster).
    chargeType String
    Charge type of instance(Postpaid/Prepaid).
    deletionProtection String
    The status of the deletion protection function of the instance.
    engineVersion String
    Engine version of instance.
    expiredTime String
    Expired time of instance.
    instanceId String
    Id of instance.
    instanceName String
    Name of instance.
    maintenanceTime String
    The maintainable period (in UTC) of the instance.
    networkType String
    Network type of instance.
    regionId String
    Id of region.
    replicas Number
    Count of replica in which shard.
    shardCapacity Number
    Capacity of shard.
    shardNumber Number
    The number of shards in the instance.
    totalCapacity Number
    Total capacity of instance.
    vpcId String
    The private network ID of the instance.
    zoneIds List<String>
    List of id of zone.

    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.34 published on Wednesday, Jul 2, 2025 by Volcengine