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

volcengine.rds_mssql.getBackups

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 rds mssql backups

    Example Usage

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

const foo = volcengine.rds_mssql.getBackups({
    instanceId: "mssql-40914121fd22",
});

    import pulumi
import pulumi_volcengine as volcengine

foo = volcengine.rds_mssql.get_backups(instance_id="mssql-40914121fd22")

    package main

import (
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
	"github.com/volcengine/pulumi-volcengine/sdk/go/volcengine/rds_mssql"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := rds_mssql.GetBackups(ctx, &rds_mssql.GetBackupsArgs{
			InstanceId: "mssql-40914121fd22",
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var foo = Volcengine.Rds_mssql.GetBackups.Invoke(new()
    {
        InstanceId = "mssql-40914121fd22",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.volcengine.rds_mssql.Rds_mssqlFunctions;
import com.pulumi.volcengine.rds_mssql.inputs.GetBackupsArgs;
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 foo = Rds_mssqlFunctions.getBackups(GetBackupsArgs.builder()
            .instanceId("mssql-40914121fd22")
            .build());

    }
}

    variables:
  foo:
    fn::invoke:
      Function: volcengine:rds_mssql:getBackups
      Arguments:
        instanceId: mssql-40914121fd22

    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_end_time: Optional[str] = None,
                backup_id: Optional[str] = None,
                backup_start_time: Optional[str] = None,
                backup_type: Optional[str] = None,
                instance_id: Optional[str] = None,
                output_file: Optional[str] = None,
                opts: Optional[InvokeOptions] = None) -> GetBackupsResult
def get_backups_output(backup_end_time: Optional[pulumi.Input[str]] = None,
                backup_id: Optional[pulumi.Input[str]] = None,
                backup_start_time: Optional[pulumi.Input[str]] = None,
                backup_type: Optional[pulumi.Input[str]] = None,
                instance_id: Optional[pulumi.Input[str]] = None,
                output_file: 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:rds_mssql/getBackups:getBackups
  arguments:
    # arguments dictionary

    The following arguments are supported:

    InstanceId string
    The id of the instance.
    BackupEndTime string
    The end time of the backup.
    BackupId string
    The id of the backup.
    BackupStartTime string
    The start time of the backup.
    BackupType string
    The type of the backup.
    OutputFile string
    File name where to save data source results.
    InstanceId string
    The id of the instance.
    BackupEndTime string
    The end time of the backup.
    BackupId string
    The id of the backup.
    BackupStartTime string
    The start time of the backup.
    BackupType string
    The type of the backup.
    OutputFile string
    File name where to save data source results.
    instanceId String
    The id of the instance.
    backupEndTime String
    The end time of the backup.
    backupId String
    The id of the backup.
    backupStartTime String
    The start time of the backup.
    backupType String
    The type of the backup.
    outputFile String
    File name where to save data source results.
    instanceId string
    The id of the instance.
    backupEndTime string
    The end time of the backup.
    backupId string
    The id of the backup.
    backupStartTime string
    The start time of the backup.
    backupType string
    The type of the backup.
    outputFile string
    File name where to save data source results.
    instance_id str
    The id of the instance.
    backup_end_time str
    The end time of the backup.
    backup_id str
    The id of the backup.
    backup_start_time str
    The start time of the backup.
    backup_type str
    The type of the backup.
    output_file str
    File name where to save data source results.
    instanceId String
    The id of the instance.
    backupEndTime String
    The end time of the backup.
    backupId String
    The id of the backup.
    backupStartTime String
    The start time of the backup.
    backupType String
    The type of the backup.
    outputFile String
    File name where to save data source results.

    getBackups Result

    The following output properties are available:

    Backups List<GetBackupsBackup>
    The collection of query.
    Id string
    The provider-assigned unique ID for this managed resource.
    InstanceId string
    TotalCount int
    The total count of query.
    BackupEndTime string
    The end time of the backup.
    BackupId string
    The id of the backup.
    BackupStartTime string
    The start time of the backup.
    BackupType string
    The type of the backup.
    OutputFile string
    Backups []GetBackupsBackup
    The collection of query.
    Id string
    The provider-assigned unique ID for this managed resource.
    InstanceId string
    TotalCount int
    The total count of query.
    BackupEndTime string
    The end time of the backup.
    BackupId string
    The id of the backup.
    BackupStartTime string
    The start time of the backup.
    BackupType string
    The type of the backup.
    OutputFile string
    backups List<GetBackupsBackup>
    The collection of query.
    id String
    The provider-assigned unique ID for this managed resource.
    instanceId String
    totalCount Integer
    The total count of query.
    backupEndTime String
    The end time of the backup.
    backupId String
    The id of the backup.
    backupStartTime String
    The start time of the backup.
    backupType String
    The type of the backup.
    outputFile String
    backups GetBackupsBackup[]
    The collection of query.
    id string
    The provider-assigned unique ID for this managed resource.
    instanceId string
    totalCount number
    The total count of query.
    backupEndTime string
    The end time of the backup.
    backupId string
    The id of the backup.
    backupStartTime string
    The start time of the backup.
    backupType string
    The type of the backup.
    outputFile string
    backups Sequence[GetBackupsBackup]
    The collection of query.
    id str
    The provider-assigned unique ID for this managed resource.
    instance_id str
    total_count int
    The total count of query.
    backup_end_time str
    The end time of the backup.
    backup_id str
    The id of the backup.
    backup_start_time str
    The start time of the backup.
    backup_type str
    The type of the backup.
    output_file str
    backups List<Property Map>
    The collection of query.
    id String
    The provider-assigned unique ID for this managed resource.
    instanceId String
    totalCount Number
    The total count of query.
    backupEndTime String
    The end time of the backup.
    backupId String
    The id of the backup.
    backupStartTime String
    The start time of the backup.
    backupType String
    The type of the backup.
    outputFile String

    Supporting Types

    GetBackupsBackup

    BackupDatabaseDetails List<GetBackupsBackupBackupDatabaseDetail>
    The detail of the database.
    BackupEndTime string
    The end time of the backup.
    BackupFileSize int
    The size of the backup file.
    BackupId string
    The id of the backup.
    BackupMethod string
    The name of the backup method.
    BackupStartTime string
    The start time of the backup.
    BackupStatus string
    The status of the backup.
    BackupType string
    The type of the backup.
    CreateType string
    The type of the backup create.
    Id string
    The id of the backup.
    BackupDatabaseDetails []GetBackupsBackupBackupDatabaseDetail
    The detail of the database.
    BackupEndTime string
    The end time of the backup.
    BackupFileSize int
    The size of the backup file.
    BackupId string
    The id of the backup.
    BackupMethod string
    The name of the backup method.
    BackupStartTime string
    The start time of the backup.
    BackupStatus string
    The status of the backup.
    BackupType string
    The type of the backup.
    CreateType string
    The type of the backup create.
    Id string
    The id of the backup.
    backupDatabaseDetails List<GetBackupsBackupBackupDatabaseDetail>
    The detail of the database.
    backupEndTime String
    The end time of the backup.
    backupFileSize Integer
    The size of the backup file.
    backupId String
    The id of the backup.
    backupMethod String
    The name of the backup method.
    backupStartTime String
    The start time of the backup.
    backupStatus String
    The status of the backup.
    backupType String
    The type of the backup.
    createType String
    The type of the backup create.
    id String
    The id of the backup.
    backupDatabaseDetails GetBackupsBackupBackupDatabaseDetail[]
    The detail of the database.
    backupEndTime string
    The end time of the backup.
    backupFileSize number
    The size of the backup file.
    backupId string
    The id of the backup.
    backupMethod string
    The name of the backup method.
    backupStartTime string
    The start time of the backup.
    backupStatus string
    The status of the backup.
    backupType string
    The type of the backup.
    createType string
    The type of the backup create.
    id string
    The id of the backup.
    backup_database_details Sequence[GetBackupsBackupBackupDatabaseDetail]
    The detail of the database.
    backup_end_time str
    The end time of the backup.
    backup_file_size int
    The size of the backup file.
    backup_id str
    The id of the backup.
    backup_method str
    The name of the backup method.
    backup_start_time str
    The start time of the backup.
    backup_status str
    The status of the backup.
    backup_type str
    The type of the backup.
    create_type str
    The type of the backup create.
    id str
    The id of the backup.
    backupDatabaseDetails List<Property Map>
    The detail of the database.
    backupEndTime String
    The end time of the backup.
    backupFileSize Number
    The size of the backup file.
    backupId String
    The id of the backup.
    backupMethod String
    The name of the backup method.
    backupStartTime String
    The start time of the backup.
    backupStatus String
    The status of the backup.
    backupType String
    The type of the backup.
    createType String
    The type of the backup create.
    id String
    The id of the backup.

    GetBackupsBackupBackupDatabaseDetail

    BackupDownloadLinkEip string
    External backup download link.
    BackupDownloadLinkInner string
    Intranet backup download link.
    BackupEndTime string
    The end time of the backup.
    BackupFileName string
    The name of the backup file.
    BackupFileSize int
    The size of the backup file.
    BackupStartTime string
    The start time of the backup.
    BackupType string
    The type of the backup.
    DatabaseName string
    The name of the database.
    DownloadProgress int
    Backup file preparation progress, unit: %.
    DownloadStatus string
    Download status.
    LinkExpiredTime string
    Download link expiration time.
    BackupDownloadLinkEip string
    External backup download link.
    BackupDownloadLinkInner string
    Intranet backup download link.
    BackupEndTime string
    The end time of the backup.
    BackupFileName string
    The name of the backup file.
    BackupFileSize int
    The size of the backup file.
    BackupStartTime string
    The start time of the backup.
    BackupType string
    The type of the backup.
    DatabaseName string
    The name of the database.
    DownloadProgress int
    Backup file preparation progress, unit: %.
    DownloadStatus string
    Download status.
    LinkExpiredTime string
    Download link expiration time.
    backupDownloadLinkEip String
    External backup download link.
    backupDownloadLinkInner String
    Intranet backup download link.
    backupEndTime String
    The end time of the backup.
    backupFileName String
    The name of the backup file.
    backupFileSize Integer
    The size of the backup file.
    backupStartTime String
    The start time of the backup.
    backupType String
    The type of the backup.
    databaseName String
    The name of the database.
    downloadProgress Integer
    Backup file preparation progress, unit: %.
    downloadStatus String
    Download status.
    linkExpiredTime String
    Download link expiration time.
    backupDownloadLinkEip string
    External backup download link.
    backupDownloadLinkInner string
    Intranet backup download link.
    backupEndTime string
    The end time of the backup.
    backupFileName string
    The name of the backup file.
    backupFileSize number
    The size of the backup file.
    backupStartTime string
    The start time of the backup.
    backupType string
    The type of the backup.
    databaseName string
    The name of the database.
    downloadProgress number
    Backup file preparation progress, unit: %.
    downloadStatus string
    Download status.
    linkExpiredTime string
    Download link expiration time.
    backup_download_link_eip str
    External backup download link.
    backup_download_link_inner str
    Intranet backup download link.
    backup_end_time str
    The end time of the backup.
    backup_file_name str
    The name of the backup file.
    backup_file_size int
    The size of the backup file.
    backup_start_time str
    The start time of the backup.
    backup_type str
    The type of the backup.
    database_name str
    The name of the database.
    download_progress int
    Backup file preparation progress, unit: %.
    download_status str
    Download status.
    link_expired_time str
    Download link expiration time.
    backupDownloadLinkEip String
    External backup download link.
    backupDownloadLinkInner String
    Intranet backup download link.
    backupEndTime String
    The end time of the backup.
    backupFileName String
    The name of the backup file.
    backupFileSize Number
    The size of the backup file.
    backupStartTime String
    The start time of the backup.
    backupType String
    The type of the backup.
    databaseName String
    The name of the database.
    downloadProgress Number
    Backup file preparation progress, unit: %.
    downloadStatus String
    Download status.
    linkExpiredTime String
    Download link expiration time.

    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