Volcengine v0.0.38, Oct 31 25

Volcengine v0.0.38 published on Friday, Oct 31, 2025 by Volcengine

volcengine.rds_mysql.getBackups

Volcengine v0.0.38 published on Friday, Oct 31, 2025 by Volcengine

Example Usage

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

const foo = volcengine.rds_mysql.getBackups({
    instanceId: "mysql-b51d37110dd1",
});

import pulumi
import pulumi_volcengine as volcengine

foo = volcengine.rds_mysql.get_backups(instance_id="mysql-b51d37110dd1")

package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := rds_mysql.GetBackups(ctx, &rds_mysql.GetBackupsArgs{
			InstanceId: pulumi.StringRef("mysql-b51d37110dd1"),
		}, 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_mysql.GetBackups.Invoke(new()
    {
        InstanceId = "mysql-b51d37110dd1",
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.volcengine.rds_mysql.Rds_mysqlFunctions;
import com.pulumi.volcengine.rds_mysql.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_mysqlFunctions.getBackups(GetBackupsArgs.builder()
            .instanceId("mysql-b51d37110dd1")
            .build());

    }
}

variables:
  foo:
    fn::invoke:
      Function: volcengine:rds_mysql:getBackups
      Arguments:
        instanceId: mysql-b51d37110dd1

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_method: Optional[str] = None,
                backup_start_time: Optional[str] = None,
                backup_status: Optional[str] = None,
                backup_type: Optional[str] = None,
                create_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_method: Optional[pulumi.Input[str]] = None,
                backup_start_time: Optional[pulumi.Input[str]] = None,
                backup_status: Optional[pulumi.Input[str]] = None,
                backup_type: Optional[pulumi.Input[str]] = None,
                create_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_mysql/getBackups:getBackups
  arguments:
    # arguments dictionary

The following arguments are supported:

BackupEndTime string: The end time of the backup.
BackupId string: The id of the backup.
BackupMethod string: Backup type, value: Physical: Physical backup. Default value. Logical: Logical backup. Description: There is no default value. When this field is not passed, backups of all states under the query conditions limited by other fields are returned.
BackupStartTime string: The start time of the backup.
BackupStatus string: Backup status, values: Success: Success. Failed: Failed. Running: In progress. Description: There is no default value. When this field is not passed, all backups in all states under the query conditions limited by other fields are returned.
BackupType string: Backup method, value: Full: Full backup under physical backup type or library table backup under logical backup type. Increment: Incremental backup under physical backup type. DumpAll: Full database backup under logical backup type. Description: There is no default value. When this field is not passed, all backups of all methods under the query conditions limited by other fields are returned.
CreateType string: Creator of backup. Values: System: System. User: User. Description: There is no default value. When this field is not passed, all types of backups under the query conditions limited by other fields are returned.
InstanceId string: The id of the instance.
OutputFile string: File name where to save data source results.

BackupEndTime string: The end time of the backup.
BackupId string: The id of the backup.
BackupMethod string: Backup type, value: Physical: Physical backup. Default value. Logical: Logical backup. Description: There is no default value. When this field is not passed, backups of all states under the query conditions limited by other fields are returned.
BackupStartTime string: The start time of the backup.
BackupStatus string: Backup status, values: Success: Success. Failed: Failed. Running: In progress. Description: There is no default value. When this field is not passed, all backups in all states under the query conditions limited by other fields are returned.
BackupType string: Backup method, value: Full: Full backup under physical backup type or library table backup under logical backup type. Increment: Incremental backup under physical backup type. DumpAll: Full database backup under logical backup type. Description: There is no default value. When this field is not passed, all backups of all methods under the query conditions limited by other fields are returned.
CreateType string: Creator of backup. Values: System: System. User: User. Description: There is no default value. When this field is not passed, all types of backups under the query conditions limited by other fields are returned.
InstanceId string: The id of the instance.
OutputFile string: File name where to save data source results.

backupEndTime String: The end time of the backup.
backupId String: The id of the backup.
backupMethod String: Backup type, value: Physical: Physical backup. Default value. Logical: Logical backup. Description: There is no default value. When this field is not passed, backups of all states under the query conditions limited by other fields are returned.
backupStartTime String: The start time of the backup.
backupStatus String: Backup status, values: Success: Success. Failed: Failed. Running: In progress. Description: There is no default value. When this field is not passed, all backups in all states under the query conditions limited by other fields are returned.
backupType String: Backup method, value: Full: Full backup under physical backup type or library table backup under logical backup type. Increment: Incremental backup under physical backup type. DumpAll: Full database backup under logical backup type. Description: There is no default value. When this field is not passed, all backups of all methods under the query conditions limited by other fields are returned.
createType String: Creator of backup. Values: System: System. User: User. Description: There is no default value. When this field is not passed, all types of backups under the query conditions limited by other fields are returned.
instanceId String: The id of the instance.
outputFile String: File name where to save data source results.

backupEndTime string: The end time of the backup.
backupId string: The id of the backup.
backupMethod string: Backup type, value: Physical: Physical backup. Default value. Logical: Logical backup. Description: There is no default value. When this field is not passed, backups of all states under the query conditions limited by other fields are returned.
backupStartTime string: The start time of the backup.
backupStatus string: Backup status, values: Success: Success. Failed: Failed. Running: In progress. Description: There is no default value. When this field is not passed, all backups in all states under the query conditions limited by other fields are returned.
backupType string: Backup method, value: Full: Full backup under physical backup type or library table backup under logical backup type. Increment: Incremental backup under physical backup type. DumpAll: Full database backup under logical backup type. Description: There is no default value. When this field is not passed, all backups of all methods under the query conditions limited by other fields are returned.
createType string: Creator of backup. Values: System: System. User: User. Description: There is no default value. When this field is not passed, all types of backups under the query conditions limited by other fields are returned.
instanceId string: The id of the instance.
outputFile string: File name where to save data source results.

backup_end_time str: The end time of the backup.
backup_id str: The id of the backup.
backup_method str: Backup type, value: Physical: Physical backup. Default value. Logical: Logical backup. Description: There is no default value. When this field is not passed, backups of all states under the query conditions limited by other fields are returned.
backup_start_time str: The start time of the backup.
backup_status str: Backup status, values: Success: Success. Failed: Failed. Running: In progress. Description: There is no default value. When this field is not passed, all backups in all states under the query conditions limited by other fields are returned.
backup_type str: Backup method, value: Full: Full backup under physical backup type or library table backup under logical backup type. Increment: Incremental backup under physical backup type. DumpAll: Full database backup under logical backup type. Description: There is no default value. When this field is not passed, all backups of all methods under the query conditions limited by other fields are returned.
create_type str: Creator of backup. Values: System: System. User: User. Description: There is no default value. When this field is not passed, all types of backups under the query conditions limited by other fields are returned.
instance_id str: The id of the instance.
output_file str: File name where to save data source results.

backupEndTime String: The end time of the backup.
backupId String: The id of the backup.
backupMethod String: Backup type, value: Physical: Physical backup. Default value. Logical: Logical backup. Description: There is no default value. When this field is not passed, backups of all states under the query conditions limited by other fields are returned.
backupStartTime String: The start time of the backup.
backupStatus String: Backup status, values: Success: Success. Failed: Failed. Running: In progress. Description: There is no default value. When this field is not passed, all backups in all states under the query conditions limited by other fields are returned.
backupType String: Backup method, value: Full: Full backup under physical backup type or library table backup under logical backup type. Increment: Incremental backup under physical backup type. DumpAll: Full database backup under logical backup type. Description: There is no default value. When this field is not passed, all backups of all methods under the query conditions limited by other fields are returned.
createType String: Creator of backup. Values: System: System. User: User. Description: There is no default value. When this field is not passed, all types of backups under the query conditions limited by other fields are returned.
instanceId String: The id of the instance.
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.
TotalCount int: The total count of query.
BackupEndTime string: The end time of backup, in the format of yyyy-MM-ddTHH:mm:ss.sssZ (UTC time).
BackupId string: The id of the backup.
BackupMethod string: Backup type, value: Physical: Physical backup. Logical: Logical backup.
BackupStartTime string: The start time of backup, in the format of yyyy-MM-ddTHH:mm:ss.sssZ (UTC time).
BackupStatus string: Backup status, values: Success. Failed. Running.
BackupType string: Backup method, values: Full: Full backup under physical backup type or library table backup under logical backup type. Increment: Incremental backup under physical backup type (created by the system). DumpAll: Full database backup under logical backup type. Description: There is no default value. When this field is not passed, all types of backups under the query conditions limited by other fields are returned.
CreateType string: Creator of backup. Values: System. User.
InstanceId string
OutputFile string

Backups []GetBackupsBackup: The collection of query.
Id string: The provider-assigned unique ID for this managed resource.
TotalCount int: The total count of query.
BackupEndTime string: The end time of backup, in the format of yyyy-MM-ddTHH:mm:ss.sssZ (UTC time).
BackupId string: The id of the backup.
BackupMethod string: Backup type, value: Physical: Physical backup. Logical: Logical backup.
BackupStartTime string: The start time of backup, in the format of yyyy-MM-ddTHH:mm:ss.sssZ (UTC time).
BackupStatus string: Backup status, values: Success. Failed. Running.
BackupType string: Backup method, values: Full: Full backup under physical backup type or library table backup under logical backup type. Increment: Incremental backup under physical backup type (created by the system). DumpAll: Full database backup under logical backup type. Description: There is no default value. When this field is not passed, all types of backups under the query conditions limited by other fields are returned.
CreateType string: Creator of backup. Values: System. User.
InstanceId string
OutputFile string

backups List<GetBackupsBackup>: The collection of query.
id String: The provider-assigned unique ID for this managed resource.
totalCount Integer: The total count of query.
backupEndTime String: The end time of backup, in the format of yyyy-MM-ddTHH:mm:ss.sssZ (UTC time).
backupId String: The id of the backup.
backupMethod String: Backup type, value: Physical: Physical backup. Logical: Logical backup.
backupStartTime String: The start time of backup, in the format of yyyy-MM-ddTHH:mm:ss.sssZ (UTC time).
backupStatus String: Backup status, values: Success. Failed. Running.
backupType String: Backup method, values: Full: Full backup under physical backup type or library table backup under logical backup type. Increment: Incremental backup under physical backup type (created by the system). DumpAll: Full database backup under logical backup type. Description: There is no default value. When this field is not passed, all types of backups under the query conditions limited by other fields are returned.
createType String: Creator of backup. Values: System. User.
instanceId String
outputFile String

backups GetBackupsBackup[]: The collection of query.
id string: The provider-assigned unique ID for this managed resource.
totalCount number: The total count of query.
backupEndTime string: The end time of backup, in the format of yyyy-MM-ddTHH:mm:ss.sssZ (UTC time).
backupId string: The id of the backup.
backupMethod string: Backup type, value: Physical: Physical backup. Logical: Logical backup.
backupStartTime string: The start time of backup, in the format of yyyy-MM-ddTHH:mm:ss.sssZ (UTC time).
backupStatus string: Backup status, values: Success. Failed. Running.
backupType string: Backup method, values: Full: Full backup under physical backup type or library table backup under logical backup type. Increment: Incremental backup under physical backup type (created by the system). DumpAll: Full database backup under logical backup type. Description: There is no default value. When this field is not passed, all types of backups under the query conditions limited by other fields are returned.
createType string: Creator of backup. Values: System. User.
instanceId string
outputFile string

backups Sequence[GetBackupsBackup]: The collection of query.
id str: The provider-assigned unique ID for this managed resource.
total_count int: The total count of query.
backup_end_time str: The end time of backup, in the format of yyyy-MM-ddTHH:mm:ss.sssZ (UTC time).
backup_id str: The id of the backup.
backup_method str: Backup type, value: Physical: Physical backup. Logical: Logical backup.
backup_start_time str: The start time of backup, in the format of yyyy-MM-ddTHH:mm:ss.sssZ (UTC time).
backup_status str: Backup status, values: Success. Failed. Running.
backup_type str: Backup method, values: Full: Full backup under physical backup type or library table backup under logical backup type. Increment: Incremental backup under physical backup type (created by the system). DumpAll: Full database backup under logical backup type. Description: There is no default value. When this field is not passed, all types of backups under the query conditions limited by other fields are returned.
create_type str: Creator of backup. Values: System. User.
instance_id str
output_file str

backups List<Property Map>: The collection of query.
id String: The provider-assigned unique ID for this managed resource.
totalCount Number: The total count of query.
backupEndTime String: The end time of backup, in the format of yyyy-MM-ddTHH:mm:ss.sssZ (UTC time).
backupId String: The id of the backup.
backupMethod String: Backup type, value: Physical: Physical backup. Logical: Logical backup.
backupStartTime String: The start time of backup, in the format of yyyy-MM-ddTHH:mm:ss.sssZ (UTC time).
backupStatus String: Backup status, values: Success. Failed. Running.
backupType String: Backup method, values: Full: Full backup under physical backup type or library table backup under logical backup type. Increment: Incremental backup under physical backup type (created by the system). DumpAll: Full database backup under logical backup type. Description: There is no default value. When this field is not passed, all types of backups under the query conditions limited by other fields are returned.
createType String: Creator of backup. Values: System. User.
instanceId String
outputFile String

Supporting Types

GetBackupsBackup

BackupEndTime string: The end time of the backup.
BackupFileName string: Backup file name.
BackupFileSize int: Backup file size, in bytes.
BackupId string: The id of the backup.
BackupMethod string: Backup type, value: Physical: Physical backup. Default value. Logical: Logical backup. Description: There is no default value. When this field is not passed, backups of all states under the query conditions limited by other fields are returned.
BackupRegion string: The region where the backup is located.
BackupStartTime string: The start time of the backup.
BackupStatus string: Backup status, values: Success: Success. Failed: Failed. Running: In progress. Description: There is no default value. When this field is not passed, all backups in all states under the query conditions limited by other fields are returned.
BackupType string: Backup method, value: Full: Full backup under physical backup type or library table backup under logical backup type. Increment: Incremental backup under physical backup type. DumpAll: Full database backup under logical backup type. Description: There is no default value. When this field is not passed, all backups of all methods under the query conditions limited by other fields are returned.
ConsistentTime string: The time point of a consistent snapshot is in the format of yyyy-MM-ddTHH:mm:ss.sssZ (UTC time).
CreateType string: Creator of backup. Values: System: System. User: User. Description: There is no default value. When this field is not passed, all types of backups under the query conditions limited by other fields are returned.
DbTableInfos List<GetBackupsBackupDbTableInfo>: The database table information contained in the backup set can include up to 10,000 tables. Explanation: When the database is empty, this field is not returned.
DecryptionKey string: The decryption key of the backup.
DownloadStatus string: Download status. Values: NotDownload: Not downloaded. Success: Downloaded. Failed: Download failed. Running: Downloading.
ErrorMessage string: Error message.
ExpiredTime string: Expired time of backup, in the format of yyyy-MM-ddTHH:mm:ss.sssZ (UTC time).
Id string: The id of the backup.
IsEncrypted bool: Is the data backup encrypted? Value: true: Encrypted. false: Not encrypted.
IsExpired bool: Whether the backup has expired. Value: true: Expired. false: Not expired.
Iv string: Initialization Vector.
UsageStats List<GetBackupsBackupUsageStat>: Statistics information about the storage space usage of backups.

BackupEndTime string: The end time of the backup.
BackupFileName string: Backup file name.
BackupFileSize int: Backup file size, in bytes.
BackupId string: The id of the backup.
BackupMethod string: Backup type, value: Physical: Physical backup. Default value. Logical: Logical backup. Description: There is no default value. When this field is not passed, backups of all states under the query conditions limited by other fields are returned.
BackupRegion string: The region where the backup is located.
BackupStartTime string: The start time of the backup.
BackupStatus string: Backup status, values: Success: Success. Failed: Failed. Running: In progress. Description: There is no default value. When this field is not passed, all backups in all states under the query conditions limited by other fields are returned.
BackupType string: Backup method, value: Full: Full backup under physical backup type or library table backup under logical backup type. Increment: Incremental backup under physical backup type. DumpAll: Full database backup under logical backup type. Description: There is no default value. When this field is not passed, all backups of all methods under the query conditions limited by other fields are returned.
ConsistentTime string: The time point of a consistent snapshot is in the format of yyyy-MM-ddTHH:mm:ss.sssZ (UTC time).
CreateType string: Creator of backup. Values: System: System. User: User. Description: There is no default value. When this field is not passed, all types of backups under the query conditions limited by other fields are returned.
DbTableInfos []GetBackupsBackupDbTableInfo: The database table information contained in the backup set can include up to 10,000 tables. Explanation: When the database is empty, this field is not returned.
DecryptionKey string: The decryption key of the backup.
DownloadStatus string: Download status. Values: NotDownload: Not downloaded. Success: Downloaded. Failed: Download failed. Running: Downloading.
ErrorMessage string: Error message.
ExpiredTime string: Expired time of backup, in the format of yyyy-MM-ddTHH:mm:ss.sssZ (UTC time).
Id string: The id of the backup.
IsEncrypted bool: Is the data backup encrypted? Value: true: Encrypted. false: Not encrypted.
IsExpired bool: Whether the backup has expired. Value: true: Expired. false: Not expired.
Iv string: Initialization Vector.
UsageStats []GetBackupsBackupUsageStat: Statistics information about the storage space usage of backups.

backupEndTime String: The end time of the backup.
backupFileName String: Backup file name.
backupFileSize Integer: Backup file size, in bytes.
backupId String: The id of the backup.
backupMethod String: Backup type, value: Physical: Physical backup. Default value. Logical: Logical backup. Description: There is no default value. When this field is not passed, backups of all states under the query conditions limited by other fields are returned.
backupRegion String: The region where the backup is located.
backupStartTime String: The start time of the backup.
backupStatus String: Backup status, values: Success: Success. Failed: Failed. Running: In progress. Description: There is no default value. When this field is not passed, all backups in all states under the query conditions limited by other fields are returned.
backupType String: Backup method, value: Full: Full backup under physical backup type or library table backup under logical backup type. Increment: Incremental backup under physical backup type. DumpAll: Full database backup under logical backup type. Description: There is no default value. When this field is not passed, all backups of all methods under the query conditions limited by other fields are returned.
consistentTime String: The time point of a consistent snapshot is in the format of yyyy-MM-ddTHH:mm:ss.sssZ (UTC time).
createType String: Creator of backup. Values: System: System. User: User. Description: There is no default value. When this field is not passed, all types of backups under the query conditions limited by other fields are returned.
dbTableInfos List<GetBackupsBackupDbTableInfo>: The database table information contained in the backup set can include up to 10,000 tables. Explanation: When the database is empty, this field is not returned.
decryptionKey String: The decryption key of the backup.
downloadStatus String: Download status. Values: NotDownload: Not downloaded. Success: Downloaded. Failed: Download failed. Running: Downloading.
errorMessage String: Error message.
expiredTime String: Expired time of backup, in the format of yyyy-MM-ddTHH:mm:ss.sssZ (UTC time).
id String: The id of the backup.
isEncrypted Boolean: Is the data backup encrypted? Value: true: Encrypted. false: Not encrypted.
isExpired Boolean: Whether the backup has expired. Value: true: Expired. false: Not expired.
iv String: Initialization Vector.
usageStats List<GetBackupsBackupUsageStat>: Statistics information about the storage space usage of backups.

backupEndTime string: The end time of the backup.
backupFileName string: Backup file name.
backupFileSize number: Backup file size, in bytes.
backupId string: The id of the backup.
backupMethod string: Backup type, value: Physical: Physical backup. Default value. Logical: Logical backup. Description: There is no default value. When this field is not passed, backups of all states under the query conditions limited by other fields are returned.
backupRegion string: The region where the backup is located.
backupStartTime string: The start time of the backup.
backupStatus string: Backup status, values: Success: Success. Failed: Failed. Running: In progress. Description: There is no default value. When this field is not passed, all backups in all states under the query conditions limited by other fields are returned.
backupType string: Backup method, value: Full: Full backup under physical backup type or library table backup under logical backup type. Increment: Incremental backup under physical backup type. DumpAll: Full database backup under logical backup type. Description: There is no default value. When this field is not passed, all backups of all methods under the query conditions limited by other fields are returned.
consistentTime string: The time point of a consistent snapshot is in the format of yyyy-MM-ddTHH:mm:ss.sssZ (UTC time).
createType string: Creator of backup. Values: System: System. User: User. Description: There is no default value. When this field is not passed, all types of backups under the query conditions limited by other fields are returned.
dbTableInfos GetBackupsBackupDbTableInfo[]: The database table information contained in the backup set can include up to 10,000 tables. Explanation: When the database is empty, this field is not returned.
decryptionKey string: The decryption key of the backup.
downloadStatus string: Download status. Values: NotDownload: Not downloaded. Success: Downloaded. Failed: Download failed. Running: Downloading.
errorMessage string: Error message.
expiredTime string: Expired time of backup, in the format of yyyy-MM-ddTHH:mm:ss.sssZ (UTC time).
id string: The id of the backup.
isEncrypted boolean: Is the data backup encrypted? Value: true: Encrypted. false: Not encrypted.
isExpired boolean: Whether the backup has expired. Value: true: Expired. false: Not expired.
iv string: Initialization Vector.
usageStats GetBackupsBackupUsageStat[]: Statistics information about the storage space usage of backups.

backup_end_time str: The end time of the backup.
backup_file_name str: Backup file name.
backup_file_size int: Backup file size, in bytes.
backup_id str: The id of the backup.
backup_method str: Backup type, value: Physical: Physical backup. Default value. Logical: Logical backup. Description: There is no default value. When this field is not passed, backups of all states under the query conditions limited by other fields are returned.
backup_region str: The region where the backup is located.
backup_start_time str: The start time of the backup.
backup_status str: Backup status, values: Success: Success. Failed: Failed. Running: In progress. Description: There is no default value. When this field is not passed, all backups in all states under the query conditions limited by other fields are returned.
backup_type str: Backup method, value: Full: Full backup under physical backup type or library table backup under logical backup type. Increment: Incremental backup under physical backup type. DumpAll: Full database backup under logical backup type. Description: There is no default value. When this field is not passed, all backups of all methods under the query conditions limited by other fields are returned.
consistent_time str: The time point of a consistent snapshot is in the format of yyyy-MM-ddTHH:mm:ss.sssZ (UTC time).
create_type str: Creator of backup. Values: System: System. User: User. Description: There is no default value. When this field is not passed, all types of backups under the query conditions limited by other fields are returned.
db_table_infos Sequence[GetBackupsBackupDbTableInfo]: The database table information contained in the backup set can include up to 10,000 tables. Explanation: When the database is empty, this field is not returned.
decryption_key str: The decryption key of the backup.
download_status str: Download status. Values: NotDownload: Not downloaded. Success: Downloaded. Failed: Download failed. Running: Downloading.
error_message str: Error message.
expired_time str: Expired time of backup, in the format of yyyy-MM-ddTHH:mm:ss.sssZ (UTC time).
id str: The id of the backup.
is_encrypted bool: Is the data backup encrypted? Value: true: Encrypted. false: Not encrypted.
is_expired bool: Whether the backup has expired. Value: true: Expired. false: Not expired.
iv str: Initialization Vector.
usage_stats Sequence[GetBackupsBackupUsageStat]: Statistics information about the storage space usage of backups.

backupEndTime String: The end time of the backup.
backupFileName String: Backup file name.
backupFileSize Number: Backup file size, in bytes.
backupId String: The id of the backup.
backupMethod String: Backup type, value: Physical: Physical backup. Default value. Logical: Logical backup. Description: There is no default value. When this field is not passed, backups of all states under the query conditions limited by other fields are returned.
backupRegion String: The region where the backup is located.
backupStartTime String: The start time of the backup.
backupStatus String: Backup status, values: Success: Success. Failed: Failed. Running: In progress. Description: There is no default value. When this field is not passed, all backups in all states under the query conditions limited by other fields are returned.
backupType String: Backup method, value: Full: Full backup under physical backup type or library table backup under logical backup type. Increment: Incremental backup under physical backup type. DumpAll: Full database backup under logical backup type. Description: There is no default value. When this field is not passed, all backups of all methods under the query conditions limited by other fields are returned.
consistentTime String: The time point of a consistent snapshot is in the format of yyyy-MM-ddTHH:mm:ss.sssZ (UTC time).
createType String: Creator of backup. Values: System: System. User: User. Description: There is no default value. When this field is not passed, all types of backups under the query conditions limited by other fields are returned.
dbTableInfos List<Property Map>: The database table information contained in the backup set can include up to 10,000 tables. Explanation: When the database is empty, this field is not returned.
decryptionKey String: The decryption key of the backup.
downloadStatus String: Download status. Values: NotDownload: Not downloaded. Success: Downloaded. Failed: Download failed. Running: Downloading.
errorMessage String: Error message.
expiredTime String: Expired time of backup, in the format of yyyy-MM-ddTHH:mm:ss.sssZ (UTC time).
id String: The id of the backup.
isEncrypted Boolean: Is the data backup encrypted? Value: true: Encrypted. false: Not encrypted.
isExpired Boolean: Whether the backup has expired. Value: true: Expired. false: Not expired.
iv String: Initialization Vector.
usageStats List<Property Map>: Statistics information about the storage space usage of backups.

GetBackupsBackupDbTableInfo

Database string: Database name.
Tables List<string>: Table names.

Database string: Database name.
Tables []string: Table names.

database String: Database name.
tables List<String>: Table names.

database string: Database name.
tables string[]: Table names.

database str: Database name.
tables Sequence[str]: Table names.

database String: Database name.
tables List<String>: Table names.

GetBackupsBackupUsageStat

Quantity int: Backup size, in bytes.
StartTime string: Statistical time.
StatItem string: Statistical items. TotalBasicSpaceUsage: Storage space usage for basic backups. BasicDataBackupUsage: Storage space usage for local data backups. BasicBinlogBackupUsage: Storage space usage for local log backups. TotalCrossRegionSpaceUsage: Storage space usage for cross-region backups. CrossRegionDataBackupUsage: Storage space usage for cross-region data backups. CrossRegionBinlogBackupUsage: Storage space usage for cross-region log backups.

Quantity int: Backup size, in bytes.
StartTime string: Statistical time.
StatItem string: Statistical items. TotalBasicSpaceUsage: Storage space usage for basic backups. BasicDataBackupUsage: Storage space usage for local data backups. BasicBinlogBackupUsage: Storage space usage for local log backups. TotalCrossRegionSpaceUsage: Storage space usage for cross-region backups. CrossRegionDataBackupUsage: Storage space usage for cross-region data backups. CrossRegionBinlogBackupUsage: Storage space usage for cross-region log backups.

quantity Integer: Backup size, in bytes.
startTime String: Statistical time.
statItem String: Statistical items. TotalBasicSpaceUsage: Storage space usage for basic backups. BasicDataBackupUsage: Storage space usage for local data backups. BasicBinlogBackupUsage: Storage space usage for local log backups. TotalCrossRegionSpaceUsage: Storage space usage for cross-region backups. CrossRegionDataBackupUsage: Storage space usage for cross-region data backups. CrossRegionBinlogBackupUsage: Storage space usage for cross-region log backups.

quantity number: Backup size, in bytes.
startTime string: Statistical time.
statItem string: Statistical items. TotalBasicSpaceUsage: Storage space usage for basic backups. BasicDataBackupUsage: Storage space usage for local data backups. BasicBinlogBackupUsage: Storage space usage for local log backups. TotalCrossRegionSpaceUsage: Storage space usage for cross-region backups. CrossRegionDataBackupUsage: Storage space usage for cross-region data backups. CrossRegionBinlogBackupUsage: Storage space usage for cross-region log backups.

quantity int: Backup size, in bytes.
start_time str: Statistical time.
stat_item str: Statistical items. TotalBasicSpaceUsage: Storage space usage for basic backups. BasicDataBackupUsage: Storage space usage for local data backups. BasicBinlogBackupUsage: Storage space usage for local log backups. TotalCrossRegionSpaceUsage: Storage space usage for cross-region backups. CrossRegionDataBackupUsage: Storage space usage for cross-region data backups. CrossRegionBinlogBackupUsage: Storage space usage for cross-region log backups.

quantity Number: Backup size, in bytes.
startTime String: Statistical time.
statItem String: Statistical items. TotalBasicSpaceUsage: Storage space usage for basic backups. BasicDataBackupUsage: Storage space usage for local data backups. BasicBinlogBackupUsage: Storage space usage for local log backups. TotalCrossRegionSpaceUsage: Storage space usage for cross-region backups. CrossRegionDataBackupUsage: Storage space usage for cross-region data backups. CrossRegionBinlogBackupUsage: Storage space usage for cross-region log backups.

Package Details

Repository: volcengine volcengine/pulumi-volcengine
License: Apache-2.0
Notes: This Pulumi package is based on the volcengine Terraform Provider.

Volcengine v0.0.38 published on Friday, Oct 31, 2025 by Volcengine

volcengine/pulumi-volcengine

volcengine.rds_mysql.getBackups

On this page

On this page

Example Usage

Using getBackups

getBackups Result

Supporting Types

GetBackupsBackup

GetBackupsBackupDbTableInfo

GetBackupsBackupUsageStat

Package Details

On this page

On this page