Todos os produtos
Search
Central de documentação

Resource Orchestration Service:DATASOURCE::DBS::BackupPlan

Última atualização: Jun 27, 2026

O DATASOURCE::DBS::BackupPlan consulta os detalhes de uma programação de backup do DBS.

Sintaxe

{
  "Type": "DATASOURCE::DBS::BackupPlan",
  "Properties": {
    "BackupPlanId": String,
    "RefreshOptions": String
  }
}

Propriedades

Propriedade

Tipo

Obrigatória

Editável

Descrição

Restrição

BackupPlanId

String

Sim

Sim

ID da programação de backup.

Nenhuma.

RefreshOptions

String

Não

Sim

Política de atualização dos recursos de source durante atualizações da pilha.

Valores válidos:

  • Never (padrão): não atualiza os recursos de source durante atualizações da pilha.

  • Always: atualiza os recursos de source durante atualizações da pilha.

Valores de retorno

Fn::GetAtt

  • BackupPlanName: nome da programação de backup.

  • BackupObjects: objetos de backup.

  • ResourceGroupId: ID do grupo de recursos.

  • DatabaseType: tipo do mecanismo de banco de dados.

  • CrossAliyunId: UID da conta usada para backups entre contas.

  • SourceEndpointDatabaseName: nome do banco de dados.

  • SourceEndpointRegion: região do banco de dados.

  • PaymentType: método de faturamento.

  • BackupPlanId: ID da programação de backup.

  • BackupGatewayId: ID do gateway de backup.

  • SourceEndpointInstanceType: localização do banco de dados.

  • SourceEndpointUserName: conta do banco de dados.

  • BackupStorageType: tipo de armazenamento integrado.

  • CrossRoleName: nome da função RAM usada para backups entre contas.

  • DuplicationInfrequentAccessPeriod: número de dias antes da transição dos dados de backup para o armazenamento de Acesso Pouco Frequente (IA).

  • BackupMethod: método de backup.

  • BackupPeriod: ciclo de backup completo.

  • CreateTime: hora de criação da programação de backup.

  • SourceEndpointInstanceId: ID da instância de banco de dados.

  • InstanceClass: tipo da programação de backup.

  • SourceEndpointSid: ID do sistema (SID) da instância de banco de dados.

  • DuplicationArchivePeriod: número de dias antes da transição dos dados de backup para o armazenamento Arquivo.

  • BackupStartTime: hora de início do backup completo.

  • EnableBackupLog: indica se o backup incremental de log está ativado.

  • OssBucketName: nome do bucket OSS.

  • BackupRetentionPeriod: período de retenção dos dados de backup.

Exemplos

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  BackupPlanId:
    Type: String
    Description:
      en: The ID of the backup plan.
    Required: true
Resources:
  ExtensionDataSource:
    Type: DATASOURCE::DBS::BackupPlan
    Properties:
      BackupPlanId:
        Ref: BackupPlanId
