ACS::HBR::RestoreHanaDatabaseBackup.json

{
  "FormatVersion": "OOS-2019-06-01",
  "Description": {
    "name-en": "ACS::HBR::RestoreHanaDatabaseBackup",
    "name-zh-cn": "将源实例数据库的备份恢复到测试实例，并检查恢复状态",
    "en": "Restore a backup of the source instance database to the test instance, and check the recovery status",
    "zh-cn": "将源实例数据库的备份恢复到测试实例，并检查恢复状态"
  },
  "Parameters": {
    "vaultId": {
      "Description": {
        "en": "Backup vault ID",
        "zh-cn": "备份库ID"
      },
      "Type": "String"
    },
    "sourceClusterId": {
      "Description": {
        "en": "Source HANA instance ID, can be found in the Hybrid Backup Recovery Console - ECS Application Backup - Instance Name/ID",
        "zh-cn": "源HANA实例ID，可以在混合备份恢复控制台中找到- ECS应用程序备份-实例名称/ID"
      },
      "Type": "String"
    },
    "clusterId": {
      "Description": {
        "en": "Destination HANA instance ID, can be found in the Hybrid Backup Recovery Console - ECS Application Backup - Instance Name/ID",
        "zh-cn": "目标HANA实例ID，可以在混合备份恢复控制台中找到- ECS应用程序备份-实例名称/ID"
      },
      "Type": "String"
    },
    "masterClientId": {
      "Description": {
        "en": "Destination HANA instance client ID",
        "zh-cn": "目的HANA实例客户端ID"
      },
      "Type": "String"
    },
    "databaseName": {
      "Description": {
        "en": "Database name",
        "zh-cn": "数据库名称"
      },
      "Type": "String"
    },
    "HANASID": {
      "ConstraintDescription": "3 characters,can including capital letter or number, must starting with capital letter",
      "Description": {
        "en": "HANA system Id",
        "zh-cn": "HANA系统Id"
      },
      "Type": "String",
      "AllowedPattern": "^[A-Z][A-Z0-9][A-Z0-9]$"
    },
    "sourceSystemName": {
      "Description": {
        "en": "Please input source name in format of \"<Source SAP HANA database name>@<Source SAP HANA system Id>\". E.g, DB1@SID.",
        "zh-cn": "请输入源名称格式为\"<源SAP HANA数据库名称>@<源SAP HANA系统Id>\"。例如,DB1@SID。"
      },
      "Type": "String"
    },
    "HANAInstanceServerId": {
      "Description": {
        "en": "Destination HANA instance ECS ID",
        "zh-cn": "目标HANAECS实例ID"
      },
      "Type": "String"
    }
  },
  "Tasks": [
    {
      "Name": "updateHanaBackupSetting",
      "Action": "ACS::ExecuteAPI",
      "Description": {
        "en": "Update HANA database backup settings",
        "zh-cn": "更新HANA数据库备份设置"
      },
      "Properties": {
        "Service": "HBR",
        "API": "UpdateHanaBackupSetting",
        "Parameters": {
          "VaultId": "{{ vaultId }}",
          "ClusterId": "{{ clusterId }}",
          "DatabaseName": "{{ databaseName }}",
          "EnableAutoLogBackup": true,
          "CatalogBackupUsingBackint": true,
          "DataBackupParameterFile": "",
          "LogBackupParameterFile": "",
          "CatalogBackupParameterFile": "",
          "LogBackupUsingBackint": true,
          "LogBackupTimeout": 900
        }
      }
    },
    {
      "Name": "describeHanaBackupSetting",
      "Action": "ACS::WaitFor",
      "Description": {
        "en": "Wait for setting HANA database backup",
        "zh-cn": "等待HANA数据库备份"
      },
      "Properties": {
        "Service": "HBR",
        "API": "DescribeHanaBackupSetting",
        "Parameters": {
          "VaultId": "{{ vaultId }}",
          "ClusterId": "{{ clusterId }}",
          "DatabaseName": "{{ databaseName }}"
        },
        "PropertySelector": "HanaBackupSetting.CatalogBackupUsingBackint",
        "StopRetryValues": [
          true
        ],
        "DesiredValues": [
          true
        ]
      },
      "Retries": 5
    },
    {
      "Name": "getHanaBackupId",
      "Action": "ACS::ExecuteAPI",
      "Description": {
        "en": "Get ID of the last backup",
        "zh-cn": "获取最后一个备份的ID"
      },
      "Properties": {
        "Service": "HBR",
        "API": "DescribeHanaBackupsAsync",
        "Parameters": {
          "VaultId": "{{ vaultId }}",
          "ClusterId": "{{ clusterId }}",
          "Mode": "RECOVERY_TO_MOST_RECENT",
          "PageSize": 10,
          "PageNumber": 1,
          "LogPosition": 0,
          "VolumeId": 0,
          "SystemCopy": true,
          "DatabaseName": "{{ databaseName }}",
          "SourceClusterId": "{{ sourceClusterId }}",
          "Source": "{{ sourceSystemName }}"
        }
      },
      "Outputs": {
        "TaskId": {
          "Type": "String",
          "ValueSelector": "TaskId"
        }
      }
    },
    {
      "Name": "waitForDescribeHanaBackups",
      "Action": "ACS::WaitFor",
      "Description": {
        "en": "Get ID of the last backup",
        "zh-cn": "获取最后一个备份的ID"
      },
      "DelayType": "Constant",
      "Delay": 5,
      "Retries": 20,
      "Properties": {
        "Service": "HBR",
        "API": "DescribeTask",
        "Parameters": {
          "TaskId": "{{ getHanaBackupId.TaskId }}"
        },
        "PropertySelector": "Description",
        "StopRetryValues": [
          "completed",
          "HanaSqlError"
        ],
        "DesiredValues": [
          "completed"
        ]
      },
      "Outputs": {
        "Result": {
          "Type": "Json",
          "ValueSelector": "Result"
        }
      }
    },
    {
      "Name": "startToRestoreBackup",
      "Action": "ACS::ExecuteAPI",
      "Description": {
        "en": "Start to restore backup",
        "zh-cn": "开始恢复备份"
      },
      "Properties": {
        "Service": "HBR",
        "API": "CreateHanaRestore",
        "Parameters": {
          "VaultId": "{{ vaultId }}",
          "ClusterId": "{{ clusterId }}",
          "Mode": "RECOVERY_TO_MOST_RECENT",
          "DatabaseName": "{{ databaseName }}",
          "BackupId": {
            "Fn::Jq": [
              "First",
              ".HanaBackups[].BackupId | tostring",
              "{{ waitForDescribeHanaBackups.Result }}"
            ]
          },
          "ClearLog": true,
          "UseDelta": true,
          "UseCatalog": true,
          "BackupPrefix": "",
          "LogPosition": 0,
          "VolumeId": 0,
          "SidAdmin": {
            "Fn::Join": [
              "",
              [
                {
                  "Fn::Jq": [
                    "First",
                    ".key | ascii_downcase",
                    {
                      "key": "{{ HANASID }}"
                    }
                  ]
                },
                "adm"
              ]
            ]
          },
          "CheckAccess": true,
          "SystemCopy": true,
          "SourceClusterId": "{{ sourceClusterId }}",
          "Source": "{{ sourceSystemName }}",
          "MasterClientId": "{{ masterClientId }}"
        }
      },
      "Outputs": {
        "RestoreId": {
          "Type": "String",
          "ValueSelector": "RestoreId"
        },
        "BackupId": {
          "Type": "Number",
          "ValueSelector": {
            "Fn::Jq": [
              "First",
              ".HanaBackups[].BackupId | tostring",
              "{{ waitForDescribeHanaBackups.Result }}"
            ]
          }
        }
      }
    },
    {
      "Name": "waitForRestoreBackup",
      "Action": "ACS::WaitFor",
      "Description": {
        "en": "Wait for restoring backup",
        "zh-cn": "等待恢复备份"
      },
      "Retries": 300,
      "Delay": 120,
      "DelayType": "Constant",
      "Properties": {
        "Service": "HBR",
        "API": "DescribeHanaRestores",
        "Parameters": {
          "VaultId": "{{ vaultId }}",
          "ClusterId": "{{ clusterId }}",
          "RestoreId": "{{ startToRestoreBackup.RestoreId }}"
        },
        "PropertySelector": "HanaRestore.HanaRestores[0].Status",
        "StopRetryValues": [
          "COMPLETE",
          "FAILED"
        ],
        "DesiredValues": [
          "COMPLETE"
        ]
      }
    }
  ]
}