# Alibaba Cloud Data Disaster Recovery API

> Alibaba Cloud Data Disaster Recovery API on Apizie: 37 endpoints (Configures a Database Backup (DBS) backup plan, Creates, configures, and starts a backup plan, Creates a Database Backup Service (DBS) backup plan, This operation creates a task to download a full backup set, …) 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://apizie.tech/v1/cloud:aliyun-dbs/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

- Project key: `cloud:aliyun-dbs`
- Category: Cloud
- Status: byok
- Source: https://api.alibabacloud.com/product/dbs
- Page: https://apizie.tech/api/cloud/aliyun-dbs
- OpenAPI: https://apizie.tech/api/cloud/aliyun-dbs/openapi.json

Alibaba Cloud OpenAPI for Data Disaster Recovery (dbs, version 2019-03-06). Calls are signed with ACS3-HMAC-SHA256 using your AccessKey ID and secret.

## Endpoints

### Configures a Database Backup (DBS) backup plan
`POST https://apizie.tech/v1/cloud:aliyun-dbs/configure-backup-plan` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| BackupPlanId | string | yes | The ID of the backup plan. You can call https://help.aliyun.com/document_detail/2869825.html to query the backup plan ID |
| SourceEndpointInstanceType | string | yes | The location of the database. You can call https://help.aliyun.com/document_detail/2869825.html to query this value. Valid values: RDS ECS… |
| SourceEndpointRegion | string | no | The region of the database. You can call https://help.aliyun.com/document_detail/2869825.html to query this value. This parameter is… |
| SourceEndpointInstanceID | string | no | The database instance ID. You can call https://help.aliyun.com/document_detail/2869825.html to query this value. This parameter is… |
| SourceEndpointIP | string | no | The database endpoint. You can call https://help.aliyun.com/document_detail/2869825.html to query this value. This parameter is required… |
| SourceEndpointPort | integer | no | The database port. You can call https://help.aliyun.com/document_detail/2869825.html to query this value. This parameter is required when… |
| SourceEndpointDatabaseName | string | no | The database name. You can call https://help.aliyun.com/document_detail/2869825.html to query this value. This parameter is required when… |
| SourceEndpointUserName | string | no | The database account. This parameter is optional when the database type is Redis, or when the database location is agent and the database… |
| SourceEndpointPassword | string | no | The password. This parameter is optional when the database type is Redis, or when the database location is agent and the database type is… |
| BackupGatewayId | integer | no | The backup gateway ID. You can call https://help.aliyun.com/document_detail/2869825.html to query this value. This parameter is required… |
| OSSBucketName | string | no | The OSS bucket name. The system automatically generates a new name by default |
| BackupObjects | string | no | The backup objects. You can call https://help.aliyun.com/document_detail/2869825.html to query this value |
| BackupPeriod | string | no | The full backup period. Valid values: Monday: Monday Tuesday: Tuesday Wednesday: Wednesday Thursday: Thursday Friday: Friday Saturday:… |
| BackupStartTime | string | no | The full backup start time in HH:mmZ (UTC) format. You can call https://help.aliyun.com/document_detail/2869825.html to query this value |
| EnableBackupLog | string | no | Enable incremental log backup. Valid values: true: Enable false: Disable |
| BackupLogIntervalSeconds | integer | no | The incremental interval in seconds (s). Only physical backup is supported |
| BackupRetentionPeriod | integer | no | The retention period for backup data. Valid values: 0 to 1825. Default value: 730 days |
| DuplicationInfrequentAccessPeriod | integer | no | The period after which data is converted to Infrequent Access storage. Default value: 180 days |
| DuplicationArchivePeriod | integer | no | The period after which data is converted to archive cold storage. Default value: 365 days |
| BackupPlanName | string | yes | The custom backup plan name. You can call https://help.aliyun.com/document_detail/2869825.html to query this value |
| SourceEndpointOracleSID | string | no | The Oracle SID name. This parameter is required when the database type is Oracle |
| BackupStorageType | string | no | The built-in storage type: Empty (default): Backup data is stored on your OSS. system: Backup data is stored on the built-in OSS of DBS |
| BackupSpeedLimit | integer | no | The disk I/O limit in KB/s. This parameter is valid only for MySQL physical backup |
| BackupRateLimit | integer | no | The network bandwidth throttling in KB/s. The maximum value is 10 GB. This parameter is valid only for MySQL physical backup |
| BackupStrategyType | string | no | The full backup period. Valid values: simple: Periodic backup. Use this value with BackupPeriod and BackupStartTime. manual: Manual… |
| CrossAliyunId | string | no | The UID for cross-Alibaba Cloud account backup. You can call https://help.aliyun.com/document_detail/2869838.html to query this value |
| CrossRoleName | string | no | The RAM role name for cross-Alibaba Cloud account backup. You can call https://help.aliyun.com/document_detail/2869838.html to query this… |
| AutoStartBackup | string | no | Enable automatic backup. Valid values: true: Enable false: Disable |
| ClientToken | string | no | The client token that is used to ensure the idempotence of the request. The client generates this value, which must be unique among… |
| ResourceGroupId | string | no | The resource group ID |
| EnableSourceEndpointSsl | string | no | 是否开启备份源数据库实例SSL安全连接 |
| BackupStorageEncryptMethod | string | no | 备份存储加密方式 |
| SslCaPem | string | no | 备份源数据库SSL安全连接PEM证书 |
| SourceEndpointOracleHome | string | no | Oracle Home |
| EnableMysqlPhysicalBackupBinlog | string | no | 开启MySQL物理备份的日志备份 |