Outputs:
  BackupPlanName:
    Description: The name of the backup plan.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - BackupPlanName
  BackupObjects:
    Description: The backup object.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - BackupObjects
  ResourceGroupId:
    Description: The ID of the resource group.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - ResourceGroupId
  DatabaseType:
    Description: Database type.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - DatabaseType
  CrossAliyunId:
    Description: The UID that is backed up across Alibaba Cloud accounts.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - CrossAliyunId
  SourceEndpointDatabaseName:
    Description: The name of the database.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - SourceEndpointDatabaseName
  SourceEndpointRegion:
    Description: The region of the database.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - SourceEndpointRegion
  PaymentType:
    Description: The billing method of the resource.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - PaymentType
  BackupPlanId:
    Description: The ID of the backup plan.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - BackupPlanId
  BackupGatewayId:
    Description: The ID of the backup gateway.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - BackupGatewayId
  SourceEndpointInstanceType:
    Description: The location of the database.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - SourceEndpointInstanceType
  SourceEndpointUserName:
    Description: Database account.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - SourceEndpointUserName
  BackupStorageType:
    Description: Built-in storage class.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - BackupStorageType
  CrossRoleName:
    Description: The name of the RAM role that is backed up across Alibaba Cloud accounts.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - CrossRoleName
  DuplicationInfrequentAccessPeriod:
    Description: The storage time is converted to low-frequency access. The default time is 180 days.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - DuplicationInfrequentAccessPeriod
  BackupMethod:
    Description: Backup method.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - BackupMethod
  BackupPeriod:
    Description: Full backup cycle.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - BackupPeriod
  CreateTime:
    Description: The creation time of the backup plans.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - CreateTime
  SourceEndpointInstanceId:
    Description: The ID of the database instance.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - SourceEndpointInstanceId
  InstanceClass:
    Description: Instance class.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - InstanceClass
  SourceEndpointSid:
    Description: Oracle SID name.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - SourceEndpointSid
  DuplicationArchivePeriod:
    Description: The storage time for conversion to archive cold standby is 365 days by default.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - DuplicationArchivePeriod
  BackupStartTime:
    Description: The start time of full backup.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - BackupStartTime
  EnableBackupLog:
    Description: Whether to enable incremental log backup.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - EnableBackupLog
  OssBucketName:
    Description: OSS Bucket name.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - OssBucketName
  BackupRetentionPeriod:
    Description: The retention period of backup data. Valid values: 0 to 1825. Default value: 730 days.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - BackupRetentionPeriod
{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "BackupPlanId": {
      "Type": "String",
      "Description": {
        "en": "The ID of the backup plan."
      },
      "Required": true
    }
  },
  "Resources": {
    "ExtensionDataSource": {
      "Type": "DATASOURCE::DBS::BackupPlan",
      "Properties": {
        "BackupPlanId": {
          "Ref": "BackupPlanId"
        }
      }
    }
  },
  "Outputs": {
    "BackupPlanName": {
      "Description": "The name of the backup plan.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "BackupPlanName"
        ]
      }
    },
    "BackupObjects": {
      "Description": "The backup object.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "BackupObjects"
        ]
      }
    },
    "ResourceGroupId": {
      "Description": "The ID of the resource group.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "ResourceGroupId"
        ]
      }
    },
    "DatabaseType": {
      "Description": "Database type.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "DatabaseType"
        ]
      }
    },
    "CrossAliyunId": {
      "Description": "The UID that is backed up across Alibaba Cloud accounts.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "CrossAliyunId"
        ]
      }
    },
    "SourceEndpointDatabaseName": {
      "Description": "The name of the database.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "SourceEndpointDatabaseName"
        ]
      }
    },
    "SourceEndpointRegion": {
      "Description": "The region of the database.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "SourceEndpointRegion"
        ]
      }
    },
    "PaymentType": {
      "Description": "The billing method of the resource.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "PaymentType"
        ]
      }
    },
    "BackupPlanId": {
      "Description": "The ID of the backup plan.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "BackupPlanId"
        ]
      }
    },
    "BackupGatewayId": {
      "Description": "The ID of the backup gateway.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "BackupGatewayId"
        ]
      }
    },
    "SourceEndpointInstanceType": {
      "Description": "The location of the database.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "SourceEndpointInstanceType"
        ]
      }
    },
    "SourceEndpointUserName": {
      "Description": "Database account.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "SourceEndpointUserName"
        ]
      }
    },
    "BackupStorageType": {
      "Description": "Built-in storage class.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "BackupStorageType"
        ]
      }
    },
    "CrossRoleName": {
      "Description": "The name of the RAM role that is backed up across Alibaba Cloud accounts.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "CrossRoleName"
        ]
      }
    },
    "DuplicationInfrequentAccessPeriod": {
      "Description": "The storage time is converted to low-frequency access. The default time is 180 days.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "DuplicationInfrequentAccessPeriod"
        ]
      }
    },
    "BackupMethod": {
      "Description": "Backup method.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "BackupMethod"
        ]
      }
    },
    "BackupPeriod": {
      "Description": "Full backup cycle.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "BackupPeriod"
        ]
      }
    },
    "CreateTime": {
      "Description": "The creation time of the backup plans.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "CreateTime"
        ]
      }
    },
    "SourceEndpointInstanceId": {
      "Description": "The ID of the database instance.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "SourceEndpointInstanceId"
        ]
      }
    },
    "InstanceClass": {
      "Description": "Instance class.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "InstanceClass"
        ]
      }
    },
    "SourceEndpointSid": {
      "Description": "Oracle SID name.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "SourceEndpointSid"
        ]
      }
    },
    "DuplicationArchivePeriod": {
      "Description": "The storage time for conversion to archive cold standby is 365 days by default.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "DuplicationArchivePeriod"
        ]
      }
    },
    "BackupStartTime": {
      "Description": "The start time of full backup.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "BackupStartTime"
        ]
      }
    },
    "EnableBackupLog": {
      "Description": "Whether to enable incremental log backup.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "EnableBackupLog"
        ]
      }
    },
    "OssBucketName": {
      "Description": "OSS Bucket name.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "OssBucketName"
        ]
      }
    },
    "BackupRetentionPeriod": {
      "Description": "The retention period of backup data. Valid values: 0 to 1825. Default value: 730 days.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "BackupRetentionPeriod"
        ]
      }
    }
  }
}