diff options
| author | Zhineng Li <[email protected]> | 2026-02-13 10:54:11 +0800 |
|---|---|---|
| committer | Zhineng Li <[email protected]> | 2026-02-13 10:54:11 +0800 |
| commit | 7347bac4ab7e136157fc94777e6cf87ef9e08599 (patch) | |
| tree | 0dec367dac6e152161a6f7cc0dba6ebbef1f34a2 /data/en_us/dbs | |
| download | acs-metadata-full-main.tar.gz acs-metadata-full-main.zip | |
first commitHEADv1.0.0+20260212main
Diffstat (limited to 'data/en_us/dbs')
| -rw-r--r-- | data/en_us/dbs/2019-03-06/api-docs.php | 10947 | ||||
| -rw-r--r-- | data/en_us/dbs/2021-01-01/api-docs.php | 5731 |
2 files changed, 16678 insertions, 0 deletions
diff --git a/data/en_us/dbs/2019-03-06/api-docs.php b/data/en_us/dbs/2019-03-06/api-docs.php new file mode 100644 index 0000000..4d02b2c --- /dev/null +++ b/data/en_us/dbs/2019-03-06/api-docs.php @@ -0,0 +1,10947 @@ +<?php return [ + 'version' => '1.0', + 'info' => [ + 'style' => 'RPC', + 'product' => 'Dbs', + 'version' => '2019-03-06', + ], + 'directories' => [ + [ + 'children' => [ + 'CreateBackupPlan', + 'CreateAndStartBackupPlan', + 'StartBackupPlan', + 'StopBackupPlan', + 'ModifyBackupObjects', + 'ModifyBackupSourceEndpoint', + 'ModifyBackupPlanName', + 'DescribeBackupPlanList', + 'DescribeBackupPlanBilling', + 'ConfigureBackupPlan', + 'ReleaseBackupPlan', + ], + 'type' => 'directory', + 'title' => 'Backup schedules', + ], + [ + 'children' => [ + 'DescribeIncrementBackupList', + 'DescribeFullBackupList', + ], + 'type' => 'directory', + 'title' => 'Backup tasks', + ], + [ + 'children' => [ + 'CreateRestoreTask', + 'StartRestoreTask', + 'DescribeRestoreTaskList', + ], + 'type' => 'directory', + 'title' => 'Restoration tasks', + ], + [ + 'children' => [ + 'DescribeBackupGatewayList', + ], + 'type' => 'directory', + 'title' => 'Backup gateways', + ], + [ + 'children' => [ + 'CreateFullBackupSetDownload', + 'DescribeBackupSetDownloadTaskList', + ], + 'type' => 'directory', + 'title' => 'Backup set download', + ], + [ + 'children' => [ + 'DescribeJobErrorCode', + 'DescribePreCheckProgressList', + 'DescribeRegions', + 'InitializeDbsServiceLinkedRole', + ], + 'type' => 'directory', + 'title' => 'Service management', + ], + [ + 'children' => [ + 'CreateGetDBListFromAgentTask', + 'CreateIncrementBackupSetDownload', + 'DescribeDLAService', + 'DescribeNodeCidrList', + 'DescribeRestoreRangeInfo', + 'DisableBackupLog', + 'EnableBackupLog', + 'GetDBListFromAgent', + 'ModifyBackupSetDownloadRules', + 'ModifyBackupStrategy', + 'ModifyStorageStrategy', + 'RenewBackupPlan', + 'UpgradeBackupPlan', + ], + 'title' => 'Others', + 'type' => 'directory', + ], + ], + 'components' => [ + 'schemas' => [], + ], + 'apis' => [ + 'ConfigureBackupPlan' => [ + 'summary' => 'Configures a DBS backup plan.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREcbsKR7J6S', + ], + ], + 'parameters' => [ + [ + 'name' => 'BackupPlanId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the backup plan. Call the [DescribeBackupPlanList](~~2869825~~) operation to obtain the value of this parameter.', + 'type' => 'string', + 'required' => true, + 'example' => 'dbstooi0*******', + 'title' => '', + ], + ], + [ + 'name' => 'SourceEndpointInstanceType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of the database source. Call the [DescribeBackupPlanList](~~2869825~~) operation to obtain the value of this parameter. Valid values:'."\n" + ."\n" + .'- **RDS**'."\n" + ."\n" + .'- **ECS**'."\n" + ."\n" + .'- **Express**: A database connected over a leased line, VPN Gateway, or Smart Access Gateway.'."\n" + ."\n" + .'- **Agent**: A database connected over a backup gateway.'."\n" + ."\n" + .'- **DDS**: ApsaraDB for MongoDB.'."\n" + ."\n" + .'- **Other**: A database connected over an IP address and port.', + 'type' => 'string', + 'required' => true, + 'example' => 'RDS', + 'title' => '', + ], + ], + [ + 'name' => 'SourceEndpointRegion', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region of the database. Call the [DescribeBackupPlanList](~~2869825~~) operation to obtain the value of this parameter.'."\n" + ."\n" + .'> This parameter is required if **SourceEndpointInstanceType** is set to RDS, ECS, DDS, Express, or Agent.', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + 'title' => '', + ], + ], + [ + 'name' => 'SourceEndpointInstanceID', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the database instance. Call the [DescribeBackupPlanList](~~2869825~~) operation to obtain the value of this parameter.'."\n" + ."\n" + .'> This parameter is required if **SourceEndpoint**.**InstanceType** is set to **RDS**, **ECS**, **DDS**, or **Express**.', + 'type' => 'string', + 'required' => false, + 'example' => 'rm-uf6wjk5*********', + 'title' => '', + ], + ], + [ + 'name' => 'SourceEndpointIP', + 'in' => 'query', + 'schema' => [ + 'description' => 'The database endpoint. Call the [DescribeBackupPlanList](~~2869825~~) operation to obtain the value of this parameter.'."\n" + ."\n" + .'> This parameter is required if **SourceEndpointInstanceType** is set to **express**, **agent**, or **other**.', + 'type' => 'string', + 'required' => false, + 'example' => 'rm-uf6wjk5*******.mysql.rds.aliyuncs.com', + 'title' => '', + ], + ], + [ + 'name' => 'SourceEndpointPort', + 'in' => 'query', + 'schema' => [ + 'description' => 'The database port. Call the [DescribeBackupPlanList](~~2869825~~) operation to obtain the value of this parameter.'."\n" + ."\n" + .'> This parameter is required if **SourceEndpoint**.**InstanceType** is set to **express**, **agent**, **other**, or **ECS**.', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '3306', + 'title' => '', + ], + ], + [ + 'name' => 'SourceEndpointDatabaseName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the database. Call the [DescribeBackupPlanList](~~2869825~~) operation to obtain the value of this parameter.'."\n" + ."\n" + .'> This parameter is required if the database type is **PostgreSQL** or **MongoDB**.', + 'type' => 'string', + 'required' => false, + 'example' => 'testRDS', + 'title' => '', + ], + ], + [ + 'name' => 'SourceEndpointUserName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The database account.'."\n" + ."\n" + .'> This parameter is optional if the database type is Redis, or if **SourceEndpointInstanceType** is **agent** and the database type is **SQL Server**. Otherwise, this parameter is required.', + 'type' => 'string', + 'required' => false, + 'example' => 'testRDS', + 'title' => '', + ], + ], + [ + 'name' => 'SourceEndpointPassword', + 'in' => 'query', + 'schema' => [ + 'description' => 'The password for the database account.'."\n" + ."\n" + .'> This parameter is optional if the database type is Redis, or if **SourceEndpointInstanceType** is **agent** and the database type is **SQL Server**. Otherwise, this parameter is required.', + 'type' => 'string', + 'required' => false, + 'example' => 'testPassword', + 'title' => '', + ], + ], + [ + 'name' => 'BackupGatewayId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the backup gateway. Call the [DescribeBackupPlanList](~~2869825~~) operation to obtain the value of this parameter.'."\n" + ."\n" + .'> This parameter is required if **SourceEndpointInstanceType** is set to **agent**.', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '23313123312', + 'title' => '', + ], + ], + [ + 'name' => 'OSSBucketName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the Object Storage Service (OSS) bucket.'."\n" + ."\n" + .'> The system automatically generates a new name by default.', + 'type' => 'string', + 'required' => false, + 'example' => 'TestOssBucket', + 'title' => '', + ], + ], + [ + 'name' => 'BackupObjects', + 'in' => 'query', + 'schema' => [ + 'description' => 'The backup objects. Call the [DescribeBackupPlanList](~~2869825~~) operation to obtain the value of this parameter.', + 'type' => 'string', + 'required' => false, + 'example' => '[ { "DBName":"待备份库名", "SchemaName":"待备份 Schema 名", "TableIncludes":[{ "TableName":"待备份表表名" }], "TableExcludes":[{ "TableName":"待备份库名不需要备份表的表名" }] } ]', + 'title' => '', + ], + ], + [ + 'name' => 'BackupPeriod', + 'in' => 'query', + 'schema' => [ + 'description' => 'The full backup cycle. Valid values:'."\n" + ."\n" + .'- **Monday**'."\n" + ."\n" + .'- **Tuesday**'."\n" + ."\n" + .'- **Wednesday**'."\n" + ."\n" + .'- **Thursday**'."\n" + ."\n" + .'- **Friday**'."\n" + ."\n" + .'- **Saturday**'."\n" + ."\n" + .'- **Sunday**', + 'type' => 'string', + 'required' => false, + 'example' => 'Monday', + 'title' => '', + ], + ], + [ + 'name' => 'BackupStartTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'The start time for the full backup. The time is in the *HH:mm*Z format (UTC). Call the [DescribeBackupPlanList](~~2869825~~) operation to obtain the value of this parameter.', + 'type' => 'string', + 'required' => false, + 'example' => '14:22', + 'title' => '', + ], + ], + [ + 'name' => 'EnableBackupLog', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to enable incremental log backup. Valid values:'."\n" + ."\n" + .'- **true**: Enable.'."\n" + ."\n" + .'- **false**: Disable.', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + 'title' => '', + ], + ], + [ + 'name' => 'BackupLogIntervalSeconds', + 'in' => 'query', + 'schema' => [ + 'description' => 'The interval for incremental backups, in seconds (s).'."\n" + ."\n" + .'> This parameter is valid only for physical backups.', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1000', + 'title' => '', + ], + ], + [ + 'name' => 'BackupRetentionPeriod', + 'in' => 'query', + 'schema' => [ + 'description' => 'The retention period for backup data, in days. Valid values: 0 to 1825. Default value: 730.', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '730', + 'title' => '', + ], + ], + [ + 'name' => 'DuplicationInfrequentAccessPeriod', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of days after which a backup is converted to Infrequent Access (IA) storage. Default value: 180.', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '180', + 'title' => '', + ], + ], + [ + 'name' => 'DuplicationArchivePeriod', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of days after which a backup is converted to archive storage. Default value: 365.', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '365', + 'title' => '', + ], + ], + [ + 'name' => 'BackupPlanName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The custom name of the backup plan. Call the [DescribeBackupPlanList](~~2869825~~) operation to obtain the value of this parameter.', + 'type' => 'string', + 'required' => true, + 'example' => 'dbstooi0*******', + 'title' => '', + ], + ], + [ + 'name' => 'SourceEndpointOracleSID', + 'in' => 'query', + 'schema' => [ + 'description' => 'The Oracle system ID (SID).'."\n" + ."\n" + .'> This parameter is required if the database type is Oracle.', + 'type' => 'string', + 'required' => false, + 'example' => 'test', + 'title' => '', + ], + ], + [ + 'name' => 'BackupStorageType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The built-in storage type:'."\n" + ."\n" + .'- Empty (default): Backup data is stored in your OSS bucket.'."\n" + ."\n" + .'- system: Backup data is stored in the built-in OSS bucket of DBS.', + 'type' => 'string', + 'required' => false, + 'example' => '无', + 'title' => '', + ], + ], + [ + 'name' => 'BackupSpeedLimit', + 'in' => 'query', + 'schema' => [ + 'description' => 'The disk I/O limit, in KB/s.'."\n" + ."\n" + .'> This parameter is valid only for physical backups of MySQL databases.', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '262144', + 'title' => '', + ], + ], + [ + 'name' => 'BackupRateLimit', + 'in' => 'query', + 'schema' => [ + 'description' => 'The network bandwidth throttling limit, in KB/s. The maximum value is 10 GB.'."\n" + ."\n" + .'> This parameter is valid only for physical backups of MySQL databases.', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '262144', + 'title' => '', + ], + ], + [ + 'name' => 'BackupStrategyType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The backup strategy. Valid values:'."\n" + ."\n" + .'- **simple**: Periodic backup. Use this value with BackupPeriod and BackupStartTime.'."\n" + ."\n" + .'- **manual**: Manual backup.'."\n" + ."\n" + .'> Default value: **simple**.', + 'type' => 'string', + 'required' => false, + 'example' => 'simple', + 'title' => '', + ], + ], + [ + 'name' => 'CrossAliyunId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The UID of the Alibaba Cloud account for cross-account backup. Call the [DescribeRestoreTaskList](~~2869838~~) operation to obtain the value of this parameter.', + 'type' => 'string', + 'required' => false, + 'example' => '2xxx7778xxxxxxxxxx', + 'title' => '', + ], + ], + [ + 'name' => 'CrossRoleName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the Resource Access Management (RAM) role for cross-account backup. Call the [DescribeRestoreTaskList](~~2869838~~) operation to obtain the value of this parameter.', + 'type' => 'string', + 'required' => false, + 'example' => 'test123', + 'title' => '', + ], + ], + [ + 'name' => 'AutoStartBackup', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to enable automatic backup.'."\n" + ."\n" + .'- **true**: Enable.'."\n" + ."\n" + .'- **false**: Disable.', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + 'title' => '', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => 'A client token used to ensure the idempotence of the request. This prevents duplicate requests. The client generates this value, which must be unique among different requests. The value can be up to 64 ASCII characters and cannot contain non-ASCII characters.', + 'type' => 'string', + 'required' => false, + 'example' => 'ETnLKlblzczshOTUbOCzxxxxxxx', + 'title' => '', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The resource group ID.', + 'type' => 'string', + 'required' => false, + 'example' => 'rg-aekzecovzti****', + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The details are as follows.', + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'The HTTP status code.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + 'title' => '', + ], + 'RequestId' => [ + 'description' => 'The request ID.', + 'type' => 'string', + 'example' => 'F1FB49D4-B504-47F1-9F43-D7EAB33F****', + 'title' => '', + ], + 'ErrCode' => [ + 'description' => 'The error code.', + 'type' => 'string', + 'example' => 'Param.NotFound', + 'title' => '', + ], + 'Success' => [ + 'description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'- **true**: The request was successful.'."\n" + ."\n" + .'- **false**: The request failed.', + 'type' => 'boolean', + 'example' => 'true', + 'title' => '', + ], + 'ErrMessage' => [ + 'description' => 'The error message.', + 'type' => 'string', + 'example' => 'The specified parameter %s value is not valid. ', + 'title' => '', + ], + 'BackupPlanId' => [ + 'description' => 'The ID of the backup plan.', + 'type' => 'string', + 'example' => 'dbstooi01ex****', + 'title' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'Request.Forbidden', + 'errorMessage' => 'Have no Permissions', + 'description' => '', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'title' => 'ConfigureBackupPlan', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + [ + 'createdAt' => '2022-07-28T07:13:06.000Z', + 'description' => 'Request parameters changed', + ], + [ + 'createdAt' => '2022-07-12T03:54:11.000Z', + 'description' => 'Error codes changed', + ], + ], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '10', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'ConfigureBackupPlan', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dbs:ConfigureBackupPlan', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DBS', + 'resourceType' => 'BackupPlan', + 'arn' => 'acs:dbs:{#regionId}:{#accountId}:backupplan/{#BackupPlanId}', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"F1FB49D4-B504-47F1-9F43-D7EAB33F****\\",\\n \\"ErrCode\\": \\"Param.NotFound\\",\\n \\"Success\\": true,\\n \\"ErrMessage\\": \\"The specified parameter %s value is not valid. \\",\\n \\"BackupPlanId\\": \\"dbstooi01ex****\\"\\n}","type":"json"}]', + ], + 'CreateAndStartBackupPlan' => [ + 'summary' => 'Creates, configures, and starts a backup plan.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREcbsKR7J6S', + ], + ], + 'parameters' => [ + [ + 'name' => 'BackupPlanId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the backup plan.', + 'type' => 'string', + 'required' => false, + 'example' => 'dbstooi0*******', + 'title' => '', + ], + ], + [ + 'name' => 'Region', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region where DBS is available. To view the available regions, call the [DescribeRegions](~~2869853~~) operation.', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + 'title' => '', + ], + ], + [ + 'name' => 'InstanceClass', + 'in' => 'query', + 'schema' => [ + 'description' => 'The specification of the backup plan. Valid values:'."\n" + ."\n" + .'- **micro**'."\n" + ."\n" + .'- **small**'."\n" + ."\n" + .'- **medium**'."\n" + ."\n" + .'- **large**'."\n" + ."\n" + .'- **xlarge**'."\n" + ."\n" + .'> Higher specifications provide better backup and recovery performance. For more information, see [Specifications](~~84372~~).', + 'type' => 'string', + 'required' => true, + 'example' => 'micro', + 'title' => '', + ], + ], + [ + 'name' => 'DatabaseType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The database type. Valid values:'."\n" + ."\n" + .'- **MySQL**'."\n" + ."\n" + .'- **MSSQL**'."\n" + ."\n" + .'- **Oracle**'."\n" + ."\n" + .'- **MariaDB**'."\n" + ."\n" + .'- **PostgreSQL**'."\n" + ."\n" + .'- **DRDS**'."\n" + ."\n" + .'- **MongoDB**'."\n" + ."\n" + .'- **Redis**', + 'type' => 'string', + 'required' => true, + 'example' => 'MySQL', + 'title' => '', + ], + ], + [ + 'name' => 'BackupMethod', + 'in' => 'query', + 'schema' => [ + 'description' => 'The backup method. Valid values:'."\n" + ."\n" + .'- **logical**: logical backup'."\n" + ."\n" + .'- **physical**: physical backup', + 'type' => 'string', + 'required' => true, + 'example' => 'logical', + 'title' => '', + ], + ], + [ + 'name' => 'Period', + 'in' => 'query', + 'schema' => [ + 'description' => 'The billing cycle of the subscription instance. Valid values:'."\n" + ."\n" + .'- **Year**'."\n" + ."\n" + .'- **Month**', + 'type' => 'string', + 'required' => false, + 'example' => 'Year', + 'title' => '', + ], + ], + [ + 'name' => 'UsedTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'The subscription duration. Valid values:'."\n" + ."\n" + .'- If **Period** is set to **Year**, the value of **UsedTime** can be 1 to 5.'."\n" + ."\n" + .'- If **Period** is set to **Month**, the value of **UsedTime** can be 1 to 11.', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + 'title' => '', + ], + ], + [ + 'name' => 'PayType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The payment method. Valid value:'."\n" + ."\n" + .'**prepay**: subscription', + 'type' => 'string', + 'required' => false, + 'example' => 'postpay', + 'title' => '', + ], + ], + [ + 'name' => 'DatabaseRegion', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region where the database is located.', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + 'title' => '', + ], + ], + [ + 'name' => 'StorageRegion', + 'in' => 'query', + 'schema' => [ + 'description' => 'The storage region.', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + 'title' => '', + ], + ], + [ + 'name' => 'InstanceType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The database instance type. Valid values:'."\n" + ."\n" + .'- **RDS**'."\n" + ."\n" + .'- **PolarDB**'."\n" + ."\n" + .'- **DDS**: Alibaba Cloud MongoDB'."\n" + ."\n" + .'- **Kvstore**: Alibaba Cloud Redis'."\n" + ."\n" + .'- **Other**: A database connected over an IP address and port.'."\n" + ."\n" + .'- **dg**: A self-managed database without a public IP address or port, connected through Database Gateway (DG).', + 'type' => 'string', + 'required' => false, + 'example' => 'RDS', + 'title' => '', + ], + ], + [ + 'name' => 'StorageType', + 'in' => 'query', + 'schema' => [ + 'description' => 'This parameter is not yet available.', + 'type' => 'string', + 'required' => false, + 'example' => '无', + 'title' => '', + ], + ], + [ + 'name' => 'FromApp', + 'in' => 'query', + 'schema' => [ + 'description' => 'The source of the request. The default value is OpenApi. You do not need to set this parameter.', + 'type' => 'string', + 'required' => false, + 'example' => 'OpenApi', + 'title' => '', + ], + ], + [ + 'name' => 'SourceEndpointInstanceType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The location of the database. Valid values:'."\n" + ."\n" + .'- **RDS**'."\n" + ."\n" + .'- **ECS**'."\n" + ."\n" + .'- **Express**: A database connected through a leased line, VPN Gateway, or Smart Access Gateway.'."\n" + ."\n" + .'- **Agent**: A database connected through a backup gateway.'."\n" + ."\n" + .'- **DDS**: Alibaba Cloud MongoDB'."\n" + ."\n" + .'- **Other**: A database connected directly over an IP address and port.'."\n" + ."\n" + .'- **dg**: A self-managed database without a public IP address or port, connected through Database Gateway (DG).', + 'type' => 'string', + 'required' => true, + 'example' => 'RDS', + 'title' => '', + ], + ], + [ + 'name' => 'SourceEndpointRegion', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region where the database is located.'."\n" + ."\n" + .'> This parameter is required if **SourceEndpoint**.**InstanceType** is set to **RDS**, **ECS**, **DDS**, **Express**, or **Agent**.', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + 'title' => '', + ], + ], + [ + 'name' => 'SourceEndpointInstanceID', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the database instance.'."\n" + ."\n" + .'> This parameter is required if **SourceEndpoint**.**InstanceType** is set to **RDS**, **ECS**, **DDS**, or **Express**.', + 'type' => 'string', + 'required' => false, + 'example' => 'rm-uf6wjk5xxxxxxxxxx', + 'title' => '', + ], + ], + [ + 'name' => 'SourceEndpointIP', + 'in' => 'query', + 'schema' => [ + 'description' => 'The database endpoint.'."\n" + ."\n" + .'> This parameter is required if **SourceEndpoint**.**InstanceType** is set to **express**, **agent**, or **other**.', + 'type' => 'string', + 'required' => false, + 'example' => 'rm-uf6wjk5xxxxxxx.mysql.rds.aliyuncs.com', + 'title' => '', + ], + ], + [ + 'name' => 'SourceEndpointPort', + 'in' => 'query', + 'schema' => [ + 'description' => 'The database port.'."\n" + ."\n" + .'> This parameter is required if **SourceEndpoint**.**InstanceType** is set to **express**, **agent**, **other**, or **ECS**.', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '3306', + 'title' => '', + ], + ], + [ + 'name' => 'SourceEndpointDatabaseName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The database name.'."\n" + ."\n" + .'> This parameter is required if the database type is **PostgreSQL** or **MongoDB**.', + 'type' => 'string', + 'required' => false, + 'example' => 'testRDS', + 'title' => '', + ], + ], + [ + 'name' => 'SourceEndpointUserName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The database account.'."\n" + ."\n" + .'> This parameter is optional if the database type is **Redis**, or if the database location is **agent** and the database type is **MSSQL**. In all other cases, this parameter is required.', + 'type' => 'string', + 'required' => false, + 'example' => 'testRDS', + 'title' => '', + ], + ], + [ + 'name' => 'SourceEndpointPassword', + 'in' => 'query', + 'schema' => [ + 'description' => 'The password for the database account.'."\n" + ."\n" + .'> This parameter is optional if the database type is **Redis**, or if the database location is **agent** and the database type is **MSSQL**. In all other cases, this parameter is required.', + 'type' => 'string', + 'required' => false, + 'example' => 'testPassword', + 'title' => '', + ], + ], + [ + 'name' => 'BackupGatewayId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the backup gateway.'."\n" + ."\n" + .'> - This parameter is required if **SourceEndpoint**.**InstanceType** is set to **agent**.'."\n" + .'>'."\n" + .'> - For more information about how to create a backup gateway, see [Add a backup gateway](~~93250~~).'."\n" + .'>'."\n" + .'> - You can call the [DescribeBackupGatewayList](~~2869840~~) operation to view the list of existing backup gateways.', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '23313123312', + 'title' => '', + ], + ], + [ + 'name' => 'OSSBucketName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the Object Storage Service (OSS) bucket.'."\n" + .'Default: The system automatically generates a new name.', + 'type' => 'string', + 'required' => false, + 'example' => 'TestOssBucket', + 'title' => '', + ], + ], + [ + 'name' => 'BackupObjects', + 'in' => 'query', + 'schema' => [ + 'description' => 'The backup objects.', + 'type' => 'string', + 'required' => false, + 'example' => '[ { "DBName":"待备份库名", "SchemaName":"待备份 Schema 名", "TableIncludes":[{ "TableName":"待备份表表名" }], "TableExcludes":[{ "TableName":"待备份库名不需要备份表的表名" }] } ]', + 'title' => '', + ], + ], + [ + 'name' => 'BackupPeriod', + 'in' => 'query', + 'schema' => [ + 'description' => 'The full backup cycle. Valid values:'."\n" + ."\n" + .'- **Monday**'."\n" + ."\n" + .'- **Tuesday**'."\n" + ."\n" + .'- **Wednesday**'."\n" + ."\n" + .'- **Thursday**'."\n" + ."\n" + .'- **Friday**'."\n" + ."\n" + .'- **Saturday**'."\n" + ."\n" + .'- **Sunday**'."\n" + ."\n" + .'> You can select multiple values. Separate them with commas (,).', + 'type' => 'string', + 'required' => false, + 'example' => 'Monday', + 'title' => '', + ], + ], + [ + 'name' => 'BackupStartTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'The start time for the full backup. The time is in the *HH:mm* format and is in UTC.', + 'type' => 'string', + 'required' => false, + 'example' => '14:22', + 'title' => '', + ], + ], + [ + 'name' => 'EnableBackupLog', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to enable incremental log backup. Valid values:'."\n" + ."\n" + .'- **true**'."\n" + ."\n" + .'- **false**', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + 'title' => '', + ], + ], + [ + 'name' => 'BackupLogIntervalSeconds', + 'in' => 'query', + 'schema' => [ + 'description' => 'The interval for incremental backups, in seconds.'."\n" + ."\n" + .'> This parameter is required only for **physical backups**.', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1000', + 'title' => '', + ], + ], + [ + 'name' => 'BackupRetentionPeriod', + 'in' => 'query', + 'schema' => [ + 'description' => 'The retention period for backup data, in days. Valid values: 0 to 1825. Default value: 730.', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '730', + 'title' => '', + ], + ], + [ + 'name' => 'DuplicationInfrequentAccessPeriod', + 'in' => 'query', + 'schema' => [ + 'description' => 'The time after which backup data is converted to Infrequent Access (IA) storage, in days. Default value: 180.', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '180', + 'title' => '', + ], + ], + [ + 'name' => 'DuplicationArchivePeriod', + 'in' => 'query', + 'schema' => [ + 'description' => 'The time after which backup data is converted to archive storage, in days. Default value: 365.', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '365', + 'title' => '', + ], + ], + [ + 'name' => 'BackupPlanName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The custom name of the backup plan.', + 'type' => 'string', + 'required' => true, + 'example' => 'dbstooi0*******', + 'title' => '', + ], + ], + [ + 'name' => 'SourceEndpointOracleSID', + 'in' => 'query', + 'schema' => [ + 'description' => 'The Oracle system ID (SID). This parameter is required if the database type is Oracle.', + 'type' => 'string', + 'required' => false, + 'example' => 'test', + 'title' => '', + ], + ], + [ + 'name' => 'BackupStorageType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The built-in storage type:'."\n" + ."\n" + .'- Empty (default): Backup data is stored in your OSS bucket.'."\n" + ."\n" + .'- system: Backup data is stored in the built-in OSS bucket of DBS.', + 'type' => 'string', + 'required' => false, + 'example' => '无', + 'title' => '', + ], + ], + [ + 'name' => 'BackupSpeedLimit', + 'in' => 'query', + 'schema' => [ + 'description' => 'The disk I/O limit, in KB/s.'."\n" + ."\n" + .'> This parameter is valid only for MySQL physical backups.', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '262144', + 'title' => '', + ], + ], + [ + 'name' => 'BackupRateLimit', + 'in' => 'query', + 'schema' => [ + 'description' => 'The network bandwidth throttling limit, in KB/s. The maximum allowed value is 10 GB.'."\n" + ."\n" + .'> This parameter is valid only for MySQL physical backups.', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '262144', + 'title' => '', + ], + ], + [ + 'name' => 'BackupStrategyType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The full backup strategy. Valid values:'."\n" + ."\n" + .'- **simple**: periodic backup. Use this value with BackupPeriod and BackupStartTime.'."\n" + ."\n" + .'- **manual**: manual backup.'."\n" + ."\n" + .'> The default value is **simple**.', + 'type' => 'string', + 'required' => false, + 'example' => 'simple', + 'title' => '', + ], + ], + [ + 'name' => 'CrossAliyunId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The UID of the Alibaba Cloud account for cross-account backup.', + 'type' => 'string', + 'required' => false, + 'example' => '1648821913******', + 'title' => '', + ], + ], + [ + 'name' => 'CrossRoleName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the RAM role for cross-account backup.', + 'type' => 'string', + 'required' => false, + 'example' => 'test123', + 'title' => '', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => 'A client token used to ensure the idempotence of the request. This prevents duplicate requests.', + 'type' => 'string', + 'required' => false, + 'example' => 'ASDASDASDSADASFCZXVZ', + 'title' => '', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the resource group.', + 'type' => 'string', + 'required' => false, + 'example' => 'rg-aekzecovzti****', + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The response parameters.', + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'The HTTP status code.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + 'title' => '', + ], + 'RequestId' => [ + 'description' => 'The request ID.', + 'type' => 'string', + 'example' => '4F1888AC-1138-4995-B9FE-D2734F61C058', + 'title' => '', + ], + 'CreateBackupSet' => [ + 'description' => 'Indicates whether the backup set is enabled. The return value is one of the following:'."\n" + ."\n" + .'- **true**: Enabled'."\n" + ."\n" + .'- **false**: Disabled', + 'type' => 'boolean', + 'example' => 'true', + 'title' => '', + ], + 'ErrCode' => [ + 'description' => 'The error code.', + 'type' => 'string', + 'example' => 'Param.NotFound', + 'title' => '', + ], + 'Success' => [ + 'description' => 'Indicates whether the request was successful.', + 'type' => 'boolean', + 'example' => 'true', + 'title' => '', + ], + 'ErrMessage' => [ + 'description' => 'The error message.', + 'type' => 'string', + 'example' => 'The specified parameter %s value is not valid.', + 'title' => '', + ], + 'BackupPlanId' => [ + 'description' => 'The ID of the backup plan.', + 'type' => 'string', + 'example' => 'dbs1hvb0wwwe****', + 'title' => '', + ], + 'OrderId' => [ + 'description' => 'The ID of the order.', + 'type' => 'string', + 'example' => '2056157***', + 'title' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'Request.Forbidden', + 'errorMessage' => 'Have no Permissions', + 'description' => '', + ], + ], + ], + 'title' => 'CreateAndStartBackupPlan', + 'description' => 'Before you call this operation, ensure that you understand the [billing methods and pricing](~~70005~~) of Database Backup (DBS).', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + [ + 'createdAt' => '2022-07-28T06:48:28.000Z', + 'description' => 'Request parameters changed', + ], + [ + 'createdAt' => '2022-07-12T03:54:06.000Z', + 'description' => 'Error codes changed', + ], + ], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '10', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'CreateAndStartBackupPlan', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'dbs:CreateAndStartBackupPlan', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DBS', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"4F1888AC-1138-4995-B9FE-D2734F61C058\\",\\n \\"CreateBackupSet\\": true,\\n \\"ErrCode\\": \\"Param.NotFound\\",\\n \\"Success\\": true,\\n \\"ErrMessage\\": \\"The specified parameter %s value is not valid.\\",\\n \\"BackupPlanId\\": \\"dbs1hvb0wwwe****\\",\\n \\"OrderId\\": \\"2056157***\\"\\n}","type":"json"}]', + ], + 'CreateBackupPlan' => [ + 'summary' => 'Creates a Database Backup Service (DBS) backup plan.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREcbsKR7J6S', + ], + ], + 'parameters' => [ + [ + 'name' => 'Region', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID of the DBS instance. This parameter is required. Call the [DescribeRegions](~~2869853~~) operation to view the regions that DBS supports.'."\n" + ."\n" + .'> For more information, see [Endpoints](~~2869810~~).', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + 'title' => '', + ], + ], + [ + 'name' => 'InstanceClass', + 'in' => 'query', + 'schema' => [ + 'description' => 'The instance class. Valid values:'."\n" + ."\n" + .'- **micro**: Entry'."\n" + ."\n" + .'- **small**: Basic'."\n" + ."\n" + .'- **medium**: Standard'."\n" + ."\n" + .'- **large**: Enhanced'."\n" + ."\n" + .'- **xlarge**: Enhanced (no traffic limit)'."\n" + ."\n" + .'> The higher the instance class, the better the performance of backup and recovery. For more information, see [Specifications](~~84372~~).', + 'type' => 'string', + 'required' => true, + 'example' => 'micro', + 'title' => '', + ], + ], + [ + 'name' => 'DatabaseType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The database type. Valid values:'."\n" + ."\n" + .'- **MySQL**'."\n" + ."\n" + .'- **MSSQL**'."\n" + ."\n" + .'- **Oracle**'."\n" + ."\n" + .'- **MariaDB**'."\n" + ."\n" + .'- **PostgreSQL**'."\n" + ."\n" + .'- **DRDS**'."\n" + ."\n" + .'- **MongoDB**'."\n" + ."\n" + .'- **Redis**', + 'type' => 'string', + 'required' => true, + 'example' => 'MySQL', + 'title' => '', + ], + ], + [ + 'name' => 'BackupMethod', + 'in' => 'query', + 'schema' => [ + 'description' => 'The backup method. Valid values:'."\n" + ."\n" + .'- **logical**: logical backup'."\n" + ."\n" + .'- **physical**: physical backup', + 'type' => 'string', + 'required' => true, + 'example' => 'logical', + 'title' => '', + ], + ], + [ + 'name' => 'Period', + 'in' => 'query', + 'schema' => [ + 'description' => 'The billing cycle of the subscription instance. Valid values:'."\n" + ."\n" + .'- **Year**'."\n" + ."\n" + .'- **Month**', + 'type' => 'string', + 'required' => false, + 'example' => 'Month', + 'title' => '', + ], + ], + [ + 'name' => 'UsedTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'The subscription duration. Valid values:'."\n" + ."\n" + .'- If you set the **Period** parameter to **Year**, the value of **UsedTime** can be 1 to 5.'."\n" + ."\n" + .'- If you set the **Period** parameter to **Month**, the value of **UsedTime** can be 1 to 11.', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + 'title' => '', + ], + ], + [ + 'name' => 'PayType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The payment method. Valid value:'."\n" + ."\n" + .'**prepay**: subscription', + 'type' => 'string', + 'required' => false, + 'example' => 'prepay', + 'title' => '', + ], + ], + [ + 'name' => 'DatabaseRegion', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region of the database.', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + 'title' => '', + ], + ], + [ + 'name' => 'StorageRegion', + 'in' => 'query', + 'schema' => [ + 'description' => 'The storage region.', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + 'title' => '', + ], + ], + [ + 'name' => 'InstanceType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The database instance type. Valid values:'."\n" + ."\n" + .'- **RDS**'."\n" + ."\n" + .'- **PolarDB**'."\n" + ."\n" + .'- **DDS**: Alibaba Cloud MongoDB'."\n" + ."\n" + .'- **Kvstore**: Alibaba Cloud Redis'."\n" + ."\n" + .'- **Other**: A database that is connected over the Internet.'."\n" + ."\n" + .'- **dg**: A self-managed database without a public IP address and port that is connected through Database Gateway (DG).', + 'type' => 'string', + 'required' => false, + 'example' => 'RDS', + 'title' => '', + ], + ], + [ + 'name' => 'StorageType', + 'in' => 'query', + 'schema' => [ + 'description' => 'This parameter is not used.', + 'type' => 'string', + 'required' => false, + 'example' => '无', + 'title' => '', + ], + ], + [ + 'name' => 'FromApp', + 'in' => 'query', + 'schema' => [ + 'description' => 'The source of the request. The default value is OpenAPI. You do not need to set this parameter.', + 'type' => 'string', + 'required' => false, + 'example' => 'OpenAPI', + 'title' => '', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => 'A client token that is used to ensure the idempotence of the request.', + 'type' => 'string', + 'required' => false, + 'example' => 'KJSAHKJFHKJSHFKASHFKJADFHKDXXXX', + 'title' => '', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the resource group.', + 'type' => 'string', + 'required' => false, + 'example' => 'rg-aekzecovzti****', + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The response parameters.', + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'The HTTP status code.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + 'title' => '', + ], + 'RequestId' => [ + 'description' => 'The request ID.', + 'type' => 'string', + 'example' => '7BCF6D62-885F-5A4A-91A1-679760E7****', + 'title' => '', + ], + 'ErrCode' => [ + 'description' => 'The error code.', + 'type' => 'string', + 'example' => 'Param.NotFound', + 'title' => '', + ], + 'Success' => [ + 'description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'- **true**: The request was successful.'."\n" + ."\n" + .'- **false**: The request failed.', + 'type' => 'boolean', + 'example' => 'true', + 'title' => '', + ], + 'ErrMessage' => [ + 'description' => 'The error message.', + 'type' => 'string', + 'example' => 'The specified parameter %s value is not valid.', + 'title' => '', + ], + 'BackupPlanId' => [ + 'description' => 'The backup plan ID.', + 'type' => 'string', + 'example' => 'dbsrhahrsu2****', + 'title' => '', + ], + 'OrderId' => [ + 'description' => 'The order ID.', + 'type' => 'string', + 'example' => '21437345592****', + 'title' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'Request.Forbidden', + 'errorMessage' => 'Have no Permissions', + 'description' => '', + ], + ], + ], + 'title' => 'CreateBackupPlan', + 'description' => 'To perform this operation in the console, see [Purchase a backup plan](~~65909~~).', + 'changeSet' => [ + [ + 'createdAt' => '2022-07-28T06:48:28.000Z', + 'description' => 'Request parameters changed', + ], + [ + 'createdAt' => '2022-07-12T03:54:06.000Z', + 'description' => 'Error codes changed', + ], + ], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '10', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'CreateBackupPlan', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'dbs:CreateBackupPlan', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DBS', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"7BCF6D62-885F-5A4A-91A1-679760E7****\\",\\n \\"ErrCode\\": \\"Param.NotFound\\",\\n \\"Success\\": true,\\n \\"ErrMessage\\": \\"The specified parameter %s value is not valid.\\",\\n \\"BackupPlanId\\": \\"dbsrhahrsu2****\\",\\n \\"OrderId\\": \\"21437345592****\\"\\n}","type":"json"}]', + ], + 'CreateFullBackupSetDownload' => [ + 'summary' => 'This operation creates a task to download a full backup set.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREcbsKR7J6S', + ], + ], + 'parameters' => [ + [ + 'name' => 'BackupSetId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the full backup set.', + 'type' => 'string', + 'required' => true, + 'example' => 'dbs1hvXXXXX', + 'title' => '', + ], + ], + [ + 'name' => 'BackupSetDataFormat', + 'in' => 'query', + 'schema' => [ + 'description' => 'The format of the downloaded full backup set. Valid values:'."\n" + ."\n" + .'- **Native**'."\n" + ."\n" + .'- **SQL**'."\n" + ."\n" + .'- **CSV**'."\n" + ."\n" + .'- **JSON**'."\n" + ."\n" + .'> The default value is CSV.', + 'type' => 'string', + 'required' => false, + 'example' => 'SQL', + 'title' => '', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => 'A client token used to ensure the idempotence of the request. This prevents the same request from being sent multiple times.', + 'type' => 'string', + 'required' => false, + 'example' => 'ETnLKlblzczshOTUbOCzxxxxxxx', + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'The HTTP status code.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + 'title' => '', + ], + 'RequestId' => [ + 'description' => 'The request ID.', + 'type' => 'string', + 'example' => 'D6E068C3-25BC-455A-85FE-45F0B22ECB1F', + 'title' => '', + ], + 'ErrCode' => [ + 'description' => 'The error code.', + 'type' => 'string', + 'example' => 'Param.NotFound', + 'title' => '', + ], + 'Success' => [ + 'description' => 'Indicates whether the request was successful.', + 'type' => 'boolean', + 'example' => 'true', + 'title' => '', + ], + 'ErrMessage' => [ + 'description' => 'The error message.', + 'type' => 'string', + 'example' => 'The specified parameter %s value is not valid. ', + 'title' => '', + ], + 'BackupSetDownloadTaskId' => [ + 'description' => 'The ID of the backup set download task.', + 'type' => 'string', + 'example' => 'dbstooi01exxxxx', + 'title' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'Request.Forbidden', + 'errorMessage' => 'Have no Permissions', + 'description' => '', + ], + ], + ], + 'title' => 'CreateFullBackupSetDownload', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + [ + 'createdAt' => '2022-07-12T03:54:06.000Z', + 'description' => 'Error codes changed', + ], + ], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '10', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'CreateFullBackupSetDownload', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'dbs:CreateFullBackupSetDownload', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DBS', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"D6E068C3-25BC-455A-85FE-45F0B22ECB1F\\",\\n \\"ErrCode\\": \\"Param.NotFound\\",\\n \\"Success\\": true,\\n \\"ErrMessage\\": \\"The specified parameter %s value is not valid. \\",\\n \\"BackupSetDownloadTaskId\\": \\"dbstooi01exxxxx\\"\\n}","type":"json"}]', + ], + 'CreateGetDBListFromAgentTask' => [ + 'summary' => 'Creates a task to obtain a database list by using a backup gateway.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREcbsKR7J6S', + ], + ], + 'parameters' => [ + [ + 'name' => 'BackupGatewayId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the backup gateway. You can call the [DescribeBackupPlanList](~~2869825~~) operation to query the ID.'."\n" + ."\n" + .'> This parameter is required.', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '160813', + 'title' => '', + ], + ], + [ + 'name' => 'DatabaseType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of the database. Valid values:'."\n" + ."\n" + .'- **MySQL**'."\n" + ."\n" + .'- **MSSQL**'."\n" + ."\n" + .'- **Oracle**'."\n" + ."\n" + .'- **MariaDB**'."\n" + ."\n" + .'- **PostgreSQL**'."\n" + ."\n" + .'- **DRDS**'."\n" + ."\n" + .'- **MongoDB**'."\n" + ."\n" + .'- **Redis**', + 'type' => 'string', + 'required' => false, + 'example' => 'MySQL', + 'title' => '', + ], + ], + [ + 'name' => 'SourceEndpointRegion', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region in which the backup gateway resides.', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + 'title' => '', + ], + ], + [ + 'name' => 'SourceEndpointIP', + 'in' => 'query', + 'schema' => [ + 'description' => 'The URL that is used to access the database.', + 'type' => 'string', + 'required' => false, + 'example' => '123.0.XX.XX', + 'title' => '', + ], + ], + [ + 'name' => 'SourceEndpointPort', + 'in' => 'query', + 'schema' => [ + 'description' => 'The port that is used to connect to the database.', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '3306', + 'title' => '', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + '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 sure that it is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length.', + 'type' => 'string', + 'required' => false, + 'example' => 'ETnLKlblzczshOTUbOCzxxxxxxxxxx', + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'The HTTP status code returned.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '400', + 'title' => '', + ], + 'RequestId' => [ + 'description' => 'The request ID.', + 'type' => 'string', + 'example' => 'EB4DFD5E-3618-498D-BE35-4DBEA0072122', + 'title' => '', + ], + 'ErrCode' => [ + 'description' => 'The error code.', + 'type' => 'string', + 'example' => 'InvalidParameter', + 'title' => '', + ], + 'Success' => [ + 'description' => 'Indicates whether the request was successful.', + 'type' => 'boolean', + 'example' => 'true', + 'title' => '', + ], + 'ErrMessage' => [ + 'description' => 'The error message.', + 'type' => 'string', + 'example' => 'This backupPlan can\'t support this action', + 'title' => '', + ], + 'TaskId' => [ + 'description' => 'The ID of the asynchronous task.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '123456', + 'title' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'Request.Forbidden', + 'errorMessage' => 'Have no Permissions', + 'description' => '', + ], + ], + ], + 'title' => 'CreateGetDBListFromAgentTask', + 'description' => 'This API operation returns a task ID. You can call the [GetDBListFromAgent](~~2869852~~) operation to query the task result based on the task ID.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + [ + 'createdAt' => '2022-07-12T03:54:06.000Z', + 'description' => 'Error codes changed', + ], + ], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '100', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'CreateGetDBListFromAgentTask', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'dbs:CreateGetDBListFromAgentTask', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DBS', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 400,\\n \\"RequestId\\": \\"EB4DFD5E-3618-498D-BE35-4DBEA0072122\\",\\n \\"ErrCode\\": \\"InvalidParameter\\",\\n \\"Success\\": true,\\n \\"ErrMessage\\": \\"This backupPlan can\'t support this action\\",\\n \\"TaskId\\": 123456\\n}","type":"json"}]', + ], + 'CreateIncrementBackupSetDownload' => [ + 'summary' => 'Creates and starts an incremental backup set download task.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREcbsKR7J6S', + ], + ], + 'parameters' => [ + [ + 'name' => 'BackupSetId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the incremental backup task. To obtain the task ID, you can call the [DescribeIncrementBackupList](~~2869833~~) operation and view the value of the **BackupSetJobId** parameter in the response.', + 'type' => 'string', + 'required' => true, + 'example' => 't4yh0g0g****', + 'title' => '', + ], + ], + [ + 'name' => 'BackupSetName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the incremental backup set. To obtain the backup set ID, you can call the [DescribeIncrementBackupList](~~2869833~~) operation and view the value of the **BackupSetId** parameter in the response.', + 'type' => 'string', + 'required' => true, + 'example' => 'mysql-bin.000054', + 'title' => '', + ], + ], + [ + 'name' => 'BackupSetDataFormat', + 'in' => 'query', + 'schema' => [ + 'description' => 'The format in which the incremental backup set is downloaded. Valid values:'."\n" + ."\n" + .'- **Native**'."\n" + ."\n" + .'- **SQL**'."\n" + ."\n" + .'- **CSV**'."\n" + ."\n" + .'- **JSON**'."\n" + ."\n" + .'> Default value: Native.', + 'type' => 'string', + 'required' => false, + 'example' => 'Native', + 'title' => '', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => 'The client token that is used to ensure the idempotence of the request.', + 'type' => 'string', + 'required' => false, + 'example' => 'ETnLKlblzczshOTUbOCz********', + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'The HTTP status code.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + 'title' => '', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.', + 'type' => 'string', + 'example' => 'D6E068C3-25BC-455A-85FE-45F0B22ECB1F', + 'title' => '', + ], + 'ErrCode' => [ + 'description' => 'The error code.', + 'type' => 'string', + 'example' => 'Param.NotFound', + 'title' => '', + ], + 'Success' => [ + 'description' => 'Indicates whether the request is successful.', + 'type' => 'boolean', + 'example' => 'true', + 'title' => '', + ], + 'ErrMessage' => [ + 'description' => 'The error message.', + 'type' => 'string', + 'example' => 'The specified parameter %s value is not valid. ', + 'title' => '', + ], + 'BackupSetDownloadTaskId' => [ + 'description' => 'The ID of the backup set download task.', + 'type' => 'string', + 'example' => '1jydacm******', + 'title' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'Request.Forbidden', + 'errorMessage' => 'Have no Permissions', + 'description' => '', + ], + ], + ], + 'title' => 'CreateIncrementBackupSetDownload', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + [ + 'createdAt' => '2022-07-12T03:54:06.000Z', + 'description' => 'Error codes changed', + ], + ], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '10', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'CreateIncrementBackupSetDownload', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'dbs:CreateIncrementBackupSetDownload', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DBS', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"D6E068C3-25BC-455A-85FE-45F0B22ECB1F\\",\\n \\"ErrCode\\": \\"Param.NotFound\\",\\n \\"Success\\": true,\\n \\"ErrMessage\\": \\"The specified parameter %s value is not valid. \\",\\n \\"BackupSetDownloadTaskId\\": \\"1jydacm******\\"\\n}","type":"json"}]', + ], + 'CreateRestoreTask' => [ + 'summary' => 'Creates a Database Backup Service (DBS) restore job.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREcbsKR7J6S', + ], + ], + 'parameters' => [ + [ + 'name' => 'BackupPlanId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the backup plan.', + 'type' => 'string', + 'required' => true, + 'example' => 'dbs1hvb0ww****', + 'title' => '', + ], + ], + [ + 'name' => 'DestinationEndpointInstanceType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The location of the database. Valid values:'."\n" + ."\n" + .'- **RDS**'."\n" + ."\n" + .'- **ECS**'."\n" + ."\n" + .'- **Express**: a database connected over a leased line, VPN Gateway, or Smart Access Gateway.'."\n" + ."\n" + .'- **Agent**: a database connected using a backup gateway.'."\n" + ."\n" + .'- **DDS**: an ApsaraDB for MongoDB instance.'."\n" + ."\n" + .'- **Other**: a database connected over the Internet.'."\n" + ."\n" + .'- **dg**: a self-managed database without a public IP address or port that is connected through Database Gateway (DG).', + 'type' => 'string', + 'required' => true, + 'example' => 'RDS', + 'title' => '', + ], + ], + [ + 'name' => 'DestinationEndpointRegion', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region of the database instance.'."\n" + ."\n" + .'> This parameter is required when **DestinationEndpointInstanceType** is set to RDS, ECS, DDS, Express, or Agent.', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + 'title' => '', + ], + ], + [ + 'name' => 'DestinationEndpointInstanceID', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the database instance.'."\n" + ."\n" + .'> This parameter is required when **DestinationEndpointInstanceType** is set to RDS, ECS, DDS, or Express.', + 'type' => 'string', + 'required' => false, + 'example' => 'rm-bp1p8c29*****', + 'title' => '', + ], + ], + [ + 'name' => 'DestinationEndpointIP', + 'in' => 'query', + 'schema' => [ + 'description' => 'The database endpoint.'."\n" + ."\n" + .'> This parameter is required when **DestinationEndpointInstanceType** is set to express, agent, or other.', + 'type' => 'string', + 'required' => false, + 'example' => 'rm-bp*****9jv8pxero.mysql.rds.aliyuncs.com', + 'title' => '', + ], + ], + [ + 'name' => 'DestinationEndpointPort', + 'in' => 'query', + 'schema' => [ + 'description' => 'The database port.'."\n" + ."\n" + .'> This parameter is required when **DestinationEndpointInstanceType** is set to express, agent, other, or ECS.', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '3306', + 'title' => '', + ], + ], + [ + 'name' => 'DestinationEndpointDatabaseName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The database name.'."\n" + ."\n" + .'> This parameter is required if the database is a PostgreSQL or MongoDB database.', + 'type' => 'string', + 'required' => false, + 'example' => 'test', + 'title' => '', + ], + ], + [ + 'name' => 'DestinationEndpointUserName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The database account.'."\n" + ."\n" + .'> This parameter is optional for Redis databases, and for MSSQL databases when DestinationEndpointInstanceType is set to agent. For all other scenarios, this parameter is required.', + 'type' => 'string', + 'required' => false, + 'example' => 'test', + 'title' => '', + ], + ], + [ + 'name' => 'DestinationEndpointPassword', + 'in' => 'query', + 'schema' => [ + 'description' => 'The password.'."\n" + ."\n" + .'> This parameter is optional for Redis databases, and for MSSQL databases when DestinationEndpointInstanceType is set to agent. For all other scenarios, this parameter is required.', + 'type' => 'string', + 'required' => false, + 'example' => 'Test', + 'title' => '', + ], + ], + [ + 'name' => 'BackupGatewayId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the backup gateway.'."\n" + ."\n" + .'> This parameter is required when **DestinationEndpointInstanceType** is set to agent.', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '4312****', + 'title' => '', + ], + ], + [ + 'name' => 'RestoreObjects', + 'in' => 'query', + 'schema' => [ + 'description' => 'The objects to restore.'."\n" + ."\n" + .'- For more information, see the definition of the RestoreObjects parameter below. This parameter is optional when **DestinationEndpointInstanceType** is set to agent. For all other scenarios, this parameter is required.'."\n" + ."\n" + .'- Template: `[{ "DBName": "source_database_name", "NewDBName": "destination_database_name" }]`'."\n" + ."\n" + .'> This API operation only supports database-level restore. To restore specific tables, use the console. For more information, see [Restore a database](~~85543~~).', + 'type' => 'string', + 'required' => false, + 'example' => 'MySQL表级别恢复示例如下：'."\n" + .'[{\\"DBName\\":\\"dbname\\", \\"NewDBName\\":\\"dbname1\\"}]', + 'title' => '', + ], + ], + [ + 'name' => 'RestoreTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'The restore time. Example: 1554560477000.', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1554560477000', + 'title' => '', + ], + ], + [ + 'name' => 'BackupSetId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the full backup set used for the restore. This parameter is mutually exclusive with RestoreTime.', + 'type' => 'string', + 'required' => false, + 'example' => 'dbs1hvb0w*****', + 'title' => '', + ], + ], + [ + 'name' => 'RestoreTaskName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the restore job.', + 'type' => 'string', + 'required' => true, + 'example' => 'test', + 'title' => '', + ], + ], + [ + 'name' => 'DestinationEndpointOracleSID', + 'in' => 'query', + 'schema' => [ + 'description' => 'The Oracle system ID (SID).'."\n" + ."\n" + .'> This parameter is required if the database is an Oracle database.', + 'type' => 'string', + 'required' => false, + 'example' => 'test', + 'title' => '', + ], + ], + [ + 'name' => 'RestoreDir', + 'in' => 'query', + 'schema' => [ + 'description' => 'This parameter is required when **DestinationEndpointInstanceType** is set to agent and the backup schedule is for a MySQL database.', + 'type' => 'string', + 'required' => false, + 'example' => 'test', + 'title' => '', + ], + ], + [ + 'name' => 'RestoreHome', + 'in' => 'query', + 'schema' => [ + 'description' => 'The database program folder.', + 'type' => 'string', + 'required' => false, + 'example' => 'test', + 'title' => '', + ], + ], + [ + 'name' => 'DuplicateConflict', + 'in' => 'query', + 'schema' => [ + 'description' => 'The policy for handling conflicts with objects that have the same name. Currently, only the following value is supported:'."\n" + ."\n" + .'**renamenew**: Renames the object if a conflict occurs.', + 'type' => 'string', + 'required' => false, + 'example' => 'renamenew', + 'title' => '', + ], + ], + [ + 'name' => 'CrossAliyunId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The UID of the Alibaba Cloud account for cross-account backup.', + 'type' => 'string', + 'required' => false, + 'example' => '2749528728********', + 'title' => '', + ], + ], + [ + 'name' => 'CrossRoleName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the RAM role for cross-account backup.', + 'type' => 'string', + 'required' => false, + 'example' => 'test123', + 'title' => '', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => 'A client token to ensure the idempotence of the request. This prevents duplicate submissions.', + 'type' => 'string', + 'required' => false, + 'example' => 'ETnLKlblzczshOTUbOC********', + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The response parameters.', + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'The HTTP status code.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + 'title' => '', + ], + 'RequestId' => [ + 'description' => 'The request ID.', + 'type' => 'string', + 'example' => '60AF7C5D-EF4D-4D48-8FD5-C0823FDF28AC', + 'title' => '', + ], + 'ErrCode' => [ + 'description' => 'The error code.', + 'type' => 'string', + 'example' => 'Param.NotFound', + 'title' => '', + ], + 'Success' => [ + 'description' => 'Indicates whether the request was successful.', + 'type' => 'boolean', + 'example' => 'true', + 'title' => '', + ], + 'ErrMessage' => [ + 'description' => 'The error message.', + 'type' => 'string', + 'example' => 'The specified parameter %s value is not valid. ', + 'title' => '', + ], + 'RestoreTaskId' => [ + 'description' => 'The ID of the restore job.', + 'type' => 'string', + 'example' => 's102h*****', + 'title' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'Request.Forbidden', + 'errorMessage' => 'Have no Permissions', + 'description' => '', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'title' => 'CreateRestoreTask', + 'description' => '### Related documents'."\n" + ."\n" + .'- [Restore a database](~~85543~~)'."\n" + ."\n" + .'- [Tutorials for database restore configuration](~~197144~~)', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + [ + 'createdAt' => '2022-07-12T03:54:06.000Z', + 'description' => 'Error codes changed', + ], + ], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '10000', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'CreateRestoreTask', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'dbs:CreateRestoreTask', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DBS', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"60AF7C5D-EF4D-4D48-8FD5-C0823FDF28AC\\",\\n \\"ErrCode\\": \\"Param.NotFound\\",\\n \\"Success\\": true,\\n \\"ErrMessage\\": \\"The specified parameter %s value is not valid. \\",\\n \\"RestoreTaskId\\": \\"s102h*****\\"\\n}","type":"json"}]', + ], + 'DescribeBackupGatewayList' => [ + 'summary' => 'Queries a list of backup gateways in Database Backup Service (DBS).', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREcbsKR7J6S', + ], + ], + 'parameters' => [ + [ + 'name' => 'Region', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region of the DBS instance. Valid values:'."\n" + ."\n" + .'- **cn-hangzhou**: China (Hangzhou)'."\n" + ."\n" + .'- **cn-shanghai**: China (Shanghai)'."\n" + ."\n" + .'- **cn-qingdao**: China (Qingdao)'."\n" + ."\n" + .'- **cn-beijing**: China (Beijing)'."\n" + ."\n" + .'- **cn-shenzhen**: China (Shenzhen)'."\n" + ."\n" + .'- **cn-hongkong**: China (Hong Kong)'."\n" + ."\n" + .'- **ap-southeast-1**: Singapore'."\n" + ."\n" + .'- **cn-hangzhou-finance**: Hangzhou Finance Cloud'."\n" + ."\n" + .'- **cn-shanghai-finance**: Shanghai Finance Cloud'."\n" + ."\n" + .'- **cn-shenzhen-finance**: Shenzhen Finance Cloud', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + 'title' => '', + ], + ], + [ + 'name' => 'Identifier', + 'in' => 'query', + 'schema' => [ + 'description' => 'The unique identifier of the backup gateway. You can query multiple gateways by separating the identifiers with commas (,).', + 'type' => 'string', + 'required' => false, + 'example' => '7213527653217', + 'title' => '', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of records on each page. Valid values:'."\n" + ."\n" + .'- **30**'."\n" + ."\n" + .'- **50**'."\n" + ."\n" + .'- **100**'."\n" + ."\n" + .'> The default value is 30.', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '30', + 'title' => '', + ], + ], + [ + 'name' => 'PageNum', + 'in' => 'query', + 'schema' => [ + '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.', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + 'title' => '', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => 'A client token used to ensure the idempotence of the request. This prevents duplicate requests.', + 'type' => 'string', + 'required' => false, + 'example' => 'ETnLKlblzczshOTUbOCzxxxxxxx', + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'The HTTP status code.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + 'title' => '', + ], + 'PageNum' => [ + 'description' => 'The page number.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + 'title' => '', + ], + 'RequestId' => [ + 'description' => 'The request ID.', + 'type' => 'string', + 'example' => '46361705-8531-492F-807E-A97E482DD4A1', + 'title' => '', + ], + 'ErrCode' => [ + 'description' => 'The error code.', + 'type' => 'string', + 'example' => 'Param.NotFound', + 'title' => '', + ], + 'Success' => [ + 'description' => 'Indicates whether the request was successful.', + 'type' => 'boolean', + 'example' => 'true', + 'title' => '', + ], + 'ErrMessage' => [ + 'description' => 'The error message.', + 'type' => 'string', + 'example' => 'The specified parameter %s value is not valid. ', + 'title' => '', + ], + 'TotalPages' => [ + 'description' => 'The total number of pages.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + 'title' => '', + ], + 'TotalElements' => [ + 'description' => 'The total number of backup gateways.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + 'title' => '', + ], + 'PageSize' => [ + 'description' => 'The number of records on each page.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '30', + 'title' => '', + ], + 'Items' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'BackupGateway' => [ + 'description' => 'The details of the backup gateway.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'DisplayName' => [ + 'description' => 'The display name of the backup gateway.', + 'type' => 'string', + 'example' => 'test', + 'title' => '', + ], + 'BackupGatewayCreateTime' => [ + 'description' => 'The time when the backup gateway was created. This is a UNIX timestamp in milliseconds. Example: 1554560477000.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1554560477000', + 'title' => '', + ], + 'BackupGatewayId' => [ + 'description' => 'The ID of the backup gateway.', + 'type' => 'string', + 'example' => '2321313123', + 'title' => '', + ], + 'Region' => [ + 'description' => 'The region.', + 'type' => 'string', + 'example' => 'cn-hangzhou', + 'title' => '', + ], + 'Identifier' => [ + 'description' => 'The unique identifier of the backup gateway.', + 'type' => 'string', + 'example' => 'sgdsajhdgu', + 'title' => '', + ], + 'SourceEndpointInternetIP' => [ + 'description' => 'The public IP address of the host where the backup gateway is installed.', + 'type' => 'string', + 'example' => 'XX.XX.XX.XX', + 'title' => '', + ], + 'BackupGatewayStatus' => [ + 'description' => 'The status of the backup gateway. Valid values:'."\n" + ."\n" + .'- ONLINE: The gateway is online.'."\n" + ."\n" + .'- OFFLINE: The gateway is offline.'."\n" + ."\n" + .'- STOPPED: The gateway is stopped.'."\n" + ."\n" + .'- UPGRADING: The gateway is being upgraded.', + 'type' => 'string', + 'example' => 'ONLINE', + 'title' => '', + ], + 'SourceEndpointIntranetIP' => [ + 'description' => 'The internal IP address of the host where the backup gateway is installed.', + 'type' => 'string', + 'example' => 'XX.XX.XX.XX', + 'title' => '', + ], + 'LastHeartbeatTime' => [ + 'description' => 'The time of the last heartbeat. This is a UNIX timestamp in milliseconds. Example: 1554560477000.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1554560477000', + 'title' => '', + ], + 'SourceEndpointHostname' => [ + 'description' => 'The hostname of the host where the backup gateway is installed.', + 'type' => 'string', + 'example' => 'test', + 'title' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'Request.Forbidden', + 'errorMessage' => 'Have no Permissions', + 'description' => '', + ], + ], + ], + 'title' => 'DescribeBackupGatewayList', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + [ + 'createdAt' => '2022-07-12T03:54:06.000Z', + 'description' => 'Error codes changed', + ], + ], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '100', + 'countWindow' => 60, + 'regionId' => '*', + 'api' => 'DescribeBackupGatewayList', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dbs:DescribeBackupGatewayList', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DBS', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"PageNum\\": 1,\\n \\"RequestId\\": \\"46361705-8531-492F-807E-A97E482DD4A1\\",\\n \\"ErrCode\\": \\"Param.NotFound\\",\\n \\"Success\\": true,\\n \\"ErrMessage\\": \\"The specified parameter %s value is not valid. \\",\\n \\"TotalPages\\": 1,\\n \\"TotalElements\\": 0,\\n \\"PageSize\\": 30,\\n \\"Items\\": {\\n \\"BackupGateway\\": [\\n {\\n \\"DisplayName\\": \\"test\\",\\n \\"BackupGatewayCreateTime\\": 1554560477000,\\n \\"BackupGatewayId\\": \\"2321313123\\",\\n \\"Region\\": \\"cn-hangzhou\\",\\n \\"Identifier\\": \\"sgdsajhdgu\\",\\n \\"SourceEndpointInternetIP\\": \\"XX.XX.XX.XX\\",\\n \\"BackupGatewayStatus\\": \\"ONLINE\\",\\n \\"SourceEndpointIntranetIP\\": \\"XX.XX.XX.XX\\",\\n \\"LastHeartbeatTime\\": 1554560477000,\\n \\"SourceEndpointHostname\\": \\"test\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + ], + 'DescribeBackupPlanBilling' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREcbsKR7J6S', + ], + ], + 'parameters' => [ + [ + 'name' => 'BackupPlanId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the backup plan. Call the [DescribeBackupPlanList](~~2869825~~) operation to obtain the value of this parameter.', + 'type' => 'string', + 'required' => true, + 'example' => 'dbstooi01ex****', + 'title' => '', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => 'A client token to ensure the idempotence of the request. The client generates this value. It must be unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length.', + 'type' => 'string', + 'required' => false, + 'example' => 'ETnLKlblzczshOTUbOCzxxxxxxxxxx', + 'title' => '', + ], + ], + [ + 'name' => 'ShowStorageType', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to display the storage class.', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'The HTTP status code.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '400', + 'title' => '', + ], + 'RequestId' => [ + 'description' => 'The request ID.', + 'type' => 'string', + 'example' => 'DD7BC7F5-4E3A-5DF3-BFF9-831503C4D9E3', + 'title' => '', + ], + 'ErrCode' => [ + 'description' => 'The error code.', + 'type' => 'string', + 'example' => 'InvalidParameter', + 'title' => '', + ], + 'Success' => [ + 'description' => 'Indicates whether the request is successful.', + 'type' => 'boolean', + 'example' => 'true', + 'title' => '', + ], + 'ErrMessage' => [ + 'description' => 'The error message.', + 'type' => 'string', + 'example' => 'This backupPlan can\'t support this action', + 'title' => '', + ], + 'Item' => [ + 'description' => 'The billing information of the backup plan.', + 'type' => 'object', + 'properties' => [ + 'BuyCreateTimestamp' => [ + 'description' => 'The timestamp that indicates when the instance was purchased.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1658372830000', + 'title' => '', + ], + 'FullStorageSize' => [ + 'description' => 'The storage space used by full backup data. Unit: bytes.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '151', + 'title' => '', + ], + 'BuyExpiredTimestamp' => [ + 'description' => 'The timestamp that indicates when the instance expires.'."\n" + ."\n" + .'> This parameter is returned only when BuyChargeType is set to PREPAY.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1661097600000', + 'title' => '', + ], + 'BuySpec' => [ + 'description' => 'The instance type.', + 'type' => 'string', + 'example' => 'micro', + 'title' => '', + ], + 'QuotaEndTimestamp' => [ + 'description' => 'The timestamp that indicates the end of the billing cycle for the free backup traffic.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1659283200000', + 'title' => '', + ], + 'IsExpired' => [ + 'description' => 'Indicates whether the instance has expired.'."\n" + ."\n" + .'> This parameter is returned only when BuyChargeType is set to PREPAY.', + 'type' => 'boolean', + 'example' => 'true', + 'title' => '', + ], + 'QuotaStartTimestamp' => [ + 'description' => 'The timestamp that indicates the start of the billing cycle for the free backup traffic.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1656604800000', + 'title' => '', + ], + 'TotalFreeBytes' => [ + 'description' => 'The total free backup traffic in the current month. Unit: bytes.'."\n" + ."\n" + .'> This parameter is returned only when BuyChargeType is set to PREPAY and IsFreeBytesUnlimited is false.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '858993459200', + 'title' => '', + ], + 'PaiedBytes' => [ + 'description' => 'The total paid backup traffic in the current month. Unit: bytes.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + 'title' => '', + ], + 'UsedFullBytes' => [ + 'description' => 'The paid traffic for full backups in the current month. Unit: bytes.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + 'title' => '', + ], + 'IsFreeBytesUnlimited' => [ + 'description' => 'Indicates whether the instance provides unlimited free backup traffic.', + 'type' => 'boolean', + 'example' => 'true', + 'title' => '', + ], + 'ContStorageSize' => [ + 'description' => 'The storage space used by incremental backup data. Unit: bytes.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10437039', + 'title' => '', + ], + 'BuyChargeType' => [ + 'description' => 'The billing method of the instance. Valid values:'."\n" + ."\n" + .'- **PREPAY**: subscription'."\n" + ."\n" + .'- **POSTPAY**: pay-as-you-go', + 'type' => 'string', + 'example' => 'PREPAY', + 'title' => '', + ], + 'UsedIncrementBytes' => [ + 'description' => 'The paid traffic for incremental backups in the current month. Unit: bytes.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '9406734', + 'title' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'Request.Forbidden', + 'errorMessage' => 'Have no Permissions', + 'description' => '', + ], + ], + ], + 'title' => 'DescribeBackupPlanBilling', + 'summary' => 'This operation queries the billing information of a backup plan.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + [ + 'createdAt' => '2022-08-18T07:56:56.000Z', + 'description' => 'Response parameters changed', + ], + [ + 'createdAt' => '2022-07-28T06:48:28.000Z', + 'description' => 'Response parameters changed', + ], + [ + 'createdAt' => '2022-07-12T03:54:06.000Z', + 'description' => 'Error codes changed', + ], + ], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '100', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'DescribeBackupPlanBilling', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dbs:DescribeBackupPlanBilling', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DBS', + 'resourceType' => 'BackupPlan', + 'arn' => 'acs:dbs:{#regionId}:{#accountId}:backupplan/{#BackupPlanId}', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 400,\\n \\"RequestId\\": \\"DD7BC7F5-4E3A-5DF3-BFF9-831503C4D9E3\\",\\n \\"ErrCode\\": \\"InvalidParameter\\",\\n \\"Success\\": true,\\n \\"ErrMessage\\": \\"This backupPlan can\'t support this action\\",\\n \\"Item\\": {\\n \\"BuyCreateTimestamp\\": 1658372830000,\\n \\"FullStorageSize\\": 151,\\n \\"BuyExpiredTimestamp\\": 1661097600000,\\n \\"BuySpec\\": \\"micro\\",\\n \\"QuotaEndTimestamp\\": 1659283200000,\\n \\"IsExpired\\": true,\\n \\"QuotaStartTimestamp\\": 1656604800000,\\n \\"TotalFreeBytes\\": 858993459200,\\n \\"PaiedBytes\\": 0,\\n \\"UsedFullBytes\\": 0,\\n \\"IsFreeBytesUnlimited\\": true,\\n \\"ContStorageSize\\": 10437039,\\n \\"BuyChargeType\\": \\"PREPAY\\",\\n \\"UsedIncrementBytes\\": 9406734\\n }\\n}","type":"json"}]', + ], + 'DescribeBackupPlanList' => [ + 'summary' => 'Queries the details of one or more DBS backup plans.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREcbsKR7J6S', + ], + ], + 'parameters' => [ + [ + 'name' => 'BackupPlanId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the backup plan. To query multiple backup plans, separate the IDs with commas (,).', + 'type' => 'string', + 'required' => false, + 'example' => 'dbstooi01exXXXX', + 'title' => '', + ], + ], + [ + 'name' => 'Region', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID of the DBS instance. To view the supported regions, call the [DescribeRegions](~~2869853~~) operation.', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + 'title' => '', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of entries to return on each page. Valid values: 1 to 100.'."\n" + ."\n" + .'> Default value: **30**.', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '30', + 'title' => '', + ], + ], + [ + 'name' => 'PageNum', + 'in' => 'query', + 'schema' => [ + 'description' => 'The page number to return. The value must be an integer that is greater than or equal to 0. Default value: 0.', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + 'title' => '', + ], + ], + [ + 'name' => 'BackupPlanName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the backup plan.', + 'type' => 'string', + 'required' => false, + 'example' => 'test123', + 'title' => '', + ], + ], + [ + 'name' => 'BackupPlanStatus', + 'in' => 'query', + 'schema' => [ + 'description' => 'The status of the backup plan. Valid values:'."\n" + ."\n" + .'- **wait**: The backup plan is not configured.'."\n" + ."\n" + .'- **init**: The backup plan failed to be started because the precheck failed.'."\n" + ."\n" + .'- **running**: The backup plan is running.'."\n" + ."\n" + .'- **stop**: The backup plan failed.'."\n" + ."\n" + .'- **pause**: The backup plan is paused.'."\n" + ."\n" + .'- **locked**: The backup plan is locked.'."\n" + ."\n" + .'- **check\\_pass**: The precheck passed.', + 'type' => 'string', + 'required' => false, + 'example' => 'wait', + 'title' => '', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => 'A client token that is used to ensure the idempotence of the request.', + 'type' => 'string', + 'required' => false, + 'example' => 'ASDASDASDSADASFCZXVZ', + 'title' => '', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the resource group.', + 'type' => 'string', + 'required' => false, + 'example' => 'rg-aekzecovzti****', + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The details of the returned parameters.', + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'The HTTP status code.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + 'title' => '', + ], + 'PageNum' => [ + 'description' => 'The page number.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + 'title' => '', + ], + 'RequestId' => [ + 'description' => 'The request ID.', + 'type' => 'string', + 'example' => '4F1888AC-1138-4995-B9FE-D2734F61C058', + 'title' => '', + ], + 'ErrCode' => [ + 'description' => 'The error code.', + 'type' => 'string', + 'example' => 'InvalidParameterValid', + 'title' => '', + ], + 'Success' => [ + 'description' => 'Indicates whether the request was successful.', + 'type' => 'boolean', + 'example' => 'true', + 'title' => '', + ], + 'ErrMessage' => [ + 'description' => 'The error message.', + 'type' => 'string', + 'example' => 'The specified parameter %s value is not valid. ', + 'title' => '', + ], + 'TotalPages' => [ + 'description' => 'The total number of pages.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '4', + 'title' => '', + ], + 'TotalElements' => [ + 'description' => 'The total number of backup plans.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + 'title' => '', + ], + 'PageSize' => [ + 'description' => 'The number of entries returned per page.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '30', + 'title' => '', + ], + 'Items' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'BackupPlanDetail' => [ + 'description' => 'The details of the backup plan.', + 'type' => 'array', + 'items' => [ + 'description' => 'The return value.', + 'type' => 'object', + 'properties' => [ + 'CrossRoleName' => [ + 'description' => 'The name of the Resource Access Management (RAM) role that is used for cross-account backup.', + 'type' => 'string', + 'example' => 'test123', + 'title' => '', + ], + 'SourceEndpointInstanceType' => [ + 'description' => 'The location of the database. Valid values:'."\n" + ."\n" + .'- **rds**'."\n" + ."\n" + .'- **ecs**'."\n" + ."\n" + .'- **express**: A database that is connected over a leased line, VPN Gateway, or Smart Access Gateway.'."\n" + ."\n" + .'- **agent**: A database that is connected using a backup gateway.'."\n" + ."\n" + .'- **dds**: A MongoDB instance.'."\n" + ."\n" + .'- **other**: A database that is connected over the internet.', + 'type' => 'string', + 'example' => 'rds', + 'title' => '', + ], + 'BackupSetDownloadDir' => [ + 'description' => 'The directory on the server where the backup set is downloaded.', + 'type' => 'string', + 'example' => '*/test/test123', + 'title' => '', + ], + 'SourceEndpointIpPort' => [ + 'description' => 'The database endpoint.', + 'type' => 'string', + 'example' => '100.*.*.10:33204', + 'title' => '', + ], + 'CrossAliyunId' => [ + 'description' => 'The UID of the Alibaba Cloud account that is used for cross-account backup.', + 'type' => 'string', + 'example' => '2xxx7778xxxxxxxxxx', + 'title' => '', + ], + 'DuplicationArchivePeriod' => [ + 'description' => 'The number of days after which a backup set is converted to an archive backup. Unit: days.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '365', + 'title' => '', + ], + 'BackupPlanId' => [ + 'description' => 'The ID of the backup plan.', + 'type' => 'string', + 'example' => 'dbstooi01eXXXX', + 'title' => '', + ], + 'EndTimestampForRestore' => [ + 'description' => 'The end of the time range within which the database can be restored. This value is a UNIX timestamp.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1554560477000', + 'title' => '', + ], + 'BackupPlanStatus' => [ + 'description' => 'The status of the backup plan. Valid values:'."\n" + ."\n" + .'- **wait**: The backup plan is not configured.'."\n" + ."\n" + .'- **init**: The backup plan failed to be started because the precheck failed.'."\n" + ."\n" + .'- **running**: The backup plan is running.'."\n" + ."\n" + .'- **stop**: The backup plan failed.'."\n" + ."\n" + .'- **pause**: The backup plan is paused.'."\n" + ."\n" + .'- **locked**: The backup plan is locked.'."\n" + ."\n" + .'- **check\\_pass**: The precheck passed.', + 'type' => 'string', + 'example' => 'init', + 'title' => '', + ], + 'BackupSetDownloadFullDataFormat' => [ + 'description' => 'The format of the full data in the downloaded backup set:'."\n" + ."\n" + .'- **Native**'."\n" + ."\n" + .'- **SQL**'."\n" + ."\n" + .'- **CSV**'."\n" + ."\n" + .'- **JSON**', + 'type' => 'string', + 'example' => 'SQL', + 'title' => '', + ], + 'BackupRetentionPeriod' => [ + 'description' => 'The retention period of the backup data. Valid values: 0 to 1825. Unit: days.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '365', + 'title' => '', + ], + 'OSSBucketRegion' => [ + 'description' => 'The region of the OSS bucket.', + 'type' => 'string', + 'example' => 'cn-hangzhou', + 'title' => '', + ], + 'SourceEndpointOracleSID' => [ + 'description' => 'The Oracle system ID (SID).', + 'type' => 'string', + 'example' => 'test', + 'title' => '', + ], + 'BackupStorageType' => [ + 'description' => 'The built-in storage type. Valid values:'."\n" + ."\n" + .'- Empty (default): The backup data is stored in your OSS bucket.'."\n" + ."\n" + .'- system: The backup data is stored in the built-in OSS bucket of DBS.', + 'type' => 'string', + 'example' => 'system', + 'title' => '', + ], + 'BackupMethod' => [ + 'description' => 'The backup method. Valid values:'."\n" + ."\n" + .'- **logical**: Logical backup'."\n" + ."\n" + .'- **physical**: Physical backup'."\n" + ."\n" + .'- **duplication**: Dump backup', + 'type' => 'string', + 'example' => 'logical', + 'title' => '', + ], + 'SourceEndpointRegion' => [ + 'description' => 'The region of the database.', + 'type' => 'string', + 'example' => 'cn-hangzhou', + 'title' => '', + ], + 'BackupPeriod' => [ + 'description' => 'The full backup cycle. Valid values:'."\n" + ."\n" + .'- **Monday**'."\n" + ."\n" + .'- **Tuesday**'."\n" + ."\n" + .'- **Wednesday**'."\n" + ."\n" + .'- **Thursday**'."\n" + ."\n" + .'- **Friday**'."\n" + ."\n" + .'- **Saturday**'."\n" + ."\n" + .'- **Sunday**', + 'type' => 'string', + 'example' => 'Monday', + 'title' => '', + ], + 'SourceEndpointDatabaseName' => [ + 'description' => 'The name of the database.', + 'type' => 'string', + 'example' => 'test', + 'title' => '', + ], + 'BackupSetDownloadGatewayId' => [ + 'description' => 'The ID of the backup gateway that is used to download the backup set.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '123123', + 'title' => '', + ], + 'BackupPlanCreateTime' => [ + 'description' => 'The timestamp that indicates when the backup plan was created.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1582527713000', + 'title' => '', + ], + 'InstanceClass' => [ + 'description' => 'The instance specification. Valid values:'."\n" + ."\n" + .'- **micro**: Micro'."\n" + ."\n" + .'- **small**: Small'."\n" + ."\n" + .'- **medium**: Medium'."\n" + ."\n" + .'- **large**: Large'."\n" + ."\n" + .'- **xlarge**: X-Large (no traffic limit)', + 'type' => 'string', + 'example' => 'micro', + 'title' => '', + ], + 'BackupSetDownloadTargetType' => [ + 'description' => 'The destination type for downloading the backup set.'."\n" + ."\n" + .'> The only valid value is agent, which indicates that a backup gateway is installed.', + 'type' => 'string', + 'example' => 'agent', + 'title' => '', + ], + 'DuplicationInfrequentAccessPeriod' => [ + 'description' => 'The number of days after which a backup set is converted to Infrequent Access (IA) storage. Unit: days.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '180', + 'title' => '', + ], + 'BackupStartTime' => [ + 'description' => 'The start time of the full backup. The time is in the HH:mm format.', + 'type' => 'string', + 'example' => '14:22', + 'title' => '', + ], + 'ErrMessage' => [ + 'description' => 'The error message returned for the precheck task.', + 'type' => 'string', + 'example' => ' can not connect to oracle instance orcl with user dbs', + 'title' => '', + ], + 'BackupObjects' => [ + 'description' => 'The backup objects.', + 'type' => 'string', + 'example' => '[ { \\"DBName\\":\\"待备份库名\\", \\"SchemaName\\":\\"待备份 Schema 名\\", \\"TableIncludes\\":[{ \\"TableName\\":\\"待备份表表名\\" }], \\"TableExcludes\\":[{ \\"TableName\\":\\"待备份库名不需要备份表的表名\\" }] } ]', + 'title' => '', + ], + 'BeginTimestampForRestore' => [ + 'description' => 'The beginning of the time range within which the database can be restored. This value is a UNIX timestamp.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1554560477000', + 'title' => '', + ], + 'SourceEndpointInstanceID' => [ + 'description' => 'The ID of the database instance.', + 'type' => 'string', + 'example' => 'test', + 'title' => '', + ], + 'OpenBackupSetAutoDownload' => [ + 'description' => 'Indicates whether the feature of automatically downloading backup sets is enabled.', + 'type' => 'boolean', + 'example' => 'true', + 'title' => '', + ], + 'BackupPlanName' => [ + 'description' => 'The name of the backup plan.', + 'type' => 'string', + 'example' => 'dbstooi01e****', + 'title' => '', + ], + 'OSSBucketName' => [ + 'description' => 'The name of the OSS bucket.', + 'type' => 'string', + 'example' => 'dbs-backup-1857XXXXX489', + 'title' => '', + ], + 'BackupGatewayId' => [ + 'description' => 'The ID of the backup gateway.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '827362187368736', + 'title' => '', + ], + 'SourceEndpointUserName' => [ + 'description' => 'The database account.', + 'type' => 'string', + 'example' => 'test', + 'title' => '', + ], + 'BackupSetDownloadIncrementDataFormat' => [ + 'description' => 'The format of the full data downloaded from the backup set:'."\n" + ."\n" + .'- **Native**'."\n" + ."\n" + .'- **SQL**'."\n" + ."\n" + .'- **CSV**'."\n" + ."\n" + .'- **JSON**', + 'type' => 'string', + 'example' => 'SQL', + 'title' => '', + ], + 'EnableBackupLog' => [ + 'description' => 'Indicates whether incremental log backup is enabled. Valid values:'."\n" + ."\n" + .'- **true**: Enabled'."\n" + ."\n" + .'- **false**: Disabled', + 'type' => 'boolean', + 'example' => 'true', + 'title' => '', + ], + 'ResourceGroupId' => [ + 'description' => 'The ID of the resource group.', + 'type' => 'string', + 'example' => 'rg-aekzecovzti****', + 'title' => '', + ], + 'DatabaseType' => [ + 'description' => 'The database type.', + 'type' => 'string', + 'example' => 'MySQL', + 'title' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'Request.Forbidden', + 'errorMessage' => 'Have no Permissions', + 'description' => '', + ], + ], + ], + 'title' => 'DescribeBackupPlanList', + 'description' => 'You must activate Object Storage Service (OSS) before you can use this API. For more information, see [Object Storage Service](~~31817~~).', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + [ + 'createdAt' => '2023-03-28T07:35:02.000Z', + 'description' => 'Response parameters changed', + ], + [ + 'createdAt' => '2022-08-12T03:51:12.000Z', + 'description' => 'Response parameters changed', + ], + [ + 'createdAt' => '2022-07-28T06:48:28.000Z', + 'description' => 'Request parameters changed, Response parameters changed', + ], + [ + 'createdAt' => '2022-07-12T03:54:06.000Z', + 'description' => 'Error codes changed', + ], + ], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '50', + 'countWindow' => 60, + 'regionId' => '*', + 'api' => 'DescribeBackupPlanList', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dbs:DescribeBackupPlanList', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DBS', + 'resourceType' => 'BackupPlan', + 'arn' => 'acs:dbs:{#regionId}:{#accountId}:backupplan/{#BackupPlanId}', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"PageNum\\": 1,\\n \\"RequestId\\": \\"4F1888AC-1138-4995-B9FE-D2734F61C058\\",\\n \\"ErrCode\\": \\"InvalidParameterValid\\",\\n \\"Success\\": true,\\n \\"ErrMessage\\": \\"The specified parameter %s value is not valid. \\",\\n \\"TotalPages\\": 4,\\n \\"TotalElements\\": 100,\\n \\"PageSize\\": 30,\\n \\"Items\\": {\\n \\"BackupPlanDetail\\": [\\n {\\n \\"CrossRoleName\\": \\"test123\\",\\n \\"SourceEndpointInstanceType\\": \\"rds\\",\\n \\"BackupSetDownloadDir\\": \\"*/test/test123\\",\\n \\"SourceEndpointIpPort\\": \\"100.*.*.10:33204\\",\\n \\"CrossAliyunId\\": \\"2xxx7778xxxxxxxxxx\\",\\n \\"DuplicationArchivePeriod\\": 365,\\n \\"BackupPlanId\\": \\"dbstooi01eXXXX\\",\\n \\"EndTimestampForRestore\\": 1554560477000,\\n \\"BackupPlanStatus\\": \\"init\\",\\n \\"BackupSetDownloadFullDataFormat\\": \\"SQL\\",\\n \\"BackupRetentionPeriod\\": 365,\\n \\"OSSBucketRegion\\": \\"cn-hangzhou\\",\\n \\"SourceEndpointOracleSID\\": \\"test\\",\\n \\"BackupStorageType\\": \\"system\\",\\n \\"BackupMethod\\": \\"logical\\",\\n \\"SourceEndpointRegion\\": \\"cn-hangzhou\\",\\n \\"BackupPeriod\\": \\"Monday\\",\\n \\"SourceEndpointDatabaseName\\": \\"test\\",\\n \\"BackupSetDownloadGatewayId\\": 123123,\\n \\"BackupPlanCreateTime\\": 1582527713000,\\n \\"InstanceClass\\": \\"micro\\",\\n \\"BackupSetDownloadTargetType\\": \\"agent\\",\\n \\"DuplicationInfrequentAccessPeriod\\": 180,\\n \\"BackupStartTime\\": \\"14:22\\",\\n \\"ErrMessage\\": \\" can not connect to oracle instance orcl with user dbs\\",\\n \\"BackupObjects\\": \\"[ { \\\\\\\\\\\\\\"DBName\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"待备份库名\\\\\\\\\\\\\\", \\\\\\\\\\\\\\"SchemaName\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"待备份 Schema 名\\\\\\\\\\\\\\", \\\\\\\\\\\\\\"TableIncludes\\\\\\\\\\\\\\":[{ \\\\\\\\\\\\\\"TableName\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"待备份表表名\\\\\\\\\\\\\\" }], \\\\\\\\\\\\\\"TableExcludes\\\\\\\\\\\\\\":[{ \\\\\\\\\\\\\\"TableName\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"待备份库名不需要备份表的表名\\\\\\\\\\\\\\" }] } ]\\",\\n \\"BeginTimestampForRestore\\": 1554560477000,\\n \\"SourceEndpointInstanceID\\": \\"test\\",\\n \\"OpenBackupSetAutoDownload\\": true,\\n \\"BackupPlanName\\": \\"dbstooi01e****\\",\\n \\"OSSBucketName\\": \\"dbs-backup-1857XXXXX489\\",\\n \\"BackupGatewayId\\": 827362187368736,\\n \\"SourceEndpointUserName\\": \\"test\\",\\n \\"BackupSetDownloadIncrementDataFormat\\": \\"SQL\\",\\n \\"EnableBackupLog\\": true,\\n \\"ResourceGroupId\\": \\"rg-aekzecovzti****\\",\\n \\"DatabaseType\\": \\"MySQL\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + ], + 'DescribeBackupSetDownloadTaskList' => [ + 'summary' => 'Queries the list of download tasks for backup sets in Database Backup Service (DBS).', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREcbsKR7J6S', + ], + ], + 'parameters' => [ + [ + 'name' => 'BackupPlanId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the backup plan. Call the [DescribeBackupPlanList](~~2869825~~) operation to obtain the value of this parameter.'."\n" + ."\n" + .'> You must specify either **BackupPlanId** or **BackupSetDownloadTaskId**.', + 'type' => 'string', + 'required' => false, + 'example' => 'dbsqhnuhyw3****', + 'title' => '', + ], + ], + [ + 'name' => 'BackupSetDownloadTaskId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the backup set download task.'."\n" + ."\n" + .'- For a full backup, call the [CreateFullBackupSetDownload](~~2869842~~) operation to obtain the value of this parameter.'."\n" + ."\n" + .'- For an incremental backup, call the [CreateIncrementBackupSetDownload](~~2869843~~) operation to obtain the value of this parameter.', + 'type' => 'string', + 'required' => false, + 'example' => 'urxgrxt7****', + 'title' => '', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of entries to return on each page. Valid values: 30, 50, and 100.'."\n" + ."\n" + .'> The default value is 30.', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '30', + 'title' => '', + ], + ], + [ + 'name' => 'PageNum', + 'in' => 'query', + 'schema' => [ + '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.', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + 'title' => '', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => 'A client token that is used to ensure the idempotence of the request. This prevents duplicate requests.', + 'type' => 'string', + 'required' => false, + 'example' => 'ETnLKlblzczshOTUbOCzXXXXXX', + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The details of the returned parameters.', + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'The HTTP status code.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + 'title' => '', + ], + 'PageNum' => [ + 'description' => 'The page number.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + 'title' => '', + ], + 'RequestId' => [ + 'description' => 'The request ID.', + 'type' => 'string', + 'example' => '6DC3D286-E0E6-5988-A558-2184984B****', + 'title' => '', + ], + 'ErrCode' => [ + 'description' => 'The error code.', + 'type' => 'string', + 'example' => 'Param.NotFound', + 'title' => '', + ], + 'Success' => [ + 'description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'- **true**: The request was successful.'."\n" + ."\n" + .'- **false**: The request failed.', + 'type' => 'boolean', + 'example' => 'true', + 'title' => '', + ], + 'ErrMessage' => [ + 'description' => 'The error message.', + 'type' => 'string', + 'example' => 'The specified parameter %s value is not valid.', + 'title' => '', + ], + 'TotalPages' => [ + 'description' => 'The total number of pages.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + 'title' => '', + ], + 'TotalElements' => [ + 'description' => 'The total number of download records for backup sets.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + 'title' => '', + ], + 'PageSize' => [ + 'description' => 'The number of entries returned per page.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '30', + 'title' => '', + ], + 'Items' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'BackupSetDownloadTaskDetail' => [ + 'description' => 'The details of the backup set download task.', + 'type' => 'array', + 'items' => [ + 'description' => 'The details of the backup set download task.', + 'type' => 'object', + 'properties' => [ + 'BackupSetDownloadStatus' => [ + 'description' => 'The status of the backup set download. Valid values:'."\n" + ."\n" + .'- **checking**: The task is being prechecked.'."\n" + ."\n" + .'- **init**: The precheck failed and the task is not started.'."\n" + ."\n" + .'- **check\\_pass**: The precheck is passed.'."\n" + ."\n" + .'- **pause**: The task is paused.'."\n" + ."\n" + .'- **schedule**: The task is waiting to be scheduled.'."\n" + ."\n" + .'- **running**: The task is running.'."\n" + ."\n" + .'- **stop**: The task failed.'."\n" + ."\n" + .'- **finish**: The task is complete.', + 'type' => 'string', + 'example' => 'finish', + 'title' => '', + ], + 'BackupSetDataSize' => [ + 'description' => 'The size of the backup set data.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '237837', + 'title' => '', + ], + 'BackupSetDownloadTargetType' => [ + 'description' => 'The target type for the backup set download.'."\n" + ."\n" + .'> This parameter is displayed only for automatic downloads. The value \\`agent\\` indicates that a backup gateway is installed.', + 'type' => 'string', + 'example' => '无', + 'title' => '', + ], + 'BackupSetDownloadDir' => [ + 'description' => 'The directory on the server to which the backup set is downloaded.'."\n" + ."\n" + .'> This parameter has a value only for automatic downloads.', + 'type' => 'string', + 'example' => '无', + 'title' => '', + ], + 'ErrMessage' => [ + 'description' => 'The error message.', + 'type' => 'string', + 'example' => 'java.lang.IndexOutOfBoundsException.', + 'title' => '', + ], + 'BackupSetDownloadCreateTime' => [ + 'description' => 'The UNIX timestamp that indicates when the task was created.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1642044001000', + 'title' => '', + ], + 'BackupPlanId' => [ + 'description' => 'The ID of the backup plan.', + 'type' => 'string', + 'example' => 'qhnuhyw3****', + 'title' => '', + ], + 'BackupSetDbType' => [ + 'description' => 'The database type.', + 'type' => 'string', + 'example' => 'MySQL', + 'title' => '', + ], + 'BackupSetDownloadInternetUrl' => [ + 'description' => 'The public network download URL for the backup set.'."\n" + ."\n" + .'> This parameter has a value only for manual downloads when the format conversion is complete.', + 'type' => 'string', + 'example' => '"//dbs-137XXXX-cn-hangzhou-1hr5cpbtmXXXX.oss-cn-hangzhou.example"', + 'title' => '', + ], + 'BackupSetId' => [ + 'description' => 'The ID of the source backup set.', + 'type' => 'string', + 'example' => '1h7za2yws****', + 'title' => '', + ], + 'BackupSetDownloadIntranetUrl' => [ + 'description' => 'The internal download URL for the backup set.'."\n" + ."\n" + .'> This parameter has a value only for manual downloads when the format conversion is complete.', + 'type' => 'string', + 'example' => '"//dbs-13XXXX-cn-hangzhou-1hr5cpbtmXXXX.oss-cn-hangzhou-internal.example"', + 'title' => '', + ], + 'BackupGatewayId' => [ + 'description' => 'The backup gateway for the backup set. This parameter has a value only for automatic downloads.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '无', + 'title' => '', + ], + 'BackupSetDownloadWay' => [ + 'description' => 'The download type. Valid values:'."\n" + ."\n" + .'- **manual**: Manual'."\n" + ."\n" + .'- **auto**: Automatic', + 'type' => 'string', + 'example' => 'manual', + 'title' => '', + ], + 'BackupSetDownloadFinishTime' => [ + 'description' => 'The UNIX timestamp that indicates when the task was completed.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1642044013000', + 'title' => '', + ], + 'BackupSetJobType' => [ + 'description' => 'The type of the source backup set task. Valid values:'."\n" + ."\n" + .'- **cbs\\_backup\\_sub\\_full**: Logical full backup task'."\n" + ."\n" + .'- **cbs\\_backup\\_sub\\_cont**: Logical incremental backup task', + 'type' => 'string', + 'example' => 'cbs_backup_sub_cont', + 'title' => '', + ], + 'BackupSetDownloadTaskId' => [ + 'description' => 'The ID of the backup set download task.', + 'type' => 'string', + 'example' => 'urxgrxt7****', + 'title' => '', + ], + 'BackupSetDownloadTaskName' => [ + 'description' => 'The name of the backup set download task.', + 'type' => 'string', + 'example' => '1h7za2yws****-ManualCont', + 'title' => '', + ], + 'BackupSetDataFormat' => [ + 'description' => 'The data format of the downloaded backup set. Valid values:'."\n" + ."\n" + .'- **Native**'."\n" + ."\n" + .'- **SQL**'."\n" + ."\n" + .'- **CSV**'."\n" + ."\n" + .'- **JSON**', + 'type' => 'string', + 'example' => 'Native', + 'title' => '', + ], + 'BackupSetCode' => [ + 'description' => 'The encoding of the source backup set.', + 'type' => 'string', + 'example' => 'mysql-bin.00XXXX', + 'title' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'Request.Forbidden', + 'errorMessage' => 'Have no Permissions', + 'description' => '', + ], + ], + ], + 'title' => 'DescribeBackupSetDownloadTaskList', + 'changeSet' => [ + [ + 'createdAt' => '2022-07-12T03:53:58.000Z', + 'description' => 'Error codes changed', + ], + ], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '100', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'DescribeBackupSetDownloadTaskList', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dbs:DescribeBackupSetDownloadTaskList', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DBS', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"PageNum\\": 0,\\n \\"RequestId\\": \\"6DC3D286-E0E6-5988-A558-2184984B****\\",\\n \\"ErrCode\\": \\"Param.NotFound\\",\\n \\"Success\\": true,\\n \\"ErrMessage\\": \\"The specified parameter %s value is not valid.\\",\\n \\"TotalPages\\": 1,\\n \\"TotalElements\\": 1,\\n \\"PageSize\\": 30,\\n \\"Items\\": {\\n \\"BackupSetDownloadTaskDetail\\": [\\n {\\n \\"BackupSetDownloadStatus\\": \\"finish\\",\\n \\"BackupSetDataSize\\": 237837,\\n \\"BackupSetDownloadTargetType\\": \\"无\\",\\n \\"BackupSetDownloadDir\\": \\"无\\",\\n \\"ErrMessage\\": \\"java.lang.IndexOutOfBoundsException.\\",\\n \\"BackupSetDownloadCreateTime\\": 1642044001000,\\n \\"BackupPlanId\\": \\"qhnuhyw3****\\",\\n \\"BackupSetDbType\\": \\"MySQL\\",\\n \\"BackupSetDownloadInternetUrl\\": \\"\\\\\\"//dbs-137XXXX-cn-hangzhou-1hr5cpbtmXXXX.oss-cn-hangzhou.example\\\\\\"\\",\\n \\"BackupSetId\\": \\"1h7za2yws****\\",\\n \\"BackupSetDownloadIntranetUrl\\": \\"\\\\\\"//dbs-13XXXX-cn-hangzhou-1hr5cpbtmXXXX.oss-cn-hangzhou-internal.example\\\\\\"\\",\\n \\"BackupGatewayId\\": 0,\\n \\"BackupSetDownloadWay\\": \\"manual\\",\\n \\"BackupSetDownloadFinishTime\\": 1642044013000,\\n \\"BackupSetJobType\\": \\"cbs_backup_sub_cont\\",\\n \\"BackupSetDownloadTaskId\\": \\"urxgrxt7****\\",\\n \\"BackupSetDownloadTaskName\\": \\"1h7za2yws****-ManualCont\\",\\n \\"BackupSetDataFormat\\": \\"Native\\",\\n \\"BackupSetCode\\": \\"mysql-bin.00XXXX\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + ], + 'DescribeDLAService' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREcbsKR7J6S', + ], + ], + 'parameters' => [ + [ + 'name' => 'BackupPlanId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the backup schedule. You can call the [DescribeBackupPlanList](~~2869825~~) operation to obtain the ID of the backup schedule.', + 'type' => 'string', + 'required' => true, + 'example' => 'dbstooi01exXXXX', + 'title' => '', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => 'The client token that is used to ensure the idempotence of the request.', + 'type' => 'string', + 'required' => false, + 'example' => 'DBS', + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'The HTTP status code.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + 'title' => '', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.', + 'type' => 'string', + 'example' => '4F1888AC-1138-4995-B9FE-D2734F61C058', + 'title' => '', + ], + 'ErrCode' => [ + 'description' => 'The error code.', + 'type' => 'string', + 'example' => 'Param.NotFound', + 'title' => '', + ], + 'Success' => [ + 'description' => 'Indicates whether the request is successful.', + 'type' => 'boolean', + 'example' => 'true', + 'title' => '', + ], + 'State' => [ + 'description' => 'The status of the DLA service for the backup schedule. Valid values:'."\n" + ."\n" + .'- **Running**: DLA is running.'."\n" + ."\n" + .'- **Closing**: DLA is being disabled.'."\n" + ."\n" + .'- **Closed**: DLA is disabled.', + 'type' => 'string', + 'example' => 'Running', + 'title' => '', + ], + 'ErrMessage' => [ + 'description' => 'The error message.', + 'type' => 'string', + 'example' => 'The specified parameter %s value is not valid.', + 'title' => '', + ], + 'AutoAdd' => [ + 'description' => 'Specifies whether to enable the feature of automatically adding incremental data to a data lake. If this feature is enabled, DBS adds the backup sets that are newly generated to the data lake that is created for the backup schedule. Valid values:'."\n" + ."\n" + .'- **true**: enables the feature.'."\n" + ."\n" + .'- **false**: disables the feature.', + 'type' => 'boolean', + 'example' => 'true', + 'title' => '', + ], + 'HaveJobFailed' => [ + 'description' => 'Indicates whether a failed DLA task exists in the return result. Valid values:'."\n" + ."\n" + .'- **true**: A failed DLA task exists.'."\n" + ."\n" + .'- **false**: No failed DLA task exists.', + 'type' => 'boolean', + 'example' => 'false', + 'title' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'Request.Forbidden', + 'errorMessage' => 'Have no Permissions', + 'description' => '', + ], + ], + ], + 'title' => 'DescribeDLAService', + 'summary' => 'Queries the status of the Data Lake Analytics (DLA) service for a backup schedule.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + [ + 'createdAt' => '2022-07-12T03:53:58.000Z', + 'description' => 'Error codes changed', + ], + ], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '10', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'DescribeDLAService', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dbs:DescribeDLAService', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DBS', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"4F1888AC-1138-4995-B9FE-D2734F61C058\\",\\n \\"ErrCode\\": \\"Param.NotFound\\",\\n \\"Success\\": true,\\n \\"State\\": \\"Running\\",\\n \\"ErrMessage\\": \\"The specified parameter %s value is not valid.\\",\\n \\"AutoAdd\\": true,\\n \\"HaveJobFailed\\": false\\n}","type":"json"}]', + ], + 'DescribeFullBackupList' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREcbsKR7J6S', + ], + ], + 'parameters' => [ + [ + 'name' => 'BackupPlanId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the backup schedule.', + 'type' => 'string', + 'required' => true, + 'example' => 'dbsr179qz******', + 'title' => '', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of entries to return on each page. Valid values:'."\n" + ."\n" + .'- 30'."\n" + ."\n" + .'- 50'."\n" + ."\n" + .'- 100'."\n" + ."\n" + .'Default value: 30.', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '30', + 'title' => '', + ], + ], + [ + 'name' => 'PageNum', + 'in' => 'query', + 'schema' => [ + 'description' => 'The page number to return. The value must be a number that is greater than or equal to 0. The value cannot exceed the maximum value of an integer. Default value: 0.', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + 'title' => '', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => 'A client token that is used to ensure the idempotence of the request. This prevents the system from processing duplicate requests.', + 'type' => 'string', + 'required' => false, + 'example' => 'ETnLKlblzczshOTUbOCzxxxxxxx', + 'title' => '', + ], + ], + [ + 'name' => 'ShowStorageType', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to show the storage class.', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + 'title' => '', + ], + ], + [ + 'name' => 'BackupSetId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the backup set.', + 'type' => 'string', + 'required' => false, + 'example' => '1iukx5h******', + 'title' => '', + ], + ], + [ + 'name' => 'StartTimestamp', + 'in' => 'query', + 'schema' => [ + 'description' => 'The backup start time.', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1676887100', + 'title' => '', + ], + ], + [ + 'name' => 'EndTimestamp', + 'in' => 'query', + 'schema' => [ + 'description' => 'The end of the time range to query. This is a UNIX timestamp.', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1676887128', + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The response parameters.', + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'The HTTP status code.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + 'title' => '', + ], + 'PageNum' => [ + 'description' => 'The page number of the returned page.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + 'title' => '', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.', + 'type' => 'string', + 'example' => '636BC118-6080-4119-A6B5-C199CEC1037D', + 'title' => '', + ], + 'ErrCode' => [ + 'description' => 'The error code.', + 'type' => 'string', + 'example' => 'Param.NotFound', + 'title' => '', + ], + 'Success' => [ + 'description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'- **true**: The request was successful.'."\n" + ."\n" + .'- **false**: The request failed.', + 'type' => 'boolean', + 'example' => 'true', + 'title' => '', + ], + 'ErrMessage' => [ + 'description' => 'The error message.', + 'type' => 'string', + 'example' => 'The specified parameter %s value is not valid. ', + 'title' => '', + ], + 'TotalPages' => [ + 'description' => 'The total number of pages returned.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + 'title' => '', + ], + 'TotalElements' => [ + 'description' => 'The total number of full backup jobs.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + 'title' => '', + ], + 'PageSize' => [ + 'description' => 'The number of entries returned per page.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + 'title' => '', + ], + 'Items' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'FullBackupFile' => [ + 'itemNode' => true, + 'description' => 'The details of the full backup job.', + 'title' => '', + 'type' => 'array', + 'items' => [ + 'description' => 'The details of the full backup job.', + 'type' => 'object', + 'properties' => [ + 'FinishTime' => [ + 'description' => 'The UNIX timestamp that indicates when the task ended.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1676887128000', + 'title' => '', + ], + 'BackupStatus' => [ + 'description' => 'The status of the backup job. Valid values:'."\n" + ."\n" + .'- schedule: The job is being initialized.'."\n" + ."\n" + .'- running: The job is running.'."\n" + ."\n" + .'- finish: The job is complete.'."\n" + ."\n" + .'- stop: The job failed.'."\n" + ."\n" + .'- pause: The job is paused.', + 'type' => 'string', + 'example' => 'finish', + 'title' => '', + ], + 'SourceEndpointIpPort' => [ + 'description' => 'The database endpoint.', + 'type' => 'string', + 'example' => '121.XXX.XXX.144:3306', + 'title' => '', + ], + 'CreateTime' => [ + 'description' => 'The UNIX timestamp that indicates when the task was created.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1676886947000', + 'title' => '', + ], + 'ErrMessage' => [ + 'description' => 'The error message.', + 'type' => 'string', + 'example' => 'NULL', + 'title' => '', + ], + 'BackupObjects' => [ + 'description' => 'The backup objects.', + 'type' => 'string', + 'example' => '[{\\"DBName\\":\\"test\\"}]', + 'title' => '', + ], + 'EndTime' => [ + 'description' => 'The UNIX timestamp that indicates when the backup ended.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1676887128000', + 'title' => '', + ], + 'StartTime' => [ + 'description' => 'The UNIX timestamp that indicates when the backup started.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1676887100000', + 'title' => '', + ], + 'BackupSetExpiredTime' => [ + 'description' => 'The UNIX timestamp that indicates when the backup set expires.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1677491900000', + 'title' => '', + ], + 'StorageMethod' => [ + 'description' => 'The storage class. Valid values:'."\n" + ."\n" + .'- Standard: Standard'."\n" + ."\n" + .'- IA: Infrequent Access'."\n" + ."\n" + .'- Archive: Archive Storage'."\n" + ."\n" + .'- UNKNOWN: Unknown. This value is typically returned when the task is not complete.', + 'type' => 'string', + 'example' => 'Standard', + 'title' => '', + ], + 'BackupSetId' => [ + 'description' => 'The ID of the backup set.', + 'type' => 'string', + 'example' => '1iukx5h******', + 'title' => '', + ], + 'BackupSize' => [ + 'description' => 'The backup size in bytes.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '580', + 'title' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'Request.Forbidden', + 'errorMessage' => 'Have no Permissions', + 'description' => '', + ], + ], + ], + 'title' => 'DescribeFullBackupList', + 'summary' => 'Queries the list of full backup jobs in Database Backup Service (DBS).', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + [ + 'createdAt' => '2022-07-12T03:53:58.000Z', + 'description' => 'Error codes changed', + ], + ], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '100', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'DescribeFullBackupList', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dbs:DescribeFullBackupList', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DBS', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"PageNum\\": 1,\\n \\"RequestId\\": \\"636BC118-6080-4119-A6B5-C199CEC1037D\\",\\n \\"ErrCode\\": \\"Param.NotFound\\",\\n \\"Success\\": true,\\n \\"ErrMessage\\": \\"The specified parameter %s value is not valid. \\",\\n \\"TotalPages\\": 1,\\n \\"TotalElements\\": 1,\\n \\"PageSize\\": 10,\\n \\"Items\\": {\\n \\"FullBackupFile\\": [\\n {\\n \\"FinishTime\\": 1676887128000,\\n \\"BackupStatus\\": \\"finish\\",\\n \\"SourceEndpointIpPort\\": \\"121.XXX.XXX.144:3306\\",\\n \\"CreateTime\\": 1676886947000,\\n \\"ErrMessage\\": \\"NULL\\",\\n \\"BackupObjects\\": \\"[{\\\\\\\\\\\\\\"DBName\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"test\\\\\\\\\\\\\\"}]\\",\\n \\"EndTime\\": 1676887128000,\\n \\"StartTime\\": 1676887100000,\\n \\"BackupSetExpiredTime\\": 1677491900000,\\n \\"StorageMethod\\": \\"Standard\\",\\n \\"BackupSetId\\": \\"1iukx5h******\\",\\n \\"BackupSize\\": 580\\n }\\n ]\\n }\\n}","type":"json"}]', + ], + 'DescribeIncrementBackupList' => [ + 'summary' => 'Queries the list of Database Backup Service (DBS) incremental backup jobs.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREcbsKR7J6S', + ], + ], + 'parameters' => [ + [ + 'name' => 'BackupPlanId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the backup schedule. To obtain this parameter, call the [DescribeBackupPlanList](~~2869825~~) operation.', + 'type' => 'string', + 'required' => true, + 'example' => 'dbsqdss5tmh****', + 'title' => '', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of records on each page. Valid values: 30, 50, and 100.'."\n" + ."\n" + .'> The default value is 30.', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '30', + 'title' => '', + ], + ], + [ + 'name' => 'PageNum', + 'in' => 'query', + 'schema' => [ + '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.', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + 'title' => '', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => 'A client token used to ensure the idempotence of the request. This prevents the submission of duplicate requests.', + 'type' => 'string', + 'required' => false, + 'example' => 'ETnLKlblzczshOTUbOCzxxxxxxx', + 'title' => '', + ], + ], + [ + 'name' => 'ShowStorageType', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to display the storage class. Valid values:'."\n" + ."\n" + .'- true'."\n" + ."\n" + .'- false'."\n" + ."\n" + .'> Default value: true.', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + 'title' => '', + ], + ], + [ + 'name' => 'StartTimestamp', + 'in' => 'query', + 'schema' => [ + 'description' => 'The UNIX timestamp that represents the start of the backup.', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1570701361528', + 'title' => '', + ], + ], + [ + 'name' => 'EndTimestamp', + 'in' => 'query', + 'schema' => [ + 'description' => 'The UNIX timestamp that represents the end of the backup.', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1570701361600', + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'The HTTP status code.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + 'title' => '', + ], + 'PageNum' => [ + 'description' => 'The page number.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + 'title' => '', + ], + 'RequestId' => [ + 'description' => 'The request ID.', + 'type' => 'string', + 'example' => 'A5D52069-E8AA-5056-8C5C-654C3610****', + 'title' => '', + ], + 'ErrCode' => [ + 'description' => 'The error code.', + 'type' => 'string', + 'example' => 'Param.NotFound', + 'title' => '', + ], + 'Success' => [ + 'description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'- **true**: The request was successful.'."\n" + ."\n" + .'- **false**: The request failed.', + 'type' => 'boolean', + 'example' => 'true', + 'title' => '', + ], + 'ErrMessage' => [ + 'description' => 'The error message.', + 'type' => 'string', + 'example' => 'The specified parameter %s value is not valid. ', + 'title' => '', + ], + 'TotalPages' => [ + 'description' => 'The total number of pages.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + 'title' => '', + ], + 'TotalElements' => [ + 'description' => 'The total number of incremental backup jobs.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + 'title' => '', + ], + 'PageSize' => [ + 'description' => 'The number of records on each page.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '30', + 'title' => '', + ], + 'Items' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'IncrementBackupFile' => [ + 'description' => 'The details of the incremental backup jobs.', + 'type' => 'array', + 'items' => [ + 'description' => 'The details of the incremental backup job.', + 'type' => 'object', + 'properties' => [ + 'EndTime' => [ + 'description' => 'The UNIX timestamp that represents the end of the backup.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1648434713000', + 'title' => '', + ], + 'BackupSetExpiredTime' => [ + 'description' => 'The UNIX timestamp that represents the expiration time of the backup set.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1711506719000', + 'title' => '', + ], + 'StartTime' => [ + 'description' => 'The UNIX timestamp that represents the start of the backup.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1648433764000', + 'title' => '', + ], + 'StorageMethod' => [ + 'description' => 'The storage class. Valid values:'."\n" + ."\n" + .'- **Standard**: Standard'."\n" + ."\n" + .'- **IA**: Infrequent Access (IA)'."\n" + ."\n" + .'- **Archive**: Archive Storage'."\n" + ."\n" + .'- **UNKNOWN**: Unknown. This is usually the status when the job is not complete.', + 'type' => 'string', + 'example' => 'Standard', + 'title' => '', + ], + 'BackupSetJobId' => [ + 'description' => 'The ID of the backup set job.', + 'type' => 'string', + 'example' => '1hv5g9wk4****', + 'title' => '', + ], + 'BackupSetId' => [ + 'description' => 'The ID of the backup set.', + 'type' => 'string', + 'example' => 'mysql-bin.00****', + 'title' => '', + ], + 'BackupStatus' => [ + 'description' => 'The status of the backup job. Valid values:'."\n" + ."\n" + .'- **INIT**: Not started'."\n" + ."\n" + .'- **FILLING**: Backing up'."\n" + ."\n" + .'- **COMPLETED**: Complete'."\n" + ."\n" + .'- **UNCOMPLETED**: Incomplete', + 'type' => 'string', + 'example' => 'FILLING', + 'title' => '', + ], + 'SourceEndpointIpPort' => [ + 'description' => 'The database endpoint.', + 'type' => 'string', + 'example' => '172.1XX.103.1:4XXX', + 'title' => '', + ], + 'BackupSize' => [ + 'description' => 'The backup size.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '18535', + 'title' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'Request.Forbidden', + 'errorMessage' => 'Have no Permissions', + 'description' => '', + ], + ], + ], + 'title' => 'DescribeIncrementBackupList', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + [ + 'createdAt' => '2022-07-12T03:53:58.000Z', + 'description' => 'Error codes changed', + ], + ], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '100', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'DescribeIncrementBackupList', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dbs:DescribeIncrementBackupList', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DBS', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"PageNum\\": 0,\\n \\"RequestId\\": \\"A5D52069-E8AA-5056-8C5C-654C3610****\\",\\n \\"ErrCode\\": \\"Param.NotFound\\",\\n \\"Success\\": true,\\n \\"ErrMessage\\": \\"The specified parameter %s value is not valid. \\",\\n \\"TotalPages\\": 1,\\n \\"TotalElements\\": 1,\\n \\"PageSize\\": 30,\\n \\"Items\\": {\\n \\"IncrementBackupFile\\": [\\n {\\n \\"EndTime\\": 1648434713000,\\n \\"BackupSetExpiredTime\\": 1711506719000,\\n \\"StartTime\\": 1648433764000,\\n \\"StorageMethod\\": \\"Standard\\",\\n \\"BackupSetJobId\\": \\"1hv5g9wk4****\\",\\n \\"BackupSetId\\": \\"mysql-bin.00****\\",\\n \\"BackupStatus\\": \\"FILLING\\",\\n \\"SourceEndpointIpPort\\": \\"172.1XX.103.1:4XXX\\",\\n \\"BackupSize\\": 18535\\n }\\n ]\\n }\\n}","type":"json"}]', + ], + 'DescribeJobErrorCode' => [ + 'summary' => 'Queries the error code of a Database Backup Service (DBS) job.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREcbsKR7J6S', + ], + ], + 'parameters' => [ + [ + 'name' => 'TaskId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the full backup or restore job.', + 'type' => 'string', + 'required' => true, + 'example' => 'r1iv62ud****', + 'title' => '', + ], + ], + [ + 'name' => 'Language', + 'in' => 'query', + 'schema' => [ + 'description' => 'The language of the error message. Valid values:'."\n" + ."\n" + .'- **en**: English (Default)'."\n" + ."\n" + .'- **cn**: Chinese', + 'type' => 'string', + 'required' => false, + 'example' => 'en', + 'title' => '', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => 'A client token. It is used to ensure the idempotence of the request.', + 'type' => 'string', + 'required' => false, + 'example' => 'ETnLKlblzczshOTUbOCz****', + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'The HTTP status code.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + 'title' => '', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.', + 'type' => 'string', + 'example' => '1FC2F86D-AFF4-4ED9-BB25-ADDE196CB2B5', + 'title' => '', + ], + 'ErrCode' => [ + 'description' => 'The error code.', + 'type' => 'string', + 'example' => 'Param.NotFound', + 'title' => '', + ], + 'Success' => [ + 'description' => 'Indicates whether the request was successful.', + 'type' => 'boolean', + 'example' => 'true', + 'title' => '', + ], + 'ErrMessage' => [ + 'description' => 'The error message.', + 'type' => 'string', + 'example' => 'The specified parameter %s value is not valid. ', + 'title' => '', + ], + 'Item' => [ + 'description' => 'The details of the error code.', + 'type' => 'object', + 'properties' => [ + 'JobState' => [ + 'description' => 'The state of the job.', + 'type' => 'string', + 'example' => 'init', + 'title' => '', + ], + 'ErrorMessage' => [ + 'description' => 'The standardized error message.', + 'type' => 'string', + 'example' => 'Describe preCheck progress failed.', + 'title' => '', + ], + 'ErrorCode' => [ + 'description' => 'The error code.', + 'type' => 'string', + 'example' => 'failed', + 'title' => '', + ], + 'JobId' => [ + 'description' => 'The ID of the full backup or restore job.', + 'type' => 'string', + 'example' => 'r1iv62ud****', + 'title' => '', + ], + 'JobType' => [ + 'description' => 'The internal job type ID in DBS.', + 'type' => 'string', + 'example' => 'testId', + 'title' => '', + ], + 'Language' => [ + 'description' => 'The language of the error message.', + 'type' => 'string', + 'example' => 'en', + 'title' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'Request.Forbidden', + 'errorMessage' => 'Have no Permissions', + 'description' => '', + ], + ], + ], + 'title' => 'DescribeJobErrorCode', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + [ + 'createdAt' => '2022-07-12T03:53:58.000Z', + 'description' => 'Error codes changed', + ], + ], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '10', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'DescribeJobErrorCode', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dbs:DescribeJobErrorCode', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DBS', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"1FC2F86D-AFF4-4ED9-BB25-ADDE196CB2B5\\",\\n \\"ErrCode\\": \\"Param.NotFound\\",\\n \\"Success\\": true,\\n \\"ErrMessage\\": \\"The specified parameter %s value is not valid. \\",\\n \\"Item\\": {\\n \\"JobState\\": \\"init\\",\\n \\"ErrorMessage\\": \\"Describe preCheck progress failed.\\",\\n \\"ErrorCode\\": \\"failed\\",\\n \\"JobId\\": \\"r1iv62ud****\\",\\n \\"JobType\\": \\"testId\\",\\n \\"Language\\": \\"en\\"\\n }\\n}","type":"json"}]', + ], + 'DescribeNodeCidrList' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREcbsKR7J6S', + ], + ], + 'parameters' => [ + [ + 'name' => 'Region', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region in which DBS is activated. Valid values:'."\n" + ."\n" + .'- **cn-hangzhou**: China (Hangzhou)'."\n" + ."\n" + .'- **cn-shanghai**: China (Shanghai)'."\n" + ."\n" + .'- **cn-qingdao**: China (Qingdao)'."\n" + ."\n" + .'- **cn-beijing**: China (Beijing)'."\n" + ."\n" + .'- **cn-shenzhen**: China (Shenzhen)'."\n" + ."\n" + .'- **cn-hongkong**: China (Hong Kong)'."\n" + ."\n" + .'- **ap-southeast-1**: Singapore (Singapore)'."\n" + ."\n" + .'- **cn-hangzhou-finance**: China East 1 Finance'."\n" + ."\n" + .'- **cn-shanghai-finance**: China East 2 Finance'."\n" + ."\n" + .'- **cn-shenzhen-finance**: China South 1 Finance', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + 'title' => '', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => 'The client token that is used to ensure the idempotence of the request.', + 'type' => 'string', + 'required' => false, + 'example' => 'ETnLKlblzczshOTUbOCzxxxxxxx', + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'The HTTP status code.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + 'title' => '', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.', + 'type' => 'string', + 'example' => '5B352E69-E7B1-4EA7-BB8E-29FFE969C791', + 'title' => '', + ], + 'ErrCode' => [ + 'description' => 'The error code.', + 'type' => 'string', + 'example' => 'Param.NotFound', + 'title' => '', + ], + 'Success' => [ + 'description' => 'Indicates whether the request is successful.', + 'type' => 'boolean', + 'example' => 'true', + 'title' => '', + ], + 'ErrMessage' => [ + 'description' => 'The error message.', + 'type' => 'string', + 'example' => 'The specified parameter %s value is not valid. ', + 'title' => '', + ], + 'IntranetIPs' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'IntranetIP' => [ + 'description' => 'The internal CIDR blocks.', + 'type' => 'array', + 'items' => [ + 'description' => 'The internal CIDR blocks.', + 'type' => 'string', + 'example' => '"10.X.X.0/24"', + 'title' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'InternetIPs' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'InternetIP' => [ + 'description' => 'The public CIDR blocks.', + 'type' => 'array', + 'items' => [ + 'description' => 'The public CIDR blocks.', + 'type' => 'string', + 'example' => '"10.X.X.0/24"', + 'title' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + 'description' => 'Possible return values include details as follows.', + 'title' => '', + 'example' => '', + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'Request.Forbidden', + 'errorMessage' => 'Have no Permissions', + 'description' => '', + ], + ], + ], + 'title' => 'DescribeNodeCidrList', + 'summary' => 'Queries the CIDR blocks of nodes on which Database Backup (DBS) is running.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + [ + 'createdAt' => '2022-07-12T03:53:58.000Z', + 'description' => 'Error codes changed', + ], + ], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '100', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'DescribeNodeCidrList', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dbs:DescribeNodeCidrList', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DBS', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"5B352E69-E7B1-4EA7-BB8E-29FFE969C791\\",\\n \\"ErrCode\\": \\"Param.NotFound\\",\\n \\"Success\\": true,\\n \\"ErrMessage\\": \\"The specified parameter %s value is not valid. \\",\\n \\"IntranetIPs\\": {\\n \\"IntranetIP\\": [\\n \\"\\\\\\"10.X.X.0/24\\\\\\"\\"\\n ]\\n },\\n \\"InternetIPs\\": {\\n \\"InternetIP\\": [\\n \\"\\\\\\"10.X.X.0/24\\\\\\"\\"\\n ]\\n }\\n}","type":"json"}]', + ], + 'DescribePreCheckProgressList' => [ + 'summary' => 'This operation queries the precheck progress for a backup plan or a restore job.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREcbsKR7J6S', + ], + ], + 'parameters' => [ + [ + 'name' => 'BackupPlanId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the backup plan.'."\n" + ."\n" + .'> Specify either BackupPlanId or RestoreTaskId.', + 'type' => 'string', + 'required' => false, + 'example' => 'dbsr1l3ro21****', + 'title' => '', + ], + ], + [ + 'name' => 'RestoreTaskId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the restore job.', + 'type' => 'string', + 'required' => false, + 'example' => 'dbasdsa****', + 'title' => '', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => 'The client token that is used to ensure the idempotence of the request.', + 'type' => 'string', + 'required' => false, + 'example' => 'ETnLKlblzczshOTUbOCziJZNwH****', + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The response parameters.', + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => 'The precheck status. Valid values:'."\n" + ."\n" + .'- **running**: The precheck is in progress.'."\n" + ."\n" + .'- **failed**: The precheck failed.'."\n" + ."\n" + .'- **finish**: The precheck is complete.', + 'type' => 'string', + 'example' => 'finish', + 'title' => '', + ], + 'HttpStatusCode' => [ + 'description' => 'The HTTP status code.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + 'title' => '', + ], + 'RequestId' => [ + 'description' => 'The request ID.', + 'type' => 'string', + 'example' => 'C4A45FE1-A903-470D-B113-F12A4DF942AB', + 'title' => '', + ], + 'Progress' => [ + 'description' => 'The precheck progress. The value ranges from 0 to 100.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + 'title' => '', + ], + 'ErrCode' => [ + 'description' => 'The error code.', + 'type' => 'string', + 'example' => 'Param.NotFound', + 'title' => '', + ], + 'Success' => [ + 'description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'- **true**: The request was successful.'."\n" + ."\n" + .'- **false**: The request failed.', + 'type' => 'boolean', + 'example' => 'true', + 'title' => '', + ], + 'ErrMessage' => [ + 'description' => 'The error message.', + 'type' => 'string', + 'example' => 'The specified parameter %s value is not valid. ', + 'title' => '', + ], + 'Items' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'PreCheckProgressDetail' => [ + 'description' => 'A list of progress details.', + 'type' => 'array', + 'items' => [ + 'description' => 'The response parameters.', + 'type' => 'object', + 'properties' => [ + 'FinishTime' => [ + 'description' => 'The time when the task was complete. This value is a UNIX timestamp.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1704351396000', + 'title' => '', + ], + 'State' => [ + 'description' => 'The progress status. Valid values:'."\n" + ."\n" + .'- **init**: The task is being initialized.'."\n" + ."\n" + .'- **warning**: A warning is reported for the task.'."\n" + ."\n" + .'- **catched**: The task is abnormal.'."\n" + ."\n" + .'- **running**: The task is in progress.'."\n" + ."\n" + .'- **failed**: The task failed.'."\n" + ."\n" + .'- **finish**: The task is complete.', + 'type' => 'string', + 'example' => 'warning', + 'title' => '', + ], + 'BootTime' => [ + 'description' => 'The time when the task started. This value is a UNIX timestamp.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1704351395000', + 'title' => '', + ], + 'JobId' => [ + 'description' => 'The progress ID.', + 'type' => 'string', + 'example' => 'qxwmxh2b****', + 'title' => '', + ], + 'Item' => [ + 'description' => 'The code for the precheck item.', + 'type' => 'string', + 'example' => 'CHECK_BINLOG_ON', + 'title' => '', + ], + 'ErrMsg' => [ + 'description' => 'The error message.', + 'type' => 'string', + 'example' => 'java.lang.RuntimeException: Could not find any schema ......', + 'title' => '', + ], + 'OrderNum' => [ + 'description' => 'The sequence number.', + 'type' => 'string', + 'example' => '30', + 'title' => '', + ], + 'Names' => [ + 'description' => 'The group to which the precheck item belongs.', + 'type' => 'string', + 'example' => 'CHECK_BINLOG_ON_DETAIL', + 'title' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'Request.Forbidden', + 'errorMessage' => 'Have no Permissions', + 'description' => '', + ], + ], + ], + 'title' => 'DescribePreCheckProgressList', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + [ + 'createdAt' => '2022-07-12T03:53:58.000Z', + 'description' => 'Error codes changed', + ], + ], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '100', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'DescribePreCheckProgressList', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dbs:DescribePreCheckProgressList', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DBS', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Status\\": \\"finish\\",\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"C4A45FE1-A903-470D-B113-F12A4DF942AB\\",\\n \\"Progress\\": 100,\\n \\"ErrCode\\": \\"Param.NotFound\\",\\n \\"Success\\": true,\\n \\"ErrMessage\\": \\"The specified parameter %s value is not valid. \\",\\n \\"Items\\": {\\n \\"PreCheckProgressDetail\\": [\\n {\\n \\"FinishTime\\": 1704351396000,\\n \\"State\\": \\"warning\\",\\n \\"BootTime\\": 1704351395000,\\n \\"JobId\\": \\"qxwmxh2b****\\",\\n \\"Item\\": \\"CHECK_BINLOG_ON\\",\\n \\"ErrMsg\\": \\"java.lang.RuntimeException: Could not find any schema ......\\",\\n \\"OrderNum\\": \\"30\\",\\n \\"Names\\": \\"CHECK_BINLOG_ON_DETAIL\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + ], + 'DescribeRegions' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREcbsKR7J6S', + ], + ], + 'parameters' => [ + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + '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 64 ASCII characters in length and cannot contain non-ASCII characters.', + 'type' => 'string', + 'required' => false, + 'example' => 'ETnLKlblzczshOTUbOCzxxxxxxxxxx', + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The returned parameters.', + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'The HTTP status code.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '400', + 'title' => '', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.', + 'type' => 'string', + 'example' => 'EB4DFD5E-3618-498D-BE35-4DBEA0072122', + 'title' => '', + ], + 'ErrCode' => [ + 'description' => 'The error code.', + 'type' => 'string', + 'example' => 'InvalidParameter', + 'title' => '', + ], + 'Success' => [ + 'description' => 'Indicates whether the request was successful.', + 'type' => 'boolean', + 'example' => 'true', + 'title' => '', + ], + 'ErrMessage' => [ + 'description' => 'The error message.', + 'type' => 'string', + 'example' => 'This backupPlan can\'t support this action', + 'title' => '', + ], + 'Regions' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'RegionCode' => [ + 'description' => 'The list of supported regions.', + 'type' => 'array', + 'items' => [ + 'description' => 'The supported regions.', + 'type' => 'string', + 'example' => 'cn-hangzhou', + 'title' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'Request.Forbidden', + 'errorMessage' => 'Have no Permissions', + 'description' => '', + ], + ], + ], + 'title' => 'DescribeRegions', + 'summary' => 'Queries the regions where DBS is available.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + [ + 'createdAt' => '2022-07-12T03:53:58.000Z', + 'description' => 'Error codes changed', + ], + ], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '100', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'DescribeRegions', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dbs:DescribeRegions', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DBS', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 400,\\n \\"RequestId\\": \\"EB4DFD5E-3618-498D-BE35-4DBEA0072122\\",\\n \\"ErrCode\\": \\"InvalidParameter\\",\\n \\"Success\\": true,\\n \\"ErrMessage\\": \\"This backupPlan can\'t support this action\\",\\n \\"Regions\\": {\\n \\"RegionCode\\": [\\n \\"cn-hangzhou\\"\\n ]\\n }\\n}","type":"json"}]', + ], + 'DescribeRestoreRangeInfo' => [ + 'summary' => 'Queries the range of time to which you can restore data in a backup schedule.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREcbsKR7J6S', + ], + ], + 'parameters' => [ + [ + 'name' => 'BackupPlanId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the backup schedule. You can call the [DescribeBackupPlanList](~~2869825~~) operation to obtain it.', + 'type' => 'string', + 'required' => true, + 'example' => 'dbssl67c7mx****', + 'title' => '', + ], + ], + [ + 'name' => 'BeginTimestampForRestore', + 'in' => 'query', + 'schema' => [ + 'description' => 'The earliest point in time to which you can restore data. You can call the [DescribeBackupPlanList](~~2869825~~) operation to obtain the value of the parameter for each backup schedule.', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1646674092000', + 'title' => '', + ], + ], + [ + 'name' => 'EndTimestampForRestore', + 'in' => 'query', + 'schema' => [ + 'description' => 'The latest point in time to which you can restore data. You can call the [DescribeBackupPlanList](~~2869825~~) operation to obtain the value of the parameter for each backup schedule.', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1646846814000', + 'title' => '', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => 'The client token that is used to ensure the idempotence of the request.', + 'type' => 'string', + 'required' => false, + 'example' => 'ETnLKlblzczshOTUbOCzxxxxxxx', + 'title' => '', + ], + ], + [ + 'name' => 'RecentlyRestore', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to query the most recent point in time to which you can restore data.', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The response parameters.', + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'The HTTP status code.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + 'title' => '', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.', + 'type' => 'string', + 'example' => 'E2BD9DFC-6760-5F49-97C5-DA739E29****', + 'title' => '', + ], + 'ErrCode' => [ + 'description' => 'The error code.', + 'type' => 'string', + 'example' => 'Param.NotFound', + 'title' => '', + ], + 'Success' => [ + 'description' => 'Indicates whether the request is successful. Valid values:'."\n" + ."\n" + .'- **true**: The request is successful.'."\n" + ."\n" + .'- **false**: The request fails.', + 'type' => 'boolean', + 'example' => 'true', + 'title' => '', + ], + 'ErrMessage' => [ + 'description' => 'The error message.', + 'type' => 'string', + 'example' => 'The specified parameter %s value is not valid. ', + 'title' => '', + ], + 'Items' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'DBSRecoverRange' => [ + 'description' => 'The information about the time ranges to which you can restore data.', + 'type' => 'array', + 'items' => [ + 'description' => 'The information about the time range to which you can restore data.', + 'type' => 'object', + 'properties' => [ + 'EndTimestampForRestore' => [ + 'description' => 'The end of the time range to which you can restore data.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1646760308000', + 'title' => '', + ], + 'SourceEndpointInstanceType' => [ + 'description' => 'The location of the database.', + 'type' => 'string', + 'example' => 'rds', + 'title' => '', + ], + 'RangeType' => [ + 'description' => 'The type of the time range to which you can restore data.'."\n" + ."\n" + .'- **point**: The time range contains discrete points in time at which full backups were performed.'."\n" + ."\n" + .'- **range**: The time range is a period of time for which continuous backup is performed. You can specify a random point in time in the time range to restore data.', + 'type' => 'string', + 'example' => 'point', + 'title' => '', + ], + 'BeginTimestampForRestore' => [ + 'description' => 'The beginning of the time range to which you can restore data.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1646760282000', + 'title' => '', + ], + 'SourceEndpointInstanceID' => [ + 'description' => 'The ID of the database instance.', + 'type' => 'string', + 'example' => 'rm-bp106x9tk2c91****', + 'title' => '', + ], + 'FullBackupList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'FullBackupDetail' => [ + 'description' => 'If the value of the RangeType parameter is point, this parameter is returned. The value of this parameter describes information about all backup points in the time range.', + 'type' => 'array', + 'items' => [ + 'description' => 'The details of the backup point.', + 'type' => 'object', + 'properties' => [ + 'EndTime' => [ + 'description' => 'The end time of the full backup task. Example: 1646760308000.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1646760308000', + 'title' => '', + ], + 'StartTime' => [ + 'description' => 'The start time of the full backup task. Example: 1646760282000.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1646760282000', + 'title' => '', + ], + 'BackupSetId' => [ + 'description' => 'The ID of the backup set.', + 'type' => 'string', + 'example' => 'qecnsxkd****', + 'title' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'Request.Forbidden', + 'errorMessage' => 'Have no Permissions', + 'description' => '', + ], + ], + ], + 'title' => 'DescribeRestoreRangeInfo', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + [ + 'createdAt' => '2022-07-12T03:53:45.000Z', + 'description' => 'Error codes changed', + ], + ], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '100', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'DescribeRestoreRangeInfo', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dbs:DescribeRestoreRangeInfo', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DBS', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"E2BD9DFC-6760-5F49-97C5-DA739E29****\\",\\n \\"ErrCode\\": \\"Param.NotFound\\",\\n \\"Success\\": true,\\n \\"ErrMessage\\": \\"The specified parameter %s value is not valid. \\",\\n \\"Items\\": {\\n \\"DBSRecoverRange\\": [\\n {\\n \\"EndTimestampForRestore\\": 1646760308000,\\n \\"SourceEndpointInstanceType\\": \\"rds\\",\\n \\"RangeType\\": \\"point\\",\\n \\"BeginTimestampForRestore\\": 1646760282000,\\n \\"SourceEndpointInstanceID\\": \\"rm-bp106x9tk2c91****\\",\\n \\"FullBackupList\\": {\\n \\"FullBackupDetail\\": [\\n {\\n \\"EndTime\\": 1646760308000,\\n \\"StartTime\\": 1646760282000,\\n \\"BackupSetId\\": \\"qecnsxkd****\\"\\n }\\n ]\\n }\\n }\\n ]\\n }\\n}","type":"json"}]', + ], + 'DescribeRestoreTaskList' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREcbsKR7J6S', + ], + ], + 'parameters' => [ + [ + 'name' => 'BackupPlanId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the backup schedule.'."\n" + ."\n" + .'> Specify either BackupPlanId or RestoreTaskId.', + 'type' => 'string', + 'required' => false, + 'example' => 'dbs1hvb0wwwXXXXX', + 'title' => '', + ], + ], + [ + 'name' => 'RestoreTaskId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the restore job. You can specify multiple IDs. Separate them with commas (,). You can call the [CreateRestoreTask](~~2869836~~) operation to obtain this parameter.'."\n" + ."\n" + .'> Specify either RestoreTaskId or BackupPlanId. If you specify both, an error is returned.', + 'type' => 'string', + 'required' => false, + 'example' => 's102h7rf5anq', + 'title' => '', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of entries to return on each page. Valid values: 1 to 100.'."\n" + ."\n" + .'> The default value is 30.', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '30', + 'title' => '', + ], + ], + [ + 'name' => 'PageNum', + 'in' => 'query', + 'schema' => [ + 'description' => 'The page number. The value must be an integer that is greater than or equal to 0. The default value is 0.', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + 'title' => '', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => 'A client token that is used to ensure the idempotence of the request.', + 'type' => 'string', + 'required' => false, + 'example' => 'ETnLKlblzczshOTUbOCzxxxxxxx', + 'title' => '', + ], + ], + [ + 'name' => 'StartTimestamp', + 'in' => 'query', + 'schema' => [ + 'description' => 'The start time of the backup.', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1570701361528', + 'title' => '', + ], + ], + [ + 'name' => 'EndTimestamp', + 'in' => 'query', + 'schema' => [ + 'description' => 'The end time of the backup.', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1570701361528', + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The details of the returned parameters.', + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'The HTTP status code.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + 'title' => '', + ], + 'PageNum' => [ + 'description' => 'The page number.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + 'title' => '', + ], + 'RequestId' => [ + 'description' => 'The request ID.', + 'type' => 'string', + 'example' => '9C397502-B4F2-4E22-AD97-C81F0049F3F3', + 'title' => '', + ], + 'ErrCode' => [ + 'description' => 'The error code.', + 'type' => 'string', + 'example' => 'Param.NotFound', + 'title' => '', + ], + 'Success' => [ + 'description' => 'Indicates whether the request was successful.', + 'type' => 'boolean', + 'example' => 'true', + 'title' => '', + ], + 'ErrMessage' => [ + 'description' => 'The error message.', + 'type' => 'string', + 'example' => 'The specified parameter %s value is not valid. ', + 'title' => '', + ], + 'TotalPages' => [ + 'description' => 'The total number of pages.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + 'title' => '', + ], + 'TotalElements' => [ + 'description' => 'The total number of restore jobs.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + 'title' => '', + ], + 'PageSize' => [ + 'description' => 'The number of entries on the current page.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '30', + 'title' => '', + ], + 'Items' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'RestoreTaskDetail' => [ + 'description' => 'The details of the restore job.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'RestoreStatus' => [ + 'description' => 'The status of the restore job. Valid values:'."\n" + ."\n" + .'- init: The job is not started or the precheck failed.'."\n" + ."\n" + .'- running: The job is running.'."\n" + ."\n" + .'- stop: The job failed.'."\n" + ."\n" + .'- pause: The job is paused.'."\n" + ."\n" + .'- check\\_pass: The precheck is passed.', + 'type' => 'string', + 'example' => 'running', + 'title' => '', + ], + 'FullStruAfterRestoreProgress' => [ + 'description' => 'The progress of the post-restore full structure task.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + 'title' => '', + ], + 'CrossRoleName' => [ + 'description' => 'The name of the Resource Access Management (RAM) role used for cross-account backup.', + 'type' => 'string', + 'example' => 'test123', + 'title' => '', + ], + 'RestoreDir' => [ + 'description' => 'The restore path.', + 'type' => 'string', + 'example' => '100.X.X.10:33204', + 'title' => '', + ], + 'CrossAliyunId' => [ + 'description' => 'The UID of the Alibaba Cloud account used for cross-account backup.', + 'type' => 'string', + 'example' => '2xxx7778xxxxxxxxxx', + 'title' => '', + ], + 'RestoreObjects' => [ + 'description' => 'The objects to restore.', + 'type' => 'string', + 'example' => '[ { \\"DBName\\":\\"test\\" } ]', + 'title' => '', + ], + 'BackupPlanId' => [ + 'description' => 'The ID of the backup schedule.', + 'type' => 'string', + 'example' => 'dbs1hvb0wXXXX', + 'title' => '', + ], + 'DestinationEndpointRegion' => [ + 'description' => 'The region of the database.', + 'type' => 'string', + 'example' => 'cn-hangzhou', + 'title' => '', + ], + 'RestoreTaskCreateTime' => [ + 'description' => 'The time when the restore job was created. This is a UNIX timestamp. Unit: milliseconds. Example: 1554560477000.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1554560477000', + 'title' => '', + ], + 'DestinationEndpointUserName' => [ + 'description' => 'The database account.', + 'type' => 'string', + 'example' => 'test', + 'title' => '', + ], + 'RestoreTaskFinishTime' => [ + 'description' => 'The time when the restore job was completed. This is a UNIX timestamp. Unit: milliseconds. Example: 1554560477000.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1554560477000', + 'title' => '', + ], + 'DestinationEndpointIpPort' => [ + 'description' => 'The database endpoint.', + 'type' => 'string', + 'example' => '100.X.X.10:33204', + 'title' => '', + ], + 'DestinationEndpointDatabaseName' => [ + 'description' => 'The database name.', + 'type' => 'string', + 'example' => 'test', + 'title' => '', + ], + 'DestinationEndpointInstanceType' => [ + 'description' => 'The location of the database. Valid values:'."\n" + ."\n" + .'- RDS'."\n" + ."\n" + .'- ECS'."\n" + ."\n" + .'- Express: A database connected over a leased line, VPN Gateway, or Smart Access Gateway.'."\n" + ."\n" + .'- agent: A database connected through a backup gateway.'."\n" + ."\n" + .'- dds: ApsaraDB for MongoDB.'."\n" + ."\n" + .'- other: A database connected over the internet.', + 'type' => 'string', + 'example' => 'RDS', + 'title' => '', + ], + 'DestinationEndpointOracleSID' => [ + 'description' => 'The Oracle system ID (SID).', + 'type' => 'string', + 'example' => 'test', + 'title' => '', + ], + 'FullStruforeRestoreProgress' => [ + 'description' => 'The progress of the pre-restore full structure task.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + 'title' => '', + ], + 'ErrMessage' => [ + 'description' => 'The error message.', + 'type' => 'string', + 'example' => 'NULL', + 'title' => '', + ], + 'RestoreTaskId' => [ + 'description' => 'The ID of the restore job.', + 'type' => 'string', + 'example' => 's1XXXXXX', + 'title' => '', + ], + 'FullDataRestoreProgress' => [ + 'description' => 'The progress of the full data restore.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + 'title' => '', + ], + 'ContinuousRestoreProgress' => [ + 'description' => 'The progress of the incremental log restore.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + 'title' => '', + ], + 'DestinationEndpointInstanceID' => [ + 'description' => 'The ID of the database instance.', + 'type' => 'string', + 'example' => 'rm-bp1p8c2947XXX', + 'title' => '', + ], + 'BackupSetId' => [ + 'description' => 'The ID of the full backup set used for the restore.', + 'type' => 'string', + 'example' => '1ibh2f5uXXX', + 'title' => '', + ], + 'BackupGatewayId' => [ + 'description' => 'The ID of the backup gateway.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '324234332', + 'title' => '', + ], + 'RestoreTaskName' => [ + 'description' => 'The name of the restore job.', + 'type' => 'string', + 'example' => 'test', + 'title' => '', + ], + 'RestoreTime' => [ + 'description' => 'The time to which the database is restored. This is a UNIX timestamp. Unit: milliseconds. Example: 1554560477000.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1554560477000', + 'title' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'Request.Forbidden', + 'errorMessage' => 'Have no Permissions', + 'description' => '', + ], + ], + ], + 'title' => 'DescribeRestoreTaskList', + 'summary' => 'Queries the list of Database Backup Service (DBS) restore jobs.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + [ + 'createdAt' => '2022-07-12T03:53:45.000Z', + 'description' => 'Error codes changed', + ], + ], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '100', + 'countWindow' => 60, + 'regionId' => '*', + 'api' => 'DescribeRestoreTaskList', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dbs:DescribeRestoreTaskList', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DBS', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"PageNum\\": 1,\\n \\"RequestId\\": \\"9C397502-B4F2-4E22-AD97-C81F0049F3F3\\",\\n \\"ErrCode\\": \\"Param.NotFound\\",\\n \\"Success\\": true,\\n \\"ErrMessage\\": \\"The specified parameter %s value is not valid. \\",\\n \\"TotalPages\\": 1,\\n \\"TotalElements\\": 1,\\n \\"PageSize\\": 30,\\n \\"Items\\": {\\n \\"RestoreTaskDetail\\": [\\n {\\n \\"RestoreStatus\\": \\"running\\",\\n \\"FullStruAfterRestoreProgress\\": 100,\\n \\"CrossRoleName\\": \\"test123\\",\\n \\"RestoreDir\\": \\"100.X.X.10:33204\\",\\n \\"CrossAliyunId\\": \\"2xxx7778xxxxxxxxxx\\",\\n \\"RestoreObjects\\": \\"[ { \\\\\\\\\\\\\\"DBName\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"test\\\\\\\\\\\\\\" } ]\\",\\n \\"BackupPlanId\\": \\"dbs1hvb0wXXXX\\",\\n \\"DestinationEndpointRegion\\": \\"cn-hangzhou\\",\\n \\"RestoreTaskCreateTime\\": 1554560477000,\\n \\"DestinationEndpointUserName\\": \\"test\\",\\n \\"RestoreTaskFinishTime\\": 1554560477000,\\n \\"DestinationEndpointIpPort\\": \\"100.X.X.10:33204\\",\\n \\"DestinationEndpointDatabaseName\\": \\"test\\",\\n \\"DestinationEndpointInstanceType\\": \\"RDS\\",\\n \\"DestinationEndpointOracleSID\\": \\"test\\",\\n \\"FullStruforeRestoreProgress\\": 0,\\n \\"ErrMessage\\": \\"NULL\\",\\n \\"RestoreTaskId\\": \\"s1XXXXXX\\",\\n \\"FullDataRestoreProgress\\": 100,\\n \\"ContinuousRestoreProgress\\": 100,\\n \\"DestinationEndpointInstanceID\\": \\"rm-bp1p8c2947XXX\\",\\n \\"BackupSetId\\": \\"1ibh2f5uXXX\\",\\n \\"BackupGatewayId\\": 324234332,\\n \\"RestoreTaskName\\": \\"test\\",\\n \\"RestoreTime\\": 1554560477000\\n }\\n ]\\n }\\n}","type":"json"}]', + ], + 'DisableBackupLog' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREcbsKR7J6S', + ], + ], + 'parameters' => [ + [ + 'name' => 'BackupPlanId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The backup schedule ID. You can call the [DescribeBackupPlanList](~~2869825~~) operation to query the ID of the backup schedule.', + 'type' => 'string', + 'required' => true, + 'example' => 'dbstooi01****', + 'title' => '', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => 'The client token that is used to ensure the idempotence of the request.', + 'type' => 'string', + 'required' => false, + 'example' => 'ETnLKlblzczshOTUbOCziJZNwH****', + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'The HTTP status code.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + 'title' => '', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.', + 'type' => 'string', + 'example' => 'D6E068C3-25BC-455A-85FE-45F0B22ECB1F', + 'title' => '', + ], + 'ErrCode' => [ + 'description' => 'The error code.', + 'type' => 'string', + 'example' => 'Param.NotFound', + 'title' => '', + ], + 'Success' => [ + 'description' => 'Indicates whether the request is successful.', + 'type' => 'boolean', + 'example' => 'true', + 'title' => '', + ], + 'ErrMessage' => [ + 'description' => 'The error message.', + 'type' => 'string', + 'example' => 'findValidDBSJob error', + 'title' => '', + ], + 'BackupPlanId' => [ + 'description' => 'The backup schedule ID.', + 'type' => 'string', + 'example' => 'dbstooi01****', + 'title' => '', + ], + 'NeedPrecheck' => [ + 'description' => 'Indicates whether a precheck is triggered. Valid values:'."\n" + ."\n" + .'- true: A precheck is triggered. You must call the [StartBackupPlan](~~2869816~~) operation to start the backup schedule.'."\n" + ."\n" + .'- false: No precheck is triggered.', + 'type' => 'boolean', + 'example' => 'false', + 'title' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'Request.Forbidden', + 'errorMessage' => 'Have no Permissions', + 'description' => '', + ], + ], + ], + 'title' => 'DisableBackupLog', + 'summary' => 'Disables incremental backup for a backup schedule.', + 'description' => '### Impact'."\n" + ."\n" + .'After you disable the incremental log backup feature, your backup schedule no longer performs incremental log backups.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + [ + 'createdAt' => '2022-07-12T03:53:45.000Z', + 'description' => 'Error codes changed', + ], + ], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '10', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'DisableBackupLog', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dbs:DisableBackupLog', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DBS', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"D6E068C3-25BC-455A-85FE-45F0B22ECB1F\\",\\n \\"ErrCode\\": \\"Param.NotFound\\",\\n \\"Success\\": true,\\n \\"ErrMessage\\": \\"findValidDBSJob error\\",\\n \\"BackupPlanId\\": \\"dbstooi01****\\",\\n \\"NeedPrecheck\\": false\\n}","type":"json"}]', + ], + 'EnableBackupLog' => [ + 'summary' => 'Enables incremental backup for a backup schedule.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREcbsKR7J6S', + ], + ], + 'parameters' => [ + [ + 'name' => 'BackupPlanId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The backup schedule ID. You can call the [DescribeBackupPlanList](~~2869825~~) operation to obtain the ID.', + 'type' => 'string', + 'required' => true, + 'example' => 'dbstooi******', + 'title' => '', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => 'The client token that is used to ensure the idempotence of the request.', + 'type' => 'string', + 'required' => false, + 'example' => 'dbs', + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'The HTTP status code.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + 'title' => '', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.', + 'type' => 'string', + 'example' => 'D6E068C3-25BC-455A-85FE-45F0B22ECB1F', + 'title' => '', + ], + 'ErrCode' => [ + 'description' => 'The error code.', + 'type' => 'string', + 'example' => 'Param.NotFound', + 'title' => '', + ], + 'Success' => [ + 'description' => 'Indicates whether the request is successful. Valid values:'."\n" + ."\n" + .'- true: The request is successful.'."\n" + ."\n" + .'- false: The request fails.', + 'type' => 'boolean', + 'example' => 'true', + 'title' => '', + ], + 'ErrMessage' => [ + 'description' => 'The error message.', + 'type' => 'string', + 'example' => 'findValidDBSJob error', + 'title' => '', + ], + 'BackupPlanId' => [ + 'description' => 'The backup schedule ID.', + 'type' => 'string', + 'example' => 'dbstooi******', + 'title' => '', + ], + 'NeedPrecheck' => [ + 'description' => 'Indicates whether a precheck is triggered. Valid values:'."\n" + ."\n" + .'- true: A precheck is triggered. You must call the [StartBackupPlan](~~2869816~~) operation to start the backup schedule.'."\n" + ."\n" + .'- false: No precheck is triggered.', + 'type' => 'boolean', + 'example' => 'true', + 'title' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'Request.Forbidden', + 'errorMessage' => 'Have no Permissions', + 'description' => '', + ], + ], + ], + 'title' => 'EnableBackupLog', + 'description' => '## Impact'."\n" + ."\n" + .'It is free to enable the incremental log backup feature. However, the backup traffic and storage capacity generated by the feature are billed in the same way as the full backup feature, and can be offset by the free quota of backup schedules or storage plans.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + [ + 'createdAt' => '2022-07-12T03:53:45.000Z', + 'description' => 'Error codes changed', + ], + ], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '10', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'EnableBackupLog', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dbs:EnableBackupLog', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DBS', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"D6E068C3-25BC-455A-85FE-45F0B22ECB1F\\",\\n \\"ErrCode\\": \\"Param.NotFound\\",\\n \\"Success\\": true,\\n \\"ErrMessage\\": \\"findValidDBSJob error\\",\\n \\"BackupPlanId\\": \\"dbstooi******\\",\\n \\"NeedPrecheck\\": true\\n}","type":"json"}]', + ], + 'GetDBListFromAgent' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREcbsKR7J6S', + ], + ], + 'parameters' => [ + [ + 'name' => 'BackupGatewayId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the backup gateway.', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '160***', + 'title' => '', + ], + ], + [ + 'name' => 'SourceEndpointRegion', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region in which the backup gateway resides.', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + 'title' => '', + ], + ], + [ + 'name' => 'TaskId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the asynchronous task.', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '123456', + 'title' => '', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + '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 sure that it is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length.', + 'type' => 'string', + 'required' => false, + 'example' => 'ETnLKlblzczshOTUbOCzxxxxxxxxxx', + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'The HTTP status code.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '400', + 'title' => '', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.', + 'type' => 'string', + 'example' => 'EB4DFD5E-3618-498D-BE35-4DBEA0072122', + 'title' => '', + ], + 'ErrCode' => [ + 'description' => 'The error code.', + 'type' => 'string', + 'example' => 'InvalidParameter', + 'title' => '', + ], + 'Success' => [ + 'description' => 'Indicates whether the request is successful.', + 'type' => 'boolean', + 'example' => 'true', + 'title' => '', + ], + 'ErrMessage' => [ + 'description' => 'The error message.', + 'type' => 'string', + 'example' => 'This backupPlan can\'t support this action', + 'title' => '', + ], + 'DbList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'dbName' => [ + 'description' => 'The details of the databases.', + 'type' => 'array', + 'items' => [ + 'description' => 'The details of the databases.', + 'type' => 'string', + 'example' => 'TaskDB', + 'title' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'Request.Forbidden', + 'errorMessage' => 'Have no Permissions', + 'description' => '', + ], + ], + ], + 'title' => 'GetDBListFromAgent', + 'summary' => 'Queries the result of a task that is used to query a database list by using a backup gateway based on the ID of the task.', + 'description' => '您需要调用 [CreateGetDBListFromAgentTask](~~2869847~~) 接口创建一个异步任务获取 TaskId（异步任务 ID）。将 TaskId 传入 GetDBListFromAgent 接口后，即可获取物理备份库表数据。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + [ + 'createdAt' => '2022-07-12T03:53:45.000Z', + 'description' => 'Error codes changed', + ], + ], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '100', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'GetDBListFromAgent', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dbs:GetDBListFromAgent', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DBS', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 400,\\n \\"RequestId\\": \\"EB4DFD5E-3618-498D-BE35-4DBEA0072122\\",\\n \\"ErrCode\\": \\"InvalidParameter\\",\\n \\"Success\\": true,\\n \\"ErrMessage\\": \\"This backupPlan can\'t support this action\\",\\n \\"DbList\\": {\\n \\"dbName\\": [\\n \\"TaskDB\\"\\n ]\\n }\\n}","type":"json"}]', + ], + 'InitializeDbsServiceLinkedRole' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREcbsKR7J6S', + ], + ], + 'parameters' => [], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The following table describes the response parameters.', + 'type' => 'object', + 'properties' => [ + 'Data' => [ + 'description' => 'An empty value.', + 'type' => 'string', + 'example' => 'null', + 'title' => '', + ], + 'RequestId' => [ + 'description' => 'The request ID.', + 'type' => 'string', + 'example' => '4F1888AC-1138-4995-B9FE-D2734F61C058', + 'title' => '', + ], + 'Success' => [ + 'description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'- **true**: The request was successful.'."\n" + ."\n" + .'- **false**: The request failed.', + 'type' => 'string', + 'example' => 'true', + 'title' => '', + ], + 'ErrorCode' => [ + 'description' => 'The error code.', + 'type' => 'string', + 'example' => 'EntityAlreadyExists.Role', + 'title' => '', + ], + 'ErrMessage' => [ + 'description' => 'The error message.', + 'type' => 'string', + 'example' => 'EntityAlreadyExists.Role : The role already exists:AliyunServiceRoleForDBS\\r\\nRequestId : 73******-3B4D-501A-9505-FA8B9******', + 'title' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'Request.Forbidden', + 'errorMessage' => 'Have no Permissions', + 'description' => '', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'title' => 'InitializeDbsServiceLinkedRole', + 'summary' => 'Grants the service-linked role (AliyunServiceRoleForDBS) to Database Backup (DBS).', + 'description' => 'DBS uses the service-linked role (AliyunServiceRoleForDBS) to obtain the required access permissions to connect to ApsaraDB databases, such as RDS, MongoDB, Redis, and PolarDB, or self-managed databases on ECS instances. For more information, see [Activate the Database Backup service](~~162603~~).', + 'requestParamsDescription' => 'This API has no request parameters.', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + [ + 'createdAt' => '2022-07-12T03:53:45.000Z', + 'description' => 'Error codes changed', + ], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'dbs:InitializeDbsServiceLinkedRole', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DBS', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": \\"null\\",\\n \\"RequestId\\": \\"4F1888AC-1138-4995-B9FE-D2734F61C058\\",\\n \\"Success\\": \\"true\\",\\n \\"ErrorCode\\": \\"EntityAlreadyExists.Role\\",\\n \\"ErrMessage\\": \\"EntityAlreadyExists.Role : The role already exists:AliyunServiceRoleForDBS\\\\\\\\r\\\\\\\\nRequestId : 73******-3B4D-501A-9505-FA8B9******\\"\\n}","type":"json"}]', + ], + 'ModifyBackupObjects' => [ + 'summary' => 'Modifies the objects included in a Database Backup Service (DBS) backup plan.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '105089', + 'abilityTreeNodes' => [ + 'FEATUREcbsUOJI4N', + ], + ], + 'parameters' => [ + [ + 'name' => 'BackupPlanId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the backup plan.', + 'type' => 'string', + 'required' => true, + 'example' => 'dbs1h****usfa', + 'title' => '', + ], + ], + [ + 'name' => 'BackupObjects', + 'in' => 'query', + 'schema' => [ + 'description' => 'The backup objects, specified as a JSON string. The structure is as follows:'."\n" + ."\n" + .'```'."\n" + .'['."\n" + .' {'."\n" + .' "DBName":"The name of the database to back up",'."\n" + .' "SchemaName":"The name of the schema to back up",'."\n" + .' "TableIncludes":[{'."\n" + .' "TableName":"The name of the table to back up"'."\n" + .' }],'."\n" + .' "TableExcludes":[{'."\n" + .' "TableName":"The name of a table in the database that you do not want to back up"'."\n" + .' }]'."\n" + .' }'."\n" + .']'."\n" + .'```'."\n" + ."\n" + .'- If you specify only `DBName` without configuring rules for sub-objects, all objects in the database are backed up.'."\n" + ."\n" + .'- If you specify `DBName` and configure rules for some objects, any objects without configured rules are not backed up by default. The following regular expressions are supported for defining object names:'."\n" + ."\n" + .' - A period (`.`) matches any single character except `'."\r\n" + .'`.'."\n" + ."\n" + .' - An asterisk (`*`) matches the preceding subexpression zero or more times. For example, `h*llo` matches `hllo` and `heeeello`.'."\n" + ."\n" + .' - A question mark (`?`) matches the preceding subexpression zero or one time. For example, `h.?llo` matches `hllo` and `hello`, but not `haello`.'."\n" + ."\n" + .' - A character set `[characters]` matches any single character within the brackets. For example, `h[aello]` matches `hallo` and `hello`.'."\n" + ."\n" + .' - A negated character set `[^characters]` matches any single character not within the brackets. For example, `h[^ae]llo` matches `hcllo` and `hdllo`, but not `hallo` or `hello`.'."\n" + ."\n" + .' - A character range `[character1-character2]` matches any character within the specified range, such as `[0-9]` or `[a-z]`.'."\n" + ."\n" + .'> `SchemaName` and `NewSchemaName` are used only for SQL Server. For other database engines, use `DBName` and `NewDBName` to specify database names.', + 'type' => 'string', + 'required' => true, + 'example' => '[ { "DBName":"17xxx92xxxx374", "SchemaName":"gy9xnj8xxxxxx", "TableIncludes":[{ "TableName":"test1" }], "TableExcludes":[{ "TableName":"test2" }] } ]', + 'title' => '', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => 'A client token to ensure the request is idempotent. This prevents the same request from being submitted multiple times.', + 'type' => 'string', + 'required' => false, + 'example' => 'ETnLKlblzczshOTUbOCzxxxxxxx', + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The returned parameters.', + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'The HTTP status code.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + 'title' => '', + ], + 'RequestId' => [ + 'description' => 'The request ID.', + 'type' => 'string', + 'example' => 'D6E068C3-25BC-455A-85FE-45F0B22ECB1F', + 'title' => '', + ], + 'ErrCode' => [ + 'description' => 'The error code.', + 'type' => 'string', + 'example' => 'InvalidParameter', + 'title' => '', + ], + 'Success' => [ + 'description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'- **true**: The request was successful.'."\n" + ."\n" + .'- **false**: The request failed.', + 'type' => 'boolean', + 'example' => 'true', + 'title' => '', + ], + 'ErrMessage' => [ + 'description' => 'The error message.', + 'type' => 'string', + 'example' => 'The specified parameter %s value is not valid. ', + 'title' => '', + ], + 'BackupPlanId' => [ + 'description' => 'The ID of the backup plan.', + 'type' => 'string', + 'example' => 'dbs1h****usfa', + 'title' => '', + ], + 'NeedPrecheck' => [ + 'description' => 'Indicates whether the modification triggers a precheck. If this parameter is set to true, call the [StartBackupPlan](~~2869816~~) operation to start the backup plan.', + 'type' => 'boolean', + 'example' => 'true', + 'title' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'Request.Forbidden', + 'errorMessage' => 'Have no Permissions', + 'description' => '', + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'title' => 'ModifyBackupObjects', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + [ + 'createdAt' => '2022-07-12T03:53:45.000Z', + 'description' => 'Error codes changed', + ], + ], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '10', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'ModifyBackupObjects', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dbs:ModifyBackupObjects', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DBS', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"D6E068C3-25BC-455A-85FE-45F0B22ECB1F\\",\\n \\"ErrCode\\": \\"InvalidParameter\\",\\n \\"Success\\": true,\\n \\"ErrMessage\\": \\"The specified parameter %s value is not valid. \\",\\n \\"BackupPlanId\\": \\"dbs1h****usfa\\",\\n \\"NeedPrecheck\\": true\\n}","type":"json"}]', + ], + 'ModifyBackupPlanName' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREcbsKR7J6S', + ], + ], + 'parameters' => [ + [ + 'name' => 'BackupPlanId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the backup plan.', + 'type' => 'string', + 'required' => true, + 'example' => 'dbstooi0XXXX', + 'title' => '', + ], + ], + [ + 'name' => 'BackupPlanName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the backup plan.', + 'type' => 'string', + 'required' => true, + 'example' => 'dbstooi0XXXX', + 'title' => '', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => 'The client token that is used to ensure the idempotence of the request. This prevents the same request from being submitted multiple times.', + 'type' => 'string', + 'required' => false, + 'example' => 'ETnLKlblzczshOTUbOCzxxxxxxx', + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'The HTTP status code.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + 'title' => '', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.', + 'type' => 'string', + 'example' => 'D6E068C3-25BC-455A-85FE-45F0B22ECB1F', + 'title' => '', + ], + 'ErrCode' => [ + 'description' => 'The error code.', + 'type' => 'string', + 'example' => 'Param.NotFound', + 'title' => '', + ], + 'Success' => [ + 'description' => 'Indicates whether the request was successful.', + 'type' => 'boolean', + 'example' => 'true', + 'title' => '', + ], + 'ErrMessage' => [ + 'description' => 'The error message.', + 'type' => 'string', + 'example' => 'The specified parameter %s value is not valid. ', + 'title' => '', + ], + 'BackupPlanId' => [ + 'description' => 'The ID of the backup plan.', + 'type' => 'string', + 'example' => 'dbstooi0XXXX', + 'title' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'Request.Forbidden', + 'errorMessage' => 'Have no Permissions', + 'description' => '', + ], + ], + ], + 'title' => 'ModifyBackupPlanName', + 'summary' => 'Modifies the name of a backup plan.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + [ + 'createdAt' => '2022-07-12T03:53:45.000Z', + 'description' => 'Error codes changed', + ], + ], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '10', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'ModifyBackupPlanName', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dbs:ModifyBackupPlanName', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DBS', + 'resourceType' => 'BackupPlan', + 'arn' => 'acs:dbs:{#regionId}:{#accountId}:backupplan/{#BackupPlanId}', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"D6E068C3-25BC-455A-85FE-45F0B22ECB1F\\",\\n \\"ErrCode\\": \\"Param.NotFound\\",\\n \\"Success\\": true,\\n \\"ErrMessage\\": \\"The specified parameter %s value is not valid. \\",\\n \\"BackupPlanId\\": \\"dbstooi0XXXX\\"\\n}","type":"json"}]', + ], + 'ModifyBackupSetDownloadRules' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREcbsKR7J6S', + ], + ], + 'parameters' => [ + [ + 'name' => 'BackupPlanId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the backup schedule.', + 'type' => 'string', + 'required' => true, + 'example' => 'dbstooi01xxxx', + 'title' => '', + ], + ], + [ + 'name' => 'OpenAutoDownload', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to enable the automatic download feature. Default value: false.', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + 'title' => '', + ], + ], + [ + 'name' => 'BackupGatewayId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the backup gateway that is used to download the backup set.', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '23312323', + 'title' => '', + ], + ], + [ + 'name' => 'FullDataFormat', + 'in' => 'query', + 'schema' => [ + 'description' => 'The format in which the full backup set is downloaded. Valid values:'."\n" + ."\n" + .'- Native'."\n" + ."\n" + .'- SQL'."\n" + ."\n" + .'- CSV'."\n" + ."\n" + .'- JSON'."\n" + ."\n" + .'> Default value: CSV.', + 'type' => 'string', + 'required' => false, + 'example' => 'CSV', + 'title' => '', + ], + ], + [ + 'name' => 'IncrementDataFormat', + 'in' => 'query', + 'schema' => [ + 'description' => 'The format in which the incremental backup set is downloaded. Valid values:'."\n" + ."\n" + .'- Native'."\n" + ."\n" + .'- SQL'."\n" + ."\n" + .'- CSV'."\n" + ."\n" + .'- JSON'."\n" + ."\n" + .'> Default value: Native.', + 'type' => 'string', + 'required' => false, + 'example' => 'Native', + 'title' => '', + ], + ], + [ + 'name' => 'BackupSetDownloadDir', + 'in' => 'query', + 'schema' => [ + 'description' => 'The server directory to which the backup set is downloaded.', + 'type' => 'string', + 'required' => false, + 'example' => 'test', + 'title' => '', + ], + ], + [ + 'name' => 'BackupSetDownloadTargetType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of the destination server to which the backup set is downloaded.'."\n" + ."\n" + .'> Set the value to agent, which indicates a server on which a backup gateway is installed.', + 'type' => 'string', + 'required' => false, + 'example' => 'agent', + 'title' => '', + ], + ], + [ + 'name' => 'BackupSetDownloadTargetTypeLocation', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of the destination directory to which the backup set is downloaded. This parameter is required if the automatic download feature is enabled. Valid values:'."\n" + ."\n" + .'- local'."\n" + ."\n" + .'- nas'."\n" + ."\n" + .'- ftp'."\n" + ."\n" + .'- minio'."\n" + ."\n" + .'> Default value: local.', + 'type' => 'string', + 'required' => false, + 'example' => 'local', + 'title' => '', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => 'The client token that is used to ensure the idempotence of the request.', + 'type' => 'string', + 'required' => false, + 'example' => 'ETnLKlblzczshOTUbOCzxxxxxxx', + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'The HTTP status code.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + 'title' => '', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.', + 'type' => 'string', + 'example' => 'D6E068C3-25BC-455A-85FE-45F0B22ECB1F', + 'title' => '', + ], + 'ErrCode' => [ + 'description' => 'The error code.', + 'type' => 'string', + 'example' => 'Param.NotFound', + 'title' => '', + ], + 'Success' => [ + 'description' => 'Indicates whether the request is successful.', + 'type' => 'boolean', + 'example' => 'true', + 'title' => '', + ], + 'ErrMessage' => [ + 'description' => 'The error message.', + 'type' => 'string', + 'example' => 'The specified parameter %s value is not valid. ', + 'title' => '', + ], + 'BackupPlanId' => [ + 'description' => 'The ID of the backup schedule.', + 'type' => 'string', + 'example' => 'dbstooi01exxxx', + 'title' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'Request.Forbidden', + 'errorMessage' => 'Have no Permissions', + 'description' => '', + ], + ], + ], + 'title' => 'ModifyBackupSetDownloadRules', + 'summary' => 'Enables, configures, or disables the automatic download feature.', + 'description' => '使用本接口前请先确认备份数据是否存储在 DBS 的内置 OSS 上，您可通过调用 [DescribeBackupPlanList](~~2869825~~) 接口查看 BackupStorageType 取值情况。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + [ + 'createdAt' => '2022-07-12T03:53:45.000Z', + 'description' => 'Error codes changed', + ], + ], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '10', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'ModifyBackupSetDownloadRules', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dbs:ModifyBackupSetDownloadRules', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DBS', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"D6E068C3-25BC-455A-85FE-45F0B22ECB1F\\",\\n \\"ErrCode\\": \\"Param.NotFound\\",\\n \\"Success\\": true,\\n \\"ErrMessage\\": \\"The specified parameter %s value is not valid. \\",\\n \\"BackupPlanId\\": \\"dbstooi01exxxx\\"\\n}","type":"json"}]', + ], + 'ModifyBackupSourceEndpoint' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREcbsKR7J6S', + ], + ], + 'parameters' => [ + [ + 'name' => 'BackupPlanId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the backup plan. Call the [DescribeBackupPlanList](~~2869825~~) operation to obtain the value of this parameter.', + 'type' => 'string', + 'required' => true, + 'example' => 'dbs1h****usfa', + 'title' => '', + ], + ], + [ + 'name' => 'SourceEndpointInstanceType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The location of the database. Call the [DescribeBackupPlanList](~~2869825~~) operation to obtain the value of this parameter. Valid values:'."\n" + ."\n" + .'- **RDS**'."\n" + ."\n" + .'- **ECS**'."\n" + ."\n" + .'- **Express**: A database connected over a leased line, VPN Gateway, or Smart Access Gateway.'."\n" + ."\n" + .'- **Agent**: A database connected through a backup gateway.'."\n" + ."\n" + .'- **DDS**: An ApsaraDB for MongoDB instance.'."\n" + ."\n" + .'- **Other**: A database connected using an IP address and a port number.', + 'type' => 'string', + 'required' => true, + 'example' => 'RDS', + 'title' => '', + ], + ], + [ + 'name' => 'SourceEndpointRegion', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region of the database. Call the [DescribeBackupPlanList](~~2869825~~) operation to obtain the value of this parameter.'."\n" + ."\n" + .'> This parameter is required if **SourceEndpointInstanceType** is set to RDS, ECS, DDS, Express, or Agent.', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + 'title' => '', + ], + ], + [ + 'name' => 'SourceEndpointInstanceID', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the database instance. Call the [DescribeBackupPlanList](~~2869825~~) operation to obtain the value of this parameter.'."\n" + ."\n" + .'> This parameter is required if **SourceEndpointInstanceType** is set to RDS, ECS, DDS, or Express.', + 'type' => 'string', + 'required' => false, + 'example' => 'rm-bp1p8c29479jv****', + 'title' => '', + ], + ], + [ + 'name' => 'SourceEndpointIP', + 'in' => 'query', + 'schema' => [ + 'description' => 'The database endpoint. Call the [DescribeBackupPlanList](~~2869825~~) operation to obtain the value of this parameter.'."\n" + ."\n" + .'> This parameter is required if **SourceEndpointInstanceType** is set to Express, Agent, or Other.', + 'type' => 'string', + 'required' => false, + 'example' => '100.*.*.10:3306', + 'title' => '', + ], + ], + [ + 'name' => 'SourceEndpointPort', + 'in' => 'query', + 'schema' => [ + 'description' => 'The database port. Call the [DescribeBackupPlanList](~~2869825~~) operation to obtain the value of this parameter.'."\n" + ."\n" + .'> This parameter is required if **SourceEndpointInstanceType** is set to Express, Agent, Other, or ECS.', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '3306', + 'title' => '', + ], + ], + [ + 'name' => 'SourceEndpointDatabaseName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The database name.'."\n" + ."\n" + .'- This parameter is required if the database type is PostgreSQL or MongoDB.'."\n" + ."\n" + .'- This parameter is required if SourceEndpointInstanceType is set to Agent and the database type is MSSQL.', + 'type' => 'string', + 'required' => false, + 'example' => 'test', + 'title' => '', + ], + ], + [ + 'name' => 'SourceEndpointUserName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The database account. Call the [DescribeBackupPlanList](~~2869825~~) operation to obtain the value of this parameter.'."\n" + ."\n" + .'This parameter is optional if the database type is Redis, or if SourceEndpointInstanceType is set to Agent and the database type is MSSQL. In all other scenarios, this parameter is required.', + 'type' => 'string', + 'required' => false, + 'example' => 'test', + 'title' => '', + ], + ], + [ + 'name' => 'SourceEndpointPassword', + 'in' => 'query', + 'schema' => [ + 'description' => 'The password.'."\n" + ."\n" + .'This parameter is optional if the database type is Redis, or if SourceEndpointInstanceType is set to Agent and the database type is MSSQL. In all other scenarios, this parameter is required.', + 'type' => 'string', + 'required' => false, + 'example' => 'test', + 'title' => '', + ], + ], + [ + 'name' => 'BackupGatewayId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the backup gateway. Call the [DescribeBackupPlanList](~~2869825~~) operation to obtain the value of this parameter.'."\n" + ."\n" + .'> This parameter is required if **SourceEndpointInstanceType** is set to Agent.', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '21321323213', + 'title' => '', + ], + ], + [ + 'name' => 'BackupObjects', + 'in' => 'query', + 'schema' => [ + 'description' => 'The backup objects. This parameter is optional if SourceEndpointInstanceType is set to Agent. In all other scenarios, this parameter is required. Call the [DescribeBackupPlanList](~~2869825~~) operation to obtain the value of this parameter.', + 'type' => 'string', + 'required' => false, + 'example' => '[{ "DBName":"待备份库名", "SchemaName":"待备份 Schema 名", "TableIncludes":[{ "TableName":"待备份表表名" }], "TableExcludes":[{"TableName":"待备份库名不需要备份表的表名" }] } ]', + 'title' => '', + ], + ], + [ + 'name' => 'SourceEndpointOracleSID', + 'in' => 'query', + 'schema' => [ + 'description' => 'The Oracle system ID (SID). This parameter is required if the database type is Oracle.', + 'type' => 'string', + 'required' => false, + 'example' => 'test', + 'title' => '', + ], + ], + [ + 'name' => 'CrossAliyunId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The UID of the Alibaba Cloud account that is used for cross-account backup. Call the [DescribeRestoreTaskList](~~2869838~~) operation to obtain the value of this parameter.', + 'type' => 'string', + 'required' => false, + 'example' => '2xxx7778xxxxxxxxxx', + 'title' => '', + ], + ], + [ + 'name' => 'CrossRoleName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the RAM role that is created for cross-account backup. Call the [DescribeRestoreTaskList](~~2869838~~) operation to obtain the value of this parameter.', + 'type' => 'string', + 'required' => false, + 'example' => 'test123', + 'title' => '', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => 'A string that is used to ensure the idempotence of the request. This prevents repeated request submissions.', + 'type' => 'string', + 'required' => false, + 'example' => 'ETnLKlblzczshOTUbOCzxxxxxxx', + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'The HTTP status code.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + 'title' => '', + ], + 'RequestId' => [ + 'description' => 'The request ID.', + 'type' => 'string', + 'example' => 'D6E068C3-25BC-455A-85FE-45F0B22E****', + 'title' => '', + ], + 'ErrCode' => [ + 'description' => 'The error code.', + 'type' => 'string', + 'example' => 'Param.NotFound', + 'title' => '', + ], + 'Success' => [ + 'description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'- **true**: The request was successful.'."\n" + ."\n" + .'- **false**: The request failed.', + 'type' => 'boolean', + 'example' => 'true', + 'title' => '', + ], + 'ErrMessage' => [ + 'description' => 'The error message.', + 'type' => 'string', + 'example' => 'The specified parameter %s value is not valid. ', + 'title' => '', + ], + 'BackupPlanId' => [ + 'description' => 'The ID of the backup plan.', + 'type' => 'string', + 'example' => 'dbs1h****usfa', + 'title' => '', + ], + 'NeedPrecheck' => [ + 'description' => 'Indicates whether the modification triggers a precheck. If the value is true, you must call the StartBackupPlan operation to start the backup plan.', + 'type' => 'boolean', + 'example' => 'false', + 'title' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'Request.Forbidden', + 'errorMessage' => 'Have no Permissions', + 'description' => '', + ], + ], + ], + 'title' => 'ModifyBackupSourceEndpoint', + 'summary' => 'Modifies the source endpoint of a database backup.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + [ + 'createdAt' => '2022-07-12T03:53:30.000Z', + 'description' => 'Error codes changed', + ], + ], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '10', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'ModifyBackupSourceEndpoint', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dbs:ModifyBackupSourceEndpoint', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DBS', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"D6E068C3-25BC-455A-85FE-45F0B22E****\\",\\n \\"ErrCode\\": \\"Param.NotFound\\",\\n \\"Success\\": true,\\n \\"ErrMessage\\": \\"The specified parameter %s value is not valid. \\",\\n \\"BackupPlanId\\": \\"dbs1h****usfa\\",\\n \\"NeedPrecheck\\": false\\n}","type":"json"}]', + ], + 'ModifyBackupStrategy' => [ + 'summary' => 'Modifies the backup time of a backup schedule.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREcbsKR7J6S', + ], + ], + 'parameters' => [ + [ + 'name' => 'BackupPlanId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the backup schedule.', + 'type' => 'string', + 'required' => true, + 'example' => 'dbstooi01XXXX', + 'title' => '', + ], + ], + [ + 'name' => 'BackupPeriod', + 'in' => 'query', + 'schema' => [ + 'description' => 'The day of each week when the full backup task runs. Valid values:'."\n" + ."\n" + .'- Monday'."\n" + ."\n" + .'- Tuesday'."\n" + ."\n" + .'- Wednesday'."\n" + ."\n" + .'- Thursday'."\n" + ."\n" + .'- Friday'."\n" + ."\n" + .'- Saturday'."\n" + ."\n" + .'- Sunday', + 'type' => 'string', + 'required' => true, + 'example' => 'Monday,Tuesday,Wednesday', + 'title' => '', + ], + ], + [ + 'name' => 'BackupStartTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'The start time of the full backup task. Specify the time in the HH:mm format.', + 'type' => 'string', + 'required' => false, + 'example' => '14:22', + 'title' => '', + ], + ], + [ + 'name' => 'BackupStrategyType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The backup method that you want to use for full backups. Valid values:'."\n" + ."\n" + .'- **simple**: scheduled backup. If you specify this value for the BackupStrategyType parameter, you must also specify the BackupPeriod and BackupStartTime parameters.'."\n" + ."\n" + .'- **Manual**: manual backup.'."\n" + ."\n" + .'> Default value: **simple**.', + 'type' => 'string', + 'required' => false, + 'example' => 'simple', + 'title' => '', + ], + ], + [ + 'name' => 'BackupLogIntervalSeconds', + 'in' => 'query', + 'schema' => [ + 'description' => 'The interval at which you want to perform incremental log backups. Unit: seconds.'."\n" + ."\n" + .'> This parameter takes effect only when physical backups are performed.', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1000', + 'title' => '', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => 'The client token that is used to ensure the idempotence of the request.', + 'type' => 'string', + 'required' => false, + 'example' => 'ETnLKlblzczshOTUbOCzxxxxxxx', + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'The HTTP status code.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + 'title' => '', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.', + 'type' => 'string', + 'example' => 'D6E068C3-25BC-455A-85FE-45F0B22ECB1F', + 'title' => '', + ], + 'ErrCode' => [ + 'description' => 'The error code.', + 'type' => 'string', + 'example' => 'Param.NotFound', + 'title' => '', + ], + 'Success' => [ + 'description' => 'Indicates whether the request is successful.', + 'type' => 'boolean', + 'example' => 'true', + 'title' => '', + ], + 'ErrMessage' => [ + 'description' => 'The error message.', + 'type' => 'string', + 'example' => 'The specified parameter %s value is not valid. ', + 'title' => '', + ], + 'BackupPlanId' => [ + 'description' => 'The ID of the backup schedule.', + 'type' => 'string', + 'example' => 'dbstooi01XXXX', + 'title' => '', + ], + 'NeedPrecheck' => [ + 'description' => 'Indicates whether a precheck is triggered. If the value of this parameter is true, you must start the backup schedule by calling the StartBackupPlan operation.', + 'type' => 'boolean', + 'example' => 'false', + 'title' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'Request.Forbidden', + 'errorMessage' => 'Have no Permissions', + 'description' => '', + ], + ], + ], + 'title' => 'ModifyBackupStrategy', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + [ + 'createdAt' => '2022-07-12T03:53:30.000Z', + 'description' => 'Error codes changed', + ], + ], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '10', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'ModifyBackupStrategy', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dbs:ModifyBackupStrategy', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DBS', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"D6E068C3-25BC-455A-85FE-45F0B22ECB1F\\",\\n \\"ErrCode\\": \\"Param.NotFound\\",\\n \\"Success\\": true,\\n \\"ErrMessage\\": \\"The specified parameter %s value is not valid. \\",\\n \\"BackupPlanId\\": \\"dbstooi01XXXX\\",\\n \\"NeedPrecheck\\": false\\n}","type":"json"}]', + ], + 'ModifyStorageStrategy' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREcbsKR7J6S', + ], + ], + 'parameters' => [ + [ + 'name' => 'BackupPlanId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the backup schedule. You can call the [DescribeBackupPlanList](~~2869825~~) operation to obtain the ID.', + 'type' => 'string', + 'required' => true, + 'example' => 'dbsqdss5tmh****', + 'title' => '', + ], + ], + [ + 'name' => 'BackupRetentionPeriod', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of days for which the backup data is retained. Valid values: 0 to 1825.'."\n" + ."\n" + .'> Default value: 730.', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '730', + 'title' => '', + ], + ], + [ + 'name' => 'DuplicationInfrequentAccessPeriod', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of days after which the storage class of the backup data is changed to Infrequent Access (IA). The value of this parameter must be smaller than the value of the DuplicationArchivePeriod parameter. For more information about the IA storage class, see [Storage class overview](~~51374~~).'."\n" + ."\n" + .'> Default value: 180.', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '190', + 'title' => '', + ], + ], + [ + 'name' => 'DuplicationArchivePeriod', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of days after which the storage class of the backup data is changed to Archive. The value of this parameter must be smaller than the value of the BackupRetentionPeriod parameter. For more information about the Archive storage class, see [Storage class overview](~~51374~~).'."\n" + ."\n" + .'> Default value: 365.', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '366', + 'title' => '', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => 'The client token that is used to ensure the idempotence of the request.', + 'type' => 'string', + 'required' => false, + 'example' => 'dbstest', + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The response parameters.', + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'The HTTP status code.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + 'title' => '', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.', + 'type' => 'string', + 'example' => 'E995F91F-6F89-503B-9F7D-502F58FD****', + 'title' => '', + ], + 'ErrCode' => [ + 'description' => 'The error code.', + 'type' => 'string', + 'example' => 'Param.NotFound', + 'title' => '', + ], + 'Success' => [ + 'description' => 'Indicates whether the request is successful. Valid values:'."\n" + ."\n" + .'- **true**: The request is successful.'."\n" + ."\n" + .'- **false**: The request fails.', + 'type' => 'boolean', + 'example' => 'true', + 'title' => '', + ], + 'ErrMessage' => [ + 'description' => 'The error message.', + 'type' => 'string', + 'example' => 'findValidDBSJob error', + 'title' => '', + ], + 'BackupPlanId' => [ + 'description' => 'The ID of the backup schedule.', + 'type' => 'string', + 'example' => 'dbsqdss5tmh****', + 'title' => '', + ], + 'NeedPrecheck' => [ + 'description' => 'Indicates whether a precheck is triggered. Valid values:'."\n" + ."\n" + .'- **true**: A precheck is triggered. You must manually call the [StartBackupPlan](~~2869818~~) operation to start the backup schedule.'."\n" + ."\n" + .'- **false**: No precheck is triggered.', + 'type' => 'boolean', + 'example' => 'false', + 'title' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'Request.Forbidden', + 'errorMessage' => 'Have no Permissions', + 'description' => '', + ], + ], + ], + 'title' => 'ModifyStorageStrategy', + 'summary' => 'Modifies the lifecycle of data that is backed up based on a backup schedule.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + [ + 'createdAt' => '2022-07-12T03:53:30.000Z', + 'description' => 'Error codes changed', + ], + ], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '10', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'ModifyStorageStrategy', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dbs:ModifyStorageStrategy', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DBS', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"E995F91F-6F89-503B-9F7D-502F58FD****\\",\\n \\"ErrCode\\": \\"Param.NotFound\\",\\n \\"Success\\": true,\\n \\"ErrMessage\\": \\"findValidDBSJob error\\",\\n \\"BackupPlanId\\": \\"dbsqdss5tmh****\\",\\n \\"NeedPrecheck\\": false\\n}","type":"json"}]', + ], + 'ReleaseBackupPlan' => [ + 'summary' => 'This operation releases a pay-as-you-go backup plan.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREcbsKR7J6S', + ], + ], + 'parameters' => [ + [ + 'name' => 'BackupPlanId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the backup plan. You can call the [DescribeBackupPlanList](~~2869825~~) operation to query the ID.', + 'type' => 'string', + 'required' => true, + 'example' => 'dbstooi01xxxx', + 'title' => '', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => 'An arbitrary string.', + 'type' => 'string', + 'required' => false, + 'example' => 'dbs', + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'The HTTP status code.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + 'title' => '', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.', + 'type' => 'string', + 'example' => 'D6E068C3-25BC-455A-85FE-45F0B22ECB1F', + 'title' => '', + ], + 'ErrCode' => [ + 'description' => 'The error code.', + 'type' => 'string', + 'example' => 'Param.NotFound', + 'title' => '', + ], + 'Success' => [ + 'description' => 'Indicates whether the request is successful. Valid values:'."\n" + ."\n" + .'- true: The request is successful.'."\n" + ."\n" + .'- false: The request failed.', + 'type' => 'boolean', + 'example' => 'true', + 'title' => '', + ], + 'ErrMessage' => [ + 'description' => 'The error message.', + 'type' => 'string', + 'example' => 'findValidDBSJob error', + 'title' => '', + ], + 'BackupPlanId' => [ + 'description' => 'The ID of the backup plan.', + 'type' => 'string', + 'example' => 'dbstooi01xxxx', + 'title' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'Request.Forbidden', + 'errorMessage' => 'Have no Permissions', + 'description' => '', + ], + ], + ], + 'title' => 'ReleaseBackupPlan', + 'description' => '## Impact'."\n" + ."\n" + .'After you release a backup plan, the service for the backup instance is stopped and you are no longer charged for the instance.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + [ + 'createdAt' => '2022-07-12T03:53:30.000Z', + 'description' => 'Error codes changed', + ], + ], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '10', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'ReleaseBackupPlan', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'dbs:ReleaseBackupPlan', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DBS', + 'resourceType' => 'BackupPlan', + 'arn' => 'acs:dbs:{#regionId}:{#accountId}:backupplan/{#BackupPlanId}', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"D6E068C3-25BC-455A-85FE-45F0B22ECB1F\\",\\n \\"ErrCode\\": \\"Param.NotFound\\",\\n \\"Success\\": true,\\n \\"ErrMessage\\": \\"findValidDBSJob error\\",\\n \\"BackupPlanId\\": \\"dbstooi01xxxx\\"\\n}","type":"json"}]', + ], + 'RenewBackupPlan' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREcbsKR7J6S', + ], + ], + 'parameters' => [ + [ + 'name' => 'BackupPlanId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the backup schedule.', + 'type' => 'string', + 'required' => true, + 'example' => 'dbstooi01exxx', + 'title' => '', + ], + ], + [ + 'name' => 'Period', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to use yearly subscription or monthly subscription for the instance. Valid values:'."\n" + ."\n" + .'- Year'."\n" + ."\n" + .'- Month', + 'type' => 'string', + 'required' => true, + 'example' => 'Month', + 'title' => '', + ], + ], + [ + 'name' => 'UsedTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'The subscription duration of the instance. Valid values:'."\n" + ."\n" + .'- If the Period parameter is set to Year, the value of the UsedTime parameter ranges from 1 to 9.'."\n" + ."\n" + .'- If the Period parameter is set to Month, the value of the UsedTime parameter ranges from 1 to 11.', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '1', + 'title' => '', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => 'The client token that is used to ensure the idempotence of the request.', + 'type' => 'string', + 'required' => false, + 'example' => 'HKAJHFIUEQWBFIJSNFOIWHN', + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'The HTTP status code.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + 'title' => '', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.', + 'type' => 'string', + 'example' => 'D6E068C3-25BC-455A-85FE-45F0B22ECB1F', + 'title' => '', + ], + 'ErrCode' => [ + 'description' => 'The error code.', + 'type' => 'string', + 'example' => 'Param.NotFound', + 'title' => '', + ], + 'Success' => [ + 'description' => 'Indicates whether the request is successful.', + 'type' => 'boolean', + 'example' => 'true', + 'title' => '', + ], + 'ErrMessage' => [ + 'description' => 'The error message.', + 'type' => 'string', + 'example' => 'The specified parameter %s value is not valid. ', + 'title' => '', + ], + 'BackupPlanId' => [ + 'description' => 'The ID of the backup schedule.', + 'type' => 'string', + 'example' => 'dbstooi01exxx', + 'title' => '', + ], + 'OrderId' => [ + 'description' => 'The ID of the order.', + 'type' => 'string', + 'example' => '202020202020', + 'title' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'Request.Forbidden', + 'errorMessage' => 'Have no Permissions', + 'description' => '', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'title' => 'RenewBackupPlan', + 'summary' => 'Renews a backup schedule.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + [ + 'createdAt' => '2022-07-12T03:53:31.000Z', + 'description' => 'Error codes changed', + ], + ], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '10', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'RenewBackupPlan', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dbs:RenewBackupPlan', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DBS', + 'resourceType' => 'BackupPlan', + 'arn' => 'acs:dbs:{#regionId}:{#accountId}:backupplan/{#BackupPlanId}', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"D6E068C3-25BC-455A-85FE-45F0B22ECB1F\\",\\n \\"ErrCode\\": \\"Param.NotFound\\",\\n \\"Success\\": true,\\n \\"ErrMessage\\": \\"The specified parameter %s value is not valid. \\",\\n \\"BackupPlanId\\": \\"dbstooi01exxx\\",\\n \\"OrderId\\": \\"202020202020\\"\\n}","type":"json"}]', + ], + 'StartBackupPlan' => [ + 'summary' => 'This operation starts a DBS backup plan.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREcbsKR7J6S', + ], + ], + 'parameters' => [ + [ + 'name' => 'BackupPlanId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the backup plan. Call the [DescribeBackupPlanList](~~2869825~~) operation to obtain the value of this parameter.', + 'type' => 'string', + 'required' => true, + 'title' => '', + 'example' => 'dbsqdss5tmh****', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => 'A client token that is used to ensure the idempotence of the request.', + 'type' => 'string', + 'required' => false, + 'title' => '', + 'example' => 'ETnLKlblzczshOTUbOCzxxxxxxx', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The details of the response.', + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'The HTTP status code.', + 'type' => 'integer', + 'format' => 'int32', + 'title' => '', + 'example' => '200', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.', + 'type' => 'string', + 'title' => '', + 'example' => 'D13761C3-9971-5C02-B789-3F3CD159****', + ], + 'ErrCode' => [ + 'description' => 'The error code.', + 'type' => 'string', + 'title' => '', + 'example' => 'Param.NotFound', + ], + 'Success' => [ + 'description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'- **true**: The request was successful.'."\n" + ."\n" + .'- **false**: The request failed.', + 'type' => 'boolean', + 'title' => '', + 'example' => 'true', + ], + 'ErrMessage' => [ + 'description' => 'The error message.', + 'type' => 'string', + 'title' => '', + 'example' => 'The specified parameter %s value is not valid. ', + ], + 'CreatedFullBackupsetId' => [ + 'description' => 'The ID of the full backup set.', + 'type' => 'string', + 'title' => '', + 'example' => '1h7toien3****', + ], + 'BackupPlanId' => [ + 'description' => 'The ID of the backup plan.', + 'type' => 'string', + 'title' => '', + 'example' => 'dbsqdss5tm****', + ], + ], + 'title' => '', + 'example' => '', + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'Request.Forbidden', + 'errorMessage' => 'Have no Permissions', + 'description' => '', + ], + ], + ], + 'title' => 'StartBackupPlan', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + [ + 'createdAt' => '2022-07-12T03:53:30.000Z', + 'description' => 'Error codes changed', + ], + ], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '10', + 'countWindow' => 60, + 'regionId' => '*', + 'api' => 'StartBackupPlan', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dbs:StartBackupPlan', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DBS', + 'resourceType' => 'BackupPlan', + 'arn' => 'acs:dbs:{#regionId}:{#accountId}:backupplan/{#BackupPlanId}', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"D13761C3-9971-5C02-B789-3F3CD159****\\",\\n \\"ErrCode\\": \\"Param.NotFound\\",\\n \\"Success\\": true,\\n \\"ErrMessage\\": \\"The specified parameter %s value is not valid. \\",\\n \\"CreatedFullBackupsetId\\": \\"1h7toien3****\\",\\n \\"BackupPlanId\\": \\"dbsqdss5tm****\\"\\n}","type":"json"}]', + ], + 'StartRestoreTask' => [ + 'summary' => 'Starts a DBS restore job.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREcbsKR7J6S', + ], + ], + 'parameters' => [ + [ + 'name' => 'RestoreTaskId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the restore job.', + 'type' => 'string', + 'required' => true, + 'example' => 's102h7rfXXXX', + 'title' => '', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => 'A client token. It ensures the idempotence of the request and prevents the same request from being submitted multiple times.', + 'type' => 'string', + 'required' => false, + 'example' => 'ETnLKlblzczshOTUbOCzxxxxxxx', + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'The HTTP status code.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + 'title' => '', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.', + 'type' => 'string', + 'example' => '60AF7C5D-EF4D-4D48-8FD5-C0823FDF28AC', + 'title' => '', + ], + 'ErrCode' => [ + 'description' => 'The error code.', + 'type' => 'string', + 'example' => 'Param.NotFound', + 'title' => '', + ], + 'Success' => [ + 'description' => 'Indicates whether the request was successful.', + 'type' => 'boolean', + 'example' => 'true', + 'title' => '', + ], + 'ErrMessage' => [ + 'description' => 'The error message.', + 'type' => 'string', + 'example' => 'The specified parameter %s value is not valid.', + 'title' => '', + ], + 'RestoreTaskId' => [ + 'description' => 'The ID of the restore job.', + 'type' => 'string', + 'example' => 's102h7rfXXXX', + 'title' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'Request.Forbidden', + 'errorMessage' => 'Have no Permissions', + 'description' => '', + ], + ], + ], + 'title' => 'StartRestoreTask', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + [ + 'createdAt' => '2022-07-12T03:53:30.000Z', + 'description' => 'Error codes changed', + ], + ], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '10000', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'StartRestoreTask', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dbs:StartRestoreTask', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DBS', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"60AF7C5D-EF4D-4D48-8FD5-C0823FDF28AC\\",\\n \\"ErrCode\\": \\"Param.NotFound\\",\\n \\"Success\\": true,\\n \\"ErrMessage\\": \\"The specified parameter %s value is not valid.\\",\\n \\"RestoreTaskId\\": \\"s102h7rfXXXX\\"\\n}","type":"json"}]', + ], + 'StopBackupPlan' => [ + 'summary' => 'This operation pauses a DBS backup plan.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREcbsKR7J6S', + ], + ], + 'parameters' => [ + [ + 'name' => 'BackupPlanId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the backup plan.', + 'type' => 'string', + 'required' => true, + 'example' => 'dbstooi01XXXX', + 'title' => '', + ], + ], + [ + 'name' => 'StopMethod', + 'in' => 'query', + 'schema' => [ + 'description' => 'The method used to pause the backup plan. Valid values:'."\n" + ."\n" + .'- ALL: Pauses the backup schedule, full data backup jobs, incremental log backup jobs, and restore jobs.'."\n" + ."\n" + .'- PLAN: Pauses only the backup schedule.', + 'type' => 'string', + 'required' => true, + 'example' => 'ALL', + 'title' => '', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => 'A client token to ensure the idempotence of the request. This prevents the same request from being sent repeatedly.', + 'type' => 'string', + 'required' => false, + 'example' => 'ETnLKlblzczshOTUbOCzxxxxxxx', + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'The HTTP status code.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + 'title' => '', + ], + 'RequestId' => [ + 'description' => 'The request ID.', + 'type' => 'string', + 'example' => 'D6E068C3-25BC-455A-85FE-45F0B22ECB1F', + 'title' => '', + ], + 'ErrCode' => [ + 'description' => 'The error code.', + 'type' => 'string', + 'example' => 'Param.NotFound', + 'title' => '', + ], + 'Success' => [ + 'description' => 'Indicates whether the request was successful.', + 'type' => 'boolean', + 'example' => 'true', + 'title' => '', + ], + 'ErrMessage' => [ + 'description' => 'The error message.', + 'type' => 'string', + 'example' => 'The specified parameter %s value is not valid. ', + 'title' => '', + ], + 'BackupPlanId' => [ + 'description' => 'The ID of the backup plan.', + 'type' => 'string', + 'example' => 'dbs1h****usfa', + 'title' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'Request.Forbidden', + 'errorMessage' => 'Have no Permissions', + 'description' => '', + ], + ], + ], + 'title' => 'StopBackupPlan', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + [ + 'createdAt' => '2022-07-12T03:53:31.000Z', + 'description' => 'Error codes changed', + ], + ], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '10', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'StopBackupPlan', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dbs:StopBackupPlan', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DBS', + 'resourceType' => 'BackupPlan', + 'arn' => 'acs:dbs:{#regionId}:{#accountId}:backupplan/{#BackupPlanId}', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"D6E068C3-25BC-455A-85FE-45F0B22ECB1F\\",\\n \\"ErrCode\\": \\"Param.NotFound\\",\\n \\"Success\\": true,\\n \\"ErrMessage\\": \\"The specified parameter %s value is not valid. \\",\\n \\"BackupPlanId\\": \\"dbs1h****usfa\\"\\n}","type":"json"}]', + ], + 'UpgradeBackupPlan' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREcbsKR7J6S', + ], + ], + 'parameters' => [ + [ + 'name' => 'BackupPlanId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the backup schedule.', + 'type' => 'string', + 'required' => true, + 'example' => 'dbstooi01eXXXX', + 'title' => '', + ], + ], + [ + 'name' => 'InstanceClass', + 'in' => 'query', + 'schema' => [ + 'description' => 'The specifications of the instance. Valid values:'."\n" + ."\n" + .'- micro'."\n" + ."\n" + .'- small'."\n" + ."\n" + .'- medium'."\n" + ."\n" + .'- large'."\n" + ."\n" + .'- xlarge', + 'type' => 'string', + 'required' => true, + 'example' => 'micro', + 'title' => '', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => 'The client token that is used to ensure the idempotence of the request.', + 'type' => 'string', + 'required' => false, + 'example' => 'ETnLKlblzczshOTUbOCzxxxxxxx', + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'The HTTP status code.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + 'title' => '', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.', + 'type' => 'string', + 'example' => 'D6E068C3-25BC-455A-85FE-45F0B22ECB1F', + 'title' => '', + ], + 'ErrCode' => [ + 'description' => 'The error code.', + 'type' => 'string', + 'example' => 'Param.NotFound', + 'title' => '', + ], + 'Success' => [ + 'description' => 'Indicates whether the request is successful.', + 'type' => 'boolean', + 'example' => 'true', + 'title' => '', + ], + 'ErrMessage' => [ + 'description' => 'The error message.', + 'type' => 'string', + 'example' => 'The specified parameter %s value is not valid. ', + 'title' => '', + ], + 'BackupPlanId' => [ + 'description' => 'The ID of the backup schedule.', + 'type' => 'string', + 'example' => 'dbstooi01XXXX', + 'title' => '', + ], + 'OrderId' => [ + 'description' => 'The ID of the order.', + 'type' => 'string', + 'example' => '2056157****', + 'title' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'Request.Forbidden', + 'errorMessage' => 'Have no Permissions', + 'description' => '', + ], + ], + ], + 'title' => 'UpgradeBackupPlan', + 'summary' => 'Upgrades a backup schedule.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + [ + 'createdAt' => '2022-07-12T03:53:30.000Z', + 'description' => 'Error codes changed', + ], + ], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '10', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'UpgradeBackupPlan', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dbs:UpgradeBackupPlan', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DBS', + 'resourceType' => 'BackupPlan', + 'arn' => 'acs:dbs:{#regionId}:{#accountId}:backupplan/{#BackupPlanId}', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"D6E068C3-25BC-455A-85FE-45F0B22ECB1F\\",\\n \\"ErrCode\\": \\"Param.NotFound\\",\\n \\"Success\\": true,\\n \\"ErrMessage\\": \\"The specified parameter %s value is not valid. \\",\\n \\"BackupPlanId\\": \\"dbstooi01XXXX\\",\\n \\"OrderId\\": \\"2056157****\\"\\n}","type":"json"}]', + ], + ], + 'endpoints' => [ + [ + 'regionId' => 'cn-wulanchabu', + 'regionName' => 'China (Ulanqab)', + 'areaId' => 'asiaPacific', + 'areaName' => 'Asia Pacific', + 'public' => 'dbs-api.cn-wulanchabu.aliyuncs.com', + 'endpoint' => 'dbs-api.cn-wulanchabu.aliyuncs.com', + 'vpc' => 'dbs-api-vpc.cn-wulanchabu.aliyuncs.com', + ], + [ + 'regionId' => 'cn-beijing', + 'regionName' => 'China (Beijing)', + 'areaId' => 'asiaPacific', + 'areaName' => 'Asia Pacific', + 'public' => 'dbs-api.cn-hangzhou.aliyuncs.com', + 'endpoint' => 'dbs-api.cn-hangzhou.aliyuncs.com', + 'vpc' => 'dbs-api-vpc.cn-beijing.aliyuncs.com', + ], + [ + 'regionId' => 'cn-qingdao', + 'regionName' => 'China (Qingdao)', + 'areaId' => 'asiaPacific', + 'areaName' => 'Asia Pacific', + 'public' => 'dbs-api.cn-hangzhou.aliyuncs.com', + 'endpoint' => 'dbs-api.cn-hangzhou.aliyuncs.com', + 'vpc' => 'dbs-api-vpc.cn-qingdao.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shanghai', + 'regionName' => 'China (Shanghai)', + 'areaId' => 'asiaPacific', + 'areaName' => 'Asia Pacific', + 'public' => 'dbs-api.cn-hangzhou.aliyuncs.com', + 'endpoint' => 'dbs-api.cn-hangzhou.aliyuncs.com', + 'vpc' => 'dbs-api-vpc.cn-shanghai.aliyuncs.com', + ], + [ + 'regionId' => 'cn-hongkong', + 'regionName' => 'China (Hong Kong)', + 'areaId' => 'asiaPacific', + 'areaName' => 'Asia Pacific', + 'public' => 'dbs-api.cn-hangzhou.aliyuncs.com', + 'endpoint' => 'dbs-api.cn-hangzhou.aliyuncs.com', + 'vpc' => 'dbs-api-vpc.cn-hongkong.aliyuncs.com', + ], + [ + 'regionId' => 'cn-zhangjiakou', + 'regionName' => 'China (Zhangjiakou)', + 'areaId' => 'asiaPacific', + 'areaName' => 'Asia Pacific', + 'public' => 'dbs-api.cn-zhangjiakou.aliyuncs.com', + 'endpoint' => 'dbs-api.cn-zhangjiakou.aliyuncs.com', + 'vpc' => 'dbs-api-vpc.cn-zhangjiakou.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shenzhen', + 'regionName' => 'China (Shenzhen)', + 'areaId' => 'asiaPacific', + 'areaName' => 'Asia Pacific', + 'public' => 'dbs-api.cn-hangzhou.aliyuncs.com', + 'endpoint' => 'dbs-api.cn-hangzhou.aliyuncs.com', + 'vpc' => 'dbs-api-vpc.cn-shenzhen.aliyuncs.com', + ], + [ + 'regionId' => 'ap-northeast-1', + 'regionName' => 'Japan (Tokyo)', + 'areaId' => 'asiaPacific', + 'areaName' => 'Asia Pacific', + 'public' => 'dbs-api.ap-northeast-1.aliyuncs.com', + 'endpoint' => 'dbs-api.ap-northeast-1.aliyuncs.com', + 'vpc' => 'dbs-api-vpc.ap-northeast-1.aliyuncs.com', + ], + [ + 'regionId' => 'cn-chengdu', + 'regionName' => 'China (Chengdu)', + 'areaId' => 'asiaPacific', + 'areaName' => 'Asia Pacific', + 'public' => 'dbs-api.cn-chengdu.aliyuncs.com', + 'endpoint' => 'dbs-api.cn-chengdu.aliyuncs.com', + 'vpc' => 'dbs-api-vpc.cn-chengdu.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-1', + 'regionName' => 'Singapore', + 'areaId' => 'asiaPacific', + 'areaName' => 'Asia Pacific', + 'public' => 'dbs-api.ap-southeast-1.aliyuncs.com', + 'endpoint' => 'dbs-api.ap-southeast-1.aliyuncs.com', + 'vpc' => 'dbs-api-vpc.ap-southeast-1.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-3', + 'regionName' => 'Malaysia (Kuala Lumpur)', + 'areaId' => 'asiaPacific', + 'areaName' => 'Asia Pacific', + 'public' => 'dbs-api.ap-southeast-3.aliyuncs.com', + 'endpoint' => 'dbs-api.ap-southeast-3.aliyuncs.com', + 'vpc' => 'dbs-api-vpc.ap-southeast-3.aliyuncs.com', + ], + [ + 'regionId' => 'cn-huhehaote', + 'regionName' => 'China (Hohhot)', + 'areaId' => 'asiaPacific', + 'areaName' => 'Asia Pacific', + 'public' => 'dbs-api.cn-huhehaote.aliyuncs.com', + 'endpoint' => 'dbs-api.cn-huhehaote.aliyuncs.com', + 'vpc' => 'dbs-api-vpc.cn-huhehaote.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-5', + 'regionName' => 'Indonesia (Jakarta)', + 'areaId' => 'asiaPacific', + 'areaName' => 'Asia Pacific', + 'public' => 'dbs-api.ap-southeast-5.aliyuncs.com', + 'endpoint' => 'dbs-api.ap-southeast-5.aliyuncs.com', + 'vpc' => 'dbs-api-vpc.ap-southeast-5.aliyuncs.com', + ], + [ + 'regionId' => 'cn-hangzhou', + 'regionName' => 'China (Hangzhou)', + 'areaId' => 'asiaPacific', + 'areaName' => 'Asia Pacific', + 'public' => 'dbs-api.cn-hangzhou.aliyuncs.com', + 'endpoint' => 'dbs-api.cn-hangzhou.aliyuncs.com', + 'vpc' => 'dbs-api-vpc.cn-hangzhou.aliyuncs.com', + ], + [ + 'regionId' => 'us-east-1', + 'regionName' => 'US (Virginia)', + 'areaId' => 'europeAmerica', + 'areaName' => 'Europe & Americas', + 'public' => 'dbs-api.cn-hangzhou.aliyuncs.com', + 'endpoint' => 'dbs-api.cn-hangzhou.aliyuncs.com', + 'vpc' => 'dbs-api-vpc.us-east-1.aliyuncs.com', + ], + [ + 'regionId' => 'eu-west-1', + 'regionName' => 'UK (London)', + 'areaId' => 'europeAmerica', + 'areaName' => 'Europe & Americas', + 'public' => 'dbs-api.eu-west-1.aliyuncs.com', + 'endpoint' => 'dbs-api.eu-west-1.aliyuncs.com', + 'vpc' => 'dbs-api-vpc.eu-west-1.aliyuncs.com', + ], + [ + 'regionId' => 'us-west-1', + 'regionName' => 'US (Silicon Valley)', + 'areaId' => 'europeAmerica', + 'areaName' => 'Europe & Americas', + 'public' => 'dbs-api.cn-hangzhou.aliyuncs.com', + 'endpoint' => 'dbs-api.cn-hangzhou.aliyuncs.com', + 'vpc' => 'dbs-api-vpc.us-west-1.aliyuncs.com', + ], + [ + 'regionId' => 'eu-central-1', + 'regionName' => 'Germany (Frankfurt)', + 'areaId' => 'europeAmerica', + 'areaName' => 'Europe & Americas', + 'public' => 'dbs-api.eu-central-1.aliyuncs.com', + 'endpoint' => 'dbs-api.eu-central-1.aliyuncs.com', + 'vpc' => 'dbs-api-vpc.eu-central-1.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shenzhen-finance-1', + 'regionName' => 'China South 1 Finance', + 'areaId' => 'industryCloud', + 'areaName' => 'Industry Cloud', + 'public' => 'dbs-api.cn-hangzhou.aliyuncs.com', + 'endpoint' => 'dbs-api.cn-hangzhou.aliyuncs.com', + 'vpc' => 'dbs-api-vpc.cn-shenzhen-finance-1.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shanghai-finance-1', + 'regionName' => 'China East 2 Finance', + 'areaId' => 'industryCloud', + 'areaName' => 'Industry Cloud', + 'public' => 'dbs-api.cn-hangzhou.aliyuncs.com', + 'endpoint' => 'dbs-api.cn-hangzhou.aliyuncs.com', + 'vpc' => 'dbs-api-vpc.cn-shanghai-finance-1.aliyuncs.com', + ], + [ + 'regionId' => 'cn-hangzhou-finance', + 'regionName' => 'China East 1 Finance', + 'areaId' => 'industryCloud', + 'areaName' => 'Industry Cloud', + 'public' => 'dbs-api.cn-hangzhou.aliyuncs.com', + 'endpoint' => 'dbs-api.cn-hangzhou.aliyuncs.com', + 'vpc' => '', + ], + ], + 'errorCodes' => [ + [ + 'code' => 'BackupPlanNotConfigure', + 'message' => 'ConfigureBackupPlanRequest Error', + 'http_code' => 200, + 'description' => 'The backup schedule is incorrectly configured.', + ], + [ + 'code' => 'BackupPlanNotDescribe', + 'message' => 'describe backup plan failed -> null', + 'http_code' => 200, + 'description' => 'Failed to query the list of backup schedules.', + ], + [ + 'code' => 'BackupPlanNotModify', + 'message' => 'modify backup source endpoint fail', + 'http_code' => 200, + 'description' => 'Failed to modify the backup source endpoint.', + ], + [ + 'code' => 'DBS.DisasterCenter.NoPermission', + 'message' => 'no permission for this action.', + 'http_code' => 403, + 'description' => 'No permission for this operation.', + ], + [ + 'code' => 'DBS.DownloadTask.CannotFind', + 'message' => 'Can not find download task.', + 'http_code' => 200, + 'description' => 'Can not find download task.', + ], + [ + 'code' => 'DBS.DownloadTask.JobAlreadyExist', + 'message' => 'Job already submit in recent days, please check it.', + 'http_code' => 200, + 'description' => 'Job already submit in recent days, please check it.', + ], + [ + 'code' => 'DBS.DownloadTask.OnlyOneRunningOrFailedTask', + 'message' => 'There can be only one running or failed task for the instance.', + 'http_code' => 200, + 'description' => 'The current instance can only have one running/failed task at the same time.', + ], + [ + 'code' => 'DBS.DownloadTask.OssForbid', + 'message' => 'OSS is forbidden to access. Please check your OSS bucket.', + 'http_code' => 200, + 'description' => 'OSS is forbidden to access. Please check your OSS bucket.', + ], + [ + 'code' => 'DBS.DownloadTask.OssStorageTypeInvalid', + 'message' => 'Unsupported bucket storage. Please make sure that your OSS bucket\'s storgae type is standard.', + 'http_code' => 200, + 'description' => 'Unsupported bucket storage. Please make sure that your OSS bucket\'s storgae type is standard.', + ], + [ + 'code' => 'DBS.NoPermissionException', + 'message' => 'Rejected by ValidationChecker.', + 'http_code' => 403, + 'description' => '', + ], + [ + 'code' => 'DBS.NotExists', + 'message' => 'data source do not existed.', + 'http_code' => 404, + 'description' => 'DBS.NotExists', + ], + [ + 'code' => 'Forbidden.InstanceNotFound', + 'message' => 'instance not found', + 'http_code' => 200, + 'description' => 'The instance does not exist.', + ], + [ + 'code' => 'InternalError', + 'message' => 'internal error', + 'http_code' => 500, + 'description' => 'An internal error occurred.', + ], + [ + 'code' => 'OperationDenied.JobStatus', + 'message' => 'The operation is not permitted.', + 'http_code' => 200, + 'description' => 'The operation is not allowed.', + ], + [ + 'code' => 'Request.Forbidden', + 'message' => 'Have no Permissions', + 'http_code' => 403, + 'description' => '', + ], + [ + 'code' => 'UserError', + 'message' => 'user error', + 'http_code' => 200, + 'description' => 'An error occurred due to improper operations.', + ], + [ + 'code' => 'UserError', + 'message' => 'You must first activate OSS before using DBS to OSS.', + 'http_code' => 403, + 'description' => 'You must first activate OSS before using DBS -> OSS.', + ], + ], + 'changeSet' => [ + [ + 'apis' => [ + [ + 'description' => 'Response parameters changed', + 'api' => 'DescribeBackupPlanList', + ], + ], + 'createdAt' => '2023-03-28T07:34:58.000Z', + 'description' => '', + ], + [ + 'apis' => [ + [ + 'description' => 'Response parameters changed', + 'api' => 'DescribeBackupPlanBilling', + ], + ], + 'createdAt' => '2022-08-18T07:57:14.000Z', + 'description' => '审计', + ], + [ + 'apis' => [ + [ + 'description' => 'Response parameters changed', + 'api' => 'DescribeBackupPlanList', + ], + ], + 'createdAt' => '2022-08-12T03:51:35.000Z', + 'description' => '接入rmc', + ], + [ + 'apis' => [ + [ + 'description' => 'Request parameters changed', + 'api' => 'ConfigureBackupPlan', + ], + ], + 'createdAt' => '2022-07-28T07:13:26.000Z', + 'description' => '操作审计', + ], + [ + 'apis' => [ + [ + 'description' => 'Request parameters changed', + 'api' => 'CreateAndStartBackupPlan', + ], + [ + 'description' => 'Request parameters changed', + 'api' => 'CreateBackupPlan', + ], + [ + 'description' => 'Response parameters changed', + 'api' => 'DescribeBackupPlanBilling', + ], + [ + 'description' => 'Request parameters changed, Response parameters changed', + 'api' => 'DescribeBackupPlanList', + ], + ], + 'createdAt' => '2022-07-28T06:54:59.000Z', + 'description' => '操作审计', + ], + [ + 'apis' => [ + [ + 'description' => 'Error codes changed', + 'api' => 'ConfigureBackupPlan', + ], + [ + 'description' => 'Error codes changed', + 'api' => 'CreateAndStartBackupPlan', + ], + [ + 'description' => 'Error codes changed', + 'api' => 'CreateBackupPlan', + ], + [ + 'description' => 'Error codes changed', + 'api' => 'CreateFullBackupSetDownload', + ], + [ + 'description' => 'Error codes changed', + 'api' => 'CreateGetDBListFromAgentTask', + ], + [ + 'description' => 'Error codes changed', + 'api' => 'CreateIncrementBackupSetDownload', + ], + [ + 'description' => 'Error codes changed', + 'api' => 'CreateRestoreTask', + ], + [ + 'description' => 'Error codes changed', + 'api' => 'DescribeBackupGatewayList', + ], + [ + 'description' => 'Error codes changed', + 'api' => 'DescribeBackupPlanBilling', + ], + [ + 'description' => 'Error codes changed', + 'api' => 'DescribeBackupPlanList', + ], + ], + 'createdAt' => '2022-07-12T03:54:35.000Z', + 'description' => '补齐api信息', + ], + ], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '50', + 'countWindow' => 60, + 'regionId' => '*', + 'api' => 'DescribeBackupPlanList', + ], + [ + 'threshold' => '10', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'ModifyBackupSetDownloadRules', + ], + [ + 'threshold' => '10', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'ReleaseBackupPlan', + ], + [ + 'threshold' => '10', + 'countWindow' => 60, + 'regionId' => '*', + 'api' => 'StartBackupPlan', + ], + [ + 'threshold' => '10', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'RenewBackupPlan', + ], + [ + 'threshold' => '10', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'DescribeJobErrorCode', + ], + [ + 'threshold' => '100', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'GetDBListFromAgent', + ], + [ + 'threshold' => '10', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'ModifyStorageStrategy', + ], + [ + 'threshold' => '10', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'UpgradeBackupPlan', + ], + [ + 'threshold' => '10', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'DisableBackupLog', + ], + [ + 'threshold' => '10', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'ModifyBackupPlanName', + ], + [ + 'threshold' => '100', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'DescribeBackupSetDownloadTaskList', + ], + [ + 'threshold' => '100', + 'countWindow' => 60, + 'regionId' => '*', + 'api' => 'DescribeBackupGatewayList', + ], + [ + 'threshold' => '10', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'ModifyBackupSourceEndpoint', + ], + [ + 'threshold' => '100', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'DescribeRegions', + ], + [ + 'threshold' => '10', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'CreateAndStartBackupPlan', + ], + [ + 'threshold' => '10', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'CreateIncrementBackupSetDownload', + ], + [ + 'threshold' => '10', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'ModifyBackupStrategy', + ], + [ + 'threshold' => '100', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'DescribeRestoreRangeInfo', + ], + [ + 'threshold' => '10', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'CreateBackupPlan', + ], + [ + 'threshold' => '100', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'CreateGetDBListFromAgentTask', + ], + [ + 'threshold' => '100', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'DescribeFullBackupList', + ], + [ + 'threshold' => '100', + 'countWindow' => 60, + 'regionId' => '*', + 'api' => 'DescribeRestoreTaskList', + ], + [ + 'threshold' => '10', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'StopBackupPlan', + ], + [ + 'threshold' => '10', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'CreateFullBackupSetDownload', + ], + [ + 'threshold' => '10', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'DescribeDLAService', + ], + [ + 'threshold' => '100', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'DescribePreCheckProgressList', + ], + [ + 'threshold' => '10', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'EnableBackupLog', + ], + [ + 'threshold' => '10', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'ModifyBackupObjects', + ], + [ + 'threshold' => '10000', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'CreateRestoreTask', + ], + [ + 'threshold' => '100', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'DescribeIncrementBackupList', + ], + [ + 'threshold' => '10', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'ConfigureBackupPlan', + ], + [ + 'threshold' => '100', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'DescribeBackupPlanBilling', + ], + [ + 'threshold' => '-1', + 'countWindow' => 1, + 'regionId' => '*', + ], + [ + 'threshold' => '10000', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'StartRestoreTask', + ], + [ + 'threshold' => '100', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'DescribeNodeCidrList', + ], + ], + ], + 'ram' => [ + 'productCode' => 'DBS', + 'productName' => 'Database Backup', + 'ramCodes' => [ + 'dbs', + ], + 'ramLevel' => 'RESOURCE', + 'ramConditions' => [], + 'ramActions' => [ + [ + 'apiName' => 'InitializeDbsServiceLinkedRole', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'dbs:InitializeDbsServiceLinkedRole', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DBS', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'StartBackupPlan', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dbs:StartBackupPlan', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DBS', + 'resourceType' => 'BackupPlan', + 'arn' => 'acs:dbs:{#regionId}:{#accountId}:backupplan/{#BackupPlanId}', + ], + ], + ], + ], + [ + 'apiName' => 'RenewBackupPlan', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dbs:RenewBackupPlan', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DBS', + 'resourceType' => 'BackupPlan', + 'arn' => 'acs:dbs:{#regionId}:{#accountId}:backupplan/{#BackupPlanId}', + ], + ], + ], + ], + [ + 'apiName' => 'DescribeFullBackupList', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dbs:DescribeFullBackupList', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DBS', + 'resourceType' => 'BackupPlan', + 'arn' => 'acs:dbs:{#regionId}:{#accountId}:backupplan/{#BackupPlanId}', + ], + ], + ], + ], + [ + 'apiName' => 'CreateIncrementBackupSetDownload', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'dbs:CreateIncrementBackupSetDownload', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DBS', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'CreateBackupPlan', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'dbs:CreateBackupPlan', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DBS', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'EnableBackupLog', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dbs:EnableBackupLog', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DBS', + 'resourceType' => 'BackupPlan', + 'arn' => 'acs:dbs:{#regionId}:{#accountId}:backupplan/{#BackupPlanId}', + ], + ], + ], + ], + [ + 'apiName' => 'ModifyBackupPlanName', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dbs:ModifyBackupPlanName', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DBS', + 'resourceType' => 'BackupPlan', + 'arn' => 'acs:dbs:{#regionId}:{#accountId}:backupplan/{#BackupPlanId}', + ], + ], + ], + ], + [ + 'apiName' => 'DisableBackupLog', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dbs:DisableBackupLog', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DBS', + 'resourceType' => 'BackupPlan', + 'arn' => 'acs:dbs:{#regionId}:{#accountId}:backupplan/{#BackupPlanId}', + ], + ], + ], + ], + [ + 'apiName' => 'ModifyBackupSetDownloadRules', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dbs:ModifyBackupSetDownloadRules', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DBS', + 'resourceType' => 'BackupPlan', + 'arn' => 'acs:dbs:{#regionId}:{#accountId}:backupplan/{#BackupPlanId}', + ], + ], + ], + ], + [ + 'apiName' => 'DescribeDLAService', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dbs:DescribeDLAService', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DBS', + 'resourceType' => 'BackupPlan', + 'arn' => 'acs:dbs:{#regionId}:{#accountId}:backupplan/{#BackupPlanId}', + ], + ], + ], + ], + [ + 'apiName' => 'ModifyBackupObjects', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dbs:ModifyBackupObjects', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DBS', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'DescribeIncrementBackupList', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dbs:DescribeIncrementBackupList', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DBS', + 'resourceType' => 'BackupPlan', + 'arn' => 'acs:dbs:{#regionId}:{#accountId}:backupplan/{#BackupPlanId}', + ], + ], + ], + ], + [ + 'apiName' => 'StopBackupPlan', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dbs:StopBackupPlan', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DBS', + 'resourceType' => 'BackupPlan', + 'arn' => 'acs:dbs:{#regionId}:{#accountId}:backupplan/{#BackupPlanId}', + ], + ], + ], + ], + [ + 'apiName' => 'CreateRestoreTask', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'dbs:CreateRestoreTask', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DBS', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'UpgradeBackupPlan', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dbs:UpgradeBackupPlan', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DBS', + 'resourceType' => 'BackupPlan', + 'arn' => 'acs:dbs:{#regionId}:{#accountId}:backupplan/{#BackupPlanId}', + ], + ], + ], + ], + [ + 'apiName' => 'CreateGetDBListFromAgentTask', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'dbs:CreateGetDBListFromAgentTask', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DBS', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'ConfigureBackupPlan', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dbs:ConfigureBackupPlan', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DBS', + 'resourceType' => 'BackupPlan', + 'arn' => 'acs:dbs:{#regionId}:{#accountId}:backupplan/{#BackupPlanId}', + ], + ], + ], + ], + [ + 'apiName' => 'CreateFullBackupSetDownload', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'dbs:CreateFullBackupSetDownload', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DBS', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'ModifyStorageStrategy', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dbs:ModifyStorageStrategy', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DBS', + 'resourceType' => 'BackupPlan', + 'arn' => 'acs:dbs:{#regionId}:{#accountId}:backupplan/{#BackupPlanId}', + ], + ], + ], + ], + [ + 'apiName' => 'CreateAndStartBackupPlan', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'dbs:CreateAndStartBackupPlan', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DBS', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'ModifyBackupStrategy', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dbs:ModifyBackupStrategy', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DBS', + 'resourceType' => 'BackupPlan', + 'arn' => 'acs:dbs:{#regionId}:{#accountId}:backupplan/{#BackupPlanId}', + ], + ], + ], + ], + [ + 'apiName' => 'StartRestoreTask', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dbs:StartRestoreTask', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DBS', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'DescribeNodeCidrList', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dbs:DescribeNodeCidrList', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DBS', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'DescribeBackupGatewayList', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dbs:DescribeBackupGatewayList', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DBS', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'DescribeBackupSetDownloadTaskList', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dbs:DescribeBackupSetDownloadTaskList', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DBS', + 'resourceType' => 'BackupPlan', + 'arn' => 'acs:dbs:{#regionId}:{#accountId}:backupplan/{#BackupPlanId}', + ], + ], + ], + ], + [ + 'apiName' => 'ReleaseBackupPlan', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'dbs:ReleaseBackupPlan', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DBS', + 'resourceType' => 'BackupPlan', + 'arn' => 'acs:dbs:{#regionId}:{#accountId}:backupplan/{#BackupPlanId}', + ], + ], + ], + ], + [ + 'apiName' => 'GetDBListFromAgent', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dbs:GetDBListFromAgent', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DBS', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'DescribeRestoreRangeInfo', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dbs:DescribeRestoreRangeInfo', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DBS', + 'resourceType' => 'BackupPlan', + 'arn' => 'acs:dbs:{#regionId}:{#accountId}:backupplan/{#BackupPlanId}', + ], + ], + ], + ], + [ + 'apiName' => 'DescribeBackupPlanList', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dbs:DescribeBackupPlanList', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DBS', + 'resourceType' => 'BackupPlan', + 'arn' => 'acs:dbs:{#regionId}:{#accountId}:backupplan/{#BackupPlanId}', + ], + ], + ], + ], + [ + 'apiName' => 'DescribeRegions', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dbs:DescribeRegions', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DBS', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'DescribePreCheckProgressList', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dbs:DescribePreCheckProgressList', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DBS', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'DescribeRestoreTaskList', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dbs:DescribeRestoreTaskList', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DBS', + 'resourceType' => 'BackupPlan', + 'arn' => 'acs:dbs:{#regionId}:{#accountId}:backupplan/{#BackupPlanId}', + ], + ], + ], + ], + [ + 'apiName' => 'DescribeJobErrorCode', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dbs:DescribeJobErrorCode', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DBS', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'DescribeBackupPlanBilling', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dbs:DescribeBackupPlanBilling', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DBS', + 'resourceType' => 'BackupPlan', + 'arn' => 'acs:dbs:{#regionId}:{#accountId}:backupplan/{#BackupPlanId}', + ], + ], + ], + ], + [ + 'apiName' => 'ModifyBackupSourceEndpoint', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dbs:ModifyBackupSourceEndpoint', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DBS', + 'resourceType' => 'BackupPlan', + 'arn' => 'acs:dbs:{#regionId}:{#accountId}:backupplan/{#BackupPlanId}', + ], + ], + ], + ], + ], + 'resourceTypes' => [ + [ + 'validationType' => 'always', + 'resourceType' => 'BackupPlan', + 'arn' => 'acs:dbs:{#regionId}:{#accountId}:backupplan/{#BackupPlanId}', + ], + [ + 'validationType' => 'always', + 'resourceType' => 'BackupPlan', + 'arn' => 'acs:dbs:{#regionId}:{#accountId}:backupplan/*', + ], + [ + 'validationType' => 'always', + 'resourceType' => 'RestoreTask', + 'arn' => 'acs:dbs:{#regionId}:{#accountId}:restoretask/{#RestoreTaskId}', + ], + ], + ], +]; diff --git a/data/en_us/dbs/2021-01-01/api-docs.php b/data/en_us/dbs/2021-01-01/api-docs.php new file mode 100644 index 0000000..7e4a0d7 --- /dev/null +++ b/data/en_us/dbs/2021-01-01/api-docs.php @@ -0,0 +1,5731 @@ +<?php return [ + 'version' => '1.0', + 'info' => [ + 'style' => 'RPC', + 'product' => 'Dbs', + 'version' => '2021-01-01', + ], + 'directories' => [ + [ + 'children' => [ + 'DescribeDownloadBackupSetStorageInfo', + 'DescribeDownloadSupport', + 'CreateDownload', + 'DescribeDownloadTask', + 'RetryDownloadTask', + ], + 'type' => 'directory', + 'title' => 'Advanced download', + ], + [ + 'children' => [ + 'ChangeResourceGroup', + 'DescribeBackupPolicy', + 'DescribeBackupDataList', + 'ModifyBackupPolicy', + 'DeleteSandboxInstance', + 'DescribeSandboxBackupSets', + 'DescribeCostInfoByDbsInstance', + ], + 'type' => 'directory', + 'title' => 'Other', + ], + [ + 'children' => [ + 'CreateAdvancedPolicy', + 'DescribeSandboxInstances', + 'DescribeSandboxRecoveryTime', + ], + 'title' => 'Others', + 'type' => 'directory', + ], + ], + 'components' => [ + 'schemas' => [], + ], + 'apis' => [ + 'ChangeResourceGroup' => [ + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'ResourceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the resource.', + 'type' => 'string', + 'required' => true, + 'title' => '', + 'example' => 'dbs1jyajqk******', + ], + ], + [ + 'name' => 'NewResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the new resource group.', + 'type' => 'string', + 'required' => true, + 'title' => '', + 'example' => 'rg-aekz4kee6******', + ], + ], + [ + 'name' => 'ResourceType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The resource type. Set the value to backupplan.', + 'type' => 'string', + 'required' => true, + 'title' => '', + 'example' => 'backupplan', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => 'A client token to ensure that the request is idempotent. This prevents the same request from being submitted multiple times.', + 'type' => 'string', + 'required' => false, + 'title' => '', + 'example' => 'dbs', + ], + ], + [ + 'name' => 'RegionCode', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the region where the instance resides.', + 'type' => 'string', + 'required' => false, + 'title' => '', + 'example' => 'cn-hangzhou', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Data' => [ + 'description' => 'Indicates whether the resource group was changed. Valid values:'."\n" + ."\n" + .'- **true**: The request was successful.'."\n" + ."\n" + .'- **false**: The request failed.', + 'type' => 'string', + 'title' => '', + 'example' => 'true', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.', + 'type' => 'string', + 'title' => '', + 'example' => '04EBD9F5-F06F-5302-8499-005C72*******', + ], + 'ErrCode' => [ + 'description' => 'The error code returned if the call fails.', + 'type' => 'string', + 'title' => '', + 'example' => 'Request.Forbidden', + ], + 'Success' => [ + 'description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'- **true**: The request was successful.'."\n" + ."\n" + .'- **false**: The request failed.', + 'type' => 'string', + 'title' => '', + 'example' => 'true', + ], + 'ErrMessage' => [ + 'description' => 'The error message returned if the call fails.', + 'type' => 'string', + 'title' => '', + 'example' => 'RAM DENY', + ], + 'Code' => [ + 'description' => 'The status code of the API.', + 'type' => 'string', + 'title' => '', + 'example' => 'Param.NotFound', + ], + 'Message' => [ + 'description' => 'Additional information.', + 'type' => 'string', + 'title' => '', + 'example' => 'The resource group is forbidden to operate', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'Request.Forbidden', + 'errorMessage' => 'Have no Permissions', + 'description' => '', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'title' => 'ChangeResourceGroup', + 'summary' => 'Changes the resource group of a resource.', + 'changeSet' => [ + [ + 'createdAt' => '2023-12-22T02:05:16.000Z', + 'description' => 'Request parameters changed', + ], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dbs:ChangeResourceGroup', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DBS', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": \\"true\\",\\n \\"RequestId\\": \\"04EBD9F5-F06F-5302-8499-005C72*******\\",\\n \\"ErrCode\\": \\"Request.Forbidden\\",\\n \\"Success\\": \\"true\\",\\n \\"ErrMessage\\": \\"RAM DENY\\",\\n \\"Code\\": \\"Param.NotFound\\",\\n \\"Message\\": \\"The resource group is forbidden to operate\\"\\n}","type":"json"}]', + ], + 'CreateAdvancedPolicy' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '221987', + 'abilityTreeNodes' => [ + 'FEATUREcbsXXHSAX', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionCode', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region in which backup sets reside.', + 'type' => 'string', + 'title' => '', + 'required' => false, + 'example' => 'cn-shanghai', + ], + ], + [ + 'name' => 'InstanceName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the PolarDB instance.', + 'type' => 'string', + 'title' => '', + 'required' => false, + 'example' => 'pc-2ze3nrr64c5****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The response parameters.', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.', + 'type' => 'string', + 'example' => '1EFBAC73-4A72-5AD0-BE27-932491FCB848', + 'title' => '', + ], + 'Message' => [ + 'description' => 'The returned message.', + 'type' => 'string', + 'example' => 'instanceName can not be empty.', + 'title' => '', + ], + 'Data' => [ + 'description' => 'Indicates whether the advanced backup policy takes effect. Valid values:'."\n" + ."\n" + .'- **true**'."\n" + ."\n" + .'- **false**', + 'type' => 'boolean', + 'example' => 'true', + 'title' => '', + ], + 'ErrMessage' => [ + 'description' => 'The error message returned if the request failed.', + 'type' => 'string', + 'example' => 'The specified parameter %s value is not valid. ', + 'title' => '', + ], + 'Code' => [ + 'description' => 'The response code.', + 'type' => 'string', + 'example' => 'Success', + 'title' => '', + ], + 'Success' => [ + 'description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'- true'."\n" + ."\n" + .'- false', + 'type' => 'string', + 'example' => 'true', + 'title' => '', + ], + 'ErrCode' => [ + 'description' => 'The error code returned if the request failed.', + 'type' => 'string', + 'example' => 'Success', + 'title' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'Request.Forbidden', + 'errorMessage' => 'Have no Permissions', + 'description' => '', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'title' => 'CreateAdvancedPolicy', + 'summary' => 'Enables an advanced backup policy for a PolarDB instance.', + 'description' => '### [](#)Supported database engines'."\n" + ."\n" + .'PolarDB for MySQL'."\n" + ."\n" + .'> This API operation is available only to specific customers. If you want to call this API operation, join the Database Backup (DBS) DingTalk group (ID 35585947) for customer consultation to request permissions.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dbs:CreateAdvancedPolicy', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DBS', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1EFBAC73-4A72-5AD0-BE27-932491FCB848\\",\\n \\"Message\\": \\"instanceName can not be empty.\\",\\n \\"Data\\": true,\\n \\"ErrMessage\\": \\"The specified parameter %s value is not valid. \\",\\n \\"Code\\": \\"Success\\",\\n \\"Success\\": \\"true\\",\\n \\"ErrCode\\": \\"Success\\"\\n}","type":"json"}]', + ], + 'CreateDownload' => [ + 'summary' => 'Creates an Advanced Download task.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '119762', + 'abilityTreeNodes' => [ + 'FEATUREcbs04Q4EK', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionCode', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the region where the instance resides. You can call the [DescribeDBInstanceAttribute](~~26231~~) operation for an RDS instance or the [DescribeDBClusterAttribute](~~2319132~~) operation for a PolarDB cluster to query the region ID.', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-beijing', + 'title' => '', + ], + ], + [ + 'name' => 'InstanceName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The instance ID.', + 'type' => 'string', + 'required' => true, + 'example' => 'rm-wz994c1t1****', + 'title' => '', + ], + ], + [ + 'name' => 'BakSetType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of the download task. Valid values:'."\n" + ."\n" + .'- **full**: downloads a full backup set.'."\n" + ."\n" + .'- **pitr**: downloads data at a specific point in time.', + 'type' => 'string', + 'required' => false, + 'example' => 'full', + 'title' => '', + ], + ], + [ + 'name' => 'BakSetId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the backup set. You can call the [DescribeBackups](~~26273~~) operation for an RDS instance or the [DescribeBackups](~~2319224~~) operation for a PolarDB cluster to query this parameter.'."\n" + ."\n" + .'> This parameter is required when BakSetType is set to full.', + 'type' => 'string', + 'required' => false, + 'example' => '146005****', + 'title' => '', + ], + ], + [ + 'name' => 'DownloadPointInTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'The point in time to which you want to download data. Specify a UNIX timestamp of the long data type. Unit: milliseconds.'."\n" + ."\n" + .'> This parameter is required when BakSetType is set to pitr.', + 'type' => 'string', + 'required' => false, + 'example' => '1661331864000', + 'title' => '', + ], + ], + [ + 'name' => 'BakSetSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The size of the full backup set. You can call the [DescribeBackups](~~26273~~) operation for an RDS instance or the [DescribeBackups](~~2319224~~) operation for a PolarDB cluster to query the size. Unit: bytes.', + 'type' => 'string', + 'required' => false, + 'example' => '216****', + 'title' => '', + ], + ], + [ + 'name' => 'FormatType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The format to which you want to convert the downloaded data. Valid values:'."\n" + ."\n" + .'- **CSV**'."\n" + ."\n" + .'- **SQL**'."\n" + ."\n" + .'- **Parquet**'."\n" + ."\n" + .'> This parameter is required.', + 'type' => 'string', + 'required' => false, + 'example' => 'CSV', + 'title' => '', + ], + ], + [ + 'name' => 'TargetType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The destination type for the download. Valid values:'."\n" + ."\n" + .'- **OSS**'."\n" + ."\n" + .'- **URL**', + 'type' => 'string', + 'required' => false, + 'example' => 'OSS', + 'title' => '', + ], + ], + [ + 'name' => 'TargetBucket', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the OSS bucket.'."\n" + ."\n" + .'- This parameter is required when TargetType is set to OSS.'."\n" + ."\n" + .'- Make sure that your account has the **AliyunDBSDefaultRole** permission. For more information about how to grant permissions, see [Grant permissions to a RAM role](~~26307~~). You can also go to the console to grant permissions as prompted.', + 'type' => 'string', + 'required' => false, + 'example' => 'test123', + 'title' => '', + ], + ], + [ + 'name' => 'TargetPath', + 'in' => 'query', + 'schema' => [ + 'description' => 'The destination path to which the data is downloaded.'."\n" + ."\n" + .'> This parameter is required when TargetType is set to OSS.', + 'type' => 'string', + 'required' => false, + 'example' => 'test_db/path', + 'title' => '', + ], + ], + [ + 'name' => 'TargetOssRegion', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region where the OSS bucket resides.'."\n" + ."\n" + .'> This parameter is required when TargetType is set to OSS.', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-beijing', + 'title' => '', + ], + ], + [ + 'name' => 'PrimaryKeyTypeOnly', + 'in' => 'query', + 'schema' => [ + 'description' => 'This field is required only for MongoDB instances. It indicates whether the primary key type in the database and table is unique. Valid values: true and false.', + 'type' => 'string', + 'required' => false, + 'example' => 'false', + 'title' => '', + ], + ], + [ + 'name' => 'IsCluster', + 'in' => 'query', + 'schema' => [ + 'description' => 'This field is required only for MongoDB instances. It indicates whether the current instance is a sharded cluster. If the instance is a sharded cluster, set the value to true. Otherwise, set the value to false.', + 'type' => 'string', + 'required' => false, + 'example' => 'false', + 'title' => '', + ], + ], + [ + 'name' => 'AdminDatabase', + 'in' => 'query', + 'schema' => [ + 'description' => 'This field is required only for MongoDB instances. It specifies the name of the authentication database. The default value is admin.', + 'type' => 'string', + 'required' => false, + 'example' => 'admin', + 'title' => '', + ], + ], + [ + 'name' => 'UseZstd', + 'in' => 'query', + 'schema' => [ + 'description' => 'Indicates whether the zstd compression algorithm is used for the compressed package. The default value is false.', + 'type' => 'string', + 'required' => false, + 'example' => 'false', + 'title' => '', + ], + ], + [ + 'name' => 'ClusterName', + 'in' => 'query', + 'schema' => [ + 'description' => 'This field is required only for MongoDB sharded clusters. It specifies the ID of the sharded cluster.', + 'type' => 'string', + 'required' => false, + 'example' => 'dds-0xid8e5336******', + 'title' => '', + ], + ], + [ + 'name' => 'IsPhysical', + 'in' => 'query', + 'schema' => [ + 'type' => 'boolean', + 'description' => '', + 'required' => false, + 'title' => '', + 'example' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The return values.', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.', + 'type' => 'string', + 'example' => 'A08F908D-2C35-583F-93C1-ED80753F****', + 'title' => '', + ], + 'ErrCode' => [ + 'description' => 'The error code.', + 'type' => 'string', + 'example' => 'DBS.ParamIsInValid', + 'title' => '', + ], + 'Success' => [ + 'description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'- **true**: The request was successful.'."\n" + ."\n" + .'- **false**: The request failed.', + 'type' => 'string', + 'example' => 'true', + 'title' => '', + ], + 'ErrMessage' => [ + 'description' => 'The error message.', + 'type' => 'string', + 'example' => 'formatType can not be empty', + 'title' => '', + ], + 'Code' => [ + 'description' => 'The status code.', + 'type' => 'string', + 'example' => 'DBS.ParamIsInValid', + 'title' => '', + ], + 'Message' => [ + 'description' => 'The error message.', + 'type' => 'string', + 'example' => 'formatType can not be empty', + 'title' => '', + ], + 'Data' => [ + 'description' => 'The returned data.', + 'type' => 'object', + 'properties' => [ + 'BakSetId' => [ + 'description' => 'The ID of the full backup set.', + 'type' => 'string', + 'example' => '146005****', + 'title' => '', + ], + 'DownloadStatus' => [ + 'description' => 'The status of the download task. Valid values:'."\n" + ."\n" + .'- initializing: The task is being initialized.'."\n" + ."\n" + .'- queueing: The task is in a queue.'."\n" + ."\n" + .'- running: The task is running.'."\n" + ."\n" + .'- failed: The task failed.'."\n" + ."\n" + .'- finished: The task is complete.'."\n" + ."\n" + .'- expired: The task has expired.'."\n" + ."\n" + .'> A task whose destination is a URL expires three days after it is complete.', + 'type' => 'string', + 'example' => 'initializing', + 'title' => '', + ], + 'Progress' => [ + 'description' => 'The number of downloaded tables/The total number of tables.'."\n" + ."\n" + .'> If the task is in the preparation stage, 0/0 is returned.', + 'type' => 'string', + 'example' => '0/0', + 'title' => '', + ], + 'BackupSetTime' => [ + 'description' => 'The point in time of the point-in-time download task. The value is a UNIX timestamp.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1661373070000', + 'title' => '', + ], + 'RegionCode' => [ + 'description' => 'The region ID.', + 'type' => 'string', + 'example' => 'cn-beijing', + 'title' => '', + ], + 'TargetPath' => [ + 'description' => 'The destination path for the download.'."\n" + ."\n" + .'> This parameter is returned when TargetType is set to **OSS**.', + 'type' => 'string', + 'example' => 'test_db/path', + 'title' => '', + ], + 'DbList' => [ + 'description' => 'If the download task is for specific databases and tables, this field returns information about these databases and tables.', + 'type' => 'string', + 'example' => 'testdb', + 'title' => '', + ], + 'ExportDataSize' => [ + 'description' => 'The volume of exported data. Unit: bytes.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + 'title' => '', + ], + 'ImportDataSize' => [ + 'description' => 'The volume of processed data. Unit: bytes.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + 'title' => '', + ], + 'GmtCreate' => [ + 'description' => 'The time when the task was created. The value is a UNIX timestamp.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1661940917570', + 'title' => '', + ], + 'TaskId' => [ + 'description' => 'The ID of the download task.', + 'type' => 'string', + 'example' => 'dt-qxnsfq5s****', + 'title' => '', + ], + 'Format' => [ + 'description' => 'The format to which the data is converted.', + 'type' => 'string', + 'example' => 'CSV', + 'title' => '', + ], + 'TargetType' => [ + 'description' => 'The destination type for the download.', + 'type' => 'string', + 'example' => 'URL', + 'title' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + ], + ], + 'errorCodes' => [ + 200 => [ + [ + 'errorCode' => 'DBS.DownloadTask.CannotFind', + 'errorMessage' => 'Can not find download task.', + 'description' => 'Can not find download task.', + ], + [ + 'errorCode' => 'DBS.DownloadTask.JobAlreadyExist', + 'errorMessage' => 'Job already submit in recent days, please check it.', + 'description' => 'Job already submit in recent days, please check it.', + ], + [ + 'errorCode' => 'DBS.DownloadTask.OnlyOneRunningOrFailedTask', + 'errorMessage' => 'There can be only one running or failed task for the instance.', + 'description' => 'The current instance can only have one running/failed task at the same time.', + ], + [ + 'errorCode' => 'DBS.DownloadTask.OssForbid', + 'errorMessage' => 'OSS is forbidden to access. Please check your OSS bucket.', + 'description' => 'OSS is forbidden to access. Please check your OSS bucket.', + ], + [ + 'errorCode' => 'DBS.DownloadTask.OssStorageTypeInvalid', + 'errorMessage' => 'Unsupported bucket storage. Please make sure that your OSS bucket\'s storgae type is standard.', + 'description' => 'Unsupported bucket storage. Please make sure that your OSS bucket\'s storgae type is standard.', + ], + [ + 'errorCode' => 'Forbidden.InstanceNotFound', + 'errorMessage' => 'instance not found', + 'description' => 'The instance does not exist.', + ], + ], + 403 => [ + [ + 'errorCode' => 'Request.Forbidden', + 'errorMessage' => 'Have no Permissions', + 'description' => '', + ], + [ + 'errorCode' => 'DBS.NoPermissionException', + 'errorMessage' => 'Rejected by ValidationChecker.', + 'description' => '', + ], + ], + [ + [ + 'errorCode' => 'DBS.NotExists', + 'errorMessage' => 'data source do not existed.', + 'description' => 'DBS.NotExists', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A08F908D-2C35-583F-93C1-ED80753F****\\",\\n \\"ErrCode\\": \\"DBS.ParamIsInValid\\",\\n \\"Success\\": \\"true\\",\\n \\"ErrMessage\\": \\"formatType can not be empty\\",\\n \\"Code\\": \\"DBS.ParamIsInValid\\",\\n \\"Message\\": \\"formatType can not be empty\\",\\n \\"Data\\": {\\n \\"BakSetId\\": \\"146005****\\",\\n \\"DownloadStatus\\": \\"initializing\\",\\n \\"Progress\\": \\"0/0\\",\\n \\"BackupSetTime\\": 1661373070000,\\n \\"RegionCode\\": \\"cn-beijing\\",\\n \\"TargetPath\\": \\"test_db/path\\",\\n \\"DbList\\": \\"testdb\\",\\n \\"ExportDataSize\\": 0,\\n \\"ImportDataSize\\": 0,\\n \\"GmtCreate\\": 1661940917570,\\n \\"TaskId\\": \\"dt-qxnsfq5s****\\",\\n \\"Format\\": \\"CSV\\",\\n \\"TargetType\\": \\"URL\\"\\n }\\n}","type":"json"}]', + 'title' => 'CreateDownload', + 'description' => '### Applicable engines'."\n" + ."\n" + .'- RDS MySQL (with cloud disks)'."\n" + ."\n" + .'- RDS PostgreSQL'."\n" + ."\n" + .'- PolarDB for MySQL'."\n" + ."\n" + .'- MongoDB'."\n" + ."\n" + .'### Related documents'."\n" + ."\n" + .'For eligible instances, you can create an Advanced Download task for a point in time or a specific backup set. You can download the data to a URL or write it directly to your Object Storage Service (OSS) bucket for data analytics and offline archiving.'."\n" + ."\n" + .'- [Download an RDS MySQL backup](~~98819~~)'."\n" + ."\n" + .'- [Download an RDS PostgreSQL backup](~~96774~~)'."\n" + ."\n" + .'- [Download a PolarDB for MySQL backup](~~2627635~~)'."\n" + ."\n" + .'- [Download a MongoDB backup](~~55011~~)', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'dbs:CreateDownload', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DBS', + 'resourceType' => 'DBInstance', + 'arn' => 'acs:rds:{#regionId}:{#accountId}:dbinstance/{#DbInstanceId}', + ], + ], + ], + ], + ], + ], + 'DeleteSandboxInstance' => [ + 'summary' => 'Deletes a sandbox instance.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'delete', + ], + 'parameters' => [ + [ + 'name' => 'BackupPlanId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the backup plan.'."\n" + ."\n" + .'> If your instance is an ApsaraDB RDS for MySQL instance, use the [auto-add data source](~~193091~~) feature to add the RDS instance to DBS and obtain the backup plan ID.', + 'type' => 'string', + 'required' => true, + 'example' => '1hxxxx8xxxxxa', + 'title' => '', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the sandbox instance.', + 'type' => 'string', + 'required' => true, + 'example' => '1jxxxxnxxx1xc', + 'title' => '', + ], + ], + [ + 'name' => 'ZoneId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The zone ID of the destination sandbox instance. The zone must be supported by PrivateLink. Call the [DescribeZones](~~469326~~) operation to query the list of zones in a specific region.'."\n" + ."\n" + .'> Before using the sandbox feature, enable [PrivateLink](~~459882~~). Call the [OpenPrivateLinkService](~~469322~~) operation to enable PrivateLink.', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou-b', + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Data' => [ + 'description' => 'The error message.', + 'type' => 'string', + 'example' => 'operation forbidden due to sandbox is creating.', + 'title' => '', + ], + 'RequestId' => [ + 'description' => 'The request ID.', + 'type' => 'string', + 'example' => '4F1888AC-1138-4995-B9FE-D2734F61C058', + 'title' => '', + ], + 'ErrCode' => [ + 'description' => 'The error code.', + 'type' => 'string', + 'example' => 'Param.NotFound', + 'title' => '', + ], + 'Success' => [ + 'description' => 'Indicates whether the request is successful.', + 'type' => 'string', + 'example' => 'true', + 'title' => '', + ], + 'ErrMessage' => [ + 'description' => 'The error message.', + 'type' => 'string', + 'example' => 'The specified parameter %s value is not valid.', + 'title' => '', + ], + 'Code' => [ + 'description' => 'The error code.', + 'type' => 'string', + 'example' => 'Param.NotFound', + 'title' => '', + ], + 'Message' => [ + 'description' => 'The error message.', + 'type' => 'string', + 'example' => 'The specified parameter %s value is not valid.', + 'title' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'Request.Forbidden', + 'errorMessage' => 'Have no Permissions', + 'description' => '', + ], + ], + ], + 'title' => 'DeleteSandboxInstance', + 'description' => 'This operation is only available for the 2021-01-01 version of the DBS API.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => '|Error code|Error message|Description|'."\n" + .'|---|---|---|'."\n" + .'|Operation.DeniedByJobStatus|operation forbidden due to sandbox is creating|The error message returned because the sandbox instance is being created and cannot be released. Release the sandbox instance when it is running.|', + 'changeSet' => [ + [ + 'createdAt' => '2023-08-18T09:25:36.000Z', + 'description' => 'Request parameters changed', + ], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'dbs:DeleteSandboxInstance', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DBS', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": \\"operation forbidden due to sandbox is creating.\\",\\n \\"RequestId\\": \\"4F1888AC-1138-4995-B9FE-D2734F61C058\\",\\n \\"ErrCode\\": \\"Param.NotFound\\",\\n \\"Success\\": \\"true\\",\\n \\"ErrMessage\\": \\"The specified parameter %s value is not valid.\\",\\n \\"Code\\": \\"Param.NotFound\\",\\n \\"Message\\": \\"The specified parameter %s value is not valid.\\"\\n}","type":"json"}]', + ], + 'DescribeBackupDataList' => [ + 'summary' => 'Queries the details of backups for a PolarDB for MySQL cluster.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '171434', + 'abilityTreeNodes' => [ + 'FEATUREcbsUOJI4N', + ], + ], + 'parameters' => [ + [ + 'name' => 'InstanceName', + 'in' => 'query', + 'schema' => [ + 'title' => '', + 'description' => 'The ID of the PolarDB cluster.', + 'type' => 'string', + 'required' => false, + 'example' => 'pc-2ze3nrr64c5******', + ], + ], + [ + 'name' => 'RegionCode', + 'in' => 'query', + 'schema' => [ + 'title' => '', + 'description' => 'The region where the backup set is located.', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'SceneType', + 'in' => 'query', + 'schema' => [ + 'title' => '', + 'description' => 'The backup scenario. This parameter supports only **LEVEL\\_1**, which indicates a level-1 backup in the region where the instance resides.', + 'type' => 'string', + 'required' => false, + 'example' => 'LEVEL_1', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'title' => '', + 'description' => 'The start of the time range to query. Specify the time in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.', + 'type' => 'string', + 'required' => false, + 'example' => '2024-04-17T17:00:16Z', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'title' => '', + 'description' => 'The end of the time range to query. The end time must be later than the start time. Specify the time in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.', + 'type' => 'string', + 'required' => false, + 'example' => '2024-04-17T17:00:32Z', + ], + ], + [ + 'name' => 'BackupStatus', + 'in' => 'query', + 'schema' => [ + 'title' => '', + 'description' => 'The status of the backup set. Valid values:'."\n" + ."\n" + .'- **OK**: The backup is successful.'."\n" + ."\n" + .'- **ERROR**: The backup failed.', + 'type' => 'string', + 'required' => false, + 'example' => 'OK', + ], + ], + [ + 'name' => 'BackupId', + 'in' => 'query', + 'schema' => [ + 'title' => '', + 'description' => 'The ID of the backup set.', + 'type' => 'string', + 'required' => false, + 'example' => '213064****', + ], + ], + [ + 'name' => 'BackupMethod', + 'in' => 'query', + 'schema' => [ + 'title' => '', + 'description' => 'The backup method. Valid values:'."\n" + ."\n" + .'- **Physical**: physical backup'."\n" + ."\n" + .'- **Logical**: logical backup'."\n" + ."\n" + .'- **Snapshot**: snapshot backup', + 'type' => 'string', + 'required' => false, + 'example' => 'Snapshot', + ], + ], + [ + 'name' => 'BackupMode', + 'in' => 'query', + 'schema' => [ + 'title' => '', + 'description' => 'The backup mode. Valid values:'."\n" + ."\n" + .'- **Automated**: automatic backup'."\n" + ."\n" + .'- **Manual**: manual backup', + 'type' => 'string', + 'required' => false, + 'example' => 'Automated', + ], + ], + [ + 'name' => 'BackupType', + 'in' => 'query', + 'schema' => [ + 'title' => '', + 'description' => 'The backup type. Valid values:'."\n" + ."\n" + .'- **FullBackup**: full backup'."\n" + ."\n" + .'- **IncrementBackup**: incremental backup', + 'type' => 'string', + 'required' => false, + 'example' => 'FullBackup', + ], + ], + [ + 'name' => 'BackupScale', + 'in' => 'query', + 'schema' => [ + 'title' => '', + 'description' => 'The backup scope. Valid values:'."\n" + ."\n" + .'- **DBInstance**: instance backup'."\n" + ."\n" + .'- **DBTable**: database and table backup', + 'type' => 'string', + 'required' => false, + 'example' => 'DBInstance', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'title' => '', + 'description' => 'The number of entries to return on each page. The default value is 20.', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'title' => '', + 'description' => 'The page number. The value must be an integer that is greater than 0 and does not exceed the maximum value of the integer data type. The default value is 1.', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'InstanceIsDeleted', + 'in' => 'query', + 'schema' => [ + 'title' => '', + 'description' => 'Specifies whether the instance is deleted. Valid values:'."\n" + ."\n" + .'- **true**: The instance is deleted.'."\n" + ."\n" + .'- **false**: The instance is not deleted. This is the default value.', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'InstanceRegion', + 'in' => 'query', + 'schema' => [ + 'title' => '', + 'description' => 'The original region of the instance.', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'DataSourceId', + 'in' => 'query', + 'schema' => [ + 'title' => '', + 'description' => 'This parameter is reserved and does not need to be specified.', + 'type' => 'string', + 'required' => false, + 'example' => 'test****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The details of the returned parameters.', + 'type' => 'object', + 'properties' => [ + 'Data' => [ + 'description' => 'The returned data.', + 'type' => 'object', + 'properties' => [ + 'Content' => [ + 'description' => 'The details of the task.', + 'type' => 'array', + 'items' => [ + 'description' => 'The details of the task.', + 'type' => 'object', + 'properties' => [ + 'BackupId' => [ + 'title' => '', + 'description' => 'The ID of the backup set.', + 'type' => 'string', + 'example' => '213088****', + ], + 'BackupName' => [ + 'title' => '', + 'description' => 'The name of the backup set.', + 'type' => 'string', + 'example' => 'logic_backup', + ], + 'BackupMode' => [ + 'title' => '', + 'description' => 'The backup mode. Valid values:'."\n" + ."\n" + .'- **Automated**: automatic backup'."\n" + ."\n" + .'- **Manual**: manual backup', + 'type' => 'string', + 'example' => 'Automated', + ], + 'BackupType' => [ + 'title' => '', + 'description' => 'The backup type. Valid values:'."\n" + ."\n" + .'- **FullBackup**: full backup'."\n" + ."\n" + .'- **IncrementBackup**: incremental backup', + 'type' => 'string', + 'example' => 'FullBackup', + ], + 'BackupScale' => [ + 'title' => '', + 'description' => 'The backup scope. Valid values:'."\n" + ."\n" + .'- **DBInstance**: instance backup'."\n" + ."\n" + .'- **DBTable**: database and table backup', + 'type' => 'string', + 'example' => 'DBInstance', + ], + 'BackupMethod' => [ + 'title' => '', + 'description' => 'The backup method. Valid values:'."\n" + ."\n" + .'- **Physical**: physical backup'."\n" + ."\n" + .'- **Logical**: logical backup'."\n" + ."\n" + .'- **Snapshot**: snapshot backup', + 'type' => 'string', + 'example' => 'Snapshot', + ], + 'BackupSize' => [ + 'title' => '', + 'description' => 'The size of the backup set in bytes.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '25669140480', + ], + 'BackupStatus' => [ + 'title' => '', + 'description' => 'The status of the backup set. Valid values:'."\n" + ."\n" + .'- **OK**: The backup is successful.'."\n" + ."\n" + .'- **ERROR**: The backup failed.', + 'type' => 'string', + 'example' => 'OK', + ], + 'BackupStartTime' => [ + 'title' => '', + 'description' => 'The start time of the backup. The time is in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.', + 'type' => 'string', + 'example' => '2024-04-17T17:00:16Z', + ], + 'BackupEndTime' => [ + 'title' => '', + 'description' => 'The end time of the backup. The time is in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.', + 'type' => 'string', + 'example' => '2024-04-17T17:00:32Z', + ], + 'ConsistentTime' => [ + 'title' => '', + 'description' => 'The point in time of the consistent snapshot. The value is a UNIX timestamp. Unit: seconds.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1713373221', + ], + 'BackupLocation' => [ + 'title' => '', + 'description' => 'The storage path of the backup.', + 'type' => 'string', + 'example' => 'logic', + ], + 'InstanceName' => [ + 'title' => '', + 'description' => 'The ID of the instance.', + 'type' => 'string', + 'example' => 'pc-2ze3nrr64c5******', + ], + 'Engine' => [ + 'title' => '', + 'description' => 'The database engine type.', + 'type' => 'string', + 'example' => 'polardb_mysql', + ], + 'EngineVersion' => [ + 'title' => '', + 'description' => 'The database engine version.', + 'type' => 'string', + 'example' => '5.7', + ], + 'SupportDeletion' => [ + 'title' => '', + 'description' => 'Indicates whether the backup set can be deleted. Valid values:'."\n" + ."\n" + .'- **0**: The backup set can be deleted.'."\n" + ."\n" + .'- **1**: The backup set cannot be deleted.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'Encryption' => [ + 'title' => '', + 'description' => 'The encryption information.', + 'type' => 'string', + 'example' => 'psk2', + ], + 'IsAvail' => [ + 'title' => '', + 'description' => 'Indicates whether the backup set is available. Valid values:'."\n" + ."\n" + .'- **1**: The backup set is available.'."\n" + ."\n" + .'- **0**: The backup set is unavailable.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Checksum' => [ + 'title' => '', + 'description' => 'The checksum.', + 'type' => 'string', + 'example' => '84a4c16431f969712e6895992719****', + ], + 'BackupDownloadURL' => [ + 'title' => '', + 'description' => 'The public download URL of the backup set.'."\n" + ."\n" + .'> This parameter is returned only when BackupMethod is set to **Physical** (physical backup) or **Logical** (logical backup).', + 'type' => 'string', + 'example' => 'http://oss.com/****', + ], + 'BackupIntranetDownloadURL' => [ + 'title' => '', + 'description' => 'The internal download URL of the backup set.'."\n" + ."\n" + .'> This parameter is returned only when BackupMethod is set to **Physical** (physical backup) or **Logical** (logical backup).', + 'type' => 'string', + 'example' => 'http://oss.com/****', + ], + 'ExpectExpireType' => [ + 'title' => '', + 'description' => 'The expected expiration type of the backup set. Valid values:'."\n" + ."\n" + .'- NEVER'."\n" + ."\n" + .'- EXPIRED'."\n" + ."\n" + .'- DELAY', + 'type' => 'string', + 'example' => 'DELAY', + ], + 'ExpectExpireTime' => [ + 'title' => '', + 'description' => 'The expected expiration time of the backup set. The time is in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.', + 'type' => 'string', + 'example' => '2024-04-19T05:00:49Z', + ], + 'PolarSnapshot' => [ + 'title' => '', + 'description' => 'The information about the level-2 dump of the PolarDB cluster.'."\n" + ."\n" + .'> The PolarSnapshot-related information is returned only after the level-2 dump feature is enabled for the PolarDB cluster in the same region and the level-1 backup is successfully dumped.', + 'type' => 'object', + 'properties' => [ + 'DumpId' => [ + 'title' => '', + 'description' => 'The ID of the dump.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => 'abc****', + ], + 'DumpSize' => [ + 'title' => '', + 'description' => 'The size of the dump backup in bytes.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '25669140589', + ], + 'expectExpireType' => [ + 'title' => '', + 'description' => 'The expected expiration type of the backup set. Valid values:'."\n" + ."\n" + .'- NEVER'."\n" + ."\n" + .'- EXPIRED'."\n" + ."\n" + .'- DELAY', + 'type' => 'string', + 'example' => 'DELAY', + ], + 'ExpectExpireTime' => [ + 'title' => '', + 'description' => 'The expected expiration time of the backup set. The time is in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.', + 'type' => 'string', + 'example' => '2024-04-19T05:00:49Z', + ], + ], + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'PageSize' => [ + 'title' => '', + 'description' => 'The page size.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '20', + ], + 'PageNumber' => [ + 'title' => '', + 'description' => 'The page number.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'TotalPages' => [ + 'title' => '', + 'description' => 'The total number of pages.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'TotalElements' => [ + 'title' => '', + 'description' => 'The total number of backup sets.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'Extra' => [ + 'title' => '', + 'description' => 'Extra information.', + 'type' => 'string', + 'example' => 'dbtest', + ], + ], + 'title' => '', + 'example' => '', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.', + 'type' => 'string', + 'title' => '', + 'example' => '95A5FFD0-7F46-5A7D-9DFE-6A376B4E2A28', + ], + 'ErrCode' => [ + 'description' => 'The error code.', + 'type' => 'string', + 'title' => '', + 'example' => 'Request.Forbidden ', + ], + 'Success' => [ + 'description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'- **true**: The request was successful.'."\n" + ."\n" + .'- **false**: The request failed.', + 'type' => 'string', + 'title' => '', + 'example' => 'true', + ], + 'ErrMessage' => [ + 'description' => 'The error message.', + 'type' => 'string', + 'title' => '', + 'example' => 'The specified parameter %s value is not valid. ', + ], + 'Code' => [ + 'description' => 'The status code.', + 'type' => 'string', + 'title' => '', + 'example' => 'Success', + ], + 'Message' => [ + 'description' => 'The returned message.', + 'type' => 'string', + 'title' => '', + 'example' => 'The specified parameter %s value is not valid.', + ], + ], + 'title' => '', + 'example' => '', + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'Request.Forbidden', + 'errorMessage' => 'Have no Permissions', + 'description' => '', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'title' => 'DescribeBackupDataList', + 'description' => '### Applicable engines'."\n" + ."\n" + .'PolarDB for MySQL'."\n" + ."\n" + .'> This API operation is available only to specific customers. To use this operation, join the DBS Customer Service DingTalk group (ID: 35585947) to request access.'."\n" + ."\n" + .'### Related documents'."\n" + ."\n" + .'[Back up a PolarDB for MySQL cluster](~~88172~~)', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'dbs:DescribeBackupDataList', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'conditional', + 'product' => 'DBS', + 'resourceType' => 'DBInstance', + 'arn' => 'acs:rds:{#regionId}:{#accountId}:dbinstance/{#DbInstanceId}', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"Content\\": [\\n {\\n \\"BackupId\\": \\"213088****\\",\\n \\"BackupName\\": \\"logic_backup\\",\\n \\"BackupMode\\": \\"Automated\\",\\n \\"BackupType\\": \\"FullBackup\\",\\n \\"BackupScale\\": \\"DBInstance\\",\\n \\"BackupMethod\\": \\"Snapshot\\",\\n \\"BackupSize\\": 25669140480,\\n \\"BackupStatus\\": \\"OK\\",\\n \\"BackupStartTime\\": \\"2024-04-17T17:00:16Z\\",\\n \\"BackupEndTime\\": \\"2024-04-17T17:00:32Z\\",\\n \\"ConsistentTime\\": 1713373221,\\n \\"BackupLocation\\": \\"logic\\",\\n \\"InstanceName\\": \\"pc-2ze3nrr64c5******\\",\\n \\"Engine\\": \\"polardb_mysql\\",\\n \\"EngineVersion\\": \\"5.7\\",\\n \\"SupportDeletion\\": 0,\\n \\"Encryption\\": \\"psk2\\",\\n \\"IsAvail\\": 1,\\n \\"Checksum\\": \\"84a4c16431f969712e6895992719****\\",\\n \\"BackupDownloadURL\\": \\"http://oss.com/****\\",\\n \\"BackupIntranetDownloadURL\\": \\"http://oss.com/****\\",\\n \\"ExpectExpireType\\": \\"DELAY\\",\\n \\"ExpectExpireTime\\": \\"2024-04-19T05:00:49Z\\",\\n \\"PolarSnapshot\\": {\\n \\"DumpId\\": 0,\\n \\"DumpSize\\": 25669140589,\\n \\"expectExpireType\\": \\"DELAY\\",\\n \\"ExpectExpireTime\\": \\"2024-04-19T05:00:49Z\\"\\n }\\n }\\n ],\\n \\"PageSize\\": 20,\\n \\"PageNumber\\": 1,\\n \\"TotalPages\\": 1,\\n \\"TotalElements\\": 1,\\n \\"Extra\\": \\"dbtest\\"\\n },\\n \\"RequestId\\": \\"95A5FFD0-7F46-5A7D-9DFE-6A376B4E2A28\\",\\n \\"ErrCode\\": \\"Request.Forbidden\\\\t\\",\\n \\"Success\\": \\"true\\",\\n \\"ErrMessage\\": \\"The specified parameter %s value is not valid. \\",\\n \\"Code\\": \\"Success\\",\\n \\"Message\\": \\"The specified parameter %s value is not valid.\\"\\n}","type":"json"}]', + ], + 'DescribeBackupPolicy' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '215256', + 'abilityTreeNodes' => [ + 'FEATUREcbsPNQ3FN', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionCode', + 'in' => 'query', + 'schema' => [ + 'title' => '', + 'description' => 'The region where the backup set is located.', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-beijing', + ], + ], + [ + 'name' => 'InstanceName', + 'in' => 'query', + 'schema' => [ + 'title' => '', + 'description' => 'The ID of the PolarDB instance.', + 'type' => 'string', + 'required' => false, + 'example' => 'pc-2ze3nrr64c5****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The response parameters.', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.', + 'type' => 'string', + 'title' => '', + 'example' => '54A63B3B-AA10-1CC3-A6BB-6CCE98D19628', + ], + 'Message' => [ + 'description' => 'The response message.', + 'type' => 'string', + 'title' => '', + 'example' => 'instanceName can not be empty.', + ], + 'Data' => [ + 'description' => 'The details of the backup policy.', + 'type' => 'object', + 'properties' => [ + 'PreferredBackupDate' => [ + 'title' => '', + 'description' => 'The basic backup cycle. This is a 7-digit number. From left to right, each digit represents a day from Monday to Sunday. A value of 1 indicates that a backup is performed, and 0 indicates that no backup is performed.', + 'type' => 'string', + 'example' => '1010101', + ], + 'PreferredBackupWindowBegin' => [ + 'title' => '', + 'description' => 'The start time of the basic backup window.', + 'type' => 'string', + 'example' => '23:00Z', + ], + 'PreferredBackupWindow' => [ + 'title' => '', + 'description' => 'The basic backup window.', + 'type' => 'string', + 'example' => '23:00Z-24:00Z', + ], + 'BackupRetentionPeriod' => [ + 'title' => '', + 'description' => 'The retention period for basic backups. If an advanced backup policy is enabled, this is the longest retention period for level-1 backups.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '7', + ], + 'BackupRetentionPolicyOnClusterDeletion' => [ + 'title' => '', + 'description' => 'The data retention policy for archived backups of deleted instances. Valid values:'."\n" + ."\n" + .'- **NONE**: No backups are retained.'."\n" + ."\n" + .'- **LATEST**: The last backup is retained.'."\n" + ."\n" + .'- **ALL**: All backups are retained.', + 'type' => 'string', + 'example' => 'LATEST', + ], + 'HighFrequencyBakInterval' => [ + 'title' => '', + 'description' => 'The high-frequency backup interval in minutes. For example, a value of 120 means that a backup is performed every two hours.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '120', + ], + 'BackupPriority' => [ + 'title' => '', + 'description' => 'The policy for backing up the secondary database. Valid values:'."\n" + ."\n" + .'- **1**: The secondary database is preferred.'."\n" + ."\n" + .'- **2**: Backup is forced to run on the primary database.'."\n" + ."\n" + .'> This parameter applies only to RDS SQL Server instances. For other engines, the return value is **0**.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'EnableLogBackup' => [ + 'title' => '', + 'description' => 'Specifies whether log backup is enabled. Valid values:'."\n" + ."\n" + .'- **1**: Enabled'."\n" + ."\n" + .'- **0**: Not enabled', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'LogBackupRetention' => [ + 'title' => '', + 'description' => 'The retention period for log backups.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '7', + ], + 'LogBackupLocalRetentionNumber' => [ + 'title' => '', + 'description' => 'The number of local log files to retain.', + 'type' => 'string', + 'example' => '10', + ], + 'EnableBackup' => [ + 'title' => '', + 'description' => 'Specifies whether backup is enabled.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'LocalLogRetentionSpace' => [ + 'title' => '', + 'description' => 'The maximum space usage for local logs.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '30', + ], + 'HighSpaceUsageProtection' => [ + 'title' => '', + 'description' => 'Specifies whether to forcibly clear logs when the instance space usage exceeds 80% or the remaining space is less than 5 GB. Valid values:'."\n" + ."\n" + .'- **Disable**: Do not clear logs.'."\n" + ."\n" + .'- **Enable**: Clear logs.', + 'type' => 'string', + 'example' => 'Enable', + ], + 'Category' => [ + 'title' => '', + 'description' => 'Specifies whether second-level backup is enabled. Valid values:'."\n" + ."\n" + .'- **Flash**: Second-level backup is enabled.'."\n" + ."\n" + .'- **Standard**: Standard backup.'."\n" + ."\n" + .'> This parameter is valid only for MySQL.', + 'type' => 'string', + 'example' => 'Standard', + ], + 'IncBackupInterval' => [ + 'title' => '', + 'description' => 'The interval for high-frequency incremental backups.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '-1', + ], + 'EnableIncBackup' => [ + 'title' => '', + 'description' => 'Specifies whether incremental backup is enabled.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'BackupMethod' => [ + 'title' => '', + 'description' => 'The backup method. Valid values:'."\n" + ."\n" + .'- **Physical**: Physical backup'."\n" + ."\n" + .'- **Snapshot**: Snapshot backup', + 'type' => 'string', + 'example' => 'Physical', + ], + 'AdvanceLogPolicies' => [ + 'description' => 'The details of the log backup policy.', + 'type' => 'array', + 'items' => [ + 'description' => 'The details of the policy.', + 'type' => 'object', + 'properties' => [ + 'PolicyId' => [ + 'title' => '', + 'description' => 'The ID of the backup policy.', + 'type' => 'string', + 'example' => 'dc13b153acc91141789122c23835****', + ], + 'SrcType' => [ + 'title' => '', + 'description' => 'The source type of the backup policy. Valid values:'."\n" + ."\n" + .'- **db**: Database'."\n" + ."\n" + .'- **level1**: Level-1 backup'."\n" + ."\n" + .'- **level2**: Level-2 backup'."\n" + ."\n" + .'- **level2Cross**: Level-2 cross-region backup', + 'type' => 'string', + 'example' => 'level1', + ], + 'SrcRegion' => [ + 'title' => '', + 'description' => 'The source region of the backup policy.', + 'type' => 'string', + 'example' => 'cn-beijing', + ], + 'DestType' => [ + 'title' => '', + 'description' => 'The destination type of the backup policy. Valid values:'."\n" + ."\n" + .'- **db**: Database'."\n" + ."\n" + .'- **level1**: Level-1 backup'."\n" + ."\n" + .'- **level2**: Level-2 backup'."\n" + ."\n" + .'- **level2Cross**: Level-2 cross-region backup', + 'type' => 'string', + 'example' => 'level1', + ], + 'DestRegion' => [ + 'title' => '', + 'description' => 'The destination region of the backup policy.', + 'type' => 'string', + 'example' => 'cn-shanghai', + ], + 'EnableLogBackup' => [ + 'title' => '', + 'description' => 'A reserved parameter.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'LogRetentionType' => [ + 'title' => '', + 'description' => 'The retention type for log backups. Valid values:'."\n" + ."\n" + .'- **never**: Never expires'."\n" + ."\n" + .'- **delay**: Expires after a fixed number of days', + 'type' => 'string', + 'example' => 'delay', + ], + 'LogRetentionValue' => [ + 'title' => '', + 'description' => 'The retention period for log backups.', + 'type' => 'string', + 'example' => '3', + ], + 'FilterType' => [ + 'type' => 'string', + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'FilterKey' => [ + 'type' => 'string', + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'FilterValue' => [ + 'type' => 'string', + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'AdvanceDataPolicies' => [ + 'description' => 'The details of the data backup policy.', + 'type' => 'array', + 'items' => [ + 'description' => 'The details of the policy.', + 'type' => 'object', + 'properties' => [ + 'PolicyId' => [ + 'title' => '', + 'description' => 'The ID of the advanced policy.', + 'type' => 'string', + 'example' => '71930ac2e9f15e41615e10627c******', + ], + 'FilterType' => [ + 'title' => '', + 'description' => 'The filter type for the advanced policy. Valid values:'."\n" + ."\n" + .'- **crontab**: Recurring schedule'."\n" + ."\n" + .'- **event**: Event-driven schedule', + 'type' => 'string', + 'example' => 'crontab', + ], + 'FilterKey' => [ + 'title' => '', + 'description' => 'The schedule type. Valid values:'."\n" + ."\n" + .'- **dayOfWeek**: Weekly schedule'."\n" + ."\n" + .'- **dayOfMonth**: Monthly schedule'."\n" + ."\n" + .'- **dayOfYear**: Yearly schedule'."\n" + ."\n" + .'- **backupInterval**: Fixed interval schedule'."\n" + ."\n" + .'> This parameter is returned only when FilterType is set to **crontab**.', + 'type' => 'string', + 'example' => 'dayOfWeek', + ], + 'FilterValue' => [ + 'title' => '', + 'description' => 'The backup cycle.', + 'type' => 'string', + 'example' => '1,2,3,4,5,6,7', + ], + 'DumpAction' => [ + 'title' => '', + 'description' => 'The dump policy. Valid values:'."\n" + ."\n" + .'- **copy**: Copy'."\n" + ."\n" + .'- **move**: Dump', + 'type' => 'string', + 'example' => 'copy', + ], + 'RetentionType' => [ + 'title' => '', + 'description' => 'The retention period type for the backup set. Valid values:'."\n" + ."\n" + .'- **never**: Never expires'."\n" + ."\n" + .'- **delay**: Expires after a fixed number of days', + 'type' => 'string', + 'example' => 'delay', + ], + 'RetentionValue' => [ + 'title' => '', + 'description' => 'The number of days before expiration.', + 'type' => 'string', + 'example' => '7', + ], + 'SrcType' => [ + 'title' => '', + 'description' => 'The source type of the backup policy. Valid values:'."\n" + ."\n" + .'- **db**: Database'."\n" + ."\n" + .'- **level1**: Level-1 backup'."\n" + ."\n" + .'- **level2**: Level-2 backup'."\n" + ."\n" + .'- **level2Cross**: Level-2 cross-region backup', + 'type' => 'string', + 'example' => 'db', + ], + 'SrcRegion' => [ + 'title' => '', + 'description' => 'The source region of the backup policy.', + 'type' => 'string', + 'example' => 'cn-beijing', + ], + 'DestType' => [ + 'title' => '', + 'description' => 'The destination type of the backup policy. Valid values:'."\n" + ."\n" + .'- **db**: Database'."\n" + ."\n" + .'- **level1**: Level-1 backup'."\n" + ."\n" + .'- **level2**: Level-2 backup'."\n" + ."\n" + .'- **level2Cross**: Level-2 cross-region backup', + 'type' => 'string', + 'example' => 'level1', + ], + 'DestRegion' => [ + 'title' => '', + 'description' => 'The destination region of the backup policy.', + 'type' => 'string', + 'example' => 'cn-beijing', + ], + 'BakType' => [ + 'title' => '', + 'description' => 'The backup type. Valid values:'."\n" + ."\n" + .'- **F**: Full backup'."\n" + ."\n" + .'- **L**: Log backup', + 'type' => 'string', + 'example' => 'F', + ], + 'AutoCreated' => [ + 'title' => '', + 'description' => 'Specifies whether the backup policy is automatically generated by the system. Valid values:'."\n" + ."\n" + .'- **true**: The policy is generated by the system.'."\n" + ."\n" + .'- **false**: The policy is a custom policy.', + 'type' => 'boolean', + 'example' => 'true', + ], + 'StorageClass' => [ + 'type' => 'string', + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'AdvanceIncPolicies' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'PolicyId' => [ + 'type' => 'string', + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'FilterType' => [ + 'type' => 'string', + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'FilterKey' => [ + 'type' => 'string', + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'FilterValue' => [ + 'type' => 'string', + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'DumpAction' => [ + 'type' => 'string', + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'RetentionType' => [ + 'type' => 'string', + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'RetentionValue' => [ + 'type' => 'string', + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'SrcType' => [ + 'type' => 'string', + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'SrcRegion' => [ + 'type' => 'string', + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'DestType' => [ + 'type' => 'string', + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'DestRegion' => [ + 'type' => 'string', + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'BakType' => [ + 'type' => 'string', + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'AutoCreated' => [ + 'type' => 'boolean', + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'ErrMessage' => [ + 'description' => 'The error message.', + 'type' => 'string', + 'title' => '', + 'example' => 'The specified parameter %s value is not valid. ', + ], + 'Code' => [ + 'description' => 'The status code.', + 'type' => 'string', + 'title' => '', + 'example' => 'Success', + ], + 'Success' => [ + 'description' => 'Specifies whether the request was successful. Valid values:'."\n" + ."\n" + .'- **true**: The request was successful.'."\n" + ."\n" + .'- **false**: The request failed.', + 'type' => 'string', + 'title' => '', + 'example' => 'true', + ], + 'ErrCode' => [ + 'description' => 'The error code.', + 'type' => 'string', + 'title' => '', + 'example' => 'Success', + ], + ], + 'title' => '', + 'example' => '', + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'Request.Forbidden', + 'errorMessage' => 'Have no Permissions', + 'description' => '', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'title' => 'DescribeBackupPolicy', + 'summary' => 'Queries the backup policy for a PolarDB instance.', + 'description' => '### Applicable engines'."\n" + ."\n" + .'PolarDB for MySQL'."\n" + ."\n" + .'> This API operation is available only to specific customers. To use this operation, join the DBS Customer Service DingTalk group (ID: 35585947) and request access.'."\n" + ."\n" + .'### Related document'."\n" + ."\n" + .'[Backup policies for PolarDB for MySQL](~~280422~~)', + 'changeSet' => [ + [ + 'createdAt' => '2024-05-28T13:59:23.000Z', + 'description' => 'Response parameters changed', + ], + [ + 'createdAt' => '2024-05-17T02:21:41.000Z', + 'description' => 'Response parameters changed', + ], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dbs:DescribeBackupPolicy', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DBS', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"54A63B3B-AA10-1CC3-A6BB-6CCE98D19628\\",\\n \\"Message\\": \\"instanceName can not be empty.\\",\\n \\"Data\\": {\\n \\"PreferredBackupDate\\": \\"1010101\\",\\n \\"PreferredBackupWindowBegin\\": \\"23:00Z\\",\\n \\"PreferredBackupWindow\\": \\"23:00Z-24:00Z\\",\\n \\"BackupRetentionPeriod\\": 7,\\n \\"BackupRetentionPolicyOnClusterDeletion\\": \\"LATEST\\",\\n \\"HighFrequencyBakInterval\\": 120,\\n \\"BackupPriority\\": 0,\\n \\"EnableLogBackup\\": 1,\\n \\"LogBackupRetention\\": 7,\\n \\"LogBackupLocalRetentionNumber\\": \\"10\\",\\n \\"EnableBackup\\": 1,\\n \\"LocalLogRetentionSpace\\": 30,\\n \\"HighSpaceUsageProtection\\": \\"Enable\\",\\n \\"Category\\": \\"Standard\\",\\n \\"IncBackupInterval\\": -1,\\n \\"EnableIncBackup\\": 0,\\n \\"BackupMethod\\": \\"Physical\\",\\n \\"AdvanceLogPolicies\\": [\\n {\\n \\"PolicyId\\": \\"dc13b153acc91141789122c23835****\\",\\n \\"SrcType\\": \\"level1\\",\\n \\"SrcRegion\\": \\"cn-beijing\\",\\n \\"DestType\\": \\"level1\\",\\n \\"DestRegion\\": \\"cn-shanghai\\",\\n \\"EnableLogBackup\\": 1,\\n \\"LogRetentionType\\": \\"delay\\",\\n \\"LogRetentionValue\\": \\"3\\",\\n \\"FilterType\\": \\"\\",\\n \\"FilterKey\\": \\"\\",\\n \\"FilterValue\\": \\"\\"\\n }\\n ],\\n \\"AdvanceDataPolicies\\": [\\n {\\n \\"PolicyId\\": \\"71930ac2e9f15e41615e10627c******\\",\\n \\"FilterType\\": \\"crontab\\",\\n \\"FilterKey\\": \\"dayOfWeek\\",\\n \\"FilterValue\\": \\"1,2,3,4,5,6,7\\",\\n \\"DumpAction\\": \\"copy\\",\\n \\"RetentionType\\": \\"delay\\",\\n \\"RetentionValue\\": \\"7\\",\\n \\"SrcType\\": \\"db\\",\\n \\"SrcRegion\\": \\"cn-beijing\\",\\n \\"DestType\\": \\"level1\\",\\n \\"DestRegion\\": \\"cn-beijing\\",\\n \\"BakType\\": \\"F\\",\\n \\"AutoCreated\\": true,\\n \\"StorageClass\\": \\"\\"\\n }\\n ],\\n \\"AdvanceIncPolicies\\": [\\n {\\n \\"PolicyId\\": \\"\\",\\n \\"FilterType\\": \\"\\",\\n \\"FilterKey\\": \\"\\",\\n \\"FilterValue\\": \\"\\",\\n \\"DumpAction\\": \\"\\",\\n \\"RetentionType\\": \\"\\",\\n \\"RetentionValue\\": \\"\\",\\n \\"SrcType\\": \\"\\",\\n \\"SrcRegion\\": \\"\\",\\n \\"DestType\\": \\"\\",\\n \\"DestRegion\\": \\"\\",\\n \\"BakType\\": \\"\\",\\n \\"AutoCreated\\": false\\n }\\n ]\\n },\\n \\"ErrMessage\\": \\"The specified parameter %s value is not valid. \\",\\n \\"Code\\": \\"Success\\",\\n \\"Success\\": \\"true\\",\\n \\"ErrCode\\": \\"Success\\"\\n}","type":"json"}]', + ], + 'DescribeCostInfoByDbsInstance' => [ + 'summary' => 'Queries the costs for a DBS instance.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'RegionCode', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + 'description' => 'The ID of the region where the instance is located. You can find this information in your bill.', + 'title' => '', + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'BackupPlanId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + 'description' => 'The ID of the backup billing instance.', + 'title' => '', + 'example' => 'dbsr1l3ro21****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Data' => [ + 'type' => 'string', + 'description' => 'Parameter descriptions:'."\n" + ."\n" + .'- **commodity**: The commodity.'."\n" + ."\n" + .'- **product**: The product.'."\n" + ."\n" + .'- **moduleCode**: The billing item.'."\n" + ."\n" + .'- **instanceName**: The sandbox instance ID.'."\n" + ."\n" + .'- **backupSetId**: The backup set ID.'."\n" + ."\n" + .'- **instanceName**: The name of the engine instance.'."\n" + ."\n" + .'- **backupPlanId**: The ID of the backup billing instance.', + 'title' => '', + 'example' => '{'."\n" + .' "backupPlanComment": "",'."\n" + .' "commodity": "cbs_post",'."\n" + .' "product": "cbs",'."\n" + .' "moduleCode": "BackupStorageSize",'."\n" + .' "instanceName": "d-2zefd6337d766294",'."\n" + .' "backupPlanId": "dbs:d-2zefd6337d766294",'."\n" + .' "moduleName": "mongodb"'."\n" + .' }', + ], + 'RequestId' => [ + 'type' => 'string', + 'description' => 'The request ID.', + 'title' => '', + 'example' => '9C397502-B4F2-4E22-AD97-C81F0049F3F3', + ], + 'ErrCode' => [ + 'type' => 'string', + 'description' => 'The error code.', + 'title' => '', + 'example' => 'Param.NotFound', + ], + 'Success' => [ + 'type' => 'string', + 'description' => 'Indicates whether the request was successful.', + 'title' => '', + 'example' => 'true', + ], + 'ErrMessage' => [ + 'type' => 'string', + 'description' => 'The error message.', + 'title' => '', + 'example' => 'The specified parameter %s value is not valid. ', + ], + 'Code' => [ + 'type' => 'string', + 'description' => 'The status code.', + 'title' => '', + 'example' => 'Success', + ], + 'Message' => [ + 'type' => 'string', + 'description' => 'The error message.', + 'title' => '', + 'example' => 'The specified parameter %s value is not valid.', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'Request.Forbidden', + 'errorMessage' => 'Have no Permissions', + 'description' => '', + ], + ], + ], + 'title' => 'DescribeCostInfoByDbsInstance', + 'description' => 'This operation is available only in version 2021-01-01 of the DBS API.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dbs:DescribeCostInfoByDbsInstance', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DBS', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": \\"{\\\\n \\\\\\"backupPlanComment\\\\\\": \\\\\\"\\\\\\",\\\\n \\\\\\"commodity\\\\\\": \\\\\\"cbs_post\\\\\\",\\\\n \\\\\\"product\\\\\\": \\\\\\"cbs\\\\\\",\\\\n \\\\\\"moduleCode\\\\\\": \\\\\\"BackupStorageSize\\\\\\",\\\\n \\\\\\"instanceName\\\\\\": \\\\\\"d-2zefd6337d766294\\\\\\",\\\\n \\\\\\"backupPlanId\\\\\\": \\\\\\"dbs:d-2zefd6337d766294\\\\\\",\\\\n \\\\\\"moduleName\\\\\\": \\\\\\"mongodb\\\\\\"\\\\n }\\",\\n \\"RequestId\\": \\"9C397502-B4F2-4E22-AD97-C81F0049F3F3\\",\\n \\"ErrCode\\": \\"Param.NotFound\\",\\n \\"Success\\": \\"true\\",\\n \\"ErrMessage\\": \\"The specified parameter %s value is not valid. \\",\\n \\"Code\\": \\"Success\\",\\n \\"Message\\": \\"The specified parameter %s value is not valid.\\"\\n}","type":"json"}]', + ], + 'DescribeDownloadBackupSetStorageInfo' => [ + 'summary' => 'Queries the storage information for downloading a backup set.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '135676', + 'abilityTreeNodes' => [ + 'FEATUREcbs04Q4EK', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionCode', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the region where the instance resides.', + 'type' => 'string', + 'required' => true, + 'title' => '', + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'Duration', + 'in' => 'query', + 'schema' => [ + 'description' => 'If the download destination is a URL, this parameter specifies the validity period of the link.'."\n" + ."\n" + .'- The default validity period of a URL is 2 hours (7,200 seconds).'."\n" + ."\n" + .'- You can set the validity period to a value from 5 minutes (300 seconds) to 1 day (86,400 seconds).'."\n" + ."\n" + .'- Convert the value to seconds before you pass it. For example, to set the validity period to 5 minutes, pass 300.', + 'type' => 'string', + 'required' => true, + 'title' => '', + 'example' => '300', + ], + ], + [ + 'name' => 'InstanceName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The instance ID.'."\n" + ."\n" + .'> If you specify **InstanceName**, you must also specify **BackupSetId**.', + 'type' => 'string', + 'required' => false, + 'title' => '', + 'example' => 'rm-uf6qqf569n435****', + ], + ], + [ + 'name' => 'TaskId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the download task.'."\n" + ."\n" + .'- If you do not specify **TaskId**, you must specify **BackupSetId** and **InstanceName**.'."\n" + ."\n" + .'- To view the task ID, click **Backup and Restoration** for the target instance and go to the **Backup Download** tab.', + 'type' => 'string', + 'required' => false, + 'title' => '', + 'example' => 'dt-s0ugzak9****', + ], + ], + [ + 'name' => 'BackupSetId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the backup set.', + 'type' => 'string', + 'required' => false, + 'title' => '', + 'example' => '30****', + ], + ], + [ + 'name' => 'ClusterName', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'description' => 'This parameter is required only for MongoDB instances. It specifies the name of the sharded cluster.', + 'title' => '', + 'required' => false, + 'example' => 'dds-example', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The returned data.', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.', + 'type' => 'string', + 'title' => '', + 'example' => '44B8C2F5-919D-5D29-BCD5-DEB03467****', + ], + 'ErrCode' => [ + 'description' => 'The error code.', + 'type' => 'string', + 'title' => '', + 'example' => 'DBS.ParamIsInValid', + ], + 'Success' => [ + 'description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'- **true**: The request was successful.'."\n" + ."\n" + .'- **false**: The request failed.', + 'type' => 'string', + 'title' => '', + 'example' => 'true', + ], + 'ErrMessage' => [ + 'description' => 'The error message.', + 'type' => 'string', + 'title' => '', + 'example' => 'Argument: regionCode Must not be empty', + ], + 'Code' => [ + 'description' => 'The error code.', + 'type' => 'string', + 'title' => '', + 'example' => 'DBS.ParamIsInValid', + ], + 'Message' => [ + 'description' => 'The error message.', + 'type' => 'string', + 'title' => '', + 'example' => 'Argument: regionCode Must not be empty', + ], + 'Data' => [ + 'description' => 'The returned data.', + 'type' => 'object', + 'properties' => [ + 'PublicUrl' => [ + 'description' => 'The public URL to download the backup set.', + 'type' => 'string', + 'title' => '', + 'example' => 'http://dbs-137383785969****-cn-hangzhou-1iv12nblw****.oss-cn-hangzhou.aliyuncs.com/dt-u7u4bufa****/dbs_target_file_path/test_456', + ], + 'PrivateUrl' => [ + 'description' => 'The private URL to download the backup set.', + 'type' => 'string', + 'title' => '', + 'example' => 'http://dbs-137383785969****-cn-hangzhou-1iv12nblw****.oss-cn-hangzhou-internal.aliyuncs.com/dt-u7u4bufa****/dbs_target_file_path/test_123', + ], + 'ExpirationTime' => [ + 'description' => 'The validity period of the link.'."\n" + ."\n" + .'> The value is a UNIX timestamp.', + 'type' => 'integer', + 'format' => 'int64', + 'title' => '', + 'example' => '1661329050', + ], + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'Request.Forbidden', + 'errorMessage' => 'Have no Permissions', + 'description' => '', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"44B8C2F5-919D-5D29-BCD5-DEB03467****\\",\\n \\"ErrCode\\": \\"DBS.ParamIsInValid\\",\\n \\"Success\\": \\"true\\",\\n \\"ErrMessage\\": \\"Argument: regionCode Must not be empty\\",\\n \\"Code\\": \\"DBS.ParamIsInValid\\",\\n \\"Message\\": \\"Argument: regionCode Must not be empty\\",\\n \\"Data\\": {\\n \\"PublicUrl\\": \\"http://dbs-137383785969****-cn-hangzhou-1iv12nblw****.oss-cn-hangzhou.aliyuncs.com/dt-u7u4bufa****/dbs_target_file_path/test_456\\",\\n \\"PrivateUrl\\": \\"http://dbs-137383785969****-cn-hangzhou-1iv12nblw****.oss-cn-hangzhou-internal.aliyuncs.com/dt-u7u4bufa****/dbs_target_file_path/test_123\\",\\n \\"ExpirationTime\\": 1661329050\\n }\\n}","type":"json"}]', + 'title' => 'DescribeDownloadBackupSetStorageInfo', + 'description' => '### Applicable engines'."\n" + ."\n" + .'- RDS MySQL (cloud disk edition)'."\n" + ."\n" + .'- RDS PostgreSQL'."\n" + ."\n" + .'- PolarDB for MySQL'."\n" + ."\n" + .'- MongoDB'."\n" + ."\n" + .'### Related documents'."\n" + ."\n" + .'- [Download an RDS MySQL backup](~~98819~~)'."\n" + ."\n" + .'- [Download an RDS PostgreSQL backup](~~96774~~)'."\n" + ."\n" + .'- [Download a PolarDB for MySQL backup](~~2627635~~)'."\n" + ."\n" + .'- [Download a MongoDB backup](~~55011~~)', + 'changeSet' => [ + [ + 'createdAt' => '2022-08-25T07:43:22.000Z', + 'description' => 'Request parameters changed', + ], + [ + 'createdAt' => '2022-08-03T09:23:52.000Z', + 'description' => 'OpenAPI offline', + ], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dbs:DescribeDownloadBackupSetStorageInfo', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DBS', + 'resourceType' => 'BackupPlan', + 'arn' => 'acs:dbs:{#regionId}:{#accountId}:backupplan/{#BackupPlanId}', + ], + ], + ], + ], + ], + ], + 'DescribeDownloadSupport' => [ + 'summary' => 'Queries whether the current instance supports the Advanced Download feature.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREcbs04Q4EK', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionCode', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID of the instance. You can call the [DescribeDBInstanceAttribute](~~26231~~) operation to query the region ID.', + 'type' => 'string', + 'required' => true, + 'title' => '', + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'InstanceName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The instance ID.', + 'type' => 'string', + 'required' => true, + 'title' => '', + 'example' => 'rm-bp1a48p922r4b****', + ], + ], + [ + 'name' => 'ClusterName', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'description' => 'The name of the sharded cluster. This parameter is required only for MongoDB sharded cluster instances.', + 'title' => '', + 'required' => false, + 'example' => 'dds-example', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The response.', + 'type' => 'object', + 'properties' => [ + 'Data' => [ + 'description' => 'Indicates whether the Advanced Download feature is supported. Valid values:'."\n" + ."\n" + .'- **true**: The feature is supported.'."\n" + ."\n" + .'- **false**: The feature is not supported.', + 'type' => 'string', + 'title' => '', + 'example' => 'true', + ], + 'RequestId' => [ + 'description' => 'The request ID.', + 'type' => 'string', + 'title' => '', + 'example' => 'F1A186F7-7B34-5C11-A903-EE23876B****', + ], + 'ErrCode' => [ + 'description' => 'The error code returned if the call fails.', + 'type' => 'string', + 'title' => '', + 'example' => 'DBS.ParamIsInValid', + ], + 'Success' => [ + 'description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'- **true**: The request was successful.'."\n" + ."\n" + .'- **false**: The request failed.', + 'type' => 'string', + 'title' => '', + 'example' => 'true', + ], + 'ErrMessage' => [ + 'description' => 'The error message returned if the call fails.', + 'type' => 'string', + 'title' => '', + 'example' => 'Argument: regionCode Must not be empty', + ], + 'Code' => [ + 'description' => 'The error code.', + 'type' => 'string', + 'title' => '', + 'example' => 'DBS.ParamIsInValid', + ], + 'Message' => [ + 'description' => 'The error message.', + 'type' => 'string', + 'title' => '', + 'example' => 'Argument: regionCode Must not be empty', + ], + ], + 'title' => '', + 'example' => '', + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'Request.Forbidden', + 'errorMessage' => 'Have no Permissions', + 'description' => '', + ], + ], + ], + 'staticInfo' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": \\"true\\",\\n \\"RequestId\\": \\"F1A186F7-7B34-5C11-A903-EE23876B****\\",\\n \\"ErrCode\\": \\"DBS.ParamIsInValid\\",\\n \\"Success\\": \\"true\\",\\n \\"ErrMessage\\": \\"Argument: regionCode Must not be empty\\",\\n \\"Code\\": \\"DBS.ParamIsInValid\\",\\n \\"Message\\": \\"Argument: regionCode Must not be empty\\"\\n}","type":"json"}]', + 'title' => 'DescribeDownloadSupport', + 'description' => '### Applicable engines'."\n" + ."\n" + .'- RDS MySQL (with cloud disks)'."\n" + ."\n" + .'- RDS PostgreSQL'."\n" + ."\n" + .'- PolarDB for MySQL'."\n" + ."\n" + .'- MongoDB'."\n" + ."\n" + .'### Related documents'."\n" + ."\n" + .'You can create an Advanced Download task for a point in time or a specific backup set. You can specify a URL as the download destination or write the data directly to your Object Storage Service (OSS) bucket for data analytics and offline archiving.'."\n" + ."\n" + .'- [Download an RDS MySQL backup](~~98819~~)'."\n" + ."\n" + .'- [Download an RDS PostgreSQL backup](~~96774~~)'."\n" + ."\n" + .'- [Download a PolarDB for MySQL backup](~~2627635~~)'."\n" + ."\n" + .'- [Download a MongoDB backup](~~55011~~)', + 'changeSet' => [ + [ + 'createdAt' => '2022-08-25T07:43:22.000Z', + 'description' => 'Request parameters changed', + ], + [ + 'createdAt' => '2022-08-03T09:23:52.000Z', + 'description' => 'OpenAPI offline', + ], + ], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '400', + 'countWindow' => 60, + 'regionId' => '*', + 'api' => 'DescribeDownloadSupport', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dbs:DescribeDownloadSupport', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DBS', + 'resourceType' => 'BackupPlan', + 'arn' => 'acs:dbs:{#regionId}:{#accountId}:backupplan/{#BackupPlanId}', + ], + ], + ], + ], + ], + ], + 'DescribeDownloadTask' => [ + 'summary' => 'Queries a list of advanced download tasks for RDS for MySQL, RDS for PostgreSQL, and PolarDB for MySQL instances.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREcbs04Q4EK', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionCode', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the region where the instance resides. To obtain the region ID, call [DescribeDBInstanceAttribute](~~26231~~).', + 'type' => 'string', + 'required' => true, + 'title' => '', + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'InstanceName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The instance ID.'."\n" + ."\n" + .'> This parameter is required.', + 'type' => 'string', + 'required' => false, + 'title' => '', + 'example' => 'rm-bp1imnmcjxdz7****', + ], + ], + [ + 'name' => 'DatasourceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the data source in DBS. The format is: *ds-${Instance ID}\\_${Region ID}*.', + 'type' => 'string', + 'required' => false, + 'title' => '', + 'example' => 'ds-rm-2ze8g2am97624****_cn-hangzhou', + ], + ], + [ + 'name' => 'BackupSetId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the backup set. To obtain the backup set ID, call [DescribeBackups](~~26273~~).', + 'type' => 'string', + 'required' => false, + 'title' => '', + 'example' => '216****', + ], + ], + [ + 'name' => 'State', + 'in' => 'query', + 'schema' => [ + 'description' => 'The state of the download task. Valid values:'."\n" + ."\n" + .'- **initializing**: The task is being initialized.'."\n" + ."\n" + .'- **queueing**: The task is in a queue.'."\n" + ."\n" + .'- **running**: The task is running.'."\n" + ."\n" + .'- **failed**: The task failed.'."\n" + ."\n" + .'- **finished**: The task is successful.'."\n" + ."\n" + .'- **expired**: The download has expired.', + 'type' => 'string', + 'required' => false, + 'title' => '', + 'example' => 'queueing', + ], + ], + [ + 'name' => 'TaskType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of the download task. Valid values:'."\n" + ."\n" + .'- **full**: full backup set download.'."\n" + ."\n" + .'- **pitr**: point-in-time recovery download.', + 'type' => 'string', + 'required' => false, + 'title' => '', + 'example' => 'full', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'The start of the time range to query tasks based on their creation time. This is a UNIX timestamp in milliseconds (ms).', + 'type' => 'string', + 'required' => false, + 'title' => '', + 'example' => '1661941554000', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'The end of the time range to query tasks based on their creation time. This is a UNIX timestamp in milliseconds (ms).', + 'type' => 'string', + 'required' => false, + 'title' => '', + 'example' => '1661941556000', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of entries to return on each page.', + 'type' => 'string', + 'required' => false, + 'title' => '', + 'example' => '50', + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => 'The page number.', + 'type' => 'string', + 'required' => false, + 'title' => '', + 'example' => '1', + ], + ], + [ + 'name' => 'OrderDirect', + 'in' => 'query', + 'schema' => [ + 'description' => 'The sorting direction. Valid values:'."\n" + ."\n" + .'- **asc**: ascending order.'."\n" + ."\n" + .'- **desc**: descending order. This is the default value.', + 'type' => 'string', + 'required' => false, + 'title' => '', + 'example' => 'desc', + ], + ], + [ + 'name' => 'OrderColumn', + 'in' => 'query', + 'schema' => [ + 'description' => 'The field used for sorting. The default value is **gmt\\_create**, which indicates the creation time.', + 'type' => 'string', + 'required' => false, + 'title' => '', + 'example' => 'gmt_create', + ], + ], + [ + 'name' => 'ClusterName', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'description' => 'The name of the sharded cluster. This parameter is required only for MongoDB instances.', + 'title' => '', + 'required' => false, + 'example' => 'dds-example', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The returned parameters.', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.', + 'type' => 'string', + 'title' => '', + 'example' => '5D285EB9-A443-592D-9F3D-A888FAC3****', + ], + 'ErrCode' => [ + 'description' => 'The error code.', + 'type' => 'string', + 'title' => '', + 'example' => 'DBS.InternalError', + ], + 'Success' => [ + 'description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'- **true**: The request was successful.'."\n" + ."\n" + .'- **false**: The request failed.', + 'type' => 'string', + 'title' => '', + 'example' => 'true', + ], + 'ErrMessage' => [ + 'description' => 'The error message.', + 'type' => 'string', + 'title' => '', + 'example' => 'instanceName can not be empty', + ], + 'Code' => [ + 'description' => 'The error code.', + 'type' => 'string', + 'title' => '', + 'example' => 'DBS.InternalError', + ], + 'Message' => [ + 'description' => 'The error message.', + 'type' => 'string', + 'title' => '', + 'example' => 'instanceName can not be empty', + ], + 'Data' => [ + 'description' => 'The task details.', + 'type' => 'object', + 'properties' => [ + 'PageNumber' => [ + 'description' => 'The page number. It must be greater than 0 and not exceed the maximum value of the integer data type. Default value: 1.', + 'type' => 'integer', + 'format' => 'int64', + 'title' => '', + 'example' => '1', + ], + 'TotalPages' => [ + 'description' => 'The total number of pages.', + 'type' => 'integer', + 'format' => 'int64', + 'title' => '', + 'example' => '2', + ], + 'Extra' => [ + 'description' => 'Additional information about the task that is used to back up data to the cloud.', + 'type' => 'string', + 'title' => '', + 'example' => 'dbtest', + ], + 'TotalElements' => [ + 'description' => 'The total number of download tasks.', + 'type' => 'integer', + 'format' => 'int64', + 'title' => '', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => 'The number of entries returned per page.', + 'type' => 'integer', + 'format' => 'int64', + 'title' => '', + 'example' => '10', + ], + 'Content' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'List' => [ + 'description' => 'The task details.', + 'type' => 'array', + 'items' => [ + 'description' => 'The task details.', + 'type' => 'object', + 'properties' => [ + 'TaskId' => [ + 'description' => 'The download task ID.', + 'type' => 'string', + 'title' => '', + 'example' => 'dt-qxntlvgu****', + ], + 'RegionCode' => [ + 'description' => 'The region ID.', + 'type' => 'string', + 'title' => '', + 'example' => 'cn-hangzhou', + ], + 'Format' => [ + 'description' => 'The destination format to which the downloaded data is converted. Valid values:'."\n" + ."\n" + .'- **csv**'."\n" + ."\n" + .'- **SQL**'."\n" + ."\n" + .'- **Parquet**', + 'type' => 'string', + 'title' => '', + 'example' => 'csv', + ], + 'DbList' => [ + 'description' => 'The list of databases.', + 'type' => 'string', + 'title' => '', + 'example' => '[dbtest]', + ], + 'BakSetId' => [ + 'description' => 'The ID of the full backup set.', + 'type' => 'string', + 'title' => '', + 'example' => '148261****', + ], + 'DownloadStatus' => [ + 'description' => 'The state of the download task. Valid values:'."\n" + ."\n" + .'- **initializing**: The task is being initialized.'."\n" + ."\n" + .'- **queueing**: The task is in a queue.'."\n" + ."\n" + .'- **running**: The task is running.'."\n" + ."\n" + .'- **failed**: The task failed.'."\n" + ."\n" + .'- **finished**: The task is successful.'."\n" + ."\n" + .'- **expired**: The download has expired.', + 'type' => 'string', + 'title' => '', + 'example' => 'queueing', + ], + 'ExportDataSize' => [ + 'description' => 'The volume of exported data, in bytes.', + 'type' => 'string', + 'title' => '', + 'example' => '0', + ], + 'ImportDataSize' => [ + 'description' => 'The volume of processed data, in bytes.', + 'type' => 'string', + 'title' => '', + 'example' => '0', + ], + 'BackupSetTime' => [ + 'description' => 'The point in time of the point-in-time download task. This is a UNIX timestamp in milliseconds (ms).', + 'type' => 'string', + 'title' => '', + 'example' => '1663162216000', + ], + 'TargetType' => [ + 'description' => 'The type of the download destination. Valid values:'."\n" + ."\n" + .'- **OSS**'."\n" + ."\n" + .'- **URL**', + 'type' => 'string', + 'title' => '', + 'example' => 'URL', + ], + 'TargetPath' => [ + 'description' => 'The destination path of the downloaded data. This parameter is returned when TargetType is set to **OSS**.', + 'type' => 'string', + 'title' => '', + 'example' => 'test_db/path', + ], + 'Progress' => [ + 'description' => 'The number of exported tables/The total number of tables to be exported.', + 'type' => 'string', + 'title' => '', + 'example' => '0/0', + ], + 'GmtCreate' => [ + 'description' => 'The time when the task was created. This is a UNIX timestamp in milliseconds.', + 'type' => 'string', + 'title' => '', + 'example' => '1663321957000', + ], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'Request.Forbidden', + 'errorMessage' => 'Have no Permissions', + 'description' => '', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5D285EB9-A443-592D-9F3D-A888FAC3****\\",\\n \\"ErrCode\\": \\"DBS.InternalError\\",\\n \\"Success\\": \\"true\\",\\n \\"ErrMessage\\": \\"instanceName can not be empty\\",\\n \\"Code\\": \\"DBS.InternalError\\",\\n \\"Message\\": \\"instanceName can not be empty\\",\\n \\"Data\\": {\\n \\"PageNumber\\": 1,\\n \\"TotalPages\\": 2,\\n \\"Extra\\": \\"dbtest\\",\\n \\"TotalElements\\": 1,\\n \\"PageSize\\": 10,\\n \\"Content\\": {\\n \\"List\\": [\\n {\\n \\"TaskId\\": \\"dt-qxntlvgu****\\",\\n \\"RegionCode\\": \\"cn-hangzhou\\",\\n \\"Format\\": \\"csv\\",\\n \\"DbList\\": \\"[dbtest]\\",\\n \\"BakSetId\\": \\"148261****\\",\\n \\"DownloadStatus\\": \\"queueing\\",\\n \\"ExportDataSize\\": \\"0\\",\\n \\"ImportDataSize\\": \\"0\\",\\n \\"BackupSetTime\\": \\"1663162216000\\",\\n \\"TargetType\\": \\"URL\\",\\n \\"TargetPath\\": \\"test_db/path\\",\\n \\"Progress\\": \\"0/0\\",\\n \\"GmtCreate\\": \\"1663321957000\\"\\n }\\n ]\\n }\\n }\\n}","type":"json"}]', + 'title' => 'DescribeDownloadTask', + 'description' => '### Applicable engines'."\n" + ."\n" + .'- ApsaraDB RDS for MySQL instances that use cloud disks'."\n" + ."\n" + .'- ApsaraDB RDS for PostgreSQL'."\n" + ."\n" + .'- PolarDB for MySQL'."\n" + ."\n" + .'- MongoDB'."\n" + ."\n" + .'### Related documents'."\n" + ."\n" + .'- [Download the backup of an ApsaraDB RDS for MySQL instance](~~98819~~)'."\n" + ."\n" + .'- [Download the backup of an ApsaraDB RDS for PostgreSQL instance](~~96774~~)'."\n" + ."\n" + .'- [Download the backup of a PolarDB for MySQL instance](~~2627635~~)'."\n" + ."\n" + .'- [Download the backup of a MongoDB instance](~~55011~~)', + 'changeSet' => [ + [ + 'createdAt' => '2022-11-16T11:43:03.000Z', + 'description' => 'Response parameters changed', + ], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dbs:DescribeDownloadTask', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DBS', + 'resourceType' => 'DBInstance', + 'arn' => 'acs:rds:{#regionId}:{#accountId}:dbinstance/{#DbInstanceId}', + ], + ], + ], + ], + ], + ], + 'DescribeSandboxBackupSets' => [ + 'summary' => 'Queries sandbox backup sets.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'BackupPlanId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the backup plan.'."\n" + ."\n" + .'> If your instance is an RDS for MySQL instance, automatically add the RDS instance to DBS to obtain the backup plan ID. For more information, see [Automatically add a data source](~~193091~~).', + 'type' => 'string', + 'required' => true, + 'example' => '1hxxxx8xxxxxa', + 'title' => '', + ], + ], + [ + 'name' => 'BackupSetId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the backup set. If you specify this parameter, the operation returns information about the snapshots of only this backup set. If you do not specify this parameter, the operation returns information about the snapshots of all backup sets that are created for the backup plan.', + 'type' => 'string', + 'required' => false, + 'example' => '1xxxx2xxxxx1e', + 'title' => '', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of entries per page. Valid values:'."\n" + ."\n" + .'- 30 (default)'."\n" + ."\n" + .'- 50'."\n" + ."\n" + .'- 100', + 'type' => 'string', + 'required' => false, + 'example' => '30', + 'title' => '', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => 'The page number. The value must be greater than 0 and cannot exceed the maximum value of the integer data type. Default value: 1.', + 'type' => 'string', + 'required' => false, + 'example' => '1', + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Data' => [ + 'description' => 'The data returned. The value of this parameter is a JSON string. The JSON string contains the following fields:'."\n" + ."\n" + .'- **backupSetTime**: The point in time of the snapshot. The time is in the yyyy-MM-ddTHH:mm:ssZ format and is displayed in Coordinated Universal Time (UTC).'."\n" + ."\n" + .'- **backupSetId**: The ID of the backup set.'."\n" + ."\n" + .'- **backupSetType**: The type of the snapshot. Valid values: **Full** (full backup) and **Inc** (incremental backup).'."\n" + ."\n" + .'- **backupPlanId**: The ID of the backup plan.', + 'type' => 'string', + 'example' => ' "Data": { "number": 2, "size": 2, "content": [ { "backupSetTime": "2021-08-28T23:12:31Z", "backupSetId": "Inc_1hxxxx8xxxxxa_20210801064200_mysql-bin.000134", "backupSetType": "Inc", "backupPlanId": "1hxxxx8xxxxxa" }, { "backupSetTime": "2021-08-28T22:42:28Z", "backupSetId": "1hxxxx8xxxxxa_20210829064228", "backupSetType": "FULL", "backupPlanId": "1hxxxx8xxxxxa" } ], "totalElements": 2 },', + 'title' => '', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.', + 'type' => 'string', + 'example' => '4F1888AC-1138-4995-B9FE-D2734F61C058', + 'title' => '', + ], + 'ErrCode' => [ + 'description' => 'The error code.', + 'type' => 'string', + 'example' => 'Param.NotFound', + 'title' => '', + ], + 'Success' => [ + 'description' => 'Indicates whether the request was successful.', + 'type' => 'string', + 'example' => 'true', + 'title' => '', + ], + 'ErrMessage' => [ + 'description' => 'The error message.', + 'type' => 'string', + 'example' => 'The specified parameter %s value is not valid.', + 'title' => '', + ], + 'Code' => [ + 'description' => 'The error code.', + 'type' => 'string', + 'example' => 'Param.NotFound', + 'title' => '', + ], + 'Message' => [ + 'description' => 'The error message.', + 'type' => 'string', + 'example' => 'The specified parameter %s value is not valid.', + 'title' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'Request.Forbidden', + 'errorMessage' => 'Have no Permissions', + 'description' => '', + ], + ], + ], + 'title' => 'DescribeSandboxBackupSets', + 'description' => 'You must enable the sandbox feature for the database instance before you perform this operation. For more information, see [Emergency recovery for an RDS for MySQL instance](~~203154~~) or [Emergency recovery for a self-managed MySQL database (sandbox instance)](~~185577~~). This operation is supported only in DBS API version 2021-01-01.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dbs:DescribeSandboxBackupSets', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DBS', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": \\" \\\\\\"Data\\\\\\": { \\\\\\"number\\\\\\": 2, \\\\\\"size\\\\\\": 2, \\\\\\"content\\\\\\": [ { \\\\\\"backupSetTime\\\\\\": \\\\\\"2021-08-28T23:12:31Z\\\\\\", \\\\\\"backupSetId\\\\\\": \\\\\\"Inc_1hxxxx8xxxxxa_20210801064200_mysql-bin.000134\\\\\\", \\\\\\"backupSetType\\\\\\": \\\\\\"Inc\\\\\\", \\\\\\"backupPlanId\\\\\\": \\\\\\"1hxxxx8xxxxxa\\\\\\" }, { \\\\\\"backupSetTime\\\\\\": \\\\\\"2021-08-28T22:42:28Z\\\\\\", \\\\\\"backupSetId\\\\\\": \\\\\\"1hxxxx8xxxxxa_20210829064228\\\\\\", \\\\\\"backupSetType\\\\\\": \\\\\\"FULL\\\\\\", \\\\\\"backupPlanId\\\\\\": \\\\\\"1hxxxx8xxxxxa\\\\\\" } ], \\\\\\"totalElements\\\\\\": 2 },\\",\\n \\"RequestId\\": \\"4F1888AC-1138-4995-B9FE-D2734F61C058\\",\\n \\"ErrCode\\": \\"Param.NotFound\\",\\n \\"Success\\": \\"true\\",\\n \\"ErrMessage\\": \\"The specified parameter %s value is not valid.\\",\\n \\"Code\\": \\"Param.NotFound\\",\\n \\"Message\\": \\"The specified parameter %s value is not valid.\\"\\n}","type":"json"}]', + ], + 'DescribeSandboxInstances' => [ + 'summary' => 'Queries sandbox instances that are created within an account.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'BackupPlanId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the backup schedule. You can call the [DescribeBackupPlanList](~~437215~~) operation to obtain the ID of the backup schedule.'."\n" + ."\n" + .'> If your instance is an ApsaraDB RDS for MySQL instance, you can [configure automatic access to a data source](~~193091~~) to automatically add the instance to DBS and obtain the ID of the backup schedule.', + 'type' => 'string', + 'required' => true, + 'example' => '1hxxxx8xxxxxa', + 'title' => '', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the sandbox instance. You can call the [CreateSandboxInstance](~~437252~~) operation to obtain the ID of the sandbox instance.', + 'type' => 'string', + 'required' => false, + 'example' => '1jxxxxnxxx1xc', + 'title' => '', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of entries to return on each page. Valid values:'."\n" + ."\n" + .'- 30\\. This is the default value.'."\n" + ."\n" + .'- 50'."\n" + ."\n" + .'- 100', + 'type' => 'string', + 'required' => false, + 'example' => '30', + 'title' => '', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of the page to return. The value must be an integer that is greater than 0. Default value: 1.', + 'type' => 'string', + 'required' => false, + 'example' => '1', + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Data' => [ + 'description' => 'The response parameters.'."\n" + ."\n" + .'- **connectionString**: the connection string of the sandbox instance, in the format of IP address:Port number. This parameter indicates the endpoint of the sandbox instance if the value of the SandboxType parameter is **Sandbox**. This parameter indicates the Network File System (NFS) mount address if the value of the SandboxType parameter is **NFS**.'."\n" + ."\n" + .'- **restoreSeconds**: the time required to create the sandbox instance. Unit: seconds.'."\n" + ."\n" + .'- **restoreTime**: the point in time to which the sandbox instance is restored. The time follows the ISO 8601 standard in the yyyy-MM-ddThh:mm:ssZ format. The time is displayed in UTC.'."\n" + ."\n" + .'- **instanceId**: the ID of the sandbox instance.'."\n" + ."\n" + .'- **backupSetId**: the ID of the backup set.'."\n" + ."\n" + .'- **createTime**: the point in time when the sandbox instance was created. The time follows the ISO 8601 standard in the yyyy-MM-ddThh:mm:ssZ format. The time is displayed in UTC.'."\n" + ."\n" + .'- **backupPlanId**: the ID of the backup schedule.'."\n" + ."\n" + .'- **vpcId**: the ID of the virtual private cloud (VPC).'."\n" + ."\n" + .'- **vpcSwitchId**: the ID of the VSwitch.'."\n" + ."\n" + .'- **sandboxSpecification**: the specifications of the sandbox instance.'."\n" + ."\n" + .'- **status**: the status of the sandbox instance. Valid values: **running**, **check\\_pass**, and **stop**.', + 'type' => 'string', + 'example' => ' { "number": 1, "size": 1, "content": [ { "connectionString": "172.26.178.229:3306", "restoreSeconds": 15, "restoreTime": "2021-08-11T07:26:24Z", "instanceId": "1jxxxxx9xxxms", "backupSetId": "1hxxxx8xxxxxa_20210811152624", "createTime": "2021-08-12T07:40:29Z", "backupPlanId": "1hxxxx8xxxxxa", "vpcId": "vpc-bp1dxxxxxjy0xxxxx1xxp", "sandboxSpecification": "MYSQL_1C_1M_SD", "status": "running", "vpcSwitchId": "vsw-bp1bxxxxxumxxxxxwxx2w" } ], "totalElements": 1 }', + 'title' => '', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.', + 'type' => 'string', + 'example' => '4F1888AC-1138-4995-B9FE-D2734F61C058', + 'title' => '', + ], + 'ErrCode' => [ + 'description' => 'The error code returned if the request fails.', + 'type' => 'string', + 'example' => 'Param.NotFound', + 'title' => '', + ], + 'Success' => [ + 'description' => 'Indicates whether the request was successful.', + 'type' => 'string', + 'example' => 'true', + 'title' => '', + ], + 'ErrMessage' => [ + 'description' => 'The error message returned if the request fails.', + 'type' => 'string', + 'example' => 'The specified parameter %s value is not valid.', + 'title' => '', + ], + 'Code' => [ + 'description' => 'The error code returned if the request fails.', + 'type' => 'string', + 'example' => 'Param.NotFound', + 'title' => '', + ], + 'Message' => [ + 'description' => 'The error message returned if the request fails.', + 'type' => 'string', + 'example' => 'The specified parameter %s value is not valid.', + 'title' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'Request.Forbidden', + 'errorMessage' => 'Have no Permissions', + 'description' => '', + ], + ], + ], + 'title' => 'DescribeSandboxInstances', + 'description' => 'This operation is available only in Database Backup (DBS) API of the 2021-01-01 version.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => '|Error code|Error message|Description|'."\n" + .'|---|---|---|'."\n" + .'|DBS.NotExisted|no valid job exist with id|The error message returned because no backup schedule exists for the instance specified by the InstanceId parameter.|', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dbs:DescribeSandboxInstances', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DBS', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": \\" { \\\\\\"number\\\\\\": 1, \\\\\\"size\\\\\\": 1, \\\\\\"content\\\\\\": [ { \\\\\\"connectionString\\\\\\": \\\\\\"172.26.178.229:3306\\\\\\", \\\\\\"restoreSeconds\\\\\\": 15, \\\\\\"restoreTime\\\\\\": \\\\\\"2021-08-11T07:26:24Z\\\\\\", \\\\\\"instanceId\\\\\\": \\\\\\"1jxxxxx9xxxms\\\\\\", \\\\\\"backupSetId\\\\\\": \\\\\\"1hxxxx8xxxxxa_20210811152624\\\\\\", \\\\\\"createTime\\\\\\": \\\\\\"2021-08-12T07:40:29Z\\\\\\", \\\\\\"backupPlanId\\\\\\": \\\\\\"1hxxxx8xxxxxa\\\\\\", \\\\\\"vpcId\\\\\\": \\\\\\"vpc-bp1dxxxxxjy0xxxxx1xxp\\\\\\", \\\\\\"sandboxSpecification\\\\\\": \\\\\\"MYSQL_1C_1M_SD\\\\\\", \\\\\\"status\\\\\\": \\\\\\"running\\\\\\", \\\\\\"vpcSwitchId\\\\\\": \\\\\\"vsw-bp1bxxxxxumxxxxxwxx2w\\\\\\" } ], \\\\\\"totalElements\\\\\\": 1 }\\",\\n \\"RequestId\\": \\"4F1888AC-1138-4995-B9FE-D2734F61C058\\",\\n \\"ErrCode\\": \\"Param.NotFound\\",\\n \\"Success\\": \\"true\\",\\n \\"ErrMessage\\": \\"The specified parameter %s value is not valid.\\",\\n \\"Code\\": \\"Param.NotFound\\",\\n \\"Message\\": \\"The specified parameter %s value is not valid.\\"\\n}","type":"json"}]', + ], + 'DescribeSandboxRecoveryTime' => [ + 'summary' => 'Queries the recoverable time range of a sandbox instance.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'BackupPlanId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the backup schedule. You can call the [DescribeBackupPlanList](~~437215~~) operation to obtain the ID of the backup schedule. If you set this parameter to the backup schedule ID obtained by calling the DescribeBackupPlanList operation, the dbs prefix must be removed. Otherwise, the call fails.'."\n" + ."\n" + .'> If your instance is an ApsaraDB RDS for MySQL instance, you can [configure automatic access to a data source](~~193091~~) to automatically add the instance to DBS and obtain the ID of the backup schedule.', + 'type' => 'string', + 'required' => true, + 'example' => '1jyjal15l****', + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.', + 'type' => 'string', + 'example' => '4F1888AC-1138-4995-B9FE-D2734F61C058', + 'title' => '', + ], + 'ErrCode' => [ + 'description' => 'The error code returned if the request fails.', + 'type' => 'string', + 'example' => 'Param.NotFound', + 'title' => '', + ], + 'Success' => [ + 'description' => 'Indicates whether the request was successful.', + 'type' => 'string', + 'example' => 'true', + 'title' => '', + ], + 'ErrMessage' => [ + 'description' => 'The error message returned if the request fails.', + 'type' => 'string', + 'example' => 'The specified parameter %s value is not valid.', + 'title' => '', + ], + 'Code' => [ + 'description' => 'The error code returned if the request fails.', + 'type' => 'string', + 'example' => 'Param.NotFound', + 'title' => '', + ], + 'Message' => [ + 'description' => 'The error message returned if the request fails.', + 'type' => 'string', + 'example' => 'The specified parameter %s value is not valid.', + 'title' => '', + ], + 'Data' => [ + 'description' => 'The response parameters.', + 'type' => 'object', + 'properties' => [ + 'RecoveryEndTime' => [ + 'description' => 'The end of the time range during which the sandbox instance can be restored. The time follows the ISO 8601 standard in the yyyy-MM-ddThh:mm:ssZ format. The time is displayed in UTC.', + 'type' => 'string', + 'example' => '2021-08-02T12:01:01Z', + 'title' => '', + ], + 'BackupPlanId' => [ + 'description' => 'The backup schedule of the sandbox instance.', + 'type' => 'string', + 'example' => '1hxxxx8xxxxxa', + 'title' => '', + ], + 'RecoveryBeginTime' => [ + 'description' => 'The beginning of the time range during which the sandbox instance can be restored. The time follows the ISO 8601 standard in the yyyy-MM-ddThh:mm:ssZ format. The time is displayed in UTC.', + 'type' => 'string', + 'example' => '2021-08-01T12:01:01Z', + 'title' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'Request.Forbidden', + 'errorMessage' => 'Have no Permissions', + 'description' => '', + ], + ], + ], + 'title' => 'DescribeSandboxRecoveryTime', + 'description' => 'Before you call this operation, you must enable the sandbox feature for the database instance. For more information, see [Use the emergency recovery feature of an ApsaraDB RDS for MySQL instance](~~203154~~) or [Create a sandbox instance for emergency disaster recovery of a self-managed MySQL database](~~185577~~). This operation is available only in Database Backup (DBS) API of the 2021-01-01 version.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dbs:DescribeSandboxRecoveryTime', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DBS', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4F1888AC-1138-4995-B9FE-D2734F61C058\\",\\n \\"ErrCode\\": \\"Param.NotFound\\",\\n \\"Success\\": \\"true\\",\\n \\"ErrMessage\\": \\"The specified parameter %s value is not valid.\\",\\n \\"Code\\": \\"Param.NotFound\\",\\n \\"Message\\": \\"The specified parameter %s value is not valid.\\",\\n \\"Data\\": {\\n \\"RecoveryEndTime\\": \\"2021-08-02T12:01:01Z\\",\\n \\"BackupPlanId\\": \\"1hxxxx8xxxxxa\\",\\n \\"RecoveryBeginTime\\": \\"2021-08-01T12:01:01Z\\"\\n }\\n}","type":"json"}]', + ], + 'ModifyBackupPolicy' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '221284', + 'abilityTreeNodes' => [ + 'FEATUREcbsYWT1H7', + 'FEATUREcbsPNQ3FN', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionCode', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region where the backup set is located.', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + 'title' => '', + ], + ], + [ + 'name' => 'PreferredBackupWindowBegin', + 'in' => 'query', + 'schema' => [ + 'description' => 'The start time of the backup window.', + 'type' => 'string', + 'required' => false, + 'example' => '17:00Z', + 'title' => '', + ], + ], + [ + 'name' => 'InstanceName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the PolarDB instance.', + 'type' => 'string', + 'required' => false, + 'example' => 'pc-2ze3nrr64c5****', + 'title' => '', + ], + ], + [ + 'name' => 'Category', + 'in' => 'query', + 'schema' => [ + 'description' => 'The backup type.'."\n" + ."\n" + .'- **Flash**: second-level backup'."\n" + ."\n" + .'- **Standard**: standard backup', + 'type' => 'string', + 'required' => false, + 'example' => 'Flash', + 'title' => '', + ], + ], + [ + 'name' => 'AdvanceLogPolicies', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'type' => 'array', + 'items' => [ + 'title' => '', + 'type' => 'object', + 'properties' => [ + 'LogRetentionType' => [ + 'type' => 'string', + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'DestType' => [ + 'type' => 'string', + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'FilterType' => [ + 'type' => 'string', + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'ActionType' => [ + 'type' => 'string', + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'SrcRegion' => [ + 'type' => 'string', + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'EnableLogBackup' => [ + 'type' => 'integer', + 'format' => 'int64', + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'SrcType' => [ + 'type' => 'string', + 'required' => false, + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'LogRetentionValue' => [ + 'type' => 'string', + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'PolicyId' => [ + 'type' => 'string', + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'FilterKey' => [ + 'type' => 'string', + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'DestRegion' => [ + 'type' => 'string', + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'FilterValue' => [ + 'type' => 'string', + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'example' => '', + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + [ + 'name' => 'AdvanceDataPolicies', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => 'The details of the data backup policy.', + 'type' => 'array', + 'items' => [ + 'title' => '', + 'description' => 'The details of the policy.', + 'type' => 'object', + 'properties' => [ + 'DestType' => [ + 'description' => 'The destination type of the backup policy. Valid values:'."\n" + ."\n" + .'- **db**: database'."\n" + ."\n" + .'- **level1**: level-1 backup'."\n" + ."\n" + .'- **level2**: level-2 backup'."\n" + ."\n" + .'- **level2Cross**: level-2 cross-region backup', + 'type' => 'string', + 'title' => '', + 'required' => false, + 'example' => 'level1', + ], + 'FilterType' => [ + 'description' => 'The filter type for the advanced policy. Valid values:'."\n" + ."\n" + .'- **crontab**: recurring schedule'."\n" + ."\n" + .'- **event**: event-based schedule', + 'type' => 'string', + 'title' => '', + 'required' => false, + 'example' => 'crontab', + ], + 'ActionType' => [ + 'description' => 'The operation type. Valid values:'."\n" + ."\n" + .'- **CREATE**: adds a policy'."\n" + ."\n" + .'- **UPDATE**: modifies a policy'."\n" + ."\n" + .'- **DELETE**: deletes a policy', + 'type' => 'string', + 'title' => '', + 'required' => false, + 'example' => 'UPDATE', + ], + 'SrcRegion' => [ + 'description' => 'The source region of the backup policy.', + 'type' => 'string', + 'title' => '', + 'required' => false, + 'example' => 'cn-shanghai', + ], + 'SrcType' => [ + 'description' => 'The source type of the backup policy. Valid values:'."\n" + ."\n" + .'- **db**: database'."\n" + ."\n" + .'- **level1**: level-1 backup'."\n" + ."\n" + .'- **level2**: level-2 backup'."\n" + ."\n" + .'- **level2Cross**: level-2 cross-region backup', + 'type' => 'string', + 'required' => false, + 'title' => '', + 'example' => 'db', + ], + 'OnlyPreserveOneEachDay' => [ + 'description' => 'Specifies whether to retain only one backup set per day for high-frequency backups that are more than one day old.', + 'type' => 'boolean', + 'title' => '', + 'required' => false, + 'example' => '', + ], + 'RetentionValue' => [ + 'description' => 'The retention period in days.', + 'type' => 'string', + 'title' => '', + 'required' => false, + 'example' => '4', + ], + 'PolicyId' => [ + 'description' => 'The ID of the advanced policy. For more information, see [DescribeBackupPolicy](~~2869783~~).', + 'type' => 'string', + 'title' => '', + 'required' => false, + 'example' => '6s67c7i3y8f8p72808p******', + ], + 'FilterKey' => [ + 'description' => 'The scheduling type. Valid values:'."\n" + ."\n" + .'- **dayOfWeek**: weekly schedule'."\n" + ."\n" + .'- **dayOfMonth**: monthly schedule'."\n" + ."\n" + .'- **dayOfYear**: yearly schedule'."\n" + ."\n" + .'- **backupInterval**: fixed interval schedule'."\n" + ."\n" + .'> This parameter is returned only when FilterType is set to **crontab**.', + 'type' => 'string', + 'title' => '', + 'required' => false, + 'example' => 'backupInterval', + ], + 'DestRegion' => [ + 'description' => 'The destination region of the backup policy.', + 'type' => 'string', + 'title' => '', + 'required' => false, + 'example' => 'cn-shanghai', + ], + 'FilterValue' => [ + 'description' => 'The backup cycle.', + 'type' => 'string', + 'title' => '', + 'required' => false, + 'example' => '180', + ], + 'RetentionType' => [ + 'description' => 'The retention period type for the backup set. Valid values:'."\n" + ."\n" + .'- **never**: never expires'."\n" + ."\n" + .'- **delay**: expires after a fixed number of days', + 'type' => 'string', + 'title' => '', + 'required' => false, + 'example' => 'delay', + ], + 'StorageClass' => [ + 'type' => 'string', + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + 'required' => false, + 'example' => '', + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + ], + [ + 'name' => 'AdvanceIncPolicies', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'type' => 'array', + 'items' => [ + 'title' => '', + 'type' => 'object', + 'properties' => [ + 'DestType' => [ + 'type' => 'string', + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'FilterType' => [ + 'type' => 'string', + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'ActionType' => [ + 'type' => 'string', + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'SrcRegion' => [ + 'type' => 'string', + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'SrcType' => [ + 'type' => 'string', + 'required' => false, + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'OnlyPreserveOneEachDay' => [ + 'type' => 'boolean', + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'RetentionValue' => [ + 'type' => 'string', + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'PolicyId' => [ + 'type' => 'string', + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'FilterKey' => [ + 'type' => 'string', + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'DestRegion' => [ + 'type' => 'string', + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'FilterValue' => [ + 'type' => 'string', + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'RetentionType' => [ + 'type' => 'string', + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'example' => '', + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + [ + 'name' => 'BackupRetentionPolicyOnClusterDeletion', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + [ + 'name' => 'BackupMethod', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + [ + 'name' => 'BackupPriority', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int32', + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + [ + 'name' => 'EnableIncBackup', + 'in' => 'query', + 'schema' => [ + 'type' => 'boolean', + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The details of the returned parameters.', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.', + 'type' => 'string', + 'example' => 'D570F209-A166-50C6-98A3-155A20B218B7', + 'title' => '', + ], + 'Message' => [ + 'description' => 'The returned message.', + 'type' => 'string', + 'example' => 'instanceName can not be empty.', + 'title' => '', + ], + 'Data' => [ + 'description' => 'The details of the backup policy.', + 'type' => 'object', + 'properties' => [ + 'PreferredBackupWindowBegin' => [ + 'description' => 'The start time of the backup window.', + 'type' => 'string', + 'title' => '', + 'example' => '17:00Z', + ], + 'PreferredBackupWindow' => [ + 'description' => 'The backup window.', + 'type' => 'string', + 'title' => '', + 'example' => '17:00Z-18:00Z', + ], + 'Category' => [ + 'description' => 'Indicates whether second-level backup is enabled. Returned values:'."\n" + ."\n" + .'- **Flash**: Second-level backup is enabled.'."\n" + ."\n" + .'- **Standard**: Standard backup is used.'."\n" + ."\n" + .'> This parameter is valid only for MySQL.', + 'type' => 'string', + 'example' => 'Standard', + 'title' => '', + ], + 'AdvanceLogPolicies' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'LogRetentionType' => [ + 'type' => 'string', + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'DestType' => [ + 'type' => 'string', + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'FilterType' => [ + 'type' => 'string', + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'SrcRegion' => [ + 'type' => 'string', + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'EnableLogBackup' => [ + 'type' => 'integer', + 'format' => 'int64', + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'SrcType' => [ + 'type' => 'string', + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'PolicyId' => [ + 'type' => 'string', + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'DestRegion' => [ + 'type' => 'string', + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'LogRetentionValue' => [ + 'type' => 'string', + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'FilterKey' => [ + 'type' => 'string', + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'FilterValue' => [ + 'type' => 'string', + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'AdvanceDataPolicies' => [ + 'description' => 'The details of the data backup policy.', + 'type' => 'array', + 'items' => [ + 'description' => 'The details of the policy.', + 'type' => 'object', + 'properties' => [ + 'RetentionValue' => [ + 'description' => 'The retention period in days.', + 'type' => 'string', + 'title' => '', + 'example' => '4', + ], + 'BakType' => [ + 'description' => 'The backup type. Returned values:'."\n" + ."\n" + .'- **F**: full backup'."\n" + ."\n" + .'- **L**: log backup', + 'type' => 'string', + 'title' => '', + 'example' => 'F', + ], + 'FilterKey' => [ + 'description' => 'The scheduling type. Returned values:'."\n" + ."\n" + .'- **dayOfWeek**: weekly schedule'."\n" + ."\n" + .'- **dayOfMonth**: monthly schedule'."\n" + ."\n" + .'- **dayOfYear**: yearly schedule'."\n" + ."\n" + .'- **backupInterval**: fixed interval schedule'."\n" + ."\n" + .'> This parameter is returned only when FilterType is set to **crontab**.', + 'type' => 'string', + 'title' => '', + 'example' => 'backupInterval', + ], + 'FilterValue' => [ + 'description' => 'The backup cycle.', + 'type' => 'string', + 'title' => '', + 'example' => '180', + ], + 'DestType' => [ + 'description' => 'The destination type of the backup policy. Returned values:'."\n" + ."\n" + .'- **db**: database'."\n" + ."\n" + .'- **level1**: level-1 backup'."\n" + ."\n" + .'- **level2**: level-2 backup'."\n" + ."\n" + .'- **level2Cross**: level-2 cross-region backup', + 'type' => 'string', + 'title' => '', + 'example' => 'level1', + ], + 'FilterType' => [ + 'description' => 'The filter type for the advanced policy. Returned values:'."\n" + ."\n" + .'- **crontab**: recurring schedule'."\n" + ."\n" + .'- **event**: event-based schedule', + 'type' => 'string', + 'title' => '', + 'example' => 'crontab', + ], + 'SrcRegion' => [ + 'description' => 'The source region of the backup policy.', + 'type' => 'string', + 'title' => '', + 'example' => 'cn-shanghai', + ], + 'AutoCreated' => [ + 'description' => 'Indicates whether the backup policy is automatically generated by the system. Returned values:'."\n" + ."\n" + .'- **true**: The policy is generated by the system.'."\n" + ."\n" + .'- **false**: The policy is a custom policy.', + 'type' => 'boolean', + 'title' => '', + 'example' => 'false', + ], + 'SrcType' => [ + 'description' => 'The source type of the backup policy. Returned values:'."\n" + ."\n" + .'- **db**: database'."\n" + ."\n" + .'- **level1**: level-1 backup'."\n" + ."\n" + .'- **level2**: level-2 backup'."\n" + ."\n" + .'- **level2Cross**: level-2 cross-region backup', + 'type' => 'string', + 'title' => '', + 'example' => 'db', + ], + 'OnlyPreserveOneEachDay' => [ + 'description' => 'Indicates whether to retain only one backup per day.'."\n" + ."\n" + .'- **true**: Only one backup is retained per day.'."\n" + ."\n" + .'- **false**: All backups are retained.', + 'type' => 'boolean', + 'example' => 'true', + 'title' => '', + ], + 'DumpAction' => [ + 'description' => 'The details of the dump policy. Returned values:'."\n" + ."\n" + .'- **copy**: copy'."\n" + ."\n" + .'- **move**: dump', + 'type' => 'string', + 'title' => '', + 'example' => 'copy', + ], + 'PolicyId' => [ + 'description' => 'The ID of the advanced policy.', + 'type' => 'string', + 'title' => '', + 'example' => 'dc13b153acc91141789122c23835****', + ], + 'DestRegion' => [ + 'description' => 'The destination region of the backup policy.', + 'type' => 'string', + 'title' => '', + 'example' => 'cn-shanghai', + ], + 'RetentionType' => [ + 'description' => 'The retention period type for the backup set. Returned values:'."\n" + ."\n" + .'- **never**: never expires'."\n" + ."\n" + .'- **delay**: expires after a fixed number of days', + 'type' => 'string', + 'title' => '', + 'example' => 'delay', + ], + 'StorageClass' => [ + 'type' => 'string', + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'AdvanceIncPolicies' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'RetentionValue' => [ + 'type' => 'string', + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'BakType' => [ + 'type' => 'string', + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'FilterKey' => [ + 'type' => 'string', + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'FilterValue' => [ + 'type' => 'string', + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'DestType' => [ + 'type' => 'string', + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'FilterType' => [ + 'type' => 'string', + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'SrcRegion' => [ + 'type' => 'string', + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'AutoCreated' => [ + 'type' => 'boolean', + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'SrcType' => [ + 'type' => 'string', + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'OnlyPreserveOneEachDay' => [ + 'type' => 'boolean', + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'DumpAction' => [ + 'type' => 'string', + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'PolicyId' => [ + 'type' => 'string', + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'DestRegion' => [ + 'type' => 'string', + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'RetentionType' => [ + 'type' => 'string', + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'BackupRetentionPolicyOnClusterDeletion' => [ + 'type' => 'string', + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'BackupMethod' => [ + 'type' => 'string', + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'BackupPriority' => [ + 'type' => 'integer', + 'format' => 'int32', + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'EnableIncBackup' => [ + 'type' => 'boolean', + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'ErrMessage' => [ + 'description' => 'The error message.', + 'type' => 'string', + 'example' => 'The specified parameter %s value is not valid.', + 'title' => '', + ], + 'Code' => [ + 'description' => 'The status code.', + 'type' => 'string', + 'example' => 'Success', + 'title' => '', + ], + 'Success' => [ + 'description' => 'Indicates whether the request was successful. Returned values:'."\n" + ."\n" + .'- **true**: The request was successful.'."\n" + ."\n" + .'- **false**: The request failed.', + 'type' => 'string', + 'example' => 'true', + 'title' => '', + ], + 'ErrCode' => [ + 'description' => 'The error code.', + 'type' => 'string', + 'example' => 'Success', + 'title' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'Request.Forbidden', + 'errorMessage' => 'Have no Permissions', + 'description' => '', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'title' => 'ModifyBackupPolicy', + 'summary' => 'Modifies the backup policy for a PolarDB instance.', + 'description' => '### Applicable engines'."\n" + ."\n" + .'PolarDB for MySQL'."\n" + ."\n" + .'> This API is available only to specific customers. To request access, you can join the DBS customer DingTalk group (ID: 35585947).', + 'changeSet' => [ + [ + 'createdAt' => '2024-09-24T08:37:35.000Z', + 'description' => 'Request parameters changed, Response parameters changed', + ], + [ + 'createdAt' => '2024-05-28T13:59:23.000Z', + 'description' => 'Request parameters changed', + ], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dbs:ModifyBackupPolicy', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DBS', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D570F209-A166-50C6-98A3-155A20B218B7\\",\\n \\"Message\\": \\"instanceName can not be empty.\\",\\n \\"Data\\": {\\n \\"PreferredBackupWindowBegin\\": \\"17:00Z\\",\\n \\"PreferredBackupWindow\\": \\"17:00Z-18:00Z\\",\\n \\"Category\\": \\"Standard\\",\\n \\"AdvanceLogPolicies\\": [\\n {\\n \\"LogRetentionType\\": \\"\\",\\n \\"DestType\\": \\"\\",\\n \\"FilterType\\": \\"\\",\\n \\"SrcRegion\\": \\"\\",\\n \\"EnableLogBackup\\": 0,\\n \\"SrcType\\": \\"\\",\\n \\"PolicyId\\": \\"\\",\\n \\"DestRegion\\": \\"\\",\\n \\"LogRetentionValue\\": \\"\\",\\n \\"FilterKey\\": \\"\\",\\n \\"FilterValue\\": \\"\\"\\n }\\n ],\\n \\"AdvanceDataPolicies\\": [\\n {\\n \\"RetentionValue\\": \\"4\\",\\n \\"BakType\\": \\"F\\",\\n \\"FilterKey\\": \\"backupInterval\\",\\n \\"FilterValue\\": \\"180\\",\\n \\"DestType\\": \\"level1\\",\\n \\"FilterType\\": \\"crontab\\",\\n \\"SrcRegion\\": \\"cn-shanghai\\",\\n \\"AutoCreated\\": false,\\n \\"SrcType\\": \\"db\\",\\n \\"OnlyPreserveOneEachDay\\": true,\\n \\"DumpAction\\": \\"copy\\",\\n \\"PolicyId\\": \\"dc13b153acc91141789122c23835****\\",\\n \\"DestRegion\\": \\"cn-shanghai\\",\\n \\"RetentionType\\": \\"delay\\",\\n \\"StorageClass\\": \\"\\"\\n }\\n ],\\n \\"AdvanceIncPolicies\\": [\\n {\\n \\"RetentionValue\\": \\"\\",\\n \\"BakType\\": \\"\\",\\n \\"FilterKey\\": \\"\\",\\n \\"FilterValue\\": \\"\\",\\n \\"DestType\\": \\"\\",\\n \\"FilterType\\": \\"\\",\\n \\"SrcRegion\\": \\"\\",\\n \\"AutoCreated\\": false,\\n \\"SrcType\\": \\"\\",\\n \\"OnlyPreserveOneEachDay\\": false,\\n \\"DumpAction\\": \\"\\",\\n \\"PolicyId\\": \\"\\",\\n \\"DestRegion\\": \\"\\",\\n \\"RetentionType\\": \\"\\"\\n }\\n ],\\n \\"BackupRetentionPolicyOnClusterDeletion\\": \\"\\",\\n \\"BackupMethod\\": \\"\\",\\n \\"BackupPriority\\": 0,\\n \\"EnableIncBackup\\": false\\n },\\n \\"ErrMessage\\": \\"The specified parameter %s value is not valid.\\",\\n \\"Code\\": \\"Success\\",\\n \\"Success\\": \\"true\\",\\n \\"ErrCode\\": \\"Success\\"\\n}","type":"json"}]', + ], + 'RetryDownloadTask' => [ + 'summary' => 'Retries a failed advanced download task.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREcbs04Q4EK', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionCode', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + 'description' => 'The ID of the region where the instance resides. To query the region ID, call [DescribeDBInstanceAttribute](~~26231~~) for an RDS instance or [DescribeDBClusterAttribute](~~2319132~~) for a PolarDB cluster.', + 'title' => '', + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'TaskId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + 'description' => 'The task ID.', + 'title' => '', + 'example' => 'dt-example', + ], + ], + [ + 'name' => 'InstanceName', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'description' => 'The instance ID.', + 'required' => false, + 'title' => '', + 'example' => 'rm-example', + ], + ], + [ + 'name' => 'ClusterName', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'description' => 'The name of the sharded cluster. This parameter is required only for MongoDB instances.', + 'title' => '', + 'required' => false, + 'example' => 'dds-example', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Data' => [ + 'type' => 'string', + 'description' => 'The details of the download task.', + 'title' => '', + 'example' => '暂无', + ], + 'RequestId' => [ + 'type' => 'string', + 'description' => 'The request ID.', + 'title' => '', + 'example' => '49FE4E8E-39B9-56DE-BC07-5AEBFAXXXXXX', + ], + 'ErrCode' => [ + 'type' => 'string', + 'description' => 'The error code.', + 'title' => '', + 'example' => 'Success', + ], + 'Success' => [ + 'type' => 'string', + 'description' => 'Indicates whether the request was successful.', + 'title' => '', + 'example' => 'True', + ], + 'ErrMessage' => [ + 'type' => 'string', + 'description' => 'The error message.', + 'title' => '', + 'example' => 'The specified parameter %s value is not valid.', + ], + 'Code' => [ + 'type' => 'string', + 'description' => 'The error code.', + 'title' => '', + 'example' => 'Success', + ], + 'Message' => [ + 'type' => 'string', + 'description' => 'The error message.', + 'title' => '', + 'example' => 'instanceName can not be empty.', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'Request.Forbidden', + 'errorMessage' => 'Have no Permissions', + 'description' => '', + ], + ], + ], + 'title' => 'RetryDownloadTask', + 'description' => '### Applicable engines'."\n" + ."\n" + .'- RDS for MySQL (with cloud disks)'."\n" + ."\n" + .'- RDS for PostgreSQL'."\n" + ."\n" + .'- PolarDB for MySQL'."\n" + ."\n" + .'- MongoDB'."\n" + ."\n" + .'### Related documents'."\n" + ."\n" + .'- [Download a backup of an RDS for MySQL instance](~~98819~~)'."\n" + ."\n" + .'- [Download a backup of an RDS for PostgreSQL instance](~~96774~~)'."\n" + ."\n" + .'- [Download a backup of a PolarDB for MySQL cluster](~~2627635~~)'."\n" + ."\n" + .'- [Download a backup of a MongoDB instance](~~55011~~)', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dbs:RetryDownloadTask', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DBS', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": \\"暂无\\",\\n \\"RequestId\\": \\"49FE4E8E-39B9-56DE-BC07-5AEBFAXXXXXX\\",\\n \\"ErrCode\\": \\"Success\\",\\n \\"Success\\": \\"True\\",\\n \\"ErrMessage\\": \\"The specified parameter %s value is not valid.\\",\\n \\"Code\\": \\"Success\\",\\n \\"Message\\": \\"instanceName can not be empty.\\"\\n}","type":"json"}]', + ], + ], + 'endpoints' => [ + [ + 'regionId' => 'cn-wulanchabu', + 'regionName' => 'China (Ulanqab)', + 'areaId' => 'asiaPacific', + 'areaName' => 'Asia Pacific', + 'public' => 'dbs-api.cn-wulanchabu.aliyuncs.com', + 'endpoint' => 'dbs-api.cn-wulanchabu.aliyuncs.com', + 'vpc' => 'dbs-api-vpc.cn-wulanchabu.aliyuncs.com', + ], + [ + 'regionId' => 'cn-beijing', + 'regionName' => 'China (Beijing)', + 'areaId' => 'asiaPacific', + 'areaName' => 'Asia Pacific', + 'public' => 'dbs-api.cn-hangzhou.aliyuncs.com', + 'endpoint' => 'dbs-api.cn-hangzhou.aliyuncs.com', + 'vpc' => 'dbs-api-vpc.cn-beijing.aliyuncs.com', + ], + [ + 'regionId' => 'cn-qingdao', + 'regionName' => 'China (Qingdao)', + 'areaId' => 'asiaPacific', + 'areaName' => 'Asia Pacific', + 'public' => 'dbs-api.cn-hangzhou.aliyuncs.com', + 'endpoint' => 'dbs-api.cn-hangzhou.aliyuncs.com', + 'vpc' => 'dbs-api-vpc.cn-qingdao.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shanghai', + 'regionName' => 'China (Shanghai)', + 'areaId' => 'asiaPacific', + 'areaName' => 'Asia Pacific', + 'public' => 'dbs-api.cn-hangzhou.aliyuncs.com', + 'endpoint' => 'dbs-api.cn-hangzhou.aliyuncs.com', + 'vpc' => 'dbs-api-vpc.cn-shanghai.aliyuncs.com', + ], + [ + 'regionId' => 'cn-hongkong', + 'regionName' => 'China (Hong Kong)', + 'areaId' => 'asiaPacific', + 'areaName' => 'Asia Pacific', + 'public' => 'dbs-api.cn-hangzhou.aliyuncs.com', + 'endpoint' => 'dbs-api.cn-hangzhou.aliyuncs.com', + 'vpc' => 'dbs-api-vpc.cn-hongkong.aliyuncs.com', + ], + [ + 'regionId' => 'cn-zhangjiakou', + 'regionName' => 'China (Zhangjiakou)', + 'areaId' => 'asiaPacific', + 'areaName' => 'Asia Pacific', + 'public' => 'dbs-api.cn-zhangjiakou.aliyuncs.com', + 'endpoint' => 'dbs-api.cn-zhangjiakou.aliyuncs.com', + 'vpc' => 'dbs-api-vpc.cn-zhangjiakou.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shenzhen', + 'regionName' => 'China (Shenzhen)', + 'areaId' => 'asiaPacific', + 'areaName' => 'Asia Pacific', + 'public' => 'dbs-api.cn-hangzhou.aliyuncs.com', + 'endpoint' => 'dbs-api.cn-hangzhou.aliyuncs.com', + 'vpc' => 'dbs-api-vpc.cn-shenzhen.aliyuncs.com', + ], + [ + 'regionId' => 'ap-northeast-1', + 'regionName' => 'Japan (Tokyo)', + 'areaId' => 'asiaPacific', + 'areaName' => 'Asia Pacific', + 'public' => 'dbs-api.ap-northeast-1.aliyuncs.com', + 'endpoint' => 'dbs-api.ap-northeast-1.aliyuncs.com', + 'vpc' => 'dbs-api-vpc.ap-northeast-1.aliyuncs.com', + ], + [ + 'regionId' => 'cn-chengdu', + 'regionName' => 'China (Chengdu)', + 'areaId' => 'asiaPacific', + 'areaName' => 'Asia Pacific', + 'public' => 'dbs-api.cn-chengdu.aliyuncs.com', + 'endpoint' => 'dbs-api.cn-chengdu.aliyuncs.com', + 'vpc' => 'dbs-api-vpc.cn-chengdu.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-1', + 'regionName' => 'Singapore', + 'areaId' => 'asiaPacific', + 'areaName' => 'Asia Pacific', + 'public' => 'dbs-api.ap-southeast-1.aliyuncs.com', + 'endpoint' => 'dbs-api.ap-southeast-1.aliyuncs.com', + 'vpc' => 'dbs-api-vpc.ap-southeast-1.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-3', + 'regionName' => 'Malaysia (Kuala Lumpur)', + 'areaId' => 'asiaPacific', + 'areaName' => 'Asia Pacific', + 'public' => 'dbs-api.ap-southeast-3.aliyuncs.com', + 'endpoint' => 'dbs-api.ap-southeast-3.aliyuncs.com', + 'vpc' => 'dbs-api-vpc.ap-southeast-3.aliyuncs.com', + ], + [ + 'regionId' => 'cn-huhehaote', + 'regionName' => 'China (Hohhot)', + 'areaId' => 'asiaPacific', + 'areaName' => 'Asia Pacific', + 'public' => 'dbs-api.cn-huhehaote.aliyuncs.com', + 'endpoint' => 'dbs-api.cn-huhehaote.aliyuncs.com', + 'vpc' => 'dbs-api-vpc.cn-huhehaote.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-5', + 'regionName' => 'Indonesia (Jakarta)', + 'areaId' => 'asiaPacific', + 'areaName' => 'Asia Pacific', + 'public' => 'dbs-api.ap-southeast-5.aliyuncs.com', + 'endpoint' => 'dbs-api.ap-southeast-5.aliyuncs.com', + 'vpc' => 'dbs-api-vpc.ap-southeast-5.aliyuncs.com', + ], + [ + 'regionId' => 'cn-hangzhou', + 'regionName' => 'China (Hangzhou)', + 'areaId' => 'asiaPacific', + 'areaName' => 'Asia Pacific', + 'public' => 'dbs-api.cn-hangzhou.aliyuncs.com', + 'endpoint' => 'dbs-api.cn-hangzhou.aliyuncs.com', + 'vpc' => 'dbs-api-vpc.cn-hangzhou.aliyuncs.com', + ], + [ + 'regionId' => 'us-east-1', + 'regionName' => 'US (Virginia)', + 'areaId' => 'europeAmerica', + 'areaName' => 'Europe & Americas', + 'public' => 'dbs-api.cn-hangzhou.aliyuncs.com', + 'endpoint' => 'dbs-api.cn-hangzhou.aliyuncs.com', + 'vpc' => 'dbs-api-vpc.us-east-1.aliyuncs.com', + ], + [ + 'regionId' => 'eu-west-1', + 'regionName' => 'UK (London)', + 'areaId' => 'europeAmerica', + 'areaName' => 'Europe & Americas', + 'public' => 'dbs-api.eu-west-1.aliyuncs.com', + 'endpoint' => 'dbs-api.eu-west-1.aliyuncs.com', + 'vpc' => 'dbs-api-vpc.eu-west-1.aliyuncs.com', + ], + [ + 'regionId' => 'us-west-1', + 'regionName' => 'US (Silicon Valley)', + 'areaId' => 'europeAmerica', + 'areaName' => 'Europe & Americas', + 'public' => 'dbs-api.cn-hangzhou.aliyuncs.com', + 'endpoint' => 'dbs-api.cn-hangzhou.aliyuncs.com', + 'vpc' => 'dbs-api-vpc.us-west-1.aliyuncs.com', + ], + [ + 'regionId' => 'eu-central-1', + 'regionName' => 'Germany (Frankfurt)', + 'areaId' => 'europeAmerica', + 'areaName' => 'Europe & Americas', + 'public' => 'dbs-api.eu-central-1.aliyuncs.com', + 'endpoint' => 'dbs-api.eu-central-1.aliyuncs.com', + 'vpc' => 'dbs-api-vpc.eu-central-1.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shenzhen-finance-1', + 'regionName' => 'China South 1 Finance', + 'areaId' => 'industryCloud', + 'areaName' => 'Industry Cloud', + 'public' => 'dbs-api.cn-hangzhou.aliyuncs.com', + 'endpoint' => 'dbs-api.cn-hangzhou.aliyuncs.com', + 'vpc' => 'dbs-api-vpc.cn-shenzhen-finance-1.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shanghai-finance-1', + 'regionName' => 'China East 2 Finance', + 'areaId' => 'industryCloud', + 'areaName' => 'Industry Cloud', + 'public' => 'dbs-api.cn-hangzhou.aliyuncs.com', + 'endpoint' => 'dbs-api.cn-hangzhou.aliyuncs.com', + 'vpc' => 'dbs-api-vpc.cn-shanghai-finance-1.aliyuncs.com', + ], + [ + 'regionId' => 'cn-hangzhou-finance', + 'regionName' => 'China East 1 Finance', + 'areaId' => 'industryCloud', + 'areaName' => 'Industry Cloud', + 'public' => 'dbs-api.cn-hangzhou.aliyuncs.com', + 'endpoint' => 'dbs-api.cn-hangzhou.aliyuncs.com', + 'vpc' => '', + ], + ], + 'errorCodes' => [ + [ + 'code' => 'BackupPlanNotConfigure', + 'message' => 'ConfigureBackupPlanRequest Error', + 'http_code' => 200, + 'description' => 'The backup schedule is incorrectly configured.', + ], + [ + 'code' => 'BackupPlanNotDescribe', + 'message' => 'describe backup plan failed -> null', + 'http_code' => 200, + 'description' => 'Failed to query the list of backup schedules.', + ], + [ + 'code' => 'BackupPlanNotModify', + 'message' => 'modify backup source endpoint fail', + 'http_code' => 200, + 'description' => 'Failed to modify the backup source endpoint.', + ], + [ + 'code' => 'DBS.DisasterCenter.NoPermission', + 'message' => 'no permission for this action.', + 'http_code' => 403, + 'description' => 'No permission for this operation.', + ], + [ + 'code' => 'DBS.DownloadTask.CannotFind', + 'message' => 'Can not find download task.', + 'http_code' => 200, + 'description' => 'Can not find download task.', + ], + [ + 'code' => 'DBS.DownloadTask.JobAlreadyExist', + 'message' => 'Job already submit in recent days, please check it.', + 'http_code' => 200, + 'description' => 'Job already submit in recent days, please check it.', + ], + [ + 'code' => 'DBS.DownloadTask.OnlyOneRunningOrFailedTask', + 'message' => 'There can be only one running or failed task for the instance.', + 'http_code' => 200, + 'description' => 'The current instance can only have one running/failed task at the same time.', + ], + [ + 'code' => 'DBS.DownloadTask.OssForbid', + 'message' => 'OSS is forbidden to access. Please check your OSS bucket.', + 'http_code' => 200, + 'description' => 'OSS is forbidden to access. Please check your OSS bucket.', + ], + [ + 'code' => 'DBS.DownloadTask.OssStorageTypeInvalid', + 'message' => 'Unsupported bucket storage. Please make sure that your OSS bucket\'s storgae type is standard.', + 'http_code' => 200, + 'description' => 'Unsupported bucket storage. Please make sure that your OSS bucket\'s storgae type is standard.', + ], + [ + 'code' => 'DBS.NoPermissionException', + 'message' => 'Rejected by ValidationChecker.', + 'http_code' => 403, + 'description' => '', + ], + [ + 'code' => 'DBS.NotExists', + 'message' => 'data source do not existed.', + 'http_code' => 404, + 'description' => 'DBS.NotExists', + ], + [ + 'code' => 'Forbidden.InstanceNotFound', + 'message' => 'instance not found', + 'http_code' => 200, + 'description' => 'The instance does not exist.', + ], + [ + 'code' => 'InternalError', + 'message' => 'internal error', + 'http_code' => 500, + 'description' => 'An internal error occurred.', + ], + [ + 'code' => 'OperationDenied.JobStatus', + 'message' => 'The operation is not permitted.', + 'http_code' => 200, + 'description' => 'The operation is not allowed.', + ], + [ + 'code' => 'Request.Forbidden', + 'message' => 'Have no Permissions', + 'http_code' => 403, + 'description' => '', + ], + [ + 'code' => 'UserError', + 'message' => 'user error', + 'http_code' => 200, + 'description' => 'An error occurred due to improper operations.', + ], + [ + 'code' => 'UserError', + 'message' => 'You must first activate OSS before using DBS to OSS.', + 'http_code' => 403, + 'description' => 'You must first activate OSS before using DBS -> OSS.', + ], + ], + 'changeSet' => [ + [ + 'apis' => [ + [ + 'description' => 'Request parameters changed, Response parameters changed', + 'api' => 'ModifyBackupPolicy', + ], + ], + 'createdAt' => '2024-09-24T08:37:03.000Z', + 'description' => '', + ], + [ + 'apis' => [ + [ + 'description' => 'Response parameters changed', + 'api' => 'DescribeBackupPolicy', + ], + [ + 'description' => 'Request parameters changed', + 'api' => 'ModifyBackupPolicy', + ], + ], + 'createdAt' => '2024-05-28T13:59:17.000Z', + 'description' => '', + ], + [ + 'apis' => [ + [ + 'description' => 'Response parameters changed', + 'api' => 'DescribeBackupPolicy', + ], + ], + 'createdAt' => '2024-05-16T11:16:56.000Z', + 'description' => '', + ], + [ + 'apis' => [ + [ + 'description' => 'Request parameters changed', + 'api' => 'ChangeResourceGroup', + ], + ], + 'createdAt' => '2023-12-21T13:43:30.000Z', + 'description' => '', + ], + [ + 'apis' => [ + [ + 'description' => 'Request parameters changed', + 'api' => 'CreateSandboxInstance', + ], + [ + 'description' => 'Request parameters changed', + 'api' => 'DeleteSandboxInstance', + ], + ], + 'createdAt' => '2023-08-18T07:28:29.000Z', + 'description' => '', + ], + [ + 'apis' => [ + [ + 'description' => 'Response parameters changed', + 'api' => 'DescribeDownloadTask', + ], + ], + 'createdAt' => '2022-11-16T11:45:26.000Z', + 'description' => 'DescribeDownloadTask更新，修改分页相关返回字段名', + ], + [ + 'apis' => [ + [ + 'description' => 'OpenAPI offline', + 'api' => 'DescribeDBTablesRecoveryBackupSet', + ], + [ + 'description' => 'OpenAPI offline', + 'api' => 'DescribeDBTablesRecoveryState', + ], + [ + 'description' => 'OpenAPI offline', + 'api' => 'DescribeDBTablesRecoveryTimeRange', + ], + [ + 'description' => 'OpenAPI offline', + 'api' => 'ModifyDBTablesRecoveryState', + ], + [ + 'description' => 'OpenAPI offline', + 'api' => 'SupportDBTableRecovery', + ], + ], + 'createdAt' => '2022-10-18T14:32:36.000Z', + 'description' => '极速库表恢复openapi', + ], + [ + 'apis' => [ + [ + 'description' => 'Request parameters changed', + 'api' => 'DescribeDownloadBackupSetStorageInfo', + ], + [ + 'description' => 'Request parameters changed', + 'api' => 'DescribeDownloadSupport', + ], + ], + 'createdAt' => '2022-08-25T07:44:08.000Z', + 'description' => '修改参数必填属性', + ], + [ + 'apis' => [ + [ + 'description' => 'OpenAPI offline', + 'api' => 'DescribeDownloadBackupSetStorageInfo', + ], + [ + 'description' => 'OpenAPI offline', + 'api' => 'DescribeDownloadSupport', + ], + ], + 'createdAt' => '2022-08-03T09:24:36.000Z', + 'description' => 'DBS高级下载V3.2发布', + ], + [ + 'apis' => [ + [ + 'description' => 'OpenAPI offline', + 'api' => 'DescribeAvailableCrossRegion', + ], + ], + 'createdAt' => '2022-07-15T06:34:03.000Z', + 'description' => '发布新接口', + ], + ], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '-1', + 'countWindow' => 1, + 'regionId' => '*', + ], + [ + 'threshold' => '400', + 'countWindow' => 60, + 'regionId' => '*', + 'api' => 'DescribeDownloadSupport', + ], + ], + ], + 'ram' => [ + 'productCode' => 'DBS', + 'productName' => 'Database Backup', + 'ramCodes' => [ + 'dbs', + ], + 'ramLevel' => 'RESOURCE', + 'ramConditions' => [], + 'ramActions' => [ + [ + 'apiName' => 'CreateAdvancedPolicy', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dbs:CreateAdvancedPolicy', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DBS', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'CreateDownload', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'dbs:CreateDownload', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DBS', + 'resourceType' => 'DBInstance', + 'arn' => 'acs:rds:{#regionId}:{#accountId}:dbinstance/{#DbInstanceId}', + ], + ], + ], + ], + [ + 'apiName' => 'DescribeDownloadTask', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dbs:DescribeDownloadTask', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DBS', + 'resourceType' => 'DBInstance', + 'arn' => 'acs:rds:{#regionId}:{#accountId}:dbinstance/{#DbInstanceId}', + ], + ], + ], + ], + [ + 'apiName' => 'DescribeBackupDataList', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'dbs:DescribeBackupDataList', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'conditional', + 'product' => 'DBS', + 'resourceType' => 'DBInstance', + 'arn' => 'acs:rds:{#regionId}:{#accountId}:dbinstance/{#DbInstanceId}', + ], + ], + ], + ], + [ + 'apiName' => 'DescribeCostInfoByDbsInstance', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dbs:DescribeCostInfoByDbsInstance', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DBS', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'DescribeSandboxInstances', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dbs:DescribeSandboxInstances', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DBS', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'DescribeDownloadBackupSetStorageInfo', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dbs:DescribeDownloadBackupSetStorageInfo', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DBS', + 'resourceType' => 'BackupPlan', + 'arn' => 'acs:dbs:{#regionId}:{#accountId}:backupplan/{#BackupPlanId}', + ], + ], + ], + ], + [ + 'apiName' => 'ChangeResourceGroup', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dbs:ChangeResourceGroup', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DBS', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'DeleteSandboxInstance', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'dbs:DeleteSandboxInstance', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DBS', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'DescribeBackupPolicy', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dbs:DescribeBackupPolicy', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DBS', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'DescribeSandboxRecoveryTime', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dbs:DescribeSandboxRecoveryTime', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DBS', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'DescribeSandboxBackupSets', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dbs:DescribeSandboxBackupSets', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DBS', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'RetryDownloadTask', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dbs:RetryDownloadTask', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DBS', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'DescribeDownloadSupport', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dbs:DescribeDownloadSupport', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DBS', + 'resourceType' => 'BackupPlan', + 'arn' => 'acs:dbs:{#regionId}:{#accountId}:backupplan/{#BackupPlanId}', + ], + ], + ], + ], + [ + 'apiName' => 'ModifyBackupPolicy', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dbs:ModifyBackupPolicy', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DBS', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + ], + 'resourceTypes' => [ + [ + 'validationType' => 'always', + 'resourceType' => 'DBInstance', + 'arn' => 'acs:rds:{#regionId}:{#accountId}:dbinstance/{#DbInstanceId}', + ], + [ + 'validationType' => 'always', + 'resourceType' => 'BackupPlan', + 'arn' => 'acs:dbs:{#regionId}:{#accountId}:backupplan/{#BackupPlanId}', + ], + [ + 'validationType' => 'always', + 'resourceType' => 'DataSource', + 'arn' => 'acs:dbs:{#regionId}:{#accountId}:', + ], + ], + ], +]; |