1. Packages
  2. Opentelekomcloud Provider
  3. API Docs
  4. getCsbsBackupV1
opentelekomcloud 1.36.37 published on Thursday, Apr 24, 2025 by opentelekomcloud

opentelekomcloud.getCsbsBackupV1

Explore with Pulumi AI

opentelekomcloud logo
opentelekomcloud 1.36.37 published on Thursday, Apr 24, 2025 by opentelekomcloud

    Up-to-date reference of API arguments for CSBS backup you can get at documentation portal

    Use this data source to get details about backup resources from OpenTelekomCloud.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as opentelekomcloud from "@pulumi/opentelekomcloud";
    
    const config = new pulumi.Config();
    const backupName = config.requireObject("backupName");
    const csbs = opentelekomcloud.getCsbsBackupV1({
        backupName: backupName,
    });
    
    import pulumi
    import pulumi_opentelekomcloud as opentelekomcloud
    
    config = pulumi.Config()
    backup_name = config.require_object("backupName")
    csbs = opentelekomcloud.get_csbs_backup_v1(backup_name=backup_name)
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-terraform-provider/sdks/go/opentelekomcloud/opentelekomcloud"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi/config"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		cfg := config.New(ctx, "")
    		backupName := cfg.RequireObject("backupName")
    		_, err := opentelekomcloud.LookupCsbsBackupV1(ctx, &opentelekomcloud.LookupCsbsBackupV1Args{
    			BackupName: pulumi.StringRef(backupName),
    		}, nil)
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Opentelekomcloud = Pulumi.Opentelekomcloud;
    
    return await Deployment.RunAsync(() => 
    {
        var config = new Config();
        var backupName = config.RequireObject<dynamic>("backupName");
        var csbs = Opentelekomcloud.GetCsbsBackupV1.Invoke(new()
        {
            BackupName = backupName,
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.opentelekomcloud.OpentelekomcloudFunctions;
    import com.pulumi.opentelekomcloud.inputs.GetCsbsBackupV1Args;
    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 config = ctx.config();
            final var backupName = config.get("backupName");
            final var csbs = OpentelekomcloudFunctions.getCsbsBackupV1(GetCsbsBackupV1Args.builder()
                .backupName(backupName)
                .build());
    
        }
    }
    
    configuration:
      backupName:
        type: dynamic
    variables:
      csbs:
        fn::invoke:
          function: opentelekomcloud:getCsbsBackupV1
          arguments:
            backupName: ${backupName}
    

    Using getCsbsBackupV1

    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 getCsbsBackupV1(args: GetCsbsBackupV1Args, opts?: InvokeOptions): Promise<GetCsbsBackupV1Result>
    function getCsbsBackupV1Output(args: GetCsbsBackupV1OutputArgs, opts?: InvokeOptions): Output<GetCsbsBackupV1Result>
    def get_csbs_backup_v1(backup_name: Optional[str] = None,
                           backup_record_id: Optional[str] = None,
                           id: Optional[str] = None,
                           policy_id: Optional[str] = None,
                           region: Optional[str] = None,
                           resource_id: Optional[str] = None,
                           resource_name: Optional[str] = None,
                           resource_type: Optional[str] = None,
                           status: Optional[str] = None,
                           tags: Optional[Sequence[GetCsbsBackupV1Tag]] = None,
                           vm_ip: Optional[str] = None,
                           opts: Optional[InvokeOptions] = None) -> GetCsbsBackupV1Result
    def get_csbs_backup_v1_output(backup_name: Optional[pulumi.Input[str]] = None,
                           backup_record_id: Optional[pulumi.Input[str]] = None,
                           id: Optional[pulumi.Input[str]] = None,
                           policy_id: Optional[pulumi.Input[str]] = None,
                           region: Optional[pulumi.Input[str]] = None,
                           resource_id: Optional[pulumi.Input[str]] = None,
                           resource_name: Optional[pulumi.Input[str]] = None,
                           resource_type: Optional[pulumi.Input[str]] = None,
                           status: Optional[pulumi.Input[str]] = None,
                           tags: Optional[pulumi.Input[Sequence[pulumi.Input[GetCsbsBackupV1TagArgs]]]] = None,
                           vm_ip: Optional[pulumi.Input[str]] = None,
                           opts: Optional[InvokeOptions] = None) -> Output[GetCsbsBackupV1Result]
    func LookupCsbsBackupV1(ctx *Context, args *LookupCsbsBackupV1Args, opts ...InvokeOption) (*LookupCsbsBackupV1Result, error)
    func LookupCsbsBackupV1Output(ctx *Context, args *LookupCsbsBackupV1OutputArgs, opts ...InvokeOption) LookupCsbsBackupV1ResultOutput

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

    public static class GetCsbsBackupV1 
    {
        public static Task<GetCsbsBackupV1Result> InvokeAsync(GetCsbsBackupV1Args args, InvokeOptions? opts = null)
        public static Output<GetCsbsBackupV1Result> Invoke(GetCsbsBackupV1InvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetCsbsBackupV1Result> getCsbsBackupV1(GetCsbsBackupV1Args args, InvokeOptions options)
    public static Output<GetCsbsBackupV1Result> getCsbsBackupV1(GetCsbsBackupV1Args args, InvokeOptions options)
    
    fn::invoke:
      function: opentelekomcloud:index/getCsbsBackupV1:getCsbsBackupV1
      arguments:
        # arguments dictionary

    The following arguments are supported:

    BackupName string
    Specifies the backup name.
    BackupRecordId string
    Specifies the backup record ID.
    Id string
    Specifies the ID of backup.
    PolicyId string
    Specifies the Policy Id.
    Region string
    ResourceId string
    Specifies the backup object ID.
    ResourceName string
    Specifies the backup object name.
    ResourceType string
    Specifies the type of backup objects.
    Status string
    Specifies the backup status.
    Tags List<GetCsbsBackupV1Tag>
    VmIp string
    Specifies the ip of VM.
    BackupName string
    Specifies the backup name.
    BackupRecordId string
    Specifies the backup record ID.
    Id string
    Specifies the ID of backup.
    PolicyId string
    Specifies the Policy Id.
    Region string
    ResourceId string
    Specifies the backup object ID.
    ResourceName string
    Specifies the backup object name.
    ResourceType string
    Specifies the type of backup objects.
    Status string
    Specifies the backup status.
    Tags []GetCsbsBackupV1Tag
    VmIp string
    Specifies the ip of VM.
    backupName String
    Specifies the backup name.
    backupRecordId String
    Specifies the backup record ID.
    id String
    Specifies the ID of backup.
    policyId String
    Specifies the Policy Id.
    region String
    resourceId String
    Specifies the backup object ID.
    resourceName String
    Specifies the backup object name.
    resourceType String
    Specifies the type of backup objects.
    status String
    Specifies the backup status.
    tags List<GetCsbsBackupV1Tag>
    vmIp String
    Specifies the ip of VM.
    backupName string
    Specifies the backup name.
    backupRecordId string
    Specifies the backup record ID.
    id string
    Specifies the ID of backup.
    policyId string
    Specifies the Policy Id.
    region string
    resourceId string
    Specifies the backup object ID.
    resourceName string
    Specifies the backup object name.
    resourceType string
    Specifies the type of backup objects.
    status string
    Specifies the backup status.
    tags GetCsbsBackupV1Tag[]
    vmIp string
    Specifies the ip of VM.
    backup_name str
    Specifies the backup name.
    backup_record_id str
    Specifies the backup record ID.
    id str
    Specifies the ID of backup.
    policy_id str
    Specifies the Policy Id.
    region str
    resource_id str
    Specifies the backup object ID.
    resource_name str
    Specifies the backup object name.
    resource_type str
    Specifies the type of backup objects.
    status str
    Specifies the backup status.
    tags Sequence[GetCsbsBackupV1Tag]
    vm_ip str
    Specifies the ip of VM.
    backupName String
    Specifies the backup name.
    backupRecordId String
    Specifies the backup record ID.
    id String
    Specifies the ID of backup.
    policyId String
    Specifies the Policy Id.
    region String
    resourceId String
    Specifies the backup object ID.
    resourceName String
    Specifies the backup object name.
    resourceType String
    Specifies the type of backup objects.
    status String
    Specifies the backup status.
    tags List<Property Map>
    vmIp String
    Specifies the ip of VM.

    getCsbsBackupV1 Result

    The following output properties are available:

    AutoTrigger bool
    Specifies whether automatic trigger is enabled.
    AverageSpeed double
    Specifies the average speed.
    BackupName string
    BackupRecordId string
    Description string
    Provides the backup description.
    Region string
    ResourceId string
    ResourceName string
    ResourceType string
    Size double
    Specifies accumulated size (MB) of backups.
    Status string
    Status of backup Volume.
    VmMetadatas List<GetCsbsBackupV1VmMetadata>
    VolumeBackups List<GetCsbsBackupV1VolumeBackup>
    Id string
    Specifies Cinder backup ID.
    PolicyId string
    Tags List<GetCsbsBackupV1Tag>
    VmIp string
    AutoTrigger bool
    Specifies whether automatic trigger is enabled.
    AverageSpeed float64
    Specifies the average speed.
    BackupName string
    BackupRecordId string
    Description string
    Provides the backup description.
    Region string
    ResourceId string
    ResourceName string
    ResourceType string
    Size float64
    Specifies accumulated size (MB) of backups.
    Status string
    Status of backup Volume.
    VmMetadatas []GetCsbsBackupV1VmMetadata
    VolumeBackups []GetCsbsBackupV1VolumeBackup
    Id string
    Specifies Cinder backup ID.
    PolicyId string
    Tags []GetCsbsBackupV1Tag
    VmIp string
    autoTrigger Boolean
    Specifies whether automatic trigger is enabled.
    averageSpeed Double
    Specifies the average speed.
    backupName String
    backupRecordId String
    description String
    Provides the backup description.
    region String
    resourceId String
    resourceName String
    resourceType String
    size Double
    Specifies accumulated size (MB) of backups.
    status String
    Status of backup Volume.
    vmMetadatas List<GetCsbsBackupV1VmMetadata>
    volumeBackups List<GetCsbsBackupV1VolumeBackup>
    id String
    Specifies Cinder backup ID.
    policyId String
    tags List<GetCsbsBackupV1Tag>
    vmIp String
    autoTrigger boolean
    Specifies whether automatic trigger is enabled.
    averageSpeed number
    Specifies the average speed.
    backupName string
    backupRecordId string
    description string
    Provides the backup description.
    region string
    resourceId string
    resourceName string
    resourceType string
    size number
    Specifies accumulated size (MB) of backups.
    status string
    Status of backup Volume.
    vmMetadatas GetCsbsBackupV1VmMetadata[]
    volumeBackups GetCsbsBackupV1VolumeBackup[]
    id string
    Specifies Cinder backup ID.
    policyId string
    tags GetCsbsBackupV1Tag[]
    vmIp string
    auto_trigger bool
    Specifies whether automatic trigger is enabled.
    average_speed float
    Specifies the average speed.
    backup_name str
    backup_record_id str
    description str
    Provides the backup description.
    region str
    resource_id str
    resource_name str
    resource_type str
    size float
    Specifies accumulated size (MB) of backups.
    status str
    Status of backup Volume.
    vm_metadatas Sequence[GetCsbsBackupV1VmMetadata]
    volume_backups Sequence[GetCsbsBackupV1VolumeBackup]
    id str
    Specifies Cinder backup ID.
    policy_id str
    tags Sequence[GetCsbsBackupV1Tag]
    vm_ip str
    autoTrigger Boolean
    Specifies whether automatic trigger is enabled.
    averageSpeed Number
    Specifies the average speed.
    backupName String
    backupRecordId String
    description String
    Provides the backup description.
    region String
    resourceId String
    resourceName String
    resourceType String
    size Number
    Specifies accumulated size (MB) of backups.
    status String
    Status of backup Volume.
    vmMetadatas List<Property Map>
    volumeBackups List<Property Map>
    id String
    Specifies Cinder backup ID.
    policyId String
    tags List<Property Map>
    vmIp String

    Supporting Types

    GetCsbsBackupV1Tag

    Key string
    Specifies tag key.
    Value string
    Specifies tag value.
    Key string
    Specifies tag key.
    Value string
    Specifies tag value.
    key String
    Specifies tag key.
    value String
    Specifies tag value.
    key string
    Specifies tag key.
    value string
    Specifies tag value.
    key str
    Specifies tag key.
    value str
    Specifies tag value.
    key String
    Specifies tag key.
    value String
    Specifies tag value.

    GetCsbsBackupV1VmMetadata

    CloudServiceType string
    Specifies ECS type.
    Disk double
    Shows system disk size corresponding to the ECS specifications.
    Eip string
    Specifies elastic IP address of the ECS.
    ImageType string
    Specifies image type.
    Name string
    Name of backup data.
    PrivateIp string
    It specifies internal IP address of the ECS.
    Ram double
    Specifies memory size of the ECS, in MB.
    Vcpus double
    Specifies CPU cores corresponding to the ECS.
    CloudServiceType string
    Specifies ECS type.
    Disk float64
    Shows system disk size corresponding to the ECS specifications.
    Eip string
    Specifies elastic IP address of the ECS.
    ImageType string
    Specifies image type.
    Name string
    Name of backup data.
    PrivateIp string
    It specifies internal IP address of the ECS.
    Ram float64
    Specifies memory size of the ECS, in MB.
    Vcpus float64
    Specifies CPU cores corresponding to the ECS.
    cloudServiceType String
    Specifies ECS type.
    disk Double
    Shows system disk size corresponding to the ECS specifications.
    eip String
    Specifies elastic IP address of the ECS.
    imageType String
    Specifies image type.
    name String
    Name of backup data.
    privateIp String
    It specifies internal IP address of the ECS.
    ram Double
    Specifies memory size of the ECS, in MB.
    vcpus Double
    Specifies CPU cores corresponding to the ECS.
    cloudServiceType string
    Specifies ECS type.
    disk number
    Shows system disk size corresponding to the ECS specifications.
    eip string
    Specifies elastic IP address of the ECS.
    imageType string
    Specifies image type.
    name string
    Name of backup data.
    privateIp string
    It specifies internal IP address of the ECS.
    ram number
    Specifies memory size of the ECS, in MB.
    vcpus number
    Specifies CPU cores corresponding to the ECS.
    cloud_service_type str
    Specifies ECS type.
    disk float
    Shows system disk size corresponding to the ECS specifications.
    eip str
    Specifies elastic IP address of the ECS.
    image_type str
    Specifies image type.
    name str
    Name of backup data.
    private_ip str
    It specifies internal IP address of the ECS.
    ram float
    Specifies memory size of the ECS, in MB.
    vcpus float
    Specifies CPU cores corresponding to the ECS.
    cloudServiceType String
    Specifies ECS type.
    disk Number
    Shows system disk size corresponding to the ECS specifications.
    eip String
    Specifies elastic IP address of the ECS.
    imageType String
    Specifies image type.
    name String
    Name of backup data.
    privateIp String
    It specifies internal IP address of the ECS.
    ram Number
    Specifies memory size of the ECS, in MB.
    vcpus Number
    Specifies CPU cores corresponding to the ECS.

    GetCsbsBackupV1VolumeBackup

    AverageSpeed double
    Specifies the average speed.
    Bootable bool
    Specifies whether the disk is bootable.
    Id string
    Specifies the ID of backup.
    ImageType string
    Specifies image type.
    Incremental bool
    Shows whether incremental backup is used.
    Name string
    Name of backup data.
    Size double
    Specifies accumulated size (MB) of backups.
    SnapshotId string
    ID of snapshot.
    SourceVolumeId string
    It specifies source volume ID.
    SourceVolumeName string
    Specifies source volume name.
    SourceVolumeSize double
    Shows source volume size in GB.
    SpaceSavingRatio double
    Specifies space saving rate.
    Status string
    Specifies the backup status.
    AverageSpeed float64
    Specifies the average speed.
    Bootable bool
    Specifies whether the disk is bootable.
    Id string
    Specifies the ID of backup.
    ImageType string
    Specifies image type.
    Incremental bool
    Shows whether incremental backup is used.
    Name string
    Name of backup data.
    Size float64
    Specifies accumulated size (MB) of backups.
    SnapshotId string
    ID of snapshot.
    SourceVolumeId string
    It specifies source volume ID.
    SourceVolumeName string
    Specifies source volume name.
    SourceVolumeSize float64
    Shows source volume size in GB.
    SpaceSavingRatio float64
    Specifies space saving rate.
    Status string
    Specifies the backup status.
    averageSpeed Double
    Specifies the average speed.
    bootable Boolean
    Specifies whether the disk is bootable.
    id String
    Specifies the ID of backup.
    imageType String
    Specifies image type.
    incremental Boolean
    Shows whether incremental backup is used.
    name String
    Name of backup data.
    size Double
    Specifies accumulated size (MB) of backups.
    snapshotId String
    ID of snapshot.
    sourceVolumeId String
    It specifies source volume ID.
    sourceVolumeName String
    Specifies source volume name.
    sourceVolumeSize Double
    Shows source volume size in GB.
    spaceSavingRatio Double
    Specifies space saving rate.
    status String
    Specifies the backup status.
    averageSpeed number
    Specifies the average speed.
    bootable boolean
    Specifies whether the disk is bootable.
    id string
    Specifies the ID of backup.
    imageType string
    Specifies image type.
    incremental boolean
    Shows whether incremental backup is used.
    name string
    Name of backup data.
    size number
    Specifies accumulated size (MB) of backups.
    snapshotId string
    ID of snapshot.
    sourceVolumeId string
    It specifies source volume ID.
    sourceVolumeName string
    Specifies source volume name.
    sourceVolumeSize number
    Shows source volume size in GB.
    spaceSavingRatio number
    Specifies space saving rate.
    status string
    Specifies the backup status.
    average_speed float
    Specifies the average speed.
    bootable bool
    Specifies whether the disk is bootable.
    id str
    Specifies the ID of backup.
    image_type str
    Specifies image type.
    incremental bool
    Shows whether incremental backup is used.
    name str
    Name of backup data.
    size float
    Specifies accumulated size (MB) of backups.
    snapshot_id str
    ID of snapshot.
    source_volume_id str
    It specifies source volume ID.
    source_volume_name str
    Specifies source volume name.
    source_volume_size float
    Shows source volume size in GB.
    space_saving_ratio float
    Specifies space saving rate.
    status str
    Specifies the backup status.
    averageSpeed Number
    Specifies the average speed.
    bootable Boolean
    Specifies whether the disk is bootable.
    id String
    Specifies the ID of backup.
    imageType String
    Specifies image type.
    incremental Boolean
    Shows whether incremental backup is used.
    name String
    Name of backup data.
    size Number
    Specifies accumulated size (MB) of backups.
    snapshotId String
    ID of snapshot.
    sourceVolumeId String
    It specifies source volume ID.
    sourceVolumeName String
    Specifies source volume name.
    sourceVolumeSize Number
    Shows source volume size in GB.
    spaceSavingRatio Number
    Specifies space saving rate.
    status String
    Specifies the backup status.

    Package Details

    Repository
    opentelekomcloud opentelekomcloud/terraform-provider-opentelekomcloud
    License
    Notes
    This Pulumi package is based on the opentelekomcloud Terraform Provider.
    opentelekomcloud logo
    opentelekomcloud 1.36.37 published on Thursday, Apr 24, 2025 by opentelekomcloud