1. Packages
  2. Tencentcloud Provider
  3. API Docs
  4. getMysqlBackupOverview
tencentcloud 1.82.34 published on Wednesday, Nov 5, 2025 by tencentcloudstack
tencentcloudstack/terraform-provider-tencentcloud

tencentcloud.getMysqlBackupOverview

Start a Neo task
Explain and create a tencentcloud.getMysqlBackupOverview resource
tencentcloud logo
tencentcloud 1.82.34 published on Wednesday, Nov 5, 2025 by tencentcloudstack
tencentcloudstack/terraform-provider-tencentcloud

    Use this data source to query detailed information of mysql backup_overview

    Example Usage

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

const backupOverview = tencentcloud.getMysqlBackupOverview({
    product: "mysql",
});

    import pulumi
import pulumi_tencentcloud as tencentcloud

backup_overview = tencentcloud.get_mysql_backup_overview(product="mysql")

    package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/tencentcloud/tencentcloud"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := tencentcloud.GetMysqlBackupOverview(ctx, &tencentcloud.GetMysqlBackupOverviewArgs{
			Product: "mysql",
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var backupOverview = Tencentcloud.GetMysqlBackupOverview.Invoke(new()
    {
        Product = "mysql",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.tencentcloud.TencentcloudFunctions;
import com.pulumi.tencentcloud.inputs.GetMysqlBackupOverviewArgs;
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 backupOverview = TencentcloudFunctions.getMysqlBackupOverview(GetMysqlBackupOverviewArgs.builder()
            .product("mysql")
            .build());

    }
}

    variables:
  backupOverview:
    fn::invoke:
      function: tencentcloud:getMysqlBackupOverview
      arguments:
        product: mysql

    Using getMysqlBackupOverview

    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 getMysqlBackupOverview(args: GetMysqlBackupOverviewArgs, opts?: InvokeOptions): Promise<GetMysqlBackupOverviewResult>
function getMysqlBackupOverviewOutput(args: GetMysqlBackupOverviewOutputArgs, opts?: InvokeOptions): Output<GetMysqlBackupOverviewResult>
    def get_mysql_backup_overview(id: Optional[str] = None,
                              product: Optional[str] = None,
                              result_output_file: Optional[str] = None,
                              opts: Optional[InvokeOptions] = None) -> GetMysqlBackupOverviewResult
def get_mysql_backup_overview_output(id: Optional[pulumi.Input[str]] = None,
                              product: Optional[pulumi.Input[str]] = None,
                              result_output_file: Optional[pulumi.Input[str]] = None,
                              opts: Optional[InvokeOptions] = None) -> Output[GetMysqlBackupOverviewResult]
    func GetMysqlBackupOverview(ctx *Context, args *GetMysqlBackupOverviewArgs, opts ...InvokeOption) (*GetMysqlBackupOverviewResult, error)
