'1.0', 'info' => ['style' => 'RPC', 'product' => 'hbr', 'version' => '2017-09-08'], 'directories' => [ [ 'children' => ['CreateVault', 'DescribeVaults'], 'type' => 'directory', 'title' => 'Backup vault', ], [ 'children' => ['CreateBackupPlan', 'DeleteBackupPlan', 'DisableBackupPlan', 'EnableBackupPlan', 'UpdateBackupPlan', 'DescribeBackupPlans', 'ExecuteBackupPlan'], 'type' => 'directory', 'title' => 'Backup plan', ], [ 'children' => ['CreatePolicyV2', 'DeletePolicyV2', 'UpdatePolicyV2', 'DescribePoliciesV2', 'CreatePolicyBindings', 'DeletePolicyBinding', 'UpdatePolicyBinding', 'DescribePolicyBindings'], 'type' => 'directory', 'title' => 'Backup policy', ], [ 'children' => ['DeleteBackupClient', 'DeleteBackupClientResource', 'UpdateClientSettings', 'InstallBackupClients'], 'type' => 'directory', 'title' => 'Backup client', ], [ 'children' => ['SearchHistoricalSnapshots', 'DescribeUdmSnapshots'], 'type' => 'directory', 'title' => 'Backup snapshot', ], [ 'children' => ['CancelRestoreJob', 'DescribeRestoreJobs2'], 'type' => 'directory', 'title' => 'Restore job', ], [ 'children' => ['CancelBackupJob', 'DescribeBackupJobs2'], 'type' => 'directory', 'title' => 'Backup job', ], [ 'children' => ['DeleteClient', 'UpgradeClient', 'DescribeHanaBackupPlans'], 'type' => 'directory', 'title' => 'SAP HANA backup', ], [ 'children' => ['DescribeContainerResource', 'DeleteContainerCluster', 'DescribeContainerCluster'], 'type' => 'directory', 'title' => 'Container backup', ], [ 'children' => [ 'OpenHbrService', 'DetachNasFileSystem', 'DescribeCrossAccounts', 'AddCrossAccount', 'BrowseFiles', 'CreateVaultReplication', 'DeleteCrossAccount', 'DeleteVaultReplication', 'DescribeDataSources', 'GetBasicStatistics', 'ListProtectedResources', 'RemoveDataSource', 'AddContainerCluster', 'AddDataSource', 'ChangeResourceGroup', 'CheckRole', 'CreateBackupJob', 'CreateClients', 'CreateHanaBackupPlan', 'CreateHanaInstance', 'CreateHanaRestore', 'CreateReplicationVault', 'CreateRestoreJob', 'CreateTempFileUploadUrl', 'DeleteAirEcsInstance', 'DeleteHanaBackupPlan', 'DeleteHanaInstance', 'DeleteSnapshot', 'DeleteUdmDisk', 'DeleteUdmEcsInstance', 'DeleteVault', 'DescribeBackupClients', 'DescribeClients', 'DescribeHanaBackupSetting', 'DescribeHanaBackupsAsync', 'DescribeHanaDatabases', 'DescribeHanaInstances', 'DescribeHanaRestores', 'DescribeHanaRetentionSetting', 'DescribeOtsTableSnapshots', 'DescribeRecoverableOtsInstances', 'DescribeRegions', 'DescribeTask', 'DescribeVaultReplicationRegions', 'DisableHanaBackupPlan', 'EnableHanaBackupPlan', 'ExecutePolicyV2', 'GenerateRamPolicy', 'GetTempFileDownloadLink', 'StartHanaDatabaseAsync', 'StopHanaDatabaseAsync', 'UninstallBackupClients', 'UninstallClient', 'UpdateContainerCluster', 'UpdateDataSource', 'UpdateHanaBackupPlan', 'UpdateHanaBackupSetting', 'UpdateHanaInstance', 'UpdateHanaRetentionSetting', 'UpdateVault', 'UpgradeBackupClients', ], 'type' => 'directory', 'title' => 'Others', ], ], 'components' => [ 'schemas' => [ 'OtsDetail' => [ 'title' => 'A short description of struct', 'description' => 'The names of the Tablestore tables.'."\n", 'visibility' => 'Public', 'type' => 'object', 'properties' => [ 'TableNames' => [ 'title' => 'OTS table name list', 'description' => 'public', 'visibility' => 'Public', 'type' => 'array', 'items' => ['description' => 'The name of the Tablestore table.', 'visibility' => 'Public', 'type' => 'string', 'example' => '["table1", "table2", "table3"]', 'extendType' => 'true'], 'backendName' => 'tableNames', ], ], ], 'OtsTableRestoreDetail' => [ 'title' => 'A short description of struct', 'description' => 'The information about the restoration of the Tablestore instance.'."\n", 'visibility' => 'Public', 'type' => 'object', 'properties' => [ 'OverwriteExisting' => ['title' => 'Overwrite existing table or not', 'description' => 'Specifies whether to overwrite existing tables.'."\n", 'visibility' => 'Public', 'type' => 'boolean', 'example' => 'true', 'backendName' => 'overwriteExisting'], 'RestoreIndex' => ['title' => 'Restore index or not', 'description' => 'Specifies whether to restore indexes.'."\n", 'visibility' => 'Public', 'type' => 'boolean', 'example' => 'true', 'backendName' => 'restoreIndex'], 'IndexNameSuffix' => ['title' => 'Specify a suffix to restored index name', 'description' => 'The name prefixes of the indexes that you want to restore.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => '2022xxxx143933', 'backendName' => 'indexNameSuffix'], 'RestoreSearchIndex' => ['title' => 'Restore search index or not', 'description' => 'Specifies whether to restore search indexes.'."\n", 'visibility' => 'Public', 'type' => 'boolean', 'example' => 'true', 'backendName' => 'restoreSearchIndex'], 'SearchIndexNameSuffix' => ['title' => 'Specify a suffix to restored search index name', 'description' => 'The name prefixes of the search indexes that you want to restore.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => '2022xxxx143933', 'backendName' => 'searchIndexNameSuffix'], 'ReGenerateAutoIncrementPK' => ['title' => 'Re-generate auto incrmental primary key or not', 'description' => 'Specifies whether to regenerate auto-increment primary keys.'."\n", 'visibility' => 'Public', 'type' => 'boolean', 'example' => 'true', 'backendName' => 'reGenerateAutoIncrementPK'], 'BatchChannelCount' => ['title' => 'Concurrent processing channel count for each restore task', 'description' => 'The number of concurrent processes for each restore job.'."\n", 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'backendName' => 'batchChannelCount'], ], ], 'Report' => [ 'title' => '任务报告信息', 'description' => 'The report.', 'visibility' => 'Public', 'type' => 'object', 'properties' => [ 'TotalFiles' => ['title' => '待取回的全部文件列表', 'description' => 'The report path of total files.', 'visibility' => 'Public', 'type' => 'string', 'example' => 'temp/report/r-0000dnz7p4pk31u6madf_total.csv', 'backendName' => 'totalFiles'], 'SuccessFiles' => ['title' => '成功的文件列表', 'description' => 'The report path of success files.', 'visibility' => 'Public', 'type' => 'string', 'example' => 'temp/report/r-0000dnz7p4pk31u6madf_success.csv', 'backendName' => 'successFiles'], 'FailedFiles' => ['title' => '失败的文件列表', 'description' => 'The report path of failed files.', 'visibility' => 'Public', 'type' => 'string', 'example' => 'temp/report/r-0000dnz7p4pk31u6madf_failed.csv', 'backendName' => 'failedFiles'], 'SkippedFiles' => ['title' => '跳过的文件列表', 'description' => 'The report path of skipped files.', 'visibility' => 'Public', 'type' => 'string', 'example' => 'temp/report/r-0000dnz7p4pk31u6madf_skipped.csv', 'backendName' => 'skippedFiles'], ], ], 'Rule' => [ 'title' => 'A short description of struct', 'description' => 'A short description of struct', 'visibility' => 'Public', 'type' => 'object', 'properties' => [ 'DestinationRetention' => ['title' => 'retention for remote replication', 'description' => 'The retention period of remote backups. Minimum value: 1. Unit: days.', 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'example' => '7', 'backendName' => 'destinationRetention'], 'Schedule' => ['title' => 'schedule setting', 'description' => 'This parameter is returned only if the value of the **RuleType** parameter is **BACKUP**. This parameter indicates the backup schedule settings. Format: `I|{startTime}|{interval}`. The system runs the first backup job at a point in time that is specified in the {startTime} parameter and the subsequent backup jobs at an interval that is specified in the {interval} parameter. The system does not run a backup job before the specified point in time. Each backup job, except the first one, starts only after the previous backup job is completed. For example, `I|1631685600|P1D` indicates that the system runs the first backup job at 14:00:00 on September 15, 2021 and the subsequent backup jobs once a day.'."\n" ."\n" .'* startTime: the time at which the system starts to run a backup job. The time follows the UNIX time format. Unit: seconds.'."\n" .'* interval: the interval at which the system runs a backup job. The interval follows the ISO 8601 standard. For example, PT1H indicates an interval of 1 hour. P1D indicates an interval of one day.', 'visibility' => 'Public', 'type' => 'string', 'example' => 'I|1631685600|P1D', 'backendName' => 'schedule'], 'Retention' => ['title' => 'retention of backup', 'description' => 'This parameter indicates the retention period of the backup data. Minimum value: 1. Unit: days.', 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'example' => '7', 'backendName' => 'retention'], 'Disabled' => ['title' => 'disable the rule or not', 'description' => 'Whether the plan is disbaled for this data source.'."\n" .'- **true**: disabled'."\n" .'- **false**: Not disabled', 'visibility' => 'Public', 'type' => 'boolean', 'example' => 'false', 'backendName' => 'disabled'], 'DoCopy' => ['title' => 'copy to other region', 'description' => 'Whether do copy.', 'visibility' => 'Public', 'type' => 'boolean', 'example' => 'true', 'backendName' => 'doCopy'], 'DestinationRegionId' => ['title' => 'copy target region id', 'description' => 'The replication region id.', 'visibility' => 'Public', 'type' => 'string', 'example' => 'cn-shenzhen', 'backendName' => 'destinationRegionId'], 'RuleName' => ['title' => 'rule name', 'description' => 'The rule name.', 'visibility' => 'Public', 'type' => 'string', 'example' => 'rule-com-backup-20241023-163113', 'backendName' => 'ruleName'], 'BackupType' => ['title' => 'backup type', 'description' => 'The backup type.'."\n" .'* COMPLETE：Full backup.'."\n" .'* INCREMENTAL：Incremental backup.', 'visibility' => 'Public', 'type' => 'string', 'example' => 'COMPLETE', 'backendName' => 'backupType'], ], ], ], ], 'apis' => [ 'AddContainerCluster' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'abilityTreeCode' => '95396', 'abilityTreeNodes' => ['FEATUREhbrFWIWBG'], 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'Identifier', 'in' => 'query', 'schema' => ['description' => 'The ID of the cluster that you want to register.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cca8f35f0e0d84540b49d994511c2c87a'], ], [ 'name' => 'Name', 'in' => 'query', 'schema' => ['description' => 'The name of the cluster.'."\n", 'type' => 'string', 'required' => false, 'example' => 'ack_pv_backup_location'], ], [ 'name' => 'Description', 'in' => 'query', 'schema' => ['description' => 'The description of the cluster.'."\n", 'type' => 'string', 'required' => false, 'example' => 'description ack pv backup'], ], [ 'name' => 'ClusterType', 'in' => 'query', 'schema' => ['description' => 'The type of the cluster. Only Container Service for Kubernetes (ACK) clusters are supported.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ACK'], ], [ 'name' => 'NetworkType', 'in' => 'query', 'schema' => ['description' => 'The network type of the cluster. Valid values:'."\n" ."\n" .'* **CLASSIC**: the classic network'."\n" .'* **VPC**: a virtual private cloud (VPC)'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'VPC'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '1FCBC078-FFCB-542A-8555-566477679720'], 'Token' => ['description' => 'The token that is used to register the Hybrid Backup Recovery (HBR) client in the cluster.'."\n", 'type' => 'string', 'example' => 'eyJhY2NvdW*****VnZpgXQC5A=='], 'Success' => ['description' => 'Indicates whether the request is successful.'."\n" ."\n" .'* true: The request is successful.'."\n" .'* false: The request fails.'."\n", 'type' => 'boolean', 'example' => 'true'], 'Code' => ['description' => 'The HTTP status code. The status code 200 indicates that the request is successful.'."\n", 'type' => 'string', 'example' => '200'], 'Message' => ['description' => 'The message that is returned. If the request is successful, a value of successful is returned. If the request fails, an error message is returned.'."\n", 'type' => 'string', 'example' => 'successful'], 'ClusterId' => ['description' => 'The ID of the cluster.'."\n", 'type' => 'string', 'example' => 'cc-00049slr9iuvvv6pp134'], ], ], ], ], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], 'title' => 'AddContainerCluster', 'summary' => 'Registers a Container Service for Kubernetes (ACK) cluster.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'AddContainerCluster'], ], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'hbr:AddContainerCluster', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'HBR', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1FCBC078-FFCB-542A-8555-566477679720\\",\\n \\"Token\\": \\"eyJhY2NvdW*****VnZpgXQC5A==\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"ClusterId\\": \\"cc-00049slr9iuvvv6pp134\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 1FCBC078-FFCB-542A-8555-566477679720\\n eyJhY2NvdW*****VnZpgXQC5A==\\n true\\n 200\\n successful\\n cc-00049slr9iuvvv6pp134\\n","errorExample":""}]', ], 'AddCrossAccount' => [ 'summary' => 'Create a cross-account management relationship.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREhbrB08D1M'], 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ 'name' => 'CrossAccountUserId', 'in' => 'query', 'schema' => ['description' => 'The UID of the account to back up.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1589753xxxxxx625', 'title' => ''], ], [ 'name' => 'CrossAccountRoleName', 'in' => 'query', 'schema' => ['description' => 'The name of the RAM role for the account to back up. This parameter is used when you configure a cross-account backup by assuming a RAM role.', 'type' => 'string', 'required' => false, 'example' => 'hbrcrossrole', 'title' => ''], ], [ 'name' => 'CrossAccountType', 'in' => 'query', 'schema' => ['description' => 'The type of cross-account backup. Valid values:'."\n" ."\n" .'- **CROSS\\_ACCOUNT**: Configures a cross-account backup by assuming a RAM role.'."\n" ."\n" .'- **CROSS\\_ACCOUNT\\_BY\\_RD**: Configures a cross-account backup based on a resource directory.', 'type' => 'string', 'required' => false, 'example' => 'CROSS_ACCOUNT', 'title' => ''], ], [ 'name' => 'Alias', 'in' => 'query', 'allowEmptyValue' => false, 'schema' => ['description' => 'The alias. The maximum length is 32 characters. This parameter is not required for cross-account backups that are configured based on a resource directory.', 'type' => 'string', 'example' => 'Source account 1', 'required' => false, 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Code' => ['description' => 'The return code. A value of 200 indicates success.', 'type' => 'string', 'example' => '200', 'title' => ''], 'Message' => ['description' => 'The message returned. If the call is successful, \\`successful\\` is returned. If the call fails, an error message is returned.', 'type' => 'string', 'example' => 'successful', 'title' => ''], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E', 'title' => ''], 'Success' => ['description' => 'Indicates whether the request was successful.'."\n" ."\n" .'- true: The request was successful.'."\n" ."\n" .'- false: The request failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], 'title' => 'AddCrossAccount', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'hbr:AddCrossAccount', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'HBR', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\",\\n \\"Success\\": true\\n}","type":"json"}]', 'translator' => 'machine', ], 'AddDataSource' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'abilityTreeCode' => '95397', 'abilityTreeNodes' => ['FEATUREhbr9ZUQY7'], 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'DataSourceType', 'in' => 'query', 'schema' => ['description' => 'The type of the data source.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'COMMON_NAS', 'title' => ''], ], [ 'name' => 'DataSourceName', 'in' => 'query', 'schema' => ['description' => 'The name of the data source.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'MyLocalNas', 'title' => ''], ], [ 'name' => 'Credential', 'in' => 'query', 'schema' => ['description' => 'The access credential for the data source. This parameter is required for local NAS (SMB) data sources and for OSS- or S3-compatible data sources. Examples:'."\n" ."\n" .'- Local NAS data source (SMB protocol):'."\n" .' {'."\n" .' "mountUsername": "\\*\\*\\*\\*\\*",'."\n" .' "mountPassword": "\\*\\*\\*\\*\\*"'."\n" .' }'."\n" ."\n" .'- OSS-compatible or S3-compatible data source:'."\n" .' {'."\n" .' "accessKeyId": "\\*\\*\\*\\*\\*",'."\n" .' "accessKeySecret": "\\*\\*\\*\\*\\*"'."\n" .' }', 'type' => 'string', 'required' => false, 'example' => '{'."\n" .' "mountUsername": "*****",'."\n" .' "mountPassword": "*****"'."\n" .'}', 'title' => ''], ], [ 'name' => 'ConnectionInfo', 'in' => 'query', 'schema' => ['description' => 'The connection information for the data source. Examples:'."\n" ."\n" .'- Local NAS data source:'."\n" .' {'."\n" .' "dataServerAddresses": \\['."\n" .' {'."\n" .' "host": "123.123.123.123",'."\n" .' "port": "8080"'."\n" .' }'."\n" .' ],'."\n" .' "sharePath": "/share",'."\n" .' "mountOptions": "vers=3",'."\n" .' "fileSystemType": "nfs"'."\n" .' }'."\n" ."\n" .'- CPFS AI-Computing Edition data source:'."\n" .' {"vpcMountTarget":"cpfs-010wn\\*\\*\\*wy-vpc-ta\\*\\*\\*8.cn-shanghai.cpfs.aliyuncs.com","sharePath":"/"}'."\n" ."\n" .'- Other large-scale file system data source:'."\n" .' {"path":"/mnt"}', 'type' => 'string', 'required' => false, 'example' => '{'."\n" .' "dataServerAddresses": ['."\n" .' {'."\n" .' "host": "123.123.123.123",'."\n" .' "port": "8080"'."\n" .' }'."\n" .' ],'."\n" .' "sharePath": "/share",'."\n" .' "mountOptions": "vers=3",'."\n" .' "fileSystemType": "nfs"'."\n" .'}', 'title' => ''], ], [ 'name' => 'IndexLevel', 'in' => 'query', 'schema' => ['description' => 'The index level. This parameter applies only to data source analysis with the archive feature.'."\n" ."\n" .'- `OFF`: No index is created.'."\n" ."\n" .'- `META`: A metadata index is created.'."\n" ."\n" .'- `ALL`: A full-text index is created. (Deprecated)', 'type' => 'string', 'required' => false, 'example' => 'META', 'title' => ''], ], [ 'name' => 'ClusterId', 'in' => 'query', 'schema' => ['description' => 'The ID of the client group used to access the data source.', 'type' => 'string', 'required' => false, 'example' => 'cl-0004i0nlngorvgjpl7ck', 'title' => ''], ], [ 'name' => 'Schedule', 'in' => 'query', 'schema' => ['description' => 'The execution schedule. This parameter applies only to data source analysis with the archive feature. The format `I|{startTime}|{interval}` specifies a task that runs at a defined interval starting from `{startTime}`. `{interval}` is an ISO 8601 duration. For example, `PT1H` specifies a one-hour interval, and `P1D` specifies a one-day interval.', 'type' => 'string', 'required' => false, 'example' => 'I|1729493847|P1D', 'title' => ''], ], [ 'name' => 'SpeedLimit', 'in' => 'query', 'schema' => ['description' => 'The rate limiting settings. This parameter applies only to data source analysis with the archive feature.', 'type' => 'string', 'required' => false, 'example' => '6:21:10240', 'title' => ''], ], [ 'name' => 'Options', 'in' => 'query', 'schema' => ['description' => 'The options for data source analysis. This parameter applies only to data source analysis with the archive feature.', 'type' => 'string', 'required' => false, 'example' => '{}', 'title' => ''], ], [ 'name' => 'Include', 'in' => 'query', 'schema' => ['description' => 'A filter that specifies the files to include. This parameter applies only to data source analysis with the archive feature.', 'type' => 'string', 'required' => false, 'example' => '["/home/alice", "/home/bob"]', 'title' => ''], ], [ 'name' => 'Exclude', 'in' => 'query', 'schema' => ['description' => 'A filter that specifies the files to exclude. This parameter applies only to data source analysis with the archive feature.', 'type' => 'string', 'required' => false, 'example' => '["/home/alice/log"]', 'title' => ''], ], [ 'name' => 'Path', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'type' => 'array', 'items' => ['description' => 'A path for data source analysis. This parameter applies only to data source analysis with the archive feature.', 'type' => 'string', 'required' => false, 'example' => '/home', 'title' => ''], 'required' => false, 'maxItems' => 8, 'description' => 'A list of paths for data source analysis. This parameter applies only to data source analysis with the archive feature.', 'title' => '', 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Code' => ['description' => 'The HTTP status code.', 'type' => 'string', 'example' => '200', 'title' => ''], 'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => 'successful', 'title' => ''], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '53167AD3-****-****-92C7-CF69A000BA45', 'title' => ''], 'Success' => ['description' => 'Indicates whether the request is successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'DataSourceId' => ['description' => 'The data source ID.', 'type' => 'string', 'example' => 'ds-000*******xzj', 'title' => ''], ], 'description' => 'The response body.', 'title' => '', 'example' => '', ], ], ], 'title' => 'AddDataSource', 'summary' => 'Creates a data source.', 'description' => '- The local NAS backup feature supports the local NAS (`COMMON_NAS`) data source type.'."\n" ."\n" .'- The CPFS backup feature supports the following data source types: CPFS (`CPFS`), CPFS AI-Computing Edition (`BMCPFS`), and other large-scale file system (`COMMON_FILE_SYSTEM`).'."\n" ."\n" .'- The archive feature supports the following data source types: local NAS (`COMMON_NAS`), HDFS (`HDFS`), and S3 (`S3`).', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"53167AD3-****-****-92C7-CF69A000BA45\\",\\n \\"Success\\": true,\\n \\"DataSourceId\\": \\"ds-000*******xzj\\"\\n}","type":"json"}]', ], 'BrowseFiles' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'systemTags' => [ 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '95403', 'abilityTreeNodes' => ['FEATUREhbrS7MI6C', 'FEATUREhbr3BJQCT', 'FEATUREhbr56LH1C', 'FEATUREhbrFWIWBG'], ], 'parameters' => [ [ 'name' => 'Token', 'in' => 'query', 'schema' => ['description' => 'Deprecated. Do not use.', 'type' => 'string', 'required' => false, 'example' => '***', 'title' => ''], ], [ 'name' => 'VaultId', 'in' => 'query', 'schema' => ['description' => 'The backup vault ID.', 'type' => 'string', 'required' => false, 'example' => 'v-000***jtz', 'title' => ''], ], [ 'name' => 'ClientId', 'in' => 'query', 'schema' => ['description' => 'The backup client ID.', 'type' => 'string', 'required' => false, 'example' => 'c-000***o48', 'title' => ''], ], [ 'name' => 'SnapshotHash', 'in' => 'query', 'schema' => ['description' => 'The hash value of the backup snapshot.', 'type' => 'string', 'required' => false, 'example' => '971***e9d', 'title' => ''], ], [ 'name' => 'Path', 'in' => 'query', 'schema' => ['description' => 'The hash value of the directory. If this parameter is not specified, the root directory of the backup is browsed.', 'type' => 'string', 'required' => false, 'example' => 'ef6***46a', 'title' => ''], ], [ 'name' => 'AbsolutePath', 'in' => 'query', 'schema' => ['description' => 'The absolute path of the directory. Specify `/` to browse the root directory of the backup.', 'type' => 'string', 'required' => false, 'example' => '/data/', 'title' => ''], ], [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => ['description' => 'Deprecated. Use MaxResults and NextToken for pagination instead.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'minimum' => '1', 'default' => '1', 'example' => '1', 'title' => ''], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => ['description' => 'Deprecated. Use MaxResults and NextToken for pagination instead.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '1000', 'minimum' => '1', 'default' => '10', 'example' => '10', 'title' => ''], ], [ 'name' => 'RestoreId', 'in' => 'query', 'schema' => ['description' => 'Deprecated.', 'type' => 'string', 'required' => false, 'example' => 'r-000***oy9', 'title' => ''], ], [ 'name' => 'NextToken', 'in' => 'query', 'schema' => ['description' => 'The token that is required to retrieve the next page of results. If this parameter is not specified, the first page of results is returned.', 'type' => 'string', 'required' => false, 'example' => 'eyJ***Q==', 'title' => ''], ], [ 'name' => 'MaxResults', 'in' => 'query', 'schema' => ['description' => 'The maximum number of results to return per request.'."\n" ."\n" .'Valid values: 10 to 100. Default value: 10.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''], ], [ 'name' => 'StorageClass', 'in' => 'query', 'schema' => ['description' => 'The storage class of the backup data. Valid values:'."\n" ."\n" .'- **STANDARD**: Standard.'."\n" ."\n" .'- **ARCHIVE**: Archive.', 'type' => 'string', 'required' => false, 'example' => 'STANDARD', 'title' => ''], ], [ 'name' => 'Edition', 'in' => 'query', 'schema' => [ 'description' => 'The Cloud Backup edition. Valid values:'."\n" ."\n" .'- **STANDARD**: Standard Edition. This is the default value.'."\n" ."\n" .'- **BASIC**: Basic Edition. Only ECS file backup is supported in Basic Edition.', 'enumValueTitles' => ['STANDARD' => 'Standard Edition', 'BASIC' => 'ECS file backup Basic Edition'], 'type' => 'string', 'required' => false, 'example' => 'STANDARD', 'title' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'NextToken' => ['description' => 'The pagination token for the next page of results. An empty value indicates that no more pages are available.', 'type' => 'string', 'example' => 'eyJ***Q=='."\n", 'title' => ''], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '843F7A45-8B***35-ECECBE5E5F78', 'title' => ''], 'Success' => ['description' => 'Indicates whether the request was successful.'."\n" ."\n" .'- true: The request was successful.'."\n" ."\n" .'- false: The request failed.', 'type' => 'boolean', 'example' => 'True', 'title' => ''], 'Code' => ['description' => 'The HTTP status code. A value of 200 indicates that the request was successful.', 'type' => 'string', 'example' => '200', 'title' => ''], 'Message' => ['description' => 'The response message. The value `successful` is returned if the request was successful. An error message is returned if the request failed.', 'type' => 'string', 'example' => 'successful', 'title' => ''], 'PageNumber' => ['description' => 'The page number. Pages start from 1. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'PageSize' => ['description' => 'The number of entries per page. Valid values: 1 to 99. Default value: 10.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], 'TotalCount' => ['description' => 'The total number of entries returned.', 'type' => 'integer', 'format' => 'int32', 'example' => '11', 'title' => ''], 'MaxResults' => ['description' => 'The maximum number of entries returned per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], 'Nodes' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'Node' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Type' => [ 'description' => 'The object type.', 'enumValueTitles' => ['file' => 'File', 'symlink' => 'Symbolic link', 'dir' => 'Directory'], 'type' => 'string', 'example' => 'file', 'title' => '', ], 'Name' => ['description' => 'The name of the file or directory.', 'type' => 'string', 'example' => 'fileName', 'title' => ''], 'Subtree' => ['description' => 'The hash value of the subdirectory. Use this value in the Path parameter to browse the contents of this subdirectory.', 'type' => 'string', 'example' => 'ef6***46a', 'title' => ''], 'Size' => ['description' => 'The file size, in bytes.', 'type' => 'integer', 'format' => 'int64', 'example' => '58727654', 'title' => ''], ], 'description' => 'The properties of a file system object.', 'title' => '', 'example' => '', ], 'description' => 'The file system objects.', 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'title' => 'BrowseFiles', 'summary' => 'Browses the list of backup files in a specified backup snapshot.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"NextToken\\": \\"eyJ***Q==\\\\n\\",\\n \\"RequestId\\": \\"843F7A45-8B***35-ECECBE5E5F78\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 11,\\n \\"MaxResults\\": 10,\\n \\"Nodes\\": {\\n \\"Node\\": [\\n {\\n \\"Type\\": \\"file\\",\\n \\"Name\\": \\"fileName\\",\\n \\"Subtree\\": \\"ef6***46a\\",\\n \\"Size\\": 58727654\\n }\\n ]\\n }\\n}","type":"json"}]', ], 'CancelBackupJob' => [ 'summary' => 'Cancels a backup job.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '95404', 'abilityTreeNodes' => ['FEATUREhbr9ZUQY7'], ], 'parameters' => [ [ 'name' => 'JobId', 'in' => 'query', 'schema' => ['description' => 'The ID of the backup job.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => 'j-******************************'], ], [ 'name' => 'VaultId', 'in' => 'query', 'schema' => ['description' => 'The ID of the backup repository.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'title' => '', 'example' => 'v-*****************************'], ], [ 'name' => 'Edition', 'in' => 'query', 'schema' => ['type' => 'string', 'title' => '', 'description' => 'The edition type. Valid values are BASIC and STANDARD. The default value is STANDARD.', 'required' => false, 'example' => 'STANDARD'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Code' => ['description' => 'The return code. A value of 200 indicates a successful request.', 'type' => 'string', 'title' => '', 'example' => '200'], 'Message' => ['description' => 'The returned message. If the request is successful, \\`successful\\` is returned. If the request fails, an error message is returned.', 'type' => 'string', 'title' => '', 'example' => 'successful'], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E'], 'Success' => ['description' => 'Indicates whether the request was successful.'."\n" ."\n" .'- true: The request was successful.'."\n" ."\n" .'- false: The request failed.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\",\\n \\"Success\\": true\\n}","type":"json"}]', 'title' => 'CancelBackupJob', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CancelBackupJob'], ], ], 'ramActions' => [ [ 'operationType' => 'delete', 'ramAction' => [ 'action' => 'hbr:CancelBackupJob', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'HBR', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], ], 'CancelRestoreJob' => [ 'summary' => 'Cancels a restore job.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREhbr56LH1C', 'FEATUREhbrS7MI6C', 'FEATUREhbrFWIWBG', 'FEATUREhbrAW9I1R', 'FEATUREhbrB1KQ9G', 'FEATUREhbrQ3MV3B', 'FEATUREhbr3BJQCT', 'FEATUREhbr9ZUQY7'], ], 'parameters' => [ [ 'name' => 'RestoreId', 'in' => 'query', 'schema' => ['description' => 'The ID of the restore job.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => 'r-*********************'], ], [ 'name' => 'VaultId', 'in' => 'query', 'schema' => ['description' => 'The ID of the backup repository.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'title' => '', 'example' => 'v-*********************'], ], [ 'name' => 'Edition', 'in' => 'query', 'schema' => ['type' => 'string', 'title' => '', 'description' => 'The edition. Valid values: BASIC and STANDARD. The default value is STANDARD.', 'required' => false, 'example' => 'STANDARD'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Code' => ['description' => 'The return code. A value of 200 indicates that the request was successful.', 'type' => 'string', 'title' => '', 'example' => '200'], 'Message' => ['description' => 'The message returned. If the request is successful, successful is returned. If the request fails, an error message is returned.', 'type' => 'string', 'title' => '', 'example' => 'successful'], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E'], 'Success' => ['description' => 'Indicates whether the request was successful.'."\n" ."\n" .'- true: The request was successful.'."\n" ."\n" .'- false: The request failed.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\",\\n \\"Success\\": true\\n}","type":"json"}]', 'title' => 'CancelRestoreJob', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CancelRestoreJob'], ], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'hbr:CancelRestoreJob', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'HBR', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], ], 'ChangeResourceGroup' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'abilityTreeCode' => '95415', 'abilityTreeNodes' => ['FEATUREhbr3BJQCT'], ], 'parameters' => [ [ 'name' => 'ResourceType', 'in' => 'formData', 'schema' => ['description' => 'The resource type. Valid values:'."\n" ."\n" .'* **vault**: backup vault'."\n" .'* **client**: backup client'."\n" .'* **hanainstance**: SAP HANA instance'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'vault'], ], [ 'name' => 'ResourceId', 'in' => 'formData', 'schema' => ['description' => 'The ID of the resource. The value of this parameter varies with the resource type. For example, if the ResourceType parameter is set to vault, the ResourceId parameter specifies the ID of the backup vault.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'v-0002vido6j5zyh5k****'], ], [ 'name' => 'NewResourceGroupId', 'in' => 'formData', 'schema' => ['description' => 'The ID of the new resource group. You can view the available resource groups in the Resource Management console.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'rg-bp67acfmxazb4p**** '], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Code' => ['description' => 'The response code. The status code 200 indicates that the request was successful.'."\n", 'type' => 'string', 'example' => '200'], 'Message' => ['description' => 'The returned message. If the request was successful, "successful" is returned. If the request failed, an error message is returned.'."\n", 'type' => 'string', 'example' => 'successful'], 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'C438054F-9088-5D1B-AED0-0EA86D9C65F4'], 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" ."\n" .'* true'."\n" .'* false'."\n", 'type' => 'boolean', 'example' => 'true'], ], 'description' => '', ], ], ], 'title' => 'ChangeResourceGroup', 'summary' => 'Changes the resource group to which an instance belongs.', 'description' => '* In the Cloud Backup console, you can use resource groups to manage resources such as backup vaults, Cloud Backup clients, and SAP HANA instances.'."\n" .'* A resource is a cloud service entity that you create on Alibaba Cloud, such as an Elastic Compute Service (ECS) instance, a backup vault, or an SAP HANA instance.'."\n" .'* You can sort resources owned by your Alibaba Cloud account into various resource groups. Resource groups facilitate resource management among multiple projects or applications within your Alibaba Cloud account and simplify permission management.'."\n", 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ChangeResourceGroup'], ], ], 'ramActions' => [], 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"C438054F-9088-5D1B-AED0-0EA86D9C65F4\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n 200\\n successful\\n C438054F-9088-5D1B-AED0-0EA86D9C65F4\\n true\\n","errorExample":""}]', ], 'CheckRole' => [ 'methods' => ['post', 'get'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '95418', 'abilityTreeNodes' => ['FEATUREhbr3BJQCT'], 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'CheckRoleType', 'in' => 'query', 'schema' => ['description' => 'The role type. Valid values:'."\n" .'- EcsRole: access permissions for ECS resources'."\n" .'- CsgRole: permissions to back up Cloud Storage Gateway resources'."\n" .'- NasRole: permissions to back up NAS resources'."\n" .'- OssRole: permissions to back up OSS resources'."\n" .'- UdmRole: permissions to back up entire ECS instances'."\n" .'- VMwareLocalRole: permissions to back up on-premises VMware virtual machines'."\n" .'- VMwareCloudRole: permissions to back up cloud-based VMware virtual machines'."\n" .'- EcsBackupRole: permissions for ECS backup'."\n" .'- OtsRole: permissions to back up OTS resources'."\n" .'- CrossAccountRole: permissions for cross-account backup', 'type' => 'string', 'required' => false, 'example' => 'OssRole', 'title' => ''], ], [ 'name' => 'CrossAccountUserId', 'in' => 'query', 'schema' => ['description' => 'The ID of the source account for cross-account backup managed by the current account.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '158975xxxxx4625', 'title' => ''], ], [ 'name' => 'CrossAccountRoleName', 'in' => 'query', 'schema' => ['description' => 'The name of the RAM role created in the source account for cross-account backup managed by the current account.', 'type' => 'string', 'required' => false, 'example' => 'BackupRole', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Code' => ['description' => 'The response code. 200 indicates success.', 'type' => 'string', 'example' => '200', 'title' => ''], 'Message' => ['description' => 'The response message. "successful" is returned if the request is successful. An error message is returned if the request fails.', 'type' => 'string', 'example' => 'successful', 'title' => ''], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '2F63CA9B-744E-51C0-A638-27882BB03078', 'title' => ''], 'Success' => ['description' => 'Indicates whether the request is successful.'."\n" ."\n" .'- true: The request is successful.'."\n" .'- false: The request failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 200 => [ ['errorCode' => 'CrossAccountBackupSlrNotExist', 'errorMessage' => 'AliyunServiceRoleForHbrCrossAccountBackup doesn\'t exist, please create this role.', 'description' => 'AliyunServiceRoleForHbrCrossAccountBackup the role does not exist, create this service association role.'], ], ], 'title' => 'Check permissions', 'summary' => 'Checks whether the current user has permissions to access a specific resource or page.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CheckRole'], ], ], 'ramActions' => [ [ 'operationType' => 'none', 'ramAction' => [ 'action' => 'hbr:CheckRole', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'HBR', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"2F63CA9B-744E-51C0-A638-27882BB03078\\",\\n \\"Success\\": true\\n}","type":"json"}]', ], 'CreateBackupJob' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'abilityTreeCode' => '95428', 'abilityTreeNodes' => ['FEATUREhbr56LH1C', 'FEATUREhbrS7MI6C', 'FEATUREhbrFWIWBG', 'FEATUREhbrB1KQ9G', 'FEATUREhbrQ3MV3B', 'FEATUREhbr3BJQCT', 'FEATUREhbrF83GXN'], ], 'parameters' => [ [ 'name' => 'JobName', 'in' => 'query', 'schema' => ['description' => 'The name of the backup job.'."\n", 'type' => 'string', 'required' => false, 'example' => 'k8s-backup-infra-20220131150046-hbr'], ], [ 'name' => 'SourceType', 'in' => 'query', 'schema' => [ 'description' => 'The type of the data source. Valid values:'."\n" ."\n" .'* **UDM_ECS**: Elastic Compute Service (ECS) instance'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'enumValueTitles' => ['UDM_ECS' => ''], 'example' => 'CONTAINER', ], ], [ 'name' => 'Retention', 'in' => 'query', 'schema' => ['description' => 'The retention period of the backup data. Unit: days.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'docRequired' => true, 'example' => '15'], ], [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'This parameter is required only if you set the **SourceType** parameter to **UDM_ECS**. This parameter specifies the ID of the ECS instance.'."\n", 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'i-bp1xxxxxxxxxxxxxxysm'], ], [ 'name' => 'Detail', 'in' => 'query', 'style' => 'json', 'schema' => ['description' => 'This parameter is required only if you set the **SourceType** parameter to **UDM_ECS**. The value is a JSON string. Valid values:'."\n" ."\n" .'* doCopy: specifies whether to enable remote replication.'."\n" ."\n" .'* destinationRegionId: the destination region for remote replication.'."\n" ."\n" .'* destinationRetention: the retention period of the backup point for remote replication.'."\n" ."\n" .'* diskIdList: the IDs of the disks that are to be backed up. If this parameter is left empty, all disks are backed up.'."\n" ."\n" .'* snapshotGroup: specifies whether to use a snapshot-consistent group. This parameter is valid only if all disks of the ECS instance are Enterprise SSDs (ESSDs).'."\n" ."\n" .'* appConsistent: specifies whether to use the application-consistent backup feature. This parameter must be used with the preScriptPath and postScriptPath parameters.'."\n" ."\n" .'* preScriptPath: the path to the pre-freeze scripts.'."\n" ."\n" .'* postScriptPath: the path to the post-thaw scripts.'."\n" ."\n" .'* enableWriters: This parameter is required only if you set the **AppConsistent** parameter to **true**. This parameter specifies whether to create application-consistent snapshots.'."\n" ."\n" .' * true: creates application-consistent snapshots.'."\n" .' * false: creates file system-consistent snapshots.'."\n" ."\n" .'* enableFsFreeze: This parameter is required only if you set the **AppConsistent** parameter to **true**. This parameter specifies whether to enable Linux fsfreeze to put file systems into the read-only state before application-consistent snapshots are created. Default value: true.'."\n" ."\n" .'* timeoutSeconds: This parameter is required only if you set the **AppConsistent** parameter to **true**. This parameter specifies the I/O freeze timeout period. Default value: 30. Unit: seconds.'."\n", 'type' => 'object', 'required' => false, 'docRequired' => false, 'example' => '{'."\n" .' "doCopy": false,'."\n" .' "destinationRegionId": "",'."\n" .' "destinationRetention": null,'."\n" .' "diskIdList": [],'."\n" .' "snapshotGroup": false,'."\n" .' "appConsistent": false,'."\n" .' "enableWriters": true,'."\n" .' "preScriptPath": "",'."\n" .' "postScriptPath": "",'."\n" .' "enableFsFreeze": true,'."\n" .' "timeoutInSeconds": 60'."\n" .'}'], ], [ 'name' => 'BackupType', 'in' => 'query', 'schema' => [ 'description' => 'The backup type. This parameter is required only if you set the SourceType parameter to UDM_ECS.'."\n" ."\n" .'* **COMPLETE**: full backup'."\n", 'type' => 'string', 'required' => false, 'enumValueTitles' => ['COMPLETE' => ''], 'example' => 'INCREMENTAL', ], ], [ 'name' => 'VaultId', 'in' => 'query', 'schema' => ['description' => 'The ID of the backup vault. This parameter is not required if you set the SourceType parameter to UDM_ECS.'."\n", 'type' => 'string', 'required' => false, 'example' => 'v-000xxxxxxxxxxxxxxy1v'], ], [ 'name' => 'SpeedLimit', 'in' => 'query', 'schema' => ['description' => 'This parameter does not take effect if you set the **SourceType** parameter to **UDM_ECS**. This parameter specifies the throttling rules. Format: `{start}|{end}|{bandwidth}`. Separate multiple throttling rules with vertical bars (|). A specified time range cannot overlap with another time range.'."\n" ."\n" .'* **start**: the start hour.'."\n" .'* **end**: the end hour.'."\n" .'* **bandwidth**: the bandwidth. Unit: KB/s.'."\n", 'type' => 'string', 'required' => false, 'example' => '0:24:NaN'], ], [ 'name' => 'Options', 'in' => 'query', 'schema' => ['description' => 'You do not need to specify this parameter.'."\n", 'type' => 'string', 'required' => false, 'example' => '{"UseVSS":false}'], ], [ 'name' => 'Include', 'in' => 'query', 'schema' => ['description' => 'This parameter does not take effect if you set the **SourceType** parameter to **UDM_ECS**. This parameter specifies the paths to the files that are backed up. The value can be up to 255 characters in length.'."\n", 'type' => 'string', 'required' => false, 'example' => '["/home/alice/*.pdf", "/home/bob/*.txt"]'], ], [ 'name' => 'Exclude', 'in' => 'query', 'schema' => ['description' => 'This parameter does not take effect if you set the **SourceType** parameter to **UDM_ECS**. This parameter specifies the paths to the files that are excluded from the backup job. The value can be up to 255 characters in length.'."\n", 'type' => 'string', 'required' => false, 'example' => '["/var", "/proc"]'], ], [ 'name' => 'ClusterId', 'in' => 'query', 'schema' => ['description' => 'You do not need to specify this parameter.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cl-00068btz******oku'], ], [ 'name' => 'ContainerResources', 'in' => 'query', 'schema' => ['description' => 'You do not need to specify this parameter.'."\n", 'type' => 'string', 'required' => false, 'example' => '[{\\"resourceType\\":\\"PV\\",\\"backupMethod\\":\\"FILE\\",\\"resourceId\\":\\"674dac6d-74cd-47e9-a675-09e2f10d2c45\\",\\"resourceInfo\\":\\"{\\\\\\"pv_name\\\\\\":\\\\\\"nas-650dac6d-74cd-47e9-a675-09e2f10d2c45\\\\\\",\\\\\\"pv_size\\\\\\":\\\\\\"8Gi\\\\\\",\\\\\\"storage_class\\\\\\":\\\\\\"alibabacloud-cnfs-nas\\\\\\",\\\\\\"pvc_name\\\\\\":\\\\\\"data-postgresql-default-0\\\\\\",\\\\\\"namespace\\\\\\":\\\\\\"database\\\\\\"}\\",\\"host\\":\\"cn-huhehaote.192.168.13.133\\",\\"hostPrefix\\":\\"6f5e758e-8d35-4584-b9ce-8333adfc7547/volumes/kubernetes.io~csi/nas-670dac6d-74cd-47e9-a675-09e2f10d2c45/mount\\",\\"pvPath\\":\\"/\\"}]'], ], [ 'name' => 'InitiatedByAck', 'in' => 'query', 'schema' => ['description' => 'false or left empty'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'false'], ], [ 'name' => 'ContainerClusterId', 'in' => 'query', 'schema' => ['description' => 'You do not need to specify this parameter.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cc-000xxxxxxxxxxxxxxi00'], ], [ 'name' => 'CrossAccountType', 'in' => 'query', 'schema' => [ 'description' => 'Specifies whether data is backed up within the same Alibaba Cloud account or across Alibaba Cloud accounts. Valid values:'."\n" ."\n" .'* SELF_ACCOUNT: Data is backed up within the same Alibaba Cloud account.'."\n" .'* CROSS_ACCOUNT: Data is backed up across Alibaba Cloud accounts.'."\n", 'type' => 'string', 'required' => false, 'enumValueTitles' => [], 'example' => 'SELF_ACCOUNT', ], ], [ 'name' => 'CrossAccountUserId', 'in' => 'query', 'schema' => ['description' => 'The ID of the source Alibaba Cloud account that authorizes the current Alibaba Cloud account to back up data across Alibaba Cloud accounts.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '158975xxxxxx4625'], ], [ 'name' => 'CrossAccountRoleName', 'in' => 'query', 'schema' => ['description' => 'The name of the RAM role that is created within the source Alibaba Cloud account and assigned to the current Alibaba Cloud account to authorize the current Alibaba Cloud account to back up data across Alibaba Cloud accounts.'."\n", 'type' => 'string', 'required' => false, 'example' => 'BackupRole'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Code' => ['description' => 'The HTTP status code. The status code 200 indicates that the request was successful.'."\n", 'type' => 'string', 'example' => '200'], 'Message' => ['description' => 'The returned message. If the request was successful, "successful" is returned. If the request failed, an error message is returned.'."\n", 'type' => 'string', 'example' => 'successful'], 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '25F49E7B-7E39-542E-83AD-62E6E7F73786'], 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" ."\n" .'* true'."\n" .'* false'."\n", 'type' => 'boolean', 'example' => 'true'], 'JobId' => ['description' => 'The ID of the backup job.'."\n", 'type' => 'string', 'example' => 'job-000csy09q50a2jdcbwbo'], ], ], ], ], 'title' => 'CreateBackupJob', 'summary' => 'Creates a backup job.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CreateBackupJob'], ], ], 'ramActions' => [], 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"25F49E7B-7E39-542E-83AD-62E6E7F73786\\",\\n \\"Success\\": true,\\n \\"JobId\\": \\"job-000csy09q50a2jdcbwbo\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 200\\n successful\\n 25F49E7B-7E39-542E-83AD-62E6E7F73786\\n true\\n job-000csy09q50a2jdcbwbo\\n","errorExample":""}]', ], 'CreateBackupPlan' => [ 'summary' => 'Creates a backup plan.', 'methods' => ['post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'paid', 'abilityTreeCode' => '95429', 'abilityTreeNodes' => ['FEATUREhbr9ZUQY7'], ], 'parameters' => [ [ 'name' => 'SourceType', 'in' => 'query', 'schema' => ['description' => 'The type of the data source. Valid values:'."\n" ."\n" .'- **ECS\\_FILE**: Backs up files from ECS instances.'."\n" ."\n" .'- **OSS**: Backs up OSS buckets.'."\n" ."\n" .'- **NAS**: Backs up NAS file systems.'."\n" ."\n" .'- **OTS**: Backs up Tablestore instances.'."\n" ."\n" .'- **UDM\\_ECS**: Backs up an entire ECS instance.'."\n" ."\n" .'- **SYNC**: Performs data synchronization.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ECS_FILE', 'title' => ''], ], [ 'name' => 'PlanName', 'in' => 'query', 'allowEmptyValue' => false, 'schema' => ['description' => 'The name of the backup plan. The name must be 1 to 64 characters in length. The name must be unique for each data source type within a backup repository.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'maxLength' => 64, 'minLength' => 1, 'example' => 'planname', 'title' => ''], ], [ 'name' => 'BackupType', 'in' => 'query', 'schema' => ['description' => 'The backup type. Set the value to **COMPLETE**, which specifies a full backup.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'COMPLETE', 'title' => ''], ], [ 'name' => 'VaultId', 'in' => 'query', 'schema' => ['description' => 'The ID of the backup repository.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'v-0006******q', 'title' => ''], ], [ 'name' => 'Schedule', 'in' => 'query', 'schema' => ['description' => 'The backup policy. The format is `I|{startTime}|{interval}`. This specifies that a backup job runs at an interval of `{interval}`, starting from `{startTime}`. Overdue backup jobs are not retried. If the previous backup job is not complete, the next backup job is not triggered. For example, `I|1631685600|P1D` indicates that a backup job runs daily starting from 14:00:00 on September 15, 2021.'."\n" ."\n" .'- **startTime**: The start time for the backup, specified as a UNIX timestamp in seconds.'."\n" ."\n" .'- **interval**: The backup interval, specified in the ISO 8601 duration format. For example, `PT1H` represents one hour and `P1D` represents one day.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'I|1602673264|P1D', 'title' => ''], ], [ 'name' => 'Retention', 'in' => 'query', 'schema' => ['description' => 'The backup retention period, in days. The minimum value is 1.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'docRequired' => true, 'example' => '7', 'title' => ''], ], [ 'name' => 'ClusterId', 'in' => 'query', 'schema' => ['description' => 'The ID of the client group that runs the data synchronization job. This parameter is required only if `SourceType` is set to `SYNC`.', 'type' => 'string', 'required' => false, 'example' => 'cl-***************', 'title' => ''], ], [ 'name' => 'FileSystemId', 'in' => 'query', 'schema' => ['description' => 'The ID of the file system. This parameter is required only if **SourceType** is set to **NAS**.', 'type' => 'string', 'required' => false, 'example' => '005494', 'title' => ''], ], [ 'name' => 'CreateTime', 'in' => 'query', 'schema' => ['description' => 'The time when the file system was created, specified as a UNIX timestamp in seconds. This parameter is required only if **SourceType** is set to **NAS**.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1607436917', 'title' => ''], ], [ 'name' => 'Bucket', 'in' => 'query', 'schema' => ['description' => 'The name of the OSS bucket. This parameter is required only if **SourceType** is set to **OSS**.', 'type' => 'string', 'required' => false, 'example' => 'hbr-backup-oss', 'title' => ''], ], [ 'name' => 'Prefix', 'in' => 'query', 'schema' => ['description' => 'The prefix of the objects to back up. If specified, only objects with this prefix are backed up. This parameter is required only if **SourceType** is set to **OSS**.', 'type' => 'string', 'required' => false, 'example' => 'oss-prefix', 'title' => ''], ], [ 'name' => 'InstanceId', 'in' => 'formData', 'schema' => ['description' => 'The ID of the ECS instance. This parameter is required only if **SourceType** is set to **ECS\\_FILE**.', 'type' => 'string', 'required' => false, 'example' => 'i-m5e*****6q', 'title' => ''], ], [ 'name' => 'Detail', 'in' => 'query', 'style' => 'json', 'schema' => ['description' => 'The details of an entire instance backup, specified as a JSON string.'."\n" ."\n" .'- `snapshotGroup`: Specifies whether to use a snapshot-consistent group. This feature is available only if all disks of the instance are ESSDs.'."\n" ."\n" .'- `appConsistent`: Specifies whether to enable application consistency. This must be used with the `preScriptPath` and `postScriptPath` parameters.'."\n" ."\n" .'- `preScriptPath`: The path to the pre-freeze script.'."\n" ."\n" .'- `postScriptPath`: The path to the post-thaw script.', 'type' => 'object', 'required' => false, 'example' => '{\\"EnableFsFreeze\\":true,\\"appConsistent\\":false,\\"postScriptPath\\":\\"\\",\\"preScriptPath\\":\\"\\",\\"snapshotGroup\\":true,\\"timeoutInSeconds\\":60}', 'title' => ''], ], [ 'name' => 'UdmRegionId', 'in' => 'query', 'schema' => ['description' => 'The region where the ECS instance is located.', 'type' => 'string', 'required' => false, 'example' => 'cn-shanghai', 'title' => ''], ], [ 'name' => 'SpeedLimit', 'in' => 'formData', 'schema' => ['description' => 'The traffic shaping policy for the backup. Format: `{start}:{end}:{bandwidth}`. You can specify multiple rules separated by vertical bars (`|`). The specified time ranges cannot overlap. This parameter is required only if **SourceType** is set to **ECS\\_FILE**.'."\n" ."\n" .'- **start**: The start hour.'."\n" ."\n" .'- **end**: The end hour.'."\n" ."\n" .'- **bandwidth**: The bandwidth limit, in KB/s.', 'type' => 'string', 'required' => false, 'example' => '0:24:5120', 'title' => ''], ], [ 'name' => 'Include', 'in' => 'formData', 'schema' => ['description' => 'The paths of the files and directories to include in the backup. The path can be up to 255 characters in length. This parameter is required only if **SourceType** is set to **ECS\\_FILE**.', 'type' => 'string', 'required' => false, 'example' => '["/home/alice/*.pdf", "/home/bob/*.txt"]', 'title' => ''], ], [ 'name' => 'Exclude', 'in' => 'formData', 'schema' => ['description' => 'The paths of the files and directories to exclude from the backup. The path can be up to 255 characters in length. This parameter is required only if **SourceType** is set to **ECS\\_FILE**.', 'type' => 'string', 'required' => false, 'example' => '["/var", "/proc"]', 'title' => ''], ], [ 'name' => 'Options', 'in' => 'formData', 'schema' => ['description' => 'Specifies whether to use Windows Volume Shadow Copy Service (VSS) to ensure data consistency. This parameter is required only if **SourceType** is set to **ECS\\_FILE**.'."\n" ."\n" .'- This feature is available only for Windows ECS instances.'."\n" ."\n" .'- If data in the backup source changes during the backup, set this parameter to `{"UseVSS":true}` to ensure data consistency.'."\n" ."\n" .'- If you enable VSS, you cannot back up multiple file directories at the same time.', 'type' => 'string', 'required' => false, 'example' => '{"UseVSS":false}', 'title' => ''], ], [ 'name' => 'DataSourceId', 'in' => 'formData', 'schema' => ['description' => 'The ID of the source data source. This parameter is required only if `SourceType` is set to `SYNC`.', 'type' => 'string', 'required' => false, 'example' => 'ds-****************', 'title' => ''], ], [ 'name' => 'Path', 'in' => 'formData', 'style' => 'repeatList', 'schema' => [ 'description' => 'The backup paths.', 'type' => 'array', 'items' => ['description' => 'A backup path. The path can be up to 65,536 characters in length.'."\n" .'The following rules apply to backup paths:'."\n" ."\n" .'- If you do not use wildcards (`*`), you can specify up to 20 paths.'."\n" ."\n" .'- If you use wildcards (`*`), you can specify only one path. Wildcard patterns such as `/*/*` are supported.'."\n" ."\n" .'- Each path must be an absolute path.'."\n" ."\n" .'- If VSS is enabled, you cannot use multiple paths, UNC paths, wildcards, or file exclusions.'."\n" ."\n" .'- When a UNC path is used, VSS, wildcards, and file exclusions are not supported. If the backup source contains UNC paths, Windows ACLs are not backed up.', 'type' => 'string', 'required' => false, 'example' => '["/home"]', 'title' => ''], 'required' => false, 'maxItems' => 20, 'title' => '', 'example' => '', ], ], [ 'name' => 'Rule', 'in' => 'formData', 'style' => 'repeatList', 'schema' => [ 'description' => 'The backup rules.', 'type' => 'array', 'items' => [ 'description' => 'A backup rule.', 'type' => 'object', 'properties' => [ 'DestinationRetention' => ['description' => 'The retention period of the geo-redundant backup, in days.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '7', 'title' => ''], 'Schedule' => ['description' => 'The backup policy. The format is `I|{startTime}|{interval}`. This specifies that a backup job runs at an interval of `{interval}`, starting from `{startTime}`. Overdue backup jobs are not retried. If the previous backup job is not complete, the next backup job is not triggered. For example, `I|1631685600|P1D` indicates that a backup job runs daily starting from 14:00:00 on September 15, 2021.'."\n" ."\n" .'In the format, startTime is the backup start time (a UNIX timestamp in seconds), and interval is the backup interval (in ISO 8601 duration format). For example, PT1H represents one hour and P1D represents one day.', 'type' => 'string', 'required' => false, 'example' => 'I|1602673264|P1D', 'title' => ''], 'Retention' => ['description' => 'The retention period of the backup, in days.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'minimum' => '1', 'example' => '7', 'title' => ''], 'Disabled' => ['description' => 'Specifies whether to disable the rule.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], 'DoCopy' => ['description' => 'Specifies whether to enable geo-redundancy for the backup.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], 'DestinationRegionId' => ['description' => 'The ID of the destination region for geo-redundancy.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''], 'RuleName' => ['description' => 'The name of the rule.', 'type' => 'string', 'required' => false, 'example' => 'rule-test-name', 'title' => ''], 'BackupType' => ['description' => 'The backup type.', 'type' => 'string', 'required' => false, 'example' => 'COMPLETE', 'title' => ''], ], 'required' => false, 'title' => '', 'example' => '', ], 'required' => false, 'maxItems' => 64, 'title' => '', 'example' => '', ], ], [ 'name' => 'InstanceName', 'in' => 'formData', 'schema' => ['description' => 'The name of the Tablestore instance.', 'type' => 'string', 'required' => false, 'example' => 'instancename', 'title' => ''], ], [ 'name' => 'OtsDetail', 'in' => 'formData', 'style' => 'json', 'schema' => ['description' => 'The details of the Tablestore instance.', '$ref' => '#/components/schemas/OtsDetail', 'required' => false, 'title' => '', 'example' => ''], ], [ 'name' => 'CrossAccountType', 'in' => 'query', 'schema' => [ 'description' => 'The type of cross-account backup. Valid values:'."\n" ."\n" .'- `SELF_ACCOUNT`: Backs up data within the same account.'."\n" ."\n" .'- `CROSS_ACCOUNT`: Backs up data to a different account.', 'enumValueTitles' => ['SELF_ACCOUNT' => 'SELF\\_ACCOUNT', 'CROSS_ACCOUNT' => 'CROSS\\_ACCOUNT'], 'type' => 'string', 'required' => false, 'example' => 'CROSS_ACCOUNT', 'title' => '', ], ], [ 'name' => 'CrossAccountUserId', 'in' => 'query', 'schema' => ['description' => 'The ID of the source Alibaba Cloud account for a cross-account backup.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '15897534xxxx4625', 'title' => ''], ], [ 'name' => 'CrossAccountRoleName', 'in' => 'query', 'schema' => ['description' => 'The name of the RAM role that is created in the source account.', 'type' => 'string', 'required' => false, 'example' => 'BackupRole', 'title' => ''], ], [ 'name' => 'KeepLatestSnapshots', 'in' => 'query', 'schema' => [ 'description' => 'Specifies whether to permanently retain the latest backup snapshots.'."\n" ."\n" .'- `0`: Do not retain.'."\n" ."\n" .'- `1`: Retain.', 'enumValueTitles' => ['No', 'Yes'], 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'title' => '', ], ], [ 'name' => 'DestSourceType', 'in' => 'query', 'schema' => ['description' => 'The type of the destination data source. This parameter is required only if `SourceType` is set to `SYNC`.', 'type' => 'string', 'required' => false, 'example' => 'OSS', 'title' => ''], ], [ 'name' => 'DestDataSourceId', 'in' => 'query', 'schema' => ['description' => 'The ID of the destination data source. This parameter is required only if `SourceType` is set to `SYNC`.', 'type' => 'string', 'required' => false, 'example' => 'ds-*********************'."\n", 'title' => ''], ], [ 'name' => 'DestDataSourceDetail', 'in' => 'query', 'style' => 'json', 'schema' => ['description' => 'The details of the destination data source. This parameter is required only if `SourceType` is set to `SYNC`.', 'type' => 'object', 'required' => false, 'example' => '{\\"prefix\\":\\"/\\"}', 'title' => ''], ], [ 'name' => 'ChangeListPath', 'in' => 'query', 'schema' => ['description' => 'The changelist configuration for incremental file synchronization. This parameter is required only if `SourceType` is set to `SYNC`.', 'type' => 'string', 'required' => false, 'example' => '{"dataSourceId": "ds-123456789", "path": "/changelist"}', 'title' => ''], ], [ 'name' => 'Disabled', 'in' => 'query', 'schema' => ['description' => 'Specifies whether to disable the backup plan upon creation.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], ], [ 'name' => 'Edition', 'in' => 'query', 'schema' => ['description' => 'The edition of the backup plan. Valid values are `BASIC` and `STANDARD`. Default value: `STANDARD`.', 'type' => 'string', 'required' => false, 'example' => 'STANDARD', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The data returned.', 'type' => 'object', 'properties' => [ 'Code' => ['description' => 'The response code. A value of 200 indicates that the request was successful.', 'type' => 'string', 'example' => '200', 'title' => ''], 'Message' => ['description' => 'The response message. If the request is successful, the value is `successful`. If the request fails, an error message is returned.', 'type' => 'string', 'example' => 'successful', 'title' => ''], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E', 'title' => ''], 'PlanId' => ['description' => 'The backup plan ID.', 'type' => 'string', 'example' => 'plan-*********************', 'title' => ''], 'Success' => ['description' => 'Indicates whether the request was successful.'."\n" ."\n" .'- `true`: The request was successful.'."\n" ."\n" .'- `false`: The request failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], 'title' => '', 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\",\\n \\"PlanId\\": \\"plan-*********************\\",\\n \\"Success\\": true\\n}","type":"json"}]', 'title' => 'CreateBackupPlan', 'description' => '>'."\n" ."\n" .'- Call this API to use features such as the basic edition of ECS file backup, cloud disk backup, container backup, the free trial of TableStore backup, archiving, or data synchronization.'."\n" ."\n" .'- To use the 30-day free trial for NAS backup or OSS backup, call the `CreateTrialBackupPlan` operation.'."\n" ."\n" .'- To use the standard capabilities of ECS file backup, local file backup, ECS instance backup, NAS backup, OSS backup, or CPFS backup, call the `CreatePolicyV2` and `CreatePolicyBindings` operations.'."\n" ."\n" .'>'."\n" ."\n" .'- Executing a backup plan creates a backup job to record its progress and result. A successful job generates a backup snapshot, which you can use to create a restore job.'."\n" ."\n" .'- A backup plan supports only one data source.'."\n" ."\n" .'- A backup plan supports only one backup policy with a fixed-interval cycle.'."\n" ."\n" .'- A backup plan can back up to only one backup repository.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CreateBackupPlan'], ], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'hbr:CreateBackupPlan', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'HBR', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], ], 'CreateClients' => [ 'methods' => ['post', 'get'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '95433', 'abilityTreeNodes' => ['FEATUREhbrI97IXK'], ], 'parameters' => [ [ 'name' => 'VaultId', 'in' => 'query', 'schema' => ['description' => 'The ID of the backup vault.'."\n", 'type' => 'string', 'required' => true, 'example' => 'v-0001ufe******kgm', 'title' => ''], ], [ 'name' => 'AlertSetting', 'in' => 'query', 'schema' => ['description' => 'The alert settings. Valid value: INHERITED, which indicates that the HBR client sends alert notifications by using the same method configured for the backup vault.'."\n", 'type' => 'string', 'required' => false, 'example' => 'INHERITED', 'title' => ''], ], [ 'name' => 'ClientInfo', 'in' => 'query', 'schema' => ['description' => 'The installation information of the HBR clients.'."\n", 'type' => 'string', 'required' => false, 'example' => '[ { "instanceId": "i-bp116lr******te9q2", "accessKeyId": "", "accessKeySecret": "", "clusterId": "cl-000csy09q******9rfz9", "sourceTypes": [ "HANA" ] }, { "instanceId": "i-bp116lrux******hte9q4", "accessKeyId": "", "accessKeySecret": "", "clusterId": "cl-000csy09q5094vw9rfz9", "sourceTypes": [ "HANA" ] }]', 'docRequired' => true, 'title' => ''], ], [ 'name' => 'UseHttps', 'in' => 'query', 'schema' => ['description' => 'Specifies whether to transmit data over HTTPS. Valid values:'."\n" ."\n" .'* true: transmits data over HTTPS.'."\n" .'* false: transmits data over HTTP.'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], ], [ 'name' => 'ResourceGroupId', 'in' => 'query', 'schema' => ['description' => 'The ID of the resource group.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rg-aekzvx7d3c4kpny', 'title' => ''], ], [ 'name' => 'CrossAccountType', 'in' => 'query', 'schema' => ['description' => 'The backup type. Valid values:'."\n" ."\n" .'- **SELF_ACCOUNT**: Data is backed up within the same Alibaba Cloud account.'."\n" .'- **CROSS_ACCOUNT**: Data is backed up across Alibaba Cloud accounts.', 'type' => 'string', 'required' => false, 'example' => 'CROSS_ACCOUNT', 'title' => ''], ], [ 'name' => 'CrossAccountUserId', 'in' => 'query', 'schema' => ['description' => 'The ID of the source Alibaba Cloud account that authorizes the current Alibaba Cloud account to back up data across Alibaba Cloud accounts.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '158975xxxxx4625', 'title' => ''], ], [ 'name' => 'CrossAccountRoleName', 'in' => 'query', 'schema' => ['description' => 'The name of the Resource Access Management (RAM) role that is created within the source Alibaba Cloud account and assigned to the current Alibaba Cloud account to authorize the current Alibaba Cloud account to back up data across Alibaba Cloud accounts.', 'type' => 'string', 'required' => false, 'example' => 'hbrcrossrole', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Code' => ['description' => 'The HTTP status code. The status code 200 indicates that the call is successful.'."\n", 'type' => 'string', 'example' => '200', 'title' => ''], 'Message' => ['description' => 'The message that is returned. If the call is successful, "successful" is returned. If the call fails, an error message is returned.'."\n", 'type' => 'string', 'example' => 'successful', 'title' => ''], 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '4A8A9AE4-F798-5E6D-853E-10F9F5A1BD4E', 'title' => ''], 'TaskId' => ['description' => 'The ID of the asynchronous job. You can call the DescribeTask operation to query the execution result of an asynchronous job.'."\n", 'type' => 'string', 'example' => 't-000h9x5t02vhyksf1x7k', 'title' => ''], 'Success' => ['description' => 'Indicates whether the call is successful. Valid values:'."\n" ."\n" .'* true: The call is successful.'."\n" .'* false: The call fails.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'InstanceStatuses' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'InstanceStatus' => [ 'description' => 'The status of the ECS instance. If you specify more than one instance IDs in the request and the status of an ECS instance does not meet the requirements to install an HBR client, an error message is returned based on the value of this parameter.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The status of the ECS instance. If you specify more than one instance IDs in the request and the status of an ECS instance does not meet the requirements to install an HBR client, an error message is returned based on the value of this parameter.'."\n", 'type' => 'object', 'properties' => [ 'ValidInstance' => ['description' => 'Indicates whether an HBR client can be installed on the ECS instance. Valid values:'."\n" ."\n" .'* true: An HBR client can be installed on the ECS instance.'."\n" .'* false: An HBR client cannot be installed on the ECS instance.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'InstanceId' => ['description' => 'The ID of the ECS instance.'."\n", 'type' => 'string', 'example' => 'i-2zegp3cdu******uj9i', 'title' => ''], ], 'title' => '', ], 'title' => '', ], ], 'description' => '', 'title' => '', ], ], 'description' => '', 'title' => '', ], ], ], 'title' => 'CreateClients', 'summary' => 'Installs one or more Cloud Backup clients on specified instances.', 'description' => 'Before you call this operation, make sure that you fully understand the billing methods and pricing of Cloud Backup. For more information, see [Billing methods and billable items](~~89062~~).'."\n", 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CreateClients'], ], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'hbr:CreateClients', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'HBR', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"4A8A9AE4-F798-5E6D-853E-10F9F5A1BD4E\\",\\n \\"TaskId\\": \\"t-000h9x5t02vhyksf1x7k\\",\\n \\"Success\\": true,\\n \\"InstanceStatuses\\": {\\n \\"InstanceStatus\\": [\\n {\\n \\"ValidInstance\\": true,\\n \\"InstanceId\\": \\"i-2zegp3cdu******uj9i\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 200\\n successful\\n 4A8A9AE4-F798-5E6D-853E-10F9F5A1BD4E\\n t-000h9x5t02vhyksf1x7k\\n true\\n \\n true\\n i-2zegp3cdu******uj9i\\n \\n","errorExample":""}]', ], 'CreateHanaBackupPlan' => [ 'methods' => ['post', 'get'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'systemTags' => ['operationType' => 'create'], 'parameters' => [ [ 'name' => 'VaultId', 'in' => 'query', 'schema' => ['description' => 'The ID of the backup vault.'."\n", 'type' => 'string', 'required' => true, 'example' => 'v-0002pcwhdn******wmi'], ], [ 'name' => 'ClusterId', 'in' => 'query', 'schema' => ['description' => 'The ID of the SAP HANA instance.'."\n", 'type' => 'string', 'required' => true, 'example' => 'cl-00024vyjj9******v'], ], [ 'name' => 'PlanName', 'in' => 'query', 'schema' => ['description' => 'The name of the backup plan.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'plan-20220110-113108'], ], [ 'name' => 'Schedule', 'in' => 'query', 'schema' => ['description' => 'The backup policy. Format: `I|{startTime}|{interval}`. The system runs the first backup job at a point in time that is specified in the {startTime} parameter and the subsequent backup jobs at an interval that is specified in the {interval} parameter. The system does not run a backup job before the specified point in time. Each backup job, except the first one, starts only after the previous backup job is completed. For example, `I|1631685600|P1D` specifies that the system runs the first backup job at 14:00:00 on September 15, 2021 and the subsequent backup jobs once a day.'."\n" ."\n" .'* startTime: the time at which the system starts to run a backup job. The time must follow the UNIX time format. Unit: seconds.'."\n" .'* interval: the interval at which the system runs a backup job. The interval must follow the ISO 8601 standard. For example, PT1H specifies an interval of one hour. P1D specifies an interval of one day.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'I|1602673264|P1D'], ], [ 'name' => 'BackupType', 'in' => 'query', 'schema' => [ 'description' => 'The backup type. Valid values:'."\n" ."\n" .'* COMPLETE: full backup'."\n" .'* INCREMENTAL: incremental backup'."\n" .'* DIFFERENTIAL: differential backup'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'enumValueTitles' => [], 'example' => 'COMPLETE', ], ], [ 'name' => 'DatabaseName', 'in' => 'query', 'schema' => ['description' => 'The name of the database.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'SYSTEMDB'], ], [ 'name' => 'BackupPrefix', 'in' => 'query', 'schema' => ['description' => 'The backup prefix.'."\n", 'type' => 'string', 'required' => false, 'example' => 'DIFF_DATA_BACKUP'], ], [ 'name' => 'ResourceGroupId', 'in' => 'query', 'schema' => ['description' => 'The ID of the resource group.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rg-acfmvnf22m7itha'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Code' => ['description' => 'The HTTP status code. The status code 200 indicates that the request was successful.'."\n", 'type' => 'string', 'example' => '200'], 'Message' => ['description' => 'The returned message. If the request was successful, "successful" is returned. If the request failed, an error message is returned.'."\n", 'type' => 'string', 'example' => 'successful'], 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '33AA3AAE-89E1-5D3A-A51D-0C0A80850F68'], 'PlanId' => ['description' => 'The ID of the backup plan.'."\n", 'type' => 'string', 'example' => 'pl-000756jdlk2zmqig2nea'], 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" ."\n" .'* true'."\n" .'* false'."\n", 'type' => 'boolean', 'example' => 'true'], ], 'description' => '', ], ], ], 'title' => 'CreateHanaBackupPlan', 'summary' => 'Creates a backup plan for an SAP HANA instance.', 'description' => '* A backup plan defines the data source, backup policy, and other configurations. After you execute a backup plan, a backup job is generated to record the backup progress and the backup result. If a backup job is completed, a backup snapshot is generated. You can use a backup snapshot to create a restore job.'."\n" .'* You can specify only one type of data source in a backup plan.'."\n" .'* You can specify only one interval as a backup cycle in a backup plan.'."\n" .'* Each backup plan allows you to back up data to only one backup vault.'."\n", 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CreateHanaBackupPlan'], ], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'hbr:CreateHanaBackupPlan', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'HBR', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"33AA3AAE-89E1-5D3A-A51D-0C0A80850F68\\",\\n \\"PlanId\\": \\"pl-000756jdlk2zmqig2nea\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n 200\\n successful\\n 33AA3AAE-89E1-5D3A-A51D-0C0A80850F68\\n pl-000756jdlk2zmqig2nea\\n true\\n","errorExample":""}]', ], 'CreateHanaInstance' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '95438', 'abilityTreeNodes' => ['FEATUREhbrI97IXK'], ], 'parameters' => [ [ 'name' => 'VaultId', 'in' => 'query', 'schema' => ['description' => 'The ID of the backup vault.'."\n", 'type' => 'string', 'required' => true, 'example' => 'v-0003v4a******gfv2', 'docRequired' => true, 'title' => ''], ], [ 'name' => 'HanaName', 'in' => 'query', 'schema' => ['description' => 'The name of the SAP HANA instance.'."\n", 'type' => 'string', 'required' => false, 'example' => 'HANA-DEV', 'docRequired' => true, 'title' => ''], ], [ 'name' => 'Host', 'in' => 'query', 'schema' => ['description' => 'The private or internal IP address of the host where the primary node of the SAP HANA instance resides.'."\n", 'type' => 'string', 'required' => false, 'example' => '47.100.XX.XX', 'docRequired' => true, 'title' => ''], ], [ 'name' => 'InstanceNumber', 'in' => 'query', 'schema' => ['description' => 'The instance number of the SAP HANA system.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '00', 'docRequired' => true, 'title' => ''], ], [ 'name' => 'UserName', 'in' => 'query', 'schema' => ['description' => 'The username of the SYSTEMDB database.'."\n", 'type' => 'string', 'required' => false, 'example' => 'admin', 'docRequired' => true, 'title' => ''], ], [ 'name' => 'Password', 'in' => 'query', 'schema' => ['description' => 'The password that is used to connect with the SAP HANA database.'."\n", 'type' => 'string', 'required' => false, 'example' => '************', 'docRequired' => true, 'title' => ''], ], [ 'name' => 'UseSsl', 'in' => 'query', 'schema' => ['description' => 'Specifies whether to connect with the SAP HANA database over Secure Sockets Layer (SSL).'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], ], [ 'name' => 'ValidateCertificate', 'in' => 'query', 'schema' => ['description' => 'Specifies whether to verify the SSL certificate of the SAP HANA database.'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], ], [ 'name' => 'AlertSetting', 'in' => 'query', 'schema' => ['description' => 'The alert settings. Valid value: INHERITED, which indicates that the Cloud Backup client sends alert notifications by using the same method configured for the backup vault.'."\n", 'type' => 'string', 'required' => false, 'example' => 'INHERITED', 'title' => ''], ], [ 'name' => 'EcsInstanceId', 'in' => 'query', 'schema' => ['description' => 'The IDs of the ECS instances that host the SAP HANA instance to be registered. Cloud Backup installs backup clients on the specified ECS instances.'."\n", 'type' => 'string', 'required' => false, 'example' => '[\\"i-uf6ir9y******hvisj\\"]', 'title' => ''], ], [ 'name' => 'Sid', 'in' => 'query', 'schema' => ['description' => 'The security identifier (SID) of the SAP HANA database. For more information, see [How to find sid user and instance number of HANA db?](https://answers.sap.com/questions/555192/how-to-find-sid-user-and-instance-number-of-hana-d.html?spm=a2c4g.11186623.0.0.55c34b4ftZeXNK).'."\n", 'type' => 'string', 'required' => false, 'example' => 'HXE', 'title' => ''], ], [ 'name' => 'ResourceGroupId', 'in' => 'query', 'schema' => ['description' => 'The ID of the resource group.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rg-acfm4ebtpkzx7zy', 'title' => ''], ], [ 'name' => 'CrossAccountType', 'in' => 'query', 'schema' => ['description' => 'The backup type. Valid values:'."\n" ."\n" .'- **SELF_ACCOUNT**: Data is backed up within the same Alibaba Cloud account.'."\n" .'- **CROSS_ACCOUNT**: Data is backed up across Alibaba Cloud accounts.', 'type' => 'string', 'required' => false, 'example' => 'CROSS_ACCOUNT', 'title' => ''], ], [ 'name' => 'CrossAccountUserId', 'in' => 'query', 'schema' => ['description' => 'The ID of the source Alibaba Cloud account that authorizes the current Alibaba Cloud account to back up data across Alibaba Cloud accounts.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '158975xxxxx4625', 'title' => ''], ], [ 'name' => 'CrossAccountRoleName', 'in' => 'query', 'schema' => ['description' => 'The name of the Resource Access Management (RAM) role that is created within the source Alibaba Cloud account and assigned to the current Alibaba Cloud account to authorize the current Alibaba Cloud account to back up data across Alibaba Cloud accounts.', 'type' => 'string', 'required' => false, 'example' => 'hbrcrossrole', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Code' => ['description' => 'The response code. The status code 200 indicates that the request was successful.'."\n", 'type' => 'string', 'example' => '200', 'title' => ''], 'Message' => ['description' => 'The returned message. If the request was successful, "successful" is returned. If the request failed, an error message is returned.'."\n", 'type' => 'string', 'example' => 'successful', 'title' => ''], 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'EB526A5D-1FE2-51C1-B790-1732C1DBA969', 'title' => ''], 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" ."\n" .'* true'."\n" .'* false'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'ClusterId' => ['description' => 'The ID of the SAP HANA instance.'."\n", 'type' => 'string', 'example' => 'cl-000dp1sz******6hn', 'title' => ''], ], 'description' => '', 'title' => '', ], ], ], 'title' => 'CreateHanaInstance', 'summary' => 'Registers an SAP HANA instance.', 'description' => 'To register an SAP HANA instance, you must configure the SAP HANA connection information. After the SAP HANA instance is registered, Cloud Backup installs a backup client on the node of the SAP HANA instance.'."\n", 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CreateHanaInstance'], ], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'hbr:CreateHanaInstance', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'HBR', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"EB526A5D-1FE2-51C1-B790-1732C1DBA969\\",\\n \\"Success\\": true,\\n \\"ClusterId\\": \\"cl-000dp1sz******6hn\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 200\\n successful\\n EB526A5D-1FE2-51C1-B790-1732C1DBA969\\n true\\n cl-000dp1sz******6hn\\n","errorExample":""}]', ], 'CreateHanaRestore' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => ['operationType' => 'create'], 'parameters' => [ [ 'name' => 'VaultId', 'in' => 'query', 'schema' => ['description' => 'The ID of the backup vault.'."\n", 'type' => 'string', 'required' => false, 'example' => 'v-000************yqr'], ], [ 'name' => 'ClusterId', 'in' => 'query', 'schema' => ['description' => 'The ID of the SAP HANA instance that you want to restore.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cl-000fbrs5******ka9w'], ], [ 'name' => 'DatabaseName', 'in' => 'query', 'schema' => ['description' => 'The name of the database that you want to restore.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'TS2'], ], [ 'name' => 'BackupId', 'in' => 'query', 'schema' => ['description' => 'The ID of the backup.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'docRequired' => true, 'example' => '1645628400235'], ], [ 'name' => 'Mode', 'in' => 'query', 'schema' => ['description' => 'The recovery mode. Valid values:'."\n" ."\n" .'* **RECOVERY_TO_MOST_RECENT**: restores the database to the recently available state to which the database has been backed up.'."\n" .'* **RECOVERY_TO_POINT_IN_TIME**: restores the database to a specified point in time.'."\n" .'* **RECOVERY_TO_SPECIFIC_BACKUP**: restores the database to a specified backup.'."\n" .'* **RECOVERY_TO_LOG_POSITION**: restores the database to a specified log position.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'RECOVERY_TO_POINT_IN_TIME'], ], [ 'name' => 'RecoveryPointInTime', 'in' => 'query', 'schema' => ['description' => 'The point in time to which you want to restore the database. This parameter is valid only if you set the Mode parameter to **RECOVERY_TO_POINT_IN_TIME**. HBR restores the database to a state closest to the specified point in time.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1635315505'], ], [ 'name' => 'LogPosition', 'in' => 'query', 'schema' => ['description' => 'The log position to which you want to restore the database. This parameter is valid only if you set the Mode parameter to **RECOVERY_TO_LOG_POSITION**.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '0'], ], [ 'name' => 'VolumeId', 'in' => 'query', 'schema' => ['description' => 'The ID of the volume that you want to restore. This parameter is valid only if you set the Mode parameter to **RECOVERY_TO_LOG_POSITION**.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0'], ], [ 'name' => 'UseCatalog', 'in' => 'query', 'schema' => ['description' => 'Specifies whether to use a catalog backup to restore the database. This parameter is required only if you set the Mode parameter to **RECOVERY_TO_SPECIFIC_BACKUP**. If you turn off Use Catalog, you must specify the prefix of a backup file. Then, Cloud Backup finds the backup file based on the specified prefix and restores the backup file.'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'false', 'default' => 'true'], ], [ 'name' => 'BackupPrefix', 'in' => 'query', 'schema' => ['description' => 'The backup prefix.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'COMPLETE_DATA_BACKUP_2022_05_02_15_39'], ], [ 'name' => 'SystemCopy', 'in' => 'query', 'schema' => ['description' => 'Specifies whether to restore the database to a different instance.'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'false'], ], [ 'name' => 'Source', 'in' => 'query', 'schema' => ['description' => 'The name of the source system. This parameter specifies the name of the source database that you want to restore. You must set the parameter in the `@SID` format.'."\n", 'type' => 'string', 'required' => false, 'example' => 'HNP@HNP'], ], [ 'name' => 'SourceClusterId', 'in' => 'query', 'schema' => ['description' => 'The ID of the source SAP HANA instance.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cl-000ii8tzv******xm0t'], ], [ 'name' => 'ClearLog', 'in' => 'query', 'schema' => ['description' => 'Specifies whether to delete all log entries from the log area after the log entries are restored. Valid values: true and false. If you set the value to false, all log entries are deleted from the log area after the log entries are restored.'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'false'], ], [ 'name' => 'CheckAccess', 'in' => 'query', 'schema' => ['description' => 'Specifies whether to validate the differential backup and log backup. Valid values: true and false. If you set the value to true, HBR checks whether the required differential backup and log backup are available before the restore job starts. If the differential backup or log backup is unavailable, HBR does not start the restore job.'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'false'], ], [ 'name' => 'UseDelta', 'in' => 'query', 'schema' => ['description' => 'Specifies whether to use a differential backup or an incremental backup to restore the database. Valid values: true and false. If you want to use a differential backup or an incremental backup to restore the database, set the value to true. If you set the value to false, HBR uses a log backup to restore the database.'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'true'], ], [ 'name' => 'SidAdmin', 'in' => 'query', 'schema' => ['description' => 'The SID admin account that is created by SAP HANA.'."\n", 'type' => 'string', 'required' => false, 'example' => 'DB'], ], [ 'name' => 'MasterClientId', 'in' => 'query', 'schema' => ['description' => 'The ID of the client where the primary node of the SAP HANA resides.'."\n", 'type' => 'string', 'required' => false, 'example' => 'c-000ii8tzv**********'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Code' => ['description' => 'The HTTP status code. The status code 200 indicates that the call is successful.'."\n", 'type' => 'string', 'example' => '200'], 'Message' => ['description' => 'The message that is returned. If the call is successful, "successful" is returned. If the call fails, an error message is returned.'."\n", 'type' => 'string', 'example' => 'successful'], 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => 'EEC65C22-2152-5E31-8AD6-D6CBF1BFF49F'], 'Success' => ['description' => 'Indicates whether the call is successful. Valid values:'."\n" ."\n" .'* true: The call is successful.'."\n" .'* false: The call fails.'."\n", 'type' => 'boolean', 'example' => 'true'], 'RestoreId' => ['description' => 'The ID of the restore job.'."\n", 'type' => 'string', 'example' => 'hr-000fb9bz190p1rse6jwv'], ], ], ], ], 'title' => 'CreateHanaRestore', 'summary' => 'Creates a restore job for an SAP HANA database.', 'description' => 'If you call this operation to restore a database, the database is restored to a specified state. Proceed with caution. For more information, see [Restore databases to an SAP HANA instance](~~101178~~).'."\n", 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CreateHanaRestore'], ], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'hbr:CreateHanaRestore', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'HBR', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"EEC65C22-2152-5E31-8AD6-D6CBF1BFF49F\\",\\n \\"Success\\": true,\\n \\"RestoreId\\": \\"hr-000fb9bz190p1rse6jwv\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 200\\n successful\\n EEC65C22-2152-5E31-8AD6-D6CBF1BFF49F\\n true\\n hr-000fb9bz190p1rse6jwv\\n","errorExample":""}]', ], 'CreatePolicyBindings' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'abilityTreeCode' => '136856', 'abilityTreeNodes' => ['FEATUREhbr56LH1C', 'FEATUREhbrFWIWBG', 'FEATUREhbrAW9I1R', 'FEATUREhbrB1KQ9G', 'FEATUREhbr3BJQCT', 'FEATUREhbr9ZUQY7'], ], 'parameters' => [ [ 'name' => 'PolicyId', 'in' => 'formData', 'schema' => ['description' => 'The ID of the backup policy.'."\n", 'type' => 'string', 'required' => false, 'example' => 'po-000************8ep', 'title' => ''], ], [ 'name' => 'PolicyBindingList', 'in' => 'query', 'style' => 'json', 'schema' => [ 'description' => 'The data sources that you want to bind to the backup policy.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The details of the data sources that you want to bind to the backup policy.'."\n", 'type' => 'object', 'properties' => [ 'PolicyBindingDescription' => ['description' => 'The description of the association.'."\n", 'type' => 'string', 'required' => false, 'example' => 'This is a policy bindable description.', 'title' => ''], 'DataSourceId' => ['description' => 'The ID of the data source. The meaning of this parameter depends on the **SourceType** parameter. Valid values:'."\n" ."\n" .'* **UDM_ECS**: the ID of the Elastic Compute Service (ECS) instance'."\n" .'* **OSS**: the name of the Object Storage Service (OSS) bucket'."\n" .'* **NAS**: the ID of the File Storage NAS (NAS) file system'."\n" .'* **COMMON_NAS**: the ID of the on-premises NAS file system'."\n" .'* **ECS_FILE**: the ID of the ECS instance'."\n" .'* **File**: the ID of the Cloud Backup client'."\n" .'* **COMMON_FILE_SYSTEM**: the ID of the Cloud Parallel File Storage (CPFS) backup data source'."\n", 'type' => 'string', 'required' => false, 'example' => 'i-bp1************dl8', 'title' => ''], 'Disabled' => ['description' => 'Specifies whether to disable the backup policy for the data source. Valid values:'."\n" ."\n" .'* true: disables the backup policy for the data source'."\n" .'* false: enables the backup policy for the data source'."\n", 'type' => 'string', 'required' => false, 'example' => 'true', 'title' => ''], 'SourceType' => ['description' => 'The type of the data source. Valid values:'."\n" ."\n" .'* **UDM_ECS**: ECS instance'."\n" .'* **OSS**: OSS bucket'."\n" .'* **NAS**: NAS file system'."\n" .'* **COMMON_NAS**: on-premises NAS file system'."\n" .'* **ECS_FILE**: ECS file'."\n" .'* **File**: on-premises file'."\n" .'* **COMMON_FILE_SYSTEM**: CPFS file system'."\n", 'type' => 'string', 'required' => false, 'example' => 'UDM_ECS', 'title' => ''], 'Source' => ['description' => '* If the SourceType parameter is set to **OSS**, set the Source parameter to the prefix of the path to the folder that you want to back up. If you do not specify the Source parameter, the entire bucket (root directory) is backed up.'."\n" .'* If the SourceType parameter is set to **ECS_FILE** or **File**, set the Source parameter to the path to the files that you want to back up. If you do not specify the Source parameter, all paths are backed up.'."\n" .'* This parameter is required if the SourceType parameter is set to **COMMON_FILE_SYSTEM**. This parameter specifies the path to be backed up. To back up the /src path, enter \\["/src"]. To back up the root path, enter \\["/"].'."\n", 'type' => 'string', 'required' => false, 'example' => 'backup/', 'title' => ''], 'Include' => ['description' => 'This parameter is required only if you set the **SourceType** parameter to **ECS_FILE**, **File**, **NAS**, **COMMON_NAS**, or **COMMON_FILE_SYSTEM**. This parameter specifies the type of files to be backed up. All files of the specified type are backed up. The value can be up to 255 characters in length.'."\n", 'type' => 'string', 'required' => false, 'example' => '[\\"*.doc\\",\\"*.xltm\\"]', 'title' => ''], 'Exclude' => ['description' => 'This parameter is required only if you set the **SourceType** parameter to **ECS_FILE**, **File**, **NAS**, **COMMON_NAS**, or **COMMON_FILE_SYSTEM**. This parameter specifies the type of files that do not need to be backed up. No files of the specified type are backed up. The value can be up to 255 characters in length.'."\n", 'type' => 'string', 'required' => false, 'example' => '[\\"*.doc\\",\\"*.xltm\\"]', 'title' => ''], 'SpeedLimit' => ['description' => 'This parameter is required only if you set the **SourceType** parameter to **ECS_FILE** or **File**. This parameter specifies the throttling rules. Format: `{start}{end}{bandwidth}`. Separate multiple throttling rules with vertical bars (|). The time ranges of the throttling rules cannot overlap.'."\n" ."\n" .'* **start**: the start hour.'."\n" .'* **end**: the end hour.'."\n" .'* **bandwidth**: the bandwidth. Unit: KB/s.'."\n", 'type' => 'string', 'required' => false, 'example' => '0:24:1024', 'title' => ''], 'AdvancedOptions' => [ 'description' => 'The advanced options.'."\n", 'type' => 'object', 'properties' => [ 'UdmDetail' => [ 'description' => 'The advanced options for ECS instance backup.'."\n", 'type' => 'object', 'properties' => [ 'ExcludeDiskIdList' => [ 'description' => 'The IDs of the disks that do not need to be protected. If the DiskIdList parameter is not empty, this parameter is ignored.'."\n", 'type' => 'array', 'items' => ['description' => 'The ID of the disk that does not need to be protected.'."\n", 'type' => 'string', 'required' => false, 'example' => 'd-bp1************apo', 'title' => ''], 'required' => false, 'title' => '', 'example' => '', ], 'DiskIdList' => [ 'description' => 'The IDs of the disks that need to be protected. If all disks need to be protected, this parameter is empty.'."\n", 'type' => 'array', 'items' => ['description' => 'The ID of the disk that needs to be protected.'."\n", 'type' => 'string', 'required' => false, 'example' => 'd-bp1************apo', 'title' => ''], 'required' => false, 'title' => '', 'example' => '', ], 'SnapshotGroup' => ['description' => 'Specifies whether to create a snapshot-consistent group. You can create a snapshot-consistent group only if all disks are Enterprise SSDs (ESSDs).'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], 'AppConsistent' => ['description' => 'Specifies whether to enable application consistency. You can enable application consistency only if all disks are ESSDs.'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], 'RamRoleName' => ['description' => 'This parameter is required only if you set the **AppConsistent** parameter to **true**. This parameter specifies the name of the Resource Access Management (RAM) role that is required to create application-consistent snapshots.'."\n", 'type' => 'string', 'required' => false, 'example' => 'AliyunECSInstanceForHbrRole', 'title' => ''], 'PreScriptPath' => ['description' => 'This parameter is required only if you set the **AppConsistent** parameter to **true**. This parameter specifies the path of the pre-freeze scripts that are executed before application-consistent snapshots are created.'."\n", 'type' => 'string', 'required' => false, 'example' => '/tmp/prescript.sh', 'title' => ''], 'PostScriptPath' => ['description' => 'This parameter is required only if you set the **AppConsistent** parameter to **true**. This parameter specifies the path of the post-thaw scripts that are executed after application-consistent snapshots are created.'."\n", 'type' => 'string', 'required' => false, 'example' => '/tmp/postscript.sh', 'title' => ''], 'EnableFsFreeze' => ['description' => 'This parameter is required only if you set the **AppConsistent** parameter to **true**. This parameter specifies whether to enable Linux fsfreeze to put file systems into the read-only state before application-consistent snapshots are created. Default value: true.'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], 'TimeoutInSeconds' => ['description' => 'This parameter is required only if you set the **AppConsistent** parameter to **true**. This parameter specifies the I/O freeze timeout period. Default value: 30. Unit: seconds.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '30', 'title' => ''], 'EnableWriters' => ['description' => 'This parameter is required only if you set the **AppConsistent** parameter to **true**. This parameter specifies whether to create application-consistent snapshots. Valid values:'."\n" ."\n" .'* true: creates application-consistent snapshots.'."\n" .'* false: creates file system-consistent snapshots.'."\n" ."\n" .'Default value: true.'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], ], 'required' => false, 'title' => '', 'example' => '', ], 'OssDetail' => [ 'description' => 'The advanced options for Object Storage Service (OSS) backup.'."\n", 'type' => 'object', 'properties' => [ 'InventoryId' => ['description' => 'The name of the OSS inventory. If this parameter is not empty, the OSS inventory is used for performance optimization.'."\n" ."\n" .'* If you want to back up more than 100 million OSS objects, we recommend that you use inventory lists to accelerate incremental backup. Storage fees for inventory lists are included into your OSS bills.'."\n" .'* A certain amount of time is required for OSS to generate inventory lists. Before inventory lists are generated, OSS objects may fail to be backed up. In this case, you can back up the OSS objects in the next backup cycle.'."\n", 'type' => 'string', 'required' => false, 'example' => 'oss-inventory-default', 'title' => ''], 'InventoryCleanupPolicy' => ['description' => 'Specifies whether the system deletes the inventory lists when a backup is completed. This parameter is valid only when OSS inventories are used. Valid values:'."\n" ."\n" .'* **NO_CLEANUP**: does not delete inventory lists.'."\n" .'* **DELETE_CURRENT**: deletes the current inventory list.'."\n" .'* **DELETE_CURRENT_AND_PREVIOUS**: deletes all inventory lists.'."\n", 'type' => 'string', 'required' => false, 'example' => 'NO_CLEANUP', 'title' => ''], 'IgnoreArchiveObject' => ['title' => '不在任务统计和失败文件列表中提示归档型对象', 'description' => 'Do not prompt for archival type objects in task statistics and failed file lists.', 'type' => 'boolean', 'required' => false, 'example' => 'true'], ], 'required' => false, 'title' => '', 'example' => '', ], 'FileDetail' => [ 'description' => 'The advanced options for file backup.'."\n", 'type' => 'object', 'properties' => [ 'UseVSS' => ['description' => 'Specifies whether to enable the Volume Shadow Copy Service (VSS) feature. Valid values:'."\n" ."\n" .'* **true**: enables the feature.'."\n" .'* **false**: disables the feature.'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], 'AdvPolicy' => ['description' => 'Specifies whether to use an advanced policy. Valid values:'."\n" ."\n" .'* **true**: uses the advanced policy.'."\n" .'* **false**: does not use the advanced policy.'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], ], 'required' => false, 'title' => '', 'example' => '', ], 'CommonNasDetail' => [ 'description' => 'The advanced options for on-premises NAS backup.'."\n", 'type' => 'object', 'properties' => [ 'FullOnIncrementFail' => ['description' => 'Specifies whether the system performs full backup if incremental backup fails. Valid values:'."\n" ."\n" .'* **true**: The system performs full backup if incremental backup fails.'."\n" .'* **false**: The system does not perform full backup if incremental backup fails.'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], 'FetchSliceSize' => ['description' => 'The size of backup shards (the number of files).'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '100000', 'title' => ''], 'ClusterId' => ['description' => 'The ID of the backup client group. When you perform on-premises NAS backup, Cloud Backup selects clients from the specified backup client group.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cl-000**************ggu', 'title' => ''], ], 'required' => false, 'title' => '', 'example' => '', ], 'CommonFileSystemDetail' => [ 'description' => 'The advanced options for CPFS backup.'."\n", 'type' => 'object', 'properties' => [ 'FullOnIncrementFail' => ['description' => 'Specifies whether the system performs full backup if incremental backup fails. Valid values:'."\n" ."\n" .'* **true**: The system performs full backup if incremental backup fails.'."\n" .'* **false**: The system does not perform full backup if incremental backup fails.'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], 'FetchSliceSize' => ['description' => 'The size of backup shards (the number of files).'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '100000', 'title' => ''], ], 'required' => false, 'title' => '', 'example' => '', ], ], 'required' => false, 'title' => '', 'example' => '', ], 'CrossAccountType' => ['description' => 'Specifies whether to back up and restore data within the same Alibaba Cloud account or across Alibaba Cloud accounts. Default value: SELF_ACCOUNT. Valid values:'."\n" ."\n" .'* **SELF_ACCOUNT**: backs up data within the same Alibaba Cloud account.'."\n" .'* **CROSS_ACCOUNT**: backs up data across Alibaba Cloud accounts.'."\n", 'type' => 'string', 'required' => false, 'example' => 'SELF_ACCOUNT', 'title' => ''], 'CrossAccountUserId' => ['description' => 'The ID of the source Alibaba Cloud account that authorizes the current Alibaba Cloud account to back up data across Alibaba Cloud accounts.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '144**********732', 'title' => ''], 'CrossAccountRoleName' => ['description' => 'The name of the RAM role that is created within the source Alibaba Cloud account and assigned to the current Alibaba Cloud account to authorize the current Alibaba Cloud account to back up data across Alibaba Cloud accounts.'."\n", 'type' => 'string', 'required' => false, 'example' => 'hbrcrossrole', 'title' => ''], ], 'required' => false, 'title' => '', 'example' => '', ], 'required' => false, 'title' => '', 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'CreatePolicyBindingsResponse', 'description' => 'CreatePolicyBindingsResponse'."\n", 'type' => 'object', 'properties' => [ 'Success' => ['description' => 'Indicates whether the call is successful. Valid values:'."\n" ."\n" .'* true: The call is successful.'."\n" .'* false: The call fails.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'Code' => ['description' => 'The HTTP status code. The status code 200 indicates that the call is successful.'."\n", 'type' => 'string', 'example' => '200', 'title' => ''], 'Message' => ['description' => 'The message that is returned. If the call is successful, "successful" is returned. If the call fails, an error message is returned.'."\n", 'type' => 'string', 'example' => 'successful', 'title' => ''], 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '82CC5B6C-72F7-5D39-92F6-67887DF9AD46', 'title' => ''], ], 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'PolicyAlreadyBoundWithThisDataSource', 'errorMessage' => 'This datasource has already been bound with the policy, please use another one.', 'description' => ''], ], ], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"82CC5B6C-72F7-5D39-92F6-67887DF9AD46\\"\\n}","type":"json"}]', 'title' => 'CreatePolicyBindings', 'summary' => 'Binds one or more data sources to a backup policy.', 'description' => '* You can bind data sources to only one policy in each request.'."\n" .'* Elastic Compute Service (ECS) instances can be bound to only one policy.'."\n", 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CreatePolicyBindings'], ], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'hbr:CreatePolicyBindings', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'HBR', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], ], 'CreatePolicyV2' => [ 'summary' => 'Create a policy.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '162846', 'abilityTreeNodes' => ['FEATUREhbrB1KQ9G', 'FEATUREhbrS7MI6C', 'FEATUREhbr3BJQCT', 'FEATUREhbrQ3MV3B', 'FEATUREhbr56LH1C', 'FEATUREhbrFWIWBG'], ], 'parameters' => [ [ 'name' => 'PolicyName', 'in' => 'formData', 'schema' => ['description' => 'The name of the backup policy.', 'type' => 'string', 'example' => 'Daily local backup + remote backup', 'required' => false, 'title' => ''], ], [ 'name' => 'PolicyType', 'in' => 'formData', 'schema' => ['description' => 'The type of the backup policy. Valid values:'."\n" ."\n" .'- **STANDARD**: A standard backup policy. It supports data sources other than ECS instance backup.'."\n" ."\n" .'- **UDM\\_ECS\\_ONLY**: A backup policy that supports only ECS instance backups.'."\n" ."\n" .'If you do not specify this parameter, Cloud Backup automatically sets the policy type based on whether a backup vault is specified in the policy rules:'."\n" ."\n" .'- If a backup vault is specified in the rules, the policy type is set to **STANDARD**.'."\n" ."\n" .'- If no backup vault is specified in the rules, the policy type is set to **UDM\\_ECS\\_ONLY**.', 'type' => 'string', 'required' => false, 'example' => 'STANDARD', 'title' => ''], ], [ 'name' => 'PolicyDescription', 'in' => 'formData', 'schema' => ['description' => 'The description of the backup policy.', 'type' => 'string', 'example' => 'Back up once at 10:00 AM every day, with offsite backup to Shanghai.', 'required' => false, 'title' => ''], ], [ 'name' => 'Rules', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'description' => 'The list of policy rules.', 'type' => 'array', 'items' => [ 'description' => 'A policy rule.', 'type' => 'object', 'properties' => [ 'RuleType' => [ 'description' => 'The type of the rule. Each policy requires at least one **BACKUP** rule and exactly one **TRANSITION** rule. Valid values:'."\n" ."\n" .'- **BACKUP**: A backup rule.'."\n" ."\n" .'- **TRANSITION**: A lifecycle rule.'."\n" ."\n" .'- **REPLICATION**: A replication rule.'."\n" ."\n" .'- **TAG**: A rule to associate data sources with the policy by using tags.', 'type' => 'string', 'required' => true, 'enum' => ['BACKUP', 'TRANSITION', 'REPLICATION', 'SECURITY', 'TAG'], 'title' => '', 'example' => 'BACKUP', ], 'Schedule' => ['description' => 'This parameter is required only when **RuleType** is set to **BACKUP**. The backup schedule. Valid formats:'."\n" ."\n" .'- `I|{startTime}|{interval}`: Runs a backup job at the specified interval starting from {startTime}. For example, `I|1631685600|P1D` runs a backup job every day, starting from 2021-09-15 14:00:00.'."\n" ."\n" .' - startTime: The backup start time in UNIX time, in seconds.'."\n" ."\n" .' - interval: The backup interval in ISO 8601 format. For example, `PT1H` specifies an interval of 1 hour. `P1D` specifies an interval of 1 day.'."\n" ."\n" .'- `C|{startTime}|{crontab}`: Runs a backup job based on the specified crontab expression starting from {startTime}. For example, `C|1631685600|0 0 2 ? * 3,5,7` runs a backup job at 02:00:00 on every Tuesday, Thursday, and Saturday, starting from 2021-09-15 14:00:00.'."\n" ."\n" .' - startTime: The backup start time in UNIX time, in seconds.'."\n" ."\n" .' - crontab: A crontab expression. For example, `0 0 2 ? * 3,5,7` specifies 02:00:00 on every Tuesday, Thursday, and Saturday.'."\n" ."\n" .'Missed backup jobs are not run retroactively. If a backup job is still running, the next scheduled job is not triggered.', 'type' => 'string', 'example' => 'I|1648647166|P1D', 'required' => false, 'title' => ''], 'BackupType' => [ 'description' => 'This parameter is required only when **RuleType** is set to **BACKUP**. The backup type. The value **COMPLETE** specifies a full backup.', 'type' => 'string', 'enum' => ['COMPLETE', 'INCREMENTAL', 'DIFFERENTIAL', 'LOG', 'INDEX', 'ARCHIVE', 'ARCHIVE_BY_SEARCH'], 'title' => '', 'required' => false, 'example' => 'COMPLETE', ], 'Retention' => ['title' => 'Expiration', 'description' => 'This parameter is required only when **RuleType** is set to **BACKUP**, **TRANSITION**, or **REPLICATION**. The retention period in days.'."\n" ."\n" .'- If **RuleType** is **BACKUP**: The backup retention period. A `Retention` parameter in a **TRANSITION** rule overrides this setting. The value must be between 1 and 364635.'."\n" ."\n" .'- If **RuleType** is **TRANSITION**: The backup retention period. The value must be between 1 and 364635.'."\n" ."\n" .'- If **RuleType** is **REPLICATION**: The retention period for cross-region backups. The value must be between 1 and 364635.', 'type' => 'integer', 'format' => 'int64', 'default' => '0', 'required' => false, 'example' => '7'], 'ReplicationRegionId' => ['title' => 'Replication', 'description' => 'This parameter is required only when **RuleType** is set to **REPLICATION**. The ID of the destination region for replication.', 'type' => 'string', 'required' => false, 'example' => 'cn-shanghai'], 'RetentionRules' => [ 'description' => 'This parameter is required only when **RuleType** is set to **TRANSITION**. The advanced retention rules.', 'type' => 'array', 'items' => [ 'description' => 'An advanced retention rule.', 'type' => 'object', 'properties' => [ 'AdvancedRetentionType' => ['description' => 'The type of the advanced retention rule. Valid values:'."\n" ."\n" .'- **DAILY**: Daily backups.'."\n" ."\n" .'- **WEEKLY**: Weekly backups.'."\n" ."\n" .'- **MONTHLY**: Monthly backups.'."\n" ."\n" .'- **YEARLY**: Yearly backups.', 'type' => 'string', 'required' => false, 'example' => 'YEARLY', 'title' => ''], 'WhichSnapshot' => ['description' => 'The ordinal number of the backup to keep based on the `AdvancedRetentionType`. For example, a value of `1` indicates the first backup. Currently, only a value of `1` is supported.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'title' => ''], 'Retention' => ['description' => 'The retention period in days for this advanced rule. The minimum value is 1.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '730', 'title' => ''], ], 'required' => false, 'title' => '', 'example' => '', ], 'required' => false, 'maxItems' => 99, 'title' => '', 'example' => '', ], 'VaultId' => ['description' => 'This parameter is required only when RuleType is set to BACKUP. The ID of the backup vault.', 'type' => 'string', 'required' => false, 'example' => 'v-0001************aseg', 'title' => ''], 'KeepLatestSnapshots' => ['description' => 'Specifies whether to permanently retain at least one backup version. Valid values:'."\n" ."\n" .'- `0`: Do not retain.'."\n" ."\n" .'- `1`: Retain.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'title' => ''], 'Immutable' => ['description' => 'Valid only when **PolicyType** is set to **UDM\\_ECS\\_ONLY**. Specifies whether to enable backup lock for the backups.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], 'DataSourceFilters' => [ 'description' => 'This parameter is required only when **RuleType** is set to **TAG**. The filter rules for data sources.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'SourceType' => ['description' => 'The type of the data source. Valid values:'."\n" ."\n" .'- **UDM\\_ECS**: ECS instance backup. Supported only when **PolicyType** is set to **UDM\\_ECS\\_ONLY**.'."\n" ."\n" .'- **OSS**: OSS backup. Supported only when **PolicyType** is set to **STANDARD**.'."\n" ."\n" .'- **NAS**: NAS backup. Supported only when **PolicyType** is set to **STANDARD**.'."\n" ."\n" .'- **ECS\\_FILE**: ECS file backup. Supported only when **PolicyType** is set to **STANDARD**.'."\n" ."\n" .'- **OTS**: Tablestore backup. Supported only when **PolicyType** is set to **STANDARD**.', 'type' => 'string', 'required' => false, 'example' => 'UDM_ECS', 'title' => ''], 'DataSourceIds' => [ 'description' => 'This parameter is deprecated.', 'type' => 'array', 'items' => ['description' => 'This parameter is deprecated.', 'type' => 'string', 'required' => false, 'example' => '已废弃。', 'title' => ''], 'required' => false, 'title' => '', 'example' => '', ], ], 'required' => false, 'description' => '', 'title' => '', 'example' => '', ], 'required' => false, 'title' => '', 'example' => '', ], 'TagFilters' => [ 'description' => 'This parameter is required only when **RuleType** is set to **TAG**. The filter rules for resource tags.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Key' => ['description' => 'The tag key.', 'type' => 'string', 'required' => false, 'example' => 'env', 'title' => ''], 'Value' => ['description' => 'The tag value. If you leave this parameter empty, the filter matches any value for the specified tag key.', 'type' => 'string', 'required' => false, 'example' => 'prod', 'title' => ''], 'Operator' => ['description' => 'The operator for matching tags. Valid values:'."\n" ."\n" .'- **EQUAL**: Matches both the tag key and tag value.'."\n" ."\n" .'- **NOT**: Matches the tag key but not the tag value.', 'type' => 'string', 'required' => false, 'example' => 'EQUAL', 'title' => ''], ], 'required' => false, 'description' => '', 'title' => '', 'example' => '', ], 'required' => false, 'title' => '', 'example' => '', ], ], 'required' => false, 'title' => '', 'example' => '', ], 'required' => false, 'maxItems' => 10, 'minItems' => 1, 'title' => '', 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'CreatePolicyResponse', 'description' => 'CreatePolicyResponse', 'type' => 'object', 'properties' => [ 'Success' => ['description' => 'Indicates whether the request succeeded. Valid values:'."\n" ."\n" .'- `true`: The request succeeded.'."\n" ."\n" .'- `false`: The request failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'Code' => ['description' => 'The return code. A value of `200` indicates that the request succeeded.', 'type' => 'string', 'example' => '200', 'title' => ''], 'Message' => ['description' => 'The response message. `successful` is returned for a successful request. An error message is returned for a failed request.', 'type' => 'string', 'example' => 'successful', 'title' => ''], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'EEC65C22-2152-5E31-8AD6-D6CBF1BFF49F', 'title' => ''], 'PolicyId' => ['description' => 'The policy ID.', 'type' => 'string', 'example' => 'po-000000zemnuyx2li3y9y', 'title' => ''], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"EEC65C22-2152-5E31-8AD6-D6CBF1BFF49F\\",\\n \\"PolicyId\\": \\"po-000000zemnuyx2li3y9y\\"\\n}","type":"json"}]', 'title' => 'CreatePolicyV2', 'description' => 'A backup policy configures your backups. When a policy runs, it initiates a backup job to track its progress and outcome. A successful backup job creates a snapshot that you can use to create a restore job.'."\n" ."\n" .'- A backup policy supports multiple data sources, including NAS backup, OSS backup, ECS instance backup, ECS file backup, on-premises file backup, Tablestore backup, and CPFS backup.'."\n" ."\n" .'- A backup policy can have only one backup schedule with a fixed interval.'."\n" ."\n" .'- A backup policy backs up data to a single backup vault.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CreatePolicyV2'], ], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'hbr:CreatePolicyV2', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'HBR', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'machine', ], 'CreateReplicationVault' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'abilityTreeCode' => '95445', 'abilityTreeNodes' => ['FEATUREhbrGSUVI2'], ], 'parameters' => [ [ 'name' => 'VaultRegionId', 'in' => 'query', 'schema' => ['description' => 'The ID of the region where the backup vault resides.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-shanghai'], ], [ 'name' => 'VaultName', 'in' => 'query', 'schema' => ['description' => 'The name of the backup vault. The name must be 1 to 64 characters in length.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'mirrorvaultname'], ], [ 'name' => 'Description', 'in' => 'query', 'schema' => ['description' => 'The description of the backup vault. The description must be 0 to 255 characters in length.'."\n", 'type' => 'string', 'required' => false, 'example' => 'description'], ], [ 'name' => 'VaultStorageClass', 'in' => 'query', 'schema' => [ 'description' => 'The storage type of the backup vault. Valid value: **STANDARD**, which indicates standard storage.'."\n", 'type' => 'string', 'required' => false, 'example' => 'STANDARD', 'default' => 'STANDARD', 'enum' => ['STANDARD', 'IA', 'ARCHIVE'], ], ], [ 'name' => 'ReplicationSourceVaultId', 'in' => 'query', 'schema' => ['description' => 'The ID of the source vault.'."\n", 'type' => 'string', 'required' => true, 'example' => 'v-*********************'], ], [ 'name' => 'ReplicationSourceRegionId', 'in' => 'query', 'schema' => ['description' => 'The ID of the region where the source vault resides.'."\n", 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'], ], [ 'name' => 'RedundancyType', 'in' => 'query', 'schema' => ['description' => 'The data redundancy type of the backup vault. Valid values:'."\n" ."\n" .'* LRS: standard locally redundant storage (LRS). Cloud Backup stores the copies of each object on multiple devices of different facilities in the same zone. This way, Cloud Backup ensures data durability and availability even if hardware failures occur.'."\n" .'* ZRS: standard zone-redundant storage (ZRS). Cloud Backup uses the multi-zone mechanism to distribute data across three zones within the same region. If a zone fails, the data that is stored in the other two zones is still accessible.'."\n", 'type' => 'string', 'required' => false, 'example' => 'LRS'], ], [ 'name' => 'EncryptType', 'in' => 'query', 'schema' => ['description' => 'The method that is used to encrypt the source data. This parameter is valid only if you set the VaultType parameter to STANDARD or OTS_BACKUP. Valid values:'."\n" ."\n" .'* **HBR_PRIVATE**: The source data is encrypted by using the built-in encryption method of Hybrid Backup Recovery (HBR).'."\n" .'* **KMS**: The source data is encrypted by using Key Management Service (KMS).'."\n", 'type' => 'string', 'required' => false, 'example' => 'HBR_PRIVATE'], ], [ 'name' => 'KmsKeyId', 'in' => 'query', 'schema' => ['description' => 'The customer master key (CMK) created in KMS or the alias of the key. This parameter is required only if you set the EncryptType parameter to KMS.'."\n", 'type' => 'string', 'required' => false, 'example' => 'alias/test'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E'], 'VaultId' => ['description' => 'The ID of the backup vault.'."\n", 'type' => 'string', 'example' => 'v-*********************'], 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" ."\n" .'* true'."\n" .'* false'."\n", 'type' => 'boolean', 'example' => 'true'], 'Code' => ['description' => 'The response code. The status code 200 indicates that the request was successful.'."\n", 'type' => 'string', 'example' => '200'], 'Message' => ['description' => 'The returned message. If the request was successful, "successful" is returned. If the request failed, an error message is returned.'."\n", 'type' => 'string', 'example' => 'successful'], 'TaskId' => ['description' => 'The ID of the job that is used to initialize the backup vault. You can call the DescribeTask operation to query the job status.'."\n", 'type' => 'string', 'example' => 't-*********************'], ], 'description' => '', ], ], ], 'title' => 'CreateReplicationVault', 'summary' => 'Creates a mirror vault.', 'description' => 'After a backup vault is created, the backup vault is in the INITIALIZING state, and the system automatically runs an initialization task to initialize the backup vault. After the initialization task is completed, the backup vault is in the CREATED state.Call this operation in the region where the mirror vault resides, which is specified by the VaultRegionId parameter.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CreateReplicationVault'], ], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'hbr:CreateReplicationVault', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'HBR', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\",\\n \\"VaultId\\": \\"v-*********************\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"TaskId\\": \\"t-*********************\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\n v-*********************\\n true\\n 200\\n successful\\n t-*********************\\n","errorExample":""}]', ], 'CreateRestoreJob' => [ 'summary' => 'Creates a restore job.', 'methods' => ['post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'paid', 'abilityTreeCode' => '95447', 'abilityTreeNodes' => ['FEATUREhbr56LH1C', 'FEATUREhbrS7MI6C', 'FEATUREhbrFWIWBG', 'FEATUREhbrB1KQ9G', 'FEATUREhbrQ3MV3B', 'FEATUREhbr3BJQCT', 'FEATUREhbrF83GXN'], ], 'parameters' => [ [ 'name' => 'RestoreType', 'in' => 'query', 'schema' => ['description' => 'The type of the destination data source. Valid values:'."\n" ."\n" .'- **ECS\\_FILE**: Restores Elastic Compute Service (ECS) files.'."\n" ."\n" .'- **OSS**: Restores data to Object Storage Service (OSS).'."\n" ."\n" .'- **NAS**: Restores data to NAS.'."\n" ."\n" .'- **COMMON\\_FILE\\_SYSTEM**: Restores data to Cloud Parallel File System (CPFS).'."\n" ."\n" .'- **OTS\\_TABLE**: Restores data to Tablestore.'."\n" ."\n" .'- **UDM\\_ECS\\_ROLLBACK**: Rolls back an entire ECS instance.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ECS_FILE', 'title' => ''], ], [ 'name' => 'VaultId', 'in' => 'query', 'schema' => ['description' => 'The ID of the backup repository to which the backup snapshot belongs.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'v-*********************', 'title' => ''], ], [ 'name' => 'SnapshotId', 'in' => 'query', 'schema' => ['description' => 'The ID of the backup snapshot.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 's-********************', 'title' => ''], ], [ 'name' => 'SnapshotHash', 'in' => 'query', 'schema' => ['description' => 'The hash value of the backup snapshot.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'f2fe...', 'title' => ''], ], [ 'name' => 'SourceType', 'in' => 'query', 'schema' => ['description' => 'The type of the source data. Valid values:'."\n" ."\n" .'- **ECS\\_FILE**: ECS files.'."\n" ."\n" .'- **OSS**: OSS data.'."\n" ."\n" .'- **NAS**: NAS data.'."\n" ."\n" .'- **COMMON\\_FILE\\_SYSTEM**: CPFS data.'."\n" ."\n" .'- **OTS\\_TABLE**: Tablestore data.'."\n" ."\n" .'- **UDM\\_ECS**: An entire ECS instance.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ECS_FILE', 'title' => ''], ], [ 'name' => 'Options', 'in' => 'query', 'schema' => ['description' => 'Specifies the parameters for the restore job.', 'type' => 'string', 'required' => false, 'example' => '{\\"includes\\":[],\\"excludes\\":[],\\"conflictPolicy\\":\\"OVERWRITE_EXISTING\\"}', 'title' => ''], ], [ 'name' => 'TargetFileSystemId', 'in' => 'query', 'schema' => ['description' => 'The ID of the destination file system. This parameter is valid only when **RestoreType** is set to **NAS**.', 'type' => 'string', 'required' => false, 'example' => '005494', 'title' => ''], ], [ 'name' => 'TargetCreateTime', 'in' => 'query', 'schema' => ['description' => 'The time when the destination file system was created. This parameter is valid only when **RestoreType** is set to **NAS**.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1554347313', 'title' => ''], ], [ 'name' => 'TargetPath', 'in' => 'formData', 'schema' => ['description' => 'The destination path for the restore. This parameter is valid only when **RestoreType** is set to **ECS\\_FILE**.', 'type' => 'string', 'required' => false, 'example' => 'C:\\', 'title' => ''], ], [ 'name' => 'TargetBucket', 'in' => 'query', 'schema' => ['description' => 'The name of the destination OSS bucket. This parameter is valid only when **RestoreType** is set to **OSS**.', 'type' => 'string', 'required' => false, 'example' => 'hbr-backup-oss', 'title' => ''], ], [ 'name' => 'TargetPrefix', 'in' => 'query', 'schema' => ['description' => 'The prefix of the destination path for the objects that you want to restore. This parameter is valid only when **RestoreType** is set to **OSS**.', 'type' => 'string', 'required' => false, 'example' => 'hbr', 'title' => ''], ], [ 'name' => 'UdmDetail', 'in' => 'query', 'style' => 'json', 'schema' => ['description' => 'The details of the entire instance backup. This parameter is a JSON string and is valid only when SourceType is set to UDM\\_ECS. The content of this parameter varies based on the value of RestoreType:'."\n" ."\n" .'- **UDM\\_ECS\\_DISK**: Clones an ECS disk.'."\n" ."\n" .' - **targetInstanceId**: string, required. The ID of the destination ECS instance to which the cloned disk is attached.'."\n" ."\n" .' - **diskCategory**: string, required. The type of the destination disk.'."\n" ."\n" .' - diskPerformanceLevel: string. The performance level of the disk when diskCategory is set to **essd**. Valid values are PL0, PL1, PL2, and PL3. The default value is PL1.'."\n" ."\n" .'- **UDM\\_ECS\\_DISK\\_ROLLBACK**: Recovers an ECS disk.'."\n" ."\n" .' - **sourceInstanceId**: string, required. The ID of the source ECS instance.'."\n" ."\n" .' - forceRestore: boolean. The default value is false. Specifies whether to forcefully recover the disk. If you set **forceRestore** to true, the disk is recovered even if it has been uninstalled from the original ECS instance or attached to a new ECS instance. Use this option with caution.'."\n" ."\n" .' - **bootAfterRestore**: boolean. The default value is false. Specifies whether to start the ECS instance after recovery.'."\n" ."\n" .'- **UDM\\_ECS**: Clones an entire ECS instance.'."\n" ."\n" .' - **bootAfterRestore**: boolean. The default value is false. Specifies whether to start the ECS instance after recovery.'."\n" ."\n" .' - **diskCategory**: string, required. The type of the destination disk.'."\n" ."\n" .' - diskPerformanceLevel: string. The performance level of the disk when diskCategory is set to **essd**. Valid values are PL0, PL1, PL2, and PL3. The default value is PL1.'."\n" ."\n" .' - **instanceType**: string, required. The instance type of the destination ECS instance.'."\n" ."\n" .' - **restoredNetwork**: string, required. The ID of the vSwitch for the destination ECS instance.'."\n" ."\n" .' - **securityGroup**: string, required. The ID of the security group for the destination ECS instance.'."\n" ."\n" .' - **restoredName**: string, required. The name of the destination ECS instance.'."\n" ."\n" .' - **restoredHostName**: string, required. The hostname of the destination ECS instance.'."\n" ."\n" .' - **allocatePublicIp**: boolean. The default value is false. Specifies whether to assign a public IP address to the destination ECS instance.'."\n" ."\n" .' - **privateIpAddress**: string. The private IP address of the destination ECS instance. If you do not specify this parameter, a random IP address is assigned by DHCP.'."\n" ."\n" .'- **UDM\\_ECS\\_ROLLBACK**: Rolls back an entire ECS instance.'."\n" ."\n" .' - **sourceInstanceId**: string, required. The ID of the source ECS instance.'."\n" ."\n" .' - forceRestore: boolean. The default value is false. Specifies whether to forcefully recover the instance. If you set **forceRestore** to true, the disk is recovered even if it has been uninstalled from the original ECS instance or attached to a new ECS instance. Use this option with caution.'."\n" ."\n" .' - **bootAfterRestore**: boolean. The default value is false. Specifies whether to start the ECS instance after recovery.', 'type' => 'object', 'required' => false, 'example' => '{\\"sourceInstanceId\\":\\"i-uf62te6pm3iwsyxyz66q\\",\\"bootAfterRestore\\":false}', 'title' => ''], ], [ 'name' => 'UdmRegionId', 'in' => 'query', 'schema' => ['description' => 'The destination region for the recovery. This parameter is valid only when **SourceType** is set to **UDM\\_ECS**.', 'type' => 'string', 'required' => false, 'example' => 'cn-shanghai', 'title' => ''], ], [ 'name' => 'TargetInstanceId', 'in' => 'formData', 'schema' => ['description' => 'The ID of the destination ECS instance. This parameter is valid only when **RestoreType** is set to **ECS\\_FILE**.', 'type' => 'string', 'required' => false, 'example' => 'i-*********************', 'title' => ''], ], [ 'name' => 'Include', 'in' => 'formData', 'schema' => ['description' => 'The path from which to restore all documents. The path cannot exceed 255 characters in length.', 'type' => 'string', 'required' => false, 'example' => '["/home/alice/*.pdf", "/home/bob/*.txt"]', 'title' => ''], ], [ 'name' => 'Exclude', 'in' => 'formData', 'schema' => ['description' => 'The paths of the files to exclude from the restore job. All files in the specified paths are not restored. The value is a JSON array of strings. Each path can be up to 255 characters in length.', 'type' => 'string', 'required' => false, 'example' => '["/var", "/proc"]', 'title' => ''], ], [ 'name' => 'TargetContainer', 'in' => 'query', 'schema' => ['description' => 'The details of the destination container. This parameter is a JSON string.', 'type' => 'string', 'required' => false, 'example' => '{\\"host\\":\\"k8s-node1\\",\\"hostPrefix\\":\\"/var/lib/kubelet/pods/4acb31fe-8577-40ff-bc8c-eccabd835f73/volumes/kubernetes.io~csi/pvc-b050b00e-ef17-4792-aab1-1642355cf1f4/mount\\",\\"pvPath\\":\\"/\\"}', 'title' => ''], ], [ 'name' => 'InitiatedByAck', 'in' => 'query', 'schema' => ['description' => 'Specifies whether the restore job is initiated by Container Service for Kubernetes (ACK). The default value is false.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], ], [ 'name' => 'TargetContainerClusterId', 'in' => 'query', 'schema' => ['description' => 'The ID of the destination container cluster.', 'type' => 'string', 'required' => false, 'example' => 'cc-000amjsc7o1h9506oob7', 'title' => ''], ], [ 'name' => 'TargetInstanceName', 'in' => 'query', 'schema' => ['description' => 'The name of the destination Tablestore instance.', 'type' => 'string', 'required' => false, 'example' => 'instancename', 'title' => ''], ], [ 'name' => 'TargetTableName', 'in' => 'query', 'schema' => ['description' => 'The name of the destination table in the Tablestore instance.', 'type' => 'string', 'required' => false, 'example' => 'tablename', 'title' => ''], ], [ 'name' => 'TargetTime', 'in' => 'query', 'schema' => ['description' => 'The time to which you want to restore the Tablestore data. This is a UNIX timestamp. Unit: seconds.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1642496881', 'title' => ''], ], [ 'name' => 'OtsDetail', 'in' => 'formData', 'style' => 'json', 'schema' => ['description' => 'The details of the Tablestore instance.', '$ref' => '#/components/schemas/OtsTableRestoreDetail', 'required' => false, 'title' => '', 'example' => ''], ], [ 'name' => 'CrossAccountType', 'in' => 'query', 'schema' => [ 'description' => 'The type of the cross-account restore. Valid values:'."\n" ."\n" .'- SELF\\_ACCOUNT: Restores data within the same account.'."\n" ."\n" .'- CROSS\\_ACCOUNT: Restores data from a different account.', 'enumValueTitles' => [], 'type' => 'string', 'required' => false, 'example' => 'SELF_ACCOUNT', 'title' => '', ], ], [ 'name' => 'CrossAccountUserId', 'in' => 'query', 'schema' => ['description' => 'The ID of the source account that contains the backup data for a cross-account restore.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '158975xxxxx4625', 'title' => ''], ], [ 'name' => 'CrossAccountRoleName', 'in' => 'query', 'schema' => ['description' => 'The name of the RAM role that you create in the source account to perform a cross-account restore.', 'type' => 'string', 'required' => false, 'example' => 'BackupRole', 'title' => ''], ], [ 'name' => 'FailbackDetail', 'in' => 'query', 'style' => 'json', 'schema' => ['description' => 'Specifies the details of an on-premises restore.', 'type' => 'object', 'required' => false, 'example' => '{"cpu":4,"extra":"{\\"restoreVMNamePrefix\\":\\"627-\\",\\"dataCenterName\\":\\"SDDC-Datacenter\\",\\"dataStoreId\\":\\"datastore-50\\",\\"folderId\\":\\"group-v49\\",\\"resourcePoolId\\":\\"resgroup-46\\",\\"locationName\\":\\"vcenter.pc-uf600a******1.acvs.aliyuncs.com/SDDC-Datacenter/Workloads\\",\\"computeResourceName\\":\\"SDDC-Datacenter/Default_c-uf600a******\\",\\"dataStoreName\\":\\"Default_c-uf600a******/WorkloadDatastore\\",\\"networkMoReference\\":\\"DistributedVirtualPortgroup:dvportgroup-1001\\",\\"useHotAdd\\":false}","instanceId":"i-2vc******z","memoryInMB":8192,"serverId":"0fdc0c86-eb92-4e05-91ab-eeaf9fb6ad01","uefiBoot":false}', 'title' => ''], ], [ 'name' => 'Edition', 'in' => 'query', 'schema' => ['description' => 'The edition of Cloud Backup. Valid values:'."\n" ."\n" .'- **STANDARD**: Standard Edition. This is the default value.'."\n" ."\n" .'- **BASIC**: Basic Edition. This edition is available only for basic ECS file backup plans.', 'type' => 'string', 'required' => false, 'example' => 'STANDARD', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Code' => ['description' => 'The return code. A value of 200 indicates that the call is successful.', 'type' => 'string', 'example' => '200', 'title' => ''], 'Message' => ['description' => 'The message that is returned. If the call is successful, "successful" is returned. If the call fails, an error message is returned.', 'type' => 'string', 'example' => 'successful', 'title' => ''], 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E', 'title' => ''], 'Success' => ['description' => 'Indicates whether the request was successful.'."\n" ."\n" .'- true: The request was successful.'."\n" ."\n" .'- false: The request failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'RestoreId' => ['description' => 'The ID of the restore job.', 'type' => 'string', 'example' => 'r-*********************', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\",\\n \\"Success\\": true,\\n \\"RestoreId\\": \\"r-*********************\\"\\n}","type":"json"}]', 'title' => 'CreateRestoreJob', 'description' => '- This operation creates a restore job from a selected backup snapshot to a specified restore destination.'."\n" ."\n" .'- The source and destination must have the same data source type.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CreateRestoreJob'], ], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'hbr:CreateRestoreJob', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'HBR', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], ], 'CreateTempFileUploadUrl' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'systemTags' => [ 'operationType' => 'create', 'abilityTreeCode' => '146297', 'abilityTreeNodes' => ['FEATUREhbrKJCQWH', 'FEATUREhbrS7MI6C'], 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'FileName', 'in' => 'query', 'schema' => ['description' => 'The name of the file to be uploaded.'."\n", 'type' => 'string', 'required' => true, 'example' => 'file-list.txt'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Endpoint' => ['description' => 'The endpoint that is used to upload the file to OSS.'."\n", 'type' => 'string', 'example' => 'oss-cn-shenzhen.aliyuncs.com'], 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => 'F4EEB401-DD21-588D-AE3B-1E835C7655E1'], 'ExpireTime' => ['description' => 'The expiration time of the signature that is used to upload the file to OSS. This value is a UNIX timestamp. Unit: seconds.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1654326678'], 'Success' => ['description' => 'Indicates whether the call is successful. Valid values:'."\n" ."\n" .'* true: The call is successful.'."\n" .'* false: The call fails.'."\n", 'type' => 'boolean', 'example' => 'true'], 'Code' => ['description' => 'The HTTP status code. The status code 200 indicates that the call is successful.'."\n", 'type' => 'string', 'example' => '200'], 'TempFileKey' => ['description' => 'The key that is used to upload the file to OSS.'."\n", 'type' => 'string', 'example' => 'temp/1440155109798732/upload/2022-07-29/49bed34c-b430-4e7e-89b1-4be2b734f95c/iaclone.diff'], 'Message' => ['description' => 'The message that is returned. If the call is successful, "successful" is returned. If the call fails, an error message is returned.'."\n", 'type' => 'string', 'example' => 'successful'], 'BucketName' => ['description' => 'The name of the OSS bucket to which the file is uploaded.'."\n", 'type' => 'string', 'example' => 'hbr-temp-bucket'], 'OssAccessKeyId' => ['description' => 'The AccessKey ID that is used to upload the file to OSS.'."\n", 'type' => 'string', 'example' => 'LTAI****Up'], 'Policy' => ['description' => 'The policy that is used to upload the file to OSS.'."\n", 'type' => 'string', 'example' => 'eyJleH****V19'], 'Signature' => ['description' => 'The signature that is used to upload the file to OSS.'."\n", 'type' => 'string', 'example' => 'RmhI****0A='], ], ], ], ], 'title' => 'CreateTempFileUploadUrl', 'summary' => 'Generates the parameters and signature required for a file upload URL.', 'description' => '1. You can directly upload a file to Object Storage Service (OSS) by using a form based on the returned value of this operation.'."\n" .'2. For more information about how to upload a file to OSS by using a form, see OSS documentation.'."\n" .'3. The system periodically deletes files that are uploaded to OSS.'."\n", 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '60', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CreateTempFileUploadUrl'], ], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'hbr:CreateTempFileUploadUrl', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'HBR', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Endpoint\\": \\"oss-cn-shenzhen.aliyuncs.com\\",\\n \\"RequestId\\": \\"F4EEB401-DD21-588D-AE3B-1E835C7655E1\\",\\n \\"ExpireTime\\": 1654326678,\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"TempFileKey\\": \\"temp/1440155109798732/upload/2022-07-29/49bed34c-b430-4e7e-89b1-4be2b734f95c/iaclone.diff\\",\\n \\"Message\\": \\"successful\\",\\n \\"BucketName\\": \\"hbr-temp-bucket\\",\\n \\"OssAccessKeyId\\": \\"LTAI****Up\\",\\n \\"Policy\\": \\"eyJleH****V19\\",\\n \\"Signature\\": \\"RmhI****0A=\\"\\n}","type":"json"}]', ], 'CreateVault' => [ 'summary' => 'Creates a backup vault.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'paid', 'abilityTreeCode' => '95458', 'abilityTreeNodes' => ['FEATUREhbr56LH1C', 'FEATUREhbrFWIWBG', 'FEATUREhbr3BJQCT', 'FEATUREhbrIA0YQI', 'FEATUREhbrI97IXK', 'FEATUREhbrTH4MM4', 'FEATUREhbrAL60OZ', 'FEATUREhbr9ZUQY7'], 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ 'name' => 'VaultRegionId', 'in' => 'query', 'schema' => ['description' => 'The region ID of the backup vault.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-shanghai', 'title' => ''], ], [ 'name' => 'VaultName', 'in' => 'query', 'schema' => ['description' => 'The name of the backup vault. The name must be 1 to 64 characters in length.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'backupvaultname', 'title' => ''], ], [ 'name' => 'Description', 'in' => 'query', 'schema' => ['description' => 'The description of the backup vault. The description can be 0 to 255 characters in length.', 'type' => 'string', 'required' => false, 'example' => 'description', 'title' => ''], ], [ 'name' => 'VaultType', 'in' => 'query', 'schema' => [ 'description' => 'The type of the backup vault. Valid values:'."\n" ."\n" .'- **STANDARD**: a standard backup vault.'."\n" ."\n" .'- **OTS\\_BACKUP**: a Tablestore backup vault.', 'enumValueTitles' => ['OTS_BACKUP' => 'OTS backup vault', 'STANDARD' => 'Standard repository'], 'type' => 'string', 'required' => false, 'default' => 'STANDARD', 'example' => 'STANDARD', 'title' => '', ], ], [ 'name' => 'VaultStorageClass', 'in' => 'query', 'schema' => [ 'description' => 'The storage class of the backup vault.'."\n" ."\n" .'- **STANDARD**: Standard.'."\n" ."\n" .'- **ARCHIVE**: This value is deprecated.'."\n" ."\n" .'- **COLD\\_ARCHIVE**: This value is deprecated.'."\n" ."\n" .'- **IA**: This value is deprecated.', 'type' => 'string', 'required' => false, 'default' => 'STANDARD', 'enum' => ['STANDARD', 'IA', 'ARCHIVE', 'COLD_ARCHIVE'], 'example' => 'STANDARD', 'title' => '', ], ], [ 'name' => 'WormEnabled', 'in' => 'query', 'schema' => ['description' => 'Specifies whether to enable backup locking.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], ], [ 'name' => 'EncryptType', 'in' => 'query', 'schema' => [ 'description' => 'The encryption type of the source data. This parameter is valid only if you set VaultType to STANDARD or OTS\\_BACKUP. Valid values:'."\n" ."\n" .'- **HBR\\_PRIVATE**: The backup vault is encrypted using the built-in encryption method of Cloud Backup.'."\n" ."\n" .'- **KMS**: The backup vault is encrypted using a customer master key (CMK) from Key Management Service (KMS).', 'enumValueTitles' => ['KMS' => 'Use the Alibaba Cloud KMS service for custom key encryption.', 'HBR_PRIVATE' => 'HBR is fully managed and uses the built-in encryption of the backup service.'], 'type' => 'string', 'required' => false, 'example' => 'KMS', 'title' => '', ], ], [ 'name' => 'KmsKeyId', 'in' => 'query', 'schema' => ['description' => 'The ID or alias of the KMS key. This parameter is required only if you set EncryptType to KMS.', 'type' => 'string', 'required' => false, 'example' => 'alias/yzs-hhht', 'title' => ''], ], [ 'name' => 'Replication', 'in' => 'query', 'schema' => ['description' => 'Specifies whether to create a replication vault.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E', 'title' => ''], 'VaultId' => ['description' => 'The ID of the backup vault.', 'type' => 'string', 'example' => 'v-*********************', 'title' => ''], 'Success' => ['description' => 'Indicates whether the request was successful.'."\n" ."\n" .'- true: The request was successful.'."\n" ."\n" .'- false: The request failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'Code' => ['description' => 'The return code. A value of 200 indicates that the request was successful.', 'type' => 'string', 'example' => '200', 'title' => ''], 'Message' => ['description' => 'The returned message. If the request was successful, \\`successful\\` is returned. If the request failed, an error message is returned.', 'type' => 'string', 'example' => 'successful', 'title' => ''], 'TaskId' => ['description' => 'The ID of the backup vault initialization task. Use the DescribeTask operation to query the task status.', 'type' => 'string', 'example' => 't-*********************', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\",\\n \\"VaultId\\": \\"v-*********************\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"TaskId\\": \\"t-*********************\\"\\n}","type":"json"}]', 'title' => 'CreateVault', 'description' => '- Each Alibaba Cloud account can create a maximum of 100 backup vaults.'."\n" ."\n" .'- After a backup vault is created, its status is INITIALIZING and an initialization task automatically starts. After the task is successfully completed, the status changes to CREATED. The backup vault can be used for backup jobs only when its status is CREATED.'."\n" ."\n\n" .' >'."\n" ."\n" .' Before you call this operation, make sure that you understand the billing methods and [pricing](https://www.aliyun.com/price/detail/hbr?) of Cloud Backup.'."\n" ."\n" .' >', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CreateVault'], ], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'hbr:CreateVault', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'HBR', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'extraInfo' => ' ', ], 'CreateVaultReplication' => [ 'summary' => 'Configures backup vault replication.', 'path' => '', 'methods' => ['post', 'get'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'paid', 'abilityTreeCode' => '95458', 'abilityTreeNodes' => ['FEATUREhbrGSUVI2'], ], 'parameters' => [ [ 'name' => 'ReplicationSourceVaultId', 'in' => 'query', 'schema' => ['description' => 'The ID of the source backup vault.', 'type' => 'string', 'required' => true, 'example' => 'v-*********************', 'title' => ''], ], [ 'name' => 'ReplicationTargetVaultId', 'in' => 'query', 'schema' => ['description' => 'The ID of the destination backup vault.', 'type' => 'string', 'required' => true, 'example' => 'r-*********************', 'title' => ''], ], [ 'name' => 'ReplicationSourceRegionId', 'in' => 'query', 'schema' => ['description' => 'The ID of the source region. If you do not specify this parameter, the region where the API is called is used.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '280DD872-EE25-52E8-9CB4-491067173DD0', 'title' => ''], 'TaskId' => ['description' => 'The ID of the backup vault initialization task. Use DescribeTask to query the task status.', 'type' => 'string', 'example' => 't-*********************', 'title' => ''], 'Success' => ['description' => 'Indicates whether the request was successful.'."\n" ."\n" .'- true: The request was successful.'."\n" ."\n" .'- false: The request failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'Code' => ['description' => 'The return code. A value of 200 indicates that the request was successful.', 'type' => 'string', 'example' => '200', 'title' => ''], 'Message' => ['description' => 'The returned message. If the request is successful, `successful` is returned. If the request fails, an error message is returned.', 'type' => 'string', 'example' => 'successful', 'title' => ''], ], 'title' => '', 'description' => 'Schema of Response', 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'CreateVaultReplication', 'description' => 'Call this method in the region where the destination backup vault is located. Before you use this API, review the billing methods and pricing of Cloud Backup.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'hbr:CreateVaultReplication', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'HBR', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"280DD872-EE25-52E8-9CB4-491067173DD0\\",\\n \\"TaskId\\": \\"t-*********************\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\"\\n}","type":"json"}]', ], 'DeleteAirEcsInstance' => [ 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '201610', 'abilityTreeNodes' => ['FEATUREhbrIF7VXM'], ], 'parameters' => [ [ 'name' => 'EcsInstanceId', 'in' => 'query', 'schema' => ['description' => 'The ID of the Elastic Compute Service (ECS) instance.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'i-uf6ir9y******hvisj'], ], [ 'name' => 'UninstallClientSourceTypes', 'in' => 'query', 'style' => 'json', 'schema' => [ 'description' => 'The data sources for which the client needs to be uninstalled.'."\n", 'type' => 'array', 'items' => ['description' => 'The data source for which the client needs to be uninstalled.'."\n", 'type' => 'string', 'required' => false, 'example' => 'ECS_FILE'], 'required' => false, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request'."\n", 'type' => 'string', 'example' => '33AA3AAE-89E1-5D3A-A51D-0C0A80850F68'], 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" ."\n" .'* true'."\n" .'* false'."\n", 'type' => 'boolean', 'example' => 'true'], 'Code' => ['description' => 'The response code. The status code 200 indicates that the request was successful.'."\n", 'type' => 'string', 'example' => '200'], 'Message' => ['description' => 'The returned message. If the request was successful, "successful" is returned. If the request failed, an error message is returned.'."\n", 'type' => 'string', 'example' => 'successful'], 'TaskId' => ['description' => 'The ID of the asynchronous job. You can call the DescribeTask operation to query the execution result of an asynchronous job.'."\n", 'type' => 'string', 'example' => 't-*********************'], ], ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'DeleteAirEcsInstance', 'summary' => 'Removes the Elastic Compute Service (ECS) instance that is used for restoration only in ECS Backup Essential Edition.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DeleteAirEcsInstance'], ], ], 'ramActions' => [ [ 'operationType' => 'delete', 'ramAction' => [ 'action' => 'hbr:DeleteAirEcsInstance', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'HBR', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"33AA3AAE-89E1-5D3A-A51D-0C0A80850F68\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"TaskId\\": \\"t-*********************\\"\\n}","type":"json"}]', ], 'DeleteBackupClient' => [ 'summary' => 'Deletes a Cloud Backup client.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREhbr3BJQCT', 'FEATUREhbrS7MI6C'], ], 'parameters' => [ [ 'name' => 'ClientId', 'in' => 'query', 'schema' => ['description' => 'The ID of the Cloud Backup client.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'c-*********************', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Code' => ['description' => 'The response code. The status code 200 indicates that the request was successful.', 'type' => 'string', 'example' => '200', 'title' => ''], 'Message' => ['description' => 'The returned message. If the request was successful, "successful" is returned. If the request failed, an error message is returned.', 'type' => 'string', 'example' => 'successful', 'title' => ''], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E', 'title' => ''], 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" ."\n" .'- true'."\n" ."\n" .'- false', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'title' => 'DeleteBackupClient', 'description' => '- You cannot delete the active Cloud Backup clients that receive heartbeat packets within 1 hour. You can call the UninstallBackupClients operation to uninstall a Cloud Backup client. Then, the client becomes inactive.'."\n" ."\n" .'- When you perform this operation, resources that are associated with the client are also deleted, including:'."\n" ."\n" .' - Backup plans'."\n" ."\n" .' - Backup jobs'."\n" ."\n" .' - Snapshots', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DeleteBackupClient'], ], ], 'ramActions' => [ [ 'operationType' => 'delete', 'ramAction' => [ 'action' => 'hbr:DeleteBackupClient', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'HBR', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\",\\n \\"Success\\": true\\n}","type":"json"}]', ], 'DeleteBackupClientResource' => [ 'summary' => 'Deletes the resources of a backup client.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', 'riskType' => 'high', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREhbr3BJQCT'], ], 'parameters' => [ [ 'name' => 'ClientIds', 'in' => 'query', 'style' => 'json', 'schema' => ['description' => 'A list of client IDs. The list can contain up to 100 client IDs.', 'type' => 'object', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => '["c-*********************"]'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Code' => ['description' => 'The return code. A value of 200 indicates success.', 'type' => 'string', 'title' => '', 'example' => '200'], 'Message' => ['description' => 'The returned message. If the request is successful, \\`successful\\` is returned. If the request fails, an error message is returned.', 'type' => 'string', 'title' => '', 'example' => 'successful'], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E'], 'Success' => ['description' => 'Indicates whether the request was successful.'."\n" ."\n" .'- true: The request was successful.'."\n" ."\n" .'- false: The request failed.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'title' => 'DeleteBackupClientResource', 'description' => 'This operation does not delete the backup client. It only deletes the resources of the backup client, such as backup plans, backup jobs, and snapshots.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DeleteBackupClientResource'], ], ], 'ramActions' => [ [ 'operationType' => 'delete', 'ramAction' => [ 'action' => 'hbr:DeleteBackupClientResource', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'HBR', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\",\\n \\"Success\\": true\\n}","type":"json"}]', ], 'DeleteBackupPlan' => [ 'summary' => 'Deletes a backup plan.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '95465', 'abilityTreeNodes' => ['FEATUREhbr56LH1C', 'FEATUREhbrS7MI6C', 'FEATUREhbrFWIWBG', 'FEATUREhbrAW9I1R', 'FEATUREhbrB1KQ9G', 'FEATUREhbrQ3MV3B', 'FEATUREhbr3BJQCT'], ], 'parameters' => [ [ 'name' => 'PlanId', 'in' => 'query', 'schema' => ['description' => 'The ID of the backup plan.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => 'plan-*********************'], ], [ 'name' => 'VaultId', 'in' => 'query', 'schema' => ['description' => 'The ID of the backup vault. This parameter is required if the SourceType parameter is not set to UDM\\_ECS.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'title' => '', 'example' => 'v-*********************'], ], [ 'name' => 'SourceType', 'in' => 'query', 'schema' => ['description' => 'The type of the data source. Valid values:'."\n" ."\n" .'- **ECS\\_FILE**: Backs up Elastic Compute Service (ECS) files.'."\n" ."\n" .'- **OSS**: Backs up Object Storage Service (OSS) buckets.'."\n" ."\n" .'- **NAS**: Backs up Network Attached Storage (NAS) file systems.'."\n" ."\n" .'- **UDM\\_ECS**: Backs up entire ECS instances.'."\n" ."\n" .'- **OTS**: Backs up Tablestore instances.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'ECS_FILE'], ], [ 'name' => 'RequireNoRunningJobs', 'in' => 'query', 'schema' => ['description' => 'Specifies whether to prevent the deletion of the backup plan if backup jobs are running.', 'type' => 'boolean', 'required' => false, 'title' => '', 'example' => 'false'], ], [ 'name' => 'Edition', 'in' => 'query', 'schema' => ['type' => 'string', 'title' => '', 'description' => 'The edition type. Valid values are BASIC and STANDARD. The default value is STANDARD.', 'required' => false, 'example' => 'STANDARD'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Code' => ['description' => 'The return code. A value of 200 indicates that the request was successful.', 'type' => 'string', 'title' => '', 'example' => '200'], 'Message' => ['description' => 'The returned message. If the request is successful, \\`successful\\` is returned. If the request fails, an error message is returned.', 'type' => 'string', 'title' => '', 'example' => 'successful'], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E'], 'Success' => ['description' => 'Indicates whether the request was successful.'."\n" ."\n" .'- true: The request was successful.'."\n" ."\n" .'- false: The request failed.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\",\\n \\"Success\\": true\\n}","type":"json"}]', 'title' => 'DeleteBackupPlan', 'description' => '- Deleting a backup plan also deletes the associated backup jobs.'."\n" ."\n" .'- Deleting a backup plan does not delete existing snapshots.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DeleteBackupPlan'], ], ], 'ramActions' => [ [ 'operationType' => 'delete', 'ramAction' => [ 'action' => 'hbr:DeleteBackupPlan', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'HBR', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], ], 'DeleteClient' => [ 'methods' => ['post', 'get'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'systemTags' => [ 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREhbrI97IXK'], ], 'parameters' => [ [ 'name' => 'VaultId', 'in' => 'query', 'schema' => ['description' => 'The ID of the backup repository.', 'type' => 'string', 'required' => false, 'example' => 'v-000************gs3', 'title' => ''], ], [ 'name' => 'ClientId', 'in' => 'query', 'schema' => ['description' => 'The ID of the client.', 'type' => 'string', 'required' => false, 'example' => 'c-000************f3h', 'title' => ''], ], [ 'name' => 'ResourceGroupId', 'in' => 'query', 'schema' => ['description' => 'The ID of the resource group.', 'type' => 'string', 'required' => false, 'example' => 'rg-acf************kwy', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Code' => ['description' => 'The return code. A value of 200 indicates that the request was successful.', 'type' => 'string', 'example' => '200', 'title' => ''], 'Message' => ['description' => 'The returned message. If the request is successful, \\`successful\\` is returned. If the request fails, an error message is returned.', 'type' => 'string', 'example' => 'successful', 'title' => ''], 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => 'C51A9094-64B7-5DC0-B9FE-5FC1AC7E081D', 'title' => ''], 'Success' => ['description' => 'Indicates whether the request was successful.'."\n" ."\n" .'- true: The request was successful.'."\n" ."\n" .'- false: The request failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'title' => 'DeleteClient', 'summary' => 'Deletes a client.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DeleteClient'], ], ], 'ramActions' => [ [ 'operationType' => 'delete', 'ramAction' => [ 'action' => 'hbr:DeleteClient', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'HBR', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"C51A9094-64B7-5DC0-B9FE-5FC1AC7E081D\\",\\n \\"Success\\": true\\n}","type":"json"}]', ], 'DeleteContainerCluster' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', 'abilityTreeCode' => '95472', 'abilityTreeNodes' => ['FEATUREhbrAL60OZ'], ], 'parameters' => [ [ 'name' => 'ClusterId', 'in' => 'query', 'schema' => ['description' => 'The cluster ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cc-0005**********hhjw', 'title' => ''], ], [ 'name' => 'Force', 'in' => 'query', 'schema' => ['description' => 'Specifies whether to forcibly delete active container backup clients.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Code' => ['description' => 'The return code. A value of 200 indicates that the request was successful.', 'type' => 'string', 'example' => '200', 'title' => ''], 'Message' => ['description' => 'The returned message. If the request was successful, "successful" is returned. If the request failed, an error message is returned.', 'type' => 'string', 'example' => 'successful', 'title' => ''], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'EB526A5D-1FE2-51C1-B790-1732C1DBA969', 'title' => ''], 'Success' => ['description' => 'Indicates whether the request was successful.'."\n" ."\n" .'- true: The request was successful.'."\n" ."\n" .'- false: The request failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'title' => 'DeleteContainerCluster', 'summary' => 'Unregisters a container cluster record in Cloud Backup. After you unregister the cluster, you cannot recover backups of the cluster.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"EB526A5D-1FE2-51C1-B790-1732C1DBA969\\",\\n \\"Success\\": true\\n}","type":"json"}]', ], 'DeleteCrossAccount' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '137630', 'abilityTreeNodes' => ['FEATUREhbrB08D1M'], ], 'parameters' => [ [ 'name' => 'CrossAccountUserId', 'in' => 'query', 'schema' => ['description' => 'The UID of the account to back up.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1841xxxxx3649795', 'title' => ''], ], [ 'name' => 'CrossAccountRoleName', 'in' => 'query', 'schema' => ['description' => 'The name of the RAM role of the account to back up. This parameter is required when you configure cross-account backup by assuming a RAM role.', 'type' => 'string', 'required' => true, 'example' => 'hbrcrossrole', 'title' => ''], ], [ 'name' => 'CrossAccountType', 'in' => 'query', 'schema' => ['description' => 'The type of cross-account backup. Valid values:'."\n" ."\n" .'- **CROSS\\_ACCOUNT**: Cross-account backup is configured by assuming a RAM role.'."\n" ."\n" .'- **CROSS\\_ACCOUNT\\_BY\\_RD**: Cross-account backup is configured based on a resource directory.', 'type' => 'string', 'required' => false, 'example' => 'CROSS_ACCOUNT', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Code' => ['description' => 'The return code. A value of 200 indicates that the request is successful.', 'type' => 'string', 'example' => '200', 'title' => ''], 'Message' => ['description' => 'The message returned. If the request is successful, \\`successful\\` is returned. If the request fails, an error message is returned.', 'type' => 'string', 'example' => 'successful', 'title' => ''], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '921E9989-735C-5254-A29F-6B8A5DDC1ED1', 'title' => ''], 'Success' => ['description' => 'Indicates whether the request was successful.'."\n" ."\n" .'- true: The request is successful.'."\n" ."\n" .'- false: The request fails.', 'type' => 'boolean', 'example' => 'True', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'title' => 'DeleteCrossAccount', 'summary' => 'Deletes a cross-account management relationship.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"921E9989-735C-5254-A29F-6B8A5DDC1ED1\\",\\n \\"Success\\": true\\n}","type":"json"}]', ], 'DeleteHanaBackupPlan' => [ 'methods' => ['post', 'get'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'systemTags' => ['operationType' => 'delete'], 'parameters' => [ [ 'name' => 'VaultId', 'in' => 'query', 'schema' => ['description' => 'The ID of the backup vault.'."\n", 'type' => 'string', 'required' => true, 'example' => 'v-0007o******1ssno'], ], [ 'name' => 'ClusterId', 'in' => 'query', 'schema' => ['description' => 'The ID of the SAP HANA instance.'."\n", 'type' => 'string', 'required' => true, 'example' => 'cl-000br3******0ooy2'], ], [ 'name' => 'PlanId', 'in' => 'query', 'schema' => ['description' => 'The ID of the backup plan.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pl-00035lc8pwp1azdf3qku'], ], [ 'name' => 'ResourceGroupId', 'in' => 'query', 'schema' => ['description' => 'The ID of the resource group.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rg-acfm4ebtpkzx7zy'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Code' => ['description' => 'The response code. The status code 200 indicates that the request was successful.'."\n", 'type' => 'string', 'example' => '200'], 'Message' => ['description' => 'The returned message. If the request was successful, "successful" is returned. If the request failed, an error message is returned.'."\n", 'type' => 'string', 'example' => 'successful'], 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '071E4789-6256-526B-B22E-2A9CDDB9EB21'], 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" ."\n" .'* true'."\n" .'* false'."\n", 'type' => 'boolean', 'example' => 'true'], ], 'description' => '', ], ], ], 'title' => 'DeleteHanaBackupPlan', 'summary' => 'Deletes an SAP HANA backup plan.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DeleteHanaBackupPlan'], ], ], 'ramActions' => [ [ 'operationType' => 'delete', 'ramAction' => [ 'action' => 'hbr:DeleteHanaBackupPlan', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'HBR', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"071E4789-6256-526B-B22E-2A9CDDB9EB21\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n 200\\n successful\\n 071E4789-6256-526B-B22E-2A9CDDB9EB21\\n true\\n","errorExample":""}]', ], 'DeleteHanaInstance' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'systemTags' => ['operationType' => 'delete'], 'parameters' => [ [ 'name' => 'VaultId', 'in' => 'query', 'schema' => ['description' => 'The ID of the backup vault.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'v-0008n2******ax3'], ], [ 'name' => 'ClusterId', 'in' => 'query', 'schema' => ['description' => 'The ID of the SAP HANA instance.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cl-000g4z09******9cfc'], ], [ 'name' => 'Sid', 'in' => 'query', 'schema' => ['description' => 'The security identifier (SID) of the SAP HANA database. You must specify a valid SID. The SID must be three characters in length and start with a letter. For more information, see [How to find sid user and instance number of HANA db?](https://answers.sap.com/questions/555192/how-to-find-sid-user-and-instance-number-of-hana-d.html?)'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'HXE'], ], [ 'name' => 'ResourceGroupId', 'in' => 'query', 'schema' => ['description' => 'The ID of the resource group.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rg-acfmwutpyat2kwy'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Code' => ['description' => 'The response code. The status code 200 indicates that the request was successful.'."\n", 'type' => 'string', 'example' => '200'], 'Message' => ['description' => 'The returned message. If the request was successful, "successful" is returned. If the request failed, an error message is returned.'."\n", 'type' => 'string', 'example' => 'successful'], 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '28EAF89A-E0D8-5C04-9A1D-B373B29BCFB9'], 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" ."\n" .'* true'."\n" .'* false'."\n", 'type' => 'boolean', 'example' => 'true'], ], 'description' => '', ], ], ], 'title' => 'DeleteHanaInstance', 'summary' => 'Deletes an SAP HANA instance.', 'description' => 'If you delete an SAP HANA instance, the existing backup data is also deleted and the running backup and restore jobs fail to be completed. Before you delete the SAP HANA instance, make sure that you no longer need the backup data of the instance and no backup or restore jobs are running for the instance. To delete an SAP HANA instance, you must specify the security identifier (SID) of the instance. The SID is three characters in length and starts with a letter. For more information, see [How to find sid user and instance number of HANA db?](https://answers.sap.com/questions/555192/how-to-find-sid-user-and-instance-number-of-hana-d.html?)'."\n", 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DeleteHanaInstance'], ], ], 'ramActions' => [ [ 'operationType' => 'delete', 'ramAction' => [ 'action' => 'hbr:DeleteHanaInstance', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'HBR', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"28EAF89A-E0D8-5C04-9A1D-B373B29BCFB9\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n 200\\n successful\\n 28EAF89A-E0D8-5C04-9A1D-B373B29BCFB9\\n true\\n","errorExample":""}]', ], 'DeletePolicyBinding' => [ 'summary' => 'Detaches a data source from a policy. After the data source is detached, the policy no longer protects it. Use this operation with caution.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREhbrS7MI6C', 'FEATUREhbrQ3MV3B', 'FEATUREhbrB1KQ9G', 'FEATUREhbr3BJQCT', 'FEATUREhbr56LH1C', 'FEATUREhbrFWIWBG', 'FEATUREhbr9ZUQY7', 'FEATUREhbrAW9I1R'], ], 'parameters' => [ [ 'name' => 'PolicyId', 'in' => 'formData', 'schema' => ['description' => 'The policy ID.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'po-000************hgp'], ], [ 'name' => 'DataSourceIds', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'description' => 'The IDs of the data sources to detach from the policy.', 'type' => 'array', 'items' => ['description' => 'The ID of a data source to detach from the policy.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'i-2ze************quf'], 'required' => false, 'title' => '', 'example' => '', ], ], [ 'name' => 'SourceType', 'in' => 'query', 'schema' => ['description' => 'The type of the data source. Valid values:'."\n" ."\n" .'- **UDM\\_ECS**: indicates an ECS instance backup.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'UDM_ECS'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'DeletePolicyBindingResponse', 'description' => 'DeletePolicyBindingResponse', 'type' => 'object', 'properties' => [ 'Success' => ['description' => 'Indicates whether the request was successful.'."\n" ."\n" .'- true: The request was successful.'."\n" ."\n" .'- false: The request failed.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], 'Code' => ['description' => 'The return code. A value of 200 indicates that the request was successful.', 'type' => 'string', 'title' => '', 'example' => '200'], 'Message' => ['description' => 'The returned message. If the request is successful, "successful" is returned. If the request fails, an error message is returned.', 'type' => 'string', 'title' => '', 'example' => 'successful'], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '3E961A5E-C5C6-566D-BFC3-0362A6A52EBA'], ], 'example' => '', ], ], ], 'title' => 'DeletePolicyBinding', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DeletePolicyBinding'], ], ], 'ramActions' => [ [ 'operationType' => '', 'ramAction' => [ 'action' => 'hbr:DeletePolicyBinding', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'HBR', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"3E961A5E-C5C6-566D-BFC3-0362A6A52EBA\\"\\n}","type":"json"}]', ], 'DeletePolicyV2' => [ 'summary' => 'Deletes a policy.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREhbrS7MI6C', 'FEATUREhbrQ3MV3B', 'FEATUREhbrB1KQ9G', 'FEATUREhbr3BJQCT', 'FEATUREhbr56LH1C', 'FEATUREhbrFWIWBG', 'FEATUREhbr9ZUQY7', 'FEATUREhbrAW9I1R'], ], 'parameters' => [ [ 'name' => 'PolicyId', 'in' => 'formData', 'schema' => ['description' => 'The policy ID.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'po-000************2l6'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'DeletePolicyResponse', 'description' => 'DeletePolicyResponse', 'type' => 'object', 'properties' => [ 'Success' => ['description' => 'Indicates whether the request was successful.'."\n" ."\n" .'- true: The request was successful.'."\n" ."\n" .'- false: The request failed.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], 'Code' => ['description' => 'The return code. A value of 200 indicates that the request was successful.', 'type' => 'string', 'title' => '', 'example' => '200'], 'Message' => ['description' => 'The returned message. If the request was successful, \\`successful\\` is returned. If the request failed, an error message is returned.', 'type' => 'string', 'title' => '', 'example' => 'successful'], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '33AA3AAE-89E1-5D3A-A51D-0C0A80850F68'], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'DeletePolicyV2', 'description' => 'When you delete a policy, it is detached from all associated data sources. Proceed with caution.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DeletePolicyV2'], ], ], 'ramActions' => [ [ 'operationType' => '', 'ramAction' => [ 'action' => 'hbr:DeletePolicyV2', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'HBR', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"33AA3AAE-89E1-5D3A-A51D-0C0A80850F68\\"\\n}","type":"json"}]', ], 'DeleteSnapshot' => [ 'summary' => 'Deletes a backup snapshot.', 'methods' => ['post', 'get'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'systemTags' => [ 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'paid', 'abilityTreeCode' => '95482', 'abilityTreeNodes' => ['FEATUREhbr56LH1C', 'FEATUREhbrFWIWBG', 'FEATUREhbrB1KQ9G', 'FEATUREhbr3BJQCT', 'FEATUREhbrS7MI6C', 'FEATUREhbrQ3MV3B'], ], 'parameters' => [ [ 'name' => 'Token', 'in' => 'query', 'schema' => ['description' => 'The token used for the deletion.', 'type' => 'string', 'required' => false, 'example' => '02WJDOE7', 'title' => ''], ], [ 'name' => 'VaultId', 'in' => 'query', 'schema' => ['description' => 'The ID of the backup repository.', 'type' => 'string', 'required' => false, 'example' => 'v-*********************', 'title' => ''], ], [ 'name' => 'ClientId', 'in' => 'query', 'schema' => ['description' => 'The client ID. To delete an ECS File Backup snapshot, specify either this parameter or **InstanceId**.', 'type' => 'string', 'required' => false, 'example' => 'c-*********************', 'title' => ''], ], [ 'name' => 'SnapshotId', 'in' => 'query', 'schema' => ['description' => 'The ID of the backup snapshot.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 's-*********************', 'title' => ''], ], [ 'name' => 'SourceType', 'in' => 'query', 'schema' => ['description' => 'The type of the backup source. Valid values:'."\n" ."\n" .'- **ECS\\_FILE**: ECS File Backup snapshot.'."\n" ."\n" .'- **OSS**: OSS backup snapshot.'."\n" ."\n" .'- **NAS**: NAS backup snapshot.'."\n" ."\n" .'- **UDM\\_ECS**: ECS instance backup snapshot.', 'type' => 'string', 'required' => false, 'example' => 'ECS_FILE', 'title' => ''], ], [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'The ID of the ECS instance. To delete an ECS File Backup snapshot, specify either this parameter or **ClientId**.', 'type' => 'string', 'required' => false, 'example' => 'i-*********************', 'title' => ''], ], [ 'name' => 'Force', 'in' => 'query', 'schema' => ['description' => 'This parameter is deprecated.', 'type' => 'boolean', 'example' => 'Deprecated.', 'deprecated' => true, 'required' => false, 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Code' => ['description' => 'The return code. A value of 200 indicates success.', 'type' => 'string', 'example' => '200', 'title' => ''], 'Message' => ['description' => 'The returned message. If the request is successful, "successful" is returned. If the request fails, an error message is returned.', 'type' => 'string', 'example' => 'successful', 'title' => ''], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E', 'title' => ''], 'Success' => ['description' => 'Indicates whether the request was successful.'."\n" ."\n" .'- true: The request was successful.'."\n" ."\n" .'- false: The request failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\",\\n \\"Success\\": true\\n}","type":"json"}]', 'title' => 'DeleteSnapshot', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DeleteSnapshot'], ], ], 'ramActions' => [ [ 'operationType' => 'delete', 'ramAction' => [ 'action' => 'hbr:DeleteSnapshot', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'HBR', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'machine', ], 'DeleteUdmDisk' => [ 'methods' => ['post', 'get'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '230674', 'abilityTreeNodes' => ['FEATUREhbrB1KQ9G'], ], 'parameters' => [ [ 'name' => 'DiskId', 'in' => 'query', 'schema' => ['description' => 'The disk ID.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'd-bp15************xy70'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request'."\n", 'type' => 'string', 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E'], 'Code' => ['description' => 'The response code. The status code 200 indicates that the request was successful.'."\n", 'type' => 'string', 'example' => '200'], 'Message' => ['description' => 'The returned message. If the request was successful, "successful" is returned. If the request failed, an error message is returned.'."\n", 'type' => 'string', 'example' => 'successful'], 'Success' => ['description' => 'Indicates whether the request was successful.'."\n" ."\n" .'* true'."\n" .'* false'."\n", 'type' => 'boolean', 'example' => 'true'], ], ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'DeleteUdmDisk', 'summary' => 'Cancels a protected disk.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DeleteUdmDisk'], ], ], 'ramActions' => [ [ 'operationType' => 'delete', 'ramAction' => [ 'action' => 'hbr:DeleteUdmDisk', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'HBR', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\",\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"Success\\": true\\n}","type":"json"}]', ], 'DeleteUdmEcsInstance' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', 'abilityTreeCode' => '95487', 'abilityTreeNodes' => ['FEATUREhbrB1KQ9G'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'The ID of the ECS instance.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'i-2zed************tlrm'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Code' => ['description' => 'The response code. The status code 200 indicates that the request was successful.'."\n", 'type' => 'string', 'example' => '200'], 'Message' => ['description' => 'The returned message. If the request was successful, "successful" is returned. If the request failed, an error message is returned.'."\n", 'type' => 'string', 'example' => 'successful'], 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '0497C0D3-82B5-56B2-8D64-D62E61B90E95'], 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" ."\n" .'* true'."\n" .'* false'."\n", 'type' => 'boolean', 'example' => 'true'], ], 'description' => '', ], ], ], 'title' => 'DeleteUdmEcsInstance', 'summary' => 'Stops protection for Elastic Compute Service (ECS) instance backup.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DeleteUdmEcsInstance'], ], ], 'ramActions' => [ [ 'operationType' => 'delete', 'ramAction' => [ 'action' => 'hbr:DeleteUdmEcsInstance', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'HBR', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"0497C0D3-82B5-56B2-8D64-D62E61B90E95\\",\\n \\"Success\\": true\\n}","type":"json"}]', ], 'DeleteVault' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'systemTags' => [ 'operationType' => 'delete', 'abilityTreeNodes' => ['FEATUREhbrS7MI6C'], ], 'parameters' => [ [ 'name' => 'Token', 'in' => 'query', 'schema' => ['description' => 'The token.'."\n", 'type' => 'string', 'required' => false, 'example' => 'caeba0bbb2be03f84eb48b699f0a*'], ], [ 'name' => 'VaultId', 'in' => 'query', 'schema' => ['description' => 'The ID of the backup vault.'."\n", 'type' => 'string', 'required' => false, 'example' => 'v-*********************'], ], [ 'name' => 'ResourceGroupId', 'in' => 'query', 'schema' => ['description' => 'The ID of the resource group.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rg-acfmoiyerpacj4q'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Code' => ['description' => 'The response code. The status code 200 indicates that the request was successful.'."\n", 'type' => 'string', 'example' => '200'], 'Message' => ['description' => 'The returned message. If the request was successful, "successful" is returned. If the request failed, an error message is returned.'."\n", 'type' => 'string', 'example' => 'successful'], 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E'], 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" ."\n" .'* true'."\n" .'* false'."\n", 'type' => 'boolean', 'example' => 'true'], ], 'description' => '', ], ], ], 'title' => 'DeleteVault', 'summary' => 'Deletes a backup vault.', 'description' => '* You cannot delete a backup vault within 2 hours after the backup vault is created or a backup vault that is in the INITIALIZING state.'."\n" .'* After you delete a backup vault, all resources that are associated with the backup vault are deleted. The resources include the Cloud Backup client of the old version, backup plans, backup jobs, snapshots, and restore jobs.'."\n", 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DeleteVault'], ], ], 'ramActions' => [ [ 'operationType' => 'delete', 'ramAction' => [ 'action' => 'hbr:DeleteVault', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'HBR', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\nsuccessful\\n473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\n200\\ntrue\\n","errorExample":""}]', ], 'DeleteVaultReplication' => [ 'summary' => 'Stops backup vault replication.', 'path' => '', 'methods' => ['post', 'get'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '95458', 'abilityTreeNodes' => ['FEATUREhbrGSUVI2'], ], 'parameters' => [ [ 'name' => 'ReplicationSourceVaultId', 'in' => 'query', 'schema' => ['description' => 'The ID of the source backup vault.', 'type' => 'string', 'required' => true, 'example' => 'v-*********************', 'title' => ''], ], [ 'name' => 'ReplicationTargetVaultId', 'in' => 'query', 'schema' => ['description' => 'The ID of the destination backup vault.', 'type' => 'string', 'required' => true, 'example' => 'r-*********************', 'title' => ''], ], [ 'name' => 'ReplicationSourceRegionId', 'in' => 'query', 'schema' => ['description' => 'The ID of the source region. If you leave this parameter empty, the region where you call the API is used.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'C438054F-9088-5D1B-AED0-0EA86D9C65F4', 'title' => ''], 'Success' => ['description' => 'Indicates whether the request is successful.'."\n" ."\n" .'- true: The request is successful.'."\n" ."\n" .'- false: The request fails.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'Code' => ['description' => 'The return code. A value of 200 indicates that the request is successful.', 'type' => 'string', 'example' => '200', 'title' => ''], 'Message' => ['description' => 'The message returned. If the request is successful, `successful` is returned. If the request fails, an error message is returned.', 'type' => 'string', 'example' => 'successful', 'title' => ''], ], 'title' => '', 'description' => 'The response object.', 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'DeleteVaultReplication', 'description' => 'You can call this method in the region of the destination backup vault.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'delete', 'ramAction' => [ 'action' => 'hbr:DeleteVaultReplication', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'HBR', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"C438054F-9088-5D1B-AED0-0EA86D9C65F4\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\"\\n}","type":"json"}]', ], 'DescribeBackupClients' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'abilityTreeCode' => '95500', 'abilityTreeNodes' => ['FEATUREhbr9ZUQY7'], ], 'parameters' => [ [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => ['description' => 'The page number. Pages start from page 1. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'minimum' => '1', 'default' => '1', 'title' => '', 'example' => '1'], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => ['description' => 'The number of entries per page. Valid values: 1 to 99. Default value: 10.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100', 'minimum' => '1', 'default' => '10', 'title' => '', 'example' => '10'], ], [ 'name' => 'ClientType', 'in' => 'query', 'schema' => [ 'description' => 'The type of the backup client. Valid values:'."\n" ."\n" .'- **ECS\\_CLIENT**: an ECS file backup client.'."\n" ."\n" .'- **CONTAINER\\_CLIENT**: a container backup client.'."\n" ."\n" .'- **LOCAL\\_CLIENT**: a client for NAS backup, CPFS backup, data archiving, or data synchronization.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'enumValueTitles' => ['CONTAINER_CLIENT' => 'CONTAINER\\_CLIENT', 'LOCAL_CLIENT' => 'LOCAL\\_CLIENT', 'ECS_CLIENT' => 'ECS\\_CLIENT'], 'title' => '', 'example' => 'ECS_CLIENT', ], ], [ 'name' => 'ClusterId', 'in' => 'query', 'schema' => ['description' => 'The ID of the backup cluster.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'cl-000ge4wa61b4d337xblq'], ], [ 'name' => 'ClientIds', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'description' => 'A list of backup client IDs.', 'type' => 'array', 'items' => ['description' => 'The backup client ID.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'c-*********************'], 'required' => false, 'example' => '["c-*********************"]', 'title' => '', ], ], [ 'name' => 'InstanceIds', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'description' => 'A list of ECS instance IDs.', 'type' => 'array', 'items' => ['description' => 'The ECS instance ID.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'i-*********************'], 'required' => false, 'example' => '["i-*********************"]', 'title' => '', ], ], [ 'name' => 'Tag', 'in' => 'formData', 'style' => 'repeatList', 'schema' => [ 'description' => 'The tags that are added to the resource.', 'type' => 'array', 'items' => [ 'description' => 'The tag information.', 'type' => 'object', 'properties' => [ 'Key' => ['description' => 'The tag key of the repository. N can be an integer from 1 to 20.'."\n" ."\n" .'- The tag key cannot start with `aliyun` or `acs:`.'."\n" ."\n" .'- The tag key cannot contain `http://` or `https://`.'."\n" ."\n" .'- The tag key cannot be an empty string.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'TestKey'], 'Value' => ['description' => 'The tag value of the repository. N can be an integer from 1 to 20.'."\n" ."\n" .'- The tag value cannot start with `aliyun` or `acs:`.'."\n" ."\n" .'- The tag value cannot contain `http://` or `https://`.'."\n" ."\n" .'- The tag value cannot be an empty string.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'TestValue'], ], 'required' => false, 'title' => '', ], 'required' => false, 'example' => '33738719#', 'maxItems' => 21, 'title' => '', ], ], [ 'name' => 'CrossAccountType', 'in' => 'query', 'schema' => ['description' => 'The type of the cross-account backup. Valid values:'."\n" ."\n" .'- SELF\\_ACCOUNT: backups of the current account'."\n" ."\n" .'- CROSS\\_ACCOUNT: cross-account backups', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'CROSS_ACCOUNT'], ], [ 'name' => 'CrossAccountUserId', 'in' => 'query', 'schema' => ['description' => 'The ID of the source account for the cross-account backup.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'title' => '', 'example' => '129374672382xxxx'], ], [ 'name' => 'CrossAccountRoleName', 'in' => 'query', 'schema' => ['description' => 'The name of the RAM role that is created in the source account for the cross-account backup.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'hbrcrossrole'], ], [ 'name' => 'Filters', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Key' => ['type' => 'string', 'description' => 'The key of the filter.', 'required' => false, 'title' => '', 'example' => 'InstanceId'], 'Values' => [ 'type' => 'array', 'items' => ['type' => 'string', 'description' => 'The value of the filter.', 'required' => false, 'title' => '', 'example' => 'i-*********************'."\n"], 'maxItems' => 100, 'description' => 'The values of the filter.', 'required' => false, 'title' => '', ], ], 'description' => 'The filter.', 'required' => false, 'title' => '', ], 'maxItems' => 5, 'description' => 'The filters used to query resources.', 'required' => false, 'title' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E'], 'Success' => ['description' => 'Indicates whether the request was successful.'."\n" ."\n" .'- true: The request was successful.'."\n" ."\n" .'- false: The request failed.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], 'Code' => ['description' => 'The return code. A value of 200 indicates that the request was successful.', 'type' => 'string', 'title' => '', 'example' => '200'], 'Message' => ['description' => 'The message that is returned. If the request is successful, \\`successful\\` is returned. If the request fails, an error message is returned.', 'type' => 'string', 'title' => '', 'example' => 'successful'], 'PageNumber' => ['description' => 'The page number. Pages start from page 1. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '1'], 'PageSize' => ['description' => 'The number of entries per page. Valid values: 1 to 99. Default value: 10.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '10'], 'TotalCount' => ['description' => 'The total number of backup clients that meet the specified conditions.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '8'], 'Clients' => [ 'description' => 'The list of backup clients.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Status' => ['description' => 'The status of the backup client. Valid values:'."\n" ."\n" .'- **REGISTERED**: The client is registered.'."\n" ."\n" .'- **ACTIVATED**: The client is activated.'."\n" ."\n" .'- **DEACTIVATED**: The client is deactivated.'."\n" ."\n" .'- **INSTALLING**: The client is being installed.'."\n" ."\n" .'- **INSTALL\\_FAILED**: The installation failed.'."\n" ."\n" .'- **NOT\\_INSTALLED**: The client is not installed.'."\n" ."\n" .'- **UPGRADING**: The client is being upgraded.'."\n" ."\n" .'- **UPGRADE\\_FAILED**: The upgrade failed.'."\n" ."\n" .'- **UNINSTALLING**: The client is being uninstalled.'."\n" ."\n" .'- **UNINSTALL\\_FAILED**: The uninstallation failed.'."\n" ."\n" .'- **STOPPED**: The client service is stopped.'."\n" ."\n" .'- **UNKNOWN**: The client is disconnected.', 'type' => 'string', 'title' => '', 'example' => 'ACTIVATED'], 'BackupStatus' => ['description' => 'The protection status of the backup client. Valid values:'."\n" ."\n" .'- **UNPROTECTED**: The server is not protected.'."\n" ."\n" .'- **PROTECTED**: The server is protected.', 'type' => 'string', 'title' => '', 'example' => 'PROTECTED'], 'ArchType' => ['description' => 'This parameter is returned only if **ClientType** is set to **ECS\\_CLIENT**. This parameter indicates the system architecture of the host where the backup client is deployed. Valid values:'."\n" ."\n" .'- **amd64**'."\n" ."\n" .'- **386**', 'type' => 'string', 'title' => '', 'example' => 'amd64'], 'ClientId' => ['description' => 'The backup client ID.', 'type' => 'string', 'title' => '', 'example' => 'c-*********************'], 'MaxClientVersion' => ['description' => 'The latest version number of the backup client.', 'type' => 'string', 'title' => '', 'example' => '2.4.5'], 'PrivateIpV4' => ['description' => 'This parameter is returned only if **ClientType** is set to **ECS\\_CLIENT**. This parameter indicates the private IP address of the ECS instance.', 'type' => 'string', 'title' => '', 'example' => '192.168.1.1'], 'InstanceName' => ['description' => 'This parameter is returned only if **ClientType** is set to **ECS\\_CLIENT**. This parameter indicates the name of the ECS instance.', 'type' => 'string', 'title' => '', 'example' => 'instancename'], 'CreatedTime' => ['description' => 'The time when the backup client was created. This value is a UNIX timestamp. Unit: seconds.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1554347313'], 'LastHeartBeatTime' => ['description' => 'The last heartbeat time of the backup client. This value is a UNIX timestamp. Unit: seconds.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1554347313'], 'ClientType' => ['description' => 'The type of the backup client. The value **ECS\\_CLIENT** indicates an ECS file backup client.', 'type' => 'string', 'title' => '', 'example' => 'ECS_CLIENT'], 'Hostname' => ['description' => 'The hostname of the host where the backup client is deployed.', 'type' => 'string', 'title' => '', 'example' => 'hostname'], 'InstanceId' => ['description' => 'The instance ID.'."\n" ."\n" .'- If the client is an ECS file backup client, this parameter indicates the ID of the ECS instance.'."\n" ."\n" .'- If the client is a local file backup client, this parameter indicates the hardware fingerprint that is generated based on system information.', 'type' => 'string', 'title' => '', 'example' => 'i-*********************'], 'Appliance' => ['description' => 'Indicates whether the client is a backup-archive all-in-one machine.'."\n" ."\n" .'- true: The client is a backup-archive all-in-one machine.'."\n" ."\n" .'- false: The client is not a backup-archive all-in-one machine.', 'type' => 'boolean', 'title' => '', 'example' => 'false'], 'UpdatedTime' => ['description' => 'The time when the backup client was updated. This value is a UNIX timestamp. Unit: seconds.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1554347313'], 'OsType' => ['description' => 'This parameter is returned only if **ClientType** is set to **ECS\\_CLIENT**. This parameter indicates the operating system type of the client. Valid values:'."\n" ."\n" .'- **windows**'."\n" ."\n" .'- **linux**', 'type' => 'string', 'title' => '', 'example' => 'linux'], 'ZoneId' => ['description' => 'This parameter is returned only if **ClientType** is set to **ECS\\_CLIENT**. This parameter indicates the zone ID.', 'type' => 'string', 'title' => '', 'example' => 'cn-hangzhou-f'], 'ClientVersion' => ['description' => 'The version number of the backup client.', 'type' => 'string', 'title' => '', 'example' => '2.4.5'], 'Tags' => [ 'description' => 'The tag information.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Key' => ['description' => 'The tag key of the repository. N can be an integer from 1 to 20.'."\n" ."\n" .'- The tag key cannot start with `aliyun` or `acs:`.'."\n" ."\n" .'- The tag key cannot contain `http://` or `https://`.'."\n" ."\n" .'- The tag key cannot be an empty string.', 'type' => 'string', 'title' => '', 'example' => 'TestKey'], 'Value' => ['description' => 'The tag value of the repository. N can be an integer from 1 to 20.'."\n" ."\n" .'- The tag value cannot start with `aliyun` or `acs:`.'."\n" ."\n" .'- The tag value cannot contain `http://` or `https://`.'."\n" ."\n" .'- The tag value cannot be an empty string.', 'type' => 'string', 'title' => '', 'example' => 'TestValue'], ], 'description' => '', 'title' => '', ], 'title' => '', ], 'Settings' => [ 'description' => 'The backup client settings.', 'type' => 'object', 'properties' => [ 'ProxyHost' => ['description' => 'The IP address of the custom proxy server for the data plane.', 'type' => 'string', 'title' => '', 'example' => '192.168.11.100'], 'MaxCpuCore' => ['description' => 'The number of CPU cores that are used by a single backup job. A value of 0 indicates that the number of CPU cores is not limited.', 'type' => 'string', 'title' => '', 'example' => '1'], 'ProxyPort' => ['description' => 'The port number of the custom proxy server for the data plane.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '3128'], 'UseHttps' => ['description' => 'Indicates whether data is transmitted over HTTPS on the data plane.'."\n" ."\n" .'- true: Data is transmitted over HTTPS.'."\n" ."\n" .'- false: Data is transmitted over HTTP.', 'type' => 'string', 'title' => '', 'example' => 'false'], 'ProxyPassword' => ['description' => 'The password for the custom proxy server for the data plane.', 'type' => 'string', 'title' => '', 'example' => '******'], 'ProxyUser' => ['description' => 'The username for the custom proxy server for the data plane.', 'type' => 'string', 'title' => '', 'example' => 'user'], 'DataProxySetting' => ['description' => 'The proxy settings for the data plane. Valid values:'."\n" ."\n" .'- **DISABLE**: A proxy is not used.'."\n" ."\n" .'- **USE\\_CONTROL\\_PROXY** (default): The proxy settings are the same as the control plane.'."\n" ."\n" .'- **CUSTOM**: Custom settings are used. The HTTP protocol is used.', 'type' => 'string', 'title' => '', 'example' => 'USE_CONTROL_PROXY'], 'DataNetworkType' => ['description' => 'The network type of the data plane. Valid values:'."\n" ."\n" .'- **PUBLIC**: Internet'."\n" ."\n" .'- **VPC**: VPC'."\n" ."\n" .'- **CLASSIC**: classic network', 'type' => 'string', 'title' => '', 'example' => 'VPC'], 'MaxWorker' => ['description' => 'The number of concurrent backup jobs. A value of 0 indicates that the number of concurrent backup jobs is not limited.', 'type' => 'string', 'title' => '', 'example' => '1'], 'MaxMemory' => ['description' => 'The maximum memory that the client can use. Unit: bytes. This parameter is supported only for client versions 2.13.0 and later.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '0'], 'AlertOnPartialComplete' => ['description' => 'Indicates whether to generate an alert for partially completed jobs. This parameter is valid only for local file backup and ECS file backup.', 'type' => 'boolean', 'title' => '', 'example' => 'false'], ], 'title' => '', ], ], 'description' => '', 'title' => '', ], 'example' => '{\'Client\': []}', 'title' => '', ], ], 'description' => '', 'title' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 8,\\n \\"Clients\\": [\\n {\\n \\"Status\\": \\"ACTIVATED\\",\\n \\"BackupStatus\\": \\"PROTECTED\\",\\n \\"ArchType\\": \\"amd64\\",\\n \\"ClientId\\": \\"c-*********************\\",\\n \\"MaxClientVersion\\": \\"2.4.5\\",\\n \\"PrivateIpV4\\": \\"192.168.1.1\\",\\n \\"InstanceName\\": \\"instancename\\",\\n \\"CreatedTime\\": 1554347313,\\n \\"LastHeartBeatTime\\": 1554347313,\\n \\"ClientType\\": \\"ECS_CLIENT\\",\\n \\"Hostname\\": \\"hostname\\",\\n \\"InstanceId\\": \\"i-*********************\\",\\n \\"Appliance\\": false,\\n \\"UpdatedTime\\": 1554347313,\\n \\"OsType\\": \\"linux\\",\\n \\"ZoneId\\": \\"cn-hangzhou-f\\",\\n \\"ClientVersion\\": \\"2.4.5\\",\\n \\"Tags\\": [\\n {\\n \\"Key\\": \\"TestKey\\",\\n \\"Value\\": \\"TestValue\\"\\n }\\n ],\\n \\"Settings\\": {\\n \\"ProxyHost\\": \\"192.168.11.100\\",\\n \\"MaxCpuCore\\": \\"1\\",\\n \\"ProxyPort\\": 3128,\\n \\"UseHttps\\": \\"false\\",\\n \\"ProxyPassword\\": \\"******\\",\\n \\"ProxyUser\\": \\"user\\",\\n \\"DataProxySetting\\": \\"USE_CONTROL_PROXY\\",\\n \\"DataNetworkType\\": \\"VPC\\",\\n \\"MaxWorker\\": \\"1\\",\\n \\"MaxMemory\\": 0,\\n \\"AlertOnPartialComplete\\": false\\n }\\n }\\n ]\\n}","type":"json"}]', 'title' => 'DescribeBackupClients', 'summary' => 'Queries the information about one or more backup clients that meet specified conditions.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeBackupClients'], ], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'hbr:DescribeBackupClients', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'HBR', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], ], 'DescribeBackupJobs2' => [ 'summary' => 'Queries backup jobs that meet the specified criteria.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '95502', 'abilityTreeNodes' => ['FEATUREhbrB1KQ9G', 'FEATUREhbrS7MI6C', 'FEATUREhbr3BJQCT', 'FEATUREhbrQ3MV3B', 'FEATUREhbr56LH1C', 'FEATUREhbrFWIWBG', 'FEATUREhbrAW9I1R'], ], 'parameters' => [ [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => ['description' => 'The page number. Pages start from page 1. The default value is 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'minimum' => '1', 'default' => '1', 'example' => '1', 'title' => ''], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => ['description' => 'The number of entries per page. Valid values: 1 to 99. The default value is 10.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100', 'minimum' => '1', 'default' => '10', 'example' => '10', 'title' => ''], ], [ 'name' => 'SourceType', 'in' => 'query', 'schema' => ['description' => 'The type of the data source. Valid values:'."\n" ."\n" .'- **ECS\\_FILE**: Backs up Elastic Compute Service (ECS) files.'."\n" ."\n" .'- **OSS**: Backs up Alibaba Cloud Object Storage Service (OSS) buckets.'."\n" ."\n" .'- **NAS**: Backs up Alibaba Cloud Apsara File Storage NAS (NAS) file systems.'."\n" ."\n" .'- **OTS**: Backs up Alibaba Cloud Tablestore instances.'."\n" ."\n" .'- **UDM\\_ECS**: Backs up entire ECS instances.'."\n" ."\n" .'- **UDM\\_ECS\\_DISK**: A sub-task for disk backup in an ECS instance backup job.'."\n" ."\n" .'- **COMMON\\_NAS**: A generic NAS data source. This includes archive NAS and on-premises NAS data sources. Use the Values parameter of Filters to specify the data source type.'."\n" ."\n" .'- **File**: Backs up on-premises files.'."\n" ."\n" .'- **SYNC**: Data synchronization.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'ECS_FILE', 'title' => ''], ], [ 'name' => 'SortDirection', 'in' => 'query', 'schema' => [ 'description' => 'The sort direction. Valid values:'."\n" ."\n" .'- **ASCEND**: Ascending order.'."\n" ."\n" .'- **DESCEND** (Default): Descending order.', 'type' => 'string', 'required' => false, 'default' => 'DESCEND', 'enum' => ['ASCEND', 'DESCEND'], 'example' => 'DESCEND', 'title' => '', ], ], [ 'name' => 'Filters', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => 'The key-value pairs of the filter.', 'type' => 'array', 'items' => [ 'description' => 'The filter.', 'type' => 'object', 'properties' => [ 'Key' => ['description' => 'The key of the filter. Valid values:'."\n" ."\n" .'- **RegionId**: The region ID.'."\n" ."\n" .'- **PlanId**: The backup plan ID.'."\n" ."\n" .'- **JobId**: The backup job ID.'."\n" ."\n" .'- **VaultId**: The repository ID.'."\n" ."\n" .'- **InstanceId**: The ECS instance ID.'."\n" ."\n" .'- **Bucket**: The name of the OSS bucket.'."\n" ."\n" .'- **FileSystemId**: The file system ID.'."\n" ."\n" .'- **Status**: The job status.'."\n" ."\n" .'- **CreatedTime**: The start time of the job.'."\n" ."\n" .'- **CompleteTime**: The end time of the job.'."\n" ."\n" .'- **InstanceName**: The name of the Tablestore instance.'."\n" ."\n" .'- **BackupType**: The backup job. This parameter is required only when SourceType is set to COMMON\\_NAS.'."\n" ."\n" .'- **ParentId**: The ID of the parent job. This parameter is required when you query sub-tasks. For example, if you set SourceType to UDM\\_ECS\\_DISK, you must specify the ID of the UDM\\_ECS job.', 'type' => 'string', 'required' => false, 'example' => 'VaultId', 'title' => ''], 'Values' => [ 'description' => 'The value of the filter.', 'type' => 'array', 'items' => ['description' => 'The value of the filter.'."\n" ."\n" .'COMPLETE: On-premises NAS backup.'."\n" ."\n" .'0: ARCHIVE: Archive NAS data source.'."\n" ."\n" .'1: ARCHIVE\\_BY\\_SEARCH: Archive NAS data source.', 'type' => 'string', 'required' => false, 'example' => 'COMPLETE', 'title' => ''], 'required' => false, 'maxItems' => 500, 'title' => '', 'example' => '', ], 'Operator' => ['description' => 'The matching operator. The default value is IN. This parameter specifies the operator to use for matching the Key and Value. Valid values:'."\n" ."\n" .'- **EQUAL**: Equal to.'."\n" ."\n" .'- **NOT\\_EQUAL**: Not equal to.'."\n" ."\n" .'- **GREATER\\_THAN**: Greater than.'."\n" ."\n" .'- **GREATER\\_THAN\\_OR\\_EQUAL**: Greater than or equal to.'."\n" ."\n" .'- **LESS\\_THAN**: Less than.'."\n" ."\n" .'- **LESS\\_THAN\\_OR\\_EQUAL**: Less than or equal to.'."\n" ."\n" .'- **BETWEEN**: The value is a JSON array in the format of `[start,end]`.'."\n" ."\n" .'- **IN**: The value is an array.'."\n" ."\n" .'> The IN operator is not supported when you use **CompleteTime** as the key for a query.', 'type' => 'string', 'required' => false, 'example' => 'IN', 'title' => ''], ], 'required' => false, 'title' => '', 'example' => '', ], 'required' => false, 'maxItems' => 5, 'title' => '', 'example' => '', ], ], [ 'name' => 'Edition', 'in' => 'query', 'schema' => ['description' => 'The edition. Valid values: BASIC and STANDARD. The default value is STANDARD.', 'type' => 'string', 'example' => 'STANDARD', 'title' => '', 'required' => false], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E', 'title' => ''], 'Success' => ['description' => 'Indicates whether the request was successful.'."\n" ."\n" .'- true: The request was successful.'."\n" ."\n" .'- false: The request failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'Code' => ['description' => 'The return code. A value of 200 indicates that the request was successful.', 'type' => 'string', 'example' => '200', 'title' => ''], 'Message' => ['description' => 'The message that is returned. If the request was successful, successful is returned. If the request failed, an error message is returned.', 'type' => 'string', 'example' => 'successful', 'title' => ''], 'PageNumber' => ['description' => 'The page number. Pages start from page 1. The default value is 1.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'PageSize' => ['description' => 'The number of entries per page. Valid values: 1 to 99. The default value is 10.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], 'TotalCount' => ['description' => 'The total number of backup jobs that meet the specified criteria.', 'type' => 'integer', 'format' => 'int64', 'example' => '8', 'title' => ''], 'BackupJobs' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'BackupJob' => [ 'description' => 'The list of backup jobs that meet the specified criteria.', 'type' => 'array', 'items' => [ 'description' => 'The details of the backup job.', 'type' => 'object', 'properties' => [ 'Status' => ['description' => 'The status of the backup job. Valid values:'."\n" ."\n" .'- **COMPLETE**: The job is successful.'."\n" ."\n" .'- **PARTIAL\\_COMPLETE**: The job is partially successful.'."\n" ."\n" .'- **FAILED**: The job failed.', 'type' => 'string', 'example' => 'COMPLETE', 'title' => ''], 'ErrorMessage' => ['description' => 'The error message for the backup job.', 'type' => 'string', 'example' => 'PARTIAL_COMPLETE', 'title' => ''], 'ActualItems' => ['description' => 'This parameter is valid only when **SourceType** is set to **ECS\\_FILE**. It indicates the actual number of items in the backup job.', 'type' => 'integer', 'format' => 'int64', 'example' => '6', 'title' => ''], 'VaultId' => ['description' => 'The ID of the backup repository.', 'type' => 'string', 'example' => 'v-0006******q', 'title' => ''], 'ActualBytes' => ['description' => 'The actual data volume of the backup job after deduplication. Unit: bytes.', 'type' => 'integer', 'format' => 'int64', 'example' => '600', 'title' => ''], 'CreateTime' => ['description' => 'This parameter is valid only when **SourceType** is set to **NAS**. It indicates the time when the file system was created. This value is a UNIX timestamp. Unit: seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1607436917', 'title' => ''], 'BackupType' => ['description' => 'The backup type. The value **COMPLETE** indicates a full backup.', 'type' => 'string', 'example' => 'COMPLETE', 'title' => ''], 'Prefix' => ['description' => 'This parameter is valid only when **SourceType** is set to **OSS**. It indicates the prefix of the backup object.', 'type' => 'string', 'example' => 'example/', 'title' => ''], 'SourceType' => ['description' => 'The type of the data source. Valid values:'."\n" ."\n" .'- **ECS\\_FILE**: Backs up ECS files.'."\n" ."\n" .'- **OSS**: Backs up Alibaba Cloud OSS buckets.'."\n" ."\n" .'- **NAS**: Backs up Alibaba Cloud NAS file systems.', 'type' => 'string', 'example' => 'ECS_FILE', 'title' => ''], 'Options' => ['description' => 'This parameter is required only when **SourceType** is set to **ECS\\_FILE**. It indicates whether to use Volume Shadow Copy Service (VSS) to define the backup path.'."\n" ."\n" .'- This feature is available only for Windows ECS instances.'."\n" ."\n" .'- If data in the backup source is changed, set this parameter to `{"UseVSS":true}` to ensure data consistency between the backup and the source.'."\n" ."\n" .'- After you enable VSS, you cannot back up multiple file directories at the same time.', 'type' => 'string', 'example' => '{"UseVSS":false}', 'title' => ''], 'ClientId' => ['description' => 'This parameter is valid only when **SourceType** is set to **ECS\\_FILE**. It indicates the ID of the backup client.', 'type' => 'string', 'example' => 'c-*********************', 'title' => ''], 'ItemsDone' => ['description' => 'This parameter is valid only when **SourceType** is set to **ECS\\_FILE**. It indicates the number of backup items.', 'type' => 'integer', 'format' => 'int64', 'example' => '8', 'title' => ''], 'BytesTotal' => ['description' => 'The total data volume of the data source. Unit: bytes.', 'type' => 'integer', 'format' => 'int64', 'example' => '1000', 'title' => ''], 'Exclude' => ['description' => 'This parameter is required only when **SourceType** is set to **ECS\\_FILE**. It indicates the path to files that do not need to be backed up. All files in this path are excluded. The path can be up to 255 characters long.', 'type' => 'string', 'example' => '["/var", "/proc"]', 'title' => ''], 'JobName' => ['description' => 'The name of the backup job.', 'type' => 'string', 'example' => 'jobname', 'title' => ''], 'CompleteTime' => ['description' => 'The time when the backup job was completed. This value is a UNIX timestamp. Unit: seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1554347313', 'title' => ''], 'CreatedTime' => ['description' => 'The time when the backup job was created. This value is a UNIX timestamp. Unit: seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1554347313', 'title' => ''], 'Bucket' => ['description' => 'This parameter is valid only when **SourceType** is set to **OSS**. It indicates the name of the OSS bucket.', 'type' => 'string', 'example' => 'hbr-backup-oss', 'title' => ''], 'Progress' => ['description' => 'The backup progress. The value is calculated as 100% × 100.', 'type' => 'integer', 'format' => 'int32', 'example' => '10000', 'title' => ''], 'SpeedLimit' => ['description' => 'This parameter is required only when **SourceType** is set to **ECS\\_FILE**. It indicates the traffic shaping settings for the backup. The format is `{start}|{end}|{bandwidth}`. Use the `|` character to separate multiple traffic shaping configurations. The time ranges of the configurations cannot overlap.'."\n" ."\n" .'- **start**: The start hour.'."\n" ."\n" .'- **end**: The end hour.'."\n" ."\n" .'- **bandwidth**: The throttling speed. Unit: KB/s.', 'type' => 'string', 'example' => '0:24:5120', 'title' => ''], 'InstanceId' => ['description' => 'This parameter is valid only when **SourceType** is set to **NAS**. It indicates the ECS instance ID.', 'type' => 'string', 'example' => 'i-*********************', 'title' => ''], 'PlanId' => ['description' => 'The backup plan ID.', 'type' => 'string', 'example' => 'plan-20********35', 'title' => ''], 'FileSystemId' => ['description' => 'This parameter is valid only when **SourceType** is set to **NAS**. It indicates the file system ID.', 'type' => 'string', 'example' => '005494', 'title' => ''], 'StartTime' => ['description' => 'The time when the backup job started. This value is a UNIX timestamp. Unit: seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1554347313', 'title' => ''], 'UpdatedTime' => ['description' => 'The time when the backup job was updated. This value is a UNIX timestamp. Unit: seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1554347313', 'title' => ''], 'JobId' => ['description' => 'The backup job ID.', 'type' => 'string', 'example' => 'job-000g********w7', 'title' => ''], 'ItemsTotal' => ['description' => 'This parameter is valid only when **SourceType** is set to **ECS\\_FILE**. It indicates the total number of items in the data source.', 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'title' => ''], 'Include' => ['description' => 'The source paths included in the backup job.', 'type' => 'string', 'example' => '["/home/alice/*.pdf", "/home/bob/*.txt"]', 'title' => ''], 'BytesDone' => ['description' => 'The data volume of the incremental backup. Unit: bytes.', 'type' => 'integer', 'format' => 'int64', 'example' => '800', 'title' => ''], 'Paths' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'Path' => [ 'description' => 'The source path of the backup.', 'type' => 'array', 'items' => ['description' => 'The source path.', 'type' => 'string', 'example' => '"/home"', 'title' => ''], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], 'Detail' => [ 'description' => 'The details of the ECS instance backup job.', 'type' => 'object', 'properties' => [ 'DoCopy' => ['description' => 'Indicates whether a remote replication is performed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'DestinationNativeSnapshotId' => ['description' => 'The ID of the remote replication snapshot.', 'type' => 'string', 'example' => 's-******************', 'title' => ''], 'DestinationNativeSnapshotProgress' => ['description' => 'The progress of the remote replication.', 'type' => 'integer', 'format' => 'int32', 'example' => '85', 'title' => ''], 'DestinationNativeSnapshotStatus' => ['description' => 'The status of the remote replication.', 'type' => 'string', 'example' => 'COMPLETE', 'title' => ''], 'DestinationRetention' => ['description' => 'The retention period of the remote replication backup.', 'type' => 'integer', 'format' => 'int64', 'example' => '30', 'title' => ''], 'DestinationSnapshotId' => ['description' => 'The ID of the remote replication backup.', 'type' => 'string', 'example' => 's-******************', 'title' => ''], 'DestinationNativeSnapshotErrorMessage' => ['description' => 'The error message for the failed remote replication.', 'type' => 'string', 'example' => 'ECS.CreatingSnapshot', 'title' => ''], 'NativeSnapshotId' => ['description' => 'The snapshot ID.', 'type' => 'string', 'example' => 's-******************', 'title' => ''], 'DiskNativeSnapshotIdList' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'DiskNativeSnapshotId' => [ 'description' => 'The mapping between snapshots and disks.', 'type' => 'array', 'items' => ['description' => 'The snapshot ID.', 'type' => 'string', 'example' => 's-******************', 'title' => ''], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], 'InstanceInfos' => ['description' => 'The information about the ECS instance, including the instance name and instance type.', 'type' => 'object', 'example' => '{'."\n" .' "i-xxxxxxxx": {'."\n" .' "hostName": "test",'."\n" .' "instanceName": "test",'."\n" .' "instanceType": "ecs.c7.xlarge",'."\n" .' "osType": "linux",'."\n" .' "diskIds": ['."\n" .' "d-xxxxxxxx01",'."\n" .' "d-xxxxxxxx02"'."\n" .' ],'."\n" .' "osNameEn": "Rocky Linux 8.8 64 bit",'."\n" .' "osName": "Rocky Linux 8.8 64position",'."\n" .' "platform": "Rocky Linux"'."\n" .' }'."\n" .'}', 'title' => ''], ], 'title' => '', 'example' => '', ], 'InstanceName' => ['description' => 'The name of the Tablestore instance.', 'type' => 'string', 'example' => 'instancename', 'title' => ''], 'OtsDetail' => [ 'description' => 'The details of the Tablestore instance.', 'type' => 'object', 'properties' => [ 'TableNames' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'TableName' => [ 'description' => 'The list of data table names in the Tablestore instance.', 'type' => 'array', 'items' => ['description' => 'The name of a data table in the Tablestore instance.', 'type' => 'string', 'example' => '["table1", "table2", "table3"]', 'title' => ''], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], 'Speed' => ['description' => 'The actual average backup speed. Unit: KB/s.', 'type' => 'integer', 'format' => 'int64', 'example' => '500', 'title' => ''], 'TableName' => ['description' => 'The name of the data table in the Tablestore instance.', 'type' => 'string', 'example' => 'table1', 'title' => ''], 'CrossAccountType' => [ 'description' => 'The type of the cross-account backup. Valid values:'."\n" ."\n" .'- SELF\\_ACCOUNT: Backs up data within the same account.'."\n" ."\n" .'- CROSS\\_ACCOUNT: Backs up data across accounts.', 'enumValueTitles' => [], 'type' => 'string', 'example' => 'SELF_ACCOUNT', 'title' => '', ], 'CrossAccountUserId' => ['description' => 'The ID of the source account that is managed by the current account for cross-account backup.', 'type' => 'integer', 'format' => 'int64', 'example' => '158975xxxxx4625', 'title' => ''], 'CrossAccountRoleName' => ['description' => 'The name of the RAM role that is created in the source account for cross-account backup and managed by the current account.', 'type' => 'string', 'example' => 'BackupRole', 'title' => ''], 'Report' => [ 'description' => 'The job report.', 'type' => 'object', 'properties' => [ 'TotalFiles' => ['description' => 'The list of all files. This parameter is not returned for data synchronization.', 'type' => 'string', 'example' => '/temp/report/158975xxxxxx4625/job-0001hfxxxxxymsspjjtl/job-0001hfxxxxxymsspjjtl_total.csv', 'title' => ''], 'SuccessFiles' => ['description' => 'The list of successful files.', 'type' => 'string', 'example' => '/temp/report/158975xxxxxx4625/r-0001hfxxxxxymsspjjtl/job-0001hfxxxxxymsspjjtl_success.zip', 'title' => ''], 'FailedFiles' => ['description' => 'The list of failed files.', 'type' => 'string', 'example' => '/temp/report/158975xxxxxx4625/r-0001hfxxxxxymsspjjtl/job-0001hfxxxxxymsspjjtl_failed.zip', 'title' => ''], 'SkippedFiles' => ['description' => 'The list of skipped files.', 'type' => 'string', 'example' => '/temp/report/158975xxxxxx4625/r-0001hfxxxxxymsspjjtl/job-0001hfxxxxxymsspjjtl_skipped.zip', 'title' => ''], 'ReportTaskStatus' => ['description' => 'The status of report generation.', 'type' => 'string', 'example' => 'COMPLETE', 'title' => ''], ], 'title' => '', 'example' => '', ], 'Identifier' => ['description' => 'This parameter is returned only when SourceType is set to CONTAINER. It indicates the ID of the cluster that is backed up by the container backup job. If the cluster is a Container Service for Kubernetes (ACK) cluster, this parameter indicates the ACK cluster ID.', 'type' => 'string', 'title' => '', 'example' => 'c83**************************b76'], 'DestSourceType' => ['description' => 'The type of the destination data source. This parameter is required only for synchronization.', 'type' => 'string', 'example' => 'OSS', 'title' => ''], 'DestDataSourceId' => ['description' => 'The ID of the destination data source. This parameter is required only for synchronization.', 'type' => 'string', 'example' => 'ds-000cov4ufudxklj24zdk', 'title' => ''], 'DestDataSourceDetail' => ['description' => 'The details of the destination data source. This parameter is required only for synchronization.', 'type' => 'string', 'example' => '{\\"prefix\\":\\"/\\"}', 'title' => ''], 'ChangeListPath' => ['description' => 'The configuration of the incremental file synchronization list. This parameter is required only for synchronization.', 'type' => 'string', 'example' => '{"dataSourceId": "ds-123456789", "path": "/changelist"}', 'title' => ''], 'FilesTotal' => ['description' => 'The total number of files to be processed.', 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'title' => ''], 'FilesDone' => ['description' => 'The number of processed files.', 'type' => 'integer', 'format' => 'int64', 'example' => '9', 'title' => ''], 'ActualFiles' => ['description' => 'The actual number of processed files.', 'type' => 'integer', 'format' => 'int64', 'example' => '8', 'title' => ''], 'TriggerMode' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 8,\\n \\"BackupJobs\\": {\\n \\"BackupJob\\": [\\n {\\n \\"Status\\": \\"COMPLETE\\",\\n \\"ErrorMessage\\": \\"PARTIAL_COMPLETE\\",\\n \\"ActualItems\\": 6,\\n \\"VaultId\\": \\"v-0006******q\\",\\n \\"ActualBytes\\": 600,\\n \\"CreateTime\\": 1607436917,\\n \\"BackupType\\": \\"COMPLETE\\",\\n \\"Prefix\\": \\"example/\\",\\n \\"SourceType\\": \\"ECS_FILE\\",\\n \\"Options\\": \\"{\\\\\\"UseVSS\\\\\\":false}\\",\\n \\"ClientId\\": \\"c-*********************\\",\\n \\"ItemsDone\\": 8,\\n \\"BytesTotal\\": 1000,\\n \\"Exclude\\": \\"[\\\\\\"/var\\\\\\", \\\\\\"/proc\\\\\\"]\\",\\n \\"JobName\\": \\"jobname\\",\\n \\"CompleteTime\\": 1554347313,\\n \\"CreatedTime\\": 1554347313,\\n \\"Bucket\\": \\"hbr-backup-oss\\",\\n \\"Progress\\": 10000,\\n \\"SpeedLimit\\": \\"0:24:5120\\",\\n \\"InstanceId\\": \\"i-*********************\\",\\n \\"PlanId\\": \\"plan-20********35\\",\\n \\"FileSystemId\\": \\"005494\\",\\n \\"StartTime\\": 1554347313,\\n \\"UpdatedTime\\": 1554347313,\\n \\"JobId\\": \\"job-000g********w7\\",\\n \\"ItemsTotal\\": 10,\\n \\"Include\\": \\"[\\\\\\"/home/alice/*.pdf\\\\\\", \\\\\\"/home/bob/*.txt\\\\\\"]\\",\\n \\"BytesDone\\": 800,\\n \\"Paths\\": {\\n \\"Path\\": [\\n \\"\\\\\\"/home\\\\\\"\\"\\n ]\\n },\\n \\"Detail\\": {\\n \\"DoCopy\\": true,\\n \\"DestinationNativeSnapshotId\\": \\"s-******************\\",\\n \\"DestinationNativeSnapshotProgress\\": 85,\\n \\"DestinationNativeSnapshotStatus\\": \\"COMPLETE\\",\\n \\"DestinationRetention\\": 30,\\n \\"DestinationSnapshotId\\": \\"s-******************\\",\\n \\"DestinationNativeSnapshotErrorMessage\\": \\"ECS.CreatingSnapshot\\",\\n \\"NativeSnapshotId\\": \\"s-******************\\",\\n \\"DiskNativeSnapshotIdList\\": {\\n \\"DiskNativeSnapshotId\\": [\\n \\"s-******************\\"\\n ]\\n },\\n \\"InstanceInfos\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n },\\n \\"InstanceName\\": \\"instancename\\",\\n \\"OtsDetail\\": {\\n \\"TableNames\\": {\\n \\"TableName\\": [\\n \\"[\\\\\\"table1\\\\\\", \\\\\\"table2\\\\\\", \\\\\\"table3\\\\\\"]\\"\\n ]\\n }\\n },\\n \\"Speed\\": 500,\\n \\"TableName\\": \\"table1\\",\\n \\"CrossAccountType\\": \\"SELF_ACCOUNT\\",\\n \\"CrossAccountUserId\\": 0,\\n \\"CrossAccountRoleName\\": \\"BackupRole\\",\\n \\"Report\\": {\\n \\"TotalFiles\\": \\"/temp/report/158975xxxxxx4625/job-0001hfxxxxxymsspjjtl/job-0001hfxxxxxymsspjjtl_total.csv\\",\\n \\"SuccessFiles\\": \\"/temp/report/158975xxxxxx4625/r-0001hfxxxxxymsspjjtl/job-0001hfxxxxxymsspjjtl_success.zip\\",\\n \\"FailedFiles\\": \\"/temp/report/158975xxxxxx4625/r-0001hfxxxxxymsspjjtl/job-0001hfxxxxxymsspjjtl_failed.zip\\",\\n \\"SkippedFiles\\": \\"/temp/report/158975xxxxxx4625/r-0001hfxxxxxymsspjjtl/job-0001hfxxxxxymsspjjtl_skipped.zip\\",\\n \\"ReportTaskStatus\\": \\"COMPLETE\\"\\n },\\n \\"Identifier\\": \\"c83**************************b76\\",\\n \\"DestSourceType\\": \\"OSS\\",\\n \\"DestDataSourceId\\": \\"ds-000cov4ufudxklj24zdk\\",\\n \\"DestDataSourceDetail\\": \\"{\\\\\\\\\\\\\\"prefix\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"/\\\\\\\\\\\\\\"}\\",\\n \\"ChangeListPath\\": \\"{\\\\\\"dataSourceId\\\\\\": \\\\\\"ds-123456789\\\\\\", \\\\\\"path\\\\\\": \\\\\\"/changelist\\\\\\"}\\",\\n \\"FilesTotal\\": 10,\\n \\"FilesDone\\": 9,\\n \\"ActualFiles\\": 8,\\n \\"TriggerMode\\": \\"\\"\\n }\\n ]\\n }\\n}","type":"json"}]', 'title' => 'DescribeBackupJobs2', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeBackupJobs2'], ], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'hbr:DescribeBackupJobs2', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'HBR', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'machine', ], 'DescribeBackupPlans' => [ 'summary' => 'Gets one or more backup plans that meet specified conditions.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '95503', 'abilityTreeNodes' => ['FEATUREhbr56LH1C', 'FEATUREhbrS7MI6C', 'FEATUREhbrFWIWBG', 'FEATUREhbrAW9I1R', 'FEATUREhbrB1KQ9G', 'FEATUREhbrQ3MV3B', 'FEATUREhbr3BJQCT'], ], 'parameters' => [ [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => ['description' => 'The page number. Pages start from page 1. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'minimum' => '1', 'default' => '1', 'title' => '', 'example' => '1'], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => ['description' => 'The number of entries per page. Valid values: 1 to 99. Default value: 10.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100', 'minimum' => '1', 'default' => '10', 'title' => '', 'example' => '10'], ], [ 'name' => 'SourceType', 'in' => 'query', 'schema' => ['description' => 'The type of the data source. Valid values:'."\n" ."\n" .'- **ECS\\_FILE**: Files of an Elastic Compute Service (ECS) instance.'."\n" ."\n" .'- **OSS**: Objects in Object Storage Service (OSS).'."\n" ."\n" .'- **NAS**: File systems of Apsara File Storage NAS (NAS).'."\n" ."\n" .'- **OTS**: Tablestore instances.'."\n" ."\n" .'- **UDM\\_ECS**: Entire ECS instances.'."\n" ."\n" .'- **SYNC**: Data synchronization.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'title' => '', 'example' => 'ECS_FILE'], ], [ 'name' => 'Filters', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => 'The filters.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Key' => ['description' => 'The key in the filter. Valid values:'."\n" ."\n" .'- **regionId**: The region ID.'."\n" ."\n" .'- **planId**: The ID of the backup plan.'."\n" ."\n" .'- **sourceType**: The type of the backup source.'."\n" ."\n" .'- **vaultId**: The ID of the backup repository.'."\n" ."\n" .'- **instanceName**: The name of the instance.'."\n" ."\n" .'- **instanceId**: The ID of the instance.'."\n" ."\n" .'- **planName**: The name of the backup plan.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'vaultId'], 'Values' => [ 'description' => 'The value to match in the filter.', 'type' => 'array', 'items' => ['description' => 'The value to match in the filter.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'v-*********************'], 'required' => false, 'example' => '["v-*********************"]', 'maxItems' => 500, 'title' => '', ], ], 'required' => false, 'description' => 'The filter.', 'title' => '', 'example' => '', ], 'required' => false, 'maxItems' => 5, 'title' => '', 'example' => '', ], ], [ 'name' => 'Edition', 'in' => 'query', 'schema' => ['type' => 'string', 'title' => '', 'description' => 'The edition of the backup plan. Valid values: BASIC and STANDARD. Default value: STANDARD.', 'required' => false, 'example' => 'STANDARD'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E'], 'Success' => ['description' => 'Indicates whether the request was successful.'."\n" ."\n" .'- true: The request was successful.'."\n" ."\n" .'- false: The request failed.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], 'Code' => ['description' => 'The return code. A value of 200 indicates that the request was successful.', 'type' => 'string', 'title' => '', 'example' => '200'], 'Message' => ['description' => 'The returned message. If the request is successful, "successful" is returned. If the request fails, an error message is returned.', 'type' => 'string', 'title' => '', 'example' => 'successful'], 'PageNumber' => ['description' => 'The page number. Pages start from page 1. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '1'], 'PageSize' => ['description' => 'The number of entries per page. Valid values: 1 to 99. Default value: 10.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '10'], 'TotalCount' => ['description' => 'The total number of backup plans that meet the specified conditions.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '8'], 'BackupPlans' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'BackupPlan' => [ 'description' => 'The backup plans that meet the specified conditions.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'VaultId' => ['description' => 'The ID of the backup repository.', 'type' => 'string', 'title' => '', 'example' => 'v-*********************'], 'BackupType' => ['description' => 'The backup type. The value **COMPLETE** indicates a full backup.', 'type' => 'string', 'title' => '', 'example' => 'COMPLETE'], 'CreateTime' => ['description' => 'The time when the file system was created. This parameter is valid only if **SourceType** is set to **NAS**. This value is a UNIX timestamp, in seconds.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1554347313'], 'DataSourceId' => ['description' => 'The ID of the data source.', 'type' => 'string', 'title' => '', 'example' => 'ds-000ht6o9*****w61'], 'SourceType' => ['description' => 'The type of the data source. Valid values:'."\n" ."\n" .'- **ECS\\_FILE**: Files of an ECS instance.'."\n" ."\n" .'- **OSS**: Objects in OSS.'."\n" ."\n" .'- **NAS**: File systems of NAS.'."\n" ."\n" .'- **OTS**: Tablestore instances.'."\n" ."\n" .'- **UDM\\_ECS**: Entire ECS instances.'."\n" ."\n" .'- **SYNC**: Data synchronization.', 'type' => 'string', 'title' => '', 'example' => 'ECS_FILE'], 'Disabled' => ['description' => 'Specifies whether the backup plan is paused.'."\n" ."\n" .'- true: The backup plan is paused.'."\n" ."\n" .'- false: The backup plan is not paused.', 'type' => 'boolean', 'title' => '', 'example' => 'false'], 'Prefix' => ['description' => 'The prefix of the objects to back up. This parameter is valid only if **SourceType** is set to **OSS**.', 'type' => 'string', 'title' => '', 'example' => 'oss-prefix'], 'Options' => ['description' => 'Specifies whether to use Windows Volume Shadow Copy Service (VSS) to create a shadow copy. This parameter is valid only if **SourceType** is set to **ECS\\_FILE**.', 'type' => 'string', 'title' => '', 'example' => '{"UseVSS":false}'], 'ClientId' => ['description' => 'The ID of the client.', 'type' => 'string', 'title' => '', 'example' => 'c-000ge4w*****1qb'], 'Exclude' => ['description' => 'The path to the files to exclude from the backup. This parameter is valid only if **SourceType** is set to **ECS\\_FILE**. Files in the specified path are not backed up.', 'type' => 'string', 'title' => '', 'example' => '["/var", "/proc"] '], 'Retention' => ['description' => 'The retention period of the backup data, in days.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '7'], 'CreatedTime' => ['description' => 'The time when the backup plan was created. This value is a UNIX timestamp, in seconds.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1554347313'], 'ClusterId' => ['description' => 'The ID of the client group.', 'type' => 'string', 'title' => '', 'example' => 'cl-000ht6o9******h'], 'Bucket' => ['description' => 'The name of the OSS bucket. This parameter is valid only if **SourceType** is set to **OSS**.', 'type' => 'string', 'title' => '', 'example' => 'hbr-backup-oss'], 'Detail' => ['description' => 'The details of the ECS instance backup.', 'type' => 'string', 'title' => '', 'example' => '{\\"doCopy\\":true,\\"doBackup\\":false,\\"instanceName\\":\\"instance example\\",\\"appConsistent\\":false,\\"destinationRegionId\\":\\"cn-shanghai\\",\\"enableFsFreeze\\":true,\\"osNameEn\\":\\"Windows Server 2019 Data Center Edition 64bit Chinese Edition\\",\\"osName\\":\\"Windows Server 2019 Data Center Edition 64bit Chinese Edition\\",\\"diskIdList\\":[],\\"backupVaultId\\":\\"\\",\\"snapshotGroup\\":true,\\"destinationRetention\\":35,\\"platform\\":\\"Windows Server 2012\\",\\"timeoutInSeconds\\":60,\\"backupRetention\\":1,\\"osType\\":\\"windows\\",\\"preScriptPath\\":\\"\\",\\"postScriptPath\\":\\"\\",\\"enableWriters\\":true,\\"ecsDeleted\\":false}'], 'Schedule' => ['description' => 'The backup policy, formatted as `I|{startTime}|{interval}`. A backup job runs every `{interval}` starting from `{startTime}`. Overdue jobs are skipped. A new job does not start if the previous one is still running. For example, `I|1631685600|P1D` means a backup job runs daily starting from 2021-09-15 14:00:00.'."\n" ."\n" .'- **startTime**: The start time of the backup. This is a UNIX timestamp in seconds.'."\n" ."\n" .'- **interval**: The backup interval in the ISO 8601 format. For example, PT1H means one hour and P1D means one day.', 'type' => 'string', 'title' => '', 'example' => 'I|1602673264|P1D'], 'SpeedLimit' => ['description' => 'The traffic shaping policy for the backup. This parameter is valid only if **SourceType** is set to **ECS\\_FILE**. Format: `{start}|{end}|{bandwidth}`. Separate multiple policies with a pipe character (`|`). The time periods of the policies cannot overlap.'."\n" ."\n" .'- start: The start hour.'."\n" ."\n" .'- end: The end hour.'."\n" ."\n" .'- bandwidth: The bandwidth limit. Unit: KB.', 'type' => 'string', 'title' => '', 'example' => '0:24:5120'], 'InstanceId' => ['description' => 'The ID of the ECS instance. This parameter is valid only if **SourceType** is set to **ECS\\_FILE**.', 'type' => 'string', 'title' => '', 'example' => 'i-*********************'], 'PlanId' => ['description' => 'The ID of the backup plan.', 'type' => 'string', 'title' => '', 'example' => 'plan-*********************'], 'BackupSourceGroupId' => ['description' => 'The ID of the backup data source group.', 'type' => 'string', 'title' => '', 'example' => 'System-Database'], 'FileSystemId' => ['description' => 'The ID of the file system. This parameter is valid only if **SourceType** is set to **NAS**.', 'type' => 'string', 'title' => '', 'example' => '00594'], 'OtsDetail' => [ 'description' => 'The details of the Tablestore instance.', 'type' => 'object', 'properties' => [ 'TableNames' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'TableName' => [ 'description' => 'The tables in the Tablestore instance.', 'type' => 'array', 'items' => ['description' => 'The name of the data table in the Tablestore instance.', 'type' => 'string', 'title' => '', 'example' => 'test2_HBR_RESTORED'], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], 'InstanceName' => ['description' => 'The name of the Tablestore instance.', 'type' => 'string', 'title' => '', 'example' => 'instancename'], 'UpdatedTime' => ['description' => 'The time when the backup plan was updated. This value is a UNIX timestamp, in seconds.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1554347313'], 'PlanName' => ['description' => 'The name of the backup plan.', 'type' => 'string', 'title' => '', 'example' => 'planname'], 'Include' => ['description' => 'The path to the files to back up. This parameter is valid only if **SourceType** is set to **ECS\\_FILE**. All files in the specified path are backed up.', 'type' => 'string', 'title' => '', 'example' => '["/home/alice/*.pdf", "/home/bob/*.txt"]'], 'Rules' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'Rule' => [ 'description' => 'The backup policies. This parameter is valid only for disk backups.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'DestinationRetention' => ['description' => 'The retention period of the geo-redundant backup, in days.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '90'], 'Schedule' => ['description' => 'The backup policy, formatted as `I|{startTime}|{interval}`. A backup job runs every `{interval}` starting from `{startTime}`. Overdue jobs are skipped. A new job does not start if the previous one is still running. For example, `I|1631685600|P1D` means a backup job runs daily starting from 2021-09-15 14:00:00.'."\n" ."\n" .'- `startTime`: The start time of the backup. This is a UNIX timestamp in seconds.'."\n" ."\n" .'- `interval`: The backup interval in the ISO 8601 format. For example, PT1H means one hour and P1D means one day.', 'type' => 'string', 'title' => '', 'example' => 'I|1631685600|P1D'], 'Retention' => ['description' => 'The retention period of the backup data, in days.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '90'], 'Disabled' => ['description' => 'Specifies whether the policy is disabled.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], 'DoCopy' => ['description' => 'Specifies whether to copy the backup snapshot to the backup repository.', 'type' => 'boolean', 'title' => '', 'example' => 'false'], 'DestinationRegionId' => ['description' => 'The ID of the destination region for the geo-redundant backup.', 'type' => 'string', 'title' => '', 'example' => 'cn-shanghai'], 'RuleId' => ['description' => 'The ID of the policy.', 'type' => 'string', 'title' => '', 'example' => 'rule-0008i52rf0ulpni6kn6m'], 'RuleName' => ['description' => 'The name of the policy.', 'type' => 'string', 'title' => '', 'example' => 'Disk Golden Rule'], 'BackupType' => ['description' => 'The backup type. The value **COMPLETE** indicates a full backup.', 'type' => 'string', 'title' => '', 'example' => 'COMPLETE'], ], 'description' => 'The backup policy.', 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], 'Resources' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'Resource' => [ 'description' => 'The backup resources. This parameter is valid only for disk backups.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'SourceType' => ['description' => 'The type of the data source. Valid value: **UDM\\_DISK**.', 'type' => 'string', 'title' => '', 'example' => 'UDM_DISK'], 'ResourceId' => ['description' => 'The ID of the data source.', 'type' => 'string', 'title' => '', 'example' => 'd-j6cgioir6m******lu4'], 'Extra' => ['description' => 'The extended information about the data source.', 'type' => 'string', 'title' => '', 'example' => '{\\"doBackup\\":false,\\"diskName\\":\\"data_disk\\",\\"size\\":100,\\"type\\":\\"data\\",\\"category\\":\\"cloud_essd\\",\\"imageId\\":\\"\\",\\"device\\":\\"/dev/xvdb\\",\\"encrypted\\":false}'], ], 'description' => 'The backup resource.', 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], 'Paths' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'Path' => [ 'description' => 'The backup paths. This parameter is valid only if **SourceType** is set to **ECS\\_FILE**.', 'type' => 'array', 'items' => ['description' => 'The backup path.', 'type' => 'string', 'title' => '', 'example' => '["/home"]'], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], 'TrialInfo' => [ 'description' => 'The free trial information.', 'type' => 'object', 'properties' => [ 'TrialStartTime' => ['description' => 'The time when the free trial starts.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1579413159'], 'TrialVaultReleaseTime' => ['description' => 'The time when the free trial repository is released.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1594965600'], 'TrialExpireTime' => ['description' => 'The time when the free trial expires.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1584597600'], 'KeepAfterTrialExpiration' => ['description' => 'Specifies whether to convert the plan to a pay-as-you-go plan after the free trial ends.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], ], 'title' => '', 'example' => '', ], 'InstanceGroupId' => ['description' => 'The ID of the instance group.', 'type' => 'string', 'title' => '', 'example' => 'i-**'], 'CrossAccountType' => [ 'description' => 'The type of the cross-account backup. Valid values:'."\n" ."\n" .'- SELF\\_ACCOUNT'."\n" ."\n" .'- CROSS\\_ACCOUNT', 'type' => 'string', 'enumValueTitles' => [], 'title' => '', 'example' => 'CROSS_ACCOUNT', ], 'CrossAccountUserId' => ['description' => 'The ID of the source account for the cross-account backup.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1841642xxxxx9795'], 'CrossAccountRoleName' => ['description' => 'The name of the RAM role in the source account for the cross-account backup.', 'type' => 'string', 'title' => '', 'example' => 'BackupRole'], 'KeepLatestSnapshots' => ['description' => 'Specifies whether to retain at least one backup version.'."\n" ."\n" .'- 0: Does not retain.'."\n" ."\n" .'- 1: Retains.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '0'], 'DestSourceType' => ['description' => 'The type of the destination data source. This parameter is required only for data synchronization.', 'type' => 'string', 'title' => '', 'example' => 'OSS'], 'DestDataSourceId' => ['description' => 'The ID of the destination data source. This parameter is required only for data synchronization.', 'type' => 'string', 'title' => '', 'example' => 'ds-*********************'], 'DestDataSourceDetail' => ['description' => 'The details of the destination data source. This parameter is required only for data synchronization.', 'type' => 'string', 'title' => '', 'example' => '{\\"prefix\\":\\"/\\"}'], 'ChangeListPath' => ['description' => 'The configurations of the incremental file synchronization. This parameter is required only for data synchronization.', 'type' => 'string', 'title' => '', 'example' => '{"dataSourceId": "ds-123456789", "path": "/changelist"}'], 'LatestExecuteJobId' => ['description' => 'The ID of the last backup job run by the plan.', 'type' => 'string', 'title' => '', 'example' => 'job-12345678'], 'LatestFinishJobId' => ['type' => 'string', 'title' => '', 'description' => 'The ID of the last completed backup job.', 'example' => 'job-00**************9khz'], 'CreatedByTag' => ['description' => 'Specifies whether the backup plan was automatically created based on tags.', 'type' => 'boolean', 'title' => '', 'example' => 'false'], 'HitTags' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'HitTag' => [ 'description' => 'The matched tag rules.', 'type' => 'array', 'items' => [ 'description' => 'The matched tag rules.', 'type' => 'object', 'properties' => [ 'Key' => ['description' => 'The tag key.', 'type' => 'string', 'title' => '', 'example' => 'type'], 'Value' => ['description' => 'The tag value.', 'type' => 'string', 'title' => '', 'example' => '0'], 'Operator' => ['description' => 'The tag matching rule. Valid values:'."\n" ."\n" .'- **EQUAL**: Matches the tag key and tag value.'."\n" ."\n" .'- **NOT**: Matches the tag key but not the tag value.', 'type' => 'string', 'title' => '', 'example' => 'EQUAL'], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], 'BusinessStatus' => ['type' => 'string', 'description' => 'The business status.', 'title' => '', 'example' => 'ACTIVE'], ], 'description' => '', 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 8,\\n \\"BackupPlans\\": {\\n \\"BackupPlan\\": [\\n {\\n \\"VaultId\\": \\"v-*********************\\",\\n \\"BackupType\\": \\"COMPLETE\\",\\n \\"CreateTime\\": 1554347313,\\n \\"DataSourceId\\": \\"ds-000ht6o9*****w61\\",\\n \\"SourceType\\": \\"ECS_FILE\\",\\n \\"Disabled\\": false,\\n \\"Prefix\\": \\"oss-prefix\\",\\n \\"Options\\": \\"{\\\\\\"UseVSS\\\\\\":false}\\",\\n \\"ClientId\\": \\"c-000ge4w*****1qb\\",\\n \\"Exclude\\": \\"[\\\\\\"/var\\\\\\", \\\\\\"/proc\\\\\\"]\\\\t\\",\\n \\"Retention\\": 7,\\n \\"CreatedTime\\": 1554347313,\\n \\"ClusterId\\": \\"cl-000ht6o9******h\\",\\n \\"Bucket\\": \\"hbr-backup-oss\\",\\n \\"Detail\\": \\"{\\\\\\\\\\\\\\"doCopy\\\\\\\\\\\\\\":true,\\\\\\\\\\\\\\"doBackup\\\\\\\\\\\\\\":false,\\\\\\\\\\\\\\"instanceName\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"instance example\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"appConsistent\\\\\\\\\\\\\\":false,\\\\\\\\\\\\\\"destinationRegionId\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"cn-shanghai\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"enableFsFreeze\\\\\\\\\\\\\\":true,\\\\\\\\\\\\\\"osNameEn\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"Windows Server 2019 Data Center Edition 64bit Chinese Edition\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"osName\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"Windows Server 2019 Data Center Edition 64bit Chinese Edition\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"diskIdList\\\\\\\\\\\\\\":[],\\\\\\\\\\\\\\"backupVaultId\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"snapshotGroup\\\\\\\\\\\\\\":true,\\\\\\\\\\\\\\"destinationRetention\\\\\\\\\\\\\\":35,\\\\\\\\\\\\\\"platform\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"Windows Server 2012\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"timeoutInSeconds\\\\\\\\\\\\\\":60,\\\\\\\\\\\\\\"backupRetention\\\\\\\\\\\\\\":1,\\\\\\\\\\\\\\"osType\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"windows\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"preScriptPath\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"postScriptPath\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"enableWriters\\\\\\\\\\\\\\":true,\\\\\\\\\\\\\\"ecsDeleted\\\\\\\\\\\\\\":false}\\",\\n \\"Schedule\\": \\"I|1602673264|P1D\\",\\n \\"SpeedLimit\\": \\"0:24:5120\\",\\n \\"InstanceId\\": \\"i-*********************\\",\\n \\"PlanId\\": \\"plan-*********************\\",\\n \\"BackupSourceGroupId\\": \\"System-Database\\",\\n \\"FileSystemId\\": \\"00594\\",\\n \\"OtsDetail\\": {\\n \\"TableNames\\": {\\n \\"TableName\\": [\\n \\"test2_HBR_RESTORED\\"\\n ]\\n }\\n },\\n \\"InstanceName\\": \\"instancename\\",\\n \\"UpdatedTime\\": 1554347313,\\n \\"PlanName\\": \\"planname\\",\\n \\"Include\\": \\"[\\\\\\"/home/alice/*.pdf\\\\\\", \\\\\\"/home/bob/*.txt\\\\\\"]\\",\\n \\"Rules\\": {\\n \\"Rule\\": [\\n {\\n \\"DestinationRetention\\": 90,\\n \\"Schedule\\": \\"I|1631685600|P1D\\",\\n \\"Retention\\": 90,\\n \\"Disabled\\": true,\\n \\"DoCopy\\": false,\\n \\"DestinationRegionId\\": \\"cn-shanghai\\",\\n \\"RuleId\\": \\"rule-0008i52rf0ulpni6kn6m\\",\\n \\"RuleName\\": \\"Disk Golden Rule\\",\\n \\"BackupType\\": \\"COMPLETE\\"\\n }\\n ]\\n },\\n \\"Resources\\": {\\n \\"Resource\\": [\\n {\\n \\"SourceType\\": \\"UDM_DISK\\",\\n \\"ResourceId\\": \\"d-j6cgioir6m******lu4\\",\\n \\"Extra\\": \\"{\\\\\\\\\\\\\\"doBackup\\\\\\\\\\\\\\":false,\\\\\\\\\\\\\\"diskName\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"data_disk\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"size\\\\\\\\\\\\\\":100,\\\\\\\\\\\\\\"type\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"data\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"category\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"cloud_essd\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"imageId\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"device\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"/dev/xvdb\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"encrypted\\\\\\\\\\\\\\":false}\\"\\n }\\n ]\\n },\\n \\"Paths\\": {\\n \\"Path\\": [\\n \\"[\\\\\\"/home\\\\\\"]\\"\\n ]\\n },\\n \\"TrialInfo\\": {\\n \\"TrialStartTime\\": 1579413159,\\n \\"TrialVaultReleaseTime\\": 1594965600,\\n \\"TrialExpireTime\\": 1584597600,\\n \\"KeepAfterTrialExpiration\\": true\\n },\\n \\"InstanceGroupId\\": \\"i-**\\",\\n \\"CrossAccountType\\": \\"CROSS_ACCOUNT\\",\\n \\"CrossAccountUserId\\": 0,\\n \\"CrossAccountRoleName\\": \\"BackupRole\\",\\n \\"KeepLatestSnapshots\\": 0,\\n \\"DestSourceType\\": \\"OSS\\",\\n \\"DestDataSourceId\\": \\"ds-*********************\\",\\n \\"DestDataSourceDetail\\": \\"{\\\\\\\\\\\\\\"prefix\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"/\\\\\\\\\\\\\\"}\\",\\n \\"ChangeListPath\\": \\"{\\\\\\"dataSourceId\\\\\\": \\\\\\"ds-123456789\\\\\\", \\\\\\"path\\\\\\": \\\\\\"/changelist\\\\\\"}\\",\\n \\"LatestExecuteJobId\\": \\"job-12345678\\",\\n \\"LatestFinishJobId\\": \\"job-00**************9khz\\",\\n \\"CreatedByTag\\": false,\\n \\"HitTags\\": {\\n \\"HitTag\\": [\\n {\\n \\"Key\\": \\"type\\",\\n \\"Value\\": \\"0\\",\\n \\"Operator\\": \\"EQUAL\\"\\n }\\n ]\\n },\\n \\"BusinessStatus\\": \\"ACTIVE\\"\\n }\\n ]\\n }\\n}","type":"json"}]', 'title' => 'DescribeBackupPlans', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeBackupPlans'], ], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'hbr:DescribeBackupPlans', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'HBR', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], ], 'DescribeClients' => [ 'methods' => ['post', 'get'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'systemTags' => [ 'operationType' => 'get', 'abilityTreeCode' => '95507', 'abilityTreeNodes' => ['FEATUREhbrI97IXK'], ], 'parameters' => [ [ 'name' => 'VaultId', 'in' => 'query', 'schema' => ['description' => 'The ID of the backup vault.'."\n", 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'v-0001vk0z******xdyr'], ], [ 'name' => 'ClientId', 'in' => 'query', 'schema' => ['description' => 'The ID of the Cloud Backup client.'."\n", 'type' => 'string', 'required' => false, 'example' => 'c-000ed600******6b0'], ], [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => ['description' => 'The page number. Pages start from page 1. Default value: 1.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'minimum' => '1', 'example' => '1', 'default' => '1'], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => ['description' => 'The number of entries per page. Valid values: 1 to 99. Default value: 10.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100', 'minimum' => '1', 'example' => '10', 'default' => '10'], ], [ 'name' => 'ClientType', 'in' => 'query', 'schema' => ['description' => 'The type of the Cloud Backup client. Valid value: **ECS_AGENT**, which indicates an SAP HANA backup client.'."\n", 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'ECS_AGENT'], ], [ 'name' => 'SourceType', 'in' => 'query', 'schema' => ['description' => 'The type of the data source. Valid value:**HANA**, which indicates SAP HANA backup.'."\n", 'type' => 'string', 'required' => false, 'example' => 'HANA'], ], [ 'name' => 'ClusterId', 'in' => 'query', 'schema' => ['description' => 'The ID of the SAP HANA instance.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cl-0005ni1******2l87'], ], [ 'name' => 'ResourceGroupId', 'in' => 'query', 'schema' => ['description' => 'The ID of the resource group.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rg-acfmw6bxl7o5qyq'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '17189276-465D-5EF3-8FFD-0FF51B5A41A0'], 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" ."\n" .'* true'."\n" .'* false'."\n", 'type' => 'boolean', 'example' => 'true'], 'Code' => ['description' => 'The response code. The status code 200 indicates that the request was successful.'."\n", 'type' => 'string', 'example' => '200'], 'Message' => ['description' => 'The returned message. If the request was successful, "successful" is returned. If the request failed, an error message is returned.'."\n", 'type' => 'string', 'example' => 'successful'], 'PageNumber' => ['description' => 'The page number. Pages start from page 1. Default value: 1.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1'], 'PageSize' => ['description' => 'The number of entries per page. Valid values: 1 to 99. Default value: 10.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '10'], 'TotalCount' => ['description' => 'The total number of entries returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '12'], 'Clients' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'Client' => [ 'description' => 'The Cloud Backup clients.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The client information.'."\n", 'type' => 'object', 'properties' => [ 'Status' => ['description' => 'The status of the Cloud Backup client. Valid values:'."\n" ."\n" .'* **REGISTERED**: The backup client is registered.'."\n" .'* **ACTIVATED**: The backup client is activated.'."\n" .'* **DEACTIVATED**: The backup client fails to be activated.'."\n" .'* **INSTALLING**: The backup client is being installed.'."\n" .'* **INSTALL_FAILED**: The backup client fails to be installed.'."\n" .'* **NOT_INSTALLED**: The backup client is not installed.'."\n" .'* **UPGRADING**: The backup client is being upgraded.'."\n" .'* **UPGRADE_FAILED**: The backup client fails to be upgraded.'."\n" .'* **UNINSTALLING**: The backup client is being uninstalled.'."\n" .'* **UNINSTALL_FAILED**: The backup client fails to be uninstalled.'."\n" .'* **STOPPED**: The backup client is out of service.'."\n" .'* **UNKNOWN**: The backup client is disconnected.'."\n", 'type' => 'string', 'example' => 'ACTIVATED'], 'VaultId' => ['description' => 'The ID of the backup vault.'."\n", 'type' => 'string', 'example' => 'v-00029mx6o******n85lg'], 'UseHttps' => ['description' => 'Indicates whether data is transmitted over HTTPS. Valid values:'."\n" ."\n" .'* true: Data is transmitted over HTTPS.'."\n" .'* false: Data is transmitted over HTTP.'."\n", 'type' => 'boolean', 'example' => 'false'], 'NetworkType' => ['description' => 'The network type. Valid values:'."\n" ."\n" .'* **CLASSIC**: the classic network'."\n" .'* **VPC**: the virtual private cloud (VPC)'."\n", 'type' => 'string', 'example' => 'VPC'], 'ClientName' => ['description' => 'The client name.'."\n", 'type' => 'string', 'example' => 'client-20211224-101226'], 'ClientId' => ['description' => 'The ID of the Cloud Backup client.'."\n", 'type' => 'string', 'example' => 'c-00062uu******2fgj'], 'AlertSetting' => ['description' => 'The alert settings. Valid value: INHERITED, which indicates that the Cloud Backup client sends alert notifications by using the same method configured for the backup vault.'."\n", 'type' => 'string', 'example' => 'INHERITED'], 'InstanceName' => ['description' => 'The name of the ECS instance.'."\n", 'type' => 'string', 'example' => 'swh-hbr'], 'MaxVersion' => ['description' => 'The maximum version number of the Cloud Backup client.'."\n", 'type' => 'string', 'example' => '1.11.23'], 'CreatedTime' => ['description' => 'The time when the Cloud Backup client was created.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1554347313'], 'StatusMessage' => ['description' => 'The status information.'."\n", 'type' => 'string', 'example' => 'HANA_NOT_SUPPORT'], 'ClientType' => ['description' => 'The type of the Cloud Backup client. Valid value: **ECS_AGENT**, which indicates an SAP HANA backup client.'."\n", 'type' => 'string', 'example' => 'ECS_AGENT'], 'InstanceId' => ['description' => 'The instance ID.'."\n", 'type' => 'string', 'example' => 'i-wz9b6wya******n8yo'], 'UpdatedTime' => ['description' => 'The time when the Cloud Backup client was updated. This value is a UNIX timestamp. Unit: seconds.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1554347313'], 'ClientVersion' => ['description' => 'The version number of the Cloud Backup client.'."\n", 'type' => 'string', 'example' => '1.11.16'], 'ClusterId' => ['description' => 'The ID of the SAP HANA instance.'."\n", 'type' => 'string', 'example' => 'cl-0008c48frr******ncpk'], 'HeartBeatTime' => ['description' => 'The latest heartbeat time of the Cloud Backup client. This value is a UNIX timestamp. Unit: seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1554347313'], ], ], ], ], ], ], 'description' => '', ], ], ], 'title' => 'DescribeClients', 'summary' => 'Queries one or more Cloud Backup clients that meet the specified conditions.', 'description' => 'This operation is applicable only to SAP HANA backup. For Cloud Backup clients of other data sources, call the DescribeBackupClients operation.'."\n", 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeClients'], ], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'hbr:DescribeClients', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'HBR', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"17189276-465D-5EF3-8FFD-0FF51B5A41A0\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 12,\\n \\"Clients\\": {\\n \\"Client\\": [\\n {\\n \\"Status\\": \\"ACTIVATED\\",\\n \\"VaultId\\": \\"v-00029mx6o******n85lg\\",\\n \\"UseHttps\\": false,\\n \\"NetworkType\\": \\"VPC\\",\\n \\"ClientName\\": \\"client-20211224-101226\\",\\n \\"ClientId\\": \\"c-00062uu******2fgj\\",\\n \\"AlertSetting\\": \\"INHERITED\\",\\n \\"InstanceName\\": \\"swh-hbr\\",\\n \\"MaxVersion\\": \\"1.11.23\\",\\n \\"CreatedTime\\": 1554347313,\\n \\"StatusMessage\\": \\"HANA_NOT_SUPPORT\\",\\n \\"ClientType\\": \\"ECS_AGENT\\",\\n \\"InstanceId\\": \\"i-wz9b6wya******n8yo\\",\\n \\"UpdatedTime\\": 1554347313,\\n \\"ClientVersion\\": \\"1.11.16\\",\\n \\"ClusterId\\": \\"cl-0008c48frr******ncpk\\",\\n \\"HeartBeatTime\\": 1554347313\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 17189276-465D-5EF3-8FFD-0FF51B5A41A0\\n true\\n 200\\n successful\\n 1\\n 10\\n 12\\n \\n ACTIVATED\\n v-00029mx6o******n85lg\\n false\\n VPC\\n client-20211224-101226\\n c-00062uu******2fgj\\n INHERITED\\n swh-hbr\\n 1.11.23\\n 1554347313\\n HANA_NOT_SUPPORT\\n ECS_AGENT\\n i-wz9b6wya******n8yo\\n 1554347313\\n 1.11.16\\n cl-0008c48frr******ncpk\\n \\n","errorExample":""}]', ], 'DescribeContainerCluster' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => ['description' => 'The number of the page to return. Pages start from page 1. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => ['description' => 'The number of entries to return on each page. Valid values: 1 to 99. Default value: 10.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''], ], [ 'name' => 'ClusterId', 'in' => 'query', 'schema' => ['description' => 'The cluster ID.', 'type' => 'string', 'required' => false, 'example' => 'cc-000**************hg9', 'title' => ''], ], [ 'name' => 'Identifier', 'in' => 'query', 'schema' => ['description' => 'The identifier of the container cluster. For a Container Service for Kubernetes (ACK) cluster, specify the cluster ID.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'cca***************************87a'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => 'CC94B755-C3C2-5B9D-BD77-E0FE819A4DB2', 'title' => ''], 'Success' => ['description' => 'Indicates whether the call is successful. Valid values:'."\n" ."\n" .'- true: The call is successful.'."\n" ."\n" .'- false: The call fails.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'Code' => ['description' => 'The HTTP status code. The status code 200 indicates that the call is successful.', 'type' => 'string', 'example' => '200', 'title' => ''], 'Message' => ['description' => 'The message that is returned. If the call is successful, "successful" is returned. If the call fails, an error message is returned.', 'type' => 'string', 'example' => 'successful', 'title' => ''], 'PageSize' => ['description' => 'The number of entries returned on each page. Valid values: 1 to 99. Default value: 10.', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''], 'PageNumber' => ['description' => 'The page number of the returned page. Pages start from page 1. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'TotalCount' => ['description' => 'The total number of returned entries.', 'type' => 'integer', 'format' => 'int64', 'example' => '8', 'title' => ''], 'Clusters' => [ 'description' => 'The information of clusters.', 'type' => 'array', 'items' => [ 'description' => 'The information of clusters.', 'type' => 'object', 'properties' => [ 'Token' => ['description' => 'The token that is used to register the Hybrid Backup Recovery (HBR) client in the cluster.', 'type' => 'string', 'example' => 'eyJhY2Nvd******A/VnZpgXQC5A==', 'title' => ''], 'Description' => ['description' => 'The description.', 'type' => 'string', 'example' => 'description ack pv backup', 'title' => ''], 'ClusterType' => ['description' => 'The type of the cluster. Valid value: ACK, which indicates ACK clusters.', 'type' => 'string', 'example' => 'ACK', 'title' => ''], 'Identifier' => ['description' => 'The identifier of the cluster.', 'type' => 'string', 'example' => 'c5bbd0931a30947f4ab85efd19380a72d', 'title' => ''], 'NetworkType' => ['description' => 'The network type of the cluster. Valid values:'."\n" ."\n" .'- **CLASSIC**: the classic network'."\n" ."\n" .'- **VPC**: virtual private cloud (VPC)', 'type' => 'string', 'example' => 'VPC', 'title' => ''], 'Name' => ['description' => 'The cluster name.', 'type' => 'string', 'example' => 'ack_pv_backup_location', 'title' => ''], 'AgentStatus' => ['description' => 'The status of the client. Valid values:'."\n" ."\n" .'- **MISS**: The client is disconnected.'."\n" ."\n" .'- **UNKNOWN**: The client is in an unknown state.'."\n" ."\n" .'- **READY**: The client is ready.', 'type' => 'string', 'example' => 'READY', 'title' => ''], 'ClusterId' => ['description' => 'The ID of the cluster.', 'type' => 'string', 'example' => 'cl-0006gwppd0jtttpmb0ri', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'title' => 'DescribeContainerCluster', 'summary' => 'Queries one or more container clusters that meet the specified conditions.', 'description' => 'Supported only for Container Service for Kubernetes (ACK) integration.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeContainerCluster'], ], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'hbr:DescribeContainerCluster', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'HBR', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CC94B755-C3C2-5B9D-BD77-E0FE819A4DB2\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"PageSize\\": 100,\\n \\"PageNumber\\": 1,\\n \\"TotalCount\\": 8,\\n \\"Clusters\\": [\\n {\\n \\"Token\\": \\"eyJhY2Nvd******A/VnZpgXQC5A==\\",\\n \\"Description\\": \\"description ack pv backup\\",\\n \\"ClusterType\\": \\"ACK\\",\\n \\"Identifier\\": \\"c5bbd0931a30947f4ab85efd19380a72d\\",\\n \\"NetworkType\\": \\"VPC\\",\\n \\"Name\\": \\"ack_pv_backup_location\\",\\n \\"AgentStatus\\": \\"READY\\",\\n \\"ClusterId\\": \\"cl-0006gwppd0jtttpmb0ri\\"\\n }\\n ]\\n}","type":"json"}]', ], 'DescribeContainerResource' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'abilityTreeCode' => '95514', 'abilityTreeNodes' => ['FEATUREhbr4JQRTT'], ], 'parameters' => [ [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => ['description' => 'The page number for paged queries. Pages start from 1. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => ['description' => 'The number of entries per page. Minimum value: 1. Maximum value: 99. Default value: 10.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''], ], [ 'name' => 'ClusterId', 'in' => 'query', 'schema' => ['description' => 'The cluster ID.', 'type' => 'string', 'required' => false, 'example' => 'cc-0005**********hhjw', 'title' => ''], ], [ 'name' => 'ResourceType', 'in' => 'query', 'schema' => ['description' => 'The resource type. Valid value:'."\n" ."\n" .'- **PV**: persistent volume (PV).', 'type' => 'string', 'required' => false, 'example' => 'PV', 'title' => ''], ], [ 'name' => 'ResourceId', 'in' => 'query', 'schema' => ['description' => 'The resource ID.'."\n" ."\n" .'- **ResourceType=PV**: The persistent volume ID.', 'type' => 'string', 'required' => false, 'example' => 'a9ab843d-****-****-8e46-1d67a82128a7', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'D98A2895-745B-5530-A8C1-9A86F0A82354', 'title' => ''], 'Success' => ['description' => 'Indicates whether the request succeeded.'."\n" ."\n" .'- true: succeeded'."\n" ."\n" .'- false: failed', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'Code' => ['description' => 'The return code. A value of 200 indicates success.', 'type' => 'string', 'example' => '200', 'title' => ''], 'Message' => ['description' => 'The response message. Returns "successful" on success or an error message on failure.', 'type' => 'string', 'example' => 'successful', 'title' => ''], 'PageSize' => ['description' => 'The number of entries per page in a paged query.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], 'PageNumber' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'TotalCount' => ['description' => 'The total number of records.', 'type' => 'integer', 'format' => 'int64', 'example' => '8', 'title' => ''], 'Resources' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'ResourceInfo' => ['description' => 'Resource details.', 'type' => 'string', 'example' => '{"pv_name":"nas-a9ab843d-****-****-8e46-1d67a82128a7","pv_size":"1000Gi","storage_class":"opk8s-nas","pvc_name":"**-pvc","namespace":"default"}', 'title' => ''], 'ClusterIdentifier' => ['description' => 'The cluster identifier.', 'type' => 'string', 'example' => 'c21b653f********695e892e718c419a4', 'title' => ''], 'ResourceType' => ['description' => 'The resource type.', 'type' => 'string', 'example' => 'PV', 'title' => ''], 'ResourceId' => ['description' => 'The resource ID.', 'type' => 'string', 'example' => 'a9ab843d-****-****-8e46-1d67a82128a7'."\n", 'title' => ''], 'ClusterId' => ['description' => 'The cluster ID.', 'type' => 'string', 'example' => 'cc-0005**********hhjw', 'title' => ''], ], 'description' => 'The list of resources.', 'title' => '', 'example' => '', ], 'description' => 'The list of resources.', 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'title' => 'DescribeContainerResource', 'summary' => 'Queries the list of container cluster resources.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D98A2895-745B-5530-A8C1-9A86F0A82354\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"PageSize\\": 10,\\n \\"PageNumber\\": 1,\\n \\"TotalCount\\": 8,\\n \\"Resources\\": [\\n {\\n \\"ResourceInfo\\": \\"{\\\\\\"pv_name\\\\\\":\\\\\\"nas-a9ab843d-****-****-8e46-1d67a82128a7\\\\\\",\\\\\\"pv_size\\\\\\":\\\\\\"1000Gi\\\\\\",\\\\\\"storage_class\\\\\\":\\\\\\"opk8s-nas\\\\\\",\\\\\\"pvc_name\\\\\\":\\\\\\"**-pvc\\\\\\",\\\\\\"namespace\\\\\\":\\\\\\"default\\\\\\"}\\",\\n \\"ClusterIdentifier\\": \\"c21b653f********695e892e718c419a4\\",\\n \\"ResourceType\\": \\"PV\\",\\n \\"ResourceId\\": \\"a9ab843d-****-****-8e46-1d67a82128a7\\\\n\\",\\n \\"ClusterId\\": \\"cc-0005**********hhjw\\"\\n }\\n ]\\n}","type":"json"}]', ], 'DescribeCrossAccounts' => [ 'summary' => 'Queries cross-account management relationships.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '137629', 'abilityTreeNodes' => ['FEATUREhbr3BJQCT', 'FEATUREhbrB08D1M'], 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => ['description' => 'The page number for paging. Pages start from 1. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'minimum' => '1', 'default' => '1', 'example' => '1', 'title' => ''], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => ['description' => 'The number of entries per page. Minimum value: 1. Maximum value: 99. Default value: 10.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100', 'minimum' => '1', 'default' => '10', 'example' => '10', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E', 'title' => ''], 'Success' => ['description' => 'Indicates whether the request succeeded.'."\n" ."\n" .'- true: succeeded'."\n" ."\n" .'- false: failed', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'Code' => ['description' => 'The return code. A value of 200 indicates success.', 'type' => 'string', 'example' => '200', 'title' => ''], 'Message' => ['description' => 'A description of the response. Successful requests return "successful". Failed requests return an error message.', 'type' => 'string', 'example' => 'successful', 'title' => ''], 'PageNumber' => ['description' => 'The page number for paging. Pages start from 1. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'PageSize' => ['description' => 'The number of entries per page. Minimum value: 1. Maximum value: 99. Default value: 10.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], 'TotalCount' => ['description' => 'The total number of records.', 'type' => 'integer', 'format' => 'int64', 'example' => '22', 'title' => ''], 'CrossAccounts' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'CrossAccount' => [ 'description' => 'The list of cross-account information.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'OwnerId' => ['description' => 'The account ID of the current account.', 'type' => 'integer', 'format' => 'int64', 'example' => '184164xxxxx49795', 'title' => ''], 'CrossAccountUserId' => ['description' => 'The original account ID of the cross-account backup managed by the current account.', 'type' => 'integer', 'format' => 'int64', 'example' => '15897534xxxxx625', 'title' => ''], 'CrossAccountRoleName' => ['description' => 'The name of the RAM role created in the original account for cross-account backup managed by the current account.', 'type' => 'string', 'example' => 'BackupRole', 'title' => ''], 'Alias' => ['description' => 'The alias. It can be up to 32 characters long.', 'type' => 'string', 'example' => 'content', 'title' => ''], 'Id' => ['description' => 'The type ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], 'CreatedTime' => ['description' => 'The creation time. This is a UNIX timestamp in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1654570439', 'title' => ''], 'UpdatedTime' => ['description' => 'The update time. This is a UNIX timestamp in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1640157098', 'title' => ''], 'CrossAccountType' => ['description' => 'The cross-account type.', 'type' => 'string', 'example' => 'CROSS_ACCOUNT', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 22,\\n \\"CrossAccounts\\": {\\n \\"CrossAccount\\": [\\n {\\n \\"OwnerId\\": 0,\\n \\"CrossAccountUserId\\": 0,\\n \\"CrossAccountRoleName\\": \\"BackupRole\\",\\n \\"Alias\\": \\"content\\",\\n \\"Id\\": 1,\\n \\"CreatedTime\\": 1654570439,\\n \\"UpdatedTime\\": 1640157098,\\n \\"CrossAccountType\\": \\"CROSS_ACCOUNT\\"\\n }\\n ]\\n }\\n}","type":"json"}]', 'title' => 'DescribeCrossAccounts', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeCrossAccounts'], ], ], 'ramActions' => [ [ 'operationType' => 'list', 'ramAction' => [ 'action' => 'hbr:DescribeCrossAccounts', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'HBR', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], ], 'DescribeDataSources' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'abilityTreeCode' => '95515', 'abilityTreeNodes' => ['FEATUREhbrF83GXN'], ], 'parameters' => [ [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => ['description' => 'The page number. Pages start from page 1. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'minimum' => '1', 'default' => '1', 'example' => '1', 'title' => ''], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => ['description' => 'The number of data sources to return on each page.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100', 'minimum' => '1', 'default' => '10', 'example' => '10', 'title' => ''], ], [ 'name' => 'DataSourceType', 'in' => 'query', 'schema' => ['description' => 'The data source type.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'COMMON_NAS', 'title' => ''], ], [ 'name' => 'ClusterId', 'in' => 'query', 'schema' => ['description' => 'The client group ID used to access the data source.', 'type' => 'string', 'required' => false, 'example' => 'cl-0003jyv******fsku5m', 'title' => ''], ], [ 'name' => 'DataSourceId', 'in' => 'query', 'schema' => ['description' => 'The data source ID.', 'type' => 'string', 'required' => false, 'example' => 'ds-000******2nqeo', 'title' => ''], ], [ 'name' => 'DataSourceName', 'in' => 'query', 'schema' => ['description' => 'The data source name.', 'type' => 'string', 'required' => false, 'example' => 'MyLocalNas', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '36A5CD24-****-****-****-5F30C3F1753F', 'title' => ''], 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" ."\n" .'- true: The request was successful.'."\n" ."\n" .'- false: The request failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'Code' => ['description' => 'The HTTP status code. A value of 200 indicates success.', 'type' => 'string', 'example' => '200', 'title' => ''], 'Message' => ['description' => 'The response message. The value is "successful" if the request was successful, or an error message if the request failed.', 'type' => 'string', 'example' => 'successful', 'title' => ''], 'PageNumber' => ['description' => 'The page number. Pages start from page 1. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'PageSize' => ['description' => 'The page size. Valid values: 1 to 99. Default value: 10.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], 'TotalCount' => ['description' => 'The total number of returned data sources.', 'type' => 'integer', 'format' => 'int64', 'example' => '20', 'title' => ''], 'DataSources' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'IndexLevel' => ['description' => 'The index level. Valid values:'."\n" ."\n" .'- OFF: No index is created.'."\n" ."\n" .'- META: A metadata index is created.'."\n" ."\n" .'- ALL: A full-text index is created. This value is deprecated.', 'type' => 'string', 'example' => 'META', 'title' => ''], 'Schedule' => ['description' => 'The analysis schedule. Archiving feature only. Format: `I|{startTime}|{interval}`. `{startTime}` is the start time as a UNIX timestamp in seconds. `{interval}` is the execution interval in ISO 8601 format. Example: PT1H for one hour, P1D for one day.', 'type' => 'string', 'example' => 'I|1729493847|P1D ', 'title' => ''], 'DataSourceName' => ['description' => 'The data source name.', 'type' => 'string', 'example' => 'COMMON_NAS', 'title' => ''], 'DataSourceId' => ['description' => 'The data source ID.', 'type' => 'string', 'example' => 'ds-000******2nqeo', 'title' => ''], 'Options' => ['description' => 'The analysis options. Archiving feature only.', 'type' => 'string', 'example' => '{}', 'title' => ''], 'SpeedLimit' => ['description' => 'The rate limit configuration. Archiving feature only.', 'type' => 'string', 'example' => '6:21:10240', 'title' => ''], 'PlanId' => ['description' => 'The analysis plan ID. Archiving feature only.', 'type' => 'string', 'example' => 'plan-123***7890', 'title' => ''], 'IndexUpdateTime' => ['description' => 'The time when the index was last updated. UNIX timestamp in seconds. Archiving feature only.', 'type' => 'boolean', 'example' => '1745454604', 'title' => ''], 'Exclude' => ['description' => 'The paths excluded from analysis. Archiving feature only.', 'type' => 'string', 'example' => '['."\n" .' "/home/alice/log"'."\n" .']', 'title' => ''], 'Indexing' => ['description' => 'Whether an index is being built. Archiving feature only.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], 'UpdatedTime' => ['description' => 'The time when the data source was last updated. UNIX timestamp in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1745454604', 'title' => ''], 'DataSourceType' => ['description' => 'The data source type.', 'type' => 'string', 'example' => 'COMMON_NAS', 'title' => ''], 'ConnectionInfo' => ['description' => 'The connection information of the data source, which describes how to access the data source.', 'type' => 'string', 'example' => '{'."\n" .' "dataServerAddresses": ['."\n" .' {'."\n" .' "host": "123.123.123.123",'."\n" .' "port": "8080"'."\n" .' }'."\n" .' ],'."\n" .' "sharePath": "/share",'."\n" .' "mountOptions": "vers=3",'."\n" .' "fileSystemType": "nfs"'."\n" .'}', 'title' => ''], 'IndexAvailable' => ['description' => 'Whether the index is available. Archiving feature only.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'CreatedTime' => ['description' => 'The time when the data source was created. UNIX timestamp in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1770257653', 'title' => ''], 'Include' => ['description' => 'The paths included in the analysis. Archiving feature only.', 'type' => 'string', 'example' => '['."\n" .' "/home/alice",'."\n" .' "/home/bob"'."\n" .']', 'title' => ''], 'ClusterId' => ['description' => 'The client group ID used to access the data source.', 'type' => 'string', 'example' => 'cl-0003jyv******fsku5m', 'title' => ''], 'Paths' => [ 'type' => 'array', 'items' => ['description' => 'An analysis path. Archiving feature only.', 'type' => 'string', 'example' => '/home', 'title' => ''], 'description' => 'The analysis paths. Archiving feature only.', 'title' => '', 'example' => '', ], ], 'description' => 'The details of a data source.', 'title' => '', 'example' => '', ], 'description' => 'The data sources.', 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'title' => 'DescribeDataSources', 'summary' => 'Queries a list of data sources. Filter results by data source type, data source ID, data source name, or client group ID.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"36A5CD24-****-****-****-5F30C3F1753F\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 20,\\n \\"DataSources\\": [\\n {\\n \\"IndexLevel\\": \\"META\\",\\n \\"Schedule\\": \\"I|1729493847|P1D\\\\t\\",\\n \\"DataSourceName\\": \\"COMMON_NAS\\",\\n \\"DataSourceId\\": \\"ds-000******2nqeo\\",\\n \\"Options\\": \\"{}\\",\\n \\"SpeedLimit\\": \\"6:21:10240\\",\\n \\"PlanId\\": \\"plan-123***7890\\",\\n \\"IndexUpdateTime\\": true,\\n \\"Exclude\\": \\"[\\\\n \\\\\\"/home/alice/log\\\\\\"\\\\n]\\",\\n \\"Indexing\\": false,\\n \\"UpdatedTime\\": 1745454604,\\n \\"DataSourceType\\": \\"COMMON_NAS\\",\\n \\"ConnectionInfo\\": \\"{\\\\n \\\\\\"dataServerAddresses\\\\\\": [\\\\n {\\\\n \\\\\\"host\\\\\\": \\\\\\"123.123.123.123\\\\\\",\\\\n \\\\\\"port\\\\\\": \\\\\\"8080\\\\\\"\\\\n }\\\\n ],\\\\n \\\\\\"sharePath\\\\\\": \\\\\\"/share\\\\\\",\\\\n \\\\\\"mountOptions\\\\\\": \\\\\\"vers=3\\\\\\",\\\\n \\\\\\"fileSystemType\\\\\\": \\\\\\"nfs\\\\\\"\\\\n}\\",\\n \\"IndexAvailable\\": true,\\n \\"CreatedTime\\": 1770257653,\\n \\"Include\\": \\"[\\\\n \\\\\\"/home/alice\\\\\\",\\\\n \\\\\\"/home/bob\\\\\\"\\\\n]\\",\\n \\"ClusterId\\": \\"cl-0003jyv******fsku5m\\",\\n \\"Paths\\": [\\n \\"/home\\"\\n ]\\n }\\n ]\\n}","type":"json"}]', ], 'DescribeHanaBackupPlans' => [ 'summary' => 'Queries for one or more SAP HANA backup plans that match specified criteria.', 'methods' => ['post', 'get'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '95518', 'abilityTreeNodes' => ['FEATUREhbrI97IXK'], ], 'parameters' => [ [ 'name' => 'VaultId', 'in' => 'query', 'schema' => ['description' => 'The ID of the backup vault.', 'type' => 'string', 'required' => false, 'example' => 'v-000i4lg4kz******ahl', 'title' => ''], ], [ 'name' => 'ClusterId', 'in' => 'query', 'schema' => ['description' => 'The ID of the SAP HANA instance.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cl-000chxz******lz7bk', 'title' => ''], ], [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => ['description' => 'The page number. The value must be a number that starts from 1. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'minimum' => '1', 'default' => '1', 'example' => '1', 'title' => ''], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => ['description' => 'The number of entries per page. Valid values: 1 to 99. Default value: 10.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100', 'minimum' => '1', 'default' => '10', 'example' => '10', 'title' => ''], ], [ 'name' => 'DatabaseName', 'in' => 'query', 'schema' => ['description' => 'The name of the database.', 'type' => 'string', 'required' => false, 'example' => 'SYSTEMDB', 'title' => ''], ], [ 'name' => 'ResourceGroupId', 'in' => 'query', 'schema' => ['description' => 'The ID of the resource group.', 'type' => 'string', 'required' => false, 'example' => 'rg-acfmvywqfey5njq', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'F029C1C7-26B6-5ADD-A73E-D85CCD7C73A9', 'title' => ''], 'Success' => ['description' => 'Indicates whether the request was successful.'."\n" ."\n" .'- true: The request was successful.'."\n" ."\n" .'- false: The request failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'Code' => ['description' => 'The return code. A value of 200 indicates that the request was successful.', 'type' => 'string', 'example' => '200', 'title' => ''], 'Message' => ['description' => 'The message that is returned. If the request was successful, "successful" is returned. If the request failed, an error message is returned.', 'type' => 'string', 'example' => 'successful', 'title' => ''], 'PageNumber' => ['description' => 'The page number. The value must be a number that starts from 1. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'PageSize' => ['description' => 'The number of entries per page. Valid values: 1 to 99. Default value: 10.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], 'TotalCount' => ['description' => 'The total number of records.', 'type' => 'integer', 'format' => 'int64', 'example' => '6', 'title' => ''], 'HanaBackupPlans' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'HanaBackupPlan' => [ 'description' => 'The details of the backup plan.', 'type' => 'array', 'items' => [ 'description' => 'The details of the backup plan.', 'type' => 'object', 'properties' => [ 'VaultId' => ['description' => 'The ID of the backup vault.', 'type' => 'string', 'example' => 'v-000csihw82pqkd7hcjws', 'title' => ''], 'BackupPrefix' => ['description' => 'The backup prefix.', 'type' => 'string', 'example' => 'COMPLETE_DATA_BACKUP', 'title' => ''], 'Schedule' => ['description' => 'The backup policy. Format: `I|{startTime}|{interval}`. The system runs the first backup job at a point in time that is specified by `{startTime}` and repeats the backup job at an interval that is specified by `{interval}`. The system does not run a backup job to compensate for a missed backup job. If a backup job is not complete, the next backup job is not triggered. For example, `I|1631685600|P1D` indicates that the system runs a backup job every day, starting from 2021-09-15 14:00:00.'."\n" ."\n" .'- startTime: The start time of the backup job. This value is a UNIX timestamp. Unit: seconds.'."\n" ."\n" .'- interval: The interval of the backup job. This value follows the ISO 8601 standard. For example, PT1H indicates that the backup job is run every hour. P1D indicates that the backup job is run every day.', 'type' => 'string', 'example' => 'I|1602673264|P1D', 'title' => ''], 'DatabaseName' => ['description' => 'The name of the database.', 'type' => 'string', 'example' => 'SYSTEMDB', 'title' => ''], 'BackupType' => ['description' => 'The backup type.'."\n" ."\n" .'- COMPLETE: full backup.'."\n" ."\n" .'- INCREMENTAL: incremental backup.'."\n" ."\n" .'- DIFFERENTIAL: differential backup.', 'type' => 'string', 'example' => 'COMPLETE', 'title' => ''], 'Disabled' => ['description' => 'Indicates whether the backup plan is paused.'."\n" ."\n" .'- true: The backup plan is paused.'."\n" ."\n" .'- false: The backup plan is not paused.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], 'PlanId' => ['description' => 'The ID of the backup plan.', 'type' => 'string', 'example' => 'pl-0000tnyndg3ne5m4ubeu', 'title' => ''], 'ClusterId' => ['description' => 'The ID of the SAP HANA instance.', 'type' => 'string', 'example' => 'cl-0002scknka*****', 'title' => ''], 'PlanName' => ['description' => 'The name of the backup plan.', 'type' => 'string', 'example' => 'plan-20220118-141153', 'title' => ''], 'BusinessStatus' => ['description' => 'The business status.', 'type' => 'string', 'title' => '', 'example' => 'ACTIVE'], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F029C1C7-26B6-5ADD-A73E-D85CCD7C73A9\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 6,\\n \\"HanaBackupPlans\\": {\\n \\"HanaBackupPlan\\": [\\n {\\n \\"VaultId\\": \\"v-000csihw82pqkd7hcjws\\",\\n \\"BackupPrefix\\": \\"COMPLETE_DATA_BACKUP\\",\\n \\"Schedule\\": \\"I|1602673264|P1D\\",\\n \\"DatabaseName\\": \\"SYSTEMDB\\",\\n \\"BackupType\\": \\"COMPLETE\\",\\n \\"Disabled\\": false,\\n \\"PlanId\\": \\"pl-0000tnyndg3ne5m4ubeu\\",\\n \\"ClusterId\\": \\"cl-0002scknka*****\\",\\n \\"PlanName\\": \\"plan-20220118-141153\\",\\n \\"BusinessStatus\\": \\"ACTIVE\\"\\n }\\n ]\\n }\\n}","type":"json"}]', 'title' => 'DescribeHanaBackupPlans', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeHanaBackupPlans'], ], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'hbr:DescribeHanaBackupPlans', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'HBR', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], ], 'DescribeHanaBackupSetting' => [ 'methods' => ['post', 'get'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'VaultId', 'in' => 'query', 'schema' => ['description' => 'The ID of the backup vault.'."\n", 'type' => 'string', 'required' => false, 'example' => 'v-000css******za5uyqr'], ], [ 'name' => 'ClusterId', 'in' => 'query', 'schema' => ['description' => 'The ID of the SAP HANA instance.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cl-00068btz******oku'], ], [ 'name' => 'DatabaseName', 'in' => 'query', 'schema' => ['description' => 'The name of the database.'."\n", 'type' => 'string', 'required' => false, 'example' => 'SYSTEMDB'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Code' => ['description' => 'The HTTP status code. The status code 200 indicates that the call is successful.'."\n", 'type' => 'string', 'example' => '200'], 'Message' => ['description' => 'The message that is returned. If the call is successful, "successful" is returned. If the call fails, an error message is returned.'."\n", 'type' => 'string', 'example' => 'successful'], 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '9D0DB5BC-5071-5ADF-BCD1-14EBB0C17C54'], 'Success' => ['description' => 'Indicates whether the call is successful. Valid values:'."\n" ."\n" .'* true: The call is successful.'."\n" .'* false: The call fails.'."\n", 'type' => 'boolean', 'example' => 'true'], 'HanaBackupSetting' => [ 'description' => 'The backup settings.'."\n", 'type' => 'object', 'properties' => [ 'DatabaseName' => ['description' => 'The name of the database.'."\n", 'type' => 'string', 'example' => 'SYSTEMDB'], 'LogBackupUsingBackint' => ['description' => 'Indicates whether Backint is used to back up logs. Valid values:'."\n" ."\n" .'* true: Backint is used to back up logs.'."\n" .'* false: Backint is not used to back up logs.'."\n", 'type' => 'boolean', 'example' => 'true'], 'CatalogBackupParameterFile' => ['description' => 'The configuration file for catalog backup.'."\n", 'type' => 'string', 'example' => '/usr/sap/SID/SYS/global/hdb/opt/hdbconfig/param'], 'CatalogBackupUsingBackint' => ['description' => 'Indicates whether Backint is used to back up catalogs. Valid values:'."\n" ."\n" .'* true: Backint is used to back up catalogs.'."\n" .'* false: Backint is not used to back up catalogs.'."\n", 'type' => 'boolean', 'example' => 'false'], 'DataBackupParameterFile' => ['description' => 'The configuration file for data backup.'."\n", 'type' => 'string', 'example' => '/usr/sap/SID/SYS/global/hdb/opt/hdbconfig/param'], 'LogBackupTimeout' => ['description' => 'The interval at which logs are backed up. Unit: seconds.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '900'], 'EnableAutoLogBackup' => ['description' => 'Indicates whether automatic log backup is enabled. Valid values:'."\n" ."\n" .'* **true**: Automatic log backup is enabled.'."\n" .'* **false**: Automatic log backup is disabled.'."\n", 'type' => 'boolean', 'example' => 'true'], 'LogBackupParameterFile' => ['description' => 'The configuration file for log backup.'."\n", 'type' => 'string', 'example' => '/usr/sap/SID/SYS/global/hdb/opt/hdbconfig/param'], ], ], ], ], ], ], 'title' => 'DescribeHanaBackupSetting', 'summary' => 'Queries the backup parameters of an SAP HANA database.', 'description' => 'If you want to query the backup retention period of a database, you can call the DescribeHanaRetentionSetting operation.'."\n", 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeHanaBackupSetting'], ], ], 'ramActions' => [], 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"9D0DB5BC-5071-5ADF-BCD1-14EBB0C17C54\\",\\n \\"Success\\": true,\\n \\"HanaBackupSetting\\": {\\n \\"DatabaseName\\": \\"SYSTEMDB\\",\\n \\"LogBackupUsingBackint\\": true,\\n \\"CatalogBackupParameterFile\\": \\"/usr/sap/SID/SYS/global/hdb/opt/hdbconfig/param\\",\\n \\"CatalogBackupUsingBackint\\": false,\\n \\"DataBackupParameterFile\\": \\"/usr/sap/SID/SYS/global/hdb/opt/hdbconfig/param\\",\\n \\"LogBackupTimeout\\": 900,\\n \\"EnableAutoLogBackup\\": true,\\n \\"LogBackupParameterFile\\": \\"/usr/sap/SID/SYS/global/hdb/opt/hdbconfig/param\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 200\\n successful\\n 9D0DB5BC-5071-5ADF-BCD1-14EBB0C17C54\\n true\\n \\n SYSTEMDB\\n true\\n /usr/sap/SID/SYS/global/hdb/opt/hdbconfig/param\\n false\\n /usr/sap/SID/SYS/global/hdb/opt/hdbconfig/param\\n 900\\n true\\n /usr/sap/SID/SYS/global/hdb/opt/hdbconfig/param\\n \\n","errorExample":""}]', ], 'DescribeHanaBackupsAsync' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'VaultId', 'in' => 'query', 'schema' => ['description' => 'The ID of the backup vault.'."\n", 'type' => 'string', 'required' => false, 'example' => 'v-000270c******pi81'], ], [ 'name' => 'ClusterId', 'in' => 'query', 'schema' => ['description' => 'The ID of the SAP HANA instance.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cl-00098******yuqvu'], ], [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => ['description' => 'The page number. Pages start from page 1. Default value: 1.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'minimum' => '1', 'example' => '1', 'default' => '1'], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => ['description' => 'The number of entries per page. Valid values: 1 to 99. Default value: 10.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100', 'minimum' => '1', 'example' => '10', 'default' => '1'], ], [ 'name' => 'DatabaseName', 'in' => 'query', 'schema' => ['description' => 'The database name.'."\n", 'type' => 'string', 'required' => false, 'example' => 'BPD'], ], [ 'name' => 'Mode', 'in' => 'query', 'schema' => ['description' => 'The recovery mode. Valid values:'."\n" ."\n" .'* **RECOVERY_TO_MOST_RECENT**: restores the database to the recently available state to which the database has been backed up.'."\n" .'* **RECOVERY_TO_POINT_IN_TIME**: restores the database to a specified point in time.'."\n" .'* **RECOVERY_TO_SPECIFIC_BACKUP**: restores the database to a specified backup.'."\n" .'* **RECOVERY_TO_LOG_POSITION**: restores the database to a specified log position.'."\n", 'type' => 'string', 'required' => false, 'example' => 'RECOVERY_TO_SPECIFIC_BACKUP', 'default' => 'RECOVERY_TO_MOST_RECENT'], ], [ 'name' => 'RecoveryPointInTime', 'in' => 'query', 'schema' => ['description' => 'The point in time to which you want to restore the database. This parameter is valid only if you set the Mode parameter to **RECOVERY_TO_POINT_IN_TIME**. Cloud Backup restores the database to a state closest to the specified point in time.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1649851200'], ], [ 'name' => 'LogPosition', 'in' => 'query', 'schema' => ['description' => 'The log position to which you want to restore the database. This parameter is valid only if you set the Mode parameter to **RECOVERY_TO_LOG_POSITION**.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '0'], ], [ 'name' => 'VolumeId', 'in' => 'query', 'schema' => ['description' => 'The ID of the volume that you want to restore. This parameter is valid only if you set the Mode parameter to **RECOVERY_TO_LOG_POSITION**.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0'], ], [ 'name' => 'SystemCopy', 'in' => 'query', 'schema' => ['description' => 'Specifies whether to restore the database to a different instance.'."\n" ."\n" .'* true: restores the database to a different instance.'."\n" .'* false: restores the database within the same instance.'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'true'], ], [ 'name' => 'Source', 'in' => 'query', 'schema' => ['description' => 'The name of the source system. This parameter specifies the name of the source database that you want to restore. You must set the parameter in the `@SID` format.'."\n", 'type' => 'string', 'required' => false, 'example' => 'P01@HP1'], ], [ 'name' => 'SourceClusterId', 'in' => 'query', 'schema' => ['description' => 'The ID of the source SAP HANA instance.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cl-0000g3m******5cj'], ], [ 'name' => 'IncludeDifferential', 'in' => 'query', 'schema' => ['description' => 'Specifies whether to include differential backups in the query results. Valid values:'."\n" ."\n" .'* true: includes differential backups.'."\n" .'* false: excludes differential backups.'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'false', 'default' => 'false'], ], [ 'name' => 'IncludeIncremental', 'in' => 'query', 'schema' => ['description' => 'Specifies whether to include incremental backups in the query results. Valid values:'."\n" ."\n" .'* true: includes incremental backups.'."\n" .'* false: excludes incremental backups.'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'true', 'default' => 'false'], ], [ 'name' => 'IncludeLog', 'in' => 'query', 'schema' => ['description' => 'Specifies whether to include log backups in the query results. Valid values:'."\n" ."\n" .'* true: includes log backups.'."\n" .'* false: excludes log backups.'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'true', 'default' => 'false'], ], [ 'name' => 'UseBackint', 'in' => 'query', 'schema' => ['description' => 'Specifies whether Backint is used. Valid values:'."\n" ."\n" .'* true: Backint is used.'."\n" .'* false: Backint is not used.'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'false', 'default' => 'false'], ], [ 'name' => 'ResourceGroupId', 'in' => 'query', 'schema' => ['description' => 'The ID of the resource group.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rg-acfmz7mced2ldhy'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Code' => ['description' => 'The response code. The status code 200 indicates that the request was successful.'."\n", 'type' => 'string', 'example' => '200'], 'Message' => ['description' => 'The returned message. If the request was successful, "successful" is returned. If the request failed, an error message is returned.'."\n", 'type' => 'string', 'example' => 'successful'], 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '31F97233-8563-563D-8880-914B00EEA928'], 'TaskId' => ['description' => 'The ID of the asynchronous job. You can call the DescribeTask operation to query the execution result of an asynchronous job.'."\n", 'type' => 'string', 'example' => 't-0006xmbplrqebt9dhkth'], 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" ."\n" .'* true'."\n" .'* false'."\n", 'type' => 'boolean', 'example' => 'true'], ], 'description' => '', ], ], ], 'title' => 'DescribeHanaBackupsAsync', 'summary' => 'Queries one or more SAP HANA backups that meet the specified conditions.', 'description' => 'After you call the DescribeHanaBackupsAsync operation to query the SAP HANA backups that meet the specified conditions, call the DescribeTask operation to query the final result.'."\n", 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeHanaBackupsAsync'], ], ], 'ramActions' => [], 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"31F97233-8563-563D-8880-914B00EEA928\\",\\n \\"TaskId\\": \\"t-0006xmbplrqebt9dhkth\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n 200\\n successful\\n 31F97233-8563-563D-8880-914B00EEA928\\n t-0006xmbplrqebt9dhkth\\n true\\n","errorExample":""}]', ], 'DescribeHanaDatabases' => [ 'methods' => ['post', 'get'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'VaultId', 'in' => 'query', 'schema' => ['description' => 'The ID of the backup vault.'."\n", 'type' => 'string', 'required' => false, 'example' => 'v-00063fq******8xjr'], ], [ 'name' => 'ClusterId', 'in' => 'query', 'schema' => ['description' => 'The ID of the SAP HANA instance.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cl-000hpc******uv14x'], ], [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => ['description' => 'The page number. Pages start from page 1. Default value: 1.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'minimum' => '1', 'example' => '1', 'default' => '1'], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => ['description' => 'The number of entries per page. Valid values: 1 to 99. Default value: 10.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100', 'minimum' => '1', 'example' => '10', 'default' => '10'], ], [ 'name' => 'ResourceGroupId', 'in' => 'query', 'schema' => ['description' => 'The ID of the resource group.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rg-acfmw2azsegupmi'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'DAAB6A29-34EB-5F56-962F-D5BDBFE8A5C2'], 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" ."\n" .'* true'."\n" .'* false'."\n", 'type' => 'boolean', 'example' => 'true'], 'Code' => ['description' => 'The response code. The status code 200 indicates that the request was successful.'."\n", 'type' => 'string', 'example' => '200'], 'Message' => ['description' => 'The returned message. If the request was successful, "successful" is returned. If the request failed, an error message is returned.'."\n", 'type' => 'string', 'example' => 'successful'], 'PageNumber' => ['description' => 'The page number. Pages start from page 1. Default value: 1.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1'], 'PageSize' => ['description' => 'The number of entries per page. Valid values: 1 to 99. Default value: 10.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '10'], 'TotalCount' => ['description' => 'The total number of entries returned.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '10'], 'HanaDatabases' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'HanaDatabase' => [ 'description' => 'The information about SAP HANA databases.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The information about SAP HANA databases.', 'type' => 'object', 'properties' => [ 'Host' => ['description' => 'The hostname.'."\n", 'type' => 'string', 'example' => 'izbp1jbf3zy******antqmz'], 'SqlPort' => ['description' => 'The port number.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '30013'], 'DatabaseName' => ['description' => 'The database name.'."\n", 'type' => 'string', 'example' => 'SYSTEMDB'], 'ServiceName' => ['description' => 'The service name.'."\n", 'type' => 'string', 'example' => 'indexserver'], 'ActiveStatus' => ['description' => 'Indicates whether the database is started. Valid values:'."\n" ."\n" .'* **YES**: The database is started.'."\n" .'* **NO**: The database is not started.'."\n", 'type' => 'string', 'example' => 'YES'], 'Detail' => ['description' => 'The detailed information.'."\n", 'type' => 'string', 'example' => 'master'], ], ], ], ], ], ], 'description' => '', ], ], ], 'title' => 'DescribeHanaDatabases', 'summary' => 'Queries the information about SAP HANA databases.', 'description' => 'After you register an SAP HANA instance and install a Cloud Backup client on the instance, you can call this operation to query the information about SAP HANA databases. You can call the StartHanaDatabaseAsync operation to start a database and call the StopHanaDatabaseAsync operation to stop a database.'."\n", 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeHanaDatabases'], ], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'hbr:DescribeHanaDatabases', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'HBR', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"DAAB6A29-34EB-5F56-962F-D5BDBFE8A5C2\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 10,\\n \\"HanaDatabases\\": {\\n \\"HanaDatabase\\": [\\n {\\n \\"Host\\": \\"izbp1jbf3zy******antqmz\\",\\n \\"SqlPort\\": 30013,\\n \\"DatabaseName\\": \\"SYSTEMDB\\",\\n \\"ServiceName\\": \\"indexserver\\",\\n \\"ActiveStatus\\": \\"YES\\",\\n \\"Detail\\": \\"master\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n DAAB6A29-34EB-5F56-962F-D5BDBFE8A5C2\\n true\\n 200\\n successful\\n 1\\n 10\\n 10\\n \\n izbp1jbf3zy******antqmz\\n 30013\\n SYSTEMDB\\n indexserver\\n YES\\n master\\n \\n","errorExample":""}]', ], 'DescribeHanaInstances' => [ 'methods' => ['post', 'get'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'systemTags' => [ 'operationType' => 'get', 'abilityTreeCode' => '95523', 'abilityTreeNodes' => ['FEATUREhbrI97IXK'], ], 'parameters' => [ [ 'name' => 'VaultId', 'in' => 'query', 'schema' => ['description' => 'The ID of the backup vault.'."\n", 'type' => 'string', 'required' => false, 'example' => 'v-000b0ov******6zs'], ], [ 'name' => 'ClusterId', 'in' => 'query', 'schema' => ['description' => 'The ID of the SAP HANA instance.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cl-0001zfc******50pr3'], ], [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => ['description' => 'The page number. Pages start from page 1. Default value: 1.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'minimum' => '1', 'example' => '1', 'default' => '1'], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => ['description' => 'The number of entries per page. Valid values: 1 to 99. Default value: 10.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100', 'minimum' => '1', 'example' => '10', 'default' => '10'], ], [ 'name' => 'Tag', 'in' => 'formData', 'style' => 'repeatList', 'schema' => [ 'description' => 'The tags of the SAP HANA instance.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The tags of SAP HANA instance.', 'type' => 'object', 'properties' => [ 'Key' => ['description' => 'The tag key.'."\n", 'type' => 'string', 'required' => false, 'example' => 'ace:rm:rgld'], 'Value' => ['description' => 'The tag value.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rg-acfmwutpyat2kwy'], ], 'required' => false, ], 'required' => false, 'maxItems' => 21, ], ], [ 'name' => 'ResourceGroupId', 'in' => 'query', 'schema' => ['description' => 'The ID of the resource group.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rg-aekz24ikcjyqjkq'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '4003DD68-3C3C-5071-B4FC-631A6C1BAC1C'], 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" ."\n" .'* true'."\n" .'* false'."\n", 'type' => 'boolean', 'example' => 'true'], 'Code' => ['description' => 'The response code. The status code 200 indicates that the request was successful.'."\n", 'type' => 'string', 'example' => '200'], 'Message' => ['description' => 'The returned message. If the request was successful, "successful" is returned. If the request failed, an error message is returned.'."\n", 'type' => 'string', 'example' => 'successful'], 'PageNumber' => ['description' => 'The page number. Pages start from page 1. Default value: 1.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1'], 'PageSize' => ['description' => 'The number of entries per page. Valid values: 1 to 99. Default value: 10.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '10'], 'TotalCount' => ['description' => 'The total number of entries returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '21'], 'Hanas' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'Hana' => [ 'description' => 'The information about the SAP HANA instances.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The SAP HANA instance.'."\n", 'type' => 'object', 'properties' => [ 'Status' => ['description' => 'The status of the SAP HANA instance. Valid values:'."\n" ."\n" .'* INITIALIZING: The instance is being initialized.'."\n" .'* INITIALIZED: The instance is registered.'."\n" .'* INVALID_HANA_NODE: The instance is invalid.'."\n" .'* INITIALIZE_FAILED: The client fails to be installed on the instance.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => 'INITIALIZED'], 'Host' => ['description' => 'The private or internal IP address of the host where the primary node of the SAP HANA instance resides.'."\n", 'type' => 'string', 'example' => '47.100.XX.XX'], 'VaultId' => ['description' => 'The ID of the backup vault.'."\n", 'type' => 'string', 'example' => 'v-0000s974******1hl'], 'UseSsl' => ['description' => 'Indicates whether the SAP HANA instance is connected over Secure Sockets Layer (SSL). Valid values:'."\n" ."\n" .'* true: The SAP HANA instance is connected over SSL.'."\n" .'* false: The SAP HANA instance is not connected over SSL.'."\n", 'type' => 'boolean', 'example' => 'true'], 'HanaName' => ['description' => 'The name of the SAP HANA instance.'."\n", 'type' => 'string', 'example' => 'HANA-DEV'], 'InstanceNumber' => ['description' => 'The instance number of the SAP HANA system.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '00'], 'ValidateCertificate' => ['description' => 'Indicates whether the SSL certificate of the SAP HANA instance is verified.'."\n", 'type' => 'boolean', 'example' => 'false'], 'AlertSetting' => ['description' => 'The alert settings. Valid value: INHERITED, which indicates that the Cloud Backup client sends alert notifications by using the same method configured for the backup vault.'."\n", 'type' => 'string', 'example' => 'INHERITED'], 'UserName' => ['description' => 'The username of the SYSTEMDB database.'."\n", 'type' => 'string', 'example' => 'admin'], 'StatusMessage' => ['description' => 'The status information.'."\n", 'type' => 'string', 'example' => 'INSTALL_CLIENT_FAILED'], 'ClusterId' => ['description' => 'The ID of the SAP HANA instance.'."\n", 'type' => 'string', 'example' => 'cl-0004cf6g6******0yd7y'], 'Tags' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'Tag' => [ 'description' => 'The tags of the SAP HANA instance.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The tags of SAP HANA instance.', 'type' => 'object', 'properties' => [ 'Key' => ['description' => 'The tag key.'."\n", 'type' => 'string', 'example' => 'ace:rm:rgld'], 'Value' => ['description' => 'The tag value.'."\n", 'type' => 'string', 'example' => 'rg-acfmwutpyat2kwy'], ], ], ], ], ], 'ResourceGroupId' => ['description' => 'The resource group ID.'."\n", 'type' => 'string', 'example' => 'rg-acfmvnf22m7itha'], 'CrossAccountType' => ['description' => 'Specifies whether data is backed up within the same Alibaba Cloud account or across Alibaba Cloud accounts. Valid values:'."\n" ."\n" .'* **SELF_ACCOUNT**: Data is backed up within the same Alibaba Cloud account.'."\n" .'* **CROSS_ACCOUNT**: Data is backed up across Alibaba Cloud accounts.'."\n", 'type' => 'string', 'example' => 'CROSS_ACCOUNT'], 'CrossAccountUserId' => ['description' => 'The ID of the source Alibaba Cloud account that authorizes the current Alibaba Cloud account to back up data across Alibaba Cloud accounts.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '158975xxxxx4625'."\n"], 'CrossAccountRoleName' => ['description' => 'The name of the Resource Access Management (RAM) role that is created within the source Alibaba Cloud account and assigned to the current Alibaba Cloud account to authorize the current Alibaba Cloud account to back up data across Alibaba Cloud accounts.'."\n", 'type' => 'string', 'example' => 'hbrcrossrole'], ], ], ], ], ], ], 'description' => '', ], ], ], 'title' => 'DescribeHanaInstances', 'summary' => 'Queries one or more SAP HANA instances that meet the specified conditions.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeHanaInstances'], ], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'hbr:DescribeHanaInstances', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'HBR', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"4003DD68-3C3C-5071-B4FC-631A6C1BAC1C\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 21,\\n \\"Hanas\\": {\\n \\"Hana\\": [\\n {\\n \\"Status\\": 0,\\n \\"Host\\": \\"47.100.XX.XX\\",\\n \\"VaultId\\": \\"v-0000s974******1hl\\",\\n \\"UseSsl\\": true,\\n \\"HanaName\\": \\"HANA-DEV\\",\\n \\"InstanceNumber\\": 0,\\n \\"ValidateCertificate\\": false,\\n \\"AlertSetting\\": \\"INHERITED\\",\\n \\"UserName\\": \\"admin\\",\\n \\"StatusMessage\\": \\"INSTALL_CLIENT_FAILED\\",\\n \\"ClusterId\\": \\"cl-0004cf6g6******0yd7y\\",\\n \\"Tags\\": {\\n \\"Tag\\": [\\n {\\n \\"Key\\": \\"ace:rm:rgld\\",\\n \\"Value\\": \\"rg-acfmwutpyat2kwy\\"\\n }\\n ]\\n },\\n \\"ResourceGroupId\\": \\"rg-acfmvnf22m7itha\\",\\n \\"CrossAccountType\\": \\"CROSS_ACCOUNT\\",\\n \\"CrossAccountUserId\\": 0,\\n \\"CrossAccountRoleName\\": \\"hbrcrossrole\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 4003DD68-3C3C-5071-B4FC-631A6C1BAC1C\\n true\\n 200\\n successful\\n 1\\n 10\\n 21\\n \\n 47.100.XX.XX\\n v-0000s974******1hl\\n true\\n HANA-DEV\\n 0\\n false\\n INHERITED\\n admin\\n INSTALL_CLIENT_FAILED\\n cl-0004cf6g6******0yd7y\\n \\n ace:rm:rgld\\n rg-acfmwutpyat2kwy\\n \\n rg-acfmvnf22m7itha\\n \\n","errorExample":""}]', ], 'DescribeHanaRestores' => [ 'methods' => ['post', 'get'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'VaultId', 'in' => 'query', 'schema' => ['description' => 'The ID of the backup vault.'."\n", 'type' => 'string', 'required' => false, 'example' => 'v-000au6bq******mpu'], ], [ 'name' => 'ClusterId', 'in' => 'query', 'schema' => ['description' => 'The ID of the SAP HANA instance.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cl-000b******soejg'], ], [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => ['description' => 'The page number. Pages start from page 1. Default value: 1.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'minimum' => '1', 'example' => '1', 'default' => '1'], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => ['description' => 'The number of entries per page. Valid values: 1 to 99. Default value: 10.\\`'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100', 'minimum' => '1', 'example' => '10', 'default' => '1'], ], [ 'name' => 'RestoreId', 'in' => 'query', 'schema' => ['description' => 'The ID of the restore job.'."\n", 'type' => 'string', 'required' => false, 'example' => 'r-0007o3vqfukfe92hvf13'], ], [ 'name' => 'DatabaseName', 'in' => 'query', 'schema' => ['description' => 'The database name.'."\n", 'type' => 'string', 'required' => false, 'example' => 'SYSTEMDB'], ], [ 'name' => 'BackupId', 'in' => 'query', 'schema' => ['description' => 'The backup ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1632754800158'], ], [ 'name' => 'RestoreStatus', 'in' => 'query', 'schema' => ['description' => 'The status of the restore job. Valid values:'."\n" ."\n" .'* **RUNNING**: The job is running.'."\n" .'* **COMPLETE**: The job is completed.'."\n" .'* **PARTIAL_COMPLETE**: The job is partially completed.'."\n" .'* **FAILED**: The job failed.'."\n" .'* **CANCELED**: The job is canceled.'."\n" .'* **EXPIRED**: The job timed out.'."\n", 'type' => 'string', 'required' => false, 'example' => 'COMPLETE'], ], [ 'name' => 'ResourceGroupId', 'in' => 'query', 'schema' => ['description' => 'The ID of the resource group.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rg-acfm4ebtpkzx7zy'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '7DEFC897-8F05-5C05-912C-C9A9510FBFF1'], 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" ."\n" .'* true'."\n" .'* false'."\n", 'type' => 'boolean', 'example' => 'true'], 'Code' => ['description' => 'The response code. The status code 200 indicates that the request was successful.'."\n", 'type' => 'string', 'example' => '200'], 'Message' => ['description' => 'The returned message. If the request was successful, "successful" is returned. If the request failed, an error message is returned.'."\n", 'type' => 'string', 'example' => 'successful'], 'PageNumber' => ['description' => 'The page number. Pages start from page 1. Default value: 1.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1'], 'PageSize' => ['description' => 'The number of entries per page. Valid values: 1 to 99. Default value: 10.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '10'], 'TotalCount' => ['description' => 'The total number of entries returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '19'], 'HanaRestore' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'HanaRestores' => [ 'description' => 'The information about restore jobs.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The restore job.'."\n", 'type' => 'object', 'properties' => [ 'Status' => ['description' => 'The status of the restore job. Valid values:'."\n" ."\n" .'* **RUNNING**: The job is running.'."\n" .'* **COMPLETE**: The job is completed.'."\n" .'* **PARTIAL_COMPLETE**: The job is partially completed.'."\n" .'* **FAILED**: The job failed.'."\n" .'* **CANCELED**: The job is canceled.'."\n" .'* **EXPIRED**: The job timed out.'."\n", 'type' => 'string', 'example' => 'COMPLETE'], 'ReachedTime' => ['description' => 'The point in time at which the database is restored.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1635315505'], 'VaultId' => ['description' => 'The ID of the backup vault.'."\n", 'type' => 'string', 'example' => 'v-000g9acf******gta'], 'CurrentPhase' => ['description' => 'The current recovery phase. This value is obtained from SAP HANA.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '2'], 'ClearLog' => ['description' => 'Indicates whether all log entries are deleted from the log area after the log entries are restored. Valid values: true and false. If the return value is false, all log entries are deleted from the log area after the log entries are restored.'."\n", 'type' => 'boolean', 'example' => 'true'], 'Message' => ['description' => 'The details of the recovery phase.'."\n", 'type' => 'string', 'example' => 'SQL Error 448 - recovery could not be completed:'], 'CheckAccess' => ['description' => 'Indicates whether the differential backup and log backup are validated. Valid values:'."\n" ."\n" .'* true: Cloud Backup checks whether the required differential backup and log backup are available before the restore job starts. If the differential backup or log backup is unavailable, Cloud Backup does not start the restore job.'."\n" .'* false: Cloud Backup does not check whether the required differential backup and log backup are available before the restore job starts.'."\n", 'type' => 'boolean', 'example' => 'true'], 'Mode' => ['description' => 'The recovery mode. Valid values:'."\n" ."\n" .'* **RECOVERY_TO_MOST_RECENT**: The database is restored to the recently available state to which the database has been backed up.'."\n" .'* **RECOVERY_TO_POINT_IN_TIME**: The database is restored to a specified point in time.'."\n" .'* **RECOVERY_TO_SPECIFIC_BACKUP**: The database is restored to a specified backup.'."\n" .'* **RECOVERY_TO_LOG_POSITION**: The database is restored to a specified log position.'."\n", 'type' => 'string', 'example' => 'RECOVERY_TO_SPECIFIC_BACKUP'], 'SystemCopy' => ['description' => 'Indicates whether the database is restored to a different instance. Valid values:'."\n" ."\n" .'* true: The database is restored to a different instance.'."\n" .'* false: The database is restored within the same instance.'."\n", 'type' => 'boolean', 'example' => 'true'], 'CurrentProgress' => ['description' => 'The current progress. This value is obtained from SAP HANA.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1'], 'UseDelta' => ['description' => 'Indicates whether a differential backup or an incremental backup is used to restore the database. Valid values: true and false. If the return value is true, Cloud Backup uses a differential backup or an incremental backup to restore the database. If the return value is false, Cloud Backup uses a log backup to restore the database.'."\n", 'type' => 'boolean', 'example' => 'true'], 'BackupID' => ['description' => 'The backup ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1635315505'], 'SourceClusterId' => ['description' => 'The ID of the source SAP HANA instance.'."\n", 'type' => 'string', 'example' => 'cl-0000g3mvy******5cj'], 'VolumeId' => ['description' => 'The ID of the volume that is restored. This parameter is returned only if the value of the Mode parameter is **RECOVERY_TO_LOG_POSITION**.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '0'], 'DatabaseName' => ['description' => 'The database name.'."\n", 'type' => 'string', 'example' => 'BWD'], 'Phase' => ['description' => 'The recovery phase.'."\n", 'type' => 'string', 'example' => 'restart'], 'ClusterId' => ['description' => 'The ID of the SAP HANA instance that is restored.'."\n", 'type' => 'string', 'example' => 'cl-000923yu******p00j4'], 'DatabaseRestoreId' => ['description' => 'The ID of the database recovery.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1644038961030'], 'State' => ['description' => 'The recovery status. This value is obtained from SAP HANA.'."\n", 'type' => 'string', 'example' => 'successful'], 'Source' => ['description' => 'The name of the source system. This parameter indicates the name of the source database that is restored. Format: `@SID`.'."\n", 'type' => 'string', 'example' => 'PRD@H4P'], 'MaxPhase' => ['description' => 'The maximum recovery phase. This value is obtained from SAP HANA.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '4'], 'EndTime' => ['description' => 'The time when the restore job ends. This value is a UNIX timestamp. Unit: seconds.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1634356382'], 'StartTime' => ['description' => 'The time when the restore job starts. This value is a UNIX timestamp. Unit: seconds.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1636970413'], 'BackupPrefix' => ['description' => 'The backup prefix.'."\n", 'type' => 'string', 'example' => 'INC_DATA_BACKUP'], 'RestoreId' => ['description' => 'The ID of the restore job.'."\n", 'type' => 'string', 'example' => 'r-000c1en183ayn9sesgqh'], 'LogPosition' => ['description' => 'The log position to which the database is restored. This parameter is returned only if the value of the Mode parameter is **RECOVERY_TO_LOG_POSITION**.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '0'], 'RecoveryPointInTime' => ['description' => 'The point in time to which the database is restored. This parameter is returned only if the value of the Mode parameter is **RECOVERY_TO_POINT_IN_TIME**. Cloud Backup restores the database to a state closest to the specified point in time.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1649851200'], 'MaxProgress' => ['description' => 'The maximum progress. This value is obtained from SAP HANA.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1'], 'UseCatalog' => ['description' => 'Indicates whether a catalog backup is used to restore the database. This parameter is returned only if the value of the Mode parameter is **RECOVERY_TO_SPECIFIC_BACKUP**. If the return value is false, Cloud Backup finds the backup file based on the specified prefix and then restores the backup file.'."\n", 'type' => 'boolean', 'example' => 'false'], ], ], ], ], ], ], 'description' => '', ], ], ], 'title' => 'DescribeHanaRestores', 'summary' => 'Queries one or more SAP HANA restore jobs that meet the specified conditions.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeHanaRestores'], ], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'hbr:DescribeHanaRestores', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'HBR', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"7DEFC897-8F05-5C05-912C-C9A9510FBFF1\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 19,\\n \\"HanaRestore\\": {\\n \\"HanaRestores\\": [\\n {\\n \\"Status\\": \\"COMPLETE\\",\\n \\"ReachedTime\\": 1635315505,\\n \\"VaultId\\": \\"v-000g9acf******gta\\",\\n \\"CurrentPhase\\": 2,\\n \\"ClearLog\\": true,\\n \\"Message\\": \\"SQL Error 448 - recovery could not be completed:\\",\\n \\"CheckAccess\\": true,\\n \\"Mode\\": \\"RECOVERY_TO_SPECIFIC_BACKUP\\",\\n \\"SystemCopy\\": true,\\n \\"CurrentProgress\\": 1,\\n \\"UseDelta\\": true,\\n \\"BackupID\\": 1635315505,\\n \\"SourceClusterId\\": \\"cl-0000g3mvy******5cj\\",\\n \\"VolumeId\\": 0,\\n \\"DatabaseName\\": \\"BWD\\",\\n \\"Phase\\": \\"restart\\",\\n \\"ClusterId\\": \\"cl-000923yu******p00j4\\",\\n \\"DatabaseRestoreId\\": 1644038961030,\\n \\"State\\": \\"successful\\",\\n \\"Source\\": \\"PRD@H4P\\",\\n \\"MaxPhase\\": 4,\\n \\"EndTime\\": 1634356382,\\n \\"StartTime\\": 1636970413,\\n \\"BackupPrefix\\": \\"INC_DATA_BACKUP\\",\\n \\"RestoreId\\": \\"r-000c1en183ayn9sesgqh\\",\\n \\"LogPosition\\": 0,\\n \\"RecoveryPointInTime\\": 1649851200,\\n \\"MaxProgress\\": 1,\\n \\"UseCatalog\\": false\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 7DEFC897-8F05-5C05-912C-C9A9510FBFF1\\n true\\n 200\\n successful\\n 1\\n 10\\n 19\\n \\n COMPLETE\\n 1635315505\\n v-000g9acf******gta\\n 2\\n true\\n SQL Error 448 - recovery could not be completed:\\n true\\n RECOVERY_TO_SPECIFIC_BACKUP\\n true\\n 1\\n true\\n 1635315505\\n cl-0000g3mvy******5cj\\n 0\\n BWD\\n restart\\n cl-000923yu******p00j4\\n 1644038961030\\n successful\\n PRD@H4P\\n 4\\n 1634356382\\n 1636970413\\n INC_DATA_BACKUP\\n r-000c1en183ayn9sesgqh\\n 0\\n 1649851200\\n 1\\n false\\n \\n","errorExample":""}]', ], 'DescribeHanaRetentionSetting' => [ 'methods' => ['post', 'get'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'VaultId', 'in' => 'query', 'schema' => ['description' => 'The ID of the backup vault.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'v-000ii8t******ntrt2'], ], [ 'name' => 'ClusterId', 'in' => 'query', 'schema' => ['description' => 'The ID of the SAP HANA instance.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cl-0002ys1i******wwtf'], ], [ 'name' => 'DatabaseName', 'in' => 'query', 'schema' => ['description' => 'The database name.'."\n", 'type' => 'string', 'required' => false, 'example' => 'C4P'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '280DD872-EE25-52E8-9CB4-491067173DD0'], 'VaultId' => ['description' => 'The ID of the backup vault.'."\n", 'type' => 'string', 'example' => 'v-0006wkn7******zkn'], 'Schedule' => ['description' => 'The policy to update the retention period. Format: `I|{startTime}|{interval}`, which indicates that the retention period is updated at an interval of {interval} starting from {startTime}.'."\n" ."\n" .'* startTime: the time at which the system starts to run a backup job. The time follows the UNIX time format. Unit: seconds.'."\n" .'* interval: the interval at which the system runs a backup job. The interval follows the ISO 8601 standard. For example, PT1H indicates an interval of 1 hour. P1D indicates an interval of one day.'."\n", 'type' => 'string', 'example' => 'I|0|P1D'], 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" ."\n" .'* true'."\n" .'* false'."\n", 'type' => 'boolean', 'example' => 'true'], 'DatabaseName' => ['description' => 'The database name.'."\n", 'type' => 'string', 'example' => 'Q01'], 'Disabled' => ['description' => 'Indicates whether the backup is permanently retained. Valid values:'."\n" ."\n" .'* true: The backup is permanently retained.'."\n" .'* false: The backup is retained for the specified number of days.'."\n", 'type' => 'boolean', 'example' => 'false'], 'Code' => ['description' => 'The response code. The status code 200 indicates that the request was successful.'."\n", 'type' => 'string', 'example' => '200'], 'RetentionDays' => ['description' => 'The number of days for which the backup is retained. If the value of the Disabled parameter is false, the backup is retained for the number of days specified by this parameter.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '3650'], 'Message' => ['description' => 'The returned message. If the request was successful, "successful" is returned. If the request failed, an error message is returned.'."\n", 'type' => 'string', 'example' => 'successful'], 'ClusterId' => ['description' => 'The ID of the SAP HANA instance.'."\n", 'type' => 'string', 'example' => 'cl-0003jyv******fsku5m'], ], 'description' => '', ], ], ], 'title' => 'DescribeHanaRetentionSetting', 'summary' => 'Queries the backup retention period of an SAP HANA database.', 'description' => '* If you want to query the backup parameters of a database, you can call the DescribeHanaBackupSetting operation.'."\n" .'* Cloud Backup deletes the expired catalogs and data that are related to Backint and file backup. The deleted catalogs and data cannot be restored. We recommend that you set the retention period based on your business requirements.'."\n", 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeHanaRetentionSetting'], ], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'hbr:DescribeHanaRetentionSetting', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'HBR', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"280DD872-EE25-52E8-9CB4-491067173DD0\\",\\n \\"VaultId\\": \\"v-0006wkn7******zkn\\",\\n \\"Schedule\\": \\"I|0|P1D\\",\\n \\"Success\\": true,\\n \\"DatabaseName\\": \\"Q01\\",\\n \\"Disabled\\": false,\\n \\"Code\\": \\"200\\",\\n \\"RetentionDays\\": 3650,\\n \\"Message\\": \\"successful\\",\\n \\"ClusterId\\": \\"cl-0003jyv******fsku5m\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 280DD872-EE25-52E8-9CB4-491067173DD0\\n v-0006wkn7******zkn\\n I|0|P1D\\n true\\n Q01\\n false\\n 200\\n 3650\\n successful\\n cl-0003jyv******fsku5m\\n","errorExample":""}]', ], 'DescribeOtsTableSnapshots' => [ 'methods' => ['get', 'post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'StartTime', 'in' => 'formData', 'schema' => ['description' => 'The start time of the backup. The value must be a UNIX timestamp. Unit: milliseconds.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1611109271630'], ], [ 'name' => 'EndTime', 'in' => 'formData', 'schema' => ['description' => 'The end time of the backup. The value must be a UNIX timestamp. Unit: milliseconds.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1652068250881'], ], [ 'name' => 'SnapshotIds', 'in' => 'formData', 'style' => 'flat', 'schema' => [ 'description' => 'The snapshot IDs.'."\n", 'type' => 'array', 'items' => ['description' => 'The snapshot ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 's-00047mxg17p26****3c'], 'required' => false, ], ], [ 'name' => 'OtsInstances', 'in' => 'formData', 'style' => 'flat', 'schema' => [ 'description' => 'The Tablestore instances that are backed up.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The list of Tablestore instances that are backed up.', 'type' => 'object', 'properties' => [ 'InstanceName' => ['description' => 'The name of the Tablestore instance.'."\n", 'type' => 'string', 'required' => false, 'example' => 'instancename'], 'TableNames' => [ 'description' => 'The names of the tables in the Tablestore instance.'."\n", 'type' => 'array', 'items' => ['description' => 'The name of the table in the Tablestore instance.'."\n", 'type' => 'string', 'required' => false, 'example' => 'tablename'], 'required' => false, ], ], 'required' => false, ], 'required' => false, ], ], [ 'name' => 'Limit', 'in' => 'formData', 'schema' => ['description' => 'The maximum number of rows that you want the current query to return.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '100'], ], [ 'name' => 'NextToken', 'in' => 'formData', 'schema' => ['description' => 'The token that is required to obtain the next page of backup snapshots.'."\n", 'type' => 'string', 'required' => false, 'example' => 'caeba0bbb2be03f84eb48b699f0a****'], ], [ 'name' => 'CrossAccountType', 'in' => 'query', 'schema' => ['description' => 'Specifies whether data is backed up within the same Alibaba Cloud account or across Alibaba Cloud accounts. Valid values:'."\n" ."\n" .'* SELF_ACCOUNT: Data is backed up within the same Alibaba Cloud account.'."\n" .'* CROSS_ACCOUNT: Data is backed up across Alibaba Cloud accounts.'."\n", 'type' => 'string', 'required' => false, 'example' => 'CROSS_ACCOUNT'], ], [ 'name' => 'CrossAccountUserId', 'in' => 'query', 'schema' => ['description' => 'The UID of the source account used for cross-account backup.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '144015xxxxx98732'], ], [ 'name' => 'CrossAccountRoleName', 'in' => 'query', 'schema' => ['description' => 'The name of the RAM role that is created within the source Alibaba Cloud account and assigned to the current Alibaba Cloud account to authorize the current Alibaba Cloud account to back up data across Alibaba Cloud accounts.'."\n", 'type' => 'string', 'required' => false, 'example' => 'BackupRole'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '09376812-6290-5E36-B504-E8010D72D1F0'], 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" ."\n" .'* true'."\n" .'* false'."\n", 'type' => 'boolean', 'example' => 'true'], 'Code' => ['description' => 'The HTTP status code. The status code 200 indicates that the request was successful.'."\n", 'type' => 'string', 'example' => '200'], 'Message' => ['description' => 'The returned message. If the request was successful, "successful" is returned. If the request failed, an error message is returned.'."\n", 'type' => 'string', 'example' => 'successful'], 'Limit' => ['description' => 'The number of backup snapshots that are displayed on the current page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '10'], 'Snapshots' => [ 'description' => 'The backup snapshots.'."\n", 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Status' => ['description' => 'The status of the backup job. Valid values:'."\n" ."\n" .'* **COMPLETE**: The backup job is completed.'."\n" .'* **PARTIAL_COMPLETE**: The backup job is partially completed.'."\n" .'* **FAILED**: The backup job has failed.'."\n", 'type' => 'string', 'example' => 'COMPLETE'], 'SnapshotHash' => ['description' => 'The hash value of the backup snapshot.'."\n", 'type' => 'string', 'example' => 'f2fe...'], 'VaultId' => ['description' => 'The ID of the backup vault that stores the backup snapshot.'."\n", 'type' => 'string', 'example' => 'v-00030j*******sn'], 'BackupType' => ['description' => 'The backup type. Valid value: **COMPLETE**, which indicates full backup.'."\n", 'type' => 'string', 'example' => 'COMPLETE'], 'CreateTime' => ['description' => 'The time when the Tablestore instance was created. The value is a UNIX timestamp. Unit: seconds.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1607436917'], 'ActualBytes' => ['description' => 'The actual data amount of backup snapshots after duplicates are removed. Unit: bytes.'."\n", 'type' => 'string', 'example' => '0'], 'SourceType' => ['description' => 'The type of the data source. Valid values:'."\n" ."\n" .'* **ECS_FILE**: backup snapshots for Elastic Compute Service (ECS) files'."\n" .'* **OSS**: backup snapshots for Object Storage Service (OSS) buckets'."\n" .'* **NAS**: backup snapshots for Apsara File Storage NAS file systems'."\n" .'* **OTS_TABLE**: backup snapshots for Tablestore instances'."\n", 'type' => 'string', 'example' => 'OTS_TABLE'], 'BytesTotal' => ['description' => 'The total amount of data. Unit: bytes.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '0'], 'CompleteTime' => ['description' => 'The time when the backup snapshot was completed. The value is a UNIX timestamp. Unit: seconds.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1642496679'], 'Retention' => ['description' => 'The retention period of the backup snapshot. Unit: days.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '730'], 'CreatedTime' => ['description' => 'The time when the backup snapshot was created. The value is a UNIX timestamp. Unit: seconds.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1642496679'], 'ParentSnapshotHash' => ['description' => 'The hash value of the parent backup snapshot.'."\n", 'type' => 'string', 'example' => 'f2fe..'], 'StartTime' => ['description' => 'The time when the backup snapshot started. The value is a UNIX timestamp. Unit: seconds.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1642496543'], 'UpdatedTime' => ['description' => 'The time when the backup snapshot was updated. The value is a UNIX timestamp. Unit: seconds.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1642496679'], 'SnapshotId' => ['description' => 'The ID of the backup snapshot.'."\n", 'type' => 'string', 'example' => 's-00047mxg17p26*****b'], 'JobId' => ['description' => 'The ID of the backup job.'."\n", 'type' => 'string', 'example' => 'job-00030j3chkt******2'], 'InstanceName' => ['description' => 'The name of the Tablestore instance.'."\n", 'type' => 'string', 'example' => 'instancename'], 'TableName' => ['description' => 'The name of the table in the Tablestore instance.'."\n", 'type' => 'string', 'example' => 'table2'], 'RangeStart' => ['description' => 'The time when the backup job started. The value is a UNIX timestamp. Unit: milliseconds.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1642492553038'], 'RangeEnd' => ['description' => 'The time when the backup job ended. The value is a UNIX timestamp. Unit: milliseconds.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1642521709966'], ], 'description' => 'The list of backup snapshots.', ], ], 'NextToken' => ['description' => 'The token that is required to obtain the next page of backup snapshots.'."\n", 'type' => 'string', 'example' => 'caeba0bbb2be03f84eb48b699f0a'], ], 'description' => '', ], ], ], 'title' => 'DescribeOtsTableSnapshots', 'summary' => 'Queries the details about Tablestore instances that are backed up.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeOtsTableSnapshots'], ], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'hbr:DescribeOtsTableSnapshots', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'HBR', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"09376812-6290-5E36-B504-E8010D72D1F0\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"Limit\\": 10,\\n \\"Snapshots\\": [\\n {\\n \\"Status\\": \\"COMPLETE\\",\\n \\"SnapshotHash\\": \\"f2fe...\\",\\n \\"VaultId\\": \\"v-00030j*******sn\\",\\n \\"BackupType\\": \\"COMPLETE\\",\\n \\"CreateTime\\": 1607436917,\\n \\"ActualBytes\\": \\"0\\",\\n \\"SourceType\\": \\"OTS_TABLE\\",\\n \\"BytesTotal\\": 0,\\n \\"CompleteTime\\": 1642496679,\\n \\"Retention\\": 730,\\n \\"CreatedTime\\": 1642496679,\\n \\"ParentSnapshotHash\\": \\"f2fe..\\",\\n \\"StartTime\\": 1642496543,\\n \\"UpdatedTime\\": 1642496679,\\n \\"SnapshotId\\": \\"s-00047mxg17p26*****b\\",\\n \\"JobId\\": \\"job-00030j3chkt******2\\",\\n \\"InstanceName\\": \\"instancename\\",\\n \\"TableName\\": \\"table2\\",\\n \\"RangeStart\\": 1642492553038,\\n \\"RangeEnd\\": 1642521709966\\n }\\n ],\\n \\"NextToken\\": \\"caeba0bbb2be03f84eb48b699f0a\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 09376812-6290-5E36-B504-E8010D72D1F0\\n true\\n 200\\n successful\\n 10\\n \\n COMPLETE\\n f2fe...\\n v-00030j*******sn\\n COMPLETE\\n 1607436917\\n 0\\n OTS_TABLE\\n 0\\n 1642496679\\n 730\\n 1642496679\\n f2fe..\\n 1642496543\\n 1642496679\\n s-00047mxg17p26*****b\\n job-00030j3chkt******2\\n instancename\\n table2\\n 1642492553038\\n 1642521709966\\n \\n caeba0bbb2be03f84eb48b699f0a\\n","errorExample":""}]', ], 'DescribePoliciesV2' => [ 'summary' => 'Queries one or more policies.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '162855', 'abilityTreeNodes' => ['FEATUREhbr56LH1C', 'FEATUREhbrS7MI6C', 'FEATUREhbrFWIWBG', 'FEATUREhbr7WEYAR', 'FEATUREhbrB1KQ9G', 'FEATUREhbr3BJQCT', 'FEATUREhbrF83GXN'], ], 'parameters' => [ [ 'name' => 'NextToken', 'in' => 'formData', 'schema' => ['description' => 'The token that is used to retrieve the next page of policies.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'caeba0bbb2be03f84eb48b699f0a'], ], [ 'name' => 'MaxResults', 'in' => 'formData', 'schema' => ['description' => 'The number of entries to return on each page.'."\n" ."\n" .'Valid values: 10 to 100. Default value: 10.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'default' => '10', 'title' => '', 'example' => '10'], ], [ 'name' => 'PolicyId', 'in' => 'formData', 'schema' => ['description' => 'The policy ID.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'po-000************2l6'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'DescribePoliciesResponse', 'description' => 'DescribePoliciesResponse', 'type' => 'object', 'properties' => [ 'Policies' => [ 'description' => 'The list of policies.', 'type' => 'array', 'items' => [ 'description' => 'The details of the policy.', 'type' => 'object', 'properties' => [ 'CreatedTime' => ['description' => 'The time when the policy was created. This value is a UNIX timestamp. Unit: seconds.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1650248136'], 'UpdatedTime' => ['description' => 'The time when the policy was updated. This value is a UNIX timestamp. Unit: seconds.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1662080404'], 'PolicyId' => ['description' => 'The policy ID.', 'type' => 'string', 'title' => '', 'example' => 'po-000************bkz'], 'PolicyName' => ['description' => 'The policy name.', 'type' => 'string', 'title' => '', 'example' => 'Daily backup + offsite backup'], 'PolicyDescription' => ['description' => 'The description of the policy.', 'type' => 'string', 'title' => '', 'example' => 'Data is backed up at 10:00:00 every day and replicated to the China (Shanghai) region.'], 'Rules' => [ 'description' => 'The list of policy rules.', 'type' => 'array', 'items' => [ 'description' => 'The details of the policy rule.', 'type' => 'object', 'properties' => [ 'RuleId' => ['description' => 'The rule ID.', 'type' => 'string', 'title' => '', 'example' => 'rule-000************f1e'], 'RuleType' => ['title' => 'TRANSITION, BACKUP, REPLICATION', 'description' => 'The type of the rule. Each policy must have at least one rule of the **BACKUP** type and can have only one rule of the **TRANSITION** type. Valid values:'."\n" ."\n" .'- **BACKUP**: the backup rule.'."\n" ."\n" .'- **TRANSITION**: the lifecycle rule.'."\n" ."\n" .'- **REPLICATION**: the replication rule.', 'type' => 'string', 'example' => 'BACKUP'], 'Schedule' => ['description' => 'This parameter is required only when **RuleType** is set to **BACKUP**. The backup schedule. The format is `I|{startTime}|{interval}`. The system runs a backup job at a specified interval, starting from the specified time. The system does not run a backup job to compensate for a missed job. If the last backup job is not complete, the next backup job is not triggered. For example, `I|1631685600|P1D` indicates that a backup job is run every day, starting from 2021-09-15 14:00:00.'."\n" ."\n" .'- startTime: The time to start the backup. This value is a UNIX timestamp. Unit: seconds.'."\n" ."\n" .'- interval: The backup interval. The value must be in the ISO 8601 standard. For example, PT1H indicates an interval of one hour. P1D indicates an interval of one day.', 'type' => 'string', 'title' => '', 'example' => 'I|1648647166|P1D'], 'BackupType' => ['title' => 'COMPLETE, INCREMENTAL, DIFFERENTIAL, LOG', 'description' => 'This parameter is required only when **RuleType** is set to **BACKUP**. The backup type. The value **COMPLETE** indicates a full backup.', 'type' => 'string', 'example' => 'COMPLETE'], 'VaultId' => ['description' => 'This parameter is required only when RuleType is set to BACKUP. The ID of the backup vault.', 'type' => 'string', 'title' => '', 'example' => 'v-000**************kgm'], 'ReplicationRegionId' => ['description' => 'This parameter is required only when **RuleType** is set to **REPLICATION**. The ID of the destination region for replication.', 'type' => 'string', 'title' => '', 'example' => 'cn-shanghai'], 'Retention' => ['description' => 'This parameter is required only when **RuleType** is set to **TRANSITION** or **REPLICATION**.'."\n" ."\n" .'- If **RuleType** is set to **TRANSITION**: the retention period of the backup. The minimum value is 1. Unit: days.'."\n" ."\n" .'- If **RuleType** is set to **REPLICATION**: the retention period of the remote backup. The minimum value is 1. Unit: days.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '7'], 'RetentionRules' => [ 'description' => 'This parameter is required only when **RuleType** is set to **TRANSITION**. The list of special retention rules.', 'type' => 'array', 'items' => [ 'description' => 'The special retention rule.', 'type' => 'object', 'properties' => [ 'AdvancedRetentionType' => ['title' => 'DAILY, WEEKLY, MONTHLY, YEARLY', 'description' => 'The type of the special retention rule. Valid values:'."\n" ."\n" .'- **WEEKLY**: weekly backups'."\n" ."\n" .'- **MONTHLY**: monthly backups'."\n" ."\n" .'- **YEARLY**: yearly backups', 'type' => 'string', 'example' => 'YEARLY'], 'WhichSnapshot' => ['description' => 'Specifies which backup is retained. This parameter is valid only for the first backup. The value must be 1.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1'], 'Retention' => ['description' => 'The special retention period of the backup. The minimum value is 1. Unit: days.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '730'], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], 'ArchiveDays' => ['description' => 'This parameter is required only when **RuleType** is set to **TRANSITION**. The number of days before a backup is converted to an archive backup. Unit: days.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '30'], 'KeepLatestSnapshots' => ['description' => 'Specifies whether to retain at least one backup version. Valid values:'."\n" ."\n" .'- **0**: No.'."\n" ."\n" .'- **1**: Yes.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1'], 'DataSourceFilters' => [ 'description' => 'This parameter is required only when **RuleType** is set to **TAG**. The filter rules for data sources.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'SourceType' => ['description' => 'The type of the data source. Valid values:'."\n" ."\n" .'- **UDM\\_ECS**: ECS instance backup'."\n" ."\n" .'- **OSS**: OSS backup'."\n" ."\n" .'- **NAS**: Alibaba Cloud NAS backup'."\n" ."\n" .'- **ECS\\_FILE**: ECS file backup'."\n" ."\n" .'- **OTS**: Tablestore backup', 'type' => 'string', 'title' => '', 'example' => 'UDM_ECS'], 'DataSourceIds' => [ 'description' => 'This parameter is deprecated.', 'type' => 'array', 'items' => ['description' => 'This parameter is deprecated.', 'type' => 'string', 'title' => '', 'example' => '已废弃。'], 'title' => '', 'example' => 'Deprecated.', ], ], 'description' => '', 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], 'TagFilters' => [ 'description' => 'This parameter is required only when **RuleType** is set to **TAG**. The filter rules for resource tags.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Key' => ['description' => 'The tag key.', 'type' => 'string', 'title' => '', 'example' => 'env'], 'Value' => ['description' => 'The tag value. If you leave this parameter empty, all tag values are matched.', 'type' => 'string', 'title' => '', 'example' => 'prod'], 'Operator' => ['description' => 'The tag matching rule. Valid values:'."\n" ."\n" .'- **EQUAL**: Matches the tag key and tag value.'."\n" ."\n" .'- **NOT**: Matches the tag key but not the tag value.', 'type' => 'string', 'title' => '', 'example' => 'EQUAL'], ], 'description' => '', 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], 'Immutable' => ['description' => 'This parameter is valid only when **PolicyType** is set to**UDM\\_ECS\\_ONLY**. This parameter specifies whether to enable backup locking.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], 'PolicyBindingCount' => ['description' => 'The number of data sources that are bound to the policy.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '5'], 'PolicyType' => ['description' => 'The type of the policy. Valid values:'."\n" ."\n" .'- **STANDARD**: a standard backup policy. This policy type supports all data sources except ECS instance backup.'."\n" ."\n" .'- **UDM\\_ECS\\_ONLY**: an ECS instance backup policy. This policy type supports only ECS instance backup.', 'type' => 'string', 'title' => '', 'example' => 'STANDARD'], 'BusinessStatus' => ['type' => 'string', 'title' => '', 'description' => 'The business status.', 'example' => 'ACTIVE'], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], 'NextToken' => ['description' => 'The token that is used to retrieve the next page of policies.', 'type' => 'string', 'title' => '', 'example' => 'caeba0bbb2be03f84eb48b699f0a'], 'MaxResults' => ['description' => 'The number of entries returned on each page.'."\n" ."\n" .'Valid values: 10 to 100. Default value: 10.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '10'], 'TotalCount' => ['description' => 'The total number of records.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '12'], 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" ."\n" .'- true: The request was successful.'."\n" ."\n" .'- false: The request failed.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], 'Code' => ['description' => 'The return code. A value of 200 indicates that the request was successful.', 'type' => 'string', 'title' => '', 'example' => '200'], 'Message' => ['description' => 'The message that is returned. If the request was successful, \\`successful\\` is returned. If the request failed, an error message is returned.', 'type' => 'string', 'title' => '', 'example' => 'successful'], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E'], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Policies\\": [\\n {\\n \\"CreatedTime\\": 1650248136,\\n \\"UpdatedTime\\": 1662080404,\\n \\"PolicyId\\": \\"po-000************bkz\\",\\n \\"PolicyName\\": \\"Daily backup + offsite backup\\",\\n \\"PolicyDescription\\": \\"Data is backed up at 10:00:00 every day and replicated to the China (Shanghai) region.\\",\\n \\"Rules\\": [\\n {\\n \\"RuleId\\": \\"rule-000************f1e\\",\\n \\"RuleType\\": \\"BACKUP\\",\\n \\"Schedule\\": \\"I|1648647166|P1D\\",\\n \\"BackupType\\": \\"COMPLETE\\",\\n \\"VaultId\\": \\"v-000**************kgm\\",\\n \\"ReplicationRegionId\\": \\"cn-shanghai\\",\\n \\"Retention\\": 7,\\n \\"RetentionRules\\": [\\n {\\n \\"AdvancedRetentionType\\": \\"YEARLY\\",\\n \\"WhichSnapshot\\": 1,\\n \\"Retention\\": 730\\n }\\n ],\\n \\"ArchiveDays\\": 30,\\n \\"KeepLatestSnapshots\\": 1,\\n \\"DataSourceFilters\\": [\\n {\\n \\"SourceType\\": \\"UDM_ECS\\",\\n \\"DataSourceIds\\": [\\n \\"已废弃。\\"\\n ]\\n }\\n ],\\n \\"TagFilters\\": [\\n {\\n \\"Key\\": \\"env\\",\\n \\"Value\\": \\"prod\\",\\n \\"Operator\\": \\"EQUAL\\"\\n }\\n ],\\n \\"Immutable\\": true\\n }\\n ],\\n \\"PolicyBindingCount\\": 5,\\n \\"PolicyType\\": \\"STANDARD\\",\\n \\"BusinessStatus\\": \\"ACTIVE\\"\\n }\\n ],\\n \\"NextToken\\": \\"caeba0bbb2be03f84eb48b699f0a\\",\\n \\"MaxResults\\": 10,\\n \\"TotalCount\\": 12,\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\"\\n}","type":"json"}]', 'title' => 'DescribePoliciesV2', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribePoliciesV2'], ], ], 'ramActions' => [ [ 'operationType' => 'list', 'ramAction' => [ 'action' => 'hbr:DescribePoliciesV2', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'HBR', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'machine', ], 'DescribePolicyBindings' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '136855', 'abilityTreeNodes' => ['FEATUREhbr56LH1C', 'FEATUREhbrS7MI6C', 'FEATUREhbrFWIWBG', 'FEATUREhbrB1KQ9G', 'FEATUREhbrQ3MV3B', 'FEATUREhbr3BJQCT'], ], 'parameters' => [ [ 'name' => 'NextToken', 'in' => 'formData', 'schema' => ['description' => 'The token that is used to retrieve the next page of results.', 'type' => 'string', 'required' => false, 'example' => 'caeba0bbb2be03f84eb48b699f0a', 'title' => ''], ], [ 'name' => 'MaxResults', 'in' => 'formData', 'schema' => ['description' => 'The number of results to return for each query.'."\n" ."\n" .'Valid values: 10 to 100. Default value: 10.', 'type' => 'integer', 'format' => 'int32', 'default' => '10', 'required' => false, 'example' => '10', 'title' => ''], ], [ 'name' => 'PolicyId', 'in' => 'formData', 'schema' => ['description' => 'The policy ID.', 'type' => 'string', 'required' => false, 'example' => 'po-000************hky', 'title' => ''], ], [ 'name' => 'DataSourceIds', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'description' => 'A list of data source IDs.', 'type' => 'array', 'items' => ['description' => 'The data source ID.', 'type' => 'string', 'required' => false, 'example' => 'i-uf6************68n', 'title' => ''], 'required' => false, 'title' => '', 'example' => '', ], ], [ 'name' => 'SourceType', 'in' => 'query', 'schema' => ['description' => 'The type of the data source. Valid value:'."\n" ."\n" .'- **UDM\\_ECS**: ECS instance backup.', 'type' => 'string', 'required' => false, 'example' => 'UDM_ECS', 'title' => ''], ], [ 'name' => 'Filters', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => 'The query filters.', 'type' => 'array', 'items' => [ 'description' => 'The query filters.', 'type' => 'object', 'properties' => [ 'Key' => ['description' => 'The key of the filter. Valid values:'."\n" ."\n" .'- **PolicyId**: the backup policy ID'."\n" ."\n" .'- **DataSourceId**: the ECS instance ID'."\n" ."\n" .'- **DataSourceType**: the data source type', 'type' => 'string', 'required' => false, 'example' => 'DataSourceType', 'title' => ''], 'Operator' => ['description' => 'The matching method. The default value is IN. This parameter specifies the operator to use for matching the key and value. Valid values:'."\n" ."\n" .'- **EQUAL**: equal to'."\n" ."\n" .'- **NOT\\_EQUAL**: not equal to'."\n" ."\n" .'- **GREATER\\_THAN**: greater than'."\n" ."\n" .'- **GREATER\\_THAN\\_OR\\_EQUAL**: greater than or equal to'."\n" ."\n" .'- **LESS\\_THAN**: less than'."\n" ."\n" .'- **LESS\\_THAN\\_OR\\_EQUAL**: less than or equal to'."\n" ."\n" .'- **BETWEEN**: between. The value is a JSON array in the format of `[lower_bound,upper_bound]`.'."\n" ."\n" .'- **IN**: in a set. The value is an array.', 'type' => 'string', 'required' => false, 'example' => 'IN', 'title' => ''], 'Values' => [ 'description' => 'The value to match in the filter.', 'type' => 'array', 'items' => ['description' => 'The value to match in the filter.', 'type' => 'string', 'required' => false, 'example' => 'UDM_ECS', 'title' => ''], 'required' => false, 'maxItems' => 100, 'title' => '', 'example' => '', ], ], 'required' => false, 'title' => '', 'example' => '', ], 'required' => false, 'maxItems' => 100, 'title' => '', 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'DescribePolicyBindingsResponse', 'description' => 'DescribePolicyBindingsResponse', 'type' => 'object', 'properties' => [ 'PolicyBindings' => [ 'description' => 'The list of policy bindings.', 'type' => 'array', 'items' => [ 'description' => 'The details of the policy binding.', 'type' => 'object', 'properties' => [ 'CreatedTime' => ['description' => 'The time when the policy binding was created. This value is a UNIX timestamp. Unit: seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1661399570', 'title' => ''], 'UpdatedTime' => ['description' => 'The time when the policy binding was last updated. This value is a UNIX timestamp. Unit: seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1653611573', 'title' => ''], 'PolicyBindingId' => ['description' => 'The ID of the policy binding.', 'type' => 'string', 'example' => 'pd-000************slc', 'title' => ''], 'PolicyBindingDescription' => ['description' => 'The description of the policy binding.', 'type' => 'string', 'example' => 'po-000************eslc-i-uf6************y5g', 'title' => ''], 'PolicyId' => ['description' => 'The policy ID.', 'type' => 'string', 'example' => 'po-000************56y', 'title' => ''], 'DataSourceId' => ['description' => 'The data source ID.', 'type' => 'string', 'example' => 'i-8vb************5ly', 'title' => ''], 'Disabled' => ['description' => 'Indicates whether the policy is paused for the data source.'."\n" ."\n" .'- true: The policy is paused.'."\n" ."\n" .'- false: The policy is not paused.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'Source' => ['description' => '- If SourceType is set to **OSS**, this parameter specifies the prefix of objects to back up. If you do not specify this parameter, the entire bucket is backed up.'."\n" ."\n" .'- If SourceType is set to **ECS\\_FILE** or **File**, this parameter specifies the paths to the files to back up. If you do not specify this parameter, all directories are backed up.', 'type' => 'string', 'example' => 'backup/', 'title' => ''], 'Include' => ['description' => 'This parameter is required only if **SourceType** is set to **ECS\\_FILE** or **File**. This parameter specifies the file types to back up. All files of the specified types are backed up. This parameter supports a maximum of 255 characters.', 'type' => 'string', 'example' => '[\\"*.doc\\",\\"*.xltm\\"]', 'title' => ''], 'Exclude' => ['description' => 'This parameter is required only if **SourceType** is set to **ECS\\_FILE** or **File**. This parameter specifies the file types to exclude from the backup. All files of the specified types are not backed up. This parameter supports a maximum of 255 characters.', 'type' => 'string', 'example' => '[\\"*.doc\\",\\"*.xltm\\"]', 'title' => ''], 'SpeedLimit' => ['description' => 'This parameter is required only if **SourceType** is set to **ECS\\_FILE** or **File**. This parameter specifies the traffic shaping settings for the backup. The format is `{start}:{end}:{bandwidth}`. You can specify multiple settings. Separate them with commas (,). The time periods cannot overlap.'."\n" ."\n" .'- **start**: the start hour.'."\n" ."\n" .'- **end**: the end hour.'."\n" ."\n" .'- **bandwidth**: the throttling speed. Unit: KB/s.', 'type' => 'string', 'example' => '0:24:10240', 'title' => ''], 'AdvancedOptions' => [ 'description' => 'The advanced options.', 'type' => 'object', 'properties' => [ 'UdmDetail' => [ 'description' => 'The advanced options for ECS instance backup.', 'type' => 'object', 'properties' => [ 'ExcludeDiskIdList' => [ 'description' => 'The list of disk IDs to exclude from the backup. This parameter is ignored if \\`DiskIdList\\` is not empty.', 'type' => 'array', 'items' => ['description' => 'The ID of the disk to exclude from the backup.', 'type' => 'string', 'example' => 'd-bp1************apo'."\n", 'title' => ''], 'title' => '', 'example' => '', ], 'DiskIdList' => [ 'description' => 'The list of disk IDs to back up. If you want to back up all disks, leave this parameter empty.', 'type' => 'array', 'items' => ['description' => 'The ID of the disk to back up.', 'type' => 'string', 'example' => 'd-bp1************apo'."\n", 'title' => ''], 'title' => '', 'example' => '', ], 'SnapshotGroup' => ['description' => 'Indicates whether to create a snapshot-consistent group. You can create a snapshot-consistent group only when all disks of the instance are Enhanced SSDs (ESSDs).', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'AppConsistent' => ['description' => 'Indicates whether to create an application-consistent snapshot. You can create an application-consistent snapshot only when all disks of the instance are ESSDs.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], 'RamRoleName' => ['description' => 'This parameter is required only if **AppConsistent** is set to **true**. This parameter specifies the name of the RAM role that is required to create an application-consistent snapshot.', 'type' => 'string', 'example' => 'AliyunECSInstanceForHbrRole', 'title' => ''], 'PreScriptPath' => ['description' => 'This parameter is required only if **AppConsistent** is set to **true**. This parameter specifies the path of the pre-freeze script that is run before the application-consistent snapshot is created.', 'type' => 'string', 'example' => '/tmp/prescript.sh', 'title' => ''], 'PostScriptPath' => ['description' => 'This parameter is required only if **AppConsistent** is set to **true**. This parameter specifies the path of the post-thaw script that is run after the application-consistent snapshot is created.', 'type' => 'string', 'example' => '/tmp/postscript.sh', 'title' => ''], 'EnableFsFreeze' => ['description' => 'This parameter is required only if **AppConsistent** is set to **true**. This parameter indicates whether to use the \\`fsfreeze\\` command of the Linux operating system to put the file system in a read-only state before you create an application-consistent snapshot. The default value is true.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'TimeoutInSeconds' => ['description' => 'This parameter is required only if **AppConsistent** is set to **true**. This parameter specifies the timeout period for I/O freeze. The default value is 30 seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '30', 'title' => ''], 'EnableWriters' => ['description' => 'This parameter is required only if **AppConsistent** is set to **true**. Indicates whether to create an application-consistent snapshot:'."\n" ."\n" .'- true: Create an application-consistent snapshot.'."\n" ."\n" .'- false: Create a file system-consistent snapshot.'."\n" ."\n" .'Default value: true.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'DestinationKmsKeyId' => ['description' => 'The ID of a customer managed key (CMK) in the destination region. If you enable cross-region replication and specify this parameter, the cross-region backup is encrypted using the specified key.', 'type' => 'string', 'example' => '4ed37b1e-da51-4187-aceb-9db4f9b7148b', 'title' => ''], ], 'title' => '', 'example' => '', ], 'OssDetail' => [ 'description' => 'The advanced options for OSS backup.', 'type' => 'object', 'properties' => [ 'InventoryId' => ['description' => 'The name of the OSS inventory. If you specify this parameter, an OSS inventory is used for performance optimization.'."\n" ."\n" .'- The storage fees for inventory files are charged by OSS.'."\n" ."\n" .'- It takes time to generate an OSS inventory file. The backup job may fail before the inventory file is generated. You can wait for the next backup cycle to run.', 'type' => 'string', 'example' => 'inventory_test', 'title' => ''], 'InventoryCleanupPolicy' => ['description' => 'Indicates whether to delete the inventory file after a backup. This parameter is valid only when an OSS inventory is used. Valid values:'."\n" ."\n" .'- **NO\\_CLEANUP**: The inventory file is not deleted.'."\n" ."\n" .'- **DELETE\\_CURRENT**: The current inventory file is deleted.'."\n" ."\n" .'- **DELETE\\_CURRENT\\_AND\\_PREVIOUS**: All inventory files are deleted.', 'type' => 'string', 'example' => 'DELETE_CURRENT_AND_PREVIOUS', 'title' => ''], 'IgnoreArchiveObject' => ['title' => '不在任务统计和失败文件列表中提示归档型对象', 'description' => 'Indicates whether to exclude archive objects from the backup job statistics and the list of failed files.', 'type' => 'boolean', 'example' => 'true'], ], 'title' => '', 'example' => '', ], 'FileDetail' => [ 'description' => 'The advanced options for file backup.', 'type' => 'object', 'properties' => [ 'UseVSS' => ['description' => 'Indicates whether to enable the Volume Shadow Copy Service (VSS) feature. This feature is available only for Windows instances. Valid values:'."\n" ."\n" .'- **true**: Enable the VSS feature.'."\n" ."\n" .'- **false**: Disable the VSS feature.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], 'AdvPolicy' => ['description' => 'Indicates whether to use an advanced policy. Valid values:'."\n" ."\n" .'- **true**: Use an advanced policy.'."\n" ."\n" .'- **false**: Do not use an advanced policy.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], ], 'title' => '', 'example' => '', ], 'CommonNasDetail' => [ 'description' => 'The advanced options for on-premises NAS.', 'type' => 'object', 'properties' => [ 'FullOnIncrementFail' => ['description' => 'Indicates whether to run a full backup if an incremental backup fails. Valid values:'."\n" ."\n" .'- **true**: Run a full backup.'."\n" ."\n" .'- **false**: Do not run a full backup.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'FetchSliceSize' => ['description' => 'The size of a backup shard, which is the number of files.', 'type' => 'integer', 'format' => 'int64', 'example' => '100000', 'title' => ''], 'ClientId' => ['description' => 'The backup client ID.', 'type' => 'string', 'example' => 'c-0001eg6mcvjs93f46s2d', 'title' => ''], 'ClusterId' => ['description' => 'The client group ID.', 'type' => 'string', 'example' => 'cl-000gkcofngi04j6k680a', 'title' => ''], ], 'title' => '', 'example' => '', ], 'CommonFileSystemDetail' => [ 'description' => 'The advanced options for large-scale file system backup.', 'type' => 'object', 'properties' => [ 'FullOnIncrementFail' => ['description' => 'Indicates whether to run a full backup if an incremental backup fails. Valid values:'."\n" ."\n" .'- **true**: Run a full backup.'."\n" ."\n" .'- **false**: Do not run a full backup.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'FetchSliceSize' => ['description' => 'The size of a backup shard, which is the number of files.', 'type' => 'integer', 'format' => 'int64', 'example' => '100000', 'title' => ''], ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], 'SourceType' => ['description' => 'The type of the data source. Valid value:'."\n" ."\n" .'- **UDM\\_ECS**: ECS instance backup', 'type' => 'string', 'example' => 'UDM_ECS', 'title' => ''], 'CrossAccountType' => ['description' => 'The type of cross-account backup. Valid values:'."\n" ."\n" .'- SELF\\_ACCOUNT: Backs up data within the same account.'."\n" ."\n" .'- CROSS\\_ACCOUNT: Backs up data across accounts.', 'type' => 'string', 'example' => 'CROSS_ACCOUNT', 'title' => ''], 'CrossAccountUserId' => ['description' => 'The ID of the source account for cross-account backup.', 'type' => 'integer', 'format' => 'int64', 'example' => '1480************', 'title' => ''], 'CrossAccountRoleName' => ['description' => 'The name of the RAM role that is created in the source account for cross-account backup.', 'type' => 'string', 'example' => 'hbrcrossrole', 'title' => ''], 'CreatedByTag' => ['description' => 'Indicates whether the data source is automatically bound to the backup policy based on tags.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], 'HitTags' => [ 'description' => 'The matched tag rules.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Key' => ['description' => 'The tag key.', 'type' => 'string', 'example' => 'env', 'title' => ''], 'Value' => ['description' => 'The tag value.', 'type' => 'string', 'example' => 'prod', 'title' => ''], 'Operator' => ['description' => 'The tag matching rule.'."\n" ."\n" .'- **EQUAL**: Matches the tag key and tag value.'."\n" ."\n" .'- **NOT**: Matches the tag key but not the tag value.', 'type' => 'string', 'example' => 'EQUAL', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], 'NextToken' => ['description' => 'The token that is used to retrieve the next page of policy bindings.', 'type' => 'string', 'example' => 'caeba0bbb2be03f84eb48b699f0a', 'title' => ''], 'MaxResults' => ['description' => 'The number of results returned for each query.'."\n" ."\n" .'Valid values: 10 to 100. Default value: 10.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], 'TotalCount' => ['description' => 'The total number of records.', 'type' => 'integer', 'format' => 'int64', 'example' => '38', 'title' => ''], 'Success' => ['description' => 'Indicates whether the request was successful.'."\n" ."\n" .'- true: The request was successful.'."\n" ."\n" .'- false: The request failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'Code' => ['description' => 'The return code. A value of 200 indicates that the request was successful.', 'type' => 'string', 'example' => '200', 'title' => ''], 'Message' => ['description' => 'The returned message. If the request is successful, \\`successful\\` is returned. If the request fails, an error message is returned.', 'type' => 'string', 'example' => 'successful', 'title' => ''], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '5225929A-4EBD-55EE-9FE1-4A130E582A76', 'title' => ''], ], 'example' => '', ], ], ], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], 'title' => 'List Bound Policies', 'summary' => 'You can query the data sources attached to a policy, or the policies attached to a data source.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribePolicyBindings'], ], ], 'ramActions' => [ [ 'operationType' => 'list', 'ramAction' => [ 'action' => 'hbr:DescribePolicyBindings', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'HBR', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"PolicyBindings\\": [\\n {\\n \\"CreatedTime\\": 1661399570,\\n \\"UpdatedTime\\": 1653611573,\\n \\"PolicyBindingId\\": \\"pd-000************slc\\",\\n \\"PolicyBindingDescription\\": \\"po-000************eslc-i-uf6************y5g\\",\\n \\"PolicyId\\": \\"po-000************56y\\",\\n \\"DataSourceId\\": \\"i-8vb************5ly\\",\\n \\"Disabled\\": true,\\n \\"Source\\": \\"backup/\\",\\n \\"Include\\": \\"[\\\\\\\\\\\\\\"*.doc\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"*.xltm\\\\\\\\\\\\\\"]\\",\\n \\"Exclude\\": \\"[\\\\\\\\\\\\\\"*.doc\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"*.xltm\\\\\\\\\\\\\\"]\\",\\n \\"SpeedLimit\\": \\"0:24:10240\\",\\n \\"AdvancedOptions\\": {\\n \\"UdmDetail\\": {\\n \\"ExcludeDiskIdList\\": [\\n \\"d-bp1************apo\\\\n\\"\\n ],\\n \\"DiskIdList\\": [\\n \\"d-bp1************apo\\\\n\\"\\n ],\\n \\"SnapshotGroup\\": true,\\n \\"AppConsistent\\": false,\\n \\"RamRoleName\\": \\"AliyunECSInstanceForHbrRole\\",\\n \\"PreScriptPath\\": \\"/tmp/prescript.sh\\",\\n \\"PostScriptPath\\": \\"/tmp/postscript.sh\\",\\n \\"EnableFsFreeze\\": true,\\n \\"TimeoutInSeconds\\": 30,\\n \\"EnableWriters\\": true,\\n \\"DestinationKmsKeyId\\": \\"4ed37b1e-da51-4187-aceb-9db4f9b7148b\\"\\n },\\n \\"OssDetail\\": {\\n \\"InventoryId\\": \\"inventory_test\\",\\n \\"InventoryCleanupPolicy\\": \\"DELETE_CURRENT_AND_PREVIOUS\\",\\n \\"IgnoreArchiveObject\\": true\\n },\\n \\"FileDetail\\": {\\n \\"UseVSS\\": false,\\n \\"AdvPolicy\\": false\\n },\\n \\"CommonNasDetail\\": {\\n \\"FullOnIncrementFail\\": true,\\n \\"FetchSliceSize\\": 100000,\\n \\"ClientId\\": \\"c-0001eg6mcvjs93f46s2d\\",\\n \\"ClusterId\\": \\"cl-000gkcofngi04j6k680a\\"\\n },\\n \\"CommonFileSystemDetail\\": {\\n \\"FullOnIncrementFail\\": true,\\n \\"FetchSliceSize\\": 100000\\n }\\n },\\n \\"SourceType\\": \\"UDM_ECS\\",\\n \\"CrossAccountType\\": \\"CROSS_ACCOUNT\\",\\n \\"CrossAccountUserId\\": 0,\\n \\"CrossAccountRoleName\\": \\"hbrcrossrole\\",\\n \\"CreatedByTag\\": false,\\n \\"HitTags\\": [\\n {\\n \\"Key\\": \\"env\\",\\n \\"Value\\": \\"prod\\",\\n \\"Operator\\": \\"EQUAL\\"\\n }\\n ]\\n }\\n ],\\n \\"NextToken\\": \\"caeba0bbb2be03f84eb48b699f0a\\",\\n \\"MaxResults\\": 10,\\n \\"TotalCount\\": 38,\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"5225929A-4EBD-55EE-9FE1-4A130E582A76\\"\\n}","type":"json"}]', ], 'DescribeRecoverableOtsInstances' => [ 'methods' => ['get', 'post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'abilityTreeCode' => '119714', 'abilityTreeNodes' => ['FEATUREhbrAW9I1R'], 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'CrossAccountType', 'in' => 'query', 'schema' => ['description' => 'Specifies whether data is backed up within the same Alibaba Cloud account or across Alibaba Cloud accounts. Valid values:'."\n" ."\n" .'* SELF_ACCOUNT: Data is backed up within the same Alibaba Cloud account.'."\n" .'* CROSS_ACCOUNT: Data is backed up across Alibaba Cloud accounts.'."\n", 'type' => 'string', 'required' => false, 'example' => 'CROSS_ACCOUNT'], ], [ 'name' => 'CrossAccountUserId', 'in' => 'query', 'schema' => ['description' => 'The ID of the source Alibaba Cloud account that authorizes the current Alibaba Cloud account to back up data across Alibaba Cloud accounts.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1440155109798732'], ], [ 'name' => 'CrossAccountRoleName', 'in' => 'query', 'schema' => ['description' => 'The name of the Resource Access Management (RAM) role that is created within the source Alibaba Cloud account and assigned to the current Alibaba Cloud account to authorize the current Alibaba Cloud account to back up data across Alibaba Cloud accounts.'."\n", 'type' => 'string', 'required' => false, 'example' => 'hbrcrossrole'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '14DC089E-5DD3-5028-AEDB-93D78E11DB2A'], 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" ."\n" .'* true'."\n" .'* false'."\n", 'type' => 'boolean', 'example' => 'true'], 'Code' => ['description' => 'The response code. The status code 200 indicates that the request was successful.'."\n", 'type' => 'string', 'example' => '200'], 'Message' => ['description' => 'The returned message. If the request was successful, "successful" is returned. If the request failed, an error message is returned.'."\n", 'type' => 'string', 'example' => 'successful'], 'OtsInstances' => [ 'description' => 'The list of Tablestore instances that can be restored and the tables in the instances.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The list of Tablestore instances that can be restored and the tables in the instances.'."\n", 'type' => 'object', 'properties' => [ 'InstanceName' => ['description' => 'The name of the Tablestore instance that can be restored.'."\n", 'type' => 'string', 'example' => 'instancename'], 'TableNames' => [ 'description' => 'The names of the tables in the Tablestore instance.'."\n", 'type' => 'array', 'items' => ['description' => 'The names of the tables in the Tablestore instance.'."\n", 'type' => 'string', 'example' => '["table1", "table2", "table3"]'], ], ], ], ], ], 'description' => '', ], ], ], 'title' => 'DescribeRecoverableOtsInstances', 'summary' => 'Queries the tables of a restorable Tablestore instance.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeRecoverableOtsInstances'], ], ], 'ramActions' => [], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"14DC089E-5DD3-5028-AEDB-93D78E11DB2A\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"OtsInstances\\": [\\n {\\n \\"InstanceName\\": \\"instancename\\",\\n \\"TableNames\\": [\\n \\"[\\\\\\"table1\\\\\\", \\\\\\"table2\\\\\\", \\\\\\"table3\\\\\\"]\\"\\n ]\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n 14DC089E-5DD3-5028-AEDB-93D78E11DB2A\\n true\\n 200\\n successful\\n \\n instancename\\n [\\"table1\\", \\"table2\\", \\"table3\\"]\\n \\n","errorExample":""}]', ], 'DescribeRegions' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'abilityTreeCode' => '95538', 'abilityTreeNodes' => ['FEATUREhbrKJCQWH', 'FEATUREhbr56LH1C', 'FEATUREhbr5DOJ9F', 'FEATUREhbrN8YWXB', 'FEATUREhbr88PDT6', 'FEATUREhbr461GQI', 'FEATUREhbrS7MI6C', 'FEATUREhbrFWIWBG', 'FEATUREhbrO5EHNR', 'FEATUREhbr7WEYAR', 'FEATUREhbrAW9I1R', 'FEATUREhbrFJ9107', 'FEATUREhbrB1KQ9G', 'FEATUREhbrQ3MV3B', 'FEATUREhbr3BJQCT', 'FEATUREhbrF83GXN', 'FEATUREhbrIA0YQI', 'FEATUREhbrI97IXK', 'FEATUREhbrTH4MM4', 'FEATUREhbrAL60OZ'], 'tenantRelevance' => 'publicInformation', ], 'parameters' => [], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Code' => ['description' => 'The response code. The status code 200 indicates that the request was successful.'."\n", 'type' => 'string', 'example' => '200'], 'Message' => ['description' => 'The returned message. If the request was successful, "successful" is returned. If the request failed, an error message is returned.'."\n", 'type' => 'string', 'example' => 'successful'], 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'B3395EC6-7A4A-5282-A9AB-7A442F2CFC90'], 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" ."\n" .'* true'."\n" .'* false'."\n", 'type' => 'boolean', 'example' => 'true'], 'Regions' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'Region' => [ 'description' => 'The regions returned.'."\n", 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'LocalName' => ['description' => 'The region name.'."\n", 'type' => 'string', 'example' => 'China (Hangzhou)'], 'RegionId' => ['description' => 'The region ID.'."\n", 'type' => 'string', 'example' => 'cn-hangzhou'], ], ], ], ], ], ], 'description' => '', ], ], ], 'title' => 'DescribeRegions', 'summary' => 'Queries available regions.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeRegions'], ], ], 'ramActions' => [], 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"B3395EC6-7A4A-5282-A9AB-7A442F2CFC90\\",\\n \\"Success\\": true,\\n \\"Regions\\": {\\n \\"Region\\": [\\n {\\n \\"LocalName\\": \\"China (Hangzhou)\\",\\n \\"RegionId\\": \\"cn-hangzhou\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 200\\n successful\\n B3395EC6-7A4A-5282-A9AB-7A442F2CFC90\\n true\\n \\n 11\\n China (Hangzhou)\\n cn-hangzhou\\n \\n","errorExample":""}]', ], 'DescribeRestoreJobs2' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '95541', 'abilityTreeNodes' => ['FEATUREhbrB1KQ9G', 'FEATUREhbrS7MI6C', 'FEATUREhbr3BJQCT', 'FEATUREhbrQ3MV3B', 'FEATUREhbr56LH1C', 'FEATUREhbrFWIWBG', 'FEATUREhbrAW9I1R'], ], 'parameters' => [ [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => ['description' => 'The page number. Pages start from 1. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'minimum' => '1', 'default' => '1', 'example' => '1', 'title' => ''], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => ['description' => 'The number of entries per page. Valid values: 1 to 99. Default value: 10.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100', 'minimum' => '1', 'default' => '10', 'example' => '10', 'title' => ''], ], [ 'name' => 'RestoreType', 'in' => 'query', 'schema' => ['description' => 'The data source type. Valid values:'."\n" ."\n" .'- **ECS\\_FILE**: Restores ECS files.'."\n" ."\n" .'- **OSS**: Restores OSS objects.'."\n" ."\n" .'- **NAS**: Restores NAS files.'."\n" ."\n" .'- **COMMON\\_FILE\\_SYSTEM**: Restores data to a CPFS file system.'."\n" ."\n" .'- **OTS\\_TABLE**: Restores an OTS table.'."\n" ."\n" .'- **UDM\\_ECS\\_ROLLBACK**: Restores an entire ECS instance.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'ECS_FILE', 'title' => ''], ], [ 'name' => 'Filters', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => 'The filter conditions.', 'type' => 'array', 'items' => [ 'description' => 'A filter for querying restore jobs.', 'type' => 'object', 'properties' => [ 'Key' => ['description' => 'The filter key. Valid values:'."\n" ."\n" .'- **RegionId**: region ID'."\n" ."\n" .'- **PlanId**: backup plan ID'."\n" ."\n" .'- **JobId**: backup job ID'."\n" ."\n" .'- **VaultId**: vault ID'."\n" ."\n" .'- **InstanceId**: ECS instance ID'."\n" ."\n" .'- **Bucket**: OSS bucket name'."\n" ."\n" .'- **FileSystemId**: file system ID'."\n" ."\n" .'- **Status**: job status'."\n" ."\n" .'- **CompleteTime**: completion time', 'type' => 'string', 'required' => false, 'example' => 'VaultId', 'title' => ''], 'Values' => [ 'description' => 'An array of values for the specified filter key.', 'type' => 'array', 'items' => ['description' => 'A value to match.', 'type' => 'string', 'required' => false, 'example' => '["v-*********************"]', 'title' => ''], 'required' => false, 'maxItems' => 500, 'title' => '', 'example' => '', ], 'Operator' => ['description' => 'The matching method. The default value is IN. Valid values:'."\n" ."\n" .'- **EQUAL**: Equal to'."\n" ."\n" .'- **NOT\\_EQUAL**: Not equal to'."\n" ."\n" .'- **GREATER\\_THAN**: Greater than'."\n" ."\n" .'- **GREATER\\_THAN\\_OR\\_EQUAL**: Greater than or equal to'."\n" ."\n" .'- **LESS\\_THAN**: Less than'."\n" ."\n" .'- **LESS\\_THAN\\_OR\\_EQUAL**: Less than or equal to'."\n" ."\n" .'- **BETWEEN**: The value is within a specified range. The `Values` parameter must be a JSON array in the `[min, max]` format.'."\n" ."\n" .'- **IN**: The value is in a specified set. The `Values` parameter must be an array.'."\n" ."\n" .'> The IN operator is not supported when `Key` is **CompleteTime**.', 'type' => 'string', 'required' => false, 'example' => 'IN', 'title' => ''], ], 'required' => false, 'title' => '', 'example' => '', ], 'required' => false, 'maxItems' => 5, 'title' => '', 'example' => '', ], ], [ 'name' => 'Edition', 'in' => 'query', 'schema' => ['description' => 'The edition. Valid values: `BASIC` and `STANDARD`. Default value: `STANDARD`.', 'type' => 'string', 'example' => 'STANDARD', 'title' => '', 'required' => false], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E', 'title' => ''], 'Success' => ['description' => 'Indicates whether the request was successful.'."\n" ."\n" .'- true: The request was successful.'."\n" ."\n" .'- false: The request failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'Code' => ['description' => 'The return code. A value of 200 indicates that the request was successful.', 'type' => 'string', 'example' => '200', 'title' => ''], 'Message' => ['description' => 'The response message. If the request is successful, "successful" is returned. Otherwise, an error message is returned.', 'type' => 'string', 'example' => 'successful', 'title' => ''], 'PageNumber' => ['description' => 'The page number of the returned page. Pages start from 1. Default: 1.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'PageSize' => ['description' => 'The number of entries per page. Valid values: 1 to 99. Default: 10.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'TotalCount' => ['description' => 'The total number of entries that match the query.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'RestoreJobs' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'RestoreJob' => [ 'description' => 'A list of restore jobs.', 'example' => '{\'RestoreJob\': []}', 'type' => 'array', 'items' => [ 'description' => 'The details of a restore job.', 'type' => 'object', 'properties' => [ 'SnapshotHash' => ['description' => 'The hash value of the backup snapshot.', 'type' => 'string', 'example' => 'f2fe...', 'title' => ''], 'Status' => ['description' => 'The status of the restore job. Valid values:'."\n" ."\n" .'- **COMPLETE**: The job is complete.'."\n" ."\n" .'- **PARTIAL\\_COMPLETE**: The job is partially complete.'."\n" ."\n" .'- **FAILED**: The job failed.', 'type' => 'string', 'example' => 'COMPLETE', 'title' => ''], 'ErrorMessage' => ['description' => 'The error message for the restore job.', 'type' => 'string', 'example' => 'PARTIAL_COMPLETE', 'title' => ''], 'ActualItems' => ['description' => 'The actual number of files restored. This parameter is returned only if **SourceType** is set to **ECS\\_FILE**.', 'type' => 'integer', 'format' => 'int64', 'example' => '6', 'title' => ''], 'VaultId' => ['description' => 'The ID of the backup vault.', 'type' => 'string', 'example' => 'v-0006******q', 'title' => ''], 'ActualBytes' => ['description' => 'The actual amount of data restored after deduplication, in bytes.', 'type' => 'integer', 'format' => 'int64', 'example' => '600', 'title' => ''], 'UdmDetail' => ['description' => 'The details of the entire machine backup.', 'type' => 'string', 'example' => '{\\"doCopy\\":true,\\"doBackup\\":false,\\"instanceName\\":\\"instance example\\",\\"appConsistent\\":false,\\"destinationRegionId\\":\\"cn-shanghai\\",\\"enableFsFreeze\\":true,\\"osNameEn\\":\\"Windows Server 2019 Data Center Edition 64bit Chinese Edition\\",\\"osName\\":\\"Windows Server 2019 Data Center Edition 64bit Chinese Edition\\",\\"diskIdList\\":[],\\"backupVaultId\\":\\"\\",\\"snapshotGroup\\":true,\\"destinationRetention\\":35,\\"platform\\":\\"Windows Server 2012\\",\\"timeoutInSeconds\\":60,\\"backupRetention\\":1,\\"osType\\":\\"windows\\",\\"preScriptPath\\":\\"\\",\\"postScriptPath\\":\\"\\",\\"enableWriters\\":true,\\"ecsDeleted\\":false}', 'title' => ''], 'SourceType' => ['description' => 'The type of the data source. Valid values:'."\n" ."\n" .'- **ECS\\_FILE**: ECS files'."\n" ."\n" .'- **OSS**: OSS objects'."\n" ."\n" .'- **NAS**: NAS files'."\n" ."\n" .'- **OTS\\_TABLE**: Tablestore tables'."\n" ."\n" .'- **UDM\\_ECS**: ECS instance', 'type' => 'string', 'example' => 'ECS_FILE', 'title' => ''], 'Options' => ['description' => 'The advanced restore options. This parameter is returned only if **SourceType** is set to **ECS\\_FILE**. It indicates whether Volume Shadow Copy Service (VSS) was used.'."\n" ."\n" .'- This feature is available only for Windows ECS instances.'."\n" ."\n" .'- The `["UseVSS":true]` option indicates that VSS was used to ensure data consistency, which is useful when the source data changes during the backup process.'."\n" ."\n" .'- If you use VSS, you cannot restore files from multiple directories at the same time.', 'type' => 'string', 'example' => '{"UseVSS":false}', 'title' => ''], 'SourceInstanceId' => ['description' => 'The ID of the source instance.', 'type' => 'string', 'example' => 'i-2ze3m7ktcgw******cs', 'title' => ''], 'RestoreType' => ['description' => 'The type of the restore job.', 'type' => 'string', 'example' => 'ECS_FILE', 'title' => ''], 'TargetCreateTime' => ['description' => 'The time when the destination file system was created. This parameter is returned only for NAS backups.', 'type' => 'integer', 'format' => 'int64', 'example' => '1634714531', 'title' => ''], 'ItemsDone' => ['description' => 'The number of files that have been restored. This parameter is returned only if **SourceType** is set to **ECS\\_FILE**.', 'type' => 'integer', 'format' => 'int64', 'example' => '8', 'title' => ''], 'BytesTotal' => ['description' => 'The total size of the data source, in bytes.', 'type' => 'integer', 'format' => 'int64', 'example' => '1000', 'title' => ''], 'Exclude' => ['description' => 'The paths to files that were excluded from the restore job. This parameter is returned only if **SourceType** is set to **ECS\\_FILE**. Each path can be up to 255 characters long.', 'type' => 'string', 'example' => '["/var", "/proc"]', 'title' => ''], 'ParentId' => ['description' => 'The ID of the parent job.', 'type' => 'string', 'example' => 'r-0003hd2an3x4dyv0l18b', 'title' => ''], 'CompleteTime' => ['description' => 'The time when the restore job completed. This is a UNIX timestamp in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1554347313', 'title' => ''], 'CreatedTime' => ['description' => 'The time when the restore job was created. This is a UNIX timestamp in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1554347313', 'title' => ''], 'TargetBucket' => ['description' => 'The destination bucket. This parameter is returned only for OSS backups.', 'type' => 'string', 'example' => 'target-bucket', 'title' => ''], 'ClusterId' => ['description' => 'The ID of the client group used for the restore job.', 'type' => 'string', 'example' => 'cl-000******hp6', 'title' => ''], 'TargetFileSystemId' => ['description' => 'The ID of the destination file system. This parameter is returned only for NAS backups.', 'type' => 'string', 'example' => '0be9****9c9', 'title' => ''], 'Progress' => ['description' => 'The progress of the restore job, where a value of 10000 indicates 100% completion.', 'type' => 'integer', 'format' => 'int32', 'example' => '10000', 'title' => ''], 'ExpireTime' => ['description' => 'The time when the restore job expires.', 'type' => 'integer', 'format' => 'int64', 'example' => '1634714531', 'title' => ''], 'TargetDataSourceId' => ['description' => 'The ID of the destination data source.', 'type' => 'string', 'example' => 'ds-000*****997', 'title' => ''], 'TargetPrefix' => ['description' => 'The destination prefix. This parameter is returned only for OSS backups.', 'type' => 'string', 'example' => '"/target"', 'title' => ''], 'TargetPath' => ['description' => 'The destination path of the restore job.', 'type' => 'string', 'example' => '"D:\\\\rebk"', 'title' => ''], 'ErrorFile' => ['description' => 'The list of files that failed to be restored.', 'type' => 'string', 'example' => '"test.csv"', 'title' => ''], 'StartTime' => ['description' => 'The time when the restore job started. This is a UNIX timestamp in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1554347313', 'title' => ''], 'UpdatedTime' => ['description' => 'The time when the restore job was last updated. This is a UNIX timestamp in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1554347313', 'title' => ''], 'SnapshotId' => ['description' => 'The ID of the snapshot used for the restore.', 'type' => 'string', 'example' => 's-0002******ga88', 'title' => ''], 'RestoreId' => ['description' => 'The ID of the restore job.', 'type' => 'string', 'example' => 'r-0003*****8a', 'title' => ''], 'TargetClientId' => ['description' => 'The ID of the destination client.', 'type' => 'string', 'example' => 'c-000e*****397', 'title' => ''], 'ItemsTotal' => ['description' => 'The total number of files in the data source. This parameter is returned only if **SourceType** is set to **ECS\\_FILE**.', 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'title' => ''], 'Include' => ['description' => 'The paths to the files that are included in the restore job.', 'type' => 'string', 'example' => '["/home/alice/*.pdf", "/home/bob/*.txt"]', 'title' => ''], 'BytesDone' => ['description' => 'The amount of data restored, in bytes.', 'type' => 'integer', 'format' => 'int64', 'example' => '800', 'title' => ''], 'TargetInstanceName' => ['description' => 'The name of the destination Tablestore instance.', 'type' => 'string', 'example' => 'instancename', 'title' => ''], 'TargetTableName' => ['description' => 'The data table in the destination Tablestore instance.', 'type' => 'string', 'example' => 'tablename', 'title' => ''], 'Speed' => ['description' => 'The average restore speed, in KB/s.', 'type' => 'integer', 'format' => 'int64', 'example' => '500', 'title' => ''], 'TargetTime' => ['description' => 'The point in time to which the Tablestore instance is restored. This is a UNIX timestamp in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1642560261', 'title' => ''], 'OtsDetail' => [ 'description' => 'The details of the Tablestore restore.', 'type' => 'object', 'properties' => [ 'BatchChannelCount' => ['description' => 'The number of channels processed by each Tablestore restore job.', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''], 'OverwriteExisting' => ['description' => 'Indicates whether existing data in the destination table was overwritten.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], ], 'title' => '', 'example' => '', ], 'CrossAccountType' => [ 'description' => 'The type of the cross-account backup. Valid values:'."\n" ."\n" .'- SELF\\_ACCOUNT: a backup within the same account'."\n" ."\n" .'- CROSS\\_ACCOUNT: a cross-account backup', 'enumValueTitles' => [], 'type' => 'string', 'example' => 'SELF_ACCOUNT', 'title' => '', ], 'CrossAccountUserId' => ['description' => 'The ID of the Alibaba Cloud account that owns the backup data. This parameter is returned for cross-account restores.', 'type' => 'integer', 'format' => 'int64', 'example' => '158975xxxxxx4625', 'title' => ''], 'CrossAccountRoleName' => ['description' => 'The name of the RAM role that was assumed in the source account to perform the cross-account restore.', 'type' => 'string', 'example' => 'BackupRole', 'title' => ''], 'Report' => [ 'description' => 'The report of the restore job.', 'type' => 'object', 'properties' => [ 'TotalFiles' => ['description' => 'The path to the list of all files for a file-based restore.', 'type' => 'string', 'example' => '/temp/report/158975xxxxxx4625/job-0001hfxxxxxymsspjjtl/job-0001hfxxxxxymsspjjtl_total.csv', 'title' => ''], 'SuccessFiles' => ['description' => 'The path to the list of successfully restored files.', 'type' => 'string', 'example' => '/temp/report/158975xxxxxx4625/r-0001hfxxxxxymsspjjtl/job-0001hfxxxxxymsspjjtl_success.zip'."\n", 'title' => ''], 'FailedFiles' => ['description' => 'The path to the list of files that failed to be restored.', 'type' => 'string', 'example' => '/temp/report/158975xxxxxx4625/r-0001hfxxxxxymsspjjtl/job-0001hfxxxxxymsspjjtl_failed.zip', 'title' => ''], 'SkippedFiles' => ['description' => 'The path to the list of skipped files.', 'type' => 'string', 'example' => '/temp/report/158975xxxxxx4625/r-0001hfxxxxxymsspjjtl/job-0001hfxxxxxymsspjjtl_skipped.zip', 'title' => ''], 'ReportTaskStatus' => ['description' => 'The status of the report generation task.', 'type' => 'string', 'example' => 'COMPLETE', 'title' => ''], ], 'title' => '', 'example' => '', ], 'MeteringBytesDone' => ['description' => 'The billable amount of restored data, in bytes. This parameter is returned only when StorageClass is set to ARCHIVE. The value is rounded up to the nearest 1 MB.', 'type' => 'integer', 'format' => 'int64', 'example' => '1048576', 'title' => ''], 'MeteringBytesTotal' => ['description' => 'The total billable amount of data in the data source, in bytes. This parameter is returned only when StorageClass is set to ARCHIVE. The value is rounded up to the nearest 1 MB.', 'type' => 'integer', 'format' => 'int64', 'example' => '1048576', 'title' => ''], 'StorageClass' => ['description' => 'The storage class of the backup data. Valid values:'."\n" ."\n" .'- **STANDARD**: Standard storage.'."\n" ."\n" .'- **ARCHIVE**: Archive storage.', 'type' => 'string', 'example' => 'STANDARD', 'title' => ''], 'FailbackDetail' => ['description' => 'The details of the VMware failback job.', 'type' => 'string', 'example' => '{"cpu":4,"extra":"{\\"restoreVMNamePrefix\\":\\"627-\\",\\"dataCenterName\\":\\"SDDC-Datacenter\\",\\"dataStoreId\\":\\"datastore-50\\",\\"folderId\\":\\"group-v49\\",\\"resourcePoolId\\":\\"resgroup-46\\",\\"locationName\\":\\"vcenter.pc-uf600arcwi9td3eyj641.acvs.aliyuncs.com/SDDC-Datacenter/Workloads\\",\\"computeResourceName\\":\\"SDDC-Datacenter/Default_c-uf600arcwi9td3eyj640\\",\\"dataStoreName\\":\\"Default_c-uf600arcwi9td3eyj640/WorkloadDatastore\\",\\"networkMoReference\\":\\"DistributedVirtualPortgroup:dvportgroup-1001\\",\\"useHotAdd\\":false}","instanceId":"i-2vc357i2eannmmotcagz","memoryInMB":8192,"serverId":"0fdc0c86-eb92-4e05-91ab-eeaf9fb6ad01","uefiBoot":false}', 'title' => ''], 'TargetInstanceId' => ['description' => 'The ID of the destination instance.', 'type' => 'string', 'example' => 'i-2ze3m7ktcgw******cs', 'title' => ''], 'SourceResourceId' => ['description' => 'The ID of the source resource.', 'type' => 'string', 'example' => 'i-123***7890', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', ], ], 'description' => 'A container for the restore job details.', 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'title' => 'DescribeRestoreJobs2', 'summary' => 'Queries restore jobs that match specified criteria.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeRestoreJobs2'], ], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'hbr:DescribeRestoreJobs2', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'HBR', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 1,\\n \\"TotalCount\\": 1,\\n \\"RestoreJobs\\": {\\n \\"RestoreJob\\": [\\n {\\n \\"SnapshotHash\\": \\"f2fe...\\",\\n \\"Status\\": \\"COMPLETE\\",\\n \\"ErrorMessage\\": \\"PARTIAL_COMPLETE\\",\\n \\"ActualItems\\": 6,\\n \\"VaultId\\": \\"v-0006******q\\",\\n \\"ActualBytes\\": 600,\\n \\"UdmDetail\\": \\"{\\\\\\\\\\\\\\"doCopy\\\\\\\\\\\\\\":true,\\\\\\\\\\\\\\"doBackup\\\\\\\\\\\\\\":false,\\\\\\\\\\\\\\"instanceName\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"instance example\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"appConsistent\\\\\\\\\\\\\\":false,\\\\\\\\\\\\\\"destinationRegionId\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"cn-shanghai\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"enableFsFreeze\\\\\\\\\\\\\\":true,\\\\\\\\\\\\\\"osNameEn\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"Windows Server 2019 Data Center Edition 64bit Chinese Edition\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"osName\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"Windows Server 2019 Data Center Edition 64bit Chinese Edition\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"diskIdList\\\\\\\\\\\\\\":[],\\\\\\\\\\\\\\"backupVaultId\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"snapshotGroup\\\\\\\\\\\\\\":true,\\\\\\\\\\\\\\"destinationRetention\\\\\\\\\\\\\\":35,\\\\\\\\\\\\\\"platform\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"Windows Server 2012\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"timeoutInSeconds\\\\\\\\\\\\\\":60,\\\\\\\\\\\\\\"backupRetention\\\\\\\\\\\\\\":1,\\\\\\\\\\\\\\"osType\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"windows\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"preScriptPath\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"postScriptPath\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"enableWriters\\\\\\\\\\\\\\":true,\\\\\\\\\\\\\\"ecsDeleted\\\\\\\\\\\\\\":false}\\",\\n \\"SourceType\\": \\"ECS_FILE\\",\\n \\"Options\\": \\"{\\\\\\"UseVSS\\\\\\":false}\\",\\n \\"SourceInstanceId\\": \\"i-2ze3m7ktcgw******cs\\",\\n \\"RestoreType\\": \\"ECS_FILE\\",\\n \\"TargetCreateTime\\": 1634714531,\\n \\"ItemsDone\\": 8,\\n \\"BytesTotal\\": 1000,\\n \\"Exclude\\": \\"[\\\\\\"/var\\\\\\", \\\\\\"/proc\\\\\\"]\\",\\n \\"ParentId\\": \\"r-0003hd2an3x4dyv0l18b\\",\\n \\"CompleteTime\\": 1554347313,\\n \\"CreatedTime\\": 1554347313,\\n \\"TargetBucket\\": \\"target-bucket\\",\\n \\"ClusterId\\": \\"cl-000******hp6\\",\\n \\"TargetFileSystemId\\": \\"0be9****9c9\\",\\n \\"Progress\\": 10000,\\n \\"ExpireTime\\": 1634714531,\\n \\"TargetDataSourceId\\": \\"ds-000*****997\\",\\n \\"TargetPrefix\\": \\"\\\\\\"/target\\\\\\"\\",\\n \\"TargetPath\\": \\"\\\\\\"D:\\\\\\\\\\\\\\\\rebk\\\\\\"\\",\\n \\"ErrorFile\\": \\"\\\\\\"test.csv\\\\\\"\\",\\n \\"StartTime\\": 1554347313,\\n \\"UpdatedTime\\": 1554347313,\\n \\"SnapshotId\\": \\"s-0002******ga88\\",\\n \\"RestoreId\\": \\"r-0003*****8a\\",\\n \\"TargetClientId\\": \\"c-000e*****397\\",\\n \\"ItemsTotal\\": 10,\\n \\"Include\\": \\"[\\\\\\"/home/alice/*.pdf\\\\\\", \\\\\\"/home/bob/*.txt\\\\\\"]\\",\\n \\"BytesDone\\": 800,\\n \\"TargetInstanceName\\": \\"instancename\\",\\n \\"TargetTableName\\": \\"tablename\\",\\n \\"Speed\\": 500,\\n \\"TargetTime\\": 1642560261,\\n \\"OtsDetail\\": {\\n \\"BatchChannelCount\\": 2,\\n \\"OverwriteExisting\\": false\\n },\\n \\"CrossAccountType\\": \\"SELF_ACCOUNT\\",\\n \\"CrossAccountUserId\\": 0,\\n \\"CrossAccountRoleName\\": \\"BackupRole\\",\\n \\"Report\\": {\\n \\"TotalFiles\\": \\"/temp/report/158975xxxxxx4625/job-0001hfxxxxxymsspjjtl/job-0001hfxxxxxymsspjjtl_total.csv\\",\\n \\"SuccessFiles\\": \\"/temp/report/158975xxxxxx4625/r-0001hfxxxxxymsspjjtl/job-0001hfxxxxxymsspjjtl_success.zip\\\\n\\",\\n \\"FailedFiles\\": \\"/temp/report/158975xxxxxx4625/r-0001hfxxxxxymsspjjtl/job-0001hfxxxxxymsspjjtl_failed.zip\\",\\n \\"SkippedFiles\\": \\"/temp/report/158975xxxxxx4625/r-0001hfxxxxxymsspjjtl/job-0001hfxxxxxymsspjjtl_skipped.zip\\",\\n \\"ReportTaskStatus\\": \\"COMPLETE\\"\\n },\\n \\"MeteringBytesDone\\": 1048576,\\n \\"MeteringBytesTotal\\": 1048576,\\n \\"StorageClass\\": \\"STANDARD\\",\\n \\"FailbackDetail\\": \\"{\\\\\\"cpu\\\\\\":4,\\\\\\"extra\\\\\\":\\\\\\"{\\\\\\\\\\\\\\"restoreVMNamePrefix\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"627-\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"dataCenterName\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"SDDC-Datacenter\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"dataStoreId\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"datastore-50\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"folderId\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"group-v49\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"resourcePoolId\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"resgroup-46\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"locationName\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"vcenter.pc-uf600arcwi9td3eyj641.acvs.aliyuncs.com/SDDC-Datacenter/Workloads\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"computeResourceName\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"SDDC-Datacenter/Default_c-uf600arcwi9td3eyj640\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"dataStoreName\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"Default_c-uf600arcwi9td3eyj640/WorkloadDatastore\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"networkMoReference\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"DistributedVirtualPortgroup:dvportgroup-1001\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"useHotAdd\\\\\\\\\\\\\\":false}\\\\\\",\\\\\\"instanceId\\\\\\":\\\\\\"i-2vc357i2eannmmotcagz\\\\\\",\\\\\\"memoryInMB\\\\\\":8192,\\\\\\"serverId\\\\\\":\\\\\\"0fdc0c86-eb92-4e05-91ab-eeaf9fb6ad01\\\\\\",\\\\\\"uefiBoot\\\\\\":false}\\",\\n \\"TargetInstanceId\\": \\"i-2ze3m7ktcgw******cs\\",\\n \\"SourceResourceId\\": \\"i-123***7890\\"\\n }\\n ]\\n }\\n}","type":"json"}]', ], 'DescribeTask' => [ 'methods' => ['post', 'get'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'systemTags' => [ 'operationType' => 'get', 'abilityTreeCode' => '95552', 'abilityTreeNodes' => ['FEATUREhbr3BJQCT'], ], 'parameters' => [ [ 'name' => 'Token', 'in' => 'query', 'schema' => ['description' => 'The access token.'."\n", 'type' => 'string', 'required' => false, 'example' => '01W3ZZOQ'], ], [ 'name' => 'TaskId', 'in' => 'query', 'schema' => ['description' => 'The ID of the job.'."\n", 'type' => 'string', 'required' => false, 'example' => 't-*********************', 'docRequired' => true], ], [ 'name' => 'ResourceGroupId', 'in' => 'query', 'schema' => ['description' => 'The ID of the resource group.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rg-acfmvywqfey5njq'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Progress' => ['description' => 'The progress of the job. Valid values: 0 to 100. Unit: percentage (%). If the job fails, the value -1 is returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '100'], 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E'], 'CompletedTime' => ['description' => 'The time when the task was complete. The time is a UNIX timestamp. Unit: seconds.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1615607706'], 'Result' => ['description' => 'The result of the job.'."\n", 'type' => 'string', 'example' => '{}'], 'Description' => ['description' => 'The status of the job. Valid values:'."\n" ."\n" .'* **created**: The job is created.'."\n" .'* **expired**: The job expires.'."\n" .'* **completed**: The job is completed.'."\n" .'* **cancelled**: The job is canceled.'."\n", 'type' => 'string', 'example' => 'completed'], 'UpdatedTime' => ['description' => 'The time when the job was updated. This value is a UNIX timestamp. Unit: seconds.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1615607706'], 'Success' => ['description' => 'Indicates whether the call is successful.'."\n" ."\n" .'* true: The call is successful.'."\n" .'* false: The call fails.'."\n", 'type' => 'boolean', 'example' => 'true'], 'Code' => ['description' => 'HttpCode'."\n", 'type' => 'string', 'example' => '200'], 'Message' => ['description' => 'The message that is returned. If the call is successful, "successful" is returned. If the call fails, an error message is returned.'."\n", 'type' => 'string', 'example' => 'successful'], 'Name' => ['description' => 'The name of the job.'."\n", 'type' => 'string', 'example' => 'InstallBackupClientsTask'], 'CreatedTime' => ['description' => 'The time when the job was created. This value is a UNIX timestamp. Unit: seconds.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1615607706'], ], 'description' => '', ], ], ], 'title' => 'DescribeTask', 'summary' => 'Queries an asynchronous job. ', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeTask'], ], ], 'ramActions' => [], 'responseDemo' => '[{"type":"json","example":"{\\n \\"Progress\\": 100,\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\",\\n \\"CompletedTime\\": 1615607706,\\n \\"Result\\": \\"{}\\",\\n \\"Description\\": \\"completed\\",\\n \\"UpdatedTime\\": 1615607706,\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"Name\\": \\"InstallBackupClientsTask\\",\\n \\"CreatedTime\\": 1615607706\\n}","errorExample":""},{"type":"xml","example":"\\n 100\\n 473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\n 1615607706\\n {}\\n completed\\n 1615607706\\n true\\n 200\\n successful\\n InstallBackupClientsTask\\n 1615607706\\n","errorExample":""}]', ], 'DescribeUdmSnapshots' => [ 'summary' => 'Queries the snapshots of full backups.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '95555', 'abilityTreeNodes' => ['FEATUREhbrB1KQ9G'], ], 'parameters' => [ [ 'name' => 'SourceType', 'in' => 'query', 'schema' => ['description' => 'The type of the data source. Valid values:'."\n" ."\n" .'- **UDM\\_ECS**: ECS instance backup'."\n" ."\n" .'- **UDM\\_ECS\\_DISK**: a disk backup subtask of an ECS instance backup'."\n" ."\n" .'- **UDM\\_DISK**: disk backup', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'UDM_ECS', 'title' => ''], ], [ 'name' => 'StartTime', 'in' => 'query', 'schema' => ['description' => 'The beginning of the time range to query. This value is a UNIX timestamp in seconds.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '1642057551', 'title' => ''], ], [ 'name' => 'EndTime', 'in' => 'query', 'schema' => ['description' => 'The end of the time range to query. This value is a UNIX timestamp in seconds.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '1643092168', 'title' => ''], ], [ 'name' => 'UdmRegionId', 'in' => 'query', 'schema' => ['description' => 'The region ID of the ECS instance.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'The ID of the ECS instance.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'i-bp18x2k7sw925ir7ofh8', 'title' => ''], ], [ 'name' => 'DiskId', 'in' => 'query', 'schema' => ['description' => 'The ID of the disk.', 'type' => 'string', 'required' => false, 'example' => 'd-bp1560750pclffpzxy70', 'title' => ''], ], [ 'name' => 'JobId', 'in' => 'query', 'schema' => ['description' => 'The ID of the backup job.', 'type' => 'string', 'required' => false, 'example' => 'job-*********************', 'title' => ''], ], [ 'name' => 'SnapshotIds', 'in' => 'formData', 'style' => 'json', 'schema' => ['description' => 'The list of snapshot IDs.', 'type' => 'object', 'required' => false, 'example' => '[\\"s-000e3vhhu62xsm6v92r0\\"]', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Code' => ['description' => 'The HTTP status code. A value of 200 indicates that the request was successful.', 'type' => 'string', 'example' => '200', 'title' => ''], 'Message' => ['description' => 'The message that is returned. If the request was successful, **successful** is returned. If the request failed, an error message is returned.', 'type' => 'string', 'example' => 'successful', 'title' => ''], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '51CDEECB-7001-51CC-94AC-2A0F2A4B71D2', 'title' => ''], 'TotalCount' => ['description' => 'The total number of snapshots.', 'type' => 'integer', 'format' => 'int64', 'example' => '3', 'title' => ''], 'Success' => ['description' => 'Indicates whether the request was successful.'."\n" ."\n" .'- true: The request was successful.'."\n" ."\n" .'- false: The request failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'Snapshots' => [ 'description' => 'The details of the snapshots.', 'type' => 'array', 'items' => [ 'description' => 'The details of the snapshots.', 'type' => 'object', 'properties' => [ 'Status' => ['description' => 'The status of the backup snapshot. Valid values:'."\n" ."\n" .'- **COMPLETE**: The backup is successful.'."\n" ."\n" .'- **PARTIAL\\_COMPLETE**: The backup is partially successful.'."\n" ."\n" .'- **FAILED**: The backup failed.', 'type' => 'string', 'example' => 'COMPLETE', 'title' => ''], 'SnapshotHash' => ['description' => 'The hash value of the snapshot.', 'type' => 'string', 'example' => 'f2fe...', 'title' => ''], 'BackupType' => ['description' => 'The backup type. The value **COMPLETE** indicates a full backup.', 'type' => 'string', 'example' => 'COMPLETE', 'title' => ''], 'CreateTime' => ['description' => 'The time when the backup snapshot was created.', 'type' => 'integer', 'format' => 'int64', 'example' => '1607436917', 'title' => ''], 'ActualBytes' => ['description' => 'The actual size of the snapshot. Unit: bytes.', 'type' => 'string', 'example' => '600', 'title' => ''], 'SourceType' => ['description' => 'The type of the data source. Valid values:'."\n" ."\n" .'- **UDM\\_ECS**: ECS instance backup'."\n" ."\n" .'- **UDM\\_ECS\\_DISK**: a disk backup subtask of an ECS instance backup'."\n" ."\n" .'- **UDM\\_DISK**: disk backup', 'type' => 'string', 'example' => 'UDM_ECS', 'title' => ''], 'Prefix' => ['description' => 'The prefix of the snapshot.', 'type' => 'string', 'example' => 'example/', 'title' => ''], 'DiskId' => ['description' => 'The ID of the disk. The disk can be a cloud disk or a local disk.', 'type' => 'string', 'example' => 'd-2ze86h5fga5rfwxxa8ef', 'title' => ''], 'BytesTotal' => ['description' => 'The total size of the data source. Unit: bytes.', 'type' => 'integer', 'format' => 'int64', 'example' => '1000', 'title' => ''], 'NativeSnapshotInfo' => ['description' => 'The information about the native snapshot.', 'type' => 'string', 'example' => '{'."\n" .' "sourceDiskId":"d-bp17misjuy636t82v7b0",'."\n" .' "lastModifiedTime":"2022-03-09T11:35:12Z",'."\n" .' "snapshotSN":"64588-429372675-857161235",'."\n" .' "snapshotId":"s-bp1fbtwv3e6xr6wpe9e0",'."\n" .' "creationTime":"2022-03-09T11:31:12Z",'."\n" .' "snapshotType":"user",'."\n" .' "usage":"none",'."\n" .' "description":"",'."\n" .' "sourceStorageType":"disk",'."\n" .' "tags":['."\n" .' {'."\n" .' "tagValue":"job-0007e0wqjl0imbrtkmnm",'."\n" .' "tagKey":"HBR JobId"'."\n" .' }'."\n" .' ],'."\n" .' "productCode":"",'."\n" .' "encrypted":false,'."\n" .' "sourceDiskType":"system",'."\n" .' "retentionDays":30,'."\n" .' "snapshotName":"Created-from-HBR-job:job-0007e0wqjl0imbrtkmnm",'."\n" .' "kMSKeyId":"",'."\n" .' "progress":"100%",'."\n" .' "category":"standard",'."\n" .' "sourceDiskSize":"20",'."\n" .' "status":"accomplished"'."\n" .' }', 'title' => ''], 'CompleteTime' => ['description' => 'The time when the backup snapshot was completed. This value is a UNIX timestamp in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1646895666', 'title' => ''], 'Retention' => ['description' => 'The retention period of the snapshot in days.', 'type' => 'integer', 'format' => 'int64', 'example' => '7', 'title' => ''], 'CreatedTime' => ['description' => 'The time when the backup snapshot was created. This value is a UNIX timestamp in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1642496679', 'title' => ''], 'RealSnapshotTime' => ['description' => 'The timestamp of the snapshot. This value is a UNIX timestamp in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1642496679', 'title' => ''], 'ParentSnapshotHash' => ['description' => 'The hash value of the parent snapshot.', 'type' => 'string', 'example' => 'f2fe..', 'title' => ''], 'InstanceId' => ['description' => 'The ID of the ECS instance.', 'type' => 'string', 'example' => 'i-bp1f0pe78dxizrsdcgxd', 'title' => ''], 'StartTime' => ['description' => 'The time when the snapshot was started. This value is a UNIX timestamp in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1554347313', 'title' => ''], 'UpdatedTime' => ['description' => 'The time when the backup snapshot was updated. This value is a UNIX timestamp in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1642496679', 'title' => ''], 'SnapshotId' => ['description' => 'The ID of the backup snapshot.', 'type' => 'string', 'example' => 's-00047mxg17p26*****b', 'title' => ''], 'JobId' => ['description' => 'The ID of the backup job.', 'type' => 'string', 'example' => 'job-00030j3chkt******2', 'title' => ''], 'NativeSnapshotId' => ['description' => 'The ID of the native snapshot.', 'type' => 'string', 'example' => 's-00047mg17p26x*****b', 'title' => ''], 'Detail' => [ 'description' => 'The details of the snapshot.', 'type' => 'object', 'properties' => [ 'DiskDevName' => ['description' => 'The name of the disk device.', 'type' => 'string', 'example' => '/dev/xvdb', 'title' => ''], 'DowngradeReason' => ['description' => 'The reason for the downgrade.', 'type' => 'string', 'example' => 'HBR.NoRamRoleBound', 'title' => ''], 'OsDiskId' => ['description' => 'The ID of the system disk.', 'type' => 'string', 'example' => 'd-bp1e6427vhd320hifvc', 'title' => ''], 'OsName' => ['description' => 'The name of the operating system.', 'type' => 'string', 'example' => 'Debian 10.10 64-bit (UEFI)', 'title' => ''], 'ContainOsDisk' => ['description' => 'Indicates whether the system disk is included.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'ConsistentLevel' => ['description' => 'The consistency level.', 'type' => 'string', 'example' => 'CRASH', 'title' => ''], 'VmName' => ['description' => 'The name of the instance.', 'type' => 'string', 'example' => 'BNSHSVR42 IPGUARD', 'title' => ''], 'DiskHbrSnapshotIdWithDeviceMap' => ['description' => 'The mapping between devices and backup point IDs.', 'type' => 'object', 'example' => '{'."\n" .' "/dev/xvdb":"s-0000u7y6wm3v1e7hxh5a", '."\n" .' "/dev/xvda":"s-0004bl6yr5pt89jjsv5a"'."\n" .'}', 'title' => ''], 'InstanceIdWithDiskIdListMap' => ['description' => 'The mapping between instance IDs and disk IDs.', 'type' => 'object', 'example' => '{'."\n" .' "i-bp1dlp0keohh7ids4uo6":"d-bp1e6427vhd320hifvs", '."\n" .' "i-bp1dlp0keohh7ids4uo6":"d-bp1e6427vhd320hifvd"'."\n" .'}', 'title' => ''], 'InstanceName' => ['description' => 'The name of the instance.', 'type' => 'string', 'example' => 'swh-hbr', 'title' => ''], 'OsType' => ['description' => 'The type of the operating system. Valid values: linux, windows.', 'type' => 'string', 'example' => 'windows', 'title' => ''], 'Platform' => ['description' => 'The operating system.', 'type' => 'string', 'example' => 'CentOS', 'title' => ''], 'OsNameEn' => ['description' => 'The English name of the operating system.', 'type' => 'string', 'example' => 'Debian 11.1 64 bit', 'title' => ''], 'HostName' => ['description' => 'The hostname.', 'type' => 'string', 'example' => 'iZbpxxxxxxxxxxxxxxxxe2Z', 'title' => ''], 'SystemDisk' => ['description' => 'Indicates whether the disk is a system disk.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'DiskIdList' => [ 'description' => 'The list of disk IDs that are included in the backup point.', 'type' => 'array', 'items' => ['description' => 'The ID of a disk that is included in the backup point.', 'type' => 'string', 'example' => 'd-bp1e6427vhd320hifvs', 'title' => ''], 'title' => '', 'example' => '', ], 'NativeSnapshotIdList' => [ 'description' => 'The list of native snapshot IDs. The native snapshot IDs in this list have a one-to-one correspondence with the disk IDs in the DiskIdList.', 'type' => 'array', 'items' => ['description' => 'The ID of the native snapshot.', 'type' => 'string', 'example' => 's-0004bl6yr5pt89jjsv5a', 'title' => ''], 'title' => '', 'example' => '', ], 'SnapshotGroupId' => ['description' => 'The ID of the snapshot group.', 'type' => 'string', 'example' => 'ssg-uf6856txcaq31uj***', 'title' => ''], 'InstanceType' => ['description' => 'The instance type of the source instance.', 'type' => 'string', 'example' => 'ecs.c6.xlarge', 'title' => ''], 'DiskCategory' => ['description' => 'The type of the source disk.', 'type' => 'string', 'example' => 'cloud_essd', 'title' => ''], 'PerformanceLevel' => ['description' => 'The performance level of the source disk.', 'type' => 'string', 'example' => 'PL0', 'title' => ''], 'InstantAccess' => ['description' => 'Indicates whether the backup is created for the instant clone feature.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], ], 'title' => '', 'example' => '', ], 'AdvancedRetentionType' => ['description' => 'The special retention type. This parameter is valid only for special retention backups. Valid values:'."\n" ."\n" .'- **WEEKLY**: weekly special retention backup'."\n" ."\n" .'- **MONTHLY**: monthly special retention backup'."\n" ."\n" .'- **YEARLY**: yearly special retention backup', 'type' => 'string', 'example' => 'WEEKLY', 'title' => ''], 'ExpireTime' => ['description' => 'The time when the backup expires.', 'type' => 'integer', 'format' => 'int64', 'example' => '1640334062', 'title' => ''], 'CanBeDeleted' => ['description' => 'Indicates whether the disk backup point can be deleted. This parameter is valid only if **SourceType** is set to **UDM\\_ECS\\_DISK**.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], 'ArchiveStatus' => ['description' => 'The archiving status.', 'type' => 'string', 'example' => 'ARCHIVED', 'title' => ''], 'ArchiveErrorMessage' => ['description' => 'The error message that is returned if the archiving fails.', 'type' => 'string', 'example' => 'InternalError', 'title' => ''], 'ArchiveTriggerTime' => ['description' => 'The time when the archiving was triggered.', 'type' => 'integer', 'format' => 'int64', 'example' => '1763373304', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"51CDEECB-7001-51CC-94AC-2A0F2A4B71D2\\",\\n \\"TotalCount\\": 3,\\n \\"Success\\": true,\\n \\"Snapshots\\": [\\n {\\n \\"Status\\": \\"COMPLETE\\",\\n \\"SnapshotHash\\": \\"f2fe...\\",\\n \\"BackupType\\": \\"COMPLETE\\",\\n \\"CreateTime\\": 1607436917,\\n \\"ActualBytes\\": \\"600\\",\\n \\"SourceType\\": \\"UDM_ECS\\",\\n \\"Prefix\\": \\"example/\\",\\n \\"DiskId\\": \\"d-2ze86h5fga5rfwxxa8ef\\",\\n \\"BytesTotal\\": 1000,\\n \\"NativeSnapshotInfo\\": \\"{\\\\n\\\\t\\\\t\\\\t\\\\t\\\\t\\\\\\"sourceDiskId\\\\\\":\\\\\\"d-bp17misjuy636t82v7b0\\\\\\",\\\\n\\\\t\\\\t\\\\t\\\\t\\\\t\\\\\\"lastModifiedTime\\\\\\":\\\\\\"2022-03-09T11:35:12Z\\\\\\",\\\\n\\\\t\\\\t\\\\t\\\\t\\\\t\\\\\\"snapshotSN\\\\\\":\\\\\\"64588-429372675-857161235\\\\\\",\\\\n\\\\t\\\\t\\\\t\\\\t\\\\t\\\\\\"snapshotId\\\\\\":\\\\\\"s-bp1fbtwv3e6xr6wpe9e0\\\\\\",\\\\n\\\\t\\\\t\\\\t\\\\t\\\\t\\\\\\"creationTime\\\\\\":\\\\\\"2022-03-09T11:31:12Z\\\\\\",\\\\n\\\\t\\\\t\\\\t\\\\t\\\\t\\\\\\"snapshotType\\\\\\":\\\\\\"user\\\\\\",\\\\n\\\\t\\\\t\\\\t\\\\t\\\\t\\\\\\"usage\\\\\\":\\\\\\"none\\\\\\",\\\\n\\\\t\\\\t\\\\t\\\\t\\\\t\\\\\\"description\\\\\\":\\\\\\"\\\\\\",\\\\n\\\\t\\\\t\\\\t\\\\t\\\\t\\\\\\"sourceStorageType\\\\\\":\\\\\\"disk\\\\\\",\\\\n\\\\t\\\\t\\\\t\\\\t\\\\t\\\\\\"tags\\\\\\":[\\\\n\\\\t\\\\t\\\\t\\\\t\\\\t\\\\t{\\\\n\\\\t\\\\t\\\\t\\\\t\\\\t\\\\t\\\\t\\\\\\"tagValue\\\\\\":\\\\\\"job-0007e0wqjl0imbrtkmnm\\\\\\",\\\\n\\\\t\\\\t\\\\t\\\\t\\\\t\\\\t\\\\t\\\\\\"tagKey\\\\\\":\\\\\\"HBR JobId\\\\\\"\\\\n\\\\t\\\\t\\\\t\\\\t\\\\t\\\\t}\\\\n\\\\t\\\\t\\\\t\\\\t\\\\t],\\\\n\\\\t\\\\t\\\\t\\\\t\\\\t\\\\\\"productCode\\\\\\":\\\\\\"\\\\\\",\\\\n\\\\t\\\\t\\\\t\\\\t\\\\t\\\\\\"encrypted\\\\\\":false,\\\\n\\\\t\\\\t\\\\t\\\\t\\\\t\\\\\\"sourceDiskType\\\\\\":\\\\\\"system\\\\\\",\\\\n\\\\t\\\\t\\\\t\\\\t\\\\t\\\\\\"retentionDays\\\\\\":30,\\\\n\\\\t\\\\t\\\\t\\\\t\\\\t\\\\\\"snapshotName\\\\\\":\\\\\\"Created-from-HBR-job:job-0007e0wqjl0imbrtkmnm\\\\\\",\\\\n\\\\t\\\\t\\\\t\\\\t\\\\t\\\\\\"kMSKeyId\\\\\\":\\\\\\"\\\\\\",\\\\n\\\\t\\\\t\\\\t\\\\t\\\\t\\\\\\"progress\\\\\\":\\\\\\"100%\\\\\\",\\\\n\\\\t\\\\t\\\\t\\\\t\\\\t\\\\\\"category\\\\\\":\\\\\\"standard\\\\\\",\\\\n\\\\t\\\\t\\\\t\\\\t\\\\t\\\\\\"sourceDiskSize\\\\\\":\\\\\\"20\\\\\\",\\\\n\\\\t\\\\t\\\\t\\\\t\\\\t\\\\\\"status\\\\\\":\\\\\\"accomplished\\\\\\"\\\\n\\\\t\\\\t\\\\t\\\\t}\\",\\n \\"CompleteTime\\": 1646895666,\\n \\"Retention\\": 7,\\n \\"CreatedTime\\": 1642496679,\\n \\"RealSnapshotTime\\": 1642496679,\\n \\"ParentSnapshotHash\\": \\"f2fe..\\",\\n \\"InstanceId\\": \\"i-bp1f0pe78dxizrsdcgxd\\",\\n \\"StartTime\\": 1554347313,\\n \\"UpdatedTime\\": 1642496679,\\n \\"SnapshotId\\": \\"s-00047mxg17p26*****b\\",\\n \\"JobId\\": \\"job-00030j3chkt******2\\",\\n \\"NativeSnapshotId\\": \\"s-00047mg17p26x*****b\\",\\n \\"Detail\\": {\\n \\"DiskDevName\\": \\"/dev/xvdb\\",\\n \\"DowngradeReason\\": \\"HBR.NoRamRoleBound\\",\\n \\"OsDiskId\\": \\"d-bp1e6427vhd320hifvc\\",\\n \\"OsName\\": \\"Debian 10.10 64-bit (UEFI)\\",\\n \\"ContainOsDisk\\": true,\\n \\"ConsistentLevel\\": \\"CRASH\\",\\n \\"VmName\\": \\"BNSHSVR42 IPGUARD\\",\\n \\"DiskHbrSnapshotIdWithDeviceMap\\": {\\n \\"/dev/xvdb\\": \\"s-0000u7y6wm3v1e7hxh5a\\",\\n \\"/dev/xvda\\": \\"s-0004bl6yr5pt89jjsv5a\\"\\n },\\n \\"InstanceIdWithDiskIdListMap\\": {\\n \\"i-bp1dlp0keohh7ids4uo6\\": \\"d-bp1e6427vhd320hifvd\\"\\n },\\n \\"InstanceName\\": \\"swh-hbr\\",\\n \\"OsType\\": \\"windows\\",\\n \\"Platform\\": \\"CentOS\\",\\n \\"OsNameEn\\": \\"Debian 11.1 64 bit\\",\\n \\"HostName\\": \\"iZbpxxxxxxxxxxxxxxxxe2Z\\",\\n \\"SystemDisk\\": true,\\n \\"DiskIdList\\": [\\n \\"d-bp1e6427vhd320hifvs\\"\\n ],\\n \\"NativeSnapshotIdList\\": [\\n \\"s-0004bl6yr5pt89jjsv5a\\"\\n ],\\n \\"SnapshotGroupId\\": \\"ssg-uf6856txcaq31uj***\\",\\n \\"InstanceType\\": \\"ecs.c6.xlarge\\",\\n \\"DiskCategory\\": \\"cloud_essd\\",\\n \\"PerformanceLevel\\": \\"PL0\\",\\n \\"InstantAccess\\": false\\n },\\n \\"AdvancedRetentionType\\": \\"WEEKLY\\",\\n \\"ExpireTime\\": 1640334062,\\n \\"CanBeDeleted\\": false,\\n \\"ArchiveStatus\\": \\"ARCHIVED\\",\\n \\"ArchiveErrorMessage\\": \\"InternalError\\",\\n \\"ArchiveTriggerTime\\": 1763373304\\n }\\n ]\\n}","type":"json"}]', 'title' => 'DescribeUdmSnapshots', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeUdmSnapshots'], ], ], 'ramActions' => [ [ 'operationType' => 'list', 'ramAction' => [ 'action' => 'hbr:DescribeUdmSnapshots', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'HBR', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], ], 'DescribeVaultReplicationRegions' => [ 'methods' => ['post', 'get'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'systemTags' => [ 'operationType' => 'get', 'abilityTreeCode' => '95568', 'abilityTreeNodes' => ['FEATUREhbrGSUVI2'], 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'Token', 'in' => 'query', 'schema' => ['description' => 'This parameter is deprecated.'."\n", 'type' => 'string', 'required' => false, 'example' => '01W3ZZOQ'], ], [ 'name' => 'VaultId', 'in' => 'query', 'schema' => ['description' => 'This parameter is deprecated.'."\n", 'type' => 'string', 'deprecated' => true, 'required' => false, 'example' => 'v-00030j3c******sn'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Code' => ['description' => 'The HTTP status code. The status code 200 indicates that the call is successful.'."\n", 'type' => 'string', 'example' => '200'], 'Message' => ['description' => 'The message that is returned. If the call is successful, "successful" is returned. If the call fails, an error message is returned.'."\n", 'type' => 'string', 'example' => 'successful'], 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => 'F4EEB401-DD21-588D-AE3B-1E835C7655E1'], 'Success' => ['description' => 'Indicates whether the call is successful.'."\n" ."\n" .'* true: The call is successful.'."\n" .'* false: The call fails.'."\n", 'type' => 'boolean', 'example' => 'true'], 'Regions' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'RegionId' => [ 'description' => 'The regions that support cross-region replication.'."\n", 'type' => 'array', 'items' => ['description' => 'The regions that support cross-region replication.'."\n", 'type' => 'string', 'example' => 'cn-hangzhou'], ], ], ], ], ], ], ], 'title' => 'DescribeVaultReplicationRegions', 'summary' => 'Queries the regions that support cross-region replication. ', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeVaultReplicationRegions'], ], ], 'ramActions' => [], 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"F4EEB401-DD21-588D-AE3B-1E835C7655E1\\",\\n \\"Success\\": true,\\n \\"Regions\\": {\\n \\"RegionId\\": [\\n \\"cn-hangzhou\\"\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 200\\n successful\\n F4EEB401-DD21-588D-AE3B-1E835C7655E1\\n true\\n cn-hangzhou\\n","errorExample":""}]', ], 'DescribeVaults' => [ 'summary' => 'Describes one or more backup vaults that meet specified criteria.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'paid', 'abilityTreeCode' => '95569', 'abilityTreeNodes' => ['FEATUREhbrFJ9107'], ], 'parameters' => [ [ 'name' => 'VaultId', 'in' => 'query', 'schema' => ['description' => 'The ID of the backup vault.', 'type' => 'string', 'required' => false, 'example' => 'v-*********************', 'title' => ''], ], [ 'name' => 'VaultRegionId', 'in' => 'query', 'schema' => ['description' => 'The ID of the region where the backup vault resides.', 'type' => 'string', 'required' => false, 'example' => 'cn-shanghai', 'title' => ''], ], [ 'name' => 'Status', 'in' => 'query', 'schema' => [ 'description' => 'The status of the backup vault.'."\n" ."\n" .'- **UNKNOWN**: The status is unknown.'."\n" ."\n" .'- **INITIALIZING**: The backup vault is being initialized.'."\n" ."\n" .'- **CREATED**: The backup vault has been created.'."\n" ."\n" .'- **ERROR**: An error occurred.', 'type' => 'string', 'required' => false, 'enum' => ['UNKNOWN', 'CREATED', 'ERROR'], 'example' => 'CREATED', 'title' => '', ], ], [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => ['description' => 'The page number. Pages start from page 1. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'minimum' => '1', 'default' => '1', 'example' => '1', 'title' => ''], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => ['description' => 'The number of entries per page. Valid values: 1 to 99. Default value: 10.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100', 'minimum' => '1', 'default' => '10', 'example' => '10', 'title' => ''], ], [ 'name' => 'VaultType', 'in' => 'query', 'schema' => ['description' => 'The type of the backup vault. Valid values:'."\n" ."\n" .'- **STANDARD**: standard backup vault. This type of vault can be used for ECS file backup, OSS backup, and NAS backup.'."\n" ."\n" .'- **OTS\\_BACKUP**: Tablestore backup vault. This type of vault is dedicated to Tablestore backup.', 'type' => 'string', 'required' => false, 'example' => 'STANDARD', 'title' => ''], ], [ 'name' => 'Tag', 'in' => 'formData', 'style' => 'repeatList', 'schema' => [ 'description' => 'The tags. You can specify a maximum of 20 tags.', 'type' => 'array', 'items' => [ 'description' => 'The tag.', 'type' => 'object', 'properties' => [ 'Key' => ['description' => 'The key of the tag.', 'type' => 'string', 'required' => false, 'example' => 'key1', 'title' => ''], 'Value' => ['description' => 'The value of the tag.', 'type' => 'string', 'required' => false, 'example' => 'value1', 'title' => ''], ], 'required' => false, 'title' => '', 'example' => '', ], 'required' => false, 'example' => '6a745bceffb042959b3b5206d6f12ad1', 'maxItems' => 21, 'title' => '', ], ], [ 'name' => 'ResourceGroupId', 'in' => 'query', 'schema' => ['description' => 'The ID of the resource group.', 'type' => 'string', 'required' => false, 'example' => 'rg-*********************', 'title' => ''], ], [ 'name' => 'VaultName', 'in' => 'query', 'schema' => ['description' => 'The name of the backup vault. The name must be 1 to 64 characters in length.', 'type' => 'string', 'required' => false, 'example' => 'vaultname', 'title' => ''], ], [ 'name' => 'VaultOwnerId', 'in' => 'query', 'schema' => ['description' => 'The ID of the Alibaba Cloud account that owns the backup vault.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '144******732', 'title' => ''], ], [ 'name' => 'Replication', 'in' => 'query', 'schema' => ['description' => 'Specifies whether to query the backup vaults that are used as replication destinations.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E', 'title' => ''], 'Success' => ['description' => 'Indicates whether the request was successful.'."\n" ."\n" .'- true: The request was successful.'."\n" ."\n" .'- false: The request failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'Code' => ['description' => 'The return code. A value of 200 indicates that the request was successful.', 'type' => 'string', 'example' => '200', 'title' => ''], 'Message' => ['description' => 'The message that is returned. If the request is successful, "successful" is returned. If the request fails, an error message is returned.', 'type' => 'string', 'example' => 'successful', 'title' => ''], 'PageNumber' => ['description' => 'The page number. Pages start from page 1. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'PageSize' => ['description' => 'The number of entries per page. Valid values: 1 to 99. Default value: 10.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], 'TotalCount' => ['description' => 'The total number of backup vaults that are returned.', 'type' => 'integer', 'format' => 'int32', 'example' => '8', 'title' => ''], 'Vaults' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'Vault' => [ 'description' => 'The list of backup vaults.', 'example' => '{\'Vault\': []}', 'type' => 'array', 'items' => [ 'description' => 'The list of backup vaults.', 'type' => 'object', 'properties' => [ 'Status' => ['description' => 'The status of the backup vault.'."\n" ."\n" .'- **UNKNOWN**: The status is unknown.'."\n" ."\n" .'- **INITIALIZING**: The backup vault is being initialized.'."\n" ."\n" .'- **CREATED**: The backup vault has been created.'."\n" ."\n" .'- **ERROR**: An error occurred.', 'type' => 'string', 'example' => 'CREATED', 'title' => ''], 'VaultId' => ['description' => 'The ID of the backup vault.', 'type' => 'string', 'example' => 'v-*********************', 'title' => ''], 'ChargeType' => ['description' => 'The billing method of the backup vault.', 'type' => 'string', 'example' => 'FREE', 'title' => ''], 'VaultType' => ['description' => 'The type of the backup vault. The value is fixed as **STANDARD**, which indicates a standard backup vault.', 'type' => 'string', 'example' => 'STANDARD', 'title' => ''], 'Dedup' => ['description' => 'Indicates whether the deduplication feature is enabled.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'ReplicationSourceVaultId' => ['description' => 'The ID of the source vault for geo-redundancy.', 'type' => 'string', 'example' => 'v-*********************', 'title' => ''], 'IndexUpdateTime' => ['description' => 'The time when the index was updated.', 'type' => 'integer', 'format' => 'int64', 'example' => '1639645628', 'title' => ''], 'Description' => ['description' => 'The description of the vault.', 'type' => 'string', 'example' => 'vault description', 'title' => ''], 'VaultStorageClass' => ['description' => 'The storage class of the backup vault. The value is fixed as **STANDARD**.', 'type' => 'string', 'example' => 'STANDARD', 'title' => ''], 'Retention' => ['description' => 'The retention period of the backup vault. Unit: days.', 'type' => 'integer', 'format' => 'int64', 'example' => '2', 'title' => ''], 'CreatedTime' => ['description' => 'The time when the backup vault was created. This value is a UNIX timestamp. Unit: seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1554347313', 'title' => ''], 'IndexLevel' => ['description' => 'The index level.'."\n" ."\n" .'- OFF: No index is created.'."\n" ."\n" .'- META: A metadata index is created.'."\n" ."\n" .'- ALL: A full-text index is created.', 'type' => 'string', 'example' => 'OFF', 'title' => ''], 'VaultName' => ['description' => 'The name of the backup vault.', 'type' => 'string', 'example' => 'vaultname', 'title' => ''], 'StorageSize' => ['description' => 'The usage of the backup vault. Unit: bytes.', 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'title' => ''], 'LatestReplicationTime' => ['description' => 'The time of the last geo-redundancy sync. This value is a UNIX timestamp. Unit: seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1554347313', 'title' => ''], 'VaultStatusMessage' => ['description' => 'The error message for the geo-redundant vault. This parameter is valid only for geo-redundant vaults. Valid values:'."\n" ."\n" .'- **UNKNOWN\\_ERROR**: An unknown error occurred.'."\n" ."\n" .'- **SOURCE\\_VAULT\\_ALREADY\\_HAS\\_REPLICATION**: Another replication destination is configured for the source vault.', 'type' => 'string', 'example' => 'SOURCE_VAULT_ALREADY_HAS_REPLICATION', 'title' => ''], 'Replication' => ['description' => 'Indicates whether the vault is a geo-redundant vault.'."\n" ."\n" .'- true: The vault is a geo-redundant vault.'."\n" ."\n" .'- false: The vault is a local backup vault.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], 'ReplicationSourceRegionId' => ['description' => 'The ID of the region where the source vault of the geo-redundant vault resides. This parameter is valid only for geo-redundant vaults.', 'type' => 'string', 'example' => 'cn-shanghai', 'title' => ''], 'VaultRegionId' => ['description' => 'The ID of the region where the backup vault resides.', 'type' => 'string', 'example' => 'cn-shanghai', 'title' => ''], 'UpdatedTime' => ['description' => 'The time when the backup vault was updated. This value is a UNIX timestamp. Unit: seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1554347313', 'title' => ''], 'ResourceGroupId' => ['description' => 'The ID of the resource group.', 'type' => 'string', 'example' => 'rg-*********************', 'title' => ''], 'BucketName' => ['description' => 'The name of the Object Storage Service (OSS) bucket used for the backup vault.', 'type' => 'string', 'example' => 'hbr-0005i51******t58', 'title' => ''], 'SearchEnabled' => ['description' => 'Indicates whether the backup search feature is enabled.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'IndexAvailable' => ['description' => 'Indicates whether the index is available. An index is available when it is not being updated.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'BytesDone' => ['description' => 'The backup data size. Unit: bytes.', 'type' => 'integer', 'format' => 'int64', 'example' => '20', 'title' => ''], 'Tags' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'Tag' => [ 'description' => 'The tags of the backup vault.', 'type' => 'array', 'items' => [ 'description' => 'The tags of the backup vault.', 'type' => 'object', 'properties' => [ 'Key' => ['description' => 'The tag key of the vault.'."\n" ."\n" .'- The key cannot start with `aliyun` or `acs:`.'."\n" ."\n" .'- The key cannot contain `http://` or `https://`.'."\n" ."\n" .'- The key cannot be an empty string.', 'type' => 'string', 'example' => 'aaa', 'title' => ''], 'Value' => ['description' => 'The tag value of the vault.'."\n" ."\n" .'- The value cannot start with `aliyun` or `acs:`.'."\n" ."\n" .'- The value cannot contain `http://` or `https://`.'."\n" ."\n" .'- The value cannot be an empty string.', 'type' => 'string', 'example' => 'a1', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], 'SourceTypes' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'SourceType' => [ 'description' => 'The types of data sources that are backed up to the vault.', 'type' => 'array', 'items' => ['description' => 'The type of the data source.', 'type' => 'string', 'example' => 'ECS_FILE', 'title' => ''], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], 'ReplicationProgress' => [ 'description' => 'The replication progress of the backup vault.', 'type' => 'object', 'properties' => [ 'HistoricalReplicationProgress' => ['description' => 'The replication progress of historical data in the backup vault. Valid values: 0 to 100.', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''], 'NewReplicationProgress' => ['description' => 'The most recent replication time of incremental data in the backup vault.', 'type' => 'integer', 'format' => 'int64', 'example' => '1579413159', 'title' => ''], ], 'title' => '', 'example' => '', ], 'BackupPlanStatistics' => [ 'description' => 'The statistics of backup plans for the backup vault.', 'type' => 'object', 'properties' => [ 'Oracle' => ['description' => 'The number of Oracle backup plans.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'LocalFile' => ['description' => 'The number of backup plans for on-premises servers.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'Nas' => ['description' => 'The number of NAS backup plans.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'CommonNas' => ['description' => 'The number of backup plans for general-purpose NAS file systems.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'Isilon' => ['description' => 'The number of Isilon backup plans.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'Oss' => ['description' => 'The number of OSS backup plans.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'SqlServer' => ['description' => 'The number of SQL Server backup plans.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'Csg' => ['description' => 'The number of Cloud Storage Gateway (CSG) backup plans.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'EcsFile' => ['description' => 'The number of ECS file backup plans.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'MySql' => ['description' => 'The number of MySQL backup plans.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'EcsHana' => ['description' => 'The number of SAP HANA backup plans.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'LocalVm' => ['description' => 'The number of backup plans for on-premises virtual machines.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'Ots' => ['description' => 'The number of Tablestore backup plans.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'Archive' => ['description' => 'The number of archive plans.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'CommonFileSystem' => ['description' => 'The number of Cloud Paralleled File System (CPFS) backup plans.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], ], 'title' => '', 'example' => '', ], 'TrialInfo' => [ 'description' => 'The free trial properties.', 'type' => 'object', 'properties' => [ 'TrialStartTime' => ['description' => 'The start time of the free trial.', 'type' => 'integer', 'format' => 'int64', 'example' => '1579413159', 'title' => ''], 'TrialVaultReleaseTime' => ['description' => 'The time when the trial backup vault is released.', 'type' => 'integer', 'format' => 'int64', 'example' => '1594965600', 'title' => ''], 'TrialExpireTime' => ['description' => 'The expiration time of the free trial.', 'type' => 'integer', 'format' => 'int64', 'example' => '1584597600', 'title' => ''], 'KeepAfterTrialExpiration' => ['description' => 'Indicates whether the backup vault is converted to a pay-as-you-go vault after the free trial ends.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], 'title' => '', 'example' => '', ], 'EncryptType' => ['description' => 'The encryption type of the backup vault.'."\n" ."\n" .'- NONE: No encryption is used.'."\n" ."\n" .'- HBR\\_PRIVATE: The backup vault is encrypted using a key that is managed by Hybrid Backup Recovery (HBR). This is the default value.'."\n" ."\n" .'- KMS: The backup vault is encrypted using a key that is managed by Key Management Service (KMS).', 'type' => 'string', 'example' => 'HBR_PRIVATE', 'title' => ''], 'WormEnabled' => ['description' => 'Indicates whether backup locking is enabled.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'SnapshotCount' => ['description' => 'The number of snapshots in the vault.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'CompressionAlgorithm' => ['description' => 'The compression algorithm that is used for the backup vault. Valid values:'."\n" ."\n" .'- DISABLED: Compression is disabled.'."\n" ."\n" .'- SNAPPY: The SNAPPY algorithm is used.'."\n" ."\n" .'- ZSTD: The Zstandard algorithm is used. Zstandard is a fast, lossless compression algorithm.', 'type' => 'string', 'example' => 'ZSTD', 'title' => ''], 'RedundancyType' => ['description' => 'The data redundancy type of the backup vault. Valid values:'."\n" ."\n" .'- LRS: locally redundant storage (LRS). HBR stores redundant copies of your data on multiple devices in the same zone to ensure data durability and availability in case of hardware failures.'."\n" ."\n" .'- ZRS: zone-redundant storage (ZRS). HBR uses a multi-zone mechanism to distribute your data across three zones within the same region. This ensures that your data remains accessible even if a zone becomes unavailable.', 'type' => 'string', 'example' => 'LRS', 'title' => ''], 'KmsKeyId' => ['description' => 'The ID of the customer master key (CMK) or the alias of the CMK that is used for KMS encryption. This parameter is required only if you set EncryptType to KMS.', 'type' => 'string', 'example' => 'alias/acs/acm', 'title' => ''], 'ChargedStorageSize' => ['description' => 'The billable storage usage of the archive vault. Unit: bytes.', 'type' => 'integer', 'format' => 'int64', 'example' => '1024000', 'title' => ''], 'ArchiveStorageSize' => ['description' => 'The billable storage usage of the Archive storage class. Unit: bytes.', 'type' => 'integer', 'format' => 'int64', 'example' => '1024000', 'title' => ''], 'ArchiveBytesDone' => ['description' => 'The backup data size of the Archive storage class. Unit: bytes.', 'type' => 'integer', 'format' => 'int64', 'example' => '1024000', 'title' => ''], 'ReplicationSourceVault' => ['description' => 'Indicates whether the vault is a source vault for geo-redundancy.'."\n" ."\n" .'- true: The vault is a source vault for geo-redundancy.'."\n" ."\n" .'- false: The vault is not a source vault for geo-redundancy.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], 'ReplicationTargetRegionId' => ['description' => 'The destination region for geo-redundancy.', 'type' => 'string', 'example' => 'cn-shanghai', 'title' => ''], 'VaultOwnerId' => ['description' => 'The ID of the account that owns the data store.', 'type' => 'integer', 'format' => 'int64', 'example' => '123***7890', 'title' => ''], 'ReplicationTargetVaultId' => ['description' => 'The ID of the replication destination vault.', 'type' => 'string', 'example' => 'v-123***7890', 'title' => ''], 'ReplicationSourceOwnerId' => ['description' => 'The ID of the source account for replication.', 'type' => 'integer', 'format' => 'int64', 'example' => '123***7890', 'title' => ''], 'ReplicationTargetOwnerId' => ['description' => 'The ID of the account that owns the replication destination vault.', 'type' => 'integer', 'format' => 'int64', 'example' => '123***7890', 'title' => ''], 'ReplicationStatus' => ['description' => 'The replication status of the replication destination vault.', 'type' => 'string', 'example' => 'RUNNING', 'title' => ''], 'RsTargetAccountIds' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'RsTargetAccountId' => [ 'type' => 'array', 'items' => ['description' => 'The destination account for resource sharing.', 'type' => 'integer', 'format' => 'int64', 'example' => '123***7890', 'title' => ''], 'description' => 'The destination account for resource sharing.', 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], 'title' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 8,\\n \\"Vaults\\": {\\n \\"Vault\\": [\\n {\\n \\"Status\\": \\"CREATED\\",\\n \\"VaultId\\": \\"v-*********************\\",\\n \\"ChargeType\\": \\"FREE\\",\\n \\"VaultType\\": \\"STANDARD\\",\\n \\"Dedup\\": true,\\n \\"ReplicationSourceVaultId\\": \\"v-*********************\\",\\n \\"IndexUpdateTime\\": 1639645628,\\n \\"Description\\": \\"vault description\\",\\n \\"VaultStorageClass\\": \\"STANDARD\\",\\n \\"Retention\\": 2,\\n \\"CreatedTime\\": 1554347313,\\n \\"IndexLevel\\": \\"OFF\\",\\n \\"VaultName\\": \\"vaultname\\",\\n \\"StorageSize\\": 10,\\n \\"LatestReplicationTime\\": 1554347313,\\n \\"VaultStatusMessage\\": \\"SOURCE_VAULT_ALREADY_HAS_REPLICATION\\",\\n \\"Replication\\": false,\\n \\"ReplicationSourceRegionId\\": \\"cn-shanghai\\",\\n \\"VaultRegionId\\": \\"cn-shanghai\\",\\n \\"UpdatedTime\\": 1554347313,\\n \\"ResourceGroupId\\": \\"rg-*********************\\",\\n \\"BucketName\\": \\"hbr-0005i51******t58\\",\\n \\"SearchEnabled\\": true,\\n \\"IndexAvailable\\": true,\\n \\"BytesDone\\": 20,\\n \\"Tags\\": {\\n \\"Tag\\": [\\n {\\n \\"Key\\": \\"aaa\\",\\n \\"Value\\": \\"a1\\"\\n }\\n ]\\n },\\n \\"SourceTypes\\": {\\n \\"SourceType\\": [\\n \\"ECS_FILE\\"\\n ]\\n },\\n \\"ReplicationProgress\\": {\\n \\"HistoricalReplicationProgress\\": 100,\\n \\"NewReplicationProgress\\": 1579413159\\n },\\n \\"BackupPlanStatistics\\": {\\n \\"Oracle\\": 1,\\n \\"LocalFile\\": 1,\\n \\"Nas\\": 1,\\n \\"CommonNas\\": 1,\\n \\"Isilon\\": 1,\\n \\"Oss\\": 1,\\n \\"SqlServer\\": 1,\\n \\"Csg\\": 1,\\n \\"EcsFile\\": 1,\\n \\"MySql\\": 1,\\n \\"EcsHana\\": 1,\\n \\"LocalVm\\": 1,\\n \\"Ots\\": 1,\\n \\"Archive\\": 1,\\n \\"CommonFileSystem\\": 1\\n },\\n \\"TrialInfo\\": {\\n \\"TrialStartTime\\": 1579413159,\\n \\"TrialVaultReleaseTime\\": 1594965600,\\n \\"TrialExpireTime\\": 1584597600,\\n \\"KeepAfterTrialExpiration\\": true\\n },\\n \\"EncryptType\\": \\"HBR_PRIVATE\\",\\n \\"WormEnabled\\": true,\\n \\"SnapshotCount\\": 0,\\n \\"CompressionAlgorithm\\": \\"ZSTD\\",\\n \\"RedundancyType\\": \\"LRS\\",\\n \\"KmsKeyId\\": \\"alias/acs/acm\\",\\n \\"ChargedStorageSize\\": 1024000,\\n \\"ArchiveStorageSize\\": 1024000,\\n \\"ArchiveBytesDone\\": 1024000,\\n \\"ReplicationSourceVault\\": false,\\n \\"ReplicationTargetRegionId\\": \\"cn-shanghai\\",\\n \\"VaultOwnerId\\": 0,\\n \\"ReplicationTargetVaultId\\": \\"v-123***7890\\",\\n \\"ReplicationSourceOwnerId\\": 0,\\n \\"ReplicationTargetOwnerId\\": 0,\\n \\"ReplicationStatus\\": \\"RUNNING\\",\\n \\"RsTargetAccountIds\\": {\\n \\"RsTargetAccountId\\": [\\n 0\\n ]\\n }\\n }\\n ]\\n }\\n}","type":"json"}]', 'title' => 'DescribeVaults', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeVaults'], ], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'hbr:DescribeVaults', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'HBR', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], ], 'DetachNasFileSystem' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'systemTags' => [ 'operationType' => 'update', 'abilityTreeCode' => '95580', 'abilityTreeNodes' => ['FEATUREhbrFWIWBG'], ], 'parameters' => [ [ 'name' => 'FileSystemId', 'in' => 'query', 'schema' => ['description' => 'The ID of the file system.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '005494', 'title' => ''], ], [ 'name' => 'CreateTime', 'in' => 'query', 'schema' => ['description' => 'The time when the file system was created. The value must be a UNIX timestamp. Unit: seconds.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '1607436917', 'title' => ''], ], [ 'name' => 'CrossAccountType', 'in' => 'query', 'schema' => [ 'description' => 'Specifies whether data is backed up and restored within the same Alibaba Cloud account or across Alibaba Cloud accounts. Valid values:'."\n" ."\n" .'- SELF\\_ACCOUNT: Data is backed up and restored within the same Alibaba Cloud account.'."\n" ."\n" .'- CROSS\\_ACCOUNT: Data is backed up and restored across Alibaba Cloud accounts.', 'enumValueTitles' => [], 'type' => 'string', 'required' => false, 'example' => 'SELF_ACCOUNT', 'title' => '', ], ], [ 'name' => 'CrossAccountUserId', 'in' => 'query', 'schema' => ['description' => 'The ID of the source Alibaba Cloud account that authorizes the current Alibaba Cloud account to back up and restore data across Alibaba Cloud accounts.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '158975xxxxx4625', 'title' => ''], ], [ 'name' => 'CrossAccountRoleName', 'in' => 'query', 'schema' => ['description' => 'The name of the RAM role that is created within the source Alibaba Cloud account and assigned to the current Alibaba Cloud account to authorize the current Alibaba Cloud account to back up and restore data across Alibaba Cloud accounts.', 'type' => 'string', 'required' => false, 'example' => 'BackupRole', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Code' => ['description' => 'The HTTP status code. The status code 200 indicates that the request is successful.', 'type' => 'string', 'example' => '200', 'title' => ''], 'Message' => ['description' => 'The message that is returned. If the request is successful, a value of successful is returned. If the request fails, an error message is returned.', 'type' => 'string', 'example' => 'successful', 'title' => ''], 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E', 'title' => ''], 'TaskId' => ['description' => 'The ID of the asynchronous job. You can call the DescribeTask operation to query the execution result of the asynchronous job.', 'type' => 'string', 'example' => 't-*********************', 'title' => ''], 'Success' => ['description' => 'Indicates whether the request is successful.'."\n" ."\n" .'- true: The request is successful.'."\n" ."\n" .'- false: The request fails.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'title' => 'DetachNasFileSystem', 'summary' => 'Deletes an internal mount target created by Cloud Backup.', 'description' => '- If the request is successful, the mount target is deleted.'."\n" ."\n" .'- After you create a backup plan for an Apsara File Storage NAS file system, HBR automatically creates a mount target for the file system. Call this operation to delete the mount target. In the **Status** column of the mount target of the NAS file system, the following information is displayed: **This mount target is created by an Alibaba Cloud internal service and cannot be operated. Service name: HBR**.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DetachNasFileSystem'], ], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'hbr:DetachNasFileSystem', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'HBR', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\",\\n \\"TaskId\\": \\"t-*********************\\",\\n \\"Success\\": true\\n}","type":"json"}]', ], 'DisableBackupPlan' => [ 'summary' => 'Disables a backup plan.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '95581', 'abilityTreeNodes' => ['FEATUREhbr9ZUQY7'], ], 'parameters' => [ [ 'name' => 'PlanId', 'in' => 'query', 'schema' => ['description' => 'The ID of the backup plan.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => 'plan-*********************'], ], [ 'name' => 'VaultId', 'in' => 'query', 'schema' => ['description' => 'The ID of the backup vault.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'title' => '', 'example' => 'v-*********************'], ], [ 'name' => 'SourceType', 'in' => 'query', 'schema' => ['description' => 'The type of the data source. Valid values:'."\n" ."\n" .'- **ECS\\_FILE**: Backs up ECS files.'."\n" ."\n" .'- **OSS**: Backs up Alibaba Cloud OSS.'."\n" ."\n" .'- **NAS**: Backs up Alibaba Cloud NAS.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'ECS_FILE'], ], [ 'name' => 'Edition', 'in' => 'query', 'schema' => ['type' => 'string', 'title' => '', 'description' => 'The edition. Valid values: BASIC and STANDARD. The default value is STANDARD.', 'required' => false, 'example' => 'STANDARD'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Code' => ['description' => 'The return code. A value of 200 indicates success.', 'type' => 'string', 'title' => '', 'example' => '200'], 'Message' => ['description' => 'The returned message. \\`successful\\` is returned if the request is successful. An error message is returned if the request fails.', 'type' => 'string', 'title' => '', 'example' => 'successful'], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E'], 'Success' => ['description' => 'Indicates whether the request was successful.'."\n" ."\n" .'- true: The request was successful.'."\n" ."\n" .'- false: The request failed.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\",\\n \\"Success\\": true\\n}","type":"json"}]', 'title' => 'DisableBackupPlan', 'description' => 'If the call is successful, the backup plan is disabled. The value of the Disabled parameter is then returned as true in the response of the DescribeBackupPlans operation.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DisableBackupPlan'], ], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'hbr:DisableBackupPlan', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'HBR', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], ], 'DisableHanaBackupPlan' => [ 'methods' => ['post', 'get'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ 'name' => 'VaultId', 'in' => 'query', 'schema' => ['description' => 'The ID of the backup vault.'."\n", 'type' => 'string', 'required' => true, 'example' => 'v-000f9z******vilrr'], ], [ 'name' => 'ClusterId', 'in' => 'query', 'schema' => ['description' => 'The ID of the SAP HANA instance.'."\n", 'type' => 'string', 'required' => true, 'example' => 'cl-0003tu******y5oc'], ], [ 'name' => 'PlanId', 'in' => 'query', 'schema' => ['description' => 'The ID of the backup plan.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pl-0006o11ectqr650ceoct'], ], [ 'name' => 'ResourceGroupId', 'in' => 'query', 'schema' => ['description' => 'The ID of the resource group.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rg-acfm3erpwweavki'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Code' => ['description' => 'The response code. The status code 200 indicates that the request was successful.'."\n", 'type' => 'string', 'example' => '200'], 'Message' => ['description' => 'The returned message. If the request was successful, "successful" is returned. If the request failed, an error message is returned.'."\n", 'type' => 'string', 'example' => 'successful'], 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'FFC87EC8-8126-5967-9C4D-82715F8DFC97'], 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" ."\n" .'* true'."\n" .'* false'."\n", 'type' => 'boolean', 'example' => 'true'], ], 'description' => '', ], ], ], 'title' => 'DisableHanaBackupPlan', 'summary' => 'Disables an SAP HANA backup plan.', 'description' => 'To enable the backup plan again, call the EnableHanaBackupPlan operation.'."\n", 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DisableHanaBackupPlan'], ], ], 'ramActions' => [], 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"FFC87EC8-8126-5967-9C4D-82715F8DFC97\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n 200\\n successful\\n FFC87EC8-8126-5967-9C4D-82715F8DFC97\\n true\\n","errorExample":""}]', ], 'EnableBackupPlan' => [ 'summary' => 'Resumes a backup plan.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'paid', 'abilityTreeCode' => '95589', 'abilityTreeNodes' => ['FEATUREhbr9ZUQY7'], ], 'parameters' => [ [ 'name' => 'PlanId', 'in' => 'query', 'schema' => ['description' => 'The ID of the backup plan.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => 'plan-*********************'], ], [ 'name' => 'VaultId', 'in' => 'query', 'schema' => ['description' => 'The ID of the backup vault.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'title' => '', 'example' => 'v-*********************'], ], [ 'name' => 'SourceType', 'in' => 'query', 'schema' => ['description' => 'The type of the data source. Valid values:'."\n" ."\n" .'- **ECS\\_FILE**: Backs up ECS files.'."\n" ."\n" .'- **OSS**: Backs up Alibaba Cloud OSS.'."\n" ."\n" .'- **NAS**: Backs up Alibaba Cloud NAS.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'ECS_FILE'], ], [ 'name' => 'Edition', 'in' => 'query', 'schema' => ['type' => 'string', 'title' => '', 'description' => 'The edition. Valid values are BASIC and STANDARD. The default value is STANDARD.', 'required' => false, 'example' => 'STANDARD'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Code' => ['description' => 'The response code. A value of 200 indicates success.', 'type' => 'string', 'title' => '', 'example' => '200'], 'Message' => ['description' => 'The response message. If the call is successful, \\`successful\\` is returned. If the call fails, an error message is returned.', 'type' => 'string', 'title' => '', 'example' => 'successful'], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E'], 'Success' => ['description' => 'Indicates whether the request was successful.'."\n" ."\n" .'- true: The request was successful.'."\n" ."\n" .'- false: The request failed.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\",\\n \\"Success\\": true\\n}","type":"json"}]', 'title' => 'EnableBackupPlan', 'description' => 'If the call is successful, the backup plan is enabled. The plan then executes backups according to its policy. In the response of the DescribeBackupPlans operation, the value of the Disabled parameter is false.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'EnableBackupPlan'], ], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'hbr:EnableBackupPlan', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'HBR', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], ], 'EnableHanaBackupPlan' => [ 'methods' => ['post', 'get'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ 'name' => 'VaultId', 'in' => 'query', 'schema' => ['description' => 'The ID of the backup vault.'."\n", 'type' => 'string', 'required' => true, 'example' => 'v-00030j3c******sn'], ], [ 'name' => 'ClusterId', 'in' => 'query', 'schema' => ['description' => 'The ID of the SAP HANA instance.'."\n", 'type' => 'string', 'required' => true, 'example' => 'cl-0001zfcn******0pr3'], ], [ 'name' => 'PlanId', 'in' => 'query', 'schema' => ['description' => 'The ID of the backup plan.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'plan-*********************'], ], [ 'name' => 'ResourceGroupId', 'in' => 'query', 'schema' => ['description' => 'The ID of the resource group.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rg-acfm4ebtpkzx7zy'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Code' => ['description' => 'The response code. The status code 200 indicates that the request was successful.'."\n", 'type' => 'string', 'example' => '200'], 'Message' => ['description' => 'The returned message. If the request was successful, "successful" is returned. If the request failed, an error message is returned.'."\n", 'type' => 'string', 'example' => 'successful'], 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E'], 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" ."\n" .'* true'."\n" .'* false'."\n", 'type' => 'boolean', 'example' => 'true'], ], 'description' => '', ], ], ], 'title' => 'EnableHanaBackupPlan', 'summary' => 'Enables an SAP HANA backup plan.', 'description' => 'To disable the backup plan again, call the DisableHanaBackupPlan operation.'."\n", 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'EnableHanaBackupPlan'], ], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'hbr:EnableHanaBackupPlan', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'HBR', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n 200\\n successful\\n 473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\n true\\n","errorExample":""}]', ], 'ExecuteBackupPlan' => [ 'summary' => 'Executes a backup plan.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'paid', 'abilityTreeCode' => '95593', 'abilityTreeNodes' => ['FEATUREhbr9ZUQY7'], ], 'parameters' => [ [ 'name' => 'PlanId', 'in' => 'query', 'schema' => ['description' => 'The ID of the backup plan.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => 'plan-*********************'], ], [ 'name' => 'VaultId', 'in' => 'query', 'schema' => ['description' => 'The ID of the backup vault.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'title' => '', 'example' => 'v-*********************'], ], [ 'name' => 'SourceType', 'in' => 'query', 'schema' => ['description' => 'The type of the data source. Valid values:'."\n" ."\n" .'- **ECS\\_FILE**: Backs up ECS files.'."\n" ."\n" .'- **OSS**: Backs up Alibaba Cloud OSS.'."\n" ."\n" .'- **NAS**: Backs up Alibaba Cloud NAS.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'ECS_FILE'], ], [ 'name' => 'RuleId', 'in' => 'query', 'schema' => ['description' => 'The ID of the backup rule.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'rule-0002*****ux8'], ], [ 'name' => 'Edition', 'in' => 'query', 'schema' => ['type' => 'string', 'title' => '', 'description' => 'The edition. Valid values: BASIC and STANDARD. Default value: STANDARD.', 'required' => false, 'example' => 'STANDARD'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Code' => ['description' => 'The return code. A value of 200 indicates success.', 'type' => 'string', 'title' => '', 'example' => '200'], 'Message' => ['description' => 'The returned message. If the request is successful, \\`successful\\` is returned. If the request fails, an error message is returned.', 'type' => 'string', 'title' => '', 'example' => 'successful'], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E'], 'Success' => ['description' => 'Indicates whether the request was successful.'."\n" ."\n" .'- true: successful'."\n" ."\n" .'- false: failed', 'type' => 'boolean', 'title' => '', 'example' => 'true'], 'JobId' => ['description' => 'The ID of the backup job.', 'type' => 'string', 'title' => '', 'example' => 'job-*********************'], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\",\\n \\"Success\\": true,\\n \\"JobId\\": \\"job-*********************\\"\\n}","type":"json"}]', 'title' => 'ExecuteBackupPlan', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ExecuteBackupPlan'], ], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'hbr:ExecuteBackupPlan', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'HBR', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], ], 'ExecutePolicyV2' => [ 'summary' => 'Execute a policy for one or all bound data sources.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'paid', 'abilityTreeCode' => '163243', 'abilityTreeNodes' => ['FEATUREhbr4JQRTT'], ], 'parameters' => [ [ 'name' => 'PolicyId', 'in' => 'formData', 'schema' => ['description' => 'Policy ID.', 'type' => 'string', 'required' => true, 'example' => 'po-000************hky', 'title' => ''], ], [ 'name' => 'DataSourceId', 'in' => 'formData', 'schema' => ['description' => 'Data source ID.', 'type' => 'string', 'required' => false, 'example' => 'i-bp1************dtv', 'title' => ''], ], [ 'name' => 'SourceType', 'in' => 'query', 'schema' => ['description' => 'Data source type, with the value range as follows:'."\n" ."\n" .'- **UDM_ECS**: Represents ECS full machine backup.', 'type' => 'string', 'required' => false, 'example' => 'UDM_ECS', 'title' => ''], ], [ 'name' => 'RuleId', 'in' => 'query', 'schema' => ['description' => 'Rule ID, limited to executing rules of **RuleType** **BACKUP**.', 'type' => 'string', 'required' => true, 'example' => 'rule-0002*****ux8', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'ExecutePolicyResponse', 'type' => 'object', 'properties' => [ 'Success' => ['description' => 'Indicates whether the request was successful.'."\n" ."\n" .'- true: Success'."\n" .'- false: Failure', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'Code' => ['description' => 'Return code, 200 indicates success.', 'type' => 'string', 'example' => '200', 'title' => ''], 'Message' => ['description' => 'Description of the return message, usually returns \'successful\' on success, and corresponding error messages on failure.', 'type' => 'string', 'example' => 'successful', 'title' => ''], 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => 'F4EEB401-DD21-588D-AE3B-1E835C7655E1', 'title' => ''], 'JobId' => ['description' => 'Backup job ID.', 'type' => 'string', 'example' => 'job-*********************', 'title' => ''], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'Execute Policy', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ExecutePolicyV2'], ], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'hbr:ExecutePolicyV2', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'HBR', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"F4EEB401-DD21-588D-AE3B-1E835C7655E1\\",\\n \\"JobId\\": \\"job-*********************\\"\\n}","type":"json"}]', ], 'GenerateRamPolicy' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'abilityTreeCode' => '95715', 'abilityTreeNodes' => ['FEATUREhbr3BJQCT'], 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'RequireBasePolicy', 'in' => 'query', 'schema' => ['description' => 'Specifies whether to generate the policy based on an existing instance-specific rule. Valid values:'."\n" ."\n" .'* true'."\n" .'* false'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'true'], ], [ 'name' => 'ActionType', 'in' => 'query', 'schema' => ['description' => 'The type of policy that you want to generate. Valid values:'."\n" ."\n" .'* BACKUP: the permission to back up data to a backup vault'."\n" .'* RESTORE: the permission to restore data from a backup vault'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'system'], ], [ 'name' => 'VaultId', 'in' => 'query', 'schema' => ['description' => 'The ID of the backup vault.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'v-0007al3m******7ao'], ], [ 'name' => 'ResourceGroupId', 'in' => 'query', 'schema' => ['description' => 'The ID of the resource group.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rg-*********************'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Code' => ['description' => 'The response code. The status code 200 indicates that the request was successful.'."\n", 'type' => 'string', 'example' => '200'], 'Message' => ['description' => 'The returned message. If the request was successful, "successful" is returned. If the request failed, an error message is returned.'."\n", 'type' => 'string', 'example' => 'successful'], 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E'], 'PolicyDocument' => ['description' => 'The content of the policy.'."\n", 'type' => 'string', 'example' => '{ "Version": "1", "Statement": [ { "Effect": "Deny", "Action": [ "hbr:CreateRestore", "hbr:CreateRestoreJob", "hbr:CreateHanaRestore", "hbr:CreateUniRestorePlan", "hbr:CreateSqlServerRestore" ], "Resource": [ "acs:hbr:*:1178******531:vault/v-000******blx06", "acs:hbr:*:1178******531:vault/v-000******blx06/client/*" ] } ] }'], 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" ."\n" .'* true'."\n" .'* false'."\n", 'type' => 'boolean', 'example' => 'true'], ], 'description' => '', ], ], ], 'title' => 'GenerateRamPolicy', 'summary' => 'Generates a Resource Access Management (RAM) policy.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'GenerateRamPolicy'], ], ], 'ramActions' => [ [ 'operationType' => 'none', 'ramAction' => [ 'action' => 'hbr:GenerateRamPolicy', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'HBR', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\",\\n \\"PolicyDocument\\": \\"{ \\\\\\"Version\\\\\\": \\\\\\"1\\\\\\", \\\\\\"Statement\\\\\\": [ { \\\\\\"Effect\\\\\\": \\\\\\"Deny\\\\\\", \\\\\\"Action\\\\\\": [ \\\\\\"hbr:CreateRestore\\\\\\", \\\\\\"hbr:CreateRestoreJob\\\\\\", \\\\\\"hbr:CreateHanaRestore\\\\\\", \\\\\\"hbr:CreateUniRestorePlan\\\\\\", \\\\\\"hbr:CreateSqlServerRestore\\\\\\" ], \\\\\\"Resource\\\\\\": [ \\\\\\"acs:hbr:*:1178******531:vault/v-000******blx06\\\\\\", \\\\\\"acs:hbr:*:1178******531:vault/v-000******blx06/client/*\\\\\\" ] } ] }\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n 200\\n successful\\n 473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\n { \\"Version\\": \\"1\\", \\"Statement\\": [ { \\"Effect\\": \\"Deny\\", \\"Action\\": [ \\"hbr:CreateRestore\\", \\"hbr:CreateRestoreJob\\", \\"hbr:CreateHanaRestore\\", \\"hbr:CreateUniRestorePlan\\", \\"hbr:CreateSqlServerRestore\\" ], \\"Resource\\": [ \\"acs:hbr:*:1178******531:vault/v-000******blx06\\", \\"acs:hbr:*:1178******531:vault/v-000******blx06/client/*\\" ] } ] }\\n true\\n","errorExample":""}]', ], 'GetBasicStatistics' => [ 'summary' => 'Retrieves basic statistics for Backup.', 'path' => '', 'methods' => ['get', 'post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREhbr3BJQCT'], ], 'parameters' => [ [ 'name' => 'SourceType', 'in' => 'query', 'schema' => ['description' => 'The data source type. The valid value is:'."\n" ."\n" .'- **ECS\\_FILE**: ECS File Backup.', 'type' => 'string', 'required' => true, 'example' => 'ECS_FILE', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The Request ID.', 'type' => 'string', 'title' => '', 'example' => 'EB526A5D-1FE2-51C1-B790-1732C1DBA969'], 'Code' => ['description' => 'The HTTP status code. A value of 200 indicates that the request was successful.', 'type' => 'string', 'example' => '200', 'title' => ''], 'Message' => ['description' => 'The response message. If the request is successful, `successful` is returned. If the request fails, an error message is returned.', 'type' => 'string', 'example' => 'successful', 'title' => ''], 'Success' => ['description' => 'Indicates whether the request was successful.'."\n" ."\n" .'- true: The request was successful.'."\n" ."\n" .'- false: The request failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'RegionStatistics' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'RegionId' => ['description' => 'The Region ID.', 'type' => 'string', 'example' => 'cn-shenzhen', 'title' => ''], 'ProtectedDataSize' => ['description' => 'The backed-up data size, in bytes.'."\n" ."\n" .'- When `SourceType` is set to `ECS_FILE`, this parameter represents the total capacity of backed-up Cloud Disks.', 'type' => 'integer', 'format' => 'int64', 'example' => '42949672960', 'title' => ''], 'ProtectedResourceCount' => ['description' => 'The number of backed-up resources.'."\n" ."\n" .'- When `SourceType` is set to `ECS_FILE`, this parameter represents the number of backed-up ECS instances.', 'type' => 'integer', 'format' => 'int32', 'example' => '5', 'title' => ''], ], 'description' => 'The Backup statistics for each region.', 'title' => '', 'example' => '', ], 'description' => 'The Backup statistics for each region.', 'title' => '', 'example' => '', ], 'SourceType' => ['description' => 'The data source type. The valid value is:'."\n" ."\n" .'- **ECS\\_FILE**: ECS File Backup.', 'type' => 'string', 'example' => 'ECS_FILE', 'title' => ''], 'GlobalStatistics' => [ 'type' => 'object', 'properties' => [ 'ProtectedDataSize' => ['description' => 'The backed-up data size, in bytes.'."\n" ."\n" .'- When `SourceType` is set to `ECS_FILE`, this parameter represents the total capacity of backed-up Cloud Disks.', 'type' => 'integer', 'format' => 'int64', 'example' => '42949672960', 'title' => ''], 'ProtectedResourceCount' => ['description' => 'The number of backed-up resources.'."\n" ."\n" .'- When `SourceType` is set to `ECS_FILE`, this parameter represents the number of backed-up ECS instances.', 'type' => 'integer', 'format' => 'int32', 'example' => '5', 'title' => ''], ], 'description' => 'The Backup statistics for all regions.', 'title' => '', 'example' => '', ], ], 'title' => '', 'description' => 'Schema of Response', 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'GetBasicStatistics', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EB526A5D-1FE2-51C1-B790-1732C1DBA969\\",\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"Success\\": true,\\n \\"RegionStatistics\\": [\\n {\\n \\"RegionId\\": \\"cn-shenzhen\\",\\n \\"ProtectedDataSize\\": 42949672960,\\n \\"ProtectedResourceCount\\": 5\\n }\\n ],\\n \\"SourceType\\": \\"ECS_FILE\\",\\n \\"GlobalStatistics\\": {\\n \\"ProtectedDataSize\\": 42949672960,\\n \\"ProtectedResourceCount\\": 5\\n }\\n}","type":"json"}]', ], 'GetTempFileDownloadLink' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'systemTags' => [ 'operationType' => 'get', 'abilityTreeCode' => '146984', 'abilityTreeNodes' => ['FEATUREhbr56LH1C', 'FEATUREhbrFWIWBG', 'FEATUREhbrAW9I1R', 'FEATUREhbrB1KQ9G', 'FEATUREhbr3BJQCT', 'FEATUREhbrAL60OZ', 'FEATUREhbr9ZUQY7'], ], 'parameters' => [ [ 'name' => 'TempFileKey', 'in' => 'query', 'schema' => ['description' => 'The key that is used to download a file.'."\n", 'type' => 'string', 'required' => true, 'example' => 'temp/1797733170015112/report/r-000jdzknbp39cnf9hs99/r-000jdzknbp39cnf9hs99-total.csv'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Code' => ['description' => 'The HTTP status code. The status code 200 indicates that the request is successful.'."\n", 'type' => 'string', 'example' => '200'], 'Url' => ['description' => 'The download URL of the file.'."\n", 'type' => 'string', 'example' => 'https://a-hbr-temp-cn-hangzhou.oss-cn-hangzhou.aliyuncs.com/job-0007yg2i0m6705wdhgb6_0.csv?Expires=1649406469&OSSAccessKeyId=LTAI************&Signature=26%2BgjegCrRmMDCpS5jzyG4ivKU8%3D'], 'Message' => ['description' => 'The message that is returned. If the request is successful, a value of successful is returned. If the request fails, an error message is returned.'."\n", 'type' => 'string', 'example' => 'successful'], 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E'], 'Success' => ['description' => 'Indicates whether the request is successful.'."\n" ."\n" .'* true: The request is successful.'."\n" .'* false: The request fails.'."\n", 'type' => 'boolean', 'example' => 'true'], ], ], ], ], 'title' => 'GetTempFileDownloadLink', 'summary' => 'Obtains download links of files such as job reports.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '60', 'countWindow' => 60, 'regionId' => '*', 'api' => 'GetTempFileDownloadLink'], ], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'hbr:GetTempFileDownloadLink', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'HBR', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Url\\": \\"https://a-hbr-temp-cn-hangzhou.oss-cn-hangzhou.aliyuncs.com/job-0007yg2i0m6705wdhgb6_0.csv?Expires=1649406469&OSSAccessKeyId=LTAI************&Signature=26%2BgjegCrRmMDCpS5jzyG4ivKU8%3D\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\",\\n \\"Success\\": true\\n}","type":"json"}]', ], 'InstallBackupClients' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '95625', 'abilityTreeNodes' => ['FEATUREhbrS7MI6C'], ], 'parameters' => [ [ 'name' => 'InstanceIds', 'in' => 'query', 'style' => 'json', 'schema' => ['description' => 'The IDs of the ECS instances. You can specify a maximum of 20 instance IDs.', 'type' => 'object', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => '["i-0xi5wj5*****v3j3bh2gj5"]'], ], [ 'name' => 'CrossAccountType', 'in' => 'query', 'schema' => ['description' => 'The type of cross-account backup. Valid values:'."\n" ."\n" .'- SELF\\_ACCOUNT: Backs up data within the current account.'."\n" ."\n" .'- CROSS\\_ACCOUNT: Backs up data across accounts.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'CROSS_ACCOUNT'], ], [ 'name' => 'CrossAccountUserId', 'in' => 'query', 'schema' => ['description' => 'The ID of the source account that is used for cross-account backup.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'title' => '', 'example' => '16392782xxxxxx'], ], [ 'name' => 'CrossAccountRoleName', 'in' => 'query', 'schema' => ['description' => 'The name of the RAM role that is created in the source account for cross-account backup.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'BackupRole'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Code' => ['description' => 'The return code. A value of 200 indicates that the operation is successful.', 'type' => 'string', 'title' => '', 'example' => '200'], 'Message' => ['description' => 'The message that is returned. If the request is successful, successful is returned. If the request fails, an error message is returned.', 'type' => 'string', 'title' => '', 'example' => 'successful'], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E'], 'TaskId' => ['description' => 'The ID of the asynchronous task. Call the DescribeTask operation to query the task result.', 'type' => 'string', 'title' => '', 'example' => 't-*********************'], 'Success' => ['description' => 'Indicates whether the request is successful.'."\n" ."\n" .'- true: The request is successful.'."\n" ."\n" .'- false: The request failed.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], 'InstanceStatuses' => [ 'description' => 'The status of the ECS instances.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'ValidInstance' => ['description' => 'Indicates whether a backup client can be installed on the ECS instance.'."\n" ."\n" .'- true: The backup client can be installed.'."\n" ."\n" .'- false: The backup client cannot be installed.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], 'InstanceId' => ['description' => 'The ID of the ECS instance.', 'type' => 'string', 'title' => '', 'example' => 'i-0xi5w***v3j3bh2gj5'], 'ErrorCode' => ['description' => 'The error code. Valid values:'."\n" ."\n" .'- An empty value indicates that the operation is successful.'."\n" ."\n" .'- **InstanceNotExists**: The ECS instance does not exist.'."\n" ."\n" .'- **InstanceNotRunning**: The ECS instance is not in the Running state.'."\n" ."\n" .'- **CloudAssistNotRunningOnInstance**: Cloud Assistant is not available.', 'type' => 'string', 'title' => '', 'example' => 'InstanceNotExists'], ], 'description' => '', 'title' => '', ], 'title' => '', ], ], 'description' => '', 'title' => '', ], ], ], 'title' => 'InstallBackupClients', 'summary' => 'Installs backup clients on one or more ECS instances.', 'description' => '- This operation creates a background asynchronous task. The task uses Cloud Assistant to install backup clients on ECS instances.'."\n" ."\n" .'- Call the [DescribeTask](~~431265~~) operation to get the task result.'."\n" ."\n" .'- The task timeout is 15 minutes. After the task is created, wait 60 seconds before making the first query. Then, query the result every 30 seconds.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'InstallBackupClients'], ], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'hbr:InstallBackupClients', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'HBR', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\",\\n \\"TaskId\\": \\"t-*********************\\",\\n \\"Success\\": true,\\n \\"InstanceStatuses\\": [\\n {\\n \\"ValidInstance\\": true,\\n \\"InstanceId\\": \\"i-0xi5w***v3j3bh2gj5\\",\\n \\"ErrorCode\\": \\"InstanceNotExists\\"\\n }\\n ]\\n}","type":"json"}]', ], 'ListProtectedResources' => [ 'path' => '', 'methods' => ['get', 'post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREhbrIF7VXM'], ], 'parameters' => [ [ 'name' => 'NextToken', 'in' => 'query', 'schema' => ['description' => 'The token to retrieve the next page of results. An empty value indicates that all results have been returned.', 'type' => 'string', 'required' => false, 'example' => 'aWQj********MCMy', 'title' => ''], ], [ 'name' => 'MaxResults', 'in' => 'query', 'schema' => ['description' => 'The maximum number of entries to return per request.'."\n" ."\n" .'Valid values: 10 to 100. Default value: 10.', 'type' => 'integer', 'format' => 'int32', 'minimum' => '0', 'required' => false, 'example' => '10', 'title' => ''], ], [ 'name' => 'CreatedByProduct', 'in' => 'query', 'schema' => [ 'description' => 'The product used to protect the resource. Valid value:'."\n" ."\n" .'- **BASIC**: File Backup Essential Edition.', 'type' => 'string', 'enum' => ['BASIC'], 'required' => false, 'example' => 'BASIC', 'title' => '', ], ], [ 'name' => 'SourceType', 'in' => 'query', 'schema' => [ 'description' => 'The data source type. Valid value:'."\n" ."\n" .'- **ECS\\_FILE**: ECS File Backup.', 'type' => 'string', 'enum' => ['ECS_FILE'], 'required' => false, 'example' => 'ECS_FILE', 'title' => '', ], ], [ 'name' => 'ResourceId', 'in' => 'query', 'schema' => ['description' => 'The resource ID.'."\n" ."\n" .'- If `SourceType` is set to **ECS\\_FILE**, this parameter specifies the ECS instance ID.', 'type' => 'string', 'required' => false, 'example' => 'i-wz95************7zrd', 'title' => ''], ], [ 'name' => 'Skip', 'in' => 'query', 'schema' => ['description' => 'The number of entries to skip in a paged query. If this value exceeds the total number of results, an empty list is returned. The value must be a multiple of `MaxResults`.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''], ], [ 'name' => 'HasSnapshot', 'in' => 'query', 'schema' => ['type' => 'boolean', 'description' => '', 'title' => '', 'example' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => 'EB09****-****-****-****-********6C38'], 'Code' => ['description' => 'The HTTP status code. A value of `200` indicates that the request was successful.', 'type' => 'string', 'example' => '200', 'title' => ''], 'Message' => ['description' => 'The response message. Returns `successful` if the request succeeds, or an error message if it fails.', 'type' => 'string', 'example' => 'successful', 'title' => ''], 'Success' => ['description' => 'Indicates whether the request was successful.'."\n" ."\n" .'- `true`: The request was successful.'."\n" ."\n" .'- `false`: The request failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'TotalCount' => ['description' => 'The total number of protected resources.', 'type' => 'integer', 'format' => 'int32', 'example' => '3', 'title' => ''], 'ProtectedResources' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'SourceType' => ['description' => 'The type of the data source.'."\n" ."\n" .'- **SourceType=ECS\\_FILE**: The data source is an ECS instance.', 'type' => 'string', 'example' => 'ECS_FILE', 'title' => ''], 'ResourceId' => ['description' => 'The resource ID.'."\n" ."\n" .'- **SourceType=ECS\\_FILE**: The ID of the ECS instance.', 'type' => 'string', 'example' => 'i-wz95************7zrd', 'title' => ''], 'ResourceOwnerId' => ['description' => 'The user UID of the resource\'s owner.', 'type' => 'integer', 'format' => 'int64', 'example' => '1024********0703', 'title' => ''], 'CreatedByProduct' => ['description' => 'The product that protects the resource. Valid value:'."\n" ."\n" .'- **BASIC**: ECS File Backup Essential Edition.', 'type' => 'string', 'example' => 'BASIC', 'title' => ''], 'SnapshotCount' => ['description' => 'The number of backups.', 'type' => 'integer', 'format' => 'int64', 'example' => '30', 'title' => ''], 'ProtectedResourceId' => ['description' => 'The ID of the protected resource.', 'type' => 'string', 'example' => 'pr-0004************gs61', 'title' => ''], 'ProtectedDataSize' => ['description' => 'The size of the protected data, in bytes.'."\n" ."\n" .'- **SourceType=ECS\\_FILE**: The size of the backed-up block storage.', 'type' => 'integer', 'format' => 'int64', 'example' => '107374182400', 'title' => ''], 'ResourceRegionId' => ['description' => 'The region ID of the resource.', 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''], 'BackupPlanCount' => ['description' => 'The number of backup plans.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], 'description' => 'The list of protected resources.', 'title' => '', 'example' => '', ], 'MaxResults' => ['description' => 'The number of entries to return on each page.'."\n" ."\n" .'Valid values: 10 to 100. Default value: 10.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], 'NextToken' => ['description' => 'The token to retrieve the next page of results. An empty value for this parameter indicates that all results have been returned.', 'type' => 'string', 'example' => 'eyJJ************MX0=', 'title' => ''], ], 'title' => '', 'description' => 'The response body.', 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'ListProtectedResources', 'summary' => 'Queries protected resources', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'list', 'ramAction' => [ 'action' => 'hbr:ListProtectedResources', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'HBR', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EB09****-****-****-****-********6C38\\",\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"Success\\": true,\\n \\"TotalCount\\": 3,\\n \\"ProtectedResources\\": [\\n {\\n \\"SourceType\\": \\"ECS_FILE\\",\\n \\"ResourceId\\": \\"i-wz95************7zrd\\",\\n \\"ResourceOwnerId\\": 0,\\n \\"CreatedByProduct\\": \\"BASIC\\",\\n \\"SnapshotCount\\": 30,\\n \\"ProtectedResourceId\\": \\"pr-0004************gs61\\",\\n \\"ProtectedDataSize\\": 107374182400,\\n \\"ResourceRegionId\\": \\"cn-hangzhou\\",\\n \\"BackupPlanCount\\": 1\\n }\\n ],\\n \\"MaxResults\\": 10,\\n \\"NextToken\\": \\"eyJJ************MX0=\\"\\n}","type":"json"}]', ], 'OpenHbrService' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], [ 'APP' => [], ], [ 'PrivateKey' => [], ], [ 'BearerToken' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '95631', 'abilityTreeNodes' => ['FEATUREhbr3BJQCT'], 'tenantRelevance' => 'publicInformation', ], 'parameters' => [], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'OrderId' => ['description' => 'The ID of the order.', 'type' => 'string', 'example' => '215463686160696', 'title' => ''], 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => 'F4A1D5F4-5055-549A-8B25-6DD23311E299', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'title' => 'OpenHbrService', 'summary' => 'Activates Cloud Backup.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'OpenHbrService'], ], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'hbr:OpenHbrService', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'HBR', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"OrderId\\": \\"215463686160696\\",\\n \\"RequestId\\": \\"F4A1D5F4-5055-549A-8B25-6DD23311E299\\"\\n}","type":"json"}]', ], 'RemoveDataSource' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', 'abilityTreeCode' => '95636', 'abilityTreeNodes' => ['FEATUREhbr9ZUQY7'], ], 'parameters' => [ [ 'name' => 'DataSourceId', 'in' => 'query', 'schema' => ['description' => 'The ID of the data source.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ds-000bz3***myv90r', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Code' => ['description' => 'The HTTP status code. A value of 200 indicates that the request was successful.', 'type' => 'string', 'example' => '200', 'title' => ''], 'Message' => ['description' => 'The message returned. If the request was successful, `successful` is returned. Otherwise, an error message is returned.', 'type' => 'string', 'example' => 'successful', 'title' => ''], 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => 'ED2BDBAC-***-***-***-495C96A63964', 'title' => ''], 'Success' => ['description' => 'Indicates whether the request was successful.'."\n" ."\n" .'- true'."\n" ."\n" .'- false', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'title' => 'RemoveDataSource', 'summary' => 'Deletes a data source.', 'description' => '>'."\n" ."\n" .'Deleting a data source can cause data loss or render related data unqueryable. Before you delete the data source, ensure that you have removed all associated backup data and backup plans.'."\n" ."\n" .'>', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"ED2BDBAC-***-***-***-495C96A63964\\",\\n \\"Success\\": true\\n}","type":"json"}]', ], 'SearchHistoricalSnapshots' => [ 'summary' => 'Retrieves one or more historical backup snapshots that meet the specified criteria.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '95649', 'abilityTreeNodes' => ['FEATUREhbr56LH1C', 'FEATUREhbrS7MI6C', 'FEATUREhbrFWIWBG', 'FEATUREhbrAW9I1R', 'FEATUREhbrB1KQ9G', 'FEATUREhbrQ3MV3B', 'FEATUREhbr3BJQCT'], ], 'parameters' => [ [ 'name' => 'SourceType', 'in' => 'query', 'schema' => ['description' => 'The type of the data source. Valid values:'."\n" ."\n" .'- **ECS\\_FILE**: a backup snapshot of ECS files.'."\n" ."\n" .'- **OSS**: a backup snapshot of Alibaba Cloud OSS.'."\n" ."\n" .'- **NAS**: a backup snapshot of Alibaba Cloud NAS.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'title' => '', 'example' => 'ECS_FILE'], ], [ 'name' => 'Query', 'in' => 'query', 'style' => 'json', 'schema' => [ 'description' => 'The query conditions. For example:'."\n" ."\n" .'```'."\n" .'['."\n" .' {'."\n" .' "field": "VaultId",'."\n" .' "value": "v-0003rf9m*****qx5",'."\n" .' "operation": "MATCH_TERM"'."\n" .' },'."\n" .' {'."\n" .' "field": "InstanceId",'."\n" .' "value": "i-bp1i20zq2*****e9368m",'."\n" .' "operation": "MATCH_TERM"'."\n" .' },'."\n" .' {'."\n" .' "field": "PlanId",'."\n" .' "value": "plan-0005vk*****gkd1iu4f",'."\n" .' "operation": "MATCH_TERM"'."\n" .' },'."\n" .' {'."\n" .' "field": "CompleteTime",'."\n" .' "value": "1626769913",'."\n" .' "operation": "GREATER_THAN_OR_EQUAL"'."\n" .' }'."\n" .']'."\n" .'```'."\n" ."\n" .'- Supported fields:'."\n" ."\n" .' - VaultId: This parameter is required. The ID of the backup vault.'."\n" ."\n" .' - InstanceId: This parameter is required only when SourceType is set to ECS\\_FILE. The ID of the ECS instance.'."\n" ."\n" .' - Bucket: This parameter is required only when SourceType is set to OSS. The name of the OSS bucket.'."\n" ."\n" .' - FileSystemId: This parameter is required only when SourceType is set to NAS. The ID of the NAS file system.'."\n" ."\n" .' - CreateTime: This parameter is required only when SourceType is set to NAS. The time when the NAS file system was created.'."\n" ."\n" .' - CompleteTime: The time when the snapshot was completed.'."\n" ."\n" .' - PlanId: The ID of the backup plan.'."\n" ."\n" .'- Supported operations:'."\n" ."\n" .' - MATCH\\_TERM: exact match.'."\n" ."\n" .' - GREATER\\_THAN: greater than.'."\n" ."\n" .' - GREATER\\_THAN\\_OR\\_EQUAL: greater than or equal to.'."\n" ."\n" .' - LESS\\_THAN: less than.'."\n" ."\n" .' - LESS\\_THAN\\_OR\\_EQUAL: less than or equal to.'."\n" ."\n" .' - BETWEEN: a range. The value is a JSON array in the `[lower bound,upper bound]` format.'."\n" ."\n" .' - IN: in a collection. The value is an array.'."\n" ."\n" .' - NOT\\_IN: not in a collection. The value is an array.', 'type' => 'array', 'items' => ['description' => 'The query conditions. For example:'."\n" ."\n" .'```'."\n" .'['."\n" .' {'."\n" .' "field": "VaultId",'."\n" .' "value": "v-0003rf9m*****qx5",'."\n" .' "operation": "MATCH_TERM"'."\n" .' },'."\n" .' {'."\n" .' "field": "InstanceId",'."\n" .' "value": "i-bp1i20zq2*****e9368m",'."\n" .' "operation": "MATCH_TERM"'."\n" .' },'."\n" .' {'."\n" .' "field": "PlanId",'."\n" .' "value": "plan-0005vk*****gkd1iu4f",'."\n" .' "operation": "MATCH_TERM"'."\n" .' },'."\n" .' {'."\n" .' "field": "CompleteTime",'."\n" .' "value": "1626769913",'."\n" .' "operation": "GREATER_THAN_OR_EQUAL"'."\n" .' }'."\n" .']'."\n" .'```'."\n" ."\n" .'- Supported fields:'."\n" ."\n" .' - VaultId: This parameter is required. The ID of the backup vault.'."\n" ."\n" .' - InstanceId: This parameter is required only when SourceType is set to ECS\\_FILE. The ID of the ECS instance.'."\n" ."\n" .' - Bucket: This parameter is required only when SourceType is set to OSS. The name of the OSS bucket.'."\n" ."\n" .' - FileSystemId: This parameter is required only when SourceType is set to NAS. The ID of the NAS file system.'."\n" ."\n" .' - CreateTime: This parameter is required only when SourceType is set to NAS. The time when the NAS file system was created.'."\n" ."\n" .' - CompleteTime: The time when the snapshot was completed.'."\n" ."\n" .' - PlanId: The ID of the backup plan.'."\n" ."\n" .'- Supported operations:'."\n" ."\n" .' - MATCH\\_TERM: exact match.'."\n" ."\n" .' - GREATER\\_THAN: greater than.'."\n" ."\n" .' - GREATER\\_THAN\\_OR\\_EQUAL: greater than or equal to.'."\n" ."\n" .' - LESS\\_THAN: less than.'."\n" ."\n" .' - LESS\\_THAN\\_OR\\_EQUAL: less than or equal to.'."\n" ."\n" .' - BETWEEN: a range. The value is a JSON array in the `[lower bound,upper bound]` format.'."\n" ."\n" .' - IN: in a collection. The value is an array.'."\n" ."\n" .' - NOT\\_IN: not in a collection. The value is an array.', 'type' => 'any', 'required' => false, 'title' => '', 'example' => '[ { "field": "VaultId", "value": "v-0003rf9m17pap3ltpqx5", "operation": "MATCH_TERM" }, { "field": "InstanceId", "value": "i-bp1i20zq2wuzdie9368m", "operation": "MATCH_TERM" }, { "field": "PlanId", "value": "plan-0005vkqhpesqgkd1iu4f", "operation": "MATCH_TERM" }, { "field": "CompleteTime", "value": 1626769913, "operation": "GREATER_THAN_OR_EQUAL" } ]'], 'required' => true, 'docRequired' => true, 'example' => '[ { "field": "VaultId", "value": "v-0003rf9m17pap3ltpqx5", "operation": "MATCH_TERM" }, { "field": "InstanceId", "value": "i-bp1i20zq2wuzdie9368m", "operation": "MATCH_TERM" }, { "field": "PlanId", "value": "plan-0005vkqhpesqgkd1iu4f", "operation": "MATCH_TERM" }, { "field": "CompleteTime", "value": 1626769913, "operation": "GREATER_THAN_OR_EQUAL" } ]', 'title' => '', ], ], [ 'name' => 'Limit', 'in' => 'query', 'schema' => ['description' => 'The maximum number of results to return.'."\n" .'To retrieve only the number of rows without any data, set Limit to `0`.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'title' => '', 'example' => '10'], ], [ 'name' => 'NextToken', 'in' => 'query', 'schema' => ['description' => 'The token that is required to obtain the next page of snapshots.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'caeba0bbb2be03f84eb48b699f0a****'], ], [ 'name' => 'SortBy', 'in' => 'query', 'schema' => ['description' => 'The field to sort by.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'CreatedTime'], ], [ 'name' => 'Order', 'in' => 'query', 'schema' => ['description' => 'The sort order. The default value is ASC.'."\n" ."\n" .'- ASC: ascending'."\n" ."\n" .'- DESC: descending', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'ASC'], ], [ 'name' => 'Edition', 'in' => 'query', 'schema' => ['type' => 'string', 'title' => '', 'description' => 'The edition. Valid values are BASIC and STANDARD. The default value is STANDARD.', 'required' => false, 'example' => 'BASIC'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'NextToken' => ['description' => 'The token that is required to obtain the next page of snapshots.', 'type' => 'string', 'title' => '', 'example' => 'BE'], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E'], 'Success' => ['description' => 'Indicates whether the request was successful.'."\n" ."\n" .'- true: The request was successful.'."\n" ."\n" .'- false: The request failed.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], 'Limit' => ['description' => 'The number of historical snapshots displayed on the current page.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '10'], 'Code' => ['description' => 'The return code. A value of 200 indicates that the request was successful.', 'type' => 'string', 'title' => '', 'example' => '200'], 'Message' => ['description' => 'The returned message. If the request is successful, \\`successful\\` is returned. If the request fails, an error message is returned.', 'type' => 'string', 'title' => '', 'example' => 'successful'], 'TotalCount' => ['description' => 'The total number of snapshots that meet the specified criteria.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '20'], 'Snapshots' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'Snapshot' => [ 'description' => 'The list of historical snapshots.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Status' => ['description' => 'The status of the backup snapshot job. Valid values:'."\n" ."\n" .'- **COMPLETE**: The job is successful.'."\n" ."\n" .'- **PARTIAL\\_COMPLETE**: The job is partially successful.'."\n" ."\n" .'- **FAILED**: The job failed.', 'type' => 'string', 'title' => '', 'example' => 'COMPLETE'], 'SnapshotHash' => ['description' => 'The hash value of the snapshot.', 'type' => 'string', 'title' => '', 'example' => 'f2fe...'], 'VaultId' => ['description' => 'The ID of the backup vault that stores the backup snapshot.', 'type' => 'string', 'title' => '', 'example' => 'v-0003rf9m17pap3ltpqx5'], 'ActualItems' => ['description' => 'The actual number of items in the snapshot.'."\n" ."\n" .'> This parameter is available only for file backups.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '6'], 'BackupType' => ['description' => 'The backup type. The value is **COMPLETE**, which indicates a full backup.', 'type' => 'string', 'title' => '', 'example' => 'COMPLETE'], 'CreateTime' => ['description' => 'This parameter is valid only when **SourceType** is set to **NAS**. This parameter indicates the time when the file system was created. This value is a UNIX timestamp. Unit: seconds.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1607436917'], 'ActualBytes' => ['description' => 'The actual data volume of the snapshot after deduplication. Unit: bytes.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '600'], 'SourceType' => ['description' => 'The type of the data source. Valid values:'."\n" ."\n" .'- **ECS\\_FILE**: a backup snapshot of ECS files.'."\n" ."\n" .'- **OSS**: a backup snapshot of Alibaba Cloud OSS.'."\n" ."\n" .'- **NAS**: a backup snapshot of Alibaba Cloud NAS.', 'type' => 'string', 'title' => '', 'example' => 'ECS_FILE'], 'Prefix' => ['description' => 'This parameter is valid only when **SourceType** is set to **OSS**. This parameter indicates the backup prefix.', 'type' => 'string', 'title' => '', 'example' => 'example/'], 'ClientId' => ['description' => 'This parameter is valid only when **SourceType** is set to **ECS\\_FILE**. This parameter indicates the ID of the backup client.', 'type' => 'string', 'title' => '', 'example' => 'c-*********************'], 'BytesTotal' => ['description' => 'The total volume of the data source. Unit: bytes.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1000'], 'ItemsDone' => ['description' => 'The number of backed up items.'."\n" ."\n" .'> This parameter is available only for file backups.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '8'], 'CompleteTime' => ['description' => 'The time when the backup snapshot was completed. This value is a UNIX timestamp. Unit: seconds.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1554347313'], 'Retention' => ['description' => 'The retention period of the backup snapshot in days.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '7'], 'CreatedTime' => ['description' => 'The time when the backup snapshot was created. This value is a UNIX timestamp. Unit: seconds.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1554347313'], 'Bucket' => ['description' => 'This parameter is valid only when **SourceType** is set to **OSS**. This parameter indicates the name of the OSS bucket.', 'type' => 'string', 'title' => '', 'example' => 'hbr-backup-oss'], 'ParentSnapshotHash' => ['description' => 'The hash value of the parent backup snapshot.', 'type' => 'string', 'title' => '', 'example' => 'f2fe..'], 'InstanceId' => ['description' => 'This parameter is valid only when **SourceType** is set to **ECS\\_FILE**. This parameter indicates the ID of the ECS instance.', 'type' => 'string', 'title' => '', 'example' => 'i-*********************'], 'FileSystemId' => ['description' => 'This parameter is valid only when **SourceType** is set to **NAS**. This parameter indicates the ID of the file system.', 'type' => 'string', 'title' => '', 'example' => '005494'], 'ErrorFile' => ['description' => 'The file that records information about backup failures. This includes information about partially completed backups.', 'type' => 'string', 'title' => '', 'example' => 'Item Error Message C:\\Program Files (x86)\\Symantec\\Symantec Endpoint Protection\\14.3.558.0000.105\\Bin\\service.dat Open: open \\\\?\\C:\\Program Files (x86)\\Symantec\\Symantec Endpoint Protection\\14.3.558.0000.105\\Bin\\service.dat: The process cannot access the file because it is being used by another process. C:\\ProgramData\\McAfee\\Agent\\data\\InstallerFiles\\172e8a3b04b7ab0fd0215f4fb7707e3744b37d83b6743b3eacb94447c74dc9af_contrib.ini Open: open \\\\?\\C:\\ProgramData\\McAfee\\Agent\\data\\InstallerFiles\\172e8a3b04b7ab0fd0215f4fb7707e3744b37d83b6743b3eacb94447c74dc9af_contrib.ini: Access is denied.'], 'StartTime' => ['description' => 'The time when the snapshot started. This value is a UNIX timestamp. Unit: seconds.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1554347313'], 'UpdatedTime' => ['description' => 'The time when the backup snapshot was updated. This value is a UNIX timestamp. Unit: seconds.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1554347313'], 'SnapshotId' => ['description' => 'The ID of the backup snapshot.', 'type' => 'string', 'title' => '', 'example' => 's-*********************'], 'JobId' => ['description' => 'The ID of the backup job.', 'type' => 'string', 'title' => '', 'example' => 'v-*********************'], 'Path' => ['description' => 'This parameter is valid only when **SourceType** is set to **ECS\\_FILE**. This parameter indicates the path of the backed up files.', 'type' => 'string', 'title' => '', 'example' => '["/home"]'], 'ItemsTotal' => ['description' => 'The total number of items in the data source.'."\n" ."\n" .'> This parameter is available only for file backups.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '10'], 'BytesDone' => ['description' => 'The data volume of the incremental backup. Unit: bytes.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '800'], 'Paths' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'Path' => [ 'description' => 'The list of paths to the backed up files.', 'example' => '"/home"', 'type' => 'array', 'items' => ['description' => 'This parameter is valid only when **SourceType** is set to **NAS**. This parameter indicates the path of the backed up files.', 'type' => 'string', 'title' => '', 'example' => '"/home"'], 'title' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], 'InstanceName' => ['description' => 'The name of the Tablestore instance.', 'type' => 'string', 'title' => '', 'example' => 'instancename'], 'TableName' => ['description' => 'The name of the data table in the Tablestore instance.', 'type' => 'string', 'title' => '', 'example' => 'table2'], 'RangeStart' => ['description' => 'The time when the backup job started. This value is a UNIX timestamp. Unit: milliseconds.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1642492553038'], 'RangeEnd' => ['description' => 'The time when the backup job ended. This value is a UNIX timestamp. Unit: milliseconds.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1642521709966'], 'ExpireTime' => ['description' => 'The expiration time of the snapshot. This value is a UNIX timestamp. Unit: seconds.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1640334062'], 'SourceSnapshotHash' => ['description' => 'The hash value of the snapshot before it was archived.', 'type' => 'string', 'title' => '', 'example' => 'qwer***'], 'SourceParentSnapshotHash' => ['description' => 'The hash value of the parent snapshot before it was archived.', 'type' => 'string', 'title' => '', 'example' => 'qwer***'], 'StorageClass' => ['description' => 'The storage class. Valid values:'."\n" ."\n" .'- **Standard**: Standard.'."\n" ."\n" .'- **Archive**: Archive.'."\n" ."\n" .'- **ColdArchive**: Cold Archive.', 'type' => 'string', 'title' => '', 'example' => 'STANDARD'], 'ArchiveTime' => ['description' => 'The time when the snapshot was archived.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1640334062'], 'UseCommonNas' => ['description' => 'Indicates whether a local NAS file system is used.', 'type' => 'boolean', 'title' => '', 'example' => 'false'], 'Include' => ['description' => 'The backup paths that are included in the backup job.', 'type' => 'string', 'title' => '', 'example' => '[\\"/test/example_cn-huhehaote_3.txt\\", \\"/test/example_cn-huhehaote_9.txt\\", \\"/test/example_cn-huhehaote_5.txt\\", \\"/test/example_cn-huhehaote_1.txt\\", \\"/test/example_cn-huhehaote_7.txt\\"]'], 'Exclude' => ['description' => 'The backup paths that are excluded from the backup job.', 'type' => 'string', 'title' => '', 'example' => '[\\"/test/example_cn-hangzhou_7.txt\\", \\"/test/example_cn-hangzhou_1.txt\\", \\"/test/example_cn-hangzhou_3.txt\\", \\"/test/example_cn-hangzhou_9.txt\\", \\"/test/example_cn-hangzhou_6.txt\\"]'], 'ProtectedDataSize' => ['type' => 'integer', 'format' => 'int64', 'title' => '', 'description' => 'The amount of data on the source side that is protected. Unit: bytes. If SourceType is set to ECS\\_FILE, this parameter indicates the capacity of the protected disk.', 'example' => '42949672960'], ], 'description' => '', 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"NextToken\\": \\"BE\\",\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\",\\n \\"Success\\": true,\\n \\"Limit\\": 10,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"TotalCount\\": 20,\\n \\"Snapshots\\": {\\n \\"Snapshot\\": [\\n {\\n \\"Status\\": \\"COMPLETE\\",\\n \\"SnapshotHash\\": \\"f2fe...\\",\\n \\"VaultId\\": \\"v-0003rf9m17pap3ltpqx5\\",\\n \\"ActualItems\\": 6,\\n \\"BackupType\\": \\"COMPLETE\\",\\n \\"CreateTime\\": 1607436917,\\n \\"ActualBytes\\": 600,\\n \\"SourceType\\": \\"ECS_FILE\\",\\n \\"Prefix\\": \\"example/\\",\\n \\"ClientId\\": \\"c-*********************\\",\\n \\"BytesTotal\\": 1000,\\n \\"ItemsDone\\": 8,\\n \\"CompleteTime\\": 1554347313,\\n \\"Retention\\": 7,\\n \\"CreatedTime\\": 1554347313,\\n \\"Bucket\\": \\"hbr-backup-oss\\",\\n \\"ParentSnapshotHash\\": \\"f2fe..\\",\\n \\"InstanceId\\": \\"i-*********************\\",\\n \\"FileSystemId\\": \\"005494\\",\\n \\"ErrorFile\\": \\"Item\\\\tError Message C:\\\\\\\\Program Files (x86)\\\\\\\\Symantec\\\\\\\\Symantec Endpoint Protection\\\\\\\\14.3.558.0000.105\\\\\\\\Bin\\\\\\\\service.dat\\\\tOpen: open \\\\\\\\\\\\\\\\?\\\\\\\\C:\\\\\\\\Program Files (x86)\\\\\\\\Symantec\\\\\\\\Symantec Endpoint Protection\\\\\\\\14.3.558.0000.105\\\\\\\\Bin\\\\\\\\service.dat: The process cannot access the file because it is being used by another process. C:\\\\\\\\ProgramData\\\\\\\\McAfee\\\\\\\\Agent\\\\\\\\data\\\\\\\\InstallerFiles\\\\\\\\172e8a3b04b7ab0fd0215f4fb7707e3744b37d83b6743b3eacb94447c74dc9af_contrib.ini\\\\tOpen: open \\\\\\\\\\\\\\\\?\\\\\\\\C:\\\\\\\\ProgramData\\\\\\\\McAfee\\\\\\\\Agent\\\\\\\\data\\\\\\\\InstallerFiles\\\\\\\\172e8a3b04b7ab0fd0215f4fb7707e3744b37d83b6743b3eacb94447c74dc9af_contrib.ini: Access is denied.\\",\\n \\"StartTime\\": 1554347313,\\n \\"UpdatedTime\\": 1554347313,\\n \\"SnapshotId\\": \\"s-*********************\\",\\n \\"JobId\\": \\"v-*********************\\",\\n \\"Path\\": \\"[\\\\\\"/home\\\\\\"]\\",\\n \\"ItemsTotal\\": 10,\\n \\"BytesDone\\": 800,\\n \\"Paths\\": {\\n \\"Path\\": [\\n \\"\\\\\\"/home\\\\\\"\\"\\n ]\\n },\\n \\"InstanceName\\": \\"instancename\\",\\n \\"TableName\\": \\"table2\\",\\n \\"RangeStart\\": 1642492553038,\\n \\"RangeEnd\\": 1642521709966,\\n \\"ExpireTime\\": 1640334062,\\n \\"SourceSnapshotHash\\": \\"qwer***\\",\\n \\"SourceParentSnapshotHash\\": \\"qwer***\\",\\n \\"StorageClass\\": \\"STANDARD\\",\\n \\"ArchiveTime\\": 1640334062,\\n \\"UseCommonNas\\": false,\\n \\"Include\\": \\"[\\\\\\\\\\\\\\"/test/example_cn-huhehaote_3.txt\\\\\\\\\\\\\\", \\\\\\\\\\\\\\"/test/example_cn-huhehaote_9.txt\\\\\\\\\\\\\\", \\\\\\\\\\\\\\"/test/example_cn-huhehaote_5.txt\\\\\\\\\\\\\\", \\\\\\\\\\\\\\"/test/example_cn-huhehaote_1.txt\\\\\\\\\\\\\\", \\\\\\\\\\\\\\"/test/example_cn-huhehaote_7.txt\\\\\\\\\\\\\\"]\\",\\n \\"Exclude\\": \\"[\\\\\\\\\\\\\\"/test/example_cn-hangzhou_7.txt\\\\\\\\\\\\\\", \\\\\\\\\\\\\\"/test/example_cn-hangzhou_1.txt\\\\\\\\\\\\\\", \\\\\\\\\\\\\\"/test/example_cn-hangzhou_3.txt\\\\\\\\\\\\\\", \\\\\\\\\\\\\\"/test/example_cn-hangzhou_9.txt\\\\\\\\\\\\\\", \\\\\\\\\\\\\\"/test/example_cn-hangzhou_6.txt\\\\\\\\\\\\\\"]\\",\\n \\"ProtectedDataSize\\": 42949672960\\n }\\n ]\\n }\\n}","type":"json"}]', 'title' => 'SearchHistoricalSnapshots', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'SearchHistoricalSnapshots'], ], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'hbr:SearchHistoricalSnapshots', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'HBR', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], ], 'StartHanaDatabaseAsync' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'systemTags' => [ 'operationType' => 'update', 'abilityTreeCode' => '95654', 'abilityTreeNodes' => ['FEATUREhbrI97IXK'], ], 'parameters' => [ [ 'name' => 'VaultId', 'in' => 'query', 'schema' => ['description' => 'The ID of the backup vault.'."\n", 'type' => 'string', 'required' => true, 'example' => 'v-0000hrh******vhr3i'], ], [ 'name' => 'ClusterId', 'in' => 'query', 'schema' => ['description' => 'The ID of the SAP HANA instance.'."\n", 'type' => 'string', 'required' => true, 'example' => 'cl-000a9ipe******sme'], ], [ 'name' => 'DatabaseName', 'in' => 'query', 'schema' => ['description' => 'The database name.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'HXE'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Code' => ['description' => 'The response code. The status code 200 indicates that the request was successful.'."\n", 'type' => 'string', 'example' => '200'], 'Message' => ['description' => 'The returned message. If the request was successful, "successful" is returned. If the request failed, an error message is returned.'."\n", 'type' => 'string', 'example' => 'successful'], 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E'], 'TaskId' => ['description' => 'The ID of the job that is used to initialize the backup vault. You can call the DescribeTask operation to query the job status.'."\n", 'type' => 'string', 'example' => 't-000bjt479yefheij1o0x'], 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" ."\n" .'* true'."\n" .'* false'."\n", 'type' => 'boolean', 'example' => 'true'], ], 'description' => '', ], ], ], 'title' => 'StartHanaDatabaseAsync', 'summary' => 'Starts an SAP HANA database.', 'description' => 'To stop the database again, call the StopHanaDatabaseAsync operation.'."\n", 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'StartHanaDatabaseAsync'], ], ], 'ramActions' => [], 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\",\\n \\"TaskId\\": \\"t-000bjt479yefheij1o0x\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n 200\\n successful\\n 473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\n t-000bjt479yefheij1o0x\\n true\\n","errorExample":""}]', ], 'StopHanaDatabaseAsync' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'systemTags' => [ 'operationType' => 'update', 'abilityTreeCode' => '95656', 'abilityTreeNodes' => ['FEATUREhbrI97IXK'], ], 'parameters' => [ [ 'name' => 'VaultId', 'in' => 'query', 'schema' => ['description' => 'The ID of the backup vault.'."\n", 'type' => 'string', 'required' => true, 'example' => 'v-0006wkn******gzkn'], ], [ 'name' => 'ClusterId', 'in' => 'query', 'schema' => ['description' => 'The ID of the SAP HANA instance.'."\n", 'type' => 'string', 'required' => true, 'example' => 'cl-000dw******45ijer'], ], [ 'name' => 'DatabaseName', 'in' => 'query', 'schema' => ['description' => 'The database name.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'BWP'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Code' => ['description' => 'The response code. The status code 200 indicates that the request was successful.'."\n", 'type' => 'string', 'example' => '200'], 'Message' => ['description' => 'The returned message. If the request was successful, "successful" is returned. If the request failed, an error message is returned.'."\n", 'type' => 'string', 'example' => 'successful'], 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'CD8B903B-DE8F-5969-9414-B2C634D504D9'], 'TaskId' => ['description' => 'The ID of the asynchronous job. You can call the DescribeTask operation to query the execution result of an asynchronous job.'."\n", 'type' => 'string', 'example' => 't-0007o3vqfukgd3y5bxxr'], 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" ."\n" .'* true'."\n" .'* false'."\n", 'type' => 'boolean', 'example' => 'true'], ], 'description' => '', ], ], ], 'title' => 'StopHanaDatabaseAsync', 'summary' => 'Stops an SAP HANA database.', 'description' => 'To start the database again, call the StartHanaDatabaseAsync operation.'."\n", 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'StopHanaDatabaseAsync'], ], ], 'ramActions' => [], 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"CD8B903B-DE8F-5969-9414-B2C634D504D9\\",\\n \\"TaskId\\": \\"t-0007o3vqfukgd3y5bxxr\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n 200\\n successful\\n CD8B903B-DE8F-5969-9414-B2C634D504D9\\n t-0007o3vqfukgd3y5bxxr\\n true\\n","errorExample":""}]', ], 'UninstallBackupClients' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'abilityTreeCode' => '95660', 'abilityTreeNodes' => ['FEATUREhbrS7MI6C'], ], 'parameters' => [ [ 'name' => 'InstanceIds', 'in' => 'query', 'style' => 'json', 'schema' => ['description' => 'The IDs of Elastic Compute Service (ECS) instances. You can specify a maximum of 20 ECS instances.'."\n", 'type' => 'object', 'required' => false, 'docRequired' => true, 'example' => '["i-0xi5wj5*****v3j3bh2gj5"]', 'default' => '[]'], ], [ 'name' => 'ClientIds', 'in' => 'query', 'style' => 'json', 'schema' => ['description' => 'The IDs of Cloud Backup clients. The sum of the number of Cloud Backup client IDs and the number of ECS instance IDs cannot exceed 20. Otherwise, an error occurs.'."\n", 'type' => 'object', 'required' => false, 'example' => '["c-*********************"]', 'default' => '[]'], ], [ 'name' => 'CrossAccountType', 'in' => 'query', 'schema' => ['description' => 'Specifies whether data is backed up and restored within the same Alibaba Cloud account or across Alibaba Cloud accounts. Valid values:'."\n" ."\n" .'* SELF_ACCOUNT: Data is backed up and restored within the same Alibaba Cloud account.'."\n" .'* CROSS_ACCOUNT: Data is backed up and restored across Alibaba Cloud accounts.'."\n", 'type' => 'string', 'required' => false, 'example' => 'CROSS_ACCOUNT'], ], [ 'name' => 'CrossAccountUserId', 'in' => 'query', 'schema' => ['description' => 'The ID of the source Alibaba Cloud account that authorizes the current Alibaba Cloud account to back up and restore data across Alibaba Cloud accounts.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '129349237xxxxx'], ], [ 'name' => 'CrossAccountRoleName', 'in' => 'query', 'schema' => ['description' => 'The name of the RAM role that is created within the source Alibaba Cloud account and assigned to the current Alibaba Cloud account to authorize the current Alibaba Cloud account to back up and restore data across Alibaba Cloud accounts.'."\n", 'type' => 'string', 'required' => false, 'example' => 'BackupRole'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Code' => ['description' => 'The HTTP status code. The status code 200 indicates that the request is successful.'."\n", 'type' => 'string', 'example' => '200'], 'Message' => ['description' => 'The message that is returned. If the request is successful, a value of successful is returned. If the request fails, an error message is returned.'."\n", 'type' => 'string', 'example' => 'successful'], 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E'], 'TaskId' => ['description' => 'The ID of the asynchronous job. You can call the DescribeTask operation to query the execution result of the asynchronous job.'."\n", 'type' => 'string', 'example' => 't-*********************'], 'Success' => ['description' => 'Indicates whether the request is successful.'."\n" ."\n" .'* true: The request is successful.'."\n" .'* false: The request fails.'."\n", 'type' => 'boolean', 'example' => 'true'], 'InstanceStatuses' => [ 'description' => 'The status of the ECS instance.'."\n", 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'ValidInstance' => ['description' => 'Indicates whether a backup client can be installed on the ECS instance.'."\n" ."\n" .'* true: A backup client can be installed on the ECS instance.'."\n" .'* false: A backup client cannot be installed on the ECS instance.'."\n", 'type' => 'boolean', 'example' => 'true'], 'InstanceId' => ['description' => 'The ID of the ECS instance.'."\n", 'type' => 'string', 'example' => 'i-0xi5w***v3j3bh2gj5'], 'ErrorCode' => ['description' => 'The error code. Valid values:'."\n" ."\n" .'* If the value is empty, the request is successful.'."\n" .'* **InstanceNotExists**: The ECS instance does not exist.'."\n" .'* **InstanceNotRunning**: The ECS instance is not running.'."\n" .'* **CloudAssistNotRunningOnInstance**: Cloud Assistant is unavailable.'."\n", 'type' => 'string', 'example' => 'InstanceNotExists'], ], ], ], ], ], ], ], 'title' => 'UninstallBackupClients', 'summary' => 'Uninstalls a Cloud Backup client from one or more Elastic Compute Service (ECS) instance.', 'description' => '* This operation creates an asynchronous job at the backend and calls Cloud Assistant to uninstall a backup client from an ECS instance.'."\n" .'* You can call the DescribeTask operation to query the execution result of an asynchronous job.'."\n" .'* The timeout period of an asynchronous job is 15 minutes. We recommend that you call the DescribeTask operation to run the first query 30 seconds after you call the UninstallBackupClients operation to uninstall backup clients. Then, run the next queries at an interval of 30 seconds.'."\n", 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'UninstallBackupClients'], ], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'hbr:UninstallBackupClients', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'HBR', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\",\\n \\"TaskId\\": \\"t-*********************\\",\\n \\"Success\\": true,\\n \\"InstanceStatuses\\": [\\n {\\n \\"ValidInstance\\": true,\\n \\"InstanceId\\": \\"i-0xi5w***v3j3bh2gj5\\",\\n \\"ErrorCode\\": \\"InstanceNotExists\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n 200\\n successful\\n 473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\n t-*********************\\n true\\n \\n true\\n i-0xi5w***v3j3bh2gj5\\n InstanceNotExists\\n \\n","errorExample":""}]', ], 'UninstallClient' => [ 'methods' => ['post', 'get'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'systemTags' => [ 'operationType' => 'delete', 'abilityTreeCode' => '95661', 'abilityTreeNodes' => ['FEATUREhbrI97IXK'], ], 'parameters' => [ [ 'name' => 'VaultId', 'in' => 'query', 'schema' => ['description' => 'The ID of the backup vault.'."\n", 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'v-0008n2q******ax3'], ], [ 'name' => 'ClientId', 'in' => 'query', 'schema' => ['description' => 'The ID of the HBR client.'."\n", 'type' => 'string', 'required' => true, 'example' => 'c-000iuqo******zi3rn'], ], [ 'name' => 'ResourceGroupId', 'in' => 'query', 'schema' => ['description' => 'The ID of the resource group.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rg-acfm3erpwweavki'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Code' => ['description' => 'The HTTP status code. The status code 200 indicates that the call is successful.'."\n", 'type' => 'string', 'example' => '200'], 'Message' => ['description' => 'The message that is returned. If the call is successful, "successful" is returned. If the call fails, an error message is returned.'."\n", 'type' => 'string', 'example' => 'successful'], 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '048A2164-3732-5DF5-88B5-F97FA56DAEB1'], 'TaskId' => ['description' => 'The ID of the asynchronous job. You can call the DescribeTask operation to query the execution result of an asynchronous job.'."\n", 'type' => 'string', 'example' => 't-0009qs5qcnvuvqrl2mxl'], 'Success' => ['description' => 'Indicates whether the call is successful. Valid values:'."\n" ."\n" .'* true: The call is successful.'."\n" .'* false: The call fails.'."\n", 'type' => 'boolean', 'example' => 'true'], ], ], ], ], 'title' => 'UninstallClient', 'summary' => 'Uninstalls an HBR client.', 'description' => 'If you call this operation, the specified HBR client is uninstalled. To reinstall the HBR client, call the CreateClients operation.'."\n", 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'UninstallClient'], ], ], 'ramActions' => [], 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"048A2164-3732-5DF5-88B5-F97FA56DAEB1\\",\\n \\"TaskId\\": \\"t-0009qs5qcnvuvqrl2mxl\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n 200\\n successful\\n 048A2164-3732-5DF5-88B5-F97FA56DAEB1\\n t-0009qs5qcnvuvqrl2mxl\\n true\\n","errorExample":""}]', ], 'UpdateBackupPlan' => [ 'summary' => 'Updates a backup plan.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '95667', 'abilityTreeNodes' => ['FEATUREhbr9ZUQY7'], ], 'parameters' => [ [ 'name' => 'PlanId', 'in' => 'query', 'schema' => ['description' => 'The ID of the backup plan.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => 'plan-20211***735'], ], [ 'name' => 'PlanName', 'in' => 'query', 'schema' => ['description' => 'The name of the backup plan.', 'type' => 'string', 'required' => false, 'maxLength' => 64, 'minLength' => 1, 'title' => '', 'example' => 'planname'], ], [ 'name' => 'Schedule', 'in' => 'query', 'schema' => ['description' => 'The backup policy. Use the `I|{startTime}|{interval}` format. This specifies that a backup job runs at a recurring interval. The `{startTime}` is when the backup starts. The `{interval}` is the time between jobs. HBR does not run overdue backup jobs. If the previous backup job is not finished, the next one does not start. For example, `I|1631685600|P1D` means the backup runs once a day, starting at 14:00:00 on September 15, 2021.'."\n" ."\n" .'- **startTime**: The start time of the backup. This is a UNIX timestamp in seconds.'."\n" ."\n" .'- **interval**: The time interval. Use the ISO 8601 standard. For example, PT1H specifies an interval of one hour. P1D specifies an interval of one day.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'I|1602673264|P1D'], ], [ 'name' => 'Retention', 'in' => 'query', 'schema' => ['description' => 'The number of days to retain backups. The minimum value is 1.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'docRequired' => true, 'title' => '', 'example' => '7'], ], [ 'name' => 'Prefix', 'in' => 'query', 'schema' => ['description' => 'This parameter is required only when **SourceType** is set to **OSS**. This parameter specifies the prefix of objects to back up. After you specify a prefix, only objects that match the prefix are backed up.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'oss-prefix'], ], [ 'name' => 'VaultId', 'in' => 'query', 'schema' => ['description' => 'The ID of the backup repository.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'title' => '', 'example' => 'v-0006******q'], ], [ 'name' => 'Detail', 'in' => 'query', 'style' => 'json', 'schema' => ['description' => 'The details of the ECS instance backup. This is a JSON string.'."\n" ."\n" .'- snapshotGroup: Specifies whether to use a snapshot-consistent group. This feature is available only when all disks of the instance are Enhanced Solid-State Drives (ESSDs).'."\n" ."\n" .'- appConsistent: Specifies whether to enable application consistency. You must also configure the preScriptPath and postScriptPath parameters.'."\n" ."\n" .'- preScriptPath: The path to the pre-freeze script.'."\n" ."\n" .'- postScriptPath: The path to the post-thaw script.', 'type' => 'object', 'required' => false, 'title' => '', 'example' => '{\\"EnableFsFreeze\\":true,\\"appConsistent\\":false,\\"postScriptPath\\":\\"\\",\\"preScriptPath\\":\\"\\",\\"snapshotGroup\\":true,\\"timeoutInSeconds\\":60}'], ], [ 'name' => 'SourceType', 'in' => 'query', 'schema' => ['description' => 'The type of the data source. Valid values:'."\n" ."\n" .'- **ECS\\_FILE**: Backs up ECS files.'."\n" ."\n" .'- **OSS**: Backs up Alibaba Cloud OSS.'."\n" ."\n" .'- **NAS**: Backs up Alibaba Cloud NAS.'."\n" ."\n" .'- **OTS**: Backs up Alibaba Cloud Tablestore.'."\n" ."\n" .'- **UDM\\_ECS**: Backs up an entire ECS instance.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'ECS_FILE'], ], [ 'name' => 'SpeedLimit', 'in' => 'query', 'schema' => ['description' => 'This parameter is required only when **SourceType** is set to **ECS\\_FILE**. This parameter specifies traffic shaping for backups. Traffic shaping helps you control backup traffic during peak business hours to avoid affecting your services. The format is `{start}|{end}|{bandwidth}`. You can specify multiple traffic shaping rules. Separate them with vertical bars (|). The time ranges of the rules cannot overlap.'."\n" ."\n" .'- **start**: The start hour.'."\n" ."\n" .'- **end**: The end hour.'."\n" ."\n" .'- **bandwidth**: The maximum speed. Unit: KB/s.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => '0:24:5120'], ], [ 'name' => 'Include', 'in' => 'formData', 'schema' => ['description' => 'This parameter is required only when **SourceType** is set to **ECS\\_FILE**. This parameter specifies the paths to the files to back up. All files in the specified paths are backed up. The value can be up to 255 characters in length.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => '["/home/alice/*.pdf", "/home/bob/*.txt"]'], ], [ 'name' => 'Exclude', 'in' => 'formData', 'schema' => ['description' => 'This parameter is required only when **SourceType** is set to **ECS\\_FILE**. This parameter specifies the paths to the files to exclude from the backup. All files in the specified paths are not backed up. The value can be up to 255 characters in length.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => '["/var", "/proc"]'], ], [ 'name' => 'Options', 'in' => 'formData', 'schema' => ['description' => 'This parameter is required only when **SourceType** is set to **ECS\\_FILE**. This parameter specifies whether to use Volume Shadow Copy Service (VSS) to define the backup path.'."\n" ."\n" .'- This feature is available only for Windows ECS instances.'."\n" ."\n" .'- If data changes occur in the backup source, set this parameter to `["UseVSS":true]` to ensure data consistency.'."\n" ."\n" .'- If you enable VSS, you cannot back up multiple file directories at the same time.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => '{"UseVSS":false}'], ], [ 'name' => 'UpdatePaths', 'in' => 'query', 'schema' => ['description' => 'Specifies whether to update the backup paths if the Path parameter is empty.'."\n" ."\n" .'- true: Updates the backup paths based on the paths specified in this call.'."\n" ."\n" .'- false: Does not update the backup paths. The backup paths that were configured when the backup plan was created are used.', 'type' => 'boolean', 'required' => false, 'title' => '', 'example' => 'false'], ], [ 'name' => 'Path', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => 'The backup paths.', 'type' => 'array', 'items' => ['description' => 'The backup path. The value can be up to 65,536 characters in length.'."\n" .'The following rules apply:'."\n" ."\n" .'- If you do not use wildcard characters (\\*), you can enter up to 20 paths.'."\n" ."\n" .'- If you use wildcard characters (\\*), you can enter only one path. Wildcard characters such as `/*/*` are supported.'."\n" ."\n" .'- Each path must be an absolute path.'."\n" ."\n" .'- If you use VSS, you cannot specify multiple paths, UNC paths, wildcard characters, or excluded files.'."\n" ."\n" .'- If you use a UNC path, you cannot use VSS, wildcard characters, or excluded files. If the backup source contains a UNC path, Windows Access Control Lists (ACLs) are not backed up.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => '["/home"]'], 'required' => false, 'maxItems' => 20, 'title' => '', 'example' => '', ], ], [ 'name' => 'Rule', 'in' => 'formData', 'style' => 'repeatList', 'schema' => [ 'description' => 'The rules of the backup plan.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'DestinationRetention' => ['description' => 'The number of days to retain the geo-redundant backup.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'title' => '', 'example' => '7'], 'Schedule' => ['description' => 'The backup policy. Use the I|{startTime}|{interval} format. This specifies that a backup job runs at a recurring interval. The {startTime} is when the backup starts. The {interval} is the time between jobs. HBR does not run overdue backup jobs. If the previous backup job is not finished, the next one does not start. For example, I|1631685600|P1D means the backup runs once a day, starting at 14:00:00 on September 15, 2021.'."\n" ."\n" .'startTime: The start time of the backup. This is a UNIX timestamp in seconds. interval: The time interval. Use the ISO 8601 standard. For example, PT1H specifies an interval of one hour. P1D specifies an interval of one day.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'I|1631685600|P1D'], 'Disabled' => ['description' => 'Specifies whether to disable the policy.', 'type' => 'boolean', 'required' => false, 'title' => '', 'example' => 'false'], 'Retention' => ['description' => 'The number of days to retain backups. The minimum value is 1.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'title' => '', 'example' => '7'], 'DoCopy' => ['description' => 'Specifies whether to enable geo-redundant replication.', 'type' => 'boolean', 'required' => false, 'title' => '', 'example' => 'false'], 'DestinationRegionId' => ['description' => 'The ID of the destination region for the geo-redundant backup.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'cn-shanghai'], 'RuleName' => ['description' => 'The name of the policy.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'rule-test-name'], 'BackupType' => ['description' => 'The backup type. Set the value to **COMPLETE**. This indicates a full backup.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'COMPLETE'], ], 'required' => false, 'description' => '', 'title' => '', 'example' => '', ], 'required' => false, 'maxItems' => 64, 'title' => '', 'example' => '', ], ], [ 'name' => 'OtsDetail', 'in' => 'formData', 'style' => 'json', 'schema' => ['description' => 'The details of the Tablestore instance.', 'required' => false, '$ref' => '#/components/schemas/OtsDetail', 'title' => '', 'example' => ''], ], [ 'name' => 'KeepLatestSnapshots', 'in' => 'query', 'schema' => ['description' => 'Specifies whether to permanently retain the latest backup version.'."\n" ."\n" .'- 0: No'."\n" ."\n" .'- 1: Yes', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'title' => '', 'example' => '1'], ], [ 'name' => 'ChangeListPath', 'in' => 'query', 'schema' => ['description' => 'The configuration for the incremental file synchronization list. (This parameter is required only for file synchronization.)', 'type' => 'string', 'required' => false, 'title' => '', 'example' => '{"dataSourceId": "ds-123456789", "path": "/changelist"}'], ], [ 'name' => 'Edition', 'in' => 'query', 'schema' => ['type' => 'string', 'title' => '', 'description' => 'The edition. Valid values are BASIC and STANDARD. The default value is STANDARD.', 'required' => false, 'example' => 'STANDARD'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Code' => ['description' => 'The return code. A value of 200 indicates that the request was successful.', 'type' => 'string', 'title' => '', 'example' => '200'], 'Message' => ['description' => 'The message returned. If the request is successful, \\`successful\\` is returned. If the request fails, an error message is returned.', 'type' => 'string', 'title' => '', 'example' => 'successful'], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E'], 'Success' => ['description' => 'Indicates whether the request was successful.'."\n" ."\n" .'- true: The request was successful.'."\n" ."\n" .'- false: The request failed.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\",\\n \\"Success\\": true\\n}","type":"json"}]', 'title' => 'UpdateBackupPlan', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'UpdateBackupPlan'], ], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'hbr:UpdateBackupPlan', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'HBR', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], ], 'UpdateClientSettings' => [ 'methods' => ['post', 'get'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'abilityTreeCode' => '95671', 'abilityTreeNodes' => ['FEATUREhbr9ZUQY7'], ], 'parameters' => [ [ 'name' => 'UseHttps', 'in' => 'query', 'schema' => ['description' => 'Specifies whether to transmit the data on the data plane over HTTPS. Valid values:'."\n" ."\n" .'- true: Data is transmitted over HTTPS.'."\n" ."\n" .'- false: Data is transmitted over HTTP.', 'type' => 'boolean', 'required' => false, 'docRequired' => true, 'example' => 'false', 'title' => ''], ], [ 'name' => 'VaultId', 'in' => 'query', 'schema' => ['description' => 'The ID of the backup vault. This parameter is required for the old HBR client.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'v-*********************', 'title' => ''], ], [ 'name' => 'ClientId', 'in' => 'query', 'schema' => ['description' => 'The ID of the HBR client.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'c-*********************', 'title' => ''], ], [ 'name' => 'DataNetworkType', 'in' => 'query', 'schema' => ['description' => 'The type of the endpoint on the data plane. Valid values:'."\n" ."\n" .'- **PUBLIC**: Internet'."\n" ."\n" .'- **VPC**: virtual private cloud (VPC)'."\n" ."\n" .'- **CLASSIC**: classic network', 'type' => 'string', 'required' => false, 'example' => 'VPC', 'title' => ''], ], [ 'name' => 'MaxCpuCore', 'in' => 'query', 'schema' => ['description' => 'The number of CPU cores used by a single backup job. The value 0 indicates that the number is unlimited.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '999', 'minimum' => '0', 'example' => '1', 'title' => ''], ], [ 'name' => 'MaxWorker', 'in' => 'query', 'schema' => ['description' => 'The number of concurrent backup jobs. The value 0 indicates that the number is unlimited.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '999', 'minimum' => '0', 'example' => '1', 'title' => ''], ], [ 'name' => 'DataProxySetting', 'in' => 'query', 'schema' => [ 'description' => 'The proxy configuration on the data plane. Valid values:'."\n" ."\n" .'- **DISABLE**: The proxy is not used.'."\n" ."\n" .'- **USE\\_CONTROL\\_PROXY** (default): The configuration is the same as that on the control plane.'."\n" ."\n" .'- **CUSTOM**: The configuration is customized (HTTP).', 'type' => 'string', 'required' => false, 'enum' => ['DISABLE', 'USE_CONTROL_PROXY', 'CUSTOM'], 'example' => 'USE_CONTROL_PROXY', 'title' => '', ], ], [ 'name' => 'ProxyHost', 'in' => 'query', 'schema' => ['description' => 'The custom host IP address of the proxy server on the data plane.', 'type' => 'string', 'required' => false, 'example' => '192.168.11.100', 'title' => ''], ], [ 'name' => 'ProxyPort', 'in' => 'query', 'schema' => ['description' => 'The custom host port of the proxy server on the data plane.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '65536', 'minimum' => '1', 'example' => '3128', 'title' => ''], ], [ 'name' => 'ProxyUser', 'in' => 'query', 'schema' => ['description' => 'The custom username of the proxy server on the data plane.', 'type' => 'string', 'required' => false, 'example' => 'user', 'title' => ''], ], [ 'name' => 'ProxyPassword', 'in' => 'query', 'schema' => ['description' => 'The custom password of the proxy server on the data plane.', 'type' => 'string', 'required' => false, 'example' => '******', 'title' => ''], ], [ 'name' => 'ResourceGroupId', 'in' => 'query', 'schema' => ['description' => 'The ID of the resource group.', 'type' => 'string', 'required' => false, 'example' => 'rg-*********************', 'title' => ''], ], [ 'name' => 'MaxMemory', 'in' => 'query', 'schema' => ['description' => 'The maximum memory that can be used by the client. Unit: bytes. Only V2.13.0 and later are supported.', 'type' => 'integer', 'format' => 'int64', 'maximum' => '1099511627776', 'exclusiveMaximum' => false, 'minimum' => '0', 'required' => false, 'example' => '4096', 'title' => ''], ], [ 'name' => 'AlertOnPartialComplete', 'in' => 'query', 'schema' => ['description' => 'Specifies whether to generate alert for partially completed jobs. This parameter is valid only for on-premises file backup and ECS file backup.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Code' => ['description' => 'The HTTP status code. The status code 200 indicates that the request was successful.', 'type' => 'string', 'example' => '200', 'title' => ''], 'Message' => ['description' => 'The returned message. If the request was successful, "successful" is returned. If the request failed, an error message is returned.', 'type' => 'string', 'example' => 'successful', 'title' => ''], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E', 'title' => ''], 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" ."\n" .'- true'."\n" ."\n" .'- false', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'title' => 'UpdateClientSettings', 'summary' => 'Updates the settings of a Cloud Backup client.', 'description' => 'This operation applies to both legacy and new Cloud Backup clients.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'UpdateClientSettings'], ], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'hbr:UpdateClientSettings', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'HBR', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\",\\n \\"Success\\": true\\n}","type":"json"}]', ], 'UpdateContainerCluster' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ 'name' => 'ClusterId', 'in' => 'query', 'schema' => ['description' => 'Cluster ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cc-000**************134'], ], [ 'name' => 'Name', 'in' => 'query', 'schema' => ['description' => 'Cluster name.', 'type' => 'string', 'required' => false, 'example' => 'ack_pv_backup_location'], ], [ 'name' => 'Description', 'in' => 'query', 'schema' => ['description' => 'Cluster description.', 'type' => 'string', 'required' => false, 'example' => 'description ack pv backup'], ], [ 'name' => 'NetworkType', 'in' => 'query', 'schema' => ['description' => 'Network type, with possible values including:'."\n" .'* **CLASSIC**: Classic Network.'."\n" .'* **VPC**: Virtual Private Cloud.', 'type' => 'string', 'required' => false, 'example' => 'VPC'], ], [ 'name' => 'RenewToken', 'in' => 'query', 'schema' => ['description' => 'Whether to regenerate the token.', 'type' => 'boolean', 'required' => false, 'example' => 'false'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'TokenUpdated' => ['description' => 'Indicates whether the cluster token has been updated.', 'type' => 'boolean', 'example' => 'false'], 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E'], 'Token' => ['description' => 'Cluster token, used for registering HBR clients within the cluster.', 'type' => 'string', 'example' => 'eyJhY2NvdW*****VnZpgXQC5A=='], 'Success' => ['description' => 'Indicates if the request was successful.'."\n" ."\n" .'- true: Success'."\n" .'- false: Failure', 'type' => 'boolean', 'example' => 'true'], 'Code' => ['description' => 'Return code, 200 indicates success.', 'type' => 'string', 'example' => '200'], 'Message' => ['description' => 'Return information.', 'type' => 'string', 'example' => 'successful'], ], ], ], ], 'title' => 'Update Container Cluster Information', 'summary' => 'Update container cluster information, including the container cluster name, network type, etc.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'UpdateContainerCluster'], ], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'hbr:UpdateContainerCluster', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'HBR', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TokenUpdated\\": false,\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\",\\n \\"Token\\": \\"eyJhY2NvdW*****VnZpgXQC5A==\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\"\\n}","type":"json"}]', ], 'UpdateDataSource' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'abilityTreeCode' => '95676', 'abilityTreeNodes' => ['FEATUREhbr9ZUQY7'], ], 'parameters' => [ [ 'name' => 'DataSourceId', 'in' => 'query', 'schema' => ['description' => 'The ID of the data source.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ds-0006xo****dtle', 'title' => ''], ], [ 'name' => 'DataSourceName', 'in' => 'query', 'schema' => ['description' => 'The name of the data source.', 'type' => 'string', 'required' => false, 'example' => 'MyLocalNas', 'title' => ''], ], [ 'name' => 'Credential', 'in' => 'query', 'schema' => ['description' => 'The access credentials for the data source. This parameter is used for on-premises NAS data sources that use the SMB protocol, and for OSS and S3 protocol-compatible data sources. Examples:'."\n" ."\n" .'- On-premises NAS data source (SMB protocol):'."\n" .' {'."\n" .' "mountUsername": "\\*\\*\\*\\*\\*",'."\n" .' "mountPassword": "\\*\\*\\*\\*\\*"'."\n" .' }'."\n" ."\n" .'- OSS protocol-compatible data source/S3 protocol-compatible data source:'."\n" .' {'."\n" .' "accessKeyId": "\\*\\*\\*\\*\\*",'."\n" .' "accessKeySecret": "\\*\\*\\*\\*\\*"'."\n" .' }', 'type' => 'string', 'required' => false, 'example' => '{"mountUsername":"***","mountPassword":"***"}', 'title' => ''], ], [ 'name' => 'ConnectionInfo', 'in' => 'query', 'schema' => ['description' => 'The connection information for the data source. Examples:'."\n" ."\n" .'- On-premises NAS data source:'."\n" .' {'."\n" .' "dataServerAddresses": \\['."\n" .' {'."\n" .' "host": "123.123.123.123",'."\n" .' "port": "8080"'."\n" .' }'."\n" .' ],'."\n" .' "sharePath": "/share",'."\n" .' "mountOptions": "vers=3",'."\n" .' "fileSystemType": "nfs"'."\n" .' }'."\n" ."\n" .'- Intelligent Computing CPFS data source:'."\n" .' {"vpcMountTarget":"cpfs-010wn\\*\\*\\*wy-vpc-ta\\*\\*\\*8.cn-shanghai.cpfs.aliyuncs.com","sharePath":"/"}'."\n" ."\n" .'- Other large-scale file system data sources:'."\n" .' {"path":"/mnt"}', 'type' => 'string', 'required' => false, 'example' => '{'."\n" .' "dataServerAddresses": ['."\n" .' {'."\n" .' "host": "123.123.123.123",'."\n" .' "port": "8080"'."\n" .' }'."\n" .' ],'."\n" .' "sharePath": "/share",'."\n" .' "mountOptions": "vers=3",'."\n" .' "fileSystemType": "nfs"'."\n" .'}', 'title' => ''], ], [ 'name' => 'IndexLevel', 'in' => 'query', 'schema' => [ 'description' => 'The index level for data source analysis. This parameter applies only to the archive feature.'."\n" ."\n" .'- OFF: No index is created.'."\n" ."\n" .'- META: A metadata index is created.'."\n" ."\n" .'- ALL: A full-text index is created. (Deprecated)', 'enumValueTitles' => ['META' => 'META', 'OFF' => 'OFF'], 'type' => 'string', 'required' => false, 'example' => 'META', 'title' => '', ], ], [ 'name' => 'ClusterId', 'in' => 'query', 'schema' => ['description' => 'The ID of the client group used to access the data source.', 'type' => 'string', 'required' => false, 'example' => 'cl-000**************hg9', 'title' => ''], ], [ 'name' => 'Schedule', 'in' => 'query', 'schema' => ['description' => 'The schedule for data source analysis. This parameter applies only to the archive feature. The format is `I|{startTime}|{interval}`. This specifies a task that starts at `{startTime}` and repeats at the specified `{interval}`. `startTime` is a Unix time value in seconds. `interval` is an ISO 8601 time interval. For example, `PT1H` indicates a one-hour interval, and `P1D` indicates a one-day interval.', 'type' => 'string', 'required' => false, 'example' => 'I|1729493847|P1D', 'title' => ''], ], [ 'name' => 'SpeedLimit', 'in' => 'query', 'schema' => ['description' => 'The rate limiting configuration for data source analysis. This parameter applies only to the archive feature.', 'type' => 'string', 'required' => false, 'example' => '0:24:102400', 'title' => ''], ], [ 'name' => 'Options', 'in' => 'query', 'schema' => ['description' => 'The options for data source analysis. This parameter applies only to the archive feature.', 'type' => 'string', 'required' => false, 'example' => '{}', 'title' => ''], ], [ 'name' => 'Include', 'in' => 'query', 'schema' => ['description' => 'A filter to specify which files to include. This parameter applies only to the archive feature.', 'type' => 'string', 'required' => false, 'example' => '["/home/alice/", "/home/bob/"]', 'title' => ''], ], [ 'name' => 'Exclude', 'in' => 'query', 'schema' => ['description' => 'A filter to specify which files to exclude. This parameter applies only to the archive feature.', 'type' => 'string', 'required' => false, 'example' => '["/home/alice/log/"]', 'title' => ''], ], [ 'name' => 'Path', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'type' => 'array', 'items' => ['description' => 'A path for data source analysis. This parameter applies only to the archive feature.', 'type' => 'string', 'required' => false, 'example' => '/home', 'title' => ''], 'required' => false, 'maxItems' => 8, 'description' => 'A list of paths for data source analysis. This parameter applies only to the archive feature.', 'title' => '', 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Code' => ['description' => 'The response code. A value of 200 indicates success.', 'type' => 'string', 'example' => '200', 'title' => ''], 'Message' => ['description' => 'The response message. If the request is successful, `successful` is returned. Otherwise, an error message is returned.', 'type' => 'string', 'example' => 'successful', 'title' => ''], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '1F22A695-***-***-***-DDC66F5E5ACB', 'title' => ''], 'Success' => ['description' => 'Indicates whether the request was successful.'."\n" ."\n" .'- true: The request was successful.'."\n" ."\n" .'- false: The request failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], 'description' => 'The response object.', 'title' => '', 'example' => '', ], ], ], 'title' => 'UpdateDataSource', 'summary' => 'Updates the data source configuration.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"1F22A695-***-***-***-DDC66F5E5ACB\\",\\n \\"Success\\": true\\n}","type":"json"}]', ], 'UpdateHanaBackupPlan' => [ 'methods' => ['post', 'get'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ 'name' => 'VaultId', 'in' => 'query', 'schema' => ['description' => 'The ID of the backup vault.'."\n", 'type' => 'string', 'required' => true, 'example' => 'v-0000rcw******5c6'], ], [ 'name' => 'ClusterId', 'in' => 'query', 'schema' => ['description' => 'The ID of the SAP HANA instance.'."\n", 'type' => 'string', 'required' => true, 'example' => 'cl-0005dhe******f38'], ], [ 'name' => 'PlanId', 'in' => 'query', 'schema' => ['description' => 'The ID of the backup plan.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pl-000br3cm4dqvmtph7cul'], ], [ 'name' => 'PlanName', 'in' => 'query', 'schema' => ['description' => 'The name of the backup plan.'."\n", 'type' => 'string', 'required' => false, 'example' => 'plan-20211109-162411'], ], [ 'name' => 'Schedule', 'in' => 'query', 'schema' => ['description' => 'The backup policy. Format: `I|{startTime}|{interval}`. The system runs the first backup job at a point in time that is specified in the {startTime} parameter and the subsequent backup jobs at an interval that is specified in the {interval} parameter. The system does not run a backup job before the specified point in time. Each backup job, except the first one, starts only after the previous backup job is completed. For example, `I|1631685600|P1D` indicates that the system runs the first backup job at 14:00:00 on September 15, 2021 and the subsequent backup jobs once a day.'."\n" ."\n" .'* startTime: the time at which the system starts to run a backup job. The time follows the UNIX time format. Unit: seconds.'."\n" .'* interval: the interval at which the system runs a backup job. The interval follows the ISO 8601 standard. For example, PT1H indicates an interval of 1 hour. P1D indicates an interval of one day.'."\n", 'type' => 'string', 'required' => false, 'example' => 'I|1602673264|P1D'], ], [ 'name' => 'BackupPrefix', 'in' => 'query', 'schema' => ['description' => 'The backup prefix.'."\n", 'type' => 'string', 'required' => false, 'example' => 'COMPLETE_DATA_BACKUP'], ], [ 'name' => 'ResourceGroupId', 'in' => 'query', 'schema' => ['description' => 'The ID of the resource group.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rg-acfmze36euddwjq'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Code' => ['description' => 'The response code. The status code 200 indicates that the request was successful.'."\n", 'type' => 'string', 'example' => '200'], 'Message' => ['description' => 'The returned message. If the request was successful, "successful" is returned. If the request failed, an error message is returned.'."\n", 'type' => 'string', 'example' => 'successful'], 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'F23BCC67-09B4-582C-AE70-C813C8548DCC'], 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" ."\n" .'* true'."\n" .'* false'."\n", 'type' => 'boolean', 'example' => 'true'], ], 'description' => '', ], ], ], 'title' => 'UpdateHanaBackupPlan', 'summary' => 'Updates an SAP HANA backup plan.', 'description' => '* A backup plan defines the data source, backup policy, and other configurations. After you execute a backup plan, a backup job is generated to record the backup progress and the backup result. If a backup job is completed, a backup snapshot is generated. You can use a backup snapshot to create a restore job.'."\n" .'* You can specify only one type of data source in a backup plan.'."\n" .'* You can specify only one interval as a backup cycle in a backup plan.'."\n" .'* Each backup plan allows you to back up data to only one backup vault.'."\n", 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'UpdateHanaBackupPlan'], ], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'hbr:UpdateHanaBackupPlan', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'HBR', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"F23BCC67-09B4-582C-AE70-C813C8548DCC\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n 200\\n successful\\n F23BCC67-09B4-582C-AE70-C813C8548DCC\\n true\\n","errorExample":""}]', ], 'UpdateHanaBackupSetting' => [ 'methods' => ['post', 'get'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ 'name' => 'VaultId', 'in' => 'query', 'schema' => ['description' => 'The ID of the backup vault.'."\n", 'type' => 'string', 'required' => false, 'example' => 'v-0005n******rluw5'], ], [ 'name' => 'ClusterId', 'in' => 'query', 'schema' => ['description' => 'The ID of the SAP HANA instance.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cl-000ezvg******8znz'], ], [ 'name' => 'DatabaseName', 'in' => 'query', 'schema' => ['description' => 'The name of the database.'."\n", 'type' => 'string', 'required' => true, 'example' => 'SYSTEMDB'], ], [ 'name' => 'EnableAutoLogBackup', 'in' => 'query', 'schema' => ['description' => 'Specifies whether to enable automatic log backup. Valid values:'."\n" ."\n" .'* **true**: enables automatic log backup.'."\n" .'* **false**: disables automatic log backup.'."\n", 'type' => 'boolean', 'required' => true, 'docRequired' => true, 'example' => 'true'], ], [ 'name' => 'DataBackupParameterFile', 'in' => 'query', 'schema' => ['description' => 'The configuration file for data backup.'."\n", 'type' => 'string', 'required' => false, 'example' => '/usr/sap/SID/SYS/global/hdb/opt/hdbconfig/param'], ], [ 'name' => 'LogBackupParameterFile', 'in' => 'query', 'schema' => ['description' => 'The configuration file for log backup.'."\n", 'type' => 'string', 'required' => false, 'example' => '/usr/sap/SID/SYS/global/hdb/opt/hdbconfig/param'], ], [ 'name' => 'LogBackupUsingBackint', 'in' => 'query', 'schema' => ['description' => 'Specifies whether to use Backint to back up logs. Valid values:'."\n" ."\n" .'* true: Backint is used to back up logs.'."\n" .'* false: Backint is not used to back up logs.'."\n", 'type' => 'boolean', 'required' => true, 'docRequired' => true, 'example' => 'true'], ], [ 'name' => 'LogBackupTimeout', 'in' => 'query', 'schema' => ['description' => 'The interval at which logs are backed up. Unit: seconds.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '900'], ], [ 'name' => 'CatalogBackupUsingBackint', 'in' => 'query', 'schema' => ['description' => 'Specifies whether to use Backint to back up catalogs. Valid values:'."\n" ."\n" .'* true: Backint is used to back up catalogs.'."\n" .'* false: Backint is not used to back up catalogs.'."\n", 'type' => 'boolean', 'required' => true, 'docRequired' => true, 'example' => 'true'], ], [ 'name' => 'CatalogBackupParameterFile', 'in' => 'query', 'schema' => ['description' => 'The configuration file for catalog backup.'."\n", 'type' => 'string', 'required' => false, 'example' => '/usr/sap/SID/SYS/global/hdb/opt/hdbconfig/param'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Code' => ['description' => 'The HTTP status code. The status code 200 indicates that the call is successful.'."\n", 'type' => 'string', 'example' => '200'], 'Message' => ['description' => 'The message that is returned. If the call is successful, "successful" is returned. If the call fails, an error message is returned.'."\n", 'type' => 'string', 'example' => 'successful'], 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '4892D474-9A4A-5298-BCD3-E46112A1EFD0'], 'Success' => ['description' => 'Indicates whether the call is successful. Valid values:'."\n" ."\n" .'* true: The call is successful.'."\n" .'* false: The call fails.'."\n", 'type' => 'boolean', 'example' => 'true'], ], ], ], ], 'title' => 'UpdateHanaBackupSetting', 'summary' => 'Updates the backup parameters of an SAP HANA database.', 'description' => 'You can call the UpdateHanaRetentionSetting operation to update the backup retention period of a database.'."\n", 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'UpdateHanaBackupSetting'], ], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'hbr:UpdateHanaBackupSetting', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'HBR', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"4892D474-9A4A-5298-BCD3-E46112A1EFD0\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n 200\\n successful\\n 4892D474-9A4A-5298-BCD3-E46112A1EFD0\\n true\\n","errorExample":""}]', ], 'UpdateHanaInstance' => [ 'methods' => ['post', 'get'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ 'name' => 'VaultId', 'in' => 'query', 'schema' => ['description' => 'The ID of the backup vault.'."\n", 'type' => 'string', 'required' => false, 'example' => 'v-0003v4ah******9xp'], ], [ 'name' => 'ClusterId', 'in' => 'query', 'schema' => ['description' => 'The ID of the SAP HANA instance.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cl-000axjt******c6j8'], ], [ 'name' => 'HanaName', 'in' => 'query', 'schema' => ['description' => 'The name of the SAP HANA instance.'."\n", 'type' => 'string', 'required' => false, 'example' => 'SAP-HANA-DEV'], ], [ 'name' => 'Host', 'in' => 'query', 'schema' => ['description' => 'The private or internal IP address of the host where the primary node of the SAP HANA instance resides.'."\n", 'type' => 'string', 'required' => false, 'example' => '47.100.XX.XX'], ], [ 'name' => 'InstanceNumber', 'in' => 'query', 'schema' => ['description' => 'The instance number of the SAP HANA system.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '00'], ], [ 'name' => 'UserName', 'in' => 'query', 'schema' => ['description' => 'The username of the SYSTEMDB database.'."\n", 'type' => 'string', 'required' => false, 'example' => 'admin'], ], [ 'name' => 'Password', 'in' => 'query', 'schema' => ['description' => 'The password that is used to connect with the SAP HANA database.'."\n", 'type' => 'string', 'required' => false, 'example' => '**********'], ], [ 'name' => 'UseSsl', 'in' => 'query', 'schema' => ['description' => 'Specifies whether to connect with the SAP HANA database over Secure Sockets Layer (SSL). Valid values:'."\n" ."\n" .'* true: The SAP HANA database is connected over SSL.'."\n" .'* false: The SAP HANA database is not connected over SSL.'."\n", 'type' => 'boolean', 'required' => true, 'docRequired' => true, 'example' => 'true'], ], [ 'name' => 'ValidateCertificate', 'in' => 'query', 'schema' => ['description' => 'Specifies whether to verify the SSL certificate of the SAP HANA database. Valid values:'."\n" ."\n" .'* true: The SSL certificate of the SAP HANA database is verified.'."\n" .'* false: The SSL certificate of the SAP HANA database is not verified.'."\n", 'type' => 'boolean', 'required' => true, 'docRequired' => true, 'example' => 'false'], ], [ 'name' => 'AlertSetting', 'in' => 'query', 'schema' => ['description' => 'The alert settings. Valid value: INHERITED, which indicates that the Cloud Backup client sends alert notifications by using the same method configured for the backup vault.'."\n", 'type' => 'string', 'required' => false, 'example' => 'INHERITED'], ], [ 'name' => 'ResourceGroupId', 'in' => 'query', 'schema' => ['description' => 'The ID of the resource group.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rg-aekzvx7d3c4kpny'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Code' => ['description' => 'The response code. The status code 200 indicates that the request was successful.'."\n", 'type' => 'string', 'example' => '200'], 'Message' => ['description' => 'The returned message. If the request was successful, "successful" is returned. If the request failed, an error message is returned.'."\n", 'type' => 'string', 'example' => 'successful'], 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'A6AB6D5A-9D21-5529-9335-A894FB045ED6'], 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" ."\n" .'* true'."\n" .'* false'."\n", 'type' => 'boolean', 'example' => 'true'], ], 'description' => '', ], ], ], 'title' => 'UpdateHanaInstance', 'summary' => 'Updates an SAP HANA instance.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'UpdateHanaInstance'], ], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'hbr:UpdateHanaInstance', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'HBR', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"A6AB6D5A-9D21-5529-9335-A894FB045ED6\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n 200\\n successful\\n A6AB6D5A-9D21-5529-9335-A894FB045ED6\\n true\\n","errorExample":""}]', ], 'UpdateHanaRetentionSetting' => [ 'methods' => ['post', 'get'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'systemTags' => [ 'operationType' => 'update', 'abilityTreeCode' => '95682', 'abilityTreeNodes' => ['FEATUREhbrI97IXK'], ], 'parameters' => [ [ 'name' => 'VaultId', 'in' => 'query', 'schema' => ['description' => 'The ID of the backup vault.'."\n", 'type' => 'string', 'required' => true, 'example' => 'v-000fb0v2ly******k6'], ], [ 'name' => 'ClusterId', 'in' => 'query', 'schema' => ['description' => 'The ID of the SAP HANA instance.'."\n", 'type' => 'string', 'required' => true, 'example' => 'cl-00024vyjj******srrq'], ], [ 'name' => 'Schedule', 'in' => 'query', 'schema' => ['description' => 'The policy to update the retention period. Format: `I|{startTime}|{interval}`. The retention period is updated at an interval of {interval} starting from {startTime}.'."\n" ."\n" .'* startTime: the time at which the system starts to run a backup job. The time follows the UNIX time format. Unit: seconds.'."\n" .'* interval: the interval at which the system runs a backup job. The interval follows the ISO 8601 standard. For example, PT1H indicates an interval of 1 hour, and P1D indicates an interval of one day.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'I|0|P1D'], ], [ 'name' => 'RetentionDays', 'in' => 'query', 'schema' => ['description' => 'The retention period of the backup data. Unit: days. If you set the Disabled parameter to false, the backup is retained for the number of days specified by this parameter.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '90'], ], [ 'name' => 'Disabled', 'in' => 'query', 'schema' => ['description' => 'Specifies whether to permanently retain the backup. Valid values:'."\n" ."\n" .'* true: The backup is permanently retained.'."\n" .'* false: The backup is retained for the specified number of days.'."\n", 'type' => 'boolean', 'required' => true, 'docRequired' => true, 'example' => 'false'], ], [ 'name' => 'DatabaseName', 'in' => 'query', 'schema' => ['description' => 'The database name.'."\n", 'type' => 'string', 'required' => true, 'example' => 'SYSTEMDB'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Code' => ['description' => 'The response code. The status code 200 indicates that the request was successful.'."\n", 'type' => 'string', 'example' => '200'], 'Message' => ['description' => 'The returned message. If the request was successful, "successful" is returned. If the request failed, an error message is returned.'."\n", 'type' => 'string', 'example' => 'successful'], 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '7BEE26EB-8EE3-57A0-A9DE-5FD700165DE5'], 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" ."\n" .'* true'."\n" .'* false'."\n", 'type' => 'boolean', 'example' => 'true'], ], 'description' => '', ], ], ], 'title' => 'UpdateHanaRetentionSetting', 'summary' => 'Updates the backup retention period of an SAP HANA database.', 'description' => '* If you want to update the backup parameters of a database, you can call the UpdateHanaBackupSetting operation.'."\n" .'* Cloud Backup deletes the expired catalogs and data that are related to Backint and file backup. The deleted catalogs and data cannot be restored. We recommend that you set the retention period based on your business requirements.'."\n", 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'UpdateHanaRetentionSetting'], ], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'hbr:UpdateHanaRetentionSetting', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'HBR', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"7BEE26EB-8EE3-57A0-A9DE-5FD700165DE5\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n 200\\n successful\\n 7BEE26EB-8EE3-57A0-A9DE-5FD700165DE5\\n true\\n","errorExample":""}]', ], 'UpdatePolicyBinding' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ 'name' => 'PolicyId', 'in' => 'formData', 'schema' => ['description' => 'The ID of the backup policy.', 'type' => 'string', 'required' => true, 'example' => 'po-000************ky9', 'title' => ''], ], [ 'name' => 'DataSourceId', 'in' => 'formData', 'schema' => ['description' => 'The ID of the data source.', 'type' => 'string', 'required' => true, 'example' => 'i-bp1************dtv', 'title' => ''], ], [ 'name' => 'SourceType', 'in' => 'query', 'schema' => ['description' => 'The type of the data source. Valid value:'."\n" ."\n" .'- **UDM\\_ECS**: ECS instance backup', 'type' => 'string', 'required' => true, 'example' => 'UDM_ECS', 'title' => ''], ], [ 'name' => 'PolicyBindingDescription', 'in' => 'query', 'schema' => ['description' => 'The description of the policy binding.', 'type' => 'string', 'required' => false, 'example' => 'po-000************5xx-i-2ze************nw4', 'title' => ''], ], [ 'name' => 'Disabled', 'in' => 'query', 'schema' => ['description' => 'Specifies whether to disable the backup policy for the data source.'."\n" ."\n" .'- true: The backup policy is disabled.'."\n" ."\n" .'- false: The backup policy is not disabled.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], ], [ 'name' => 'Source', 'in' => 'query', 'schema' => ['description' => 'This parameter has different meanings based on the value of SourceType.'."\n" ."\n" .'- **OSS**: The prefix of the objects that you want to back up. If you do not specify this parameter, the entire bucket is backed up. Only a single prefix is supported. To back up the /backup directory, set this parameter to /backup.'."\n" ."\n" .'- **ECS\\_FILE**: The paths to the files that you want to back up. If you do not specify this parameter, all files are backed up. You can specify multiple paths. To back up the files in the /a and /b paths, set this parameter to \\["/a", "/b"].'."\n" ."\n" .'- **File**: The paths to the files that you want to back up. If you do not specify this parameter, all files are backed up. You can specify multiple paths. To back up the files in the /a and /b directories, set this parameter to \\["/a", "/b"].'."\n" ."\n" .'- **COMMON\\_FILE\\_SYSTEM**: Required. The backup paths. You can specify multiple paths. To back up the /a and /b paths, set this parameter to \\["/a", "/b"]. To back up the root directory, set this parameter to \\["/"].'."\n" ."\n" .'- **COMMON\\_NAS**: Required. The backup path. Only a single path is supported. To back up the /a path, set this parameter to \\["/a"]. To back up the root directory, set this parameter to \\["/"].'."\n" ."\n" .'- **OTS**: The list of tables that you want to back up. If you do not specify this parameter, all tables are backed up. You can specify multiple tables. To back up Table a and Table b, set this parameter to \\["a", "b"].', 'type' => 'string', 'required' => false, 'example' => 'backup/', 'title' => ''], ], [ 'name' => 'Include', 'in' => 'query', 'schema' => ['description' => 'This parameter is available only if you set **SourceType** to **ECS\\_FILE**, **File**, **NAS**, **COMMON\\_NAS**, or **COMMON\\_FILE\\_SYSTEM**. This parameter specifies the file types to be backed up. All files of the specified types are backed up. The value can be up to 255 characters in length.', 'type' => 'string', 'required' => false, 'example' => '[\\"*.doc\\",\\"*.xltm\\"]', 'title' => ''], ], [ 'name' => 'Exclude', 'in' => 'query', 'schema' => ['description' => 'This parameter is required when **SourceType** is set to **ECS\\_FILE**, **File**, **NAS**, **COMMON\\_NAS**, or **COMMON\\_FILE\\_SYSTEM**. It specifies the file types to include in the backup. The value can be up to 255 characters in length.', 'type' => 'string', 'required' => false, 'example' => '[\\"*.doc\\",\\"*.xltm\\"]', 'title' => ''], ], [ 'name' => 'SpeedLimit', 'in' => 'query', 'schema' => ['description' => 'This parameter is required only if you set **SourceType** to **ECS\\_FILE** or **File**. This parameter specifies the throttling rules for backups. The format is `{start}{end}{bandwidth}`. Separate multiple throttling rules with a vertical bar (|). The time periods of the rules cannot overlap.'."\n" ."\n" .'- **start**: The start hour.'."\n" ."\n" .'- **end**: The end hour.'."\n" ."\n" .'- **bandwidth**: The throttling speed. Unit: KB/s.', 'type' => 'string', 'required' => false, 'example' => '0:24:5120', 'title' => ''], ], [ 'name' => 'AdvancedOptions', 'in' => 'query', 'style' => 'json', 'schema' => [ 'description' => 'The advanced options.', 'type' => 'object', 'properties' => [ 'UdmDetail' => [ 'description' => 'The details of the ECS instance backup.', 'type' => 'object', 'properties' => [ 'ExcludeDiskIdList' => [ 'description' => 'The list of cloud disk IDs that do not need to be protected. This parameter is ignored when DiskIdList is not empty.', 'type' => 'array', 'items' => ['description' => 'The ID of a cloud disk that does not need to be protected.', 'type' => 'string', 'required' => false, 'example' => 'd-bp1************apo', 'title' => ''], 'required' => false, 'title' => '', 'example' => '', ], 'DiskIdList' => [ 'description' => 'The list of cloud disk IDs that need to be protected. If you want to protect all cloud disks, leave this parameter empty.', 'type' => 'array', 'items' => ['description' => 'The ID of a cloud disk that needs to be protected.', 'type' => 'string', 'required' => false, 'example' => 'd-bp1************apo', 'title' => ''], 'required' => false, 'title' => '', 'example' => '', ], 'SnapshotGroup' => ['description' => 'Specifies whether to create a snapshot-consistent group. You can create a snapshot-consistent group only if all disk types are Enhanced SSDs (ESSDs).', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], 'AppConsistent' => ['description' => 'Specifies whether to enable application consistency. You can enable application consistency only if all disk types are ESSDs.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], 'RamRoleName' => ['description' => 'This parameter is required only if you set **AppConsistent** to **true**. This parameter specifies the name of the RAM role that is required to create application-consistent snapshots.', 'type' => 'string', 'required' => false, 'example' => 'AliyunECSInstanceForHbrRole', 'title' => ''], 'PreScriptPath' => ['description' => 'This parameter is required only if you set **AppConsistent** to **true**. This parameter specifies the path to the pre-freeze script that is run before an application-consistent snapshot is created.', 'type' => 'string', 'required' => false, 'example' => '/tmp/prescript.sh', 'title' => ''], 'PostScriptPath' => ['description' => 'This parameter is required only if you set **AppConsistent** to **true**. This parameter specifies the path to the post-thaw script that is run after an application-consistent snapshot is created.', 'type' => 'string', 'required' => false, 'example' => '/tmp/postscript.sh', 'title' => ''], 'EnableFsFreeze' => ['description' => 'This parameter is required only if you set **AppConsistent** to **true**. This parameter specifies whether to use the FsFreeze mechanism of Linux to ensure file system read consistency before an application-consistent snapshot is created. The default value is true.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], 'TimeoutInSeconds' => ['description' => 'This parameter is required only if you set **AppConsistent** to **true**. This parameter specifies the I/O freeze timeout period. The default value is 30 seconds.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '30', 'title' => ''], 'EnableWriters' => ['description' => 'This parameter is required only if you set **AppConsistent** to **true**. This parameter specifies whether to create an application-consistent snapshot:'."\n" ."\n" .'- true: Create an application-consistent snapshot.'."\n" ."\n" .'- false: Create a file system-consistent snapshot.'."\n" ."\n" .'The default value is true.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], ], 'required' => false, 'title' => '', 'example' => '', ], 'OssDetail' => [ 'description' => 'The details of the OSS backup.', 'type' => 'object', 'properties' => [ 'InventoryId' => ['description' => 'The name of the OSS inventory. If you specify this parameter, OSS inventory is used for performance tuning.'."\n" ."\n" .'- Use an inventory to improve the performance of incremental backups when you back up more than 100 million OSS objects. The storage fees for the inventory files are charged by OSS.'."\n" ."\n" .'- It takes time to generate an OSS inventory file. Before the inventory file is generated, the backup job may fail. You can wait for the next backup cycle to run.', 'type' => 'string', 'required' => false, 'example' => '30663060', 'title' => ''], 'InventoryCleanupPolicy' => ['description' => 'Specifies whether to delete the inventory file after a backup. This parameter is valid only when you use an OSS inventory. Valid values:'."\n" ."\n" .'- **NO\\_CLEANUP**: Does not delete the inventory file.'."\n" ."\n" .'- **DELETE\\_CURRENT**: Deletes the current file.'."\n" ."\n" .'- **DELETE\\_CURRENT\\_AND\\_PREVIOUS**: Deletes all files.', 'type' => 'string', 'required' => false, 'example' => 'NO_CLEANUP', 'title' => ''], 'IgnoreArchiveObject' => ['title' => '不在任务统计和失败文件列表中提示归档型对象', 'description' => 'Specifies whether to exclude archive objects from task statistics and the list of failed files.', 'type' => 'boolean', 'required' => false, 'example' => 'true'], ], 'required' => false, 'title' => '', 'example' => '', ], 'CommonFileSystemDetail' => [ 'description' => 'The details of the large-scale file system backup.', 'type' => 'object', 'properties' => [ 'FullOnIncrementFail' => ['description' => 'Specifies whether to run a full backup if an incremental backup fails. Valid values:'."\n" ."\n" .'- **true**: Runs a full backup.'."\n" ."\n" .'- **false**: Does not run a full backup.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], 'FetchSliceSize' => ['description' => 'The size of the backup shard (the number of files).', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '100000', 'title' => ''], ], 'required' => false, 'title' => '', 'example' => '', ], ], 'required' => false, 'title' => '', 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'UpdatePolicyBindingResponse', 'description' => 'UpdatePolicyBindingResponse', 'type' => 'object', 'properties' => [ 'Success' => ['description' => 'Indicates whether the request was successful.'."\n" ."\n" .'- true: The request was successful.'."\n" ."\n" .'- false: The request failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'Code' => ['description' => 'The return code. The value 200 indicates that the request was successful.', 'type' => 'string', 'example' => '200', 'title' => ''], 'Message' => ['description' => 'The message that is returned. If the request was successful, "successful" is returned. If the request failed, an error message is returned.', 'type' => 'string', 'example' => 'successful', 'title' => ''], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'B6F24C46-54B9-519B-9AB8-A8988D705E67', 'title' => ''], ], 'example' => '', ], ], ], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"B6F24C46-54B9-519B-9AB8-A8988D705E67\\"\\n}","type":"json"}]', 'title' => 'UpdatePolicyBinding', 'summary' => 'Updates the association between a backup policy and a data source.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'UpdatePolicyBinding'], ], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'hbr:UpdatePolicyBinding', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'HBR', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], ], 'UpdatePolicyV2' => [ 'summary' => 'Modifies a backup policy.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'abilityTreeCode' => '162850', 'abilityTreeNodes' => ['FEATUREhbr56LH1C', 'FEATUREhbrS7MI6C', 'FEATUREhbrFWIWBG', 'FEATUREhbrB1KQ9G', 'FEATUREhbrQ3MV3B', 'FEATUREhbr3BJQCT', 'FEATUREhbrF83GXN'], ], 'parameters' => [ [ 'name' => 'PolicyId', 'in' => 'formData', 'schema' => ['title' => 'required parameters', 'description' => 'The ID of the backup policy.'."\n", 'type' => 'string', 'required' => false, 'example' => 'po-000************viy'], ], [ 'name' => 'PolicyName', 'in' => 'formData', 'schema' => ['description' => 'The name of the backup policy.'."\n", 'type' => 'string', 'required' => false, 'example' => 'Daily backup + offsite backup', 'title' => ''], ], [ 'name' => 'PolicyDescription', 'in' => 'formData', 'schema' => ['description' => 'The description of the backup policy.'."\n", 'type' => 'string', 'required' => false, 'example' => 'Back up once at 10:00 AM every day, with offsite backup to Shanghai.', 'title' => ''], ], [ 'name' => 'Rules', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'description' => 'The rules in the backup policy.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The details of the rule.'."\n", 'type' => 'object', 'properties' => [ 'RuleId' => ['description' => 'The rule ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rule-000************rof', 'title' => ''], 'RuleType' => [ 'title' => '', 'description' => 'The type of the rule. Each backup policy must have at least one rule of the **BACKUP** type and only one rule of the **TRANSITION** type. Valid values:'."\n" ."\n" .'* **BACKUP**: backup rule'."\n" .'* **TRANSITION**: lifecycle rule'."\n" .'* **REPLICATION**: replication rule'."\n", 'type' => 'string', 'required' => false, 'example' => 'BACKUP', 'enum' => [], ], 'Schedule' => ['description' => 'This parameter is required only if the **RuleType** parameter is set to **BACKUP**. This parameter specifies the backup schedule settings. Formats:'."\n" ."\n" .'* `I|{startTime}|{interval}`: The system runs the first backup job at a point in time that is specified in the {startTime} parameter and the subsequent backup jobs at an interval that is specified in the {interval} parameter. For example, `I|1631685600|P1D` indicates that the system runs the first backup job at 14:00:00 on September 15, 2021 and the subsequent backup jobs once a day.'."\n" ."\n" .' * startTime: the time at which the system starts to run a backup job. The time must follow the UNIX time format. Unit: seconds.'."\n" .' * interval: the interval at which the system runs a backup job. The interval must follow the ISO 8601 standard. For example, `PT1H` specifies an interval of 1 hour. `P1D` specifies an interval of one day.'."\n" ."\n" .'* `C|{startTime}|{crontab}`: The system runs backup jobs at a point in time that is specified in the {startTime} parameter based on the {crontab} expression. For example, C|1631685600|0 0 2 ?\\* 3,5,7 indicates that the system runs backup jobs at 02:00:00 every Tuesday, Thursday, and Saturday from14:00:00 on September 15, 2021.``'."\n" ."\n" .' * startTime: the time at which the system starts to run a backup job. The time must follow the UNIX time format. Unit: seconds.'."\n" .' * crontab: the crontab expression. For example, 0 0 2 ?\\* 3,5,7 indicates 02:00:00 every Tuesday, Thursday, and Saturday.``'."\n" ."\n" .'The system does not run a backup job before the specified point in time. Each backup job, except the first one, starts only after the previous backup job is completed.'."\n", 'type' => 'string', 'required' => false, 'example' => 'I|1648647166|P1D', 'title' => ''], 'BackupType' => ['title' => '', 'description' => 'This parameter is required only if the **RuleType** parameter is set to **BACKUP**. This parameter specifies the backup type. Valid value: **COMPLETE**, which indicates full backup.'."\n", 'type' => 'string', 'required' => false, 'example' => 'COMPLETE'], 'Retention' => ['title' => 'Expiration', 'description' => 'This parameter is required only if the **RuleType** parameter is set to **TRANSITION** or **REPLICATION**.'."\n" ."\n" .'* If the **RuleType** parameter is set to **TRANSITION**, this parameter specifies the retention period of the backup data. Minimum value: 1. Unit: days.'."\n" .'* If the **RuleType** parameter is set to **REPLICATION**, this parameter specifies the retention period of remote backups. Minimum value: 1. Unit: days.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '7', 'default' => '0'], 'ReplicationRegionId' => ['title' => 'Replication', 'description' => 'This parameter is required only if the **RuleType** parameter is set to **REPLICATION**. This parameter specifies the ID of the destination region.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-shanghai'], 'ArchiveDays' => ['description' => 'This parameter is required only if the **RuleType** parameter is set to **TRANSITION**. This parameter specifies the time when data is dumped from a backup vault to an archive vault. Unit: days.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '90', 'default' => '0', 'title' => ''], 'ColdArchiveDays' => ['description' => 'This parameter is required only if the **RuleType** parameter is set to **TRANSITION**. This parameter specifies the time when data is dumped from a backup vault to a cold archive vault. Unit: days.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '365', 'default' => '0', 'title' => ''], 'VaultId' => ['description' => 'This parameter is required only if the RuleType parameter is set to BACKUP. The ID of the backup vault.'."\n", 'type' => 'string', 'required' => false, 'example' => 'v-0001************aseg', 'title' => ''], 'RetentionRules' => [ 'description' => 'This parameter is required only if the **RuleType** parameter is set to **TRANSITION**. This parameter specifies the special retention rules.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The special retention rule.'."\n", 'type' => 'object', 'properties' => [ 'AdvancedRetentionType' => ['description' => 'The type of the special retention rule. Valid values:'."\n" ."\n" .'* **WEEKLY**: retains weekly backups'."\n" .'* **MONTHLY**: retains monthly backups'."\n" .'* **YEARLY**: retains yearly backups'."\n", 'type' => 'string', 'required' => false, 'example' => 'YEARLY', 'title' => ''], 'WhichSnapshot' => ['description' => 'Specifies which backup is retained based on the special retention rule. Only the first backup can be retained.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'title' => ''], 'Retention' => ['description' => 'The special retention period of backups. Minimum value: 1. Unit: days.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '365', 'title' => ''], ], 'required' => false, 'title' => '', 'example' => '', ], 'required' => false, 'maxItems' => 99, 'title' => '', 'example' => '', ], 'KeepLatestSnapshots' => ['description' => 'Specifies whether to enable the feature of keeping at least one backup version. Valid values:'."\n" ."\n" .'* 0: The feature is disabled.'."\n" .'* 1: The feature is enabled.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'title' => ''], 'DataSourceFilters' => [ 'description' => 'This parameter is required only if the **RuleType** parameter is set to **TAG**. This parameter specifies the data source filter rule.'."\n", 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'SourceType' => ['description' => 'The type of the data source. Valid values:'."\n" ."\n" .'* **UDM_ECS**: Elastic Compute Service (ECS) instance This type of data source is supported only if the **RuleType** parameter is set to **UDM_ECS_ONLY**.'."\n" .'* **OSS**: Object Storage Service (OSS) bucket This type of data source is supported only if the **RuleType** parameter is set to **STANDARD**.'."\n" .'* **NAS**: File Storage NAS (NAS) file system This type of data source is supported only if the **RuleType** parameter is set to **STANDARD**.'."\n" .'* **ECS_FILE**: ECS file This type of data source is supported only if the **RuleType** parameter is set to **STANDARD**.'."\n" .'* **OTS**: Tablestore instance This type of data source is supported only if the **RuleType** parameter is set to **STANDARD**.'."\n", 'type' => 'string', 'required' => false, 'example' => 'UDM_ECS', 'title' => ''], 'DataSourceIds' => [ 'description' => 'This parameter is deprecated.'."\n", 'type' => 'array', 'items' => ['description' => 'This parameter is deprecated.'."\n", 'type' => 'string', 'required' => false, 'example' => '已废弃。', 'title' => ''], 'required' => false, 'title' => '', 'example' => '', ], ], 'required' => false, 'description' => '', 'title' => '', 'example' => '', ], 'required' => false, 'title' => '', 'example' => '', ], 'TagFilters' => [ 'description' => 'This parameter is required only if the **RuleType** parameter is set to **TAG**. This parameter specifies the resource tag filter rule.'."\n", 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Key' => ['description' => 'The tag key.'."\n", 'type' => 'string', 'required' => false, 'example' => 'env', 'title' => ''], 'Value' => ['description' => 'The tag value. If you leave this parameter empty, the value is any value.'."\n", 'type' => 'string', 'required' => false, 'example' => 'prod', 'title' => ''], 'Operator' => ['description' => 'The tag-based matching rule. Valid values:'."\n" ."\n" .'* **EQUAL**: Both the tag key and tag value are matched.'."\n" .'* **NOT**: The tag key is matched and the tag value is not matched.'."\n", 'type' => 'string', 'required' => false, 'example' => 'EQUAL', 'title' => ''], ], 'required' => false, 'description' => '', 'title' => '', 'example' => '', ], 'required' => false, 'title' => '', 'example' => '', ], 'Immutable' => ['description' => 'This parameter is required only if the **PolicyType** parameter is set to **UDM_ECS_ONLY**. This parameter specifies whether to enable the immutable backup feature.'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], ], 'required' => false, 'title' => '', 'example' => '', ], 'required' => false, 'maxItems' => 10, 'minItems' => 1, 'title' => '', 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'UpdatePolicyResponse', 'description' => 'UpdatePolicyResponse'."\n", 'type' => 'object', 'properties' => [ 'Success' => ['description' => 'Indicates whether the call is successful. Valid values:'."\n" ."\n" .'* true: The call is successful.'."\n" .'* false: The call fails.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'Code' => ['description' => 'The HTTP status code. The status code 200 indicates that the call is successful.'."\n", 'type' => 'string', 'example' => '200', 'title' => ''], 'Message' => ['description' => 'The message that is returned. If the call is successful, "successful" is returned. If the call fails, an error message is returned.'."\n", 'type' => 'string', 'example' => 'successful', 'title' => ''], 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E', 'title' => ''], ], 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\"\\n}","type":"json"}]', 'title' => 'UpdatePolicyV2', 'description' => 'If you modify a backup policy, the modification takes effect on all data sources that are bound to the backup policy. Proceed with caution.'."\n", 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 60, 'regionId' => '*', 'api' => 'UpdatePolicyV2'], ], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'hbr:UpdatePolicyV2', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'HBR', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], ], 'UpdateVault' => [ 'methods' => ['post', 'get'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'systemTags' => [ 'operationType' => 'update', 'abilityTreeCode' => '95698', 'abilityTreeNodes' => ['FEATUREhbrKJCQWH', 'FEATUREhbrS7MI6C', 'FEATUREhbr7WEYAR', 'FEATUREhbrQ3MV3B', 'FEATUREhbrF83GXN', 'FEATUREhbr56LH1C', 'FEATUREhbrFWIWBG', 'FEATUREhbrAW9I1R', 'FEATUREhbr3BJQCT', 'FEATUREhbrIA0YQI', 'FEATUREhbrI97IXK', 'FEATUREhbrTH4MM4', 'FEATUREhbr9ZUQY7'], ], 'parameters' => [ [ 'name' => 'VaultId', 'in' => 'query', 'schema' => ['description' => 'The ID of the backup vault.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'v-*********************'], ], [ 'name' => 'VaultName', 'in' => 'query', 'schema' => ['description' => 'The name of the backup vault. The name must be 1 to 64 characters in length.'."\n", 'type' => 'string', 'required' => false, 'example' => 'vaultname'], ], [ 'name' => 'Description', 'in' => 'query', 'schema' => ['description' => 'The description of the backup vault. The description must be 0 to 255 characters in length.'."\n", 'type' => 'string', 'required' => false, 'example' => 'vault description'], ], [ 'name' => 'WormEnabled', 'in' => 'query', 'schema' => ['description' => 'Specifies whether to enable the immutable backup feature for storage vaults. After the immutable backup feature is enabled, backup vaults and all backup data cannot be deleted until the retention period expires. The immutable backup feature cannot be disabled after it is enabled. Only standard backup vaults and archive vaults support the immutable backup feature.'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'true'], ], [ 'name' => 'ResourceGroupId', 'in' => 'query', 'schema' => ['description' => 'The ID of the resource group.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rg-acfm2fa2xeiebyy'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Code' => ['description' => 'The response code. The status code 200 indicates that the request was successful.'."\n", 'type' => 'string', 'example' => '200'], 'Message' => ['description' => 'The returned message. If the request was successful, a success message is returned. If the request failed, an error message is returned.'."\n", 'type' => 'string', 'example' => 'successful'], 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E'], 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" ."\n" .'* true'."\n" .'* false'."\n", 'type' => 'boolean', 'example' => 'true'], ], 'description' => '', ], ], ], 'title' => 'UpdateVault', 'summary' => 'Updates the configuration information about the backup vault.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'UpdateVault'], ], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'hbr:UpdateVault', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'HBR', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\nsuccessful\\n473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\n200\\ntrue\\n","errorExample":""}]', ], 'UpgradeBackupClients' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'abilityTreeCode' => '95706', 'abilityTreeNodes' => ['FEATUREhbrS7MI6C'], ], 'parameters' => [ [ 'name' => 'InstanceIds', 'in' => 'query', 'style' => 'json', 'schema' => ['description' => 'The IDs of Elastic Compute Service (ECS) instances. The total number of ECS instance IDs and Cloud Backup client IDs cannot exceed 100.'."\n", 'type' => 'object', 'required' => false, 'docRequired' => true, 'example' => '["c-*********************"]', 'default' => '[]'], ], [ 'name' => 'ClientIds', 'in' => 'query', 'style' => 'json', 'schema' => ['description' => 'The IDs of Cloud Backup clients. The total number of Cloud Backup client IDs and ECS instance IDs cannot exceed 100.'."\n", 'type' => 'object', 'required' => false, 'docRequired' => true, 'example' => '["i-0xi5wj******3j3bh2gj5"]', 'default' => '[]'], ], [ 'name' => 'CrossAccountType', 'in' => 'query', 'schema' => ['description' => 'Specifies whether data is backed up within the same Alibaba Cloud account or across Alibaba Cloud accounts. Valid values:'."\n" ."\n" .'* SELF_ACCOUNT: Data is backed up within the same Alibaba Cloud account.'."\n" .'* CROSS_ACCOUNT: Data is backed up across Alibaba Cloud accounts.'."\n", 'type' => 'string', 'required' => false, 'example' => 'CROSS_ACCOUNT'], ], [ 'name' => 'CrossAccountUserId', 'in' => 'query', 'schema' => ['description' => 'The ID of the source Alibaba Cloud account that authorizes the current Alibaba Cloud account to back up data across Alibaba Cloud accounts.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1283948272xxxxx'], ], [ 'name' => 'CrossAccountRoleName', 'in' => 'query', 'schema' => ['description' => 'The name of the RAM role that is created within the source Alibaba Cloud account and assigned to the current Alibaba Cloud account to authorize the current Alibaba Cloud account to back up data across Alibaba Cloud accounts.'."\n", 'type' => 'string', 'required' => false, 'example' => 'hbrcrossrole'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Code' => ['description' => 'The HTTP status code. The status code 200 indicates that the call is successful.'."\n", 'type' => 'string', 'example' => '200'], 'Message' => ['description' => 'The message that is returned. If the call is successful, "successful" is returned. If the call fails, an error message is returned.'."\n", 'type' => 'string', 'example' => 'successful'], 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E'], 'TaskId' => ['description' => 'The ID of the asynchronous job. You can call the DescribeTask operation to query the execution result of an asynchronous job.'."\n", 'type' => 'string', 'example' => 't-*********************'], 'Success' => ['description' => 'Indicates whether the call is successful. Valid values:'."\n" ."\n" .'* true: The call is successful.'."\n" .'* false: The call fails.'."\n", 'type' => 'boolean', 'example' => 'true'], 'InstanceStatuses' => [ 'description' => 'The status of the ECS instance. If the status of an ECS instance cannot meet the requirements to install an HBR client and the value of the InstanceIds parameter is greater than 1, an error message is returned based on the value of this parameter.'."\n", 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'ValidInstance' => ['description' => 'Indicates whether an HBR client can be installed on the ECS instance. Valid values:'."\n" ."\n" .'* true: An HBR client can be installed on the ECS instance.'."\n" .'* false: An HBR client cannot be installed on the ECS instance.'."\n", 'type' => 'boolean', 'example' => 'true'], 'InstanceId' => ['description' => 'The ID of the ECS instance.'."\n", 'type' => 'string', 'example' => 'i-0xi5w***v3j3bh2gj5'], 'ErrorCode' => ['description' => 'The error code that is returned. Valid values:'."\n" ."\n" .'* If the value is empty, the call is successful.'."\n" .'* **InstanceNotExists**: The ECS instance does not exist.'."\n" .'* **InstanceNotRunning**: The ECS instance is not running.'."\n" .'* **CloudAssistNotRunningOnInstance**: Cloud Assistant is unavailable.'."\n", 'type' => 'string', 'example' => 'InstanceNotExists'], ], ], ], ], ], ], ], 'title' => 'UpgradeBackupClients', 'summary' => 'Upgrades an HBR client on one or more Elastic Compute Service (ECS) instances.', 'description' => '* This operation creates an asynchronous job at the backend and calls Cloud Assistant to upgrade an HBR client that is installed on an ECS instance.'."\n" .'* You can call the DescribeTask operation to query the execution result of an asynchronous job.'."\n" .'* The timeout period of an asynchronous job is 15 minutes.'."\n", 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'UpgradeBackupClients'], ], ], 'ramActions' => [], 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\",\\n \\"TaskId\\": \\"t-*********************\\",\\n \\"Success\\": true,\\n \\"InstanceStatuses\\": [\\n {\\n \\"ValidInstance\\": true,\\n \\"InstanceId\\": \\"i-0xi5w***v3j3bh2gj5\\",\\n \\"ErrorCode\\": \\"InstanceNotExists\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n 200\\n successful\\n 473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\n t-*********************\\n true\\n \\n true\\n i-0xi5w***v3j3bh2gj5\\n InstanceNotExists\\n \\n","errorExample":""}]', ], 'UpgradeClient' => [ 'methods' => ['post', 'get'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREhbrI97IXK', 'FEATUREhbr3BJQCT', 'FEATUREhbrTH4MM4'], ], 'parameters' => [ [ 'name' => 'VaultId', 'in' => 'query', 'schema' => ['description' => 'The ID of the backup vault.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'v-000djw8ci******3ic', 'title' => ''], ], [ 'name' => 'ClientId', 'in' => 'query', 'schema' => ['description' => 'The ID of the Cloud Backup client.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'c-000boklw******63a9', 'title' => ''], ], [ 'name' => 'ResourceGroupId', 'in' => 'query', 'schema' => ['description' => 'The ID of the resource group.', 'type' => 'string', 'required' => false, 'example' => 'rg-acfmy6uja5wyc2i', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Code' => ['description' => 'The response code. The status code 200 indicates that the request was successful.', 'type' => 'string', 'example' => '200', 'title' => ''], 'Message' => ['description' => 'The returned message. If the request was successful, "successful" is returned. If the request failed, an error message is returned.', 'type' => 'string', 'example' => 'successful', 'title' => ''], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '22D97921-16BD-547C-B175-1DC25B1DCD73', 'title' => ''], 'TaskId' => ['description' => 'The ID of the asynchronous job. You can call the DescribeTask operation to query the execution result of an asynchronous job.', 'type' => 'string', 'example' => 't-000i97jujk0z58a2ignf', 'title' => ''], 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" ."\n" .'- true'."\n" ."\n" .'- false', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'title' => 'UpgradeClient', 'summary' => 'Upgrades the Cloud Backup client.', 'description' => 'Upgrades a Cloud Backup client to the latest version. After the upgrade succeeds, the client version cannot be rolled back.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'UpgradeClient'], ], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'hbr:UpgradeClient', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'HBR', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"22D97921-16BD-547C-B175-1DC25B1DCD73\\",\\n \\"TaskId\\": \\"t-000i97jujk0z58a2ignf\\",\\n \\"Success\\": true\\n}","type":"json"}]', ], ], 'endpoints' => [ ['regionId' => 'cn-wulanchabu', 'regionName' => 'China (Ulanqab)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'hbr.cn-wulanchabu.aliyuncs.com', 'endpoint' => 'hbr.cn-wulanchabu.aliyuncs.com', 'vpc' => 'hbr-vpc.cn-wulanchabu.aliyuncs.com'], ['regionId' => 'cn-beijing', 'regionName' => 'China (Beijing)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'hbr.cn-beijing.aliyuncs.com', 'endpoint' => 'hbr.cn-beijing.aliyuncs.com', 'vpc' => 'hbr-vpc.cn-beijing.aliyuncs.com'], ['regionId' => 'cn-qingdao', 'regionName' => 'China (Qingdao)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'hbr.cn-qingdao.aliyuncs.com', 'endpoint' => 'hbr.cn-qingdao.aliyuncs.com', 'vpc' => 'hbr-vpc.cn-qingdao.aliyuncs.com'], ['regionId' => 'cn-shanghai', 'regionName' => 'China (Shanghai)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'hbr.cn-shanghai.aliyuncs.com', 'endpoint' => 'hbr.cn-shanghai.aliyuncs.com', 'vpc' => 'hbr-vpc.cn-shanghai.aliyuncs.com'], ['regionId' => 'cn-hongkong', 'regionName' => 'China (Hong Kong)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'hbr.cn-hongkong.aliyuncs.com', 'endpoint' => 'hbr.cn-hongkong.aliyuncs.com', 'vpc' => 'hbr-vpc.cn-hongkong.aliyuncs.com'], ['regionId' => 'cn-heyuan', 'regionName' => 'China (Heyuan)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'hbr.cn-heyuan.aliyuncs.com', 'endpoint' => 'hbr.cn-heyuan.aliyuncs.com', 'vpc' => 'hbr-vpc.cn-heyuan.aliyuncs.com'], ['regionId' => 'cn-zhangjiakou', 'regionName' => 'China (Zhangjiakou)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'hbr.cn-zhangjiakou.aliyuncs.com', 'endpoint' => 'hbr.cn-zhangjiakou.aliyuncs.com', 'vpc' => 'hbr-vpc.cn-zhangjiakou.aliyuncs.com'], ['regionId' => 'cn-shenzhen', 'regionName' => 'China (Shenzhen)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'hbr.cn-shenzhen.aliyuncs.com', 'endpoint' => 'hbr.cn-shenzhen.aliyuncs.com', 'vpc' => 'hbr-vpc.cn-shenzhen.aliyuncs.com'], ['regionId' => 'ap-northeast-2', 'regionName' => 'South Korea (Seoul)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'hbr.ap-northeast-2.aliyuncs.com', 'endpoint' => 'hbr.ap-northeast-2.aliyuncs.com', 'vpc' => 'hbr-vpc.ap-northeast-2.aliyuncs.com'], ['regionId' => 'ap-northeast-1', 'regionName' => 'Japan (Tokyo)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'hbr.ap-northeast-1.aliyuncs.com', 'endpoint' => 'hbr.ap-northeast-1.aliyuncs.com', 'vpc' => 'hbr-vpc.ap-northeast-1.aliyuncs.com'], ['regionId' => 'cn-chengdu', 'regionName' => 'China (Chengdu)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'hbr.cn-chengdu.aliyuncs.com', 'endpoint' => 'hbr.cn-chengdu.aliyuncs.com', 'vpc' => 'hbr-vpc.cn-chengdu.aliyuncs.com'], ['regionId' => 'cn-guangzhou', 'regionName' => 'China (Guangzhou)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'hbr.cn-guangzhou.aliyuncs.com', 'endpoint' => 'hbr.cn-guangzhou.aliyuncs.com', 'vpc' => 'hbr-vpc.cn-guangzhou.aliyuncs.com'], ['regionId' => 'ap-southeast-1', 'regionName' => 'Singapore', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'hbr.ap-southeast-1.aliyuncs.com', 'endpoint' => 'hbr.ap-southeast-1.aliyuncs.com', 'vpc' => 'hbr-vpc.ap-southeast-1.aliyuncs.com'], ['regionId' => 'ap-southeast-3', 'regionName' => 'Malaysia (Kuala Lumpur)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'hbr.ap-southeast-3.aliyuncs.com', 'endpoint' => 'hbr.ap-southeast-3.aliyuncs.com', 'vpc' => 'hbr-vpc.ap-southeast-3.aliyuncs.com'], ['regionId' => 'cn-huhehaote', 'regionName' => 'China (Hohhot)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'hbr.cn-huhehaote.aliyuncs.com', 'endpoint' => 'hbr.cn-huhehaote.aliyuncs.com', 'vpc' => 'hbr-vpc.cn-huhehaote.aliyuncs.com'], ['regionId' => 'ap-southeast-5', 'regionName' => 'Indonesia (Jakarta)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'hbr.ap-southeast-5.aliyuncs.com', 'endpoint' => 'hbr.ap-southeast-5.aliyuncs.com', 'vpc' => 'hbr-vpc.ap-southeast-5.aliyuncs.com'], ['regionId' => 'ap-southeast-6', 'regionName' => 'Philippines (Manila)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'hbr.ap-southeast-6.aliyuncs.com', 'endpoint' => 'hbr.ap-southeast-6.aliyuncs.com', 'vpc' => 'hbr-vpc.ap-southeast-6.aliyuncs.com'], ['regionId' => 'ap-southeast-7', 'regionName' => 'Thailand (Bangkok)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'hbr.ap-southeast-7.aliyuncs.com', 'endpoint' => 'hbr.ap-southeast-7.aliyuncs.com', 'vpc' => 'hbr-vpc.ap-southeast-7.aliyuncs.com'], ['regionId' => 'cn-hangzhou', 'regionName' => 'China (Hangzhou)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'hbr.cn-hangzhou.aliyuncs.com', 'endpoint' => 'hbr.cn-hangzhou.aliyuncs.com', 'vpc' => 'hbr-vpc.cn-hangzhou.aliyuncs.com'], ['regionId' => 'us-east-1', 'regionName' => 'US (Virginia)', 'areaId' => 'europeAmerica', 'areaName' => 'Europe & Americas', 'public' => 'hbr.us-east-1.aliyuncs.com', 'endpoint' => 'hbr.us-east-1.aliyuncs.com', 'vpc' => 'hbr-vpc.us-east-1.aliyuncs.com'], ['regionId' => 'eu-west-1', 'regionName' => 'UK (London)', 'areaId' => 'europeAmerica', 'areaName' => 'Europe & Americas', 'public' => 'hbr.eu-west-1.aliyuncs.com', 'endpoint' => 'hbr.eu-west-1.aliyuncs.com', 'vpc' => 'hbr-vpc.eu-west-1.aliyuncs.com'], ['regionId' => 'us-west-1', 'regionName' => 'US (Silicon Valley)', 'areaId' => 'europeAmerica', 'areaName' => 'Europe & Americas', 'public' => 'hbr.us-west-1.aliyuncs.com', 'endpoint' => 'hbr.us-west-1.aliyuncs.com', 'vpc' => 'hbr-vpc.us-west-1.aliyuncs.com'], ['regionId' => 'eu-central-1', 'regionName' => 'Germany (Frankfurt)', 'areaId' => 'europeAmerica', 'areaName' => 'Europe & Americas', 'public' => 'hbr.eu-central-1.aliyuncs.com', 'endpoint' => 'hbr.eu-central-1.aliyuncs.com', 'vpc' => 'hbr-vpc.eu-central-1.aliyuncs.com'], ['regionId' => 'me-east-1', 'regionName' => 'UAE (Dubai)', 'areaId' => 'middleEast', 'areaName' => 'Middle East', 'public' => 'hbr.me-east-1.aliyuncs.com', 'endpoint' => 'hbr.me-east-1.aliyuncs.com', 'vpc' => 'hbr-vpc.me-east-1.aliyuncs.com'], ['regionId' => 'me-central-1', 'regionName' => 'Saudi Arabia (Riyadh)', 'areaId' => 'middleEast', 'areaName' => 'Middle East', 'public' => 'hbr.me-central-1.aliyuncs.com', 'endpoint' => 'hbr.me-central-1.aliyuncs.com', 'vpc' => 'hbr-vpc.me-central-1.aliyuncs.com'], ['regionId' => 'cn-hangzhou-finance', 'regionName' => 'China East 1 Finance', 'areaId' => 'industryCloud', 'areaName' => 'Industry Cloud', 'public' => 'hbr.cn-hangzhou-finance.aliyuncs.com', 'endpoint' => 'hbr.cn-hangzhou-finance.aliyuncs.com', 'vpc' => 'hbr-vpc.cn-hangzhou-finance.aliyuncs.com'], ['regionId' => 'cn-shenzhen-finance-1', 'regionName' => 'China South 1 Finance', 'areaId' => 'industryCloud', 'areaName' => 'Industry Cloud', 'public' => 'hbr.cn-shenzhen-finance-1.aliyuncs.com', 'endpoint' => 'hbr.cn-shenzhen-finance-1.aliyuncs.com', 'vpc' => 'hbr-vpc.cn-shenzhen-finance-1.aliyuncs.com'], ['regionId' => 'cn-beijing-finance-1', 'regionName' => 'China North 2 Finance (Preview)', 'areaId' => 'industryCloud', 'areaName' => 'Industry Cloud', 'public' => 'hbr.cn-beijing-finance-1.aliyuncs.com', 'endpoint' => 'hbr.cn-beijing-finance-1.aliyuncs.com', 'vpc' => 'hbr-vpc.cn-beijing-finance-1.aliyuncs.com'], ['regionId' => 'cn-shanghai-finance-1', 'regionName' => 'China East 2 Finance', 'areaId' => 'industryCloud', 'areaName' => 'Industry Cloud', 'public' => 'hbr.cn-shanghai-finance-1.aliyuncs.com', 'endpoint' => 'hbr.cn-shanghai-finance-1.aliyuncs.com', 'vpc' => 'hbr-vpc.cn-shanghai-finance-1.aliyuncs.com'], ], 'errorCodes' => [ ['code' => 'AirBackupJobNotExists', 'message' => 'The air backup job does not exist.', 'http_code' => 404, 'description' => 'The ECS Backup Air backup job does not exist.'], ['code' => 'AirBackupPlanNotExists', 'message' => 'The air backup plan does not exist.', 'http_code' => 404, 'description' => 'The ECS Backup Air plan does not exist.'], ['code' => 'AirInstanceAtLeastOnePlan', 'message' => 'The air instance must have one plan.', 'http_code' => 400, 'description' => 'The air instance must have at least one plan.'], ['code' => 'AirInstanceError', 'message' => 'The air instance is error, does not support this operation.', 'http_code' => 400, 'description' => 'The ECS Backup Air is in error status. This operation is not supported. Please rebind or unbind ECS.'], ['code' => 'AirInstanceExpired', 'message' => 'The air instance is expired, does not support this operation.', 'http_code' => 400, 'description' => 'The Ecs Backup Air instance is expired, does not support this operation.'], ['code' => 'AirInstanceInitializing', 'message' => 'The air instance is in INITIALIZING.', 'http_code' => 400, 'description' => 'The ECS Backup Air instance is in INITIALIZING or UNBINDING status, does not support this operation.'], ['code' => 'AirInstanceNotExists', 'message' => 'The air Instance does not exist.', 'http_code' => 404, 'description' => 'The ECS Backup Air instance does not exist.'], ['code' => 'ArchiveDaysTooShort', 'message' => 'The snapshot should be in standard bucket for at least 30 days.', 'http_code' => 400, 'description' => ''], ['code' => 'ArchiveRetentionDaysTooShort', 'message' => 'The archive snapshot should be in archive bucket for at least 60 days.', 'http_code' => 400, 'description' => ''], ['code' => 'ArchiveSnapshotCannotDetect', 'message' => 'Archive snapshot cannot detect.', 'http_code' => 400, 'description' => 'The snapshot is archived, cannot do detect.'], ['code' => 'ArchiveSnapshotCannotGenerateReport', 'message' => 'The archived snapshot can not generate report.', 'http_code' => 400, 'description' => 'The archived snapshot can not generate report.'], ['code' => 'BackupJobStillRunning', 'message' => 'Previous backup job has not complete yet, please wait until it complete.', 'http_code' => 400, 'description' => 'The preceding backup jobs has not been completed. Please wait until the backup jobs are completed.'], ['code' => 'BrowseDuplicateLoad', 'message' => 'Backend job have already submitted.', 'http_code' => 400, 'description' => 'The task is running at the backend.'], ['code' => 'BrowseFileError', 'message' => 'An error occurred while browsing the backup files; please submit a ticket.', 'http_code' => 500, 'description' => ''], ['code' => 'BrowseFileError', 'message' => 'Browse file error.', 'http_code' => 400, 'description' => 'Failed to browse file'], ['code' => 'BrowseTimeout', 'message' => 'Too many files in this folder, backend job have already launched. Please wait for a while and try again.', 'http_code' => 400, 'description' => 'The folder contains too many files. A task is running at the backend to process the files. Please wait for a while and try again.'], ['code' => 'CannotArchiveDetectingSnapshot', 'message' => 'Can not archive detecting snapshot.', 'http_code' => 400, 'description' => 'The snapshot is detecting, can not be archived. Please wait for the snapshot detection to complete before retry.'], ['code' => 'CannotDeleteActiveClient', 'message' => 'The active client can not deleted.', 'http_code' => 400, 'description' => 'Active clients cannot be deleted.'], ['code' => 'CannotDeleteArchivedSnapshot', 'message' => 'Can not delete archived snapshot.', 'http_code' => 400, 'description' => 'The snapshot is archived, can not delete manually. Please wait for the snapshot to expire, it will be deleted automatically by Cloud Backup service.'], ['code' => 'CannotDeleteArchivingSnapshot', 'message' => 'Can not delete archiving snapshot.', 'http_code' => 400, 'description' => 'The snapshot is archving, can not delete it manually. Please wait for the snapshot to expire and it will be deleted automatically by Cloud Backup service.'], ['code' => 'CannotDeleteDetectingSnapshot', 'message' => 'Cannot delete detecting snapshot.', 'http_code' => 400, 'description' => 'The snapshot is detecting, cannot be deleted. Please wait for the detection to complete before retry.'], ['code' => 'CannotDeleteLatestOtsSnapshot', 'message' => 'Cannot delete latest snapshot. The backup plan has enabled Keep-Latest-Snapshot. If you want to delete this snapshot, please delete the backup plan first.', 'http_code' => 400, 'description' => 'The latest backup cannot be deleted. "Keep Latest Backup" is enabled for this backup plan. If you still want to delete this backup, delete the backup plan first.'], ['code' => 'CannotDeleteLatestSnapshot', 'message' => 'Cannot delete latest snapshot. The backup plan has enabled Keep-Latest-Snapshot. If you want to delete this snapshot, please turn off Keep-Latest-Snapshot.', 'http_code' => 400, 'description' => 'The latest backup cannot be deleted. "Keep At Least One Backup Version" is enabled for this backup plan. If you still want to delete this backup, turn off "Keep At Least One Backup Version" first.'], ['code' => 'CannotDeletePlanWithRunningJobs', 'message' => 'Cannot delete plan with running jobs.', 'http_code' => 400, 'description' => 'You cannot delete a schedule while a task is running'], ['code' => 'CannotDeleteReplicationSourceVault', 'message' => 'Cannot delete replication source vault.', 'http_code' => 400, 'description' => 'You cannot delete the source backup database for cross-region backup.'], ['code' => 'CannotInstallNewClientWithAegisClient', 'message' => 'Cannot install client on this ECS because an old version of aegis backup client already installed.', 'http_code' => 400, 'description' => 'The client cannot be installed on this ECS because an older version of the aegis backup client is already installed.'], ['code' => 'CannotOperateClientInstalledByEcsOwner', 'message' => 'Can not operate client on this ECS because it was installed by ECS owner.', 'http_code' => 403, 'description' => 'Cannot operate another user\'s ECS client'], ['code' => 'CannotOperateClientInstalledByOthers', 'message' => 'The client is installed by another service, can not be operated.', 'http_code' => 400, 'description' => 'You cannot operate clients installed by other services.'], ['code' => 'CannotTurnOffKeepLatestSnapshot', 'message' => 'Cannot turn off Keep latest snapshot, please set KeepLatestSnapshot to 1.', 'http_code' => 400, 'description' => '"Keep At Least One Backup Version" cannot be turned off. We recommend that you enable this feature.'], ['code' => 'CannotUnInstallNewClientWithAegisClient', 'message' => 'The client is being used by the Anti-Ransomware feature of Security Center and cannot be deleted.', 'http_code' => 403, 'description' => 'The client is being used by the Anti-Ransomware feature of Security Center and cannot be deleted.'], ['code' => 'CannotUpgradeClientWithRunningJobs', 'message' => 'Cannot upgrade the client when there is an ongoing job. Try again after the job is finished.', 'http_code' => 400, 'description' => ''], ['code' => 'Client.HanaInvalidCertOrNetworkFailure', 'message' => 'Connection to database failed, please ensure the server certificate is valid and network is reachable.', 'http_code' => 400, 'description' => 'Connection to database failed, please ensure the server certificate is valid and network is reachable.'], ['code' => 'Client.HanaSqlError', 'message' => 'Internal HANA SQL error.', 'http_code' => 400, 'description' => 'The client reported an error when executing the HANA SQL statement.'], ['code' => 'Client.HanaSqlError', 'message' => 'Hana reports error when execute SQL statements.', 'http_code' => 400, 'description' => 'An error occurred while Hana was executing the SQL statement.'], ['code' => 'ClientBindsToWormVaultCannotBeDeleted', 'message' => 'The client is bound to a backup vault that has enabled backup lock. You cannot delete the client.', 'http_code' => 400, 'description' => ''], ['code' => 'ClientBindsToWormVaultCannotBeDeleted', 'message' => 'Cannot delete client bond to WORM vault.', 'http_code' => 400, 'description' => 'Deletion of a client from a WORM backup vault is not allowed'], ['code' => 'ClientResponseTimeout', 'message' => 'The client response timed out.', 'http_code' => 400, 'description' => 'The client response timed out.'], ['code' => 'CloudAssistNotRunningOnInstance', 'message' => 'There is no cloud assistant running on the instance.', 'http_code' => 400, 'description' => 'There is no cloud assistant running on the instance.'], ['code' => 'ClusterNameDuplicate', 'message' => 'The cluster name already exists, please modify the cluster name and try again.', 'http_code' => 400, 'description' => 'The cluster name already exists, please modify the cluster name and try again.'], ['code' => 'ClusterNotExist', 'message' => 'Cluster does not exist.', 'http_code' => 400, 'description' => 'Cluster does not exist'], ['code' => 'CommodityCodeNotSupport', 'message' => 'The commodity code does not support.', 'http_code' => 404, 'description' => 'Commodity Code is not supported.'], ['code' => 'ContainerBackupJobStillRunning', 'message' => 'The previous backup task for this resource is still running.', 'http_code' => 400, 'description' => ''], ['code' => 'ContainerClusterNotExists', 'message' => 'The container cluster does not exist.', 'http_code' => 404, 'description' => 'The container cluster does not exist.'], ['code' => 'CrossAccountBackupSlrNotExist', 'message' => 'AliyunServiceRoleForHbrCrossAccountBackup does not exist, please create this role.', 'http_code' => 400, 'description' => ''], ['code' => 'CrossAccountBackupSlrNotExist', 'message' => 'AliyunServiceRoleForHbrCrossAccountBackup doesn\'t exist, please create this role.', 'http_code' => 200, 'description' => 'AliyunServiceRoleForHbrCrossAccountBackup the role does not exist, create this service association role.'], ['code' => 'CrossAccountItemNotExists', 'message' => 'The cross account item not exists.', 'http_code' => 403, 'description' => 'Cross-account information does not exist'], ['code' => 'DataSourceNotExists', 'message' => 'Data source not exist.', 'http_code' => 400, 'description' => 'Data source does not exist'], ['code' => 'DoNotHaveActivatedClient', 'message' => 'There is not any actived client.', 'http_code' => 400, 'description' => 'There are no active clients.'], ['code' => 'EcsAlreadyHasClientInstalledByOthers', 'message' => 'The ECS already has a client which managed by another service.', 'http_code' => 400, 'description' => 'The ECS instance already has a disaster recovery client managed by other services.'], ['code' => 'EncryptedDiskNotSupportCopy', 'message' => 'The instance contains encrypted disk not support replication in ecs server backup.', 'http_code' => 400, 'description' => ''], ['code' => 'ExceedMaxBytes', 'message' => 'The bytes done exceeds 500G.', 'http_code' => 400, 'description' => 'The bytes done exceeds the upper limit.'], ['code' => 'FailedToActivateUniBackupInstance', 'message' => 'Failed to activate unibackup instance.', 'http_code' => 400, 'description' => 'Unable to activate database backup instance'], ['code' => 'FailedToCreateUniBackupJob', 'message' => 'Failed to create unibackup job.', 'http_code' => 400, 'description' => 'Unable to create database backup task'], ['code' => 'FailedToDeleteUniBackupJob', 'message' => 'Failed to delete unibackup job.', 'http_code' => 400, 'description' => 'Unable to delete database backup task'], ['code' => 'FailedToDescribeFileSystems', 'message' => 'Failed to describe NAS file systems.', 'http_code' => 400, 'description' => 'Failed to describe NAS file systems.'], ['code' => 'FailedToGetOssBucket', 'message' => 'Failed to get oss bucket.', 'http_code' => 400, 'description' => 'Failed to get oss bucket.'], ['code' => 'FailedToListUniBackupInstanceDetail', 'message' => 'Failed to list unibackup instance detail.', 'http_code' => 400, 'description' => 'Unable to list database instance details'], ['code' => 'FailedToListUniBackupResources', 'message' => 'Failed to list unibackup resources.', 'http_code' => 400, 'description' => 'Expand Database Instance Resources'], ['code' => 'FailedToUpdateUniBackupJob', 'message' => 'Failed to update unibackup job.', 'http_code' => 400, 'description' => 'Unable to update database backup task'], ['code' => 'FileDetectionNotExits', 'message' => 'File detection not exists.', 'http_code' => 400, 'description' => 'The file detection record does not exist, please submit the ticket.'], ['code' => 'HanaNodeNotExist', 'message' => 'There is no hana node.', 'http_code' => 400, 'description' => 'No legitimate hana node found'], ['code' => 'HanaNotExist', 'message' => 'The HANA cluster or instance does not exist.', 'http_code' => 404, 'description' => 'The HANA cluster or instance does not exist.'], ['code' => 'HanaUsesWormVaultCannotBeDeleted', 'message' => 'Hana instances that use worm vault cannot be deleted.', 'http_code' => 400, 'description' => 'Hana instances that use locked backup vaults cannot be deleted.'], ['code' => 'HanaUsesWormVaultCannotBeDeleted', 'message' => 'Cannot delete Hana instance in WORM vault.', 'http_code' => 400, 'description' => 'HANA instances in the locked backup vault are not allowed to be deleted.'], ['code' => 'HbrRoleNotExist', 'message' => 'Aliyun HBR default role doesn\'t exist.', 'http_code' => 400, 'description' => 'The default role of Alibaba Cloud Backup does not exist.'], ['code' => 'ImmutableSnapshotCannotBeDeleted', 'message' => 'This ECS instance backup snapshot is immutable and cannot be deleted.', 'http_code' => 403, 'description' => 'This ECS instance backup snapshot is immutable and cannot be deleted.'], ['code' => 'InDebt', 'message' => 'Use is in debt.', 'http_code' => 400, 'description' => 'User is overdue.'], ['code' => 'InDebtOverdue', 'message' => 'The user is overdue.', 'http_code' => 400, 'description' => 'The user is overdue, please recharge before using the service.'], ['code' => 'InitVaultError', 'message' => 'An error occurred while initializing the repository; please submit a ticket.', 'http_code' => 500, 'description' => ''], ['code' => 'InitVaultError', 'message' => 'Initialize vault failed.', 'http_code' => 400, 'description' => 'Failed to initialize vault.'], ['code' => 'InstanceHasBeenProtectedByAir', 'message' => 'The instance has been protected by air instance.', 'http_code' => 400, 'description' => 'The ECS instance is protected by other ECS Backup Air instances.'], ['code' => 'InstanceNotExists', 'message' => 'The instance does not exist.', 'http_code' => 400, 'description' => 'Instance does not exist'], ['code' => 'InstanceNotRunning', 'message' => 'The Ecs instance is not running.', 'http_code' => 400, 'description' => 'The ECS instance is not running.'], ['code' => 'INSUFFICIENT_AVAILABLE_QUOTA', 'message' => 'Your account balance drops below 0. Top up your account balance before you can make a purchase.', 'http_code' => 400, 'description' => 'Your account balance is insufficient, please recharge before purchasing.'], ['code' => 'InvalidBackupInterval', 'message' => 'invalid backup interval, please modify your parameter', 'http_code' => 400, 'description' => ''], ['code' => 'InvalidBackupRuleRetention', 'message' => 'The retention of BACKUP rules is invalid. If the policy has no TRANSITION rule, the retention of BACKUP rule must be -1 or 1 to 364635 days.', 'http_code' => 400, 'description' => 'The retention of BACKUP rules is invalid. If the policy has no TRANSITION rule, the retention of BACKUP rule must be -1 or 1 to 364635 days.'], ['code' => 'InvalidDestinationPath', 'message' => 'Invalid destination path.', 'http_code' => 400, 'description' => 'Invalid destination path'], ['code' => 'InvalidPolicyPolicyNameDuplicate', 'message' => 'The policy name is duplicate.', 'http_code' => 400, 'description' => 'Duplicate policy name.'], ['code' => 'InvalidPolicyPolicyNameTooLong', 'message' => 'The policy name is too long. The length should be between 1 and 64 characters.', 'http_code' => 400, 'description' => 'The policy name is too long. The length should be between 1 and 64 characters.'], ['code' => 'InvalidPolicyType', 'message' => 'The policy type does not allow binding to this type of data source. Please change the policy and try again.', 'http_code' => 400, 'description' => 'The policy type does not allow binding to this type of data source. Please change the policy and try again.'], ['code' => 'InvalidScheduleFormat', 'message' => 'invalid schedule format, please modify your parameter', 'http_code' => 400, 'description' => ''], ['code' => 'InvalidScheduleForOtsIncrementalBackup', 'message' => 'Invalid backup interval for Tablestore incremental backup, please modify the parameters.', 'http_code' => 400, 'description' => 'The time interval specified for the incremental backup of Tablestore data is invalid. Modify the parameter.'], ['code' => 'InvalidSourcePath', 'message' => 'Invalid source path.', 'http_code' => 400, 'description' => 'Invalid source path'], ['code' => 'InvalidStatusToDetect', 'message' => 'The archiving snapshot can not do detect.', 'http_code' => 400, 'description' => 'The snapshot is archiving, can not do detect.'], ['code' => 'InvalidToken', 'message' => 'The token is invalid.', 'http_code' => 400, 'description' => 'Token is not valid.'], ['code' => 'InventoryFilterPrefixNotEqualToBackupPrefix', 'message' => 'Inventory filter prefix does not equal to backup prefix', 'http_code' => 400, 'description' => 'Cannot create backup plan. The OSS inventory filter does not equal to the backup prefix. Please modify the filter or backup prefix.'], ['code' => 'InventoryFilterPrefixNotEqualToBackupPrefix', 'message' => 'OSS inventory filter prefix doesn\'t equal to backup prefix.', 'http_code' => 400, 'description' => 'The prefix of the OSS inventory is different from the prefix of the backup task.'], ['code' => 'JobCanceled', 'message' => 'The job has been canceled.', 'http_code' => 400, 'description' => 'The job has been canceled.'], ['code' => 'LocalDiskNotSupported', 'message' => 'This instance has local disk(s) that is not supported by HBR ECS Server Backup', 'http_code' => 400, 'description' => ''], ['code' => 'LocalDiskNotSupported', 'message' => 'Not support local disk yet.', 'http_code' => 400, 'description' => 'Local cloud disks are not supported.'], ['code' => 'MagpieBridgeSlrNotExist', 'message' => 'AliyunServiceRoleForHbrMagpieBridge doesn\'t exist, please create this role.', 'http_code' => 403, 'description' => 'AliyunServiceRoleForHbrMagpieBridge doesn\'t exist, please create this role.'], ['code' => 'NasFileSystemNotExist', 'message' => 'The NAS file system does not exsit.', 'http_code' => 404, 'description' => 'The NAS file system does not exist.'], ['code' => 'NasFileSystemTypeNotSupported', 'message' => 'The NAS file system type is not supported.', 'http_code' => 400, 'description' => 'This NAS file system type is not supported.'], ['code' => 'NasServiceNotOpened', 'message' => 'Alibaba Cloud NAS has not been activated. Go to the Alibaba Cloud NAS console to activate the product.', 'http_code' => 400, 'description' => 'Your account does not open Nas Service yet or balance is insufficient.'], ['code' => 'NoCompleteBackupRule', 'message' => 'The policy is missing the backup rule for full backup. Add it and try again.', 'http_code' => 400, 'description' => 'The policy is missing the backup rule (RuleType = BACKUP) for full backup (BackupType = COMPLETE). Add it and try again.'], ['code' => 'NoPermissionToCreateCrossAccountBackupSlr', 'message' => 'No permission to create AliyunServiceRoleForHbrCrossAccountBackup', 'http_code' => 400, 'description' => ''], ['code' => 'NoPermissionToCreateMagpieBridgeSlr', 'message' => 'No permission to create AliyunServiceRoleForHbrMagpieBridge.', 'http_code' => 403, 'description' => 'AliyunServiceRoleForHbrMagpieBridge you do not have permission to create a service association role, please check the permission.'], ['code' => 'NoSuchEcsInstance', 'message' => 'The ECS Instance does not exist.', 'http_code' => 404, 'description' => ''], ['code' => 'NotExist_ResourceGroup', 'message' => 'The resource group does not exist.', 'http_code' => 403, 'description' => 'The resource group does not exist.'], ['code' => 'OssBucketNotFound', 'message' => 'The OSS bucket is not found.', 'http_code' => 404, 'description' => 'The OSS bucket is not found.'], ['code' => 'PlanNameDuplicate', 'message' => 'Plan with specified name already exists.', 'http_code' => 400, 'description' => 'Plan with specified name already exists.'], ['code' => 'PlanNotExist', 'message' => 'Plan doesn\'t exist.', 'http_code' => 400, 'description' => 'Plan does not exist'], ['code' => 'PolicyAlreadyBoundWithThisDataSource', 'message' => 'This datasource has already been bound with the policy, please use another one.', 'http_code' => 400, 'description' => ''], ['code' => 'PolicyAlreadyExist', 'message' => 'The specified policy already exists.', 'http_code' => 400, 'description' => ''], ['code' => 'PolicyBindingCreatedByTagCannotDelete', 'message' => 'The policy binding is created by tag rule in the policy, can not be deleted.', 'http_code' => 403, 'description' => 'The policy binding is created by tag rule in the policy, can not be deleted.'], ['code' => 'PolicyBindingExists', 'message' => 'This datasource has been bound to a policy (can not create backup plan or been bound to another policy).', 'http_code' => 400, 'description' => ''], ['code' => 'PolicyBindingNotExist', 'message' => 'PolicyBinding doesn\'t exist.', 'http_code' => 404, 'description' => 'Policy binding does not exist'], ['code' => 'PolicyOnExecution', 'message' => 'The policy is on execution, please wait and retry.', 'http_code' => 400, 'description' => 'The policy is on execution, please wait and retry.'], ['code' => 'ReplicationSourceVaultNotFound', 'message' => 'The replication source vault does not exist.', 'http_code' => 404, 'description' => 'The replication source vault does not exist.'], ['code' => 'ReplicationVaultCannotBeWormIfSourceVaultNot', 'message' => 'The replication vault cannot be immutable if the source vault is not immutable.', 'http_code' => 400, 'description' => ''], ['code' => 'ReplicationVaultEncryptionTypeNotMatch', 'message' => 'Replication vault encryption type not match source vault.', 'http_code' => 400, 'description' => 'The replication vault encryption type is inconsistent with the source vault. Please modify the replication vault encryption type.'], ['code' => 'ReportFileTaskAlreadyExist', 'message' => 'The task to generate the report file already exists.', 'http_code' => 400, 'description' => 'The task to generate the report file already exists.'], ['code' => 'RoleNotExist', 'message' => 'The specified role doesn\'t exist.', 'http_code' => 404, 'description' => 'The cross-service authorization role required by the cloud backup service does not exist. Please grant the cloud backup service corresponding permissions.'], ['code' => 'SameSourceAndDestinationDataSourceError', 'message' => 'The source and destination data source can not be same.', 'http_code' => 400, 'description' => 'Source and destination cannot be the same data source'], ['code' => 'SnapshotAlreadyArchived', 'message' => 'Can not archive archived snapshot.', 'http_code' => 400, 'description' => 'The snapshot is archived, can not archive again.'], ['code' => 'SnapshotDetecting', 'message' => 'The snapshot or another snapshot in the same snapshot link is detecting.', 'http_code' => 400, 'description' => 'The snapshot or another snapshot in the same snapshot link is detecting, cannot detect this snapshot.'], ['code' => 'SnapshotExistsCanNotDeletePlan', 'message' => 'The backup plan or policy binding can not be deleted when snapshots exist.', 'http_code' => 400, 'description' => 'The backup plan/policy still has snapshots and cannot be deleted. Delete the snapshots first. Before deleting snapshots, you can pause the backup plan if you want the backup plan to no longer run.'], ['code' => 'StandardPolicyMustSetVaultId', 'message' => 'The standard policy must set vault id in the rules.', 'http_code' => 400, 'description' => 'The standard policy must set vault id in the rules.'], ['code' => 'TagKeyCannotBeEmpty', 'message' => 'The tag key in the tag filters can not be empty.', 'http_code' => 400, 'description' => 'The tag key in the policy tag filters can not be empty.'], ['code' => 'UdmBackupPlanMayExceedEcsDiskSnapshotQuota', 'message' => 'This risky backup plan may cause too many recovery points to exist at the same time, exceeding the maximum number of snapshots (default 256) that can be created by a single disk, resulting in the failure of creating new snapshots.', 'http_code' => 400, 'description' => ''], ['code' => 'UdmEcsInstanceWithSnapshotsCanNotBeDeleted', 'message' => 'The ecs instance with snapshots can not be unprotected, please delete snapshots first.', 'http_code' => 400, 'description' => 'The ECS instance has available backup points and cannot be unprotected. Delete the available recovery points first.'], ['code' => 'UdmEcsOnlyPolicyCanNotSetVaultId', 'message' => 'The ecs-instance-backup-only policy can not set vault id in the rules.', 'http_code' => 400, 'description' => 'The ecs-instance-backup-only policy can not set vault id in the rules.'], ['code' => 'VaultBoundPolicyCannotBeDeleted', 'message' => 'The vault has been bound to the policy, please go to the Policy Center, delete the policy and retry.', 'http_code' => 400, 'description' => ''], ['code' => 'VaultNotFound', 'message' => 'The vault is not found.', 'http_code' => 404, 'description' => 'The vault is not found.'], ['code' => 'VaultReplicationNotExist', 'message' => 'Vault replication doesn\'t exist.', 'http_code' => 404, 'description' => 'Vault replication doesn\'t exist.'], ['code' => 'VaultWithFileDetectionRunningCannotBeDeleted', 'message' => 'The vault with file detection running cannot be deleted.', 'http_code' => 403, 'description' => 'The vault with file detection running cannot be deleted.'], ['code' => 'WormVaultCannotBeDeleted', 'message' => 'The vault has enabled backup lock and cannot be deleted.', 'http_code' => 400, 'description' => ''], ['code' => 'WormVaultRetentionCannotBeReduced', 'message' => 'The retention days of immutable vault cannot be reduced.', 'http_code' => 400, 'description' => ''], ['code' => 'WormVaultSnapshotsCannotBeDeleted', 'message' => 'You cannot delete snapshots in the backup locked vault.', 'http_code' => 400, 'description' => ''], ['code' => 'WormVaultSupportedForStandardOnly', 'message' => 'You can only enable backup lock for standard backup vaults.', 'http_code' => 400, 'description' => ''], ['code' => 'WormVaultSupportedForStandardOnly', 'message' => 'Only Standard type vault supports WORM.', 'http_code' => 400, 'description' => 'Only the standard vault supports WORM.'], ['code' => 'CannotOperateNewClientWithBasic', 'message' => 'The client is used by the essential edition, please do not perform any operations on this client.', 'http_code' => 400, 'description' => 'The client is used by the essential edition, please do not perform any operations on this client.'], ['code' => 'CannotDeleteReplicationTargetVault', 'message' => 'Cannot delete replication target vault.', 'http_code' => 400, 'description' => 'You cannot close the copy target backup library in a copy.'], ['code' => 'ReplicationVaultCannotBeWormBeforeCreateReplication', 'message' => 'The replication vault cannot be immutable before create replication.', 'http_code' => 400, 'description' => 'The replication vault cannot be immutable before create replication.'], ['code' => 'CannotDeleteSharedResource', 'message' => 'Cannot delete shared resource.', 'http_code' => 400, 'description' => 'You cannot delete a resource from a share.'], ['code' => 'DuplicateRequest', 'message' => 'Duplicate request, another request is processing.', 'http_code' => 409, 'description' => 'Duplicate request, another request is in progress.'], ['code' => 'KmsKeyNotFound', 'message' => 'Kms key not found.', 'http_code' => 404, 'description' => 'KMS key not found.'], ['code' => 'InvalidKmsKeyStatus', 'message' => 'The status of kms key is invalid.', 'http_code' => 400, 'description' => 'The status of kms key is invalid.'], ['code' => 'BackupJobStillRunning', 'message' => 'Last Backup job with same backup plan ID is not finished yet.', 'http_code' => 400, 'description' => 'Last Backup job with same backup plan ID is not finished yet.'], ['code' => 'BASIC_INFO_UNCOMPLETED', 'message' => 'Your information is incomplete. Complete your information before the operation.', 'http_code' => 400, 'description' => 'Your user basic information is incomplete, please improve the user basic information.'], ['code' => 'ORDER.OPEND', 'message' => 'The service is activated.', 'http_code' => 400, 'description' => 'Service activated'], ['code' => 'QUOTA_NOT_ENOUGH', 'message' => 'The quota is insufficient. You can contact your channel partner to request a quota increase.', 'http_code' => 400, 'description' => 'The account limit is insufficient, please contact the channel to increase the limit.'], ['code' => 'PERMISSION_DENIED', 'message' => 'Permission denied: Unknown or unsupported caller type. Please ensure the request is made with a valid caller type (Partner, Customer, SubUser, or AssumedRoleUser).', 'http_code' => 400, 'description' => 'Unknown caller type'], ['code' => 'AccountNotEnableRdTrustedService', 'message' => 'You have not enabled HBR as a trust service of resource directory.', 'http_code' => 400, 'description' => 'You have not enabled HBR as a trust service of resource directory.'], ['code' => 'BackupAccountNotInSpecifiedRd', 'message' => 'The backup account is not in the specified resource directory.', 'http_code' => 403, 'description' => 'The account to be backed up is not in the specified resource directory.'], ['code' => 'CannotAccessRdService', 'message' => 'Cannot access resource directory service.', 'http_code' => 400, 'description' => 'Cannot access resource directory service.'], ['code' => 'CrossAccountRoleNotExist', 'message' => 'Cross account role doesn\'t exist, please check this role.', 'http_code' => 404, 'description' => 'Cross account role doesn\'t exist, please check this role.'], ['code' => 'VaultReplicationStopping', 'message' => 'Vault replication is stopping.', 'http_code' => 400, 'description' => 'Vault replication is stopping.'], ['code' => 'CrossAccountItemAlreadyExists', 'message' => 'The cross account item already exists.', 'http_code' => 400, 'description' => 'Cross-account configuration already exists. Do not create it again.'], ['code' => 'SnapshotHashRequired', 'message' => 'Snapshot hash is required.', 'http_code' => 400, 'description' => 'Snapshot hash is missing.'], ['code' => 'KmsServiceNotEnabled', 'message' => 'Kms service not enabled.', 'http_code' => 400, 'description' => 'Key Management Service not activated'], ['code' => 'FeatureDeprecated', 'message' => 'The feature has been deprecated.', 'http_code' => 400, 'description' => 'The feature has been deprecated.'], ], 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CreateVault'], ['threshold' => '-1', 'countWindow' => 1, 'regionId' => '*'], ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DeleteBackupClientResource'], ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeVaultReplicationRegions'], ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeHanaInstances'], ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'GenerateRamPolicy'], ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'StopHanaDatabaseAsync'], ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'UpdateHanaBackupPlan'], ['threshold' => '60', 'countWindow' => 60, 'regionId' => '*', 'api' => 'GetTempFileDownloadLink'], ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'EnableBackupPlan'], ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeTask'], ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DeleteHanaInstance'], ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DeleteAirEcsInstance'], ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'UpdateContainerCluster'], ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CreateClients'], ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeBackupPlans'], ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CreateBackupPlan'], ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DeleteVault'], ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CreateHanaBackupPlan'], ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'UpdatePolicyBinding'], ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CreateRestoreJob'], ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribePolicyBindings'], ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CreateReplicationVault'], ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CancelRestoreJob'], ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'UpdateHanaRetentionSetting'], ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeCrossAccounts'], ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'UpdateHanaInstance'], ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeHanaDatabases'], ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DeleteBackupClient'], ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CreateHanaRestore'], ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeVaults'], ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DeletePolicyV2'], ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeRecoverableOtsInstances'], ['threshold' => '60', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CreateTempFileUploadUrl'], ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'UpgradeClient'], ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CancelBackupJob'], ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeClients'], ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'UpdateBackupPlan'], ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeHanaBackupSetting'], ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DeleteUdmEcsInstance'], ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeBackupClients'], ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CreatePolicyBindings'], ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DeleteSnapshot'], ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CheckRole'], ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DeleteClient'], ['threshold' => '100', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CreatePolicyV2'], ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DeleteHanaBackupPlan'], ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CreateBackupJob'], ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DeleteUdmDisk'], ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DeleteBackupPlan'], ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DeletePolicyBinding'], ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeRegions'], ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeOtsTableSnapshots'], ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeRestoreJobs2'], ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'OpenHbrService'], ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'AddContainerCluster'], ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeHanaBackupPlans'], ['threshold' => '100', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribePoliciesV2'], ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CreateHanaInstance'], ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeContainerCluster'], ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeHanaBackupsAsync'], ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeHanaRestores'], ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'SearchHistoricalSnapshots'], ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DisableHanaBackupPlan'], ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'InstallBackupClients'], ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'UpgradeBackupClients'], ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'StartHanaDatabaseAsync'], ['threshold' => '100', 'countWindow' => 60, 'regionId' => '*', 'api' => 'UpdatePolicyV2'], ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'UninstallBackupClients'], ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DetachNasFileSystem'], ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'UninstallClient'], ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeHanaRetentionSetting'], ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DisableBackupPlan'], ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'UpdateClientSettings'], ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'EnableHanaBackupPlan'], ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ChangeResourceGroup'], ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ExecuteBackupPlan'], ['threshold' => '100', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ExecutePolicyV2'], ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'UpdateVault'], ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'UpdateHanaBackupSetting'], ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeBackupJobs2'], ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeUdmSnapshots'], ], ], 'ram' => [ 'productCode' => 'HBR', 'productName' => 'Cloud Backup', 'ramCodes' => ['hbr'], 'ramLevel' => 'OPERATION', 'ramConditions' => [], 'ramActions' => [ [ 'apiName' => 'DescribeBackupPlans', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'hbr:DescribeBackupPlans', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'HBR', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'DeleteContainerCluster', 'description' => '', 'operationType' => 'delete', 'ramAction' => [ 'action' => 'hbr:DeleteContainerCluster', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'HBR', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'DeleteAirEcsInstance', 'description' => '', 'operationType' => 'delete', 'ramAction' => [ 'action' => 'hbr:DeleteAirEcsInstance', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'HBR', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'CreateVaultReplication', 'description' => '', 'operationType' => 'create', 'ramAction' => [ 'action' => 'hbr:CreateVaultReplication', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'HBR', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'UpdateHanaRetentionSetting', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'hbr:UpdateHanaRetentionSetting', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'HBR', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'UpgradeClient', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'hbr:UpgradeClient', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'HBR', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'DescribeContainerCluster', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'hbr:DescribeContainerCluster', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'HBR', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'CreateTempFileUploadUrl', 'description' => '', 'operationType' => 'create', 'ramAction' => [ 'action' => 'hbr:CreateTempFileUploadUrl', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'HBR', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'DescribePoliciesV2', 'description' => '', 'operationType' => 'list', 'ramAction' => [ 'action' => 'hbr:DescribePoliciesV2', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'HBR', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'DeleteCrossAccount', 'description' => '', 'operationType' => 'delete', 'ramAction' => [ 'action' => 'hbr:DeleteCrossAccount', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'HBR', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'AddDataSource', 'description' => '', 'operationType' => 'create', 'ramAction' => [ 'action' => 'hbr:AddDataSource', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'HBR', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'UpdateHanaBackupSetting', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'hbr:UpdateHanaBackupSetting', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'HBR', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'DescribeUdmSnapshots', 'description' => '', 'operationType' => 'list', 'ramAction' => [ 'action' => 'hbr:DescribeUdmSnapshots', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'HBR', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'OpenHbrService', 'description' => '', 'operationType' => 'create', 'ramAction' => [ 'action' => 'hbr:OpenHbrService', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'HBR', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'DescribeBackupJobs2', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'hbr:DescribeBackupJobs2', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'HBR', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'DeleteBackupClient', 'description' => '', 'operationType' => 'delete', 'ramAction' => [ 'action' => 'hbr:DeleteBackupClient', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'HBR', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'BrowseFiles', 'description' => '', 'operationType' => 'list', 'ramAction' => [ 'action' => 'hbr:BrowseFiles', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'HBR', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'DescribeHanaBackupSetting', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'hbr:DescribeHanaBackupSetting', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'HBR', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'DescribeHanaRetentionSetting', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'hbr:DescribeHanaRetentionSetting', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'HBR', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'CreateVault', 'description' => '', 'operationType' => 'create', 'ramAction' => [ 'action' => 'hbr:CreateVault', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'HBR', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'AddContainerCluster', 'description' => '', 'operationType' => 'create', 'ramAction' => [ 'action' => 'hbr:AddContainerCluster', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'HBR', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'GetBasicStatistics', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'hbr:GetBasicStatistics', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'HBR', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'DescribeHanaBackupPlans', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'hbr:DescribeHanaBackupPlans', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'HBR', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'EnableBackupPlan', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'hbr:EnableBackupPlan', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'HBR', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'ChangeResourceGroup', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'hbr:ChangeResourceGroup', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'HBR', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'AddCrossAccount', 'description' => '', 'operationType' => 'create', 'ramAction' => [ 'action' => 'hbr:AddCrossAccount', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'HBR', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'StartHanaDatabaseAsync', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'hbr:StartHanaDatabaseAsync', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'HBR', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'DescribeClients', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'hbr:DescribeClients', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'HBR', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'DescribeOtsTableSnapshots', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'hbr:DescribeOtsTableSnapshots', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'HBR', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'GetTempFileDownloadLink', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'hbr:GetTempFileDownloadLink', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'HBR', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'ExecutePolicyV2', 'description' => '', 'operationType' => 'create', 'ramAction' => [ 'action' => 'hbr:ExecutePolicyV2', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'HBR', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'DescribeContainerResource', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'hbr:DescribeContainerResource', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'HBR', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'UpdateContainerCluster', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'hbr:UpdateContainerCluster', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'HBR', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'DescribeBackupClients', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'hbr:DescribeBackupClients', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'HBR', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'CreatePolicyV2', 'description' => '', 'operationType' => 'create', 'ramAction' => [ 'action' => 'hbr:CreatePolicyV2', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'HBR', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'EnableHanaBackupPlan', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'hbr:EnableHanaBackupPlan', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'HBR', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'CreateClients', 'description' => '', 'operationType' => 'create', 'ramAction' => [ 'action' => 'hbr:CreateClients', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'HBR', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'DescribeRecoverableOtsInstances', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'hbr:DescribeRecoverableOtsInstances', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'HBR', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'CreateReplicationVault', 'description' => '', 'operationType' => 'create', 'ramAction' => [ 'action' => 'hbr:CreateReplicationVault', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'HBR', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'DescribeHanaInstances', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'hbr:DescribeHanaInstances', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'HBR', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'UpdateDataSource', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'hbr:UpdateDataSource', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'HBR', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'DescribeCrossAccounts', 'description' => '', 'operationType' => 'list', 'ramAction' => [ 'action' => 'hbr:DescribeCrossAccounts', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'HBR', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'ExecuteBackupPlan', 'description' => '', 'operationType' => 'create', 'ramAction' => [ 'action' => 'hbr:ExecuteBackupPlan', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'HBR', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'DeleteBackupPlan', 'description' => '', 'operationType' => 'delete', 'ramAction' => [ 'action' => 'hbr:DeleteBackupPlan', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'HBR', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'DeleteHanaInstance', 'description' => '', 'operationType' => 'delete', 'ramAction' => [ 'action' => 'hbr:DeleteHanaInstance', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'HBR', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'SearchHistoricalSnapshots', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'hbr:SearchHistoricalSnapshots', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'HBR', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'CreateHanaRestore', 'description' => '', 'operationType' => 'create', 'ramAction' => [ 'action' => 'hbr:CreateHanaRestore', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'HBR', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'DescribePolicyBindings', 'description' => '', 'operationType' => 'list', 'ramAction' => [ 'action' => 'hbr:DescribePolicyBindings', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'HBR', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'DescribeHanaDatabases', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'hbr:DescribeHanaDatabases', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'HBR', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'CancelRestoreJob', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'hbr:CancelRestoreJob', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'HBR', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'DeleteClient', 'description' => '', 'operationType' => 'delete', 'ramAction' => [ 'action' => 'hbr:DeleteClient', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'HBR', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'UninstallBackupClients', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'hbr:UninstallBackupClients', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'HBR', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'DeleteHanaBackupPlan', 'description' => '', 'operationType' => 'delete', 'ramAction' => [ 'action' => 'hbr:DeleteHanaBackupPlan', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'HBR', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'DetachNasFileSystem', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'hbr:DetachNasFileSystem', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'HBR', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'GenerateRamPolicy', 'description' => '', 'operationType' => 'none', 'ramAction' => [ 'action' => 'hbr:GenerateRamPolicy', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'HBR', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'DeletePolicyV2', 'description' => '', 'operationType' => 'delete', 'ramAction' => [ 'action' => 'hbr:DeletePolicyV2', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'HBR', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'CreateHanaInstance', 'description' => '', 'operationType' => 'create', 'ramAction' => [ 'action' => 'hbr:CreateHanaInstance', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'HBR', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'DescribeTask', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'hbr:DescribeTask', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'HBR', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'CreateBackupJob', 'description' => '', 'operationType' => 'create', 'ramAction' => [ 'action' => 'hbr:CreateBackupJob', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'HBR', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'DisableBackupPlan', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'hbr:DisableBackupPlan', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'HBR', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'UpdatePolicyV2', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'hbr:UpdatePolicyV2', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'HBR', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'UninstallClient', 'description' => '', 'operationType' => 'delete', 'ramAction' => [ 'action' => 'hbr:UninstallClient', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'HBR', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'DescribeHanaBackupsAsync', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'hbr:DescribeHanaBackupsAsync', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'HBR', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'StopHanaDatabaseAsync', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'hbr:StopHanaDatabaseAsync', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'HBR', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'DescribeRestoreJobs2', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'hbr:DescribeRestoreJobs2', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'HBR', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'DeleteVaultReplication', 'description' => '', 'operationType' => 'delete', 'ramAction' => [ 'action' => 'hbr:DeleteVaultReplication', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'HBR', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'DeleteSnapshot', 'description' => '', 'operationType' => 'delete', 'ramAction' => [ 'action' => 'hbr:DeleteSnapshot', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'HBR', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'InstallBackupClients', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'hbr:InstallBackupClients', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'HBR', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'UpdateHanaBackupPlan', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'hbr:UpdateHanaBackupPlan', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'HBR', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'CreateRestoreJob', 'description' => '', 'operationType' => 'create', 'ramAction' => [ 'action' => 'hbr:CreateRestoreJob', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'HBR', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'DeleteUdmDisk', 'description' => '', 'operationType' => 'delete', 'ramAction' => [ 'action' => 'hbr:DeleteUdmDisk', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'HBR', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'CancelBackupJob', 'description' => '', 'operationType' => 'delete', 'ramAction' => [ 'action' => 'hbr:CancelBackupJob', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'HBR', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'CheckRole', 'description' => '', 'operationType' => 'none', 'ramAction' => [ 'action' => 'hbr:CheckRole', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'HBR', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'UpdateVault', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'hbr:UpdateVault', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'HBR', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'DeleteUdmEcsInstance', 'description' => '', 'operationType' => 'delete', 'ramAction' => [ 'action' => 'hbr:DeleteUdmEcsInstance', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'HBR', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'CreateBackupPlan', 'description' => '', 'operationType' => 'create', 'ramAction' => [ 'action' => 'hbr:CreateBackupPlan', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'HBR', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'DescribeDataSources', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'hbr:DescribeDataSources', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'HBR', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'DeleteBackupClientResource', 'description' => '', 'operationType' => 'delete', 'ramAction' => [ 'action' => 'hbr:DeleteBackupClientResource', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'HBR', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'CreateHanaBackupPlan', 'description' => '', 'operationType' => 'create', 'ramAction' => [ 'action' => 'hbr:CreateHanaBackupPlan', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'HBR', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'ListProtectedResources', 'description' => '', 'operationType' => 'list', 'ramAction' => [ 'action' => 'hbr:ListProtectedResources', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'HBR', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'UpdatePolicyBinding', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'hbr:UpdatePolicyBinding', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'HBR', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'DescribeVaults', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'hbr:DescribeVaults', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'HBR', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'UpgradeBackupClients', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'hbr:UpgradeBackupClients', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'HBR', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'CreatePolicyBindings', 'description' => '', 'operationType' => 'create', 'ramAction' => [ 'action' => 'hbr:CreatePolicyBindings', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'HBR', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'UpdateHanaInstance', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'hbr:UpdateHanaInstance', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'HBR', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'RemoveDataSource', 'description' => '', 'operationType' => 'delete', 'ramAction' => [ 'action' => 'hbr:RemoveDataSource', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'HBR', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'DeletePolicyBinding', 'description' => '', 'operationType' => 'delete', 'ramAction' => [ 'action' => 'hbr:DeletePolicyBinding', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'HBR', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'UpdateClientSettings', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'hbr:UpdateClientSettings', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'HBR', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'DeleteVault', 'description' => '', 'operationType' => 'delete', 'ramAction' => [ 'action' => 'hbr:DeleteVault', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'HBR', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'DescribeHanaRestores', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'hbr:DescribeHanaRestores', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'HBR', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'DisableHanaBackupPlan', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'hbr:DisableHanaBackupPlan', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'HBR', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'UpdateBackupPlan', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'hbr:UpdateBackupPlan', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'HBR', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'resourceTypes' => [], ], ];