### Creates, configures, and starts a backup plan
`POST https://apizie.tech/v1/cloud:aliyun-dbs/create-and-start-backup-plan` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| BackupPlanId | string | no | The ID of the backup plan |
| Region | string | no | The region where DBS is available. To view the available regions, call the https://help.aliyun.com/document_detail/2869853.html operation |
| InstanceClass | string | yes | The specification of the backup plan. Valid values: micro small medium large xlarge Higher specifications provide better backup and… |
| DatabaseType | string | yes | The database type. Valid values: MySQL MSSQL Oracle MariaDB PostgreSQL DRDS MongoDB Redis |
| BackupMethod | string | yes | The backup method. Valid values: logical: logical backup physical: physical backup |
| Period | string | no | The billing cycle of the subscription instance. Valid values: Year Month |
| UsedTime | integer | no | The subscription duration. Valid values: If Period is set to Year, the value of UsedTime can be 1 to 5. If Period is set to Month, the… |
| PayType | string | no | The payment method. Valid value: prepay: subscription |
| DatabaseRegion | string | no | The region where the database is located |
| StorageRegion | string | no | The storage region |
| InstanceType | string | no | The database instance type. Valid values: RDS PolarDB DDS: Alibaba Cloud MongoDB Kvstore: Alibaba Cloud Redis Other: A database connected… |
| StorageType | string | no | This parameter is not yet available |
| FromApp | string | no | The source of the request. The default value is OpenApi. You do not need to set this parameter |
| SourceEndpointInstanceType | string | yes | The location of the database. Valid values: RDS ECS Express: A database connected through a leased line, VPN Gateway, or Smart Access… |
| SourceEndpointRegion | string | no | The region where the database is located. This parameter is required if SourceEndpoint.InstanceType is set to RDS, ECS, DDS, Express, or… |
| SourceEndpointInstanceID | string | no | The ID of the database instance. This parameter is required if SourceEndpoint.InstanceType is set to RDS, ECS, DDS, or Express |
| SourceEndpointIP | string | no | The database endpoint. This parameter is required if SourceEndpoint.InstanceType is set to express, agent, or other |
| SourceEndpointPort | integer | no | The database port. This parameter is required if SourceEndpoint.InstanceType is set to express, agent, other, or ECS |
| SourceEndpointDatabaseName | string | no | The database name. This parameter is required if the database type is PostgreSQL or MongoDB |
| SourceEndpointUserName | string | no | The database account. This parameter is optional if the database type is Redis, or if the database location is agent and the database type… |
| SourceEndpointPassword | string | no | The password for the database account. This parameter is optional if the database type is Redis, or if the database location is agent and… |
| BackupGatewayId | integer | no | The ID of the backup gateway. This parameter is required if SourceEndpoint.InstanceType is set to agent. For more information about how to… |
| OSSBucketName | string | no | The name of the Object Storage Service (OSS) bucket. Default: The system automatically generates a new name |
| BackupObjects | string | no | The backup objects |
| BackupPeriod | string | no | The full backup cycle. Valid values: Monday Tuesday Wednesday Thursday Friday Saturday Sunday You can select multiple values. Separate… |
| BackupStartTime | string | no | The start time for the full backup. The time is in the HH:mm format and is in UTC |
| EnableBackupLog | string | no | Specifies whether to enable incremental log backup. Valid values: true false |
| BackupLogIntervalSeconds | integer | no | The interval for incremental backups, in seconds. This parameter is required only for physical backups |
| BackupRetentionPeriod | integer | no | The retention period for backup data, in days. Valid values: 0 to 1825. Default value: 730 |
| DuplicationInfrequentAccessPeriod | integer | no | The time after which backup data is converted to Infrequent Access (IA) storage, in days. Default value: 180 |
| DuplicationArchivePeriod | integer | no | The time after which backup data is converted to archive storage, in days. Default value: 365 |
| BackupPlanName | string | yes | The custom name of the backup plan |
| SourceEndpointOracleSID | string | no | The Oracle system ID (SID). This parameter is required if the database type is Oracle |
| BackupStorageType | string | no | The built-in storage type: Empty (default): Backup data is stored in your OSS bucket. system: Backup data is stored in the built-in OSS… |
| BackupSpeedLimit | integer | no | The disk I/O limit, in KB/s. This parameter is valid only for MySQL physical backups |
| BackupRateLimit | integer | no | The network bandwidth throttling limit, in KB/s. The maximum allowed value is 10 GB. This parameter is valid only for MySQL physical backups |
| BackupStrategyType | string | no | The full backup strategy. Valid values: simple: periodic backup. Use this value with BackupPeriod and BackupStartTime. manual: manual… |
| CrossAliyunId | string | no | The UID of the Alibaba Cloud account for cross-account backup |
| CrossRoleName | string | no | The name of the RAM role for cross-account backup |
| ClientToken | string | no | A client token used to ensure the idempotence of the request. This prevents duplicate requests |
| ResourceGroupId | string | no | The ID of the resource group |