func GetMysqlBackupOverviewOutput(ctx *Context, args *GetMysqlBackupOverviewOutputArgs, opts ...InvokeOption) GetMysqlBackupOverviewResultOutput

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

    public static class GetMysqlBackupOverview 
{
    public static Task<GetMysqlBackupOverviewResult> InvokeAsync(GetMysqlBackupOverviewArgs args, InvokeOptions? opts = null)
    public static Output<GetMysqlBackupOverviewResult> Invoke(GetMysqlBackupOverviewInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetMysqlBackupOverviewResult> getMysqlBackupOverview(GetMysqlBackupOverviewArgs args, InvokeOptions options)
public static Output<GetMysqlBackupOverviewResult> getMysqlBackupOverview(GetMysqlBackupOverviewArgs args, InvokeOptions options)

    fn::invoke:
  function: tencentcloud:index/getMysqlBackupOverview:getMysqlBackupOverview
  arguments:
    # arguments dictionary

    The following arguments are supported:

    Product string
    The type of cloud database product to be queried, currently only supports mysql.
    Id string
    ResultOutputFile string
    Used to save results.
    Product string
    The type of cloud database product to be queried, currently only supports mysql.
    Id string
    ResultOutputFile string
    Used to save results.
    product String
    The type of cloud database product to be queried, currently only supports mysql.
    id String
    resultOutputFile String
    Used to save results.
    product string
    The type of cloud database product to be queried, currently only supports mysql.
    id string
    resultOutputFile string
    Used to save results.
    product str
    The type of cloud database product to be queried, currently only supports mysql.
    id str
    result_output_file str
    Used to save results.
    product String
    The type of cloud database product to be queried, currently only supports mysql.
    id String
    resultOutputFile String
    Used to save results.

    getMysqlBackupOverview Result

    The following output properties are available:

    BackupArchiveVolume double
    Archive backup capacity, including data backup and log backup. Note: This field may return null, indicating that no valid value can be obtained.
    BackupCount double
    The total number of user backups in the current region (including data backups and log backups).
    BackupStandbyVolume double
    Standard storage backup capacity, including data backup and log backup. Note: This field may return null, indicating that no valid value can be obtained.
    BackupVolume double
    The total backup capacity of the user in the current region.
    BillingVolume double
    The billable capacity of the user&#39;s backup in the current region, that is, the part that exceeds the gifted capacity.
    FreeVolume double
    The free backup capacity obtained by the user in the current region.
    Id string
    Product string
    RemoteBackupVolume double
    The total capacity of off-site backup of the user in the current region. Note: This field may return null, indicating that no valid value can be obtained.
    ResultOutputFile string
    BackupArchiveVolume float64
    Archive backup capacity, including data backup and log backup. Note: This field may return null, indicating that no valid value can be obtained.
    BackupCount float64
    The total number of user backups in the current region (including data backups and log backups).
    BackupStandbyVolume float64
    Standard storage backup capacity, including data backup and log backup. Note: This field may return null, indicating that no valid value can be obtained.
    BackupVolume float64
    The total backup capacity of the user in the current region.
    BillingVolume float64
    The billable capacity of the user&#39;s backup in the current region, that is, the part that exceeds the gifted capacity.
    FreeVolume float64
    The free backup capacity obtained by the user in the current region.
    Id string
    Product string
    RemoteBackupVolume float64
    The total capacity of off-site backup of the user in the current region. Note: This field may return null, indicating that no valid value can be obtained.
    ResultOutputFile string
    backupArchiveVolume Double
    Archive backup capacity, including data backup and log backup. Note: This field may return null, indicating that no valid value can be obtained.
    backupCount Double
    The total number of user backups in the current region (including data backups and log backups).
    backupStandbyVolume Double
    Standard storage backup capacity, including data backup and log backup. Note: This field may return null, indicating that no valid value can be obtained.
    backupVolume Double
    The total backup capacity of the user in the current region.
    billingVolume Double
    The billable capacity of the user&#39;s backup in the current region, that is, the part that exceeds the gifted capacity.
    freeVolume Double
    The free backup capacity obtained by the user in the current region.
    id String
    product String
    remoteBackupVolume Double
    The total capacity of off-site backup of the user in the current region. Note: This field may return null, indicating that no valid value can be obtained.
    resultOutputFile String
    backupArchiveVolume number
    Archive backup capacity, including data backup and log backup. Note: This field may return null, indicating that no valid value can be obtained.
    backupCount number
    The total number of user backups in the current region (including data backups and log backups).
    backupStandbyVolume number
    Standard storage backup capacity, including data backup and log backup. Note: This field may return null, indicating that no valid value can be obtained.
    backupVolume number
    The total backup capacity of the user in the current region.
    billingVolume number
    The billable capacity of the user&#39;s backup in the current region, that is, the part that exceeds the gifted capacity.
    freeVolume number
    The free backup capacity obtained by the user in the current region.
    id string
    product string
    remoteBackupVolume number
    The total capacity of off-site backup of the user in the current region. Note: This field may return null, indicating that no valid value can be obtained.
    resultOutputFile string
    backup_archive_volume float
    Archive backup capacity, including data backup and log backup. Note: This field may return null, indicating that no valid value can be obtained.
    backup_count float
    The total number of user backups in the current region (including data backups and log backups).
    backup_standby_volume float
    Standard storage backup capacity, including data backup and log backup. Note: This field may return null, indicating that no valid value can be obtained.
    backup_volume float
    The total backup capacity of the user in the current region.
    billing_volume float
    The billable capacity of the user&#39;s backup in the current region, that is, the part that exceeds the gifted capacity.
    free_volume float
    The free backup capacity obtained by the user in the current region.
    id str
    product str
    remote_backup_volume float
    The total capacity of off-site backup of the user in the current region. Note: This field may return null, indicating that no valid value can be obtained.
    result_output_file str
    backupArchiveVolume Number
    Archive backup capacity, including data backup and log backup. Note: This field may return null, indicating that no valid value can be obtained.
    backupCount Number
    The total number of user backups in the current region (including data backups and log backups).
    backupStandbyVolume Number
    Standard storage backup capacity, including data backup and log backup. Note: This field may return null, indicating that no valid value can be obtained.
    backupVolume Number
    The total backup capacity of the user in the current region.
    billingVolume Number
    The billable capacity of the user&#39;s backup in the current region, that is, the part that exceeds the gifted capacity.
    freeVolume Number
    The free backup capacity obtained by the user in the current region.
    id String
    product String
    remoteBackupVolume Number
    The total capacity of off-site backup of the user in the current region. Note: This field may return null, indicating that no valid value can be obtained.
    resultOutputFile String

    Package Details

    Repository
    tencentcloud tencentcloudstack/terraform-provider-tencentcloud
    License
    Notes
    This Pulumi package is based on the tencentcloud Terraform Provider.
    tencentcloud logo
    tencentcloud 1.82.34 published on Wednesday, Nov 5, 2025 by tencentcloudstack
    tencentcloudstack/terraform-provider-tencentcloud
      Meet Neo: Your AI Platform Teammate