全部產品
Search

搜尋本產品

    ：DATASOURCE::DBS::BackupPlans

    文件中心

    ：DATASOURCE::DBS::BackupPlans

    更新時間：Sep 30, 2024

    DATASOURCE::DBS::BackupPlans類型用於查詢備份計劃列表資訊。

    文法

    {
  "Type": "DATASOURCE::DBS::BackupPlans",
  "Properties": {
    "BackupPlanName": String,
    "ResourceGroupId": String,
    "BackupPlanId": String,
    "RefreshOptions": String
  }
}

    屬性

    屬性名稱

    類型

    必須

    允許更新

    描述

    約束

    BackupPlanName

    String

    否

    是

    備份計劃名稱。

    無

    ResourceGroupId

    String

    否

    是

    資源群組ID。

    無

    BackupPlanId

    String

    否

    是

    備份計劃ID。

    無

    RefreshOptions

    String

    否

    是

    當資源棧更新時，資料來源資源的重新整理策略。

    取值：

    • Never（預設值）：更新堆棧時，從不重新整理資料來源資源。

    • Always：更新堆棧時，始終重新整理資料來源資源。

    傳回值

    Fn::GetAtt

    • BackupPlanIds：備份計劃ID列表。

    • BackupPlans：備份計劃詳情列表。

    屬性名稱

    類型

    描述

    約束

    BackupPlanIds

    List

    備份計劃ID列表。

    無

    BackupPlans

    List

    備份計劃詳情列表。

    無

    SourceEndpointUserName

    String

    資料庫帳號。

    無

    BackupObjects

    String

    備份對象。

    無

    EnableBackupLog

    String

    是否開啟增量記錄備份。

    無

    DuplicationArchivePeriod

    String

    轉為歸檔冷備儲存時間。

    無

    CrossAliyunId

    String

    跨阿里雲帳號備份的UID。

    無

    BackupStorageType

    String

    內建儲存類型。

    無

    SourceEndpointInstanceId

    String

    資料庫執行個體ID。

    無

    BackupPlanId

    String

    備份計劃ID。

    無

    Status

    String

    備份計劃狀態。

    無

    OssBucketName

    String

    OSS Bucket名稱。

    無

    SourceEndpointDatabaseName

    String

    資料庫名稱。

    無

    ResourceGroupId

    String

    資源群組ID。

    無

    InstanceClass

    String

    規格。

    無

    SourceEndpointRegion

    String

    資料庫地區。

    無

    CrossRoleName

    String

    跨阿里雲帳號備份的RAM角色名稱。

    無

    BackupRetentionPeriod

    String

    備份資料保留時間。

    取值範圍：0~1825。

    單位：天。

    BackupMethod

    String

    備份方式。

    無

    BackupPeriod

    String

    全量備份周期。

    無

    BackupGatewayId

    String

    備份網關ID。

    無

    SourceEndpointSid

    String

    資料庫執行個體SID名稱。

    無

    DuplicationInfrequentAccessPeriod

    String

    轉為低頻訪問儲存時間。

    單位：天。

    SourceEndpointInstanceType

    String

    資料庫所在位置。

    無

    BackupStartTime

    String

    全量備份開始時間。

    格式為HH:mm。

    DatabaseType

    String

    資料庫類型。

    無

    BackupPlanName

    String

    備份計劃名稱。

    無

    CreateTime

    String

    備份計劃建立時間戳記。

    無

    樣本

    YAML格式

    ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  BackupPlanName:
    Description: The name of the backup schedule.
    Type: String
Resources:
  ExtensionDataSource:
    Properties:
      BackupPlanName:
        Ref: BackupPlanName
    Type: DATASOURCE::DBS::BackupPlans
Outputs:
  BackupPlanIds:
    Description: The list of backup plan IDs.
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - BackupPlanIds
  BackupPlans:
    Description: The list of backup plans.
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - BackupPlans

    JSON格式 

    {
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "BackupPlanName": {
      "Type": "String",
      "Description": "The name of the backup schedule."
    }
  },
  "Resources": {
    "ExtensionDataSource": {
      "Type": "DATASOURCE::DBS::BackupPlans",
      "Properties": {
        "BackupPlanName": {
          "Ref": "BackupPlanName"
        }
      }
    }
  },
  "Outputs": {
    "BackupPlanIds": {
      "Description": "The list of backup plan IDs.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "BackupPlanIds"
        ]
      }
    },
    "BackupPlans": {
      "Description": "The list of backup plans.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "BackupPlans"
        ]
      }
    }
  }
}