### Creates a Database Backup Service (DBS) backup plan
`POST https://apizie.tech/v1/cloud:aliyun-dbs/create-backup-plan` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Region | string | no | The region ID of the DBS instance. This parameter is required. Call the https://help.aliyun.com/document_detail/2869853.html operation to… |
| InstanceClass | string | yes | The instance class. Valid values: micro: Entry small: Basic medium: Standard large: Enhanced xlarge: Enhanced (no traffic limit) The… |
| DatabaseType | string | yes | The database type. Valid values: MySQL MSSQL Oracle MariaDB PostgreSQL DRDS MongoDB Redis |
| BackupMethod | string | yes | The backup method. Valid values: logical: logical backup physical: physical backup |
| Period | string | no | The billing cycle of the subscription instance. Valid values: Year Month |
| UsedTime | integer | no | The subscription duration. Valid values: If you set the Period parameter to Year, the value of UsedTime can be 1 to 5. If you set the… |
| PayType | string | no | The payment method. Valid value: prepay: subscription |
| DatabaseRegion | string | no | The region of the database |
| StorageRegion | string | no | The storage region |
| InstanceType | string | no | The database instance type. Valid values: RDS PolarDB DDS: Alibaba Cloud MongoDB Kvstore: Alibaba Cloud Redis Other: A database that is… |
| StorageType | string | no | This parameter is not used |
| FromApp | string | no | The source of the request. The default value is OpenAPI. You do not need to set this parameter |
| ClientToken | string | no | A client token that is used to ensure the idempotence of the request |
| ResourceGroupId | string | no | The ID of the resource group |

### This operation creates a task to download a full backup set
`POST https://apizie.tech/v1/cloud:aliyun-dbs/create-full-backup-set-download` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| BackupSetId | string | yes | The ID of the full backup set |
| BackupSetDataFormat | string | no | The format of the downloaded full backup set. Valid values: Native SQL CSV JSON The default value is CSV |
| ClientToken | string | no | A client token used to ensure the idempotence of the request. This prevents the same request from being sent multiple times |

### Creates a task to obtain a database list by using a backup gateway
`POST https://apizie.tech/v1/cloud:aliyun-dbs/create-get-dblist-from-agent-task` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| BackupGatewayId | integer | no | The ID of the backup gateway. You can call the https://help.aliyun.com/document_detail/2869825.html operation to query the ID. This… |
| DatabaseType | string | no | The type of the database. Valid values: MySQL MSSQL Oracle MariaDB PostgreSQL DRDS MongoDB Redis |
| SourceEndpointRegion | string | no | The region in which the backup gateway resides |
| SourceEndpointIP | string | no | The URL that is used to access the database |
| SourceEndpointPort | integer | no | The port that is used to connect to the database |
| ClientToken | string | no | The client token that is used to ensure the idempotence of the request. You can use the client to generate the value, but you must make… |

### Creates and starts an incremental backup set download task
`POST https://apizie.tech/v1/cloud:aliyun-dbs/create-increment-backup-set-download` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| BackupSetId | string | yes | The ID of the incremental backup task. To obtain the task ID, you can call the https://help.aliyun.com/document_detail/2869833.html… |
| BackupSetName | string | yes | The ID of the incremental backup set. To obtain the backup set ID, you can call the https://help.aliyun.com/document_detail/2869833.html… |
| BackupSetDataFormat | string | no | The format in which the incremental backup set is downloaded. Valid values: Native SQL CSV JSON Default value: Native |
| ClientToken | string | no | The client token that is used to ensure the idempotence of the request |

