{"openapi":"3.1.0","info":{"title":"Apizie","version":"2.0.0","description":"One API key, one envelope, many public data sources."},"servers":[{"url":"https://zieapi.vercel.app"}],"security":[{"ApiKeyAuth":[]}],"paths":{"/v1/cloud:aliyun-dbs/configure-backup-plan":{"post":{"operationId":"cloud_aliyun_dbs_configure_backup_plan","summary":"Configures a Database Backup (DBS) backup plan","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["BackupPlanId","SourceEndpointInstanceType","BackupPlanName"],"properties":{"BackupPlanId":{"type":"string","description":"The ID of the backup plan. You can call https://help.aliyun.com/document_detail/2869825.html to query the backup plan ID"},"SourceEndpointInstanceType":{"type":"string","description":"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":{"type":"string","description":"The region of the database. You can call https://help.aliyun.com/document_detail/2869825.html to query this value. This parameter is…"},"SourceEndpointInstanceID":{"type":"string","description":"The database instance ID. You can call https://help.aliyun.com/document_detail/2869825.html to query this value. This parameter is…"},"SourceEndpointIP":{"type":"string","description":"The database endpoint. You can call https://help.aliyun.com/document_detail/2869825.html to query this value. This parameter is required…"},"SourceEndpointPort":{"type":"integer","description":"The database port. You can call https://help.aliyun.com/document_detail/2869825.html to query this value. This parameter is required when…"},"SourceEndpointDatabaseName":{"type":"string","description":"The database name. You can call https://help.aliyun.com/document_detail/2869825.html to query this value. This parameter is required when…"},"SourceEndpointUserName":{"type":"string","description":"The database account. This parameter is optional when the database type is Redis, or when the database location is agent and the database…"},"SourceEndpointPassword":{"type":"string","description":"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":{"type":"integer","description":"The backup gateway ID. You can call https://help.aliyun.com/document_detail/2869825.html to query this value. This parameter is required…"},"OSSBucketName":{"type":"string","description":"The OSS bucket name. The system automatically generates a new name by default"},"BackupObjects":{"type":"string","description":"The backup objects. You can call https://help.aliyun.com/document_detail/2869825.html to query this value"},"BackupPeriod":{"type":"string","description":"The full backup period. Valid values: Monday: Monday Tuesday: Tuesday Wednesday: Wednesday Thursday: Thursday Friday: Friday Saturday:…"},"BackupStartTime":{"type":"string","description":"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":{"type":"string","description":"Enable incremental log backup. Valid values: true: Enable false: Disable"},"BackupLogIntervalSeconds":{"type":"integer","description":"The incremental interval in seconds (s). Only physical backup is supported"},"BackupRetentionPeriod":{"type":"integer","description":"The retention period for backup data. Valid values: 0 to 1825. Default value: 730 days"},"DuplicationInfrequentAccessPeriod":{"type":"integer","description":"The period after which data is converted to Infrequent Access storage. Default value: 180 days"},"DuplicationArchivePeriod":{"type":"integer","description":"The period after which data is converted to archive cold storage. Default value: 365 days"},"BackupPlanName":{"type":"string","description":"The custom backup plan name. You can call https://help.aliyun.com/document_detail/2869825.html to query this value"},"SourceEndpointOracleSID":{"type":"string","description":"The Oracle SID name. This parameter is required when the database type is Oracle"},"BackupStorageType":{"type":"string","description":"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":{"type":"integer","description":"The disk I/O limit in KB/s. This parameter is valid only for MySQL physical backup"},"BackupRateLimit":{"type":"integer","description":"The network bandwidth throttling in KB/s. The maximum value is 10 GB. This parameter is valid only for MySQL physical backup"},"BackupStrategyType":{"type":"string","description":"The full backup period. Valid values: simple: Periodic backup. Use this value with BackupPeriod and BackupStartTime. manual: Manual…"},"CrossAliyunId":{"type":"string","description":"The UID for cross-Alibaba Cloud account backup. You can call https://help.aliyun.com/document_detail/2869838.html to query this value"},"CrossRoleName":{"type":"string","description":"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":{"type":"string","description":"Enable automatic backup. Valid values: true: Enable false: Disable"},"ClientToken":{"type":"string","description":"The client token that is used to ensure the idempotence of the request. The client generates this value, which must be unique among…"},"ResourceGroupId":{"type":"string","description":"The resource group ID"},"EnableSourceEndpointSsl":{"type":"string","description":"是否开启备份源数据库实例SSL安全连接"},"BackupStorageEncryptMethod":{"type":"string","description":"备份存储加密方式"},"SslCaPem":{"type":"string","description":"备份源数据库SSL安全连接PEM证书"},"SourceEndpointOracleHome":{"type":"string","description":"Oracle Home"},"EnableMysqlPhysicalBackupBinlog":{"type":"string","description":"开启MySQL物理备份的日志备份"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dbs/create-and-start-backup-plan":{"post":{"operationId":"cloud_aliyun_dbs_create_and_start_backup_plan","summary":"Creates, configures, and starts a backup plan","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["InstanceClass","DatabaseType","BackupMethod","SourceEndpointInstanceType","BackupPlanName"],"properties":{"BackupPlanId":{"type":"string","description":"The ID of the backup plan"},"Region":{"type":"string","description":"The region where DBS is available. To view the available regions, call the https://help.aliyun.com/document_detail/2869853.html operation"},"InstanceClass":{"type":"string","description":"The specification of the backup plan. Valid values: micro small medium large xlarge Higher specifications provide better backup and…"},"DatabaseType":{"type":"string","description":"The database type. Valid values: MySQL MSSQL Oracle MariaDB PostgreSQL DRDS MongoDB Redis"},"BackupMethod":{"type":"string","description":"The backup method. Valid values: logical: logical backup physical: physical backup"},"Period":{"type":"string","description":"The billing cycle of the subscription instance. Valid values: Year Month"},"UsedTime":{"type":"integer","description":"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":{"type":"string","description":"The payment method. Valid value: prepay: subscription"},"DatabaseRegion":{"type":"string","description":"The region where the database is located"},"StorageRegion":{"type":"string","description":"The storage region"},"InstanceType":{"type":"string","description":"The database instance type. Valid values: RDS PolarDB DDS: Alibaba Cloud MongoDB Kvstore: Alibaba Cloud Redis Other: A database connected…"},"StorageType":{"type":"string","description":"This parameter is not yet available"},"FromApp":{"type":"string","description":"The source of the request. The default value is OpenApi. You do not need to set this parameter"},"SourceEndpointInstanceType":{"type":"string","description":"The location of the database. Valid values: RDS ECS Express: A database connected through a leased line, VPN Gateway, or Smart Access…"},"SourceEndpointRegion":{"type":"string","description":"The region where the database is located. This parameter is required if SourceEndpoint.InstanceType is set to RDS, ECS, DDS, Express, or…"},"SourceEndpointInstanceID":{"type":"string","description":"The ID of the database instance. This parameter is required if SourceEndpoint.InstanceType is set to RDS, ECS, DDS, or Express"},"SourceEndpointIP":{"type":"string","description":"The database endpoint. This parameter is required if SourceEndpoint.InstanceType is set to express, agent, or other"},"SourceEndpointPort":{"type":"integer","description":"The database port. This parameter is required if SourceEndpoint.InstanceType is set to express, agent, other, or ECS"},"SourceEndpointDatabaseName":{"type":"string","description":"The database name. This parameter is required if the database type is PostgreSQL or MongoDB"},"SourceEndpointUserName":{"type":"string","description":"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":{"type":"string","description":"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":{"type":"integer","description":"The ID of the backup gateway. This parameter is required if SourceEndpoint.InstanceType is set to agent. For more information about how to…"},"OSSBucketName":{"type":"string","description":"The name of the Object Storage Service (OSS) bucket. Default: The system automatically generates a new name"},"BackupObjects":{"type":"string","description":"The backup objects"},"BackupPeriod":{"type":"string","description":"The full backup cycle. Valid values: Monday Tuesday Wednesday Thursday Friday Saturday Sunday You can select multiple values. Separate…"},"BackupStartTime":{"type":"string","description":"The start time for the full backup. The time is in the HH:mm format and is in UTC"},"EnableBackupLog":{"type":"string","description":"Specifies whether to enable incremental log backup. Valid values: true false"},"BackupLogIntervalSeconds":{"type":"integer","description":"The interval for incremental backups, in seconds. This parameter is required only for physical backups"},"BackupRetentionPeriod":{"type":"integer","description":"The retention period for backup data, in days. Valid values: 0 to 1825. Default value: 730"},"DuplicationInfrequentAccessPeriod":{"type":"integer","description":"The time after which backup data is converted to Infrequent Access (IA) storage, in days. Default value: 180"},"DuplicationArchivePeriod":{"type":"integer","description":"The time after which backup data is converted to archive storage, in days. Default value: 365"},"BackupPlanName":{"type":"string","description":"The custom name of the backup plan"},"SourceEndpointOracleSID":{"type":"string","description":"The Oracle system ID (SID). This parameter is required if the database type is Oracle"},"BackupStorageType":{"type":"string","description":"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":{"type":"integer","description":"The disk I/O limit, in KB/s. This parameter is valid only for MySQL physical backups"},"BackupRateLimit":{"type":"integer","description":"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":{"type":"string","description":"The full backup strategy. Valid values: simple: periodic backup. Use this value with BackupPeriod and BackupStartTime. manual: manual…"},"CrossAliyunId":{"type":"string","description":"The UID of the Alibaba Cloud account for cross-account backup"},"CrossRoleName":{"type":"string","description":"The name of the RAM role for cross-account backup"},"ClientToken":{"type":"string","description":"A client token used to ensure the idempotence of the request. This prevents duplicate requests"},"ResourceGroupId":{"type":"string","description":"The ID of the resource group"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dbs/create-backup-plan":{"post":{"operationId":"cloud_aliyun_dbs_create_backup_plan","summary":"Creates a Database Backup Service (DBS) backup plan","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["InstanceClass","DatabaseType","BackupMethod"],"properties":{"Region":{"type":"string","description":"The region ID of the DBS instance. This parameter is required. Call the https://help.aliyun.com/document_detail/2869853.html operation to…"},"InstanceClass":{"type":"string","description":"The instance class. Valid values: micro: Entry small: Basic medium: Standard large: Enhanced xlarge: Enhanced (no traffic limit) The…"},"DatabaseType":{"type":"string","description":"The database type. Valid values: MySQL MSSQL Oracle MariaDB PostgreSQL DRDS MongoDB Redis"},"BackupMethod":{"type":"string","description":"The backup method. Valid values: logical: logical backup physical: physical backup"},"Period":{"type":"string","description":"The billing cycle of the subscription instance. Valid values: Year Month"},"UsedTime":{"type":"integer","description":"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":{"type":"string","description":"The payment method. Valid value: prepay: subscription"},"DatabaseRegion":{"type":"string","description":"The region of the database"},"StorageRegion":{"type":"string","description":"The storage region"},"InstanceType":{"type":"string","description":"The database instance type. Valid values: RDS PolarDB DDS: Alibaba Cloud MongoDB Kvstore: Alibaba Cloud Redis Other: A database that is…"},"StorageType":{"type":"string","description":"This parameter is not used"},"FromApp":{"type":"string","description":"The source of the request. The default value is OpenAPI. You do not need to set this parameter"},"ClientToken":{"type":"string","description":"A client token that is used to ensure the idempotence of the request"},"ResourceGroupId":{"type":"string","description":"The ID of the resource group"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dbs/create-full-backup-set-download":{"post":{"operationId":"cloud_aliyun_dbs_create_full_backup_set_download","summary":"This operation creates a task to download a full backup set","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["BackupSetId"],"properties":{"BackupSetId":{"type":"string","description":"The ID of the full backup set"},"BackupSetDataFormat":{"type":"string","description":"The format of the downloaded full backup set. Valid values: Native SQL CSV JSON The default value is CSV"},"ClientToken":{"type":"string","description":"A client token used to ensure the idempotence of the request. This prevents the same request from being sent multiple times"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dbs/create-get-dblist-from-agent-task":{"post":{"operationId":"cloud_aliyun_dbs_create_get_dblist_from_agent_task","summary":"Creates a task to obtain a database list by using a backup gateway","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"BackupGatewayId":{"type":"integer","description":"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":{"type":"string","description":"The type of the database. Valid values: MySQL MSSQL Oracle MariaDB PostgreSQL DRDS MongoDB Redis"},"SourceEndpointRegion":{"type":"string","description":"The region in which the backup gateway resides"},"SourceEndpointIP":{"type":"string","description":"The URL that is used to access the database"},"SourceEndpointPort":{"type":"integer","description":"The port that is used to connect to the database"},"ClientToken":{"type":"string","description":"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…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dbs/create-increment-backup-set-download":{"post":{"operationId":"cloud_aliyun_dbs_create_increment_backup_set_download","summary":"Creates and starts an incremental backup set download task","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["BackupSetId","BackupSetName"],"properties":{"BackupSetId":{"type":"string","description":"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":{"type":"string","description":"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":{"type":"string","description":"The format in which the incremental backup set is downloaded. Valid values: Native SQL CSV JSON Default value: Native"},"ClientToken":{"type":"string","description":"The client token that is used to ensure the idempotence of the request"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dbs/create-restore-task":{"post":{"operationId":"cloud_aliyun_dbs_create_restore_task","summary":"Creates a Database Backup (DBS) restore task","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["BackupPlanId","DestinationEndpointInstanceType","RestoreTaskName"],"properties":{"BackupPlanId":{"type":"string","description":"The ID of the backup plan"},"DestinationEndpointInstanceType":{"type":"string","description":"The location of the database. Valid values: RDS ECS Express: databases connected over Express Connect circuits, VPN gateways, or Smart…"},"DestinationEndpointRegion":{"type":"string","description":"The region of the database instance. This parameter is required if DestinationEndpointInstanceType is set to RDS, ECS, DDS, Express, or…"},"DestinationEndpointInstanceID":{"type":"string","description":"The instance ID of the database. This parameter is required if DestinationEndpointInstanceType is set to RDS, ECS, DDS, or Express"},"DestinationEndpointIP":{"type":"string","description":"The database connection address. This parameter is required if DestinationEndpointInstanceType is set to Express, Agent, or Other"},"DestinationEndpointPort":{"type":"integer","description":"The port number of the database. This parameter is required if DestinationEndpointInstanceType is set to Express, Agent, Other, or ECS"},"DestinationEndpointDatabaseName":{"type":"string","description":"The name of the database. This parameter is required if the database engine is PostgreSQL or MongoDB"},"DestinationEndpointUserName":{"type":"string","description":"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":{"type":"string","description":"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":{"type":"integer","description":"The ID of the backup gateway. This parameter is required if DestinationEndpointInstanceType is set to Agent"},"RestoreObjects":{"type":"string","description":"The objects to be restored. For more information, see the definition of the RestoreObjects parameter below. This parameter is not required…"},"RestoreTime":{"type":"integer","description":"The point in time to which you want to restore the database. The value is a UNIX timestamp in milliseconds"},"BackupSetId":{"type":"string","description":"The ID of the full backup set used for restoration. This parameter and RestoreTime are mutually exclusive"},"RestoreTaskName":{"type":"string","description":"The name of the restore task"},"DestinationEndpointOracleSID":{"type":"string","description":"The Oracle SID. This parameter is required if the database engine is Oracle"},"RestoreDir":{"type":"string","description":"This parameter is required if DestinationEndpointInstanceType is set to Agent and the backup plan is for MySQL"},"RestoreHome":{"type":"string","description":"The directory of the database program"},"DuplicateConflict":{"type":"string","description":"The method used to handle conflicts between objects with the same name. Valid values: renamenew: renames the object if an object with the…"},"CrossAliyunId":{"type":"string","description":"The UID of the Alibaba Cloud account used for cross-account backup"},"CrossRoleName":{"type":"string","description":"The name of the RAM role used for cross-account backup"},"ClientToken":{"type":"string","description":"The client token that is used to ensure the idempotence of the request and prevent duplicate submissions"},"RestoreDestinationMode":{"type":"string","description":"The method used to restore data to the destination. Valid values: EXIST_INSTANCE: restores data to an existing instance. NEW_INSTANCE:…"},"EnableDestinationEndpointSsl":{"type":"string","description":"Specifies whether to connect to the destination by using an SSL-encrypted connection"},"SslCaPem":{"type":"string","description":"The credential for the SSL-encrypted connection to the destination"},"DestDatabaseInstanceType":{"type":"string","description":"The instance type of the new database to which data is restored"},"DestDatabaseInstanceRegion":{"type":"string","description":"The region of the new database instance to which data is restored"},"DestDatabaseInstanceVpc":{"type":"string","description":"The VPC of the new database instance to which data is restored"},"DestDatabaseInstanceClass":{"type":"string","description":"The instance specifications of the new database instance to which data is restored"},"DestDatabaseInstanceStorageSize":{"type":"string","description":"The instance storage size of the new database to recover"},"DestDatabaseInstanceVSwitch":{"type":"string","description":"The vSwitch of the new database instance to which data is restored"},"DestDatabaseInstanceDatabaseVersion":{"type":"string","description":"The database engine version of the new database instance to which data is restored"},"AutoOpenDatabase":{"type":"string","description":"Specifies whether to automatically start the instance after an Oracle physical backup is restored"},"AutoShutdownDatabase":{"type":"string","description":"Specifies whether to automatically shut down the instance after an Oracle physical backup is restored"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dbs/describe-backup-gateway-list":{"post":{"operationId":"cloud_aliyun_dbs_describe_backup_gateway_list","summary":"Queries a list of backup gateways in Database Backup Service (DBS)","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Region"],"properties":{"Region":{"type":"string","description":"The region of the DBS instance. Valid values: cn-hangzhou: China (Hangzhou) cn-shanghai: China (Shanghai) cn-qingdao: China (Qingdao)…"},"Identifier":{"type":"string","description":"The unique identifier of the backup gateway. You can query multiple gateways by separating the identifiers with commas (,)"},"PageSize":{"type":"integer","description":"The number of records on each page. Valid values: 30 50 100 The default value is 30"},"PageNum":{"type":"integer","description":"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":{"type":"string","description":"A client token used to ensure the idempotence of the request. This prevents duplicate requests"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dbs/describe-backup-plan-billing":{"post":{"operationId":"cloud_aliyun_dbs_describe_backup_plan_billing","summary":"This operation queries the billing information of a backup plan","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["BackupPlanId"],"properties":{"BackupPlanId":{"type":"string","description":"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":{"type":"string","description":"A client token to ensure the idempotence of the request. The client generates this value. It must be unique among different requests. The…"},"ShowStorageType":{"type":"string","description":"Specifies whether to display the storage class"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dbs/describe-backup-plan-list":{"post":{"operationId":"cloud_aliyun_dbs_describe_backup_plan_list","summary":"Queries a DBS backup plan","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"BackupPlanId":{"type":"string","description":"The ID of the backup plan. You can specify multiple backup plan IDs, separated by commas"},"Region":{"type":"string","description":"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":{"type":"integer","description":"The number of entries to return on each page. Valid values: 1 to 100. The default value is 30"},"PageNum":{"type":"integer","description":"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":{"type":"string","description":"The name of the backup plan"},"BackupPlanStatus":{"type":"string","description":"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":{"type":"string","description":"A client-generated token that ensures the idempotence of the request"},"ResourceGroupId":{"type":"string","description":"The ID of the resource group"},"ShowStorageStrategyInfo":{"type":"string","description":"Specifies whether to return information about the storage strategy. Default value: false"},"ShowBackupStrategyInfo":{"type":"string","description":"Specifies whether to return information about the backup strategy. Default value: false"},"ShowRecoverTimeRange":{"type":"string","description":"Specifies whether to return the recovery time range. Default value: false"},"BackupMethod":{"type":"string","description":"The backup method"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dbs/describe-backup-set-download-task-list":{"post":{"operationId":"cloud_aliyun_dbs_describe_backup_set_download_task_list","summary":"Queries the list of download tasks for backup sets in Database Backup Service (DBS)","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"BackupPlanId":{"type":"string","description":"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":{"type":"string","description":"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":{"type":"integer","description":"The number of entries to return on each page. Valid values: 30, 50, and 100. The default value is 30"},"PageNum":{"type":"integer","description":"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":{"type":"string","description":"A client token that is used to ensure the idempotence of the request. This prevents duplicate requests"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dbs/describe-dlaservice":{"post":{"operationId":"cloud_aliyun_dbs_describe_dlaservice","summary":"Queries the status of the Data Lake Analytics (DLA) service for a backup schedule","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["BackupPlanId"],"properties":{"BackupPlanId":{"type":"string","description":"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":{"type":"string","description":"The client token that is used to ensure the idempotence of the request"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dbs/describe-full-backup-list":{"post":{"operationId":"cloud_aliyun_dbs_describe_full_backup_list","summary":"Queries the list of full backup tasks in Database Backup (DBS)","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["BackupPlanId"],"properties":{"BackupPlanId":{"type":"string","description":"The ID of the backup plan"},"PageSize":{"type":"integer","description":"The number of entries per page. Valid values: 30 50 100 Default value: 30"},"PageNum":{"type":"integer","description":"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":{"type":"string","description":"The client token that is used to ensure request idempotence and prevent duplicate submissions"},"ShowStorageType":{"type":"string","description":"Specifies whether to display the storage type"},"BackupSetId":{"type":"string","description":"The ID of the backup set"},"StartTimestamp":{"type":"integer","description":"The start time of the backup"},"EndTimestamp":{"type":"integer","description":"The end time of the backup"},"ShowProgress":{"type":"string","description":"Specifies whether to display the backup progress"},"BackupSetStatus":{"type":"string","description":"The status of the backup set"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dbs/describe-increment-backup-list":{"post":{"operationId":"cloud_aliyun_dbs_describe_increment_backup_list","summary":"This operation queries the list of incremental backup tasks for DBS","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["BackupPlanId"],"properties":{"BackupPlanId":{"type":"string","description":"The ID of the backup plan. Call the https://help.aliyun.com/document_detail/2869825.html operation to obtain this ID"},"PageSize":{"type":"integer","description":"The number of entries per page. Valid values: 30, 50, and 100. Default value: 30"},"PageNum":{"type":"integer","description":"The page number. The value starts from 0, and the default is 0"},"ClientToken":{"type":"string","description":"A client-generated token that ensures the idempotence of the request"},"ShowStorageType":{"type":"string","description":"Specifies whether to return the storage class. Valid values: true false Default value: true"},"StartTimestamp":{"type":"integer","description":"The start timestamp of the backup query time range, in milliseconds"},"EndTimestamp":{"type":"integer","description":"The end timestamp of the backup query time range, in milliseconds"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dbs/describe-job-error-code":{"post":{"operationId":"cloud_aliyun_dbs_describe_job_error_code","summary":"Queries error code information for a Database Backup (DBS) job","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["TaskId"],"properties":{"TaskId":{"type":"string","description":"The ID of the full backup or restore job"},"Language":{"type":"string","description":"The language of the error message. Valid values: en: English (Default) cn: Chinese"},"ClientToken":{"type":"string","description":"The client token that is used to ensure the idempotence of the request"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dbs/describe-node-cidr-list":{"post":{"operationId":"cloud_aliyun_dbs_describe_node_cidr_list","summary":"Queries the CIDR blocks of nodes on which Database Backup (DBS) is running","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Region"],"properties":{"Region":{"type":"string","description":"The region in which DBS is activated. Valid values: cn-hangzhou: China (Hangzhou) cn-shanghai: China (Shanghai) cn-qingdao: China…"},"ClientToken":{"type":"string","description":"The client token that is used to ensure the idempotence of the request"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dbs/describe-pre-check-progress-list":{"post":{"operationId":"cloud_aliyun_dbs_describe_pre_check_progress_list","summary":"This operation queries the precheck progress for a backup plan or a restore job","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"BackupPlanId":{"type":"string","description":"The ID of the backup plan. Specify either BackupPlanId or RestoreTaskId"},"RestoreTaskId":{"type":"string","description":"The ID of the restore job"},"ClientToken":{"type":"string","description":"The client token that is used to ensure the idempotence of the request"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dbs/describe-regions":{"post":{"operationId":"cloud_aliyun_dbs_describe_regions","summary":"Queries the regions where DBS is available","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"ClientToken":{"type":"string","description":"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…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dbs/describe-restore-range-info":{"post":{"operationId":"cloud_aliyun_dbs_describe_restore_range_info","summary":"Queries the details of the recoverable time ranges for a backup plan","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["BackupPlanId","BeginTimestampForRestore","EndTimestampForRestore"],"properties":{"BackupPlanId":{"type":"string","description":"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":{"type":"integer","description":"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":{"type":"integer","description":"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":{"type":"string","description":"The client token that is used to ensure the idempotence of the request and prevent duplicate submissions"},"RecentlyRestore":{"type":"string","description":"Specifies whether to enable recent restoration"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dbs/describe-restore-task-list":{"post":{"operationId":"cloud_aliyun_dbs_describe_restore_task_list","summary":"Queries restore jobs in Database Backup Service (DBS)","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"BackupPlanId":{"type":"string","description":"The ID of the backup plan. You must specify either this parameter or `RestoreTaskId`"},"RestoreTaskId":{"type":"string","description":"The ID of the restore task. You can specify multiple IDs, separated by commas. You can call the…"},"PageSize":{"type":"integer","description":"The number of entries to return on each page. Valid values: 1 to 100. The default value is 30"},"PageNum":{"type":"integer","description":"The page number. The value must be an integer that is greater than or equal to 0. Default value: 0"},"ClientToken":{"type":"string","description":"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":{"type":"integer","description":"The beginning of the time range to query restore tasks. Specify the time in the UNIX timestamp format. The timestamp is a…"},"EndTimestamp":{"type":"integer","description":"The end of the time range to query restore tasks. Specify the time in the UNIX timestamp format. The timestamp is a millisecond-level…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dbs/disable-backup-log":{"post":{"operationId":"cloud_aliyun_dbs_disable_backup_log","summary":"Disable incremental backup for a backup plan","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["BackupPlanId"],"properties":{"BackupPlanId":{"type":"string","description":"The ID of the backup plan. To get this ID, call the https://help.aliyun.com/document_detail/2869825.html operation"},"ClientToken":{"type":"string","description":"A client token to ensure the idempotence of the request"},"DisableMysqlPhysicalBackupBinlogOnly":{"type":"string","description":"Specifies whether to disable only the log backup feature for a physical backup of a MySQL database"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dbs/enable-backup-log":{"post":{"operationId":"cloud_aliyun_dbs_enable_backup_log","summary":"Enable incremental backup for a backup schedule","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["BackupPlanId"],"properties":{"BackupPlanId":{"type":"string","description":"The backup plan ID. Call https://help.aliyun.com/document_detail/2869825.html to obtain this ID"},"ClientToken":{"type":"string","description":"A client-generated token that ensures the idempotency of the request"},"EnableMysqlPhysicalBackupBinlog":{"type":"string","description":"Specifies whether to enable log backup for MySQL physical backups. Set the value to `true` to enable this feature"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dbs/get-dblist-from-agent":{"post":{"operationId":"cloud_aliyun_dbs_get_dblist_from_agent","summary":"Retrieves database and table data from a physical backup by using a backup gateway","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"BackupGatewayId":{"type":"integer","description":"The ID of the backup gateway. You can call the https://help.aliyun.com/document_detail/2869840.html operation to obtain this parameter.…"},"SourceEndpointRegion":{"type":"string","description":"The region ID of the backup gateway"},"TaskId":{"type":"integer","description":"The ID of the asynchronous task. You can call the https://help.aliyun.com/document_detail/2869847.html operation to obtain this parameter"},"ClientToken":{"type":"string","description":"The client token that is used to ensure the idempotence of the request to prevent repeated submissions. The value is generated by the…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dbs/initialize-dbs-service-linked-role":{"post":{"operationId":"cloud_aliyun_dbs_initialize_dbs_service_linked_role","summary":"Grants the service-linked role (AliyunServiceRoleForDBS) to Database Backup (DBS)","description":"POST /","tags":["cloud"],"parameters":[],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dbs/modify-backup-objects":{"post":{"operationId":"cloud_aliyun_dbs_modify_backup_objects","summary":"Modifies the objects included in a Database Backup Service (DBS) backup plan","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["BackupPlanId","BackupObjects"],"properties":{"BackupPlanId":{"type":"string","description":"The ID of the backup plan"},"BackupObjects":{"type":"string","description":"The backup objects, specified as a JSON string. The structure is as follows: ``` [ { \"DBName\":\"The name of the database to back up\",…"},"ClientToken":{"type":"string","description":"A client token to ensure the request is idempotent. This prevents the same request from being submitted multiple times"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dbs/modify-backup-plan-name":{"post":{"operationId":"cloud_aliyun_dbs_modify_backup_plan_name","summary":"Modifies the name of a backup plan","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["BackupPlanId","BackupPlanName"],"properties":{"BackupPlanId":{"type":"string","description":"The ID of the backup plan"},"BackupPlanName":{"type":"string","description":"The name of the backup plan"},"ClientToken":{"type":"string","description":"The client token that is used to ensure the idempotence of the request. This prevents the same request from being submitted multiple times"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dbs/modify-backup-set-download-rules":{"post":{"operationId":"cloud_aliyun_dbs_modify_backup_set_download_rules","summary":"Enables, modifies, or disables the automatic download feature","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["BackupPlanId"],"properties":{"BackupPlanId":{"type":"string","description":"The ID of the backup plan. Call the https://help.aliyun.com/document_detail/2869825.html operation to query the backup plan ID"},"OpenAutoDownload":{"type":"string","description":"Specifies whether to enable automatic download. Default value: false"},"BackupGatewayId":{"type":"integer","description":"The ID of the backup gateway used for downloading backup sets"},"FullDataFormat":{"type":"string","description":"The format of the full data in the backup set to download. Valid values: Native SQL CSV JSON Default value: CSV"},"IncrementDataFormat":{"type":"string","description":"The format of the incremental data in the backup set to download. Valid values: Native SQL CSV JSON Default value: Native"},"BackupSetDownloadDir":{"type":"string","description":"The server directory for downloading backup sets"},"BackupSetDownloadTargetType":{"type":"string","description":"The target type for downloading backup sets. Default value: agent, which indicates that a backup gateway is installed. Currently, only…"},"BackupSetDownloadTargetTypeLocation":{"type":"string","description":"The target directory type for downloading backup sets. This parameter is required if automatic download is enabled. Valid values: local…"},"ClientToken":{"type":"string","description":"The client token that is used to ensure the idempotence of the request and prevent repeated submissions"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dbs/modify-backup-source-endpoint":{"post":{"operationId":"cloud_aliyun_dbs_modify_backup_source_endpoint","summary":"Modify a DBS backup source endpoint","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["BackupPlanId","SourceEndpointInstanceType"],"properties":{"BackupPlanId":{"type":"string","description":"The backup plan ID. You can call the https://help.aliyun.com/document_detail/2869825.html operation to get this value"},"SourceEndpointInstanceType":{"type":"string","description":"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":{"type":"string","description":"The database region. You can call the https://help.aliyun.com/document_detail/2869825.html operation to get this value. This parameter is…"},"SourceEndpointInstanceID":{"type":"string","description":"The database instance ID. You can call the https://help.aliyun.com/document_detail/2869825.html operation to get this value. This…"},"SourceEndpointIP":{"type":"string","description":"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":{"type":"integer","description":"The database port. You can call the https://help.aliyun.com/document_detail/2869825.html operation to get this value. This parameter is…"},"SourceEndpointDatabaseName":{"type":"string","description":"The database name. This parameter is required for PostgreSQL and MongoDB databases. This parameter is also required for Microsoft SQL…"},"SourceEndpointUserName":{"type":"string","description":"The username of the database account. You can call the https://help.aliyun.com/document_detail/2869825.html operation to get this value.…"},"SourceEndpointPassword":{"type":"string","description":"The password for the database account. This parameter is required for all database engines except for Redis and Microsoft SQL Server (when…"},"BackupGatewayId":{"type":"integer","description":"The backup gateway ID. You can call the https://help.aliyun.com/document_detail/2869825.html operation to get this value. This parameter…"},"BackupObjects":{"type":"string","description":"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":{"type":"string","description":"The Oracle SID. This parameter is required for Oracle databases"},"CrossAliyunId":{"type":"string","description":"The UID for cross-account backup"},"CrossRoleName":{"type":"string","description":"The RAM role name for cross-account backup"},"ClientToken":{"type":"string","description":"A client-generated token to ensure request idempotence"},"EnableSourceEndpointSsl":{"type":"string","description":"Specifies whether to use an SSL connection to back up the source database"},"SslCaPem":{"type":"string","description":"The PEM certificate for the SSL connection"},"SourceEndpointOracleHome":{"type":"string","description":"The Oracle Home path"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dbs/modify-backup-strategy":{"post":{"operationId":"cloud_aliyun_dbs_modify_backup_strategy","summary":"Modifies the backup time of a backup schedule","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["BackupPlanId","BackupPeriod"],"properties":{"BackupPlanId":{"type":"string","description":"The ID of the backup schedule"},"BackupPeriod":{"type":"string","description":"The day of each week when the full backup task runs. Valid values: Monday Tuesday Wednesday Thursday Friday Saturday Sunday"},"BackupStartTime":{"type":"string","description":"The start time of the full backup task. Specify the time in the HH:mm format"},"BackupStrategyType":{"type":"string","description":"The backup method that you want to use for full backups. Valid values: simple: scheduled backup. If you specify this value for the…"},"BackupLogIntervalSeconds":{"type":"integer","description":"The interval at which you want to perform incremental log backups. Unit: seconds. This parameter takes effect only when physical backups…"},"ClientToken":{"type":"string","description":"The client token that is used to ensure the idempotence of the request"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dbs/modify-storage-strategy":{"post":{"operationId":"cloud_aliyun_dbs_modify_storage_strategy","summary":"Modify the lifecycle of stored data in a backup plan","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["BackupPlanId","BackupRetentionPeriod","DuplicationInfrequentAccessPeriod","DuplicationArchivePeriod"],"properties":{"BackupPlanId":{"type":"string","description":"Backup plan ID. Obtain this parameter's value by calling the https://help.aliyun.com/document_detail/2869825.html API"},"BackupRetentionPeriod":{"type":"integer","description":"Backup data retention period, in days. Valid values: 0 to 1825. Default value: 730 days"},"DuplicationInfrequentAccessPeriod":{"type":"integer","description":"Time to convert to Infrequent Access storage. This value must be less than the Archive Storage period (DuplicationArchivePeriod…"},"DuplicationArchivePeriod":{"type":"integer","description":"Time to convert to Archive Storage. This value must be less than the backup data retention period (BackupRetentionPeriod parameter). For…"},"ClientToken":{"type":"string","description":"An arbitrary string used to ensure the idempotence of the request and prevent duplicate submissions"},"IncrementBackupRetentionPeriod":{"type":"string","description":"增量备份数据保留时间"},"IncrementDuplicationInfrequentAccessPeriod":{"type":"string","description":"增量备份数据转为低频访问存储时间"},"IncrementDuplicationArchivePeriod":{"type":"string","description":"增量备份数据转为归档冷备存储时间"},"LogBackupRetentionPeriod":{"type":"string","description":"日志备份数据保留时间"},"LogDuplicationInfrequentAccessPeriod":{"type":"string","description":"日志备份数据转为归档冷备存储时间"},"LogDuplicationArchivePeriod":{"type":"string","description":"日志备份数据转为归档冷备存储时间"},"BackupStorageEncryptMethod":{"type":"string","description":"备份数据存储加密方式"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dbs/release-backup-plan":{"post":{"operationId":"cloud_aliyun_dbs_release_backup_plan","summary":"This operation releases a pay-as-you-go backup plan","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["BackupPlanId"],"properties":{"BackupPlanId":{"type":"string","description":"The ID of the backup plan. You can call the https://help.aliyun.com/document_detail/2869825.html operation to query the ID"},"ClientToken":{"type":"string","description":"An arbitrary string"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dbs/renew-backup-plan":{"post":{"operationId":"cloud_aliyun_dbs_renew_backup_plan","summary":"Renews a backup schedule","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["BackupPlanId","Period","UsedTime"],"properties":{"BackupPlanId":{"type":"string","description":"The ID of the backup schedule"},"Period":{"type":"string","description":"Specifies whether to use yearly subscription or monthly subscription for the instance. Valid values: Year Month"},"UsedTime":{"type":"integer","description":"The subscription duration of the instance. Valid values: If the Period parameter is set to Year, the value of the UsedTime parameter…"},"ClientToken":{"type":"string","description":"The client token that is used to ensure the idempotence of the request"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dbs/start-backup-plan":{"post":{"operationId":"cloud_aliyun_dbs_start_backup_plan","summary":"This operation starts a DBS backup plan","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["BackupPlanId"],"properties":{"BackupPlanId":{"type":"string","description":"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":{"type":"string","description":"A client token that is used to ensure the idempotence of the request"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dbs/start-restore-task":{"post":{"operationId":"cloud_aliyun_dbs_start_restore_task","summary":"Starts a DBS restore job","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["RestoreTaskId"],"properties":{"RestoreTaskId":{"type":"string","description":"The ID of the restore job"},"ClientToken":{"type":"string","description":"A client token. It ensures the idempotence of the request and prevents the same request from being submitted multiple times"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dbs/stop-backup-plan":{"post":{"operationId":"cloud_aliyun_dbs_stop_backup_plan","summary":"This operation pauses a DBS backup plan","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["BackupPlanId","StopMethod"],"properties":{"BackupPlanId":{"type":"string","description":"The ID of the backup plan"},"StopMethod":{"type":"string","description":"The method used to pause the backup plan. Valid values: ALL: Pauses the backup schedule, full data backup jobs, incremental log backup…"},"ClientToken":{"type":"string","description":"A client token to ensure the idempotence of the request. This prevents the same request from being sent repeatedly"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dbs/upgrade-backup-plan":{"post":{"operationId":"cloud_aliyun_dbs_upgrade_backup_plan","summary":"Upgrades a backup schedule","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["BackupPlanId","InstanceClass"],"properties":{"BackupPlanId":{"type":"string","description":"The ID of the backup schedule"},"InstanceClass":{"type":"string","description":"The specifications of the instance. Valid values: micro small medium large xlarge"},"ClientToken":{"type":"string","description":"The client token that is used to ensure the idempotence of the request"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dbs/version":{"post":{"operationId":"cloud_aliyun_dbs_version","summary":"version","description":"POST /","tags":["cloud"],"parameters":[],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}}},"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"x-api-key"}},"schemas":{"RunEnvelope":{"type":"object","required":["project","data","timestamp"],"properties":{"project":{"type":"string","example":"dev-tools:hash"},"data":{},"timestamp":{"type":"string","format":"date-time"}}},"ErrorEnvelope":{"type":"object","properties":{"content":{},"message":{"type":"string"},"errors":{"type":"array","items":{}},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}}}}}},"responses":{"Error":{"description":"Invalid key, plan gate, rate limit or upstream failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}}}}