# Alibaba Cloud Cloud Backup API > Alibaba Cloud Cloud Backup API on Apizie: 97 endpoints (Registers a container cluster, Adds a cross-account management relationship, Creates a data source, Browses the list of backup files, …) returned as clean JSON through one API key. Send your own provider key in the x-upstream-key header. Call it over REST at https://zieapi.vercel.app/v1/cloud:aliyun-hbr/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month. - Project key: `cloud:aliyun-hbr` - Category: Cloud - Status: byok - Source: https://api.alibabacloud.com/product/hbr - Page: https://zieapi.vercel.app/api/cloud/aliyun-hbr - OpenAPI: https://zieapi.vercel.app/api/cloud/aliyun-hbr/openapi.json Alibaba Cloud OpenAPI for Cloud Backup (hbr, version 2017-09-08). Calls are signed with ACS3-HMAC-SHA256 using your AccessKey ID and secret. ## Endpoints ### Registers a container cluster `POST https://zieapi.vercel.app/v1/cloud:aliyun-hbr/add-container-cluster` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://hbr.ap-southeast-1.aliyuncs.com | | Identifier | string | yes | The cluster ID | | Name | string | no | The cluster name | | Description | string | no | The description | | ClusterType | string | yes | The cluster type. Only ACK is supported, which indicates Alibaba Cloud Container Service for Kubernetes | | NetworkType | string | yes | The network type. Valid values: CLASSIC: classic network VPC: VPC | ### Adds a cross-account management relationship `POST https://zieapi.vercel.app/v1/cloud:aliyun-hbr/add-cross-account` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://hbr.ap-southeast-1.aliyuncs.com | | CrossAccountUserId | integer | no | The UID of the account to be backed up | | CrossAccountRoleName | string | no | Specifies the name of the RAM role for the account to be backed up when you configure cross-account backup based on RAM role assumption | | CrossAccountType | string | no | The cross-account backup type. Valid values: CROSS_ACCOUNT: Cross-account backup based on RAM role assumption. CROSS_ACCOUNT_BY_RD:… | | Alias | string | no | The alias. The alias can be up to 32 characters in length. This parameter is not required when you configure cross-account backup based on… | ### Creates a data source `POST https://zieapi.vercel.app/v1/cloud:aliyun-hbr/add-data-source` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://hbr.ap-southeast-1.aliyuncs.com | | DataSourceType | string | yes | The data source type | | DataSourceName | string | yes | The name of the data source | | Credential | string | no | The access credential for the data source. Specify this parameter as needed for on-premises NAS data sources that use the SMB protocol,… | | ConnectionInfo | string | no | The connection information of the data source, which describes how to access the data source. Examples: On-premises NAS data source: {… | | IndexLevel | string | no | The index level. This parameter is used only for data source analysis in the archiving feature. Do not use this parameter in other… | | ClusterId | string | no | The ID of the client group used to access the data source | | Schedule | string | no | The execution cycle. This parameter is used only for data source analysis in the archiving feature. Do not use this parameter in other… | | SpeedLimit | string | no | The throttling limit. This parameter is used only for data source analysis in the archiving feature. Do not use this parameter in other… | | Options | string | no | The data source analysis options. This parameter is used only for data source analysis in the archiving feature. Do not use this parameter… | | Include | string | no | The filter that specifies the files to include. This parameter is used only for data source analysis in the archiving feature. Do not use… | | Exclude | string | no | The filter that specifies the files to exclude. This parameter is used only for data source analysis in the archiving feature. Do not use… | | Path | string | no | The list of paths for data source analysis. This parameter is used only for data source analysis in the archiving feature. Do not use this… | ### Browses the list of backup files `POST https://zieapi.vercel.app/v1/cloud:aliyun-hbr/browse-files` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://hbr.ap-southeast-1.aliyuncs.com | | Token | string | no | [Deprecated] Do not specify this parameter | | VaultId | string | no | The ID of the backup vault | | ClientId | string | no | The ID of the backup client | | SnapshotHash | string | no | The hash value of the backup point | | Path | string | no | The hash value of the directory. If you do not specify this parameter, the root directory of the backup is browsed | | AbsolutePath | string | no | The path of the directory. Use a forward slash (/) to browse the root directory of the backup | | PageNumber | integer | no | [Deprecated] Use the MaxResults and NextToken parameters for pagination | | PageSize | integer | no | [Deprecated] Use the MaxResults and NextToken parameters for pagination | | RestoreId | string | no | [Deprecated] | | NextToken | string | no | The token required to retrieve the next page of results | | MaxResults | integer | no | The number of entries returned per query. Valid values: 10 to 100. Default value: 10 | | StorageClass | string | no | The storage class of the backup data. Valid values: STANDARD: Standard. ARCHIVE: Archive | | Edition | string | no | The edition of Cloud Backup. Valid values: STANDARD: Standard Edition. This is the default value. BASIC: Basic Edition. Only ECS File… | ### Cancels a backup job `POST https://zieapi.vercel.app/v1/cloud:aliyun-hbr/cancel-backup-job` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://hbr.ap-southeast-1.aliyuncs.com | | JobId | string | yes | The ID of the backup job | | VaultId | string | no | The ID of the backup vault | | Edition | string | no | The edition type. Valid values: BASIC and STANDARD. Default value: STANDARD | ### Cancels a restore job `POST https://zieapi.vercel.app/v1/cloud:aliyun-hbr/cancel-restore-job` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://hbr.ap-southeast-1.aliyuncs.com | | RestoreId | string | yes | The ID of the restore job | | VaultId | string | no | The ID of the backup vault | | Edition | string | no | The edition type. Valid values: BASIC and STANDARD. Default value: STANDARD | ### Modifies the resource group of an instance `POST https://zieapi.vercel.app/v1/cloud:aliyun-hbr/change-resource-group` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://hbr.ap-southeast-1.aliyuncs.com | | ResourceType | string | yes | The resource type. Valid values: vault: backup vault client: backup client hanainstance: SAP HANA instance | | ResourceId | string | yes | The ID of the resource. For example, if ResourceType is set to vault, ResourceId specifies the ID of the backup vault | | NewResourceGroupId | string | yes | The ID of the new resource group. You can view available resource groups in the Resource Group console | ### Checks whether the current user has permissions to access a specific resource or page `POST https://zieapi.vercel.app/v1/cloud:aliyun-hbr/check-role` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://hbr.ap-southeast-1.aliyuncs.com | | CheckRoleType | string | no | The role type. Valid values: EcsRole: access permissions for ECS resources CsgRole: permissions to back up Cloud Storage Gateway resources… | | CrossAccountUserId | integer | no | The ID of the source account for cross-account backup managed by the current account | | CrossAccountRoleName | string | no | The name of the RAM role created in the source account for cross-account backup managed by the current account | ### Creates a manual backup job `POST https://zieapi.vercel.app/v1/cloud:aliyun-hbr/create-backup-job` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://hbr.ap-southeast-1.aliyuncs.com | | JobName | string | no | The name of the backup job | | SourceType | string | yes | The type of the data source. Valid values: UDM_ECS: ECS instance backup | | Retention | integer | no | The retention period of the backup, in days | | InstanceId | string | no | This parameter is required when SourceType is set to UDM_ECS. The ECS instance ID | | Detail | string | no | The detail configurations. This parameter is required when SourceType is set to UDM_ECS. The value is a JSON character string. doCopy:… | | BackupType | string | no | The backup type. This parameter is required when SourceType is set to UDM_ECS. Valid values: COMPLETE: full backup | | VaultId | string | no | The ID of the backup vault. This parameter is not required when SourceType is set to UDM_ECS | | SpeedLimit | string | no | The backup traffic throttling. This parameter does not take effect when SourceType is set to UDM_ECS. The format is… | | Options | string | no | This parameter is not required | | Include | string | no | The paths to back up. All files in the specified paths are backed up. This parameter does not take effect when SourceType is set to… | | Exclude | string | no | The paths to exclude from the backup. All files in the specified paths are not backed up. This parameter does not take effect when… | | ClusterId | string | no | This parameter is not required | | ContainerResources | string | no | This parameter is not required | | InitiatedByAck | string | no | Set this parameter to false or leave it empty | | ContainerClusterId | string | no | This parameter is not required | | CrossAccountType | string | no | The cross-account backup type. Valid values: SELF_ACCOUNT: current account backup CROSS_ACCOUNT: cross-account backup | | CrossAccountUserId | integer | no | The ID of the source account for the cross-account backup managed by the current account | | CrossAccountRoleName | string | no | The name of the RAM role created in the source account for the cross-account backup managed by the current account | ### Creates a backup plan `POST https://zieapi.vercel.app/v1/cloud:aliyun-hbr/create-backup-plan` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://hbr.ap-southeast-1.aliyuncs.com | | SourceType | string | yes | The type of the data source. Valid values: ECS_FILE: backs up ECS files. OSS: backs up Alibaba Cloud OSS. NAS: backs up Alibaba Cloud NAS.… | | PlanName | string | no | The name of the backup plan. The name must be 1 to 64 characters in length. The backup plan name must be unique for each data source type… | | BackupType | string | no | The backup type. Set the value to COMPLETE, which indicates full backup | | VaultId | string | no | The vault ID | | Schedule | string | no | The backup policy. Format: `I/{startTime}/{interval}`. This indicates that a backup job is executed at every `{interval}` starting from… | | Retention | integer | no | The retention period of the backup data. Minimum value: 1. Unit: days | | ClusterId | string | no | The ID of the client group that executes the data synchronization plan. This parameter is required only for data synchronization | | FileSystemId | string | no | This parameter is required only when SourceType is set to NAS. The file system ID | | CreateTime | integer | no | This parameter is required only when SourceType is set to NAS. The time when the file system was created. The value is a UNIX timestamp.… | | Bucket | string | no | This parameter is required only when SourceType is set to OSS. The name of the OSS bucket | | Prefix | string | no | This parameter is required only when SourceType is set to OSS. The backup prefix. If specified, only objects that match the prefix are… | | InstanceId | string | no | This parameter is required only when SourceType is set to ECS_FILE. The ECS instance ID | | Detail | string | no | The details of the full-copy backup. The value is a JSON string. snapshotGroup: specifies whether to use a consistent snapshot group. This… | | UdmRegionId | string | no | The region where the ECS instance for full-copy backup resides | | SpeedLimit | string | no | This parameter is required only when SourceType is set to ECS_FILE. The backup traffic control. Format: `{start}:{end}:{bandwidth}`.… | | Include | string | no | This parameter is required only when SourceType is set to ECS_FILE. The path to include in the backup. All files in this path are backed… | | Exclude | string | no | This parameter is required only when SourceType is set to ECS_FILE. The path to exclude from the backup. All files in this path are not… | | Options | string | no | This parameter is required only when SourceType is set to ECS_FILE. Specifies whether to use Windows Volume Shadow Copy Service (VSS) to… | | DataSourceId | string | no | The ID of the source data source. This parameter is required only for data synchronization | | Path | string | no | The source paths (JSON-encoded) | | Rule | string | no | The backup plan rules (JSON-encoded) | | InstanceName | string | no | The name of the Tablestore instance | | OtsDetail | string | no | The details of the Tablestore instance (JSON-encoded) | | CrossAccountType | string | no | The cross-account backup type. Valid values: SELF_ACCOUNT: backup within the same account. CROSS_ACCOUNT: cross-account backup | | CrossAccountUserId | integer | no | The ID of the source account for cross-account backup | | CrossAccountRoleName | string | no | The name of the RAM role created in the source account for cross-account backup | | KeepLatestSnapshots | integer | no | Specifies whether to retain at least one backup version. Valid values: 0: does not retain. 1: retains | | DestSourceType | string | no | The type of the destination data source. This parameter is required only for data synchronization | | DestDataSourceId | string | no | The ID of the destination data source. This parameter is required only for data synchronization | | DestDataSourceDetail | string | no | The details of the destination data source. This parameter is required only for data synchronization (JSON-encoded) | | ChangeListPath | string | no | The configuration of the incremental file synchronization list. This parameter is required only for data synchronization | | Disabled | string | no | Specifies whether the plan is disabled by default | | Edition | string | no | The edition type. Valid values: BASIC and STANDARD. Default value: STANDARD | ### Installs one or more Cloud Backup clients on a specified instance `POST https://zieapi.vercel.app/v1/cloud:aliyun-hbr/create-clients` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://hbr.ap-southeast-1.aliyuncs.com | | VaultId | string | yes | The ID of the backup vault | | AlertSetting | string | no | The alert settings. A value of INHERITED specifies that the alerting method of the backup vault is used | | ClientInfo | string | no | The client installation information | | UseHttps | string | no | Specifies whether to use HTTPS for data transmission. Valid values: true: Uses HTTPS. false: Uses HTTP | | ResourceGroupId | string | no | The ID of the resource group | | CrossAccountType | string | no | The cross-account backup type. Valid values: SELF_ACCOUNT: current account backup CROSS_ACCOUNT: cross-account backup | | CrossAccountUserId | integer | no | The ID of the source account for cross-account backups managed by the current account | | CrossAccountRoleName | string | no | The name of the RAM role created in the source account for cross-account backups managed by the current account | ### Creates an SAP HANA backup plan `POST https://zieapi.vercel.app/v1/cloud:aliyun-hbr/create-hana-backup-plan` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://hbr.ap-southeast-1.aliyuncs.com | | VaultId | string | yes | The ID of the backup vault | | ClusterId | string | yes | The SAP HANA instance ID | | PlanName | string | yes | The name of the backup plan | | Schedule | string | yes | The backup policy. Valid format: `I/{startTime}/{interval}`. This format specifies that a backup job is executed at an interval of… | | BackupType | string | yes | The backup type. Valid values: COMPLETE: full backup. INCREMENTAL: incremental backup. DIFFERENTIAL: differential backup | | DatabaseName | string | yes | The name of the database | | BackupPrefix | string | no | The backup prefix | | ResourceGroupId | string | no | The ID of the resource group | ### Registers an SAP HANA instance `POST https://zieapi.vercel.app/v1/cloud:aliyun-hbr/create-hana-instance` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://hbr.ap-southeast-1.aliyuncs.com | | VaultId | string | yes | The ID of the backup vault | | HanaName | string | no | The name of the SAP HANA instance | | Host | string | no | The private or internal IP address of the SAP HANA primary node | | InstanceNumber | integer | no | The instance number specified when SAP HANA is installed | | UserName | string | no | The username of the SYSTEMDB database | | Password | string | no | The password used to connect to the SAP HANA instance | | UseSsl | string | no | Specifies whether to enable SSL connections to securely connect to the database | | ValidateCertificate | string | no | Specifies whether to validate the SSL certificate of the database server | | AlertSetting | string | no | The alert settings. A value of INHERITED indicates that the alerting method is the same as that of the backup vault | | EcsInstanceId | string | no | The instance IDs of all nodes of the HANA system to be registered. Cloud Backup installs backup clients on these nodes | | Sid | string | no | The system ID (SID) of the SAP HANA database. For more information, see How to find SID… | | ResourceGroupId | string | no | The ID of the resource group | | CrossAccountType | string | no | The cross-account backup type. Valid values: SELF_ACCOUNT: Backs up data within the current account. CROSS_ACCOUNT: Backs up data across… | | CrossAccountUserId | integer | no | The ID of the source account for cross-account backup managed by the current account | | CrossAccountRoleName | string | no | The name of the RAM role created in the source account for cross-account backup managed by the current account | ### Creates a restore job for an SAP HANA database `POST https://zieapi.vercel.app/v1/cloud:aliyun-hbr/create-hana-restore` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://hbr.ap-southeast-1.aliyuncs.com | | VaultId | string | no | The ID of the backup vault | | ClusterId | string | yes | The instance ID of the SAP HANA instance to be recovered | | DatabaseName | string | yes | The name of the database to be restored | | BackupId | integer | no | The ID of the backup | | Mode | string | yes | The restore mode. Valid values: RECOVERY_TO_MOST_RECENT: Most recent time. Restores the database to the most recent available state based… | | RecoveryPointInTime | integer | no | The point in time to which you want to restore the database. This parameter is valid only when the Mode parameter is set to… | | LogPosition | integer | no | The log position. This parameter is valid only when the Mode parameter is set to RECOVERY_TO_LOG_POSITION | | VolumeId | integer | no | The ID of the volume to be restored. This parameter is valid only when the Mode parameter is set to RECOVERY_TO_LOG_POSITION | | UseCatalog | string | no | Specifies whether to search for backups from the catalog. This parameter is valid only when the Mode parameter is set to… | | BackupPrefix | string | yes | The backup prefix | | SystemCopy | string | no | Specifies whether to perform a cross-instance restore | | Source | string | no | The name of the source system. This parameter specifies the name of the source database to be restored, in the format of `source database… | | SourceClusterId | string | no | The instance ID of the source SAP HANA instance | | ClearLog | string | no | Specifies whether to initialize the log area. If you do not want to restore the log segments that reside in the log area, set this… | | CheckAccess | string | no | Specifies whether to check the availability of differential and log backups. If you enable this option, the system checks whether the… | | UseDelta | string | no | Specifies whether to use differential backups. Select this option if you want to perform a restore by using differential or incremental… | | SidAdmin | string | no | The SidAdmin account, which is a system account created by SAP HANA | | MasterClientId | string | no | The client ID of the HANA master node | ### Binds one or more data sources to a policy `POST https://zieapi.vercel.app/v1/cloud:aliyun-hbr/create-policy-bindings` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://hbr.ap-southeast-1.aliyuncs.com | | PolicyId | string | no | The policy ID | | PolicyBindingList | string | no | The policy binding list (JSON-encoded) | ### Creates a policy `POST https://zieapi.vercel.app/v1/cloud:aliyun-hbr/create-policy-v2` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://hbr.ap-southeast-1.aliyuncs.com | | PolicyName | string | no | The policy name | | PolicyType | string | no | The policy type. Valid values: STANDARD: general backup policy. Supports backing up data sources other than ECS instances. UDM_ECS_ONLY:… | | PolicyDescription | string | no | The policy description | | Rules | string | no | The list of policy rules (JSON-encoded) | ### [Deprecated] Creates a replication target vault and configures cross-region replication. This API operation… `POST https://zieapi.vercel.app/v1/cloud:aliyun-hbr/create-replication-vault` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://hbr.ap-southeast-1.aliyuncs.com | | VaultRegionId | string | yes | The region ID of the backup vault | | VaultName | string | yes | The name of the backup vault. The name must be 1 to 64 characters in length | | Description | string | no | The description of the backup vault. The description must be 0 to 255 characters in length | | VaultStorageClass | string | no | The storage class of the backup vault. The value can only be STANDARD, which indicates standard storage | | ReplicationSourceVaultId | string | yes | The ID of the source vault | | ReplicationSourceRegionId | string | yes | The region ID of the source vault | | RedundancyType | string | no | The data redundancy storage method of the backup vault. Valid values: LRS: locally redundant storage (LRS). The data redundancy storage… | | EncryptType | string | no | The encryption type of the replication target vault. This parameter is valid only when VaultType is set to STANDARD. The encryption type… | | KmsKeyId | string | no | The custom key or alias from Alibaba Cloud KMS. This parameter is required only when EncryptType is set to KMS | ### Creates a restore job `POST https://zieapi.vercel.app/v1/cloud:aliyun-hbr/create-restore-job` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://hbr.ap-southeast-1.aliyuncs.com | | RestoreType | string | yes | The data source type of the restore destination. Valid values: ECS_FILE: restores to an ECS file. OSS: restores to Alibaba Cloud OSS. NAS:… | | VaultId | string | no | The ID of the backup vault to which the backup snapshot belongs | | SnapshotId | string | no | The ID of the backup snapshot | | SnapshotHash | string | no | The hash value of the backup snapshot | | SourceType | string | yes | The data source type. Valid values: ECS_FILE: restores ECS files. OSS: restores Alibaba Cloud OSS. NAS: restores Alibaba Cloud NAS.… | | Options | string | no | The restore job parameters | | TargetFileSystemId | string | no | This parameter is valid only when RestoreType is set to NAS. The file system ID of the restore destination | | TargetCreateTime | integer | no | This parameter is valid only when RestoreType is set to NAS. The creation time of the destination file system. This value is a UNIX… | | TargetPath | string | no | This parameter is valid only when RestoreType is set to ECS_FILE. The file path of the restore destination | | TargetBucket | string | no | This parameter is valid only when RestoreType is set to OSS. The name of the destination OSS bucket | | TargetPrefix | string | no | This parameter is valid only when RestoreType is set to OSS. The object prefix of the restore destination | | UdmDetail | string | no | This parameter is valid only when SourceType is set to UDM_ECS. The details of the full-copy migration backup. This parameter is a JSON… | | UdmRegionId | string | no | This parameter is valid only when SourceType is set to UDM_ECS. The destination region for restoration | | TargetInstanceId | string | no | This parameter is valid only when RestoreType is set to ECS_FILE. The ECS instance ID of the restore destination | | Include | string | no | The path to restore. All files under this path are restored. Maximum length: 255 characters | | Exclude | string | no | The path to exclude from restoration. All files under this path are not restored. Maximum length: 255 characters | | TargetContainer | string | no | The details of the target container for restoration | | InitiatedByAck | string | no | Specifies whether the operation is invoked by Container Service. Default value: false | | TargetContainerClusterId | string | no | The ID of the target container cluster for restoration | | TargetInstanceName | string | no | The name of the target Tablestore instance for restoration | | TargetTableName | string | no | The name of the target data table in Tablestore for restoration | | TargetTime | integer | no | The point in time to which the Tablestore data is restored. This value is a UNIX timestamp. Unit: seconds | | OtsDetail | string | no | The details of the Tablestore instance (JSON-encoded) | | CrossAccountType | string | no | The cross-account backup type. Valid values: SELF_ACCOUNT: backup within the current account. CROSS_ACCOUNT: cross-account backup | | CrossAccountUserId | integer | no | The ID of the source account for cross-account backup managed by the current account | | CrossAccountRoleName | string | no | The name of the RAM role created in the source account for cross-account backup managed by the current account | | FailbackDetail | string | no | The details of the restoration to the local host (JSON-encoded) | | Edition | string | no | The Cloud Backup feature edition. Valid values: STANDARD: Standard Edition. This is the default value. BASIC: Essential Edition.… | ### Generates the parameters and signature required for a file upload URL `POST https://zieapi.vercel.app/v1/cloud:aliyun-hbr/create-temp-file-upload-url` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://hbr.ap-southeast-1.aliyuncs.com | | FileName | string | yes | The name of the file to be uploaded | ### Creates a backup vault `POST https://zieapi.vercel.app/v1/cloud:aliyun-hbr/create-vault` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://hbr.ap-southeast-1.aliyuncs.com | | VaultRegionId | string | yes | The ID of the region where the backup vault resides | | VaultName | string | yes | The name of the backup vault. The name must be 1 to 64 characters in length | | Description | string | no | The description of the backup vault. The description must be 0 to 255 characters in length | | VaultType | string | no | The type of the backup vault. Valid values: STANDARD: general backup vault. OTS_BACKUP: OTS backup vault | | VaultStorageClass | string | no | The storage class of the backup vault. Valid values: STANDARD: standard storage. ARCHIVE: deprecated. COLD_ARCHIVE: deprecated. IA:… | | WormEnabled | string | no | Specifies whether to enable backup lock | | EncryptType | string | no | The source encryption type. This parameter is valid only when VaultType is set to STANDARD or OTS_BACKUP. Valid values: HBR_PRIVATE: fully… | | KmsKeyId | string | no | The ID or alias of the custom key in Alibaba Cloud KMS. This parameter is required only when EncryptType is set to KMS | | Replication | string | no | Specifies whether to create a replication target vault | ### Configures backup vault replication `POST https://zieapi.vercel.app/v1/cloud:aliyun-hbr/create-vault-replication` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://hbr.ap-southeast-1.aliyuncs.com | | ReplicationSourceVaultId | string | yes | The ID of the replication source vault | | ReplicationTargetVaultId | string | yes | The ID of the replication target vault | | ReplicationSourceRegionId | string | no | The region ID of the replication source. If you do not specify this parameter, the default value is the region where the API operation is… | ### Deletes a Cloud Backup client `POST https://zieapi.vercel.app/v1/cloud:aliyun-hbr/delete-backup-client` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://hbr.ap-southeast-1.aliyuncs.com | | ClientId | string | yes | The ID of the Cloud Backup client | ### Deletes the resources associated with a backup client `POST https://zieapi.vercel.app/v1/cloud:aliyun-hbr/delete-backup-client-resource` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://hbr.ap-southeast-1.aliyuncs.com | | ClientIds | string | yes | The list of client IDs. You can specify up to 100 client IDs (JSON-encoded) | ### Deletes a backup plan `POST https://zieapi.vercel.app/v1/cloud:aliyun-hbr/delete-backup-plan` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://hbr.ap-southeast-1.aliyuncs.com | | PlanId | string | yes | The ID of the backup plan | | VaultId | string | no | The ID of the backup vault. This parameter is required when SourceType is not set to UDM_ECS | | SourceType | string | no | The type of the data source. Valid values: ECS_FILE: ECS files. OSS: Alibaba Cloud OSS. NAS: Alibaba Cloud NAS. UDM_ECS: ECS instances.… | | RequireNoRunningJobs | string | no | Specifies whether no running jobs are required | | Edition | string | no | The edition. Valid values: BASIC and STANDARD. Default value: STANDARD | ### Deletes a client `POST https://zieapi.vercel.app/v1/cloud:aliyun-hbr/delete-client` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://hbr.ap-southeast-1.aliyuncs.com | | VaultId | string | no | The ID of the backup repository | | ClientId | string | no | The ID of the client | | ResourceGroupId | string | no | The ID of the resource group | ### Unregisters a container cluster record in Cloud Backup. After you unregister the cluster, you cannot recover… `POST https://zieapi.vercel.app/v1/cloud:aliyun-hbr/delete-container-cluster` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://hbr.ap-southeast-1.aliyuncs.com | | ClusterId | string | yes | The cluster ID | | Force | string | no | Specifies whether to forcibly delete active container backup clients | ### Deletes a cross-account management relationship `POST https://zieapi.vercel.app/v1/cloud:aliyun-hbr/delete-cross-account` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://hbr.ap-southeast-1.aliyuncs.com | | CrossAccountUserId | integer | yes | The UID of the account to back up | | CrossAccountRoleName | string | yes | 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… | | CrossAccountType | string | no | The type of cross-account backup. Valid values: CROSS_ACCOUNT: Cross-account backup is configured by assuming a RAM role.… | ### Deletes an SAP HANA backup plan `POST https://zieapi.vercel.app/v1/cloud:aliyun-hbr/delete-hana-backup-plan` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://hbr.ap-southeast-1.aliyuncs.com | | VaultId | string | yes | The ID of the backup vault | | ClusterId | string | yes | The ID of the SAP HANA instance | | PlanId | string | yes | The ID of the backup plan | | ResourceGroupId | string | no | The ID of the resource group | ### Deletes an SAP HANA instance `POST https://zieapi.vercel.app/v1/cloud:aliyun-hbr/delete-hana-instance` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://hbr.ap-southeast-1.aliyuncs.com | | VaultId | string | yes | The ID of the backup vault | | ClusterId | string | yes | The ID of the SAP HANA instance | | Sid | string | yes | 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… | | ResourceGroupId | string | no | The ID of the resource group | ### Dissociates a data source from a policy. After the dissociation, the policy can no longer protect the data… `POST https://zieapi.vercel.app/v1/cloud:aliyun-hbr/delete-policy-binding` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://hbr.ap-southeast-1.aliyuncs.com | | PolicyId | string | yes | The policy ID | | DataSourceIds | string | no | The list of data source IDs to dissociate from the policy (JSON-encoded) | | SourceType | string | no | The data source type. Valid values: UDM_ECS: ECS instance backup. OSS: OSS backup. NAS: Alibaba Cloud NAS backup. COMMON_NAS: On-premises… | ### Deletes a policy `POST https://zieapi.vercel.app/v1/cloud:aliyun-hbr/delete-policy-v2` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://hbr.ap-southeast-1.aliyuncs.com | | PolicyId | string | no | The policy ID | ### Deletes a backup snapshot `POST https://zieapi.vercel.app/v1/cloud:aliyun-hbr/delete-snapshot` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://hbr.ap-southeast-1.aliyuncs.com | | Token | string | no | The token for the deletion | | VaultId | string | no | The backup vault ID | | ClientId | string | no | The client ID. When deleting a backup snapshot of ECS File Backup Essential Edition, you must specify either this parameter or InstanceId | | SnapshotId | string | yes | The backup snapshot ID | | SourceType | string | no | The backup source type. Valid values: ECS_FILE: backup snapshot of ECS File Backup Essential Edition. OSS: backup snapshot of Alibaba… | | InstanceId | string | no | The ECS instance ID. When deleting a backup snapshot of ECS File Backup Essential Edition, you must specify either this parameter or… | | Force | string | no | Deprecated | ### Cancels a protected disk `POST https://zieapi.vercel.app/v1/cloud:aliyun-hbr/delete-udm-disk` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://hbr.ap-southeast-1.aliyuncs.com | | DiskId | string | no | The disk ID | ### Stops protection for Elastic Compute Service (ECS) instance backup `POST https://zieapi.vercel.app/v1/cloud:aliyun-hbr/delete-udm-ecs-instance` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://hbr.ap-southeast-1.aliyuncs.com | | InstanceId | string | yes | The ID of the ECS instance | ### Deletes a backup vault `POST https://zieapi.vercel.app/v1/cloud:aliyun-hbr/delete-vault` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://hbr.ap-southeast-1.aliyuncs.com | | Token | string | no | The token | | VaultId | string | no | The ID of the backup vault | | ResourceGroupId | string | no | The ID of the resource group | ### Stops backup vault replication `POST https://zieapi.vercel.app/v1/cloud:aliyun-hbr/delete-vault-replication` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://hbr.ap-southeast-1.aliyuncs.com | | ReplicationSourceVaultId | string | yes | The ID of the source backup vault | | ReplicationTargetVaultId | string | yes | The ID of the destination backup vault | | ReplicationSourceRegionId | string | no | The ID of the source region. If you leave this parameter empty, the region where you call the API is used | ### Retrieves information about one or more backup clients that meet the specified conditions `POST https://zieapi.vercel.app/v1/cloud:aliyun-hbr/describe-backup-clients` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://hbr.ap-southeast-1.aliyuncs.com | | PageNumber | integer | no | The page number. Pages start from 1. Default value: 1 | | PageSize | integer | no | The number of entries per page. Minimum value: 1. Maximum value: 99. Default value: 10 | | ClientType | string | yes | The type of the backup client. Valid values: ECS_CLIENT: ECS File Backup client. CONTAINER_CLIENT: container backup client. LOCAL_CLIENT:… | | ClusterId | string | no | The ID of the backup cluster | | ClientIds | string | no | The list of backup client IDs (JSON-encoded) | | InstanceIds | string | no | The list of ECS instance IDs (JSON-encoded) | | Tag | string | no | The tag information to return (JSON-encoded) | | CrossAccountType | string | no | The type of cross-account backup. Valid values: SELF_ACCOUNT: backup within the current account. CROSS_ACCOUNT: cross-account backup | | CrossAccountUserId | integer | no | The ID of the source account used for cross-account backup | | CrossAccountRoleName | string | no | The name of the RAM role created in the source account for cross-account backup | | Filters | string | no | The query filters (JSON-encoded) | ### Queries one or more backup jobs that meet the specified conditions `POST https://zieapi.vercel.app/v1/cloud:aliyun-hbr/describe-backup-jobs2` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://hbr.ap-southeast-1.aliyuncs.com | | PageNumber | integer | no | The page number. Pages start from 1. Default value: 1 | | PageSize | integer | no | The number of entries per page. Valid values: 1 to 99. Default value: 10 | | SourceType | string | no | The data source type. Valid values: ECS_FILE: ECS files OSS: Alibaba Cloud OSS NAS: Alibaba Cloud NAS OTS: Alibaba Cloud Tablestore… | | SortDirection | string | no | The sort order. Valid values: ASCEND: ascending order DESCEND (default): descending order | | Filters | string | no | The key-value pairs in the query filter (JSON-encoded) | | Edition | string | no | The edition. Valid values: BASIC and STANDARD. Default value: STANDARD | ### Retrieves one or more backup plans that meet the specified conditions `POST https://zieapi.vercel.app/v1/cloud:aliyun-hbr/describe-backup-plans` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://hbr.ap-southeast-1.aliyuncs.com | | PageNumber | integer | no | The page number. Pages start from 1. Default value: 1 | | PageSize | integer | no | The number of entries per page. Minimum value: 1. Maximum value: 99. Default value: 10 | | SourceType | string | no | The type of the data source. Valid values: | | Filters | string | no | The query filters (JSON-encoded) | | Edition | string | no | The edition type. Valid values: BASIC and STANDARD. Default value: STANDARD | ### Queries one or more Cloud Backup clients that meet the specified conditions `POST https://zieapi.vercel.app/v1/cloud:aliyun-hbr/describe-clients` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://hbr.ap-southeast-1.aliyuncs.com | | VaultId | string | no | The ID of the backup vault | | ClientId | string | no | The ID of the Cloud Backup client | | PageNumber | integer | no | The page number. Pages start from page 1. Default value: 1 | | PageSize | integer | no | The number of entries per page. Valid values: 1 to 99. Default value: 10 | | ClientType | string | no | The type of the Cloud Backup client. Valid value: ECS_AGENT, which indicates an SAP HANA backup client | | SourceType | string | no | The type of the data source. Valid value:HANA, which indicates SAP HANA backup | | ClusterId | string | no | The ID of the SAP HANA instance | | ResourceGroupId | string | no | The ID of the resource group | ### Queries one or more container clusters that meet the specified conditions `POST https://zieapi.vercel.app/v1/cloud:aliyun-hbr/describe-container-cluster` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://hbr.ap-southeast-1.aliyuncs.com | | PageNumber | integer | no | The number of the page to return. Pages start from page 1. Default value: 1 | | PageSize | integer | no | The number of entries to return on each page. Valid values: 1 to 99. Default value: 10 | | ClusterId | string | no | The cluster ID | | Identifier | string | no | The identifier of the container cluster. For a Container Service for Kubernetes (ACK) cluster, specify the cluster ID | ### Queries the list of container cluster resources `POST https://zieapi.vercel.app/v1/cloud:aliyun-hbr/describe-container-resource` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://hbr.ap-southeast-1.aliyuncs.com | | PageNumber | integer | no | The page number for paged queries. Pages start from 1. Default value: 1 | | PageSize | integer | no | The number of entries per page. Minimum value: 1. Maximum value: 99. Default value: 10 | | ClusterId | string | no | The cluster ID | | ResourceType | string | no | The resource type. Valid value: PV: persistent volume (PV) | | ResourceId | string | no | The resource ID. ResourceType=PV: The persistent volume ID | ### Queries cross-account management relationships `POST https://zieapi.vercel.app/v1/cloud:aliyun-hbr/describe-cross-accounts` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://hbr.ap-southeast-1.aliyuncs.com | | PageNumber | integer | no | The page number for paging. Pages start from 1. Default value: 1 | | PageSize | integer | no | The number of entries per page. Minimum value: 1. Maximum value: 99. Default value: 10 | ### Queries a list of data sources. Filter results by data source type, data source ID, data source name, or… `POST https://zieapi.vercel.app/v1/cloud:aliyun-hbr/describe-data-sources` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://hbr.ap-southeast-1.aliyuncs.com | | PageNumber | integer | no | The page number. Pages start from page 1. Default value: 1 | | PageSize | integer | no | The number of data sources to return on each page | | DataSourceType | string | no | The data source type | | ClusterId | string | no | The client group ID used to access the data source | | DataSourceId | string | no | The data source ID | | DataSourceName | string | no | The data source name | ### Queries the free trial activation status and expiration time of a specified feature. Currently, only the… `POST https://zieapi.vercel.app/v1/cloud:aliyun-hbr/describe-feature-trial-info` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://hbr.ap-southeast-1.aliyuncs.com | | FeatureType | string | yes | The feature type. Currently, only the free trial information of Tablestore backup can be queried | ### Queries for one or more SAP HANA backup plans that match specified criteria `POST https://zieapi.vercel.app/v1/cloud:aliyun-hbr/describe-hana-backup-plans` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://hbr.ap-southeast-1.aliyuncs.com | | VaultId | string | no | The ID of the backup vault | | ClusterId | string | yes | The ID of the SAP HANA instance | | PageNumber | integer | no | The page number. The value must be a number that starts from 1. Default value: 1 | | PageSize | integer | no | The number of entries per page. Valid values: 1 to 99. Default value: 10 | | DatabaseName | string | no | The name of the database | | ResourceGroupId | string | no | The ID of the resource group | ### Queries the backup parameters of an SAP HANA database `POST https://zieapi.vercel.app/v1/cloud:aliyun-hbr/describe-hana-backup-setting` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://hbr.ap-southeast-1.aliyuncs.com | | VaultId | string | no | The ID of the backup vault | | ClusterId | string | yes | The ID of the SAP HANA instance | | DatabaseName | string | no | The name of the database | ### Queries one or more SAP HANA backups that meet the specified conditions `POST https://zieapi.vercel.app/v1/cloud:aliyun-hbr/describe-hana-backups-async` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://hbr.ap-southeast-1.aliyuncs.com | | VaultId | string | no | The ID of the backup vault | | ClusterId | string | yes | The ID of the SAP HANA instance | | PageNumber | integer | no | The page number. Pages start from page 1. Default value: 1 | | PageSize | integer | no | The number of entries per page. Valid values: 1 to 99. Default value: 10 | | DatabaseName | string | no | The database name | | Mode | string | no | The recovery mode. Valid values: RECOVERY_TO_MOST_RECENT: restores the database to the recently available state to which the database has… | | RecoveryPointInTime | integer | no | The point in time to which you want to restore the database. This parameter is valid only if you set the Mode parameter to… | | LogPosition | integer | no | The log position to which you want to restore the database. This parameter is valid only if you set the Mode parameter to… | | VolumeId | integer | no | 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 | | SystemCopy | string | no | Specifies whether to restore the database to a different instance. true: restores the database to a different instance. false: restores… | | Source | string | no | The name of the source system. This parameter specifies the name of the source database that you want to restore. You must set the… | | SourceClusterId | string | no | The ID of the source SAP HANA instance | | IncludeDifferential | string | no | Specifies whether to include differential backups in the query results. Valid values: true: includes differential backups. false: excludes… | | IncludeIncremental | string | no | Specifies whether to include incremental backups in the query results. Valid values: true: includes incremental backups. false: excludes… | | IncludeLog | string | no | Specifies whether to include log backups in the query results. Valid values: true: includes log backups. false: excludes log backups | | UseBackint | string | no | Specifies whether Backint is used. Valid values: true: Backint is used. false: Backint is not used | | ResourceGroupId | string | no | The ID of the resource group | ### Queries the information about SAP HANA databases `POST https://zieapi.vercel.app/v1/cloud:aliyun-hbr/describe-hana-databases` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://hbr.ap-southeast-1.aliyuncs.com | | VaultId | string | no | The ID of the backup vault | | ClusterId | string | yes | The ID of the SAP HANA instance | | PageNumber | integer | no | The page number. Pages start from page 1. Default value: 1 | | PageSize | integer | no | The number of entries per page. Valid values: 1 to 99. Default value: 10 | | ResourceGroupId | string | no | The ID of the resource group | ### Queries one or more SAP HANA instances that meet the specified conditions `POST https://zieapi.vercel.app/v1/cloud:aliyun-hbr/describe-hana-instances` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://hbr.ap-southeast-1.aliyuncs.com | | VaultId | string | no | The ID of the backup vault | | ClusterId | string | no | The ID of the SAP HANA instance | | PageNumber | integer | no | The page number. Pages start from page 1. Default value: 1 | | PageSize | integer | no | The number of entries per page. Valid values: 1 to 99. Default value: 10 | | Tag | string | no | The tags of the SAP HANA instance (JSON-encoded) | | ResourceGroupId | string | no | The ID of the resource group | ### Queries one or more SAP HANA restore jobs that meet the specified conditions `POST https://zieapi.vercel.app/v1/cloud:aliyun-hbr/describe-hana-restores` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://hbr.ap-southeast-1.aliyuncs.com | | VaultId | string | no | The ID of the backup vault | | ClusterId | string | yes | The ID of the SAP HANA instance | | PageNumber | integer | no | The page number. Pages start from page 1. Default value: 1 | | PageSize | integer | no | The number of entries per page. Valid values: 1 to 99. Default value: 10.` | | RestoreId | string | no | The ID of the restore job | | DatabaseName | string | no | The database name | | BackupId | integer | no | The backup ID | | RestoreStatus | string | no | The status of the restore job. Valid values: RUNNING: The job is running. COMPLETE: The job is completed. PARTIAL_COMPLETE: The job is… | | ResourceGroupId | string | no | The ID of the resource group | ### Queries the backup retention period of an SAP HANA database `POST https://zieapi.vercel.app/v1/cloud:aliyun-hbr/describe-hana-retention-setting` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://hbr.ap-southeast-1.aliyuncs.com | | VaultId | string | yes | The ID of the backup vault | | ClusterId | string | yes | The ID of the SAP HANA instance | | DatabaseName | string | no | The database name | ### Queries the details about Tablestore instances that are backed up `POST https://zieapi.vercel.app/v1/cloud:aliyun-hbr/describe-ots-table-snapshots` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://hbr.ap-southeast-1.aliyuncs.com | | StartTime | integer | no | The start time of the backup. The value must be a UNIX timestamp. Unit: milliseconds | | EndTime | integer | no | The end time of the backup. The value must be a UNIX timestamp. Unit: milliseconds | | SnapshotIds | string | no | The snapshot IDs (JSON-encoded) | | OtsInstances | string | no | The Tablestore instances that are backed up (JSON-encoded) | | Limit | integer | no | The maximum number of rows that you want the current query to return | | NextToken | string | no | The token that is required to obtain the next page of backup snapshots | | CrossAccountType | string | no | Specifies whether data is backed up within the same Alibaba Cloud account or across Alibaba Cloud accounts. Valid values: SELF_ACCOUNT:… | | CrossAccountUserId | integer | no | The UID of the source account used for cross-account backup | | CrossAccountRoleName | string | no | The name of the RAM role that is created within the source Alibaba Cloud account and assigned to the current Alibaba Cloud account to… | ### Queries one or more policies `POST https://zieapi.vercel.app/v1/cloud:aliyun-hbr/describe-policies-v2` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://hbr.ap-southeast-1.aliyuncs.com | | MaxResults | integer | no | The number of results per query. Valid values: 10 to 100. Default value: 10 | | NextToken | string | no | The token required to retrieve the next page of policies | | PolicyId | string | no | The policy ID | | RuleScope | string | no | The RuleScope | | AccountScope | string | no | The AccountScope | | Accounts | string | no | The Accounts (JSON-encoded) | ### Queries one or more data sources bound to a policy, or queries one or more policies bound to a data source `POST https://zieapi.vercel.app/v1/cloud:aliyun-hbr/describe-policy-bindings` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://hbr.ap-southeast-1.aliyuncs.com | | NextToken | string | no | The token required to obtain the next page of policy-data source associations | | MaxResults | integer | no | The number of results for each query. Valid values: 10 to 100. Default value: 10 | | PolicyId | string | no | The policy ID | | DataSourceIds | string | no | The list of data source IDs (JSON-encoded) | | SourceType | string | no | The data source type. Valid values: UDM_ECS: ECS instance backup. OSS: OSS backup. NAS: Alibaba Cloud NAS backup. COMMON_NAS: On-premises… | | Filters | string | no | The query filters (JSON-encoded) | ### Queries the tables of a restorable Tablestore instance `POST https://zieapi.vercel.app/v1/cloud:aliyun-hbr/describe-recoverable-ots-instances` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://hbr.ap-southeast-1.aliyuncs.com | | CrossAccountType | string | no | Specifies whether data is backed up within the same Alibaba Cloud account or across Alibaba Cloud accounts. Valid values: SELF_ACCOUNT:… | | CrossAccountUserId | integer | no | The ID of the source Alibaba Cloud account that authorizes the current Alibaba Cloud account to back up data across Alibaba Cloud accounts | | CrossAccountRoleName | string | no | The name of the Resource Access Management (RAM) role that is created within the source Alibaba Cloud account and assigned to the current… | ### Queries available regions `POST https://zieapi.vercel.app/v1/cloud:aliyun-hbr/describe-regions` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://hbr.ap-southeast-1.aliyuncs.com | ### Queries restore jobs that match specified criteria `POST https://zieapi.vercel.app/v1/cloud:aliyun-hbr/describe-restore-jobs2` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://hbr.ap-southeast-1.aliyuncs.com | | PageNumber | integer | no | The page number. Pages start from 1. Default value: 1 | | PageSize | integer | no | The number of entries per page. Valid values: 1 to 99. Default value: 10 | | RestoreType | string | no | The data source type. Valid values: ECS_FILE: Restores ECS files. OSS: Restores OSS objects. NAS: Restores NAS files. COMMON_FILE_SYSTEM:… | | Filters | string | no | The filter conditions (JSON-encoded) | | Edition | string | no | The edition. Valid values: `BASIC` and `STANDARD`. Default value: `STANDARD` | ### Queries an asynchronous job. `POST https://zieapi.vercel.app/v1/cloud:aliyun-hbr/describe-task` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://hbr.ap-southeast-1.aliyuncs.com | | Token | string | no | The access token | | TaskId | string | no | The ID of the job | | ResourceGroupId | string | no | The ID of the resource group | ### Queries the snapshots of full backups `POST https://zieapi.vercel.app/v1/cloud:aliyun-hbr/describe-udm-snapshots` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://hbr.ap-southeast-1.aliyuncs.com | | SourceType | string | yes | The type of the data source. Valid values: UDM_ECS: ECS instance backup UDM_ECS_DISK: a disk backup subtask of an ECS instance backup… | | StartTime | integer | yes | The beginning of the time range to query. This value is a UNIX timestamp in seconds | | EndTime | integer | yes | The end of the time range to query. This value is a UNIX timestamp in seconds | | UdmRegionId | string | yes | The region ID of the ECS instance | | InstanceId | string | no | The ID of the ECS instance | | DiskId | string | no | The ID of the disk | | JobId | string | no | The ID of the backup job | | SnapshotIds | string | no | The list of snapshot IDs (JSON-encoded) | ### Queries the regions that support cross-region replication. `POST https://zieapi.vercel.app/v1/cloud:aliyun-hbr/describe-vault-replication-regions` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://hbr.ap-southeast-1.aliyuncs.com | | Token | string | no | This parameter is deprecated | | VaultId | string | no | This parameter is deprecated | ### Queries the information of one or more backup vaults that meet the specified conditions `POST https://zieapi.vercel.app/v1/cloud:aliyun-hbr/describe-vaults` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://hbr.ap-southeast-1.aliyuncs.com | | VaultId | string | no | The ID of the backup vault | | VaultRegionId | string | no | The ID of the region to which the backup vault belongs | | Status | string | no | The status of the backup vault. Valid values: UNKNOWN: unknown INITIALIZING: initializing CREATED: created ERROR: error | | PageNumber | integer | no | The page number. Pages start from page 1. Default value: 1 | | PageSize | integer | no | The number of entries per page. Minimum value: 1. Maximum value: 99. Default value: 10 | | VaultType | string | no | The type of the backup vault. Valid values: STANDARD: A standard vault. It can be used for ECS File Backup Standard Edition, OSS backup,… | | Tag | string | no | The tag information. A maximum of 20 tags are supported (JSON-encoded) | | ResourceGroupId | string | no | The ID of the resource group | | VaultName | string | no | The name of the backup vault. The name must be 1 to 64 characters in length | | VaultOwnerId | integer | no | The ID of the account to which the backup vault belongs | | Replication | string | no | Specifies whether to query replication target vaults | ### Deletes an internal mount target created by Cloud Backup `POST https://zieapi.vercel.app/v1/cloud:aliyun-hbr/detach-nas-file-system` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://hbr.ap-southeast-1.aliyuncs.com | | FileSystemId | string | yes | The ID of the file system | | CreateTime | string | yes | The time when the file system was created. The value must be a UNIX timestamp. Unit: seconds | | CrossAccountType | string | no | Specifies whether data is backed up and restored within the same Alibaba Cloud account or across Alibaba Cloud accounts. Valid values:… | | CrossAccountUserId | integer | no | The ID of the source Alibaba Cloud account that authorizes the current Alibaba Cloud account to back up and restore data across Alibaba… | | CrossAccountRoleName | string | no | The name of the RAM role that is created within the source Alibaba Cloud account and assigned to the current Alibaba Cloud account to… | ### Disables a backup plan `POST https://zieapi.vercel.app/v1/cloud:aliyun-hbr/disable-backup-plan` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://hbr.ap-southeast-1.aliyuncs.com | | PlanId | string | yes | The ID of the backup plan | | VaultId | string | no | The ID of the backup vault | | SourceType | string | no | The type of the data source. Valid values: ECS_FILE: Backs up ECS files. OSS: Backs up Alibaba Cloud OSS. NAS: Backs up Alibaba Cloud NAS | | Edition | string | no | The edition. Valid values: BASIC and STANDARD. The default value is STANDARD | ### Disables an SAP HANA backup plan `POST https://zieapi.vercel.app/v1/cloud:aliyun-hbr/disable-hana-backup-plan` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://hbr.ap-southeast-1.aliyuncs.com | | VaultId | string | yes | The ID of the backup vault | | ClusterId | string | yes | The ID of the SAP HANA instance | | PlanId | string | yes | The ID of the backup plan | | ResourceGroupId | string | no | The ID of the resource group | ### Resumes a backup plan `POST https://zieapi.vercel.app/v1/cloud:aliyun-hbr/enable-backup-plan` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://hbr.ap-southeast-1.aliyuncs.com | | PlanId | string | yes | The ID of the backup plan | | VaultId | string | no | The ID of the backup vault | | SourceType | string | no | The type of the data source. Valid values: ECS_FILE: Backs up ECS files. OSS: Backs up Alibaba Cloud OSS. NAS: Backs up Alibaba Cloud NAS | | Edition | string | no | The edition. Valid values are BASIC and STANDARD. The default value is STANDARD | ### Enables an SAP HANA backup plan `POST https://zieapi.vercel.app/v1/cloud:aliyun-hbr/enable-hana-backup-plan` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://hbr.ap-southeast-1.aliyuncs.com | | VaultId | string | yes | The ID of the backup vault | | ClusterId | string | yes | The ID of the SAP HANA instance | | PlanId | string | yes | The ID of the backup plan | | ResourceGroupId | string | no | The ID of the resource group | ### Executes a backup plan `POST https://zieapi.vercel.app/v1/cloud:aliyun-hbr/execute-backup-plan` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://hbr.ap-southeast-1.aliyuncs.com | | PlanId | string | yes | The ID of the backup plan | | VaultId | string | no | The ID of the backup vault | | SourceType | string | no | The type of the data source. Valid values: ECS_FILE: Backs up ECS files. OSS: Backs up Alibaba Cloud OSS. NAS: Backs up Alibaba Cloud NAS | | RuleId | string | no | The ID of the backup rule | | Edition | string | no | The edition. Valid values: BASIC and STANDARD. Default value: STANDARD | ### Execute a policy for one or all bound data sources `POST https://zieapi.vercel.app/v1/cloud:aliyun-hbr/execute-policy-v2` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://hbr.ap-southeast-1.aliyuncs.com | | PolicyId | string | yes | Policy ID | | DataSourceId | string | no | Data source ID | | SourceType | string | no | Data source type, with the value range as follows: UDM_ECS: Represents ECS full machine backup | | RuleId | string | yes | Rule ID, limited to executing rules of RuleType BACKUP | ### Generates a Resource Access Management (RAM) policy `POST https://zieapi.vercel.app/v1/cloud:aliyun-hbr/generate-ram-policy` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://hbr.ap-southeast-1.aliyuncs.com | | RequireBasePolicy | string | no | Specifies whether to generate the policy based on an existing instance-specific rule. Valid values: true false | | ActionType | string | yes | The type of policy that you want to generate. Valid values: BACKUP: the permission to back up data to a backup vault RESTORE: the… | | VaultId | string | yes | The ID of the backup vault | | ResourceGroupId | string | no | The ID of the resource group | ### Retrieves basic statistics for Backup `POST https://zieapi.vercel.app/v1/cloud:aliyun-hbr/get-basic-statistics` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://hbr.ap-southeast-1.aliyuncs.com | | SourceType | string | yes | The data source type. The valid value is: ECS_FILE: ECS File Backup | ### Obtains download links of files such as job reports `POST https://zieapi.vercel.app/v1/cloud:aliyun-hbr/get-temp-file-download-link` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://hbr.ap-southeast-1.aliyuncs.com | | TempFileKey | string | yes | The key that is used to download a file | ### Queries the free trial information of a specified OSS bucket or NAS file system `POST https://zieapi.vercel.app/v1/cloud:aliyun-hbr/get-trial-info` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://hbr.ap-southeast-1.aliyuncs.com | | SourceType | string | yes | The data source type. Only free trial information of OSS backup and NAS backup can be queried | | Bucket | string | no | This parameter is required only when SourceType is set to OSS. The name of the OSS bucket | | FileSystemId | string | no | This parameter is required only when SourceType is set to NAS. The ID of the file system | | CreateTime | integer | no | This parameter is required only when SourceType is set to NAS. The time when the file system was created. UNIX timestamp, in seconds | ### Installs backup clients on one or more ECS instances `POST https://zieapi.vercel.app/v1/cloud:aliyun-hbr/install-backup-clients` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://hbr.ap-southeast-1.aliyuncs.com | | InstanceIds | string | yes | The IDs of the ECS instances. You can specify a maximum of 20 instance IDs (JSON-encoded) | | CrossAccountType | string | no | The type of cross-account backup. Valid values: SELF_ACCOUNT: Backs up data within the current account. CROSS_ACCOUNT: Backs up data… | | CrossAccountUserId | integer | no | The ID of the source account that is used for cross-account backup | | CrossAccountRoleName | string | no | The name of the RAM role that is created in the source account for cross-account backup | ### Queries the list of protected resources `POST https://zieapi.vercel.app/v1/cloud:aliyun-hbr/list-protected-resources` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://hbr.ap-southeast-1.aliyuncs.com | | NextToken | string | no | The pagination token for the next page. If NextToken is empty, no next page exists | | MaxResults | integer | no | The maximum number of results to return per query. Valid values: 10 to 100. Default value: 10 | | CreatedByProduct | string | no | The product capability to which the resource belongs. Valid values: HBR: Cloud Backup standard capabilities. BASIC: ECS File Backup… | | SourceType | string | no | The type of backup feature. Valid values: ECS_FILE: ECS file backup. COMMON_FILE_SYSTEM: CPFS backup. COMMON_NAS: On-premises NAS backup.… | | ResourceId | string | no | The resource ID. The meaning of this parameter varies based on the value of SourceType: SourceType=ECS_FILE: the ECS instance ID.… | | Skip | integer | no | The number of entries to skip for a paged query. If the number of skipped entries exceeds the total number of matched entries, an empty… | | HasSnapshot | string | no | Specifies whether backup points exist | ### Queries backup points `POST https://zieapi.vercel.app/v1/cloud:aliyun-hbr/list-snapshots` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://hbr.ap-southeast-1.aliyuncs.com | | NextToken | string | no | The pagination token. You do not need to specify this parameter for the first query. When you query the next page, set this parameter to… | | MaxResults | integer | no | The maximum number of results to return for a paged query. Default value: 10. The value must be greater than 1 | | Skip | integer | no | The number of entries to skip. The value must be a non-negative integer and a multiple of MaxResults. This parameter cannot be used… | | SourceType | string | yes | The data source type. It must be the same as the data source type of the protected resource specified by ProtectedResourceId. Valid values: | | ProtectedResourceId | string | yes | The ID of the protected resource. The protected resource must exist, and its data source type must be the same as the value of the… | | VaultId | string | no | The ID of the vault. This is an optional filter. If you specify this parameter, only the backup points in the specified vault are returned | | CompleteTimeStart | integer | no | The start completion time. The value is a UNIX timestamp in seconds. Only backup points whose completion time is greater than or equal to… | | CompleteTimeEnd | integer | no | The end completion time. The value is a UNIX timestamp in seconds. Only backup points whose completion time is less than this value are… | | PlanId | string | no | The ID of the backup plan. This is an optional filter. If you specify this parameter, only the backup points under the specified backup… | ### Activates the Cloud Backup service `POST https://zieapi.vercel.app/v1/cloud:aliyun-hbr/open-hbr-service` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://hbr.ap-southeast-1.aliyuncs.com | ### Deletes a data source `POST https://zieapi.vercel.app/v1/cloud:aliyun-hbr/remove-data-source` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://hbr.ap-southeast-1.aliyuncs.com | | DataSourceId | string | yes | The ID of the data source | ### Retrieves one or more historical backup snapshots that meet the specified conditions `POST https://zieapi.vercel.app/v1/cloud:aliyun-hbr/search-historical-snapshots` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://hbr.ap-southeast-1.aliyuncs.com | | SourceType | string | no | The type of the data source. Valid values: ECS_FILE: backup snapshots of ECS files. OSS: backup snapshots of Alibaba Cloud OSS. NAS:… | | Query | string | no | The query conditions. Example of Query: ``` [ { "field": "VaultId", "value": "v-0003rf9m*****qx5", "operation": "MATCH_TERM" }, { "field":… | | Limit | integer | no | The maximum number of results to return for this query. If you only want to obtain the row count without actual data, set `limit=0` to… | | NextToken | string | no | The token required to retrieve the next page of snapshots | | SortBy | string | no | The field used for sorting | | Order | string | no | The sort order. Default value: ASC. ASC: ascending order. DESC: descending order | | Edition | string | no | The edition type. Valid values: BASIC and STANDARD. Default value: STANDARD | ### Starts an SAP HANA database `POST https://zieapi.vercel.app/v1/cloud:aliyun-hbr/start-hana-database-async` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://hbr.ap-southeast-1.aliyuncs.com | | VaultId | string | yes | The ID of the backup vault | | ClusterId | string | yes | The ID of the SAP HANA instance | | DatabaseName | string | yes | The database name | ### Stops an SAP HANA database `POST https://zieapi.vercel.app/v1/cloud:aliyun-hbr/stop-hana-database-async` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://hbr.ap-southeast-1.aliyuncs.com | | VaultId | string | yes | The ID of the backup vault | | ClusterId | string | yes | The SAP HANA instance ID | | DatabaseName | string | yes | The name of the database | ### Uninstalls the backup client from one or more ECS instances `POST https://zieapi.vercel.app/v1/cloud:aliyun-hbr/uninstall-backup-clients` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://hbr.ap-southeast-1.aliyuncs.com | | InstanceIds | string | no | The ECS instance IDs. You can specify up to 20 instance IDs (JSON-encoded) | | ClientIds | string | no | The IDs of the backup clients. The total number of client IDs and ECS instance IDs cannot exceed 20. Otherwise, an error is reported… | | CrossAccountType | string | no | The cross-account backup type. Valid values: SELF_ACCOUNT: backup within the current account CROSS_ACCOUNT: cross-account backup | | CrossAccountUserId | integer | no | The ID of the source account used for the cross-account backup feature | | CrossAccountRoleName | string | no | The name of the role created in Resource Access Management (RAM) of the source account for cross-account backup | ### Uninstalls an HBR backup client `POST https://zieapi.vercel.app/v1/cloud:aliyun-hbr/uninstall-client` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://hbr.ap-southeast-1.aliyuncs.com | | VaultId | string | no | The ID of the backup vault | | ClientId | string | yes | The ID of the backup client | | ResourceGroupId | string | no | The ID of the resource group | ### Updates a backup plan `POST https://zieapi.vercel.app/v1/cloud:aliyun-hbr/update-backup-plan` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://hbr.ap-southeast-1.aliyuncs.com | | PlanId | string | yes | The ID of the backup plan | | PlanName | string | no | The name of the backup plan | | Schedule | string | no | The backup policy. Valid format: `I/{startTime}/{interval}`. This format specifies that a backup job is executed at an interval of… | | Retention | integer | no | The retention period of backups in days. The minimum value is 1 | | Prefix | string | no | The backup prefix. This parameter is required only when SourceType is set to OSS. After this parameter is specified, only objects whose… | | VaultId | string | no | The ID of the backup vault | | Detail | string | no | The details of the ECS instance backup. The value is a JSON string. snapshotGroup: Specifies whether to use a consistent snapshot group.… | | SourceType | string | no | The type of the data source. Valid values: ECS_FILE: ECS files. OSS: Alibaba Cloud OSS. NAS: Alibaba Cloud NAS. OTS: Alibaba Cloud… | | SpeedLimit | string | no | The throttling for backup traffic. This parameter is required only when SourceType is set to ECS_FILE. Throttling helps you control the… | | Include | string | no | The paths to be backed up. All files in the specified paths are backed up. This parameter is required only when SourceType is set to… | | Exclude | string | no | The paths to be excluded from backup. All files in the specified paths are not backed up. This parameter is required only when SourceType… | | Options | string | no | Specifies whether to use Volume Shadow Copy Service (VSS) to define backup paths for Windows. This parameter is required only when… | | UpdatePaths | string | no | Specifies whether to update the source paths when the source paths are empty. Valid values: true: updates the source paths based on the… | | Path | string | no | The backup path (JSON-encoded) | | Rule | string | no | The rules of the backup plan (JSON-encoded) | | OtsDetail | string | no | The details of the Tablestore instance (JSON-encoded) | | KeepLatestSnapshots | integer | no | Specifies whether to retain at least one backup version. Valid values: 0: does not retain. 1: retains | | ChangeListPath | string | no | The configuration of the incremental file synchronization list. This parameter is required only for synchronization | | Edition | string | no | The edition type. Valid values: BASIC and STANDARD. Default value: STANDARD | ### Updates the configuration of a backup client `POST https://zieapi.vercel.app/v1/cloud:aliyun-hbr/update-client-settings` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://hbr.ap-southeast-1.aliyuncs.com | | UseHttps | string | no | Specifies whether to use HTTPS to transmit data plane data. true: Uses HTTPS for transmission. false: Uses HTTP for transmission | | VaultId | string | no | The backup vault ID. This parameter is required for legacy clients | | ClientId | string | yes | The backup client ID | | DataNetworkType | string | no | The data plane access point type. Valid values: PUBLIC: public network VPC: VPC network CLASSIC: classic network | | MaxCpuCore | integer | no | The number of CPU cores used by a single backup job. A value of 0 indicates no limit | | MaxWorker | integer | no | The number of concurrent workers for a single backup job. A value of 0 indicates no limit | | DataProxySetting | string | no | The data plane proxy setting. Valid values: DISABLE: does not use a proxy. USE_CONTROL_PROXY (default): uses the same configuration as the… | | ProxyHost | string | no | The IP address of the custom data plane proxy server host | | ProxyPort | integer | no | The port of the custom data plane proxy server host | | ProxyUser | string | no | The username of the custom data plane proxy server | | ProxyPassword | string | no | The password of the custom data plane proxy server | | ResourceGroupId | string | no | The resource group ID | | MaxMemory | integer | no | The maximum memory that the client can use, in bytes. Only version 2.13.0 and later are supported | | AlertOnPartialComplete | string | no | Specifies whether to trigger an alert for partially completed jobs. This parameter takes effect only for local File Backup and ECS File… | ### Update container cluster information, including the container cluster name, network type, etc `POST https://zieapi.vercel.app/v1/cloud:aliyun-hbr/update-container-cluster` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://hbr.ap-southeast-1.aliyuncs.com | | ClusterId | string | yes | Cluster ID | | Name | string | no | Cluster name | | Description | string | no | Cluster description | | NetworkType | string | no | Network type, with possible values including: CLASSIC: Classic Network. VPC: Virtual Private Cloud | | RenewToken | string | no | Whether to regenerate the token | ### Updates the data source configuration `POST https://zieapi.vercel.app/v1/cloud:aliyun-hbr/update-data-source` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://hbr.ap-southeast-1.aliyuncs.com | | DataSourceId | string | yes | The ID of the data source | | DataSourceName | string | no | The name of the data source | | Credential | string | no | 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… | | ConnectionInfo | string | no | The connection information for the data source. Examples: On-premises NAS data source: { "dataServerAddresses": [ { "host":… | | IndexLevel | string | no | The index level for data source analysis. This parameter applies only to the archive feature. OFF: No index is created. META: A metadata… | | ClusterId | string | no | The ID of the client group used to access the data source | | Schedule | string | no | The schedule for data source analysis. This parameter applies only to the archive feature. The format is `I/{startTime}/{interval}`. This… | | SpeedLimit | string | no | The rate limiting configuration for data source analysis. This parameter applies only to the archive feature | | Options | string | no | The options for data source analysis. This parameter applies only to the archive feature | | Include | string | no | A filter to specify which files to include. This parameter applies only to the archive feature | | Exclude | string | no | A filter to specify which files to exclude. This parameter applies only to the archive feature | | Path | string | no | A list of paths for data source analysis. This parameter applies only to the archive feature (JSON-encoded) | ### Updates an SAP HANA backup plan `POST https://zieapi.vercel.app/v1/cloud:aliyun-hbr/update-hana-backup-plan` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://hbr.ap-southeast-1.aliyuncs.com | | VaultId | string | yes | The ID of the backup vault | | ClusterId | string | yes | The SAP HANA instance ID | | PlanId | string | yes | The ID of the backup plan | | PlanName | string | no | The name of the backup plan | | Schedule | string | no | The backup policy. Valid format: `I/{startTime}/{interval}`. This format specifies that a backup job is executed at an interval of… | | BackupPrefix | string | no | The backup prefix | | ResourceGroupId | string | no | The ID of the resource group | ### Updates the backup parameters of an SAP HANA database `POST https://zieapi.vercel.app/v1/cloud:aliyun-hbr/update-hana-backup-setting` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://hbr.ap-southeast-1.aliyuncs.com | | VaultId | string | no | The ID of the backup vault | | ClusterId | string | yes | The SAP HANA instance ID | | DatabaseName | string | yes | The name of the database | | EnableAutoLogBackup | string | yes | Specifies whether to enable automatic log backup. Valid values: true: Enables automatic log backup. false: Disables automatic log backup | | DataBackupParameterFile | string | no | The data backup configuration file | | LogBackupParameterFile | string | no | The log backup configuration file | | LogBackupUsingBackint | string | yes | Specifies whether to back up logs to Backint. Valid values: true: Backs up logs to Backint. false: Does not back up logs to Backint | | LogBackupTimeout | integer | no | The log backup interval in seconds | | CatalogBackupUsingBackint | string | yes | Specifies whether to use Backint for catalog backup. Valid values: true: Uses Backint for catalog backup. false: Does not use Backint for… | | CatalogBackupParameterFile | string | no | The catalog backup configuration file | ### Updates an SAP HANA instance `POST https://zieapi.vercel.app/v1/cloud:aliyun-hbr/update-hana-instance` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://hbr.ap-southeast-1.aliyuncs.com | | VaultId | string | no | The ID of the backup vault | | ClusterId | string | no | The ID of the SAP HANA instance | | HanaName | string | no | The name of the SAP HANA instance | | Host | string | no | The private or internal IP address of the host where the primary node of the SAP HANA instance resides | | InstanceNumber | integer | yes | The instance number of the SAP HANA system | | UserName | string | no | The username of the SYSTEMDB database | | Password | string | no | The password that is used to connect with the SAP HANA database | | UseSsl | string | yes | Specifies whether to connect with the SAP HANA database over Secure Sockets Layer (SSL). Valid values: true: The SAP HANA database is… | | ValidateCertificate | string | yes | Specifies whether to verify the SSL certificate of the SAP HANA database. Valid values: true: The SSL certificate of the SAP HANA database… | | AlertSetting | string | no | The alert settings. Valid value: INHERITED, which indicates that the Cloud Backup client sends alert notifications by using the same… | | ResourceGroupId | string | no | The ID of the resource group | ### Updates the backup retention period of an SAP HANA database `POST https://zieapi.vercel.app/v1/cloud:aliyun-hbr/update-hana-retention-setting` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://hbr.ap-southeast-1.aliyuncs.com | | VaultId | string | yes | The ID of the backup vault | | ClusterId | string | yes | The SAP HANA instance ID | | Schedule | string | yes | The policy for updating the retention period. Valid format: `I/{startTime}/{interval}`. This format specifies that the retention period is… | | RetentionDays | integer | yes | The number of days for which backups are retained. If Disabled is set to false, backups are retained for the number of days specified by… | | Disabled | string | yes | Specifies whether backups are permanently retained. Valid values: true: Backups are permanently retained. false: Backups are not… | | DatabaseName | string | yes | The name of the database | ### Modifies the association between a policy and a data source `POST https://zieapi.vercel.app/v1/cloud:aliyun-hbr/update-policy-binding` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://hbr.ap-southeast-1.aliyuncs.com | | PolicyId | string | yes | The policy ID | | DataSourceId | string | yes | The data source ID | | SourceType | string | yes | The data source type. Valid values: UDM_ECS: ECS instance backup. OSS: OSS backup. NAS: Alibaba Cloud NAS backup. COMMON_NAS: On-premises… | | PolicyBindingDescription | string | no | The description of the policy binding | | Disabled | string | no | Specifies whether the policy is suspended for the data source. Valid values: true: Suspended. false: Not suspended | | Source | string | no | The backup source. The meaning varies based on the value of SourceType. OSS: The prefix to back up. If not specified, the root directory… | | Include | string | no | The file types to back up. This parameter is available when SourceType is set to ECS_FILE, File, NAS, COMMON_NAS, COMMON_FILE_SYSTEM, or… | | Exclude | string | no | The file types to back up. This parameter is available when SourceType is set to ECS_FILE, File, NAS, COMMON_NAS, COMMON_FILE_SYSTEM, or… | | SpeedLimit | string | no | The backup traffic throttling. This parameter is required when SourceType is set to ECS_FILE or File. The format is… | | AdvancedOptions | string | no | The advanced options (JSON-encoded) | ### Modifies a policy `POST https://zieapi.vercel.app/v1/cloud:aliyun-hbr/update-policy-v2` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://hbr.ap-southeast-1.aliyuncs.com | | PolicyId | string | no | The policy ID | | PolicyName | string | no | The policy name | | PolicyDescription | string | no | The policy description | | Rules | string | no | The list of policy rules (JSON-encoded) | ### Updates the configuration of a backup vault `POST https://zieapi.vercel.app/v1/cloud:aliyun-hbr/update-vault` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://hbr.ap-southeast-1.aliyuncs.com | | VaultId | string | yes | The ID of the backup vault | | VaultName | string | no | The name of the backup vault. The name must be 1 to 64 characters in length | | Description | string | no | The description of the vault. The description must be 0 to 255 characters in length | | WormEnabled | string | no | Specifies whether to enable the backup lock feature for the vault. After the backup lock feature is enabled, the backup vault and all… | | ResourceGroupId | string | no | The ID of the resource group | ### Upgrades an HBR client on one or more Elastic Compute Service (ECS) instances `POST https://zieapi.vercel.app/v1/cloud:aliyun-hbr/upgrade-backup-clients` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://hbr.ap-southeast-1.aliyuncs.com | | InstanceIds | string | no | The IDs of Elastic Compute Service (ECS) instances. The total number of ECS instance IDs and Cloud Backup client IDs cannot exceed 100… | | ClientIds | string | no | The IDs of Cloud Backup clients. The total number of Cloud Backup client IDs and ECS instance IDs cannot exceed 100 (JSON-encoded) | | CrossAccountType | string | no | Specifies whether data is backed up within the same Alibaba Cloud account or across Alibaba Cloud accounts. Valid values: SELF_ACCOUNT:… | | CrossAccountUserId | integer | no | The ID of the source Alibaba Cloud account that authorizes the current Alibaba Cloud account to back up data across Alibaba Cloud accounts | | CrossAccountRoleName | string | no | The name of the RAM role that is created within the source Alibaba Cloud account and assigned to the current Alibaba Cloud account to… | ### Upgrades the Cloud Backup client `POST https://zieapi.vercel.app/v1/cloud:aliyun-hbr/upgrade-client` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://hbr.ap-southeast-1.aliyuncs.com | | VaultId | string | no | The ID of the backup vault | | ClientId | string | no | The ID of the Cloud Backup client | | ResourceGroupId | string | no | The ID of the resource group | ### version `POST https://zieapi.vercel.app/v1/cloud:aliyun-hbr/version` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://hbr.ap-southeast-1.aliyuncs.com | ## Example ``` curl "https://zieapi.vercel.app/v1/cloud:aliyun-hbr/add-container-cluster" \ -H "x-api-key: $APIZIE_KEY" \ -H "x-upstream-key: $PROVIDER_KEY" ``` ## FAQ ### How do I call the Alibaba Cloud Cloud Backup API? Create a free Apizie key, then send POST https://zieapi.vercel.app/v1/cloud:aliyun-hbr/add-container-cluster with the header x-api-key. Every endpoint returns { project, data, timestamp }. ### Is the Alibaba Cloud Cloud Backup API free on Apizie? Yes. The Free plan includes 1,000 requests a month at 100 requests a minute, no credit card. Alibaba Cloud Cloud Backup itself also needs your own key from aliyuncs.com. ### Can AI agents use the Alibaba Cloud Cloud Backup API? Yes. Add the Apizie MCP server (https://zieapi.vercel.app/mcp) to Claude, ChatGPT, Cursor or VS Code, then ask in plain language. The agent calls run_scraper with project key cloud:aliyun-hbr. ### What is the status of the Alibaba Cloud Cloud Backup API? Needs your own provider key (bring your own key)