### Creates a Database Backup (DBS) restore task
`POST https://apizie.tech/v1/cloud:aliyun-dbs/create-restore-task` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| BackupPlanId | string | yes | The ID of the backup plan |
| DestinationEndpointInstanceType | string | yes | The location of the database. Valid values: RDS ECS Express: databases connected over Express Connect circuits, VPN gateways, or Smart… |
| DestinationEndpointRegion | string | no | The region of the database instance. This parameter is required if DestinationEndpointInstanceType is set to RDS, ECS, DDS, Express, or… |
| DestinationEndpointInstanceID | string | no | The instance ID of the database. This parameter is required if DestinationEndpointInstanceType is set to RDS, ECS, DDS, or Express |
| DestinationEndpointIP | string | no | The database connection address. This parameter is required if DestinationEndpointInstanceType is set to Express, Agent, or Other |
| DestinationEndpointPort | integer | no | The port number of the database. This parameter is required if DestinationEndpointInstanceType is set to Express, Agent, Other, or ECS |
| DestinationEndpointDatabaseName | string | no | The name of the database. This parameter is required if the database engine is PostgreSQL or MongoDB |
| DestinationEndpointUserName | string | no | The username of the database account. This parameter is not required if the database engine is Redis, or if the database is connected over… |
| DestinationEndpointPassword | string | no | The password of the database account. This parameter is not required if the database engine is Redis, or if the database is connected over… |
| BackupGatewayId | integer | no | The ID of the backup gateway. This parameter is required if DestinationEndpointInstanceType is set to Agent |
| RestoreObjects | string | no | The objects to be restored. For more information, see the definition of the RestoreObjects parameter below. This parameter is not required… |
| RestoreTime | integer | no | The point in time to which you want to restore the database. The value is a UNIX timestamp in milliseconds |
| BackupSetId | string | no | The ID of the full backup set used for restoration. This parameter and RestoreTime are mutually exclusive |
| RestoreTaskName | string | yes | The name of the restore task |
| DestinationEndpointOracleSID | string | no | The Oracle SID. This parameter is required if the database engine is Oracle |
| RestoreDir | string | no | This parameter is required if DestinationEndpointInstanceType is set to Agent and the backup plan is for MySQL |
| RestoreHome | string | no | The directory of the database program |
| DuplicateConflict | string | no | The method used to handle conflicts between objects with the same name. Valid values: renamenew: renames the object if an object with the… |
| CrossAliyunId | string | no | The UID of the Alibaba Cloud account used for cross-account backup |
| CrossRoleName | string | no | The name of the RAM role used for cross-account backup |
| ClientToken | string | no | The client token that is used to ensure the idempotence of the request and prevent duplicate submissions |
| RestoreDestinationMode | string | no | The method used to restore data to the destination. Valid values: EXIST_INSTANCE: restores data to an existing instance. NEW_INSTANCE:… |
| EnableDestinationEndpointSsl | string | no | Specifies whether to connect to the destination by using an SSL-encrypted connection |
| SslCaPem | string | no | The credential for the SSL-encrypted connection to the destination |
| DestDatabaseInstanceType | string | no | The instance type of the new database to which data is restored |
| DestDatabaseInstanceRegion | string | no | The region of the new database instance to which data is restored |
| DestDatabaseInstanceVpc | string | no | The VPC of the new database instance to which data is restored |
| DestDatabaseInstanceClass | string | no | The instance specifications of the new database instance to which data is restored |
| DestDatabaseInstanceStorageSize | string | no | The instance storage size of the new database to recover |
| DestDatabaseInstanceVSwitch | string | no | The vSwitch of the new database instance to which data is restored |
| DestDatabaseInstanceDatabaseVersion | string | no | The database engine version of the new database instance to which data is restored |
| AutoOpenDatabase | string | no | Specifies whether to automatically start the instance after an Oracle physical backup is restored |
| AutoShutdownDatabase | string | no | Specifies whether to automatically shut down the instance after an Oracle physical backup is restored |

### Queries a list of backup gateways in Database Backup Service (DBS)
`POST https://apizie.tech/v1/cloud:aliyun-dbs/describe-backup-gateway-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Region | string | yes | The region of the DBS instance. Valid values: cn-hangzhou: China (Hangzhou) cn-shanghai: China (Shanghai) cn-qingdao: China (Qingdao)… |
| Identifier | string | no | The unique identifier of the backup gateway. You can query multiple gateways by separating the identifiers with commas (,) |
| PageSize | integer | no | The number of records on each page. Valid values: 30 50 100 The default value is 30 |
| PageNum | integer | no | The page number. The value must be greater than or equal to 0 and cannot exceed the maximum value of an integer. The default value is 0 |
| ClientToken | string | no | A client token used to ensure the idempotence of the request. This prevents duplicate requests |

### This operation queries the billing information of a backup plan
`POST https://apizie.tech/v1/cloud:aliyun-dbs/describe-backup-plan-billing` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| BackupPlanId | string | yes | The ID of the backup plan. Call the https://help.aliyun.com/document_detail/2869825.html operation to obtain the value of this parameter |
| ClientToken | string | no | A client token to ensure the idempotence of the request. The client generates this value. It must be unique among different requests. The… |
| ShowStorageType | string | no | Specifies whether to display the storage class |

### Queries a DBS backup plan
`POST https://apizie.tech/v1/cloud:aliyun-dbs/describe-backup-plan-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| BackupPlanId | string | no | The ID of the backup plan. You can specify multiple backup plan IDs, separated by commas |
| Region | string | no | The ID of the region where the backup plan is located. You can call the https://help.aliyun.com/document_detail/2869853.html operation to… |
| PageSize | integer | no | The number of entries to return on each page. Valid values: 1 to 100. The default value is 30 |
| PageNum | integer | no | The page number to return. The value must be an integer that is greater than or equal to 0. The default value is 0 |
| BackupPlanName | string | no | The name of the backup plan |
| BackupPlanStatus | string | no | The status of the backup plan. Valid values: wait: The backup plan is not configured. init: The backup plan is not started because a… |
| ClientToken | string | no | A client-generated token that ensures the idempotence of the request |
| ResourceGroupId | string | no | The ID of the resource group |
| ShowStorageStrategyInfo | string | no | Specifies whether to return information about the storage strategy. Default value: false |
| ShowBackupStrategyInfo | string | no | Specifies whether to return information about the backup strategy. Default value: false |
| ShowRecoverTimeRange | string | no | Specifies whether to return the recovery time range. Default value: false |
| BackupMethod | string | no | The backup method |

### Queries the list of download tasks for backup sets in Database Backup Service (DBS)
`POST https://apizie.tech/v1/cloud:aliyun-dbs/describe-backup-set-download-task-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| BackupPlanId | string | no | The ID of the backup plan. Call the https://help.aliyun.com/document_detail/2869825.html operation to obtain the value of this parameter.… |
| BackupSetDownloadTaskId | string | no | The ID of the backup set download task. For a full backup, call the https://help.aliyun.com/document_detail/2869842.html operation to… |
| PageSize | integer | no | The number of entries to return on each page. Valid values: 30, 50, and 100. The default value is 30 |
| PageNum | integer | no | The page number. The value must be a non-negative integer that does not exceed the maximum value of the integer type. The default value is 0 |
| ClientToken | string | no | A client token that is used to ensure the idempotence of the request. This prevents duplicate requests |

### Queries the status of the Data Lake Analytics (DLA) service for a backup schedule
`POST https://apizie.tech/v1/cloud:aliyun-dbs/describe-dlaservice` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| BackupPlanId | string | yes | The ID of the backup schedule. You can call the https://help.aliyun.com/document_detail/2869825.html operation to obtain the ID of the… |
| ClientToken | string | no | The client token that is used to ensure the idempotence of the request |

### Queries the list of full backup tasks in Database Backup (DBS)
`POST https://apizie.tech/v1/cloud:aliyun-dbs/describe-full-backup-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| BackupPlanId | string | yes | The ID of the backup plan |
| PageSize | integer | no | The number of entries per page. Valid values: 30 50 100 Default value: 30 |
| PageNum | integer | no | The page number. The value must be greater than or equal to 0 and less than or equal to the maximum value of the Integer data type.… |
| ClientToken | string | no | The client token that is used to ensure request idempotence and prevent duplicate submissions |
| ShowStorageType | string | no | Specifies whether to display the storage type |
| BackupSetId | string | no | The ID of the backup set |
| StartTimestamp | integer | no | The start time of the backup |
| EndTimestamp | integer | no | The end time of the backup |
| ShowProgress | string | no | Specifies whether to display the backup progress |
| BackupSetStatus | string | no | The status of the backup set |

### This operation queries the list of incremental backup tasks for DBS
`POST https://apizie.tech/v1/cloud:aliyun-dbs/describe-increment-backup-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| BackupPlanId | string | yes | The ID of the backup plan. Call the https://help.aliyun.com/document_detail/2869825.html operation to obtain this ID |
| PageSize | integer | no | The number of entries per page. Valid values: 30, 50, and 100. Default value: 30 |
| PageNum | integer | no | The page number. The value starts from 0, and the default is 0 |
| ClientToken | string | no | A client-generated token that ensures the idempotence of the request |
| ShowStorageType | string | no | Specifies whether to return the storage class. Valid values: true false Default value: true |
| StartTimestamp | integer | no | The start timestamp of the backup query time range, in milliseconds |
| EndTimestamp | integer | no | The end timestamp of the backup query time range, in milliseconds |

### Queries error code information for a Database Backup (DBS) job
`POST https://apizie.tech/v1/cloud:aliyun-dbs/describe-job-error-code` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| TaskId | string | yes | The ID of the full backup or restore job |
| Language | string | no | The language of the error message. Valid values: en: English (Default) cn: Chinese |
| ClientToken | string | no | The client token that is used to ensure the idempotence of the request |

### Queries the CIDR blocks of nodes on which Database Backup (DBS) is running
`POST https://apizie.tech/v1/cloud:aliyun-dbs/describe-node-cidr-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Region | string | yes | The region in which DBS is activated. Valid values: cn-hangzhou: China (Hangzhou) cn-shanghai: China (Shanghai) cn-qingdao: China… |
| ClientToken | string | no | The client token that is used to ensure the idempotence of the request |

### This operation queries the precheck progress for a backup plan or a restore job
`POST https://apizie.tech/v1/cloud:aliyun-dbs/describe-pre-check-progress-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| BackupPlanId | string | no | The ID of the backup plan. Specify either BackupPlanId or RestoreTaskId |
| RestoreTaskId | string | no | The ID of the restore job |
| ClientToken | string | no | The client token that is used to ensure the idempotence of the request |

### Queries the regions where DBS is available
`POST https://apizie.tech/v1/cloud:aliyun-dbs/describe-regions` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| ClientToken | string | no | A client-generated token that is used to ensure the idempotence of the request. The token must be unique for each request. It can be up to… |

### Queries the details of the recoverable time ranges for a backup plan
`POST https://apizie.tech/v1/cloud:aliyun-dbs/describe-restore-range-info` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| BackupPlanId | string | yes | The ID of the backup plan. You can call the https://help.aliyun.com/document_detail/2869825.html operation to obtain the value of this… |
| BeginTimestampForRestore | integer | yes | The start time of the recoverable time range to query. You can call the https://help.aliyun.com/document_detail/2869825.html operation to… |
| EndTimestampForRestore | integer | yes | The end time of the recoverable time range to query. You can call the https://help.aliyun.com/document_detail/2869825.html operation to… |
| ClientToken | string | no | The client token that is used to ensure the idempotence of the request and prevent duplicate submissions |
| RecentlyRestore | string | no | Specifies whether to enable recent restoration |

### Queries restore jobs in Database Backup Service (DBS)
`POST https://apizie.tech/v1/cloud:aliyun-dbs/describe-restore-task-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| BackupPlanId | string | no | The ID of the backup plan. You must specify either this parameter or `RestoreTaskId` |
| RestoreTaskId | string | no | The ID of the restore task. You can specify multiple IDs, separated by commas. You can call the… |
| PageSize | integer | no | The number of entries to return on each page. Valid values: 1 to 100. The default value is 30 |
| PageNum | integer | no | The page number. The value must be an integer that is greater than or equal to 0. Default value: 0 |
| ClientToken | string | no | A client-generated token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must… |
| StartTimestamp | integer | no | The beginning of the time range to query restore tasks. Specify the time in the UNIX timestamp format. The timestamp is a… |
| EndTimestamp | integer | no | The end of the time range to query restore tasks. Specify the time in the UNIX timestamp format. The timestamp is a millisecond-level… |

### Disable incremental backup for a backup plan
`POST https://apizie.tech/v1/cloud:aliyun-dbs/disable-backup-log` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| BackupPlanId | string | yes | The ID of the backup plan. To get this ID, call the https://help.aliyun.com/document_detail/2869825.html operation |
| ClientToken | string | no | A client token to ensure the idempotence of the request |
| DisableMysqlPhysicalBackupBinlogOnly | string | no | Specifies whether to disable only the log backup feature for a physical backup of a MySQL database |

### Enable incremental backup for a backup schedule
`POST https://apizie.tech/v1/cloud:aliyun-dbs/enable-backup-log` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| BackupPlanId | string | yes | The backup plan ID. Call https://help.aliyun.com/document_detail/2869825.html to obtain this ID |
| ClientToken | string | no | A client-generated token that ensures the idempotency of the request |
| EnableMysqlPhysicalBackupBinlog | string | no | Specifies whether to enable log backup for MySQL physical backups. Set the value to `true` to enable this feature |

### Retrieves database and table data from a physical backup by using a backup gateway
`POST https://apizie.tech/v1/cloud:aliyun-dbs/get-dblist-from-agent` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| BackupGatewayId | integer | no | The ID of the backup gateway. You can call the https://help.aliyun.com/document_detail/2869840.html operation to obtain this parameter.… |
| SourceEndpointRegion | string | no | The region ID of the backup gateway |
| TaskId | integer | no | The ID of the asynchronous task. You can call the https://help.aliyun.com/document_detail/2869847.html operation to obtain this parameter |
| ClientToken | string | no | The client token that is used to ensure the idempotence of the request to prevent repeated submissions. The value is generated by the… |

### Grants the service-linked role (AliyunServiceRoleForDBS) to Database Backup (DBS)
`POST https://apizie.tech/v1/cloud:aliyun-dbs/initialize-dbs-service-linked-role` (byok)

### Modifies the objects included in a Database Backup Service (DBS) backup plan
`POST https://apizie.tech/v1/cloud:aliyun-dbs/modify-backup-objects` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| BackupPlanId | string | yes | The ID of the backup plan |
| BackupObjects | string | yes | The backup objects, specified as a JSON string. The structure is as follows: ``` [ { "DBName":"The name of the database to back up",… |
| ClientToken | string | no | A client token to ensure the request is idempotent. This prevents the same request from being submitted multiple times |

### Modifies the name of a backup plan
`POST https://apizie.tech/v1/cloud:aliyun-dbs/modify-backup-plan-name` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| BackupPlanId | string | yes | The ID of the backup plan |
| BackupPlanName | string | yes | The name of the backup plan |
| ClientToken | string | no | The client token that is used to ensure the idempotence of the request. This prevents the same request from being submitted multiple times |

### Enables, modifies, or disables the automatic download feature
`POST https://apizie.tech/v1/cloud:aliyun-dbs/modify-backup-set-download-rules` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| BackupPlanId | string | yes | The ID of the backup plan. Call the https://help.aliyun.com/document_detail/2869825.html operation to query the backup plan ID |
| OpenAutoDownload | string | no | Specifies whether to enable automatic download. Default value: false |
| BackupGatewayId | integer | no | The ID of the backup gateway used for downloading backup sets |
| FullDataFormat | string | no | The format of the full data in the backup set to download. Valid values: Native SQL CSV JSON Default value: CSV |
| IncrementDataFormat | string | no | The format of the incremental data in the backup set to download. Valid values: Native SQL CSV JSON Default value: Native |
| BackupSetDownloadDir | string | no | The server directory for downloading backup sets |
| BackupSetDownloadTargetType | string | no | The target type for downloading backup sets. Default value: agent, which indicates that a backup gateway is installed. Currently, only… |
| BackupSetDownloadTargetTypeLocation | string | no | The target directory type for downloading backup sets. This parameter is required if automatic download is enabled. Valid values: local… |
| ClientToken | string | no | The client token that is used to ensure the idempotence of the request and prevent repeated submissions |

### Modify a DBS backup source endpoint
`POST https://apizie.tech/v1/cloud:aliyun-dbs/modify-backup-source-endpoint` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| BackupPlanId | string | yes | The backup plan ID. You can call the https://help.aliyun.com/document_detail/2869825.html operation to get this value |
| SourceEndpointInstanceType | string | yes | The type of the source instance. You can call the https://help.aliyun.com/document_detail/2869825.html operation to get this value. Valid… |
| SourceEndpointRegion | string | no | The database region. You can call the https://help.aliyun.com/document_detail/2869825.html operation to get this value. This parameter is… |
| SourceEndpointInstanceID | string | no | The database instance ID. You can call the https://help.aliyun.com/document_detail/2869825.html operation to get this value. This… |
| SourceEndpointIP | string | no | The IP address of the database. You can call the https://help.aliyun.com/document_detail/2869825.html operation to get this value. This… |
| SourceEndpointPort | integer | no | The database port. You can call the https://help.aliyun.com/document_detail/2869825.html operation to get this value. This parameter is… |
| SourceEndpointDatabaseName | string | no | The database name. This parameter is required for PostgreSQL and MongoDB databases. This parameter is also required for Microsoft SQL… |
| SourceEndpointUserName | string | no | The username of the database account. You can call the https://help.aliyun.com/document_detail/2869825.html operation to get this value.… |
| SourceEndpointPassword | string | no | The password for the database account. This parameter is required for all database engines except for Redis and Microsoft SQL Server (when… |
| BackupGatewayId | integer | no | The backup gateway ID. You can call the https://help.aliyun.com/document_detail/2869825.html operation to get this value. This parameter… |
| BackupObjects | string | no | Backup objects: This parameter is optional if the database is located on an agent, but required for all other scenarios. You can call the… |
| SourceEndpointOracleSID | string | no | The Oracle SID. This parameter is required for Oracle databases |
| CrossAliyunId | string | no | The UID for cross-account backup |
| CrossRoleName | string | no | The RAM role name for cross-account backup |
| ClientToken | string | no | A client-generated token to ensure request idempotence |
| EnableSourceEndpointSsl | string | no | Specifies whether to use an SSL connection to back up the source database |
| SslCaPem | string | no | The PEM certificate for the SSL connection |
| SourceEndpointOracleHome | string | no | The Oracle Home path |

### Modifies the backup time of a backup schedule
`POST https://apizie.tech/v1/cloud:aliyun-dbs/modify-backup-strategy` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| BackupPlanId | string | yes | The ID of the backup schedule |
| BackupPeriod | string | yes | The day of each week when the full backup task runs. Valid values: Monday Tuesday Wednesday Thursday Friday Saturday Sunday |
| BackupStartTime | string | no | The start time of the full backup task. Specify the time in the HH:mm format |
| BackupStrategyType | string | no | The backup method that you want to use for full backups. Valid values: simple: scheduled backup. If you specify this value for the… |
| BackupLogIntervalSeconds | integer | no | The interval at which you want to perform incremental log backups. Unit: seconds. This parameter takes effect only when physical backups… |
| ClientToken | string | no | The client token that is used to ensure the idempotence of the request |

### Modify the lifecycle of stored data in a backup plan
`POST https://apizie.tech/v1/cloud:aliyun-dbs/modify-storage-strategy` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| BackupPlanId | string | yes | Backup plan ID. Obtain this parameter's value by calling the https://help.aliyun.com/document_detail/2869825.html API |
| BackupRetentionPeriod | integer | yes | Backup data retention period, in days. Valid values: 0 to 1825. Default value: 730 days |
| DuplicationInfrequentAccessPeriod | integer | yes | Time to convert to Infrequent Access storage. This value must be less than the Archive Storage period (DuplicationArchivePeriod… |
| DuplicationArchivePeriod | integer | yes | Time to convert to Archive Storage. This value must be less than the backup data retention period (BackupRetentionPeriod parameter). For… |
| ClientToken | string | no | An arbitrary string used to ensure the idempotence of the request and prevent duplicate submissions |
| IncrementBackupRetentionPeriod | string | no | 增量备份数据保留时间 |
| IncrementDuplicationInfrequentAccessPeriod | string | no | 增量备份数据转为低频访问存储时间 |
| IncrementDuplicationArchivePeriod | string | no | 增量备份数据转为归档冷备存储时间 |
| LogBackupRetentionPeriod | string | no | 日志备份数据保留时间 |
| LogDuplicationInfrequentAccessPeriod | string | no | 日志备份数据转为归档冷备存储时间 |
| LogDuplicationArchivePeriod | string | no | 日志备份数据转为归档冷备存储时间 |
| BackupStorageEncryptMethod | string | no | 备份数据存储加密方式 |

### This operation releases a pay-as-you-go backup plan
`POST https://apizie.tech/v1/cloud:aliyun-dbs/release-backup-plan` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| BackupPlanId | string | yes | The ID of the backup plan. You can call the https://help.aliyun.com/document_detail/2869825.html operation to query the ID |
| ClientToken | string | no | An arbitrary string |

### Renews a backup schedule
`POST https://apizie.tech/v1/cloud:aliyun-dbs/renew-backup-plan` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| BackupPlanId | string | yes | The ID of the backup schedule |
| Period | string | yes | Specifies whether to use yearly subscription or monthly subscription for the instance. Valid values: Year Month |
| UsedTime | integer | yes | The subscription duration of the instance. Valid values: If the Period parameter is set to Year, the value of the UsedTime parameter… |
| ClientToken | string | no | The client token that is used to ensure the idempotence of the request |

### This operation starts a DBS backup plan
`POST https://apizie.tech/v1/cloud:aliyun-dbs/start-backup-plan` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| BackupPlanId | string | yes | The ID of the backup plan. Call the https://help.aliyun.com/document_detail/2869825.html operation to obtain the value of this parameter |
| ClientToken | string | no | A client token that is used to ensure the idempotence of the request |

### Starts a DBS restore job
`POST https://apizie.tech/v1/cloud:aliyun-dbs/start-restore-task` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| RestoreTaskId | string | yes | The ID of the restore job |
| ClientToken | string | no | A client token. It ensures the idempotence of the request and prevents the same request from being submitted multiple times |

### This operation pauses a DBS backup plan
`POST https://apizie.tech/v1/cloud:aliyun-dbs/stop-backup-plan` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| BackupPlanId | string | yes | The ID of the backup plan |
| StopMethod | string | yes | The method used to pause the backup plan. Valid values: ALL: Pauses the backup schedule, full data backup jobs, incremental log backup… |
| ClientToken | string | no | A client token to ensure the idempotence of the request. This prevents the same request from being sent repeatedly |

### Upgrades a backup schedule
`POST https://apizie.tech/v1/cloud:aliyun-dbs/upgrade-backup-plan` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| BackupPlanId | string | yes | The ID of the backup schedule |
| InstanceClass | string | yes | The specifications of the instance. Valid values: micro small medium large xlarge |
| ClientToken | string | no | The client token that is used to ensure the idempotence of the request |

### version
`POST https://apizie.tech/v1/cloud:aliyun-dbs/version` (byok)

## Example
```
curl "https://apizie.tech/v1/cloud:aliyun-dbs/configure-backup-plan" \
  -H "x-api-key: $APIZIE_KEY" \
  -H "x-upstream-key: $PROVIDER_KEY"
```

## FAQ

### How do I call the Alibaba Cloud Data Disaster Recovery API?
Create a free Apizie key, then send POST https://apizie.tech/v1/cloud:aliyun-dbs/configure-backup-plan with the header x-api-key. Every endpoint returns { project, data, timestamp }.

### Is the Alibaba Cloud Data Disaster Recovery API free on Apizie?
Yes. The Free plan includes 1,000 requests a month at 100 requests a minute, no credit card. Alibaba Cloud Data Disaster Recovery itself also needs your own key from aliyuncs.com.

### Can AI agents use the Alibaba Cloud Data Disaster Recovery API?
Yes. Add the Apizie MCP server (https://apizie.tech/mcp) to Claude, ChatGPT, Cursor or VS Code, then ask in plain language. The agent calls run_scraper with project key cloud:aliyun-dbs.

### What is the status of the Alibaba Cloud Data Disaster Recovery API?
Needs your own provider key (bring your own key)