'1.0', 'info' => ['style' => 'RPC', 'product' => 'Dbs', 'version' => '2019-03-06'], 'directories' => [ [ 'children' => ['CreateBackupPlan', 'CreateAndStartBackupPlan', 'StartBackupPlan', 'EnableBackupLog', 'StopBackupPlan', 'DisableBackupLog', 'ModifyBackupObjects', 'ModifyBackupSourceEndpoint', 'ModifyStorageStrategy', 'ModifyBackupPlanName', 'ModifyBackupStrategy', 'DescribeBackupPlanList', 'DescribeRestoreRangeInfo', 'DescribeBackupPlanBilling', 'ConfigureBackupPlan', 'RenewBackupPlan', 'UpgradeBackupPlan', 'ReleaseBackupPlan'], 'type' => 'directory', 'title' => 'Backup plan', ], [ 'children' => ['DescribeIncrementBackupList', 'DescribeFullBackupList'], 'type' => 'directory', 'title' => 'Backup task', ], [ 'children' => ['CreateRestoreTask', 'StartRestoreTask', 'DescribeRestoreTaskList'], 'type' => 'directory', 'title' => 'Restore task', ], [ 'children' => ['DescribeBackupGatewayList'], 'type' => 'directory', 'title' => 'Backup gateway', ], [ 'children' => ['CreateFullBackupSetDownload', 'CreateIncrementBackupSetDownload', 'ModifyBackupSetDownloadRules', 'DescribeBackupSetDownloadTaskList'], 'type' => 'directory', 'title' => 'Backup set download', ], [ 'children' => ['CreateGetDBListFromAgentTask', 'DescribeNodeCidrList', 'DescribeJobErrorCode', 'DescribePreCheckProgressList', 'DescribeDLAService', 'GetDBListFromAgent', 'InitializeDbsServiceLinkedRole'], 'type' => 'directory', 'title' => 'Service management', ], [ 'children' => ['DescribeRegions'], 'title' => 'Others', 'type' => 'directory', ], ], 'components' => [ 'schemas' => [], ], 'apis' => [ 'ConfigureBackupPlan' => [ '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. You can call [DescribeBackupPlanList](~~2869825~~) to query the backup plan ID.', 'type' => 'string', 'required' => true, 'example' => 'dbstooi0*******', 'title' => ''], ], [ 'name' => 'SourceEndpointInstanceType', 'in' => 'query', 'schema' => ['description' => 'The location of the database. You can call [DescribeBackupPlanList](~~2869825~~) to query this value. Valid values:'."\n" ."\n" .'- **RDS**'."\n" ."\n" .'- **ECS**'."\n" ."\n" .'- **Express**: A database connected through a leased line, VPN Gateway, or Smart Gateway.'."\n" ."\n" .'- **Agent**: A database connected through a backup gateway.'."\n" ."\n" .'- **DDS**: Cloud MongoDB.'."\n" ."\n" .'- **Other**: A database directly connected through IP:Port.', 'type' => 'string', 'required' => true, 'example' => 'RDS', 'title' => ''], ], [ 'name' => 'SourceEndpointRegion', 'in' => 'query', 'schema' => ['description' => 'The region of the database. You can call [DescribeBackupPlanList](~~2869825~~) to query this value.'."\n" ."\n" .'> This parameter is required when **SourceEndpointInstanceType** is RDS, ECS, DDS, Express, or Agent.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''], ], [ 'name' => 'SourceEndpointInstanceID', 'in' => 'query', 'schema' => ['description' => 'The database instance ID. You can call [DescribeBackupPlanList](~~2869825~~) to query this value.'."\n" ."\n" .'> This parameter is required when **SourceEndpoint**.**InstanceType** is **RDS**, **ECS**, **DDS**, or **Express**.', 'type' => 'string', 'required' => false, 'example' => 'rm-uf6wjk5*********', 'title' => ''], ], [ 'name' => 'SourceEndpointIP', 'in' => 'query', 'schema' => ['description' => 'The database endpoint. You can call [DescribeBackupPlanList](~~2869825~~) to query this value.'."\n" ."\n" .'> This parameter is required when **SourceEndpointInstanceType** is **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. You can call [DescribeBackupPlanList](~~2869825~~) to query this value.'."\n" ."\n" .'> This parameter is required when **SourceEndpoint**.**InstanceType** is **express**, **agent**, **other**, or **ECS**.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '3306', 'title' => ''], ], [ 'name' => 'SourceEndpointDatabaseName', 'in' => 'query', 'schema' => ['description' => 'The database name. You can call [DescribeBackupPlanList](~~2869825~~) to query this value.'."\n" ."\n" .'> This parameter is required when 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 when the database type is **Redis**, or when the database location is **agent** and the database type is **SQL Server**. It is required in other scenarios.', 'type' => 'string', 'required' => false, 'example' => 'testRDS', 'title' => ''], ], [ 'name' => 'SourceEndpointPassword', 'in' => 'query', 'schema' => ['description' => 'The password.'."\n" ."\n" .'> This parameter is optional when the database type is **Redis**, or when the database location is **agent** and the database type is **SQL Server**. It is required in other scenarios.', 'type' => 'string', 'required' => false, 'example' => 'testPassword', 'title' => ''], ], [ 'name' => 'BackupGatewayId', 'in' => 'query', 'schema' => ['description' => 'The backup gateway ID. You can call [DescribeBackupPlanList](~~2869825~~) to query this value.'."\n" ."\n" .'> This parameter is required when **SourceEndpointInstanceType** is **agent**.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '23313123312', 'title' => ''], ], [ 'name' => 'OSSBucketName', 'in' => 'query', 'schema' => ['description' => 'The OSS bucket name.'."\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. You can call [DescribeBackupPlanList](~~2869825~~) to query this value.', 'type' => 'string', 'required' => false, 'example' => '[ { "DBName":"待备份库名", "SchemaName":"待备份 Schema 名", "TableIncludes":[{ "TableName":"待备份表表名" }], "TableExcludes":[{ "TableName":"待备份库名不需要备份表的表名" }] } ]', 'title' => ''], ], [ 'name' => 'BackupPeriod', 'in' => 'query', 'schema' => ['description' => 'The full backup period. Valid values:'."\n" ."\n" .'- **Monday**: Monday'."\n" ."\n" .'- **Tuesday**: Tuesday'."\n" ."\n" .'- **Wednesday**: Wednesday'."\n" ."\n" .'- **Thursday**: Thursday'."\n" ."\n" .'- **Friday**: Friday'."\n" ."\n" .'- **Saturday**: Saturday'."\n" ."\n" .'- **Sunday**: Sunday', 'type' => 'string', 'required' => false, 'example' => 'Monday', 'title' => ''], ], [ 'name' => 'BackupStartTime', 'in' => 'query', 'schema' => ['description' => 'The full backup start time in *HH:mm*Z (UTC) format. You can call [DescribeBackupPlanList](~~2869825~~) to query this value.', 'type' => 'string', 'required' => false, 'example' => '14:22', 'title' => ''], ], [ 'name' => 'EnableBackupLog', 'in' => 'query', 'schema' => ['description' => '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 incremental interval in seconds (s).'."\n" ."\n" .'> Only physical backup is supported.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1000', 'title' => ''], ], [ 'name' => 'BackupRetentionPeriod', 'in' => 'query', 'schema' => ['description' => 'The retention period for backup data. Valid values: 0 to 1825. Default value: 730 days.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '730', 'title' => ''], ], [ 'name' => 'DuplicationInfrequentAccessPeriod', 'in' => 'query', 'schema' => ['description' => 'The period after which data is converted to Infrequent Access storage. Default value: 180 days.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '180', 'title' => ''], ], [ 'name' => 'DuplicationArchivePeriod', 'in' => 'query', 'schema' => ['description' => 'The period after which data is converted to archive cold storage. Default value: 365 days.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '365', 'title' => ''], ], [ 'name' => 'BackupPlanName', 'in' => 'query', 'schema' => ['description' => 'The custom backup plan name. You can call [DescribeBackupPlanList](~~2869825~~) to query this value.', 'type' => 'string', 'required' => true, 'example' => 'dbstooi0*******', 'title' => ''], ], [ 'name' => 'SourceEndpointOracleSID', 'in' => 'query', 'schema' => ['description' => 'The Oracle SID name.'."\n" ."\n" .'> This parameter is required when 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 on your OSS.'."\n" ."\n" .'- system: Backup data is stored on the built-in OSS 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 backup.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '262144', 'title' => ''], ], [ 'name' => 'BackupRateLimit', 'in' => 'query', 'schema' => ['description' => 'The network bandwidth throttling in KB/s. The maximum value is 10 GB.'."\n" ."\n" .'> This parameter is valid only for MySQL physical backup.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '262144', 'title' => ''], ], [ 'name' => 'BackupStrategyType', 'in' => 'query', 'schema' => ['description' => 'The full backup period. 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 for cross-Alibaba Cloud account backup. You can call [DescribeRestoreTaskList](~~2869838~~) to query this value.', 'type' => 'string', 'required' => false, 'example' => '2xxx7778xxxxxxxxxx', 'title' => ''], ], [ 'name' => 'CrossRoleName', 'in' => 'query', 'schema' => ['description' => 'The RAM role name for cross-Alibaba Cloud account backup. You can call [DescribeRestoreTaskList](~~2869838~~) to query this value.', 'type' => 'string', 'required' => false, 'example' => 'test123', 'title' => ''], ], [ 'name' => 'AutoStartBackup', 'in' => 'query', 'schema' => ['description' => 'Enable automatic backup. Valid values:'."\n" ."\n" .'- **true**: Enable'."\n" ."\n" .'- **false**: Disable', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], ], [ 'name' => 'ClientToken', 'in' => 'query', 'schema' => ['description' => 'The client token that is used to ensure the idempotence of the request. The client generates this value, which must be unique among different requests. The token can be up to 64 ASCII characters in length.', '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' => ''], ], [ 'name' => 'EnableSourceEndpointSsl', 'in' => 'query', 'schema' => ['type' => 'string', 'example' => 'true', 'description' => '', 'title' => ''], ], [ 'name' => 'BackupStorageEncryptMethod', 'in' => 'query', 'schema' => ['type' => 'string', 'example' => 'encrypted', 'description' => '', 'title' => ''], ], [ 'name' => 'SslCaPem', 'in' => 'query', 'schema' => ['type' => 'string', 'example' => '-----BEGIN CERTIFICATE----- ... -----END CERTIFICATE-----', 'description' => '', 'title' => ''], ], [ 'name' => 'SourceEndpointOracleHome', 'in' => 'query', 'schema' => ['type' => 'string', 'example' => '/home/test', 'description' => '', 'title' => ''], ], [ 'name' => 'EnableMysqlPhysicalBackupBinlog', 'in' => 'query', 'schema' => ['type' => 'string', 'example' => 'true', 'description' => '', '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' => '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 backup plan ID.', 'type' => 'string', 'example' => 'dbstooi01ex****', 'title' => ''], ], 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 403 => [ ['errorCode' => 'Request.Forbidden', 'errorMessage' => 'Have no Permissions', 'description' => ''], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'ConfigureBackupPlan', 'summary' => 'Configures a Database Backup (DBS) backup plan.', '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' => 'prepay', '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' => ''], ], ], '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"}]', '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' => '*'], ], ], ], ], ], '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' => 'This operation creates a DBS restore task.', '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 type of the destination endpoint. Valid values:'."\n" ."\n" .'- **RDS**: an ApsaraDB RDS instance.'."\n" ."\n" .'- **ECS**: a self-managed database hosted on an ECS instance.'."\n" ."\n" .'- **Express**: a database connected over a leased line, VPN Gateway, or Smart Access Gateway.'."\n" ."\n" .'- **Agent**: a database connected via a backup gateway.'."\n" ."\n" .'- **DDS**: an ApsaraDB for MongoDB (DDS) instance.'."\n" ."\n" .'- **Other**: a database connected over the internet by using a public IP address and port.'."\n" ."\n" .'- **dg**: a self-managed database without a public endpoint, connected via Database Gateway.', 'type' => 'string', 'required' => true, 'example' => 'RDS', 'title' => ''], ], [ 'name' => 'DestinationEndpointRegion', 'in' => 'query', 'schema' => ['description' => 'The region ID of the destination 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 destination 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 endpoint of the destination database.'."\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 port that is used to connect to the destination database.'."\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 name of the destination database.'."\n" ."\n" .'> This parameter is required if the database engine is PostgreSQL or MongoDB.', 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''], ], [ 'name' => 'DestinationEndpointUserName', 'in' => 'query', 'schema' => ['description' => 'The username for the destination database account.'."\n" ."\n" .'> This parameter is optional if the database engine is Redis, or if `DestinationEndpointInstanceType` is set to `Agent` and the database engine is MSSQL. In other scenarios, this parameter is required.', 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''], ], [ 'name' => 'DestinationEndpointPassword', 'in' => 'query', 'schema' => ['description' => 'The password for the destination database account.'."\n" ."\n" .'> This parameter is optional if the database engine is Redis, or if `DestinationEndpointInstanceType` is set to `Agent` and the database engine is MSSQL. In 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" .'- This parameter is optional if `DestinationEndpointInstanceType` is set to `Agent`. In other scenarios, this parameter is required.'."\n" ."\n" .'- The value must be a JSON string in the following format: `[{ "DBName": "source_database_name", "NewDBName": "destination_database_name" }]`'."\n" ."\n" .'> You can use this API operation to restore data only at the database level. To restore data at the table level, log on to the console. For more information, see [Restore databases](~~85543~~).', 'type' => 'string', 'required' => false, 'example' => 'MySQL表级别恢复示例如下：'."\n" .'[{\\"DBName\\":\\"dbname\\", \\"NewDBName\\":\\"dbname1\\"}]', 'title' => ''], ], [ 'name' => 'RestoreTime', 'in' => 'query', 'schema' => ['description' => 'The point-in-time for the restore, specified as a UNIX timestamp in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1554560477000', 'title' => ''], ], [ 'name' => 'BackupSetId', 'in' => 'query', 'schema' => ['description' => 'The ID of the full backup set to use for the restore. The `BackupSetId` and `RestoreTime` parameters are mutually exclusive.', '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 SID of the Oracle database.'."\n" ."\n" .'> This parameter is required if the database engine is Oracle.', 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''], ], [ 'name' => 'RestoreDir', 'in' => 'query', 'schema' => ['description' => 'The restore directory. This parameter is required if **DestinationEndpointInstanceType** is set to `Agent` and the database type is MySQL.', 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''], ], [ 'name' => 'RestoreHome', 'in' => 'query', 'schema' => ['description' => 'The installation directory of the database.', 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''], ], [ 'name' => 'DuplicateConflict', 'in' => 'query', 'schema' => ['description' => 'The policy for resolving same-name object conflicts. Valid value:'."\n" ."\n" .'**renamenew**: Renames the restored object if its name conflicts with an existing object.', 'type' => 'string', 'required' => false, 'example' => 'renamenew', 'title' => ''], ], [ 'name' => 'CrossAliyunId', 'in' => 'query', 'schema' => ['description' => 'The ID of the Alibaba Cloud account that owns the source database. This parameter is required for cross-account restores.', 'type' => 'string', 'required' => false, 'example' => '2749528728********', 'title' => ''], ], [ 'name' => 'CrossRoleName', 'in' => 'query', 'schema' => ['description' => 'The name of the RAM role used for the cross-account restore.', 'type' => 'string', 'required' => false, 'example' => 'test123', 'title' => ''], ], [ 'name' => 'ClientToken', 'in' => 'query', 'schema' => ['description' => 'A client-generated token to ensure request idempotence. This token must be unique across requests.', 'type' => 'string', 'required' => false, 'example' => 'ETnLKlblzczshOTUbOC********', 'title' => ''], ], [ 'name' => 'RestoreDestinationMode', 'in' => 'query', 'schema' => ['description' => 'The type of the restore destination. Valid values:'."\n" ."\n" .'- **EXIST\\_INSTANCE**: Restores data to an existing instance.'."\n" ."\n" .'- **NEW\\_INSTANCE**: Restores data to a new instance.', 'type' => 'string', 'example' => 'EXIST_INSTANCE', 'title' => '', 'required' => false], ], [ 'name' => 'EnableDestinationEndpointSsl', 'in' => 'query', 'schema' => ['description' => 'Specifies whether to enable SSL encryption to connect to the destination database.', 'type' => 'boolean', 'title' => '', 'required' => false, 'example' => 'true'], ], [ 'name' => 'SslCaPem', 'in' => 'query', 'schema' => ['description' => 'The SSL certificate used to connect to the destination database.> This parameter is required when `EnableDestinationEndpointSsl` is set to `true`.', 'type' => 'string', 'example' => '-----BEGIN CERTIFICATE----- ... -----END CERTIFICATE-----', 'title' => '', 'required' => false], ], [ 'name' => 'DestDatabaseInstanceType', 'in' => 'query', 'schema' => ['description' => 'The type of the new instance to create for the restore.> This parameter is required when `RestoreDestinationMode` is set to `NEW_INSTANCE`.', 'type' => 'string', 'example' => 'rds', 'title' => '', 'required' => false], ], [ 'name' => 'DestDatabaseInstanceRegion', 'in' => 'query', 'schema' => ['description' => 'The region where the new instance will be created.> This parameter is required when `RestoreDestinationMode` is set to `NEW_INSTANCE`.', 'type' => 'string', 'example' => 'cn-beijing', 'title' => '', 'required' => false], ], [ 'name' => 'DestDatabaseInstanceVpc', 'in' => 'query', 'schema' => ['description' => 'The VPC ID of the new instance.> This parameter is required when `RestoreDestinationMode` is set to `NEW_INSTANCE`.', 'type' => 'string', 'example' => 'vpc-xx', 'title' => '', 'required' => false], ], [ 'name' => 'DestDatabaseInstanceClass', 'in' => 'query', 'schema' => ['description' => 'The instance type of the new instance.> This parameter is required when `RestoreDestinationMode` is set to `NEW_INSTANCE`.', 'type' => 'string', 'example' => 'mysql.x4.large.2', 'title' => '', 'required' => false], ], [ 'name' => 'DestDatabaseInstanceStorageSize', 'in' => 'query', 'schema' => ['description' => 'The storage space of the new instance. Unit: GB.> This parameter is required when `RestoreDestinationMode` is set to `NEW_INSTANCE`.', 'type' => 'string', 'example' => '500', 'title' => '', 'required' => false], ], [ 'name' => 'DestDatabaseInstanceVSwitch', 'in' => 'query', 'schema' => ['description' => 'The vSwitch ID of the new instance.> This parameter is required when `RestoreDestinationMode` is set to `NEW_INSTANCE`.', 'type' => 'string', 'required' => false, 'example' => 'vsw-xx', 'title' => ''], ], [ 'name' => 'DestDatabaseInstanceDatabaseVersion', 'in' => 'query', 'schema' => ['description' => 'The database engine version of the new instance.> This parameter is required when `RestoreDestinationMode` is set to `NEW_INSTANCE`.', 'type' => 'string', 'required' => false, 'example' => '8.0', 'title' => ''], ], [ 'name' => 'AutoOpenDatabase', 'in' => 'query', 'schema' => ['description' => 'Specifies whether to automatically start the Oracle instance after restoring a physical backup. Valid values: `true` and `false`.', 'type' => 'string', 'required' => false, 'example' => 'true', 'title' => ''], ], [ 'name' => 'AutoShutdownDatabase', 'in' => 'query', 'schema' => ['description' => 'Specifies whether to automatically stop the Oracle instance before restoring a physical backup. Valid values: `true` and `false`.', 'type' => 'string', 'required' => false, 'example' => 'true', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response object.', 'type' => 'object', 'properties' => [ 'HttpStatusCode' => ['description' => 'The HTTP status code returned for the request.', '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 returned if the request fails.', 'type' => 'string', 'example' => 'Param.NotFound', 'title' => ''], 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', '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' => ''], 'RestoreTaskId' => ['description' => 'The ID of the restore task.', 'type' => 'string', 'example' => 's102h*****', 'title' => ''], ], 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 403 => [ ['errorCode' => 'Request.Forbidden', 'errorMessage' => 'Have no Permissions', 'description' => ''], ], ], 'staticInfo' => ['returnType' => 'synchronous'], '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"}]', 'title' => 'CreateRestoreTask', 'description' => '### Related operations'."\n" ."\n" .'- [Recover databases](~~85543~~)'."\n" ."\n" .'- [Tutorials on configuring recovery for various database types](~~197144~~)', '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' => '*'], ], ], ], ], 'extraInfo' => ' ', ], '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 a DBS backup plan.', '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. You can specify multiple backup plan IDs, separated by commas.', 'type' => 'string', 'required' => false, 'example' => 'dbstooi01exXXXX', 'title' => ''], ], [ 'name' => 'Region', 'in' => 'query', 'schema' => ['description' => 'The ID of the region where the backup plan is located. You can call the [DescribeRegions](~~2869853~~) operation to query the list of supported regions.', '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" .'> The default value is **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. The default value is 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 is not started because a precheck failed.'."\n" ."\n" .'- **running**: The backup plan is running.'."\n" ."\n" .'- **stop**: The backup plan has failed.'."\n" ."\n" .'- **pause**: The backup plan is paused.'."\n" ."\n" .'- **locked**: The backup plan is locked.'."\n" ."\n" .'- **check\\_pass**: The precheck is passed.', 'type' => 'string', 'required' => false, 'example' => 'wait', 'title' => ''], ], [ 'name' => 'ClientToken', 'in' => 'query', 'schema' => ['description' => 'A client-generated token that ensures 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' => ''], ], [ 'name' => 'ShowStorageStrategyInfo', 'in' => 'query', 'schema' => ['description' => 'Specifies whether to return information about the storage strategy. Default value: false.', 'type' => 'boolean', 'default' => 'true', 'title' => '', 'required' => false, 'example' => 'false'], ], [ 'name' => 'ShowBackupStrategyInfo', 'in' => 'query', 'schema' => ['description' => 'Specifies whether to return information about the backup strategy. Default value: false.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], ], [ 'name' => 'ShowRecoverTimeRange', 'in' => 'query', 'schema' => ['description' => 'Specifies whether to return the recovery time range. Default value: false.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], ], [ 'name' => 'BackupMethod', 'in' => 'query', 'schema' => ['description' => 'The backup method.', 'type' => 'string', 'example' => 'logical', 'title' => '', 'required' => false], ], ], '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.', '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 per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '30', 'title' => ''], 'Items' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'BackupPlanDetail' => [ 'description' => 'A list of the backup plans.', 'type' => 'array', 'items' => [ 'description' => 'The details of a backup plan.', 'type' => 'object', 'properties' => [ 'CrossRoleName' => ['description' => 'The name of the RAM role for cross-account backups.', 'type' => 'string', 'example' => 'test123', 'title' => ''], 'SourceEndpointInstanceType' => ['description' => 'The type of the source endpoint. Valid values:'."\n" ."\n" .'- **rds**'."\n" ."\n" .'- **ecs**'."\n" ."\n" .'- **express**: A database connected over an Express Connect circuit, a VPN Gateway, or a Smart Access Gateway instance.'."\n" ."\n" .'- **agent**: A database connected by a backup gateway.'."\n" ."\n" .'- **dds**: An ApsaraDB for MongoDB instance.'."\n" ."\n" .'- **other**: A database connected by an IP address and a port number.', 'type' => 'string', 'example' => 'rds', 'title' => ''], 'BackupSetDownloadDir' => ['description' => 'The server directory for downloaded backup sets.', 'type' => 'string', 'example' => '*/test/test123', 'title' => ''], 'SourceEndpointIpPort' => ['description' => 'The endpoint of the source database.', 'type' => 'string', 'example' => '100.*.*.10:33204', 'title' => ''], 'CrossAliyunId' => ['description' => 'The user ID for cross-account backups.', 'type' => 'string', 'example' => '2xxx7778xxxxxxxxxx', 'title' => ''], 'DuplicationArchivePeriod' => ['description' => 'The number of days after which a duplicate backup is converted to archive storage.', '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 restorable time period. This value is a UNIX timestamp in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1554560477000', 'title' => ''], 'BackupPlanStatus' => ['description' => 'The status of the backup plan. Valid values:'."\n" ."\n" .'- **wait**: The plan is not configured.'."\n" ."\n" .'- **init**: The plan has not started because a precheck failed.'."\n" ."\n" .'- **running**: The plan is running.'."\n" ."\n" .'- **stop**: The plan failed.'."\n" ."\n" .'- **pause**: The plan is paused.'."\n" ."\n" .'- **locked**: The plan is locked.'."\n" ."\n" .'- **check\\_pass**: The precheck passed.', 'type' => 'string', 'example' => 'init', 'title' => ''], 'BackupSetDownloadFullDataFormat' => ['description' => 'The data format for downloading full backup sets. Valid values:'."\n" ."\n" .'- **Native**'."\n" ."\n" .'- **SQL**'."\n" ."\n" .'- **CSV**'."\n" ."\n" .'- **JSON**', 'type' => 'string', 'example' => 'SQL', 'title' => ''], 'BackupRetentionPeriod' => ['description' => 'The backup retention period, in days. Valid values: 0 to 1825.', '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 storage type of the backup data. Valid values:'."\n" ."\n" .'- Empty string (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**: Duplicate backup', 'type' => 'string', 'example' => 'logical', 'title' => ''], 'SourceEndpointRegion' => ['description' => 'The region of the source database.', 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''], 'BackupPeriod' => ['description' => 'The day of the week for full backups. 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 source database.', 'type' => 'string', 'example' => 'test', 'title' => ''], 'BackupSetDownloadGatewayId' => ['description' => 'The ID of the backup gateway used to download the backup set.', 'type' => 'integer', 'format' => 'int64', 'example' => '123123', 'title' => ''], 'BackupPlanCreateTime' => ['description' => 'The creation time of the backup plan. This value is a UNIX timestamp in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1582527713000', 'title' => ''], 'InstanceClass' => ['description' => 'The instance class. Valid values:'."\n" ."\n" .'- **micro**: Entry-level'."\n" ."\n" .'- **small**: Low-spec'."\n" ."\n" .'- **medium**: Medium-spec'."\n" ."\n" .'- **large**: High-spec'."\n" ."\n" .'- **xlarge**: High-spec (no traffic limit)', 'type' => 'string', 'example' => 'micro', 'title' => ''], 'BackupSetDownloadTargetType' => ['description' => 'The target type for backup set downloads.'."\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 backup data is converted to Infrequent Access storage.', 'type' => 'integer', 'format' => 'int32', 'example' => '180', 'title' => ''], 'BackupStartTime' => ['description' => 'The start time for full backups. The time is in the HH:mm format.', 'type' => 'string', 'example' => '14:22', 'title' => ''], 'ErrMessage' => ['description' => 'The error message returned by the precheck task.', 'type' => 'string', 'example' => ' can not connect to oracle instance orcl with user dbs', 'title' => ''], 'BackupObjects' => ['description' => 'The backup objects, specified in a JSON string.', 'type' => 'string', 'example' => '[ { \\"DBName\\":\\"待备份库名\\", \\"SchemaName\\":\\"待备份 Schema 名\\", \\"TableIncludes\\":[{ \\"TableName\\":\\"待备份表表名\\" }], \\"TableExcludes\\":[{ \\"TableName\\":\\"待备份库名不需要备份表的表名\\" }] } ]', 'title' => ''], 'BeginTimestampForRestore' => ['description' => 'The beginning of the restorable time period. This value is a UNIX timestamp in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1554560477000', 'title' => ''], 'SourceEndpointInstanceID' => ['description' => 'The ID of the source database instance.', 'type' => 'string', 'example' => 'test', 'title' => ''], 'OpenBackupSetAutoDownload' => ['description' => 'Indicates whether automatic download of 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 username of the source database account.', 'type' => 'string', 'example' => 'test', 'title' => ''], 'BackupSetDownloadIncrementDataFormat' => ['description' => 'The data format for downloading incremental backup sets. Valid values:'."\n" ."\n" .'- **Native**'."\n" ."\n" .'- **SQL**'."\n" ."\n" .'- **CSV**'."\n" ."\n" .'- **JSON**', 'type' => 'string', 'example' => 'SQL', 'title' => ''], 'EnableBackupLog' => ['description' => 'Indicates whether 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 type of the source database.', 'type' => 'string', 'example' => 'MySQL', 'title' => ''], 'BackupPlanRegion' => ['description' => 'The region of the backup plan.', 'type' => 'string', 'example' => 'cn-beijing', 'title' => ''], 'SourceEndpointHost' => ['description' => 'The source endpoint address.', 'type' => 'string', 'example' => '127.0.0.1', 'title' => ''], 'InstanceChargeType' => ['description' => 'The billing method of the backup plan instance.', 'type' => 'string', 'example' => 'PREPAY', 'title' => ''], 'InstanceExpiredTimestamp' => ['description' => 'The expiration time of the backup plan instance. This value is a UNIX timestamp in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1764051253000', 'title' => ''], 'SourceEndpointEnableSsl' => ['description' => 'Indicates whether SSL encryption is enabled for the source database.', 'type' => 'string', 'example' => 'true', 'title' => ''], 'StorageEncryptMethod' => ['description' => 'The encryption method for the backup storage.', 'type' => 'string', 'example' => 'encrypted', 'title' => ''], 'SourceEndpointPort' => ['description' => 'The port number of the source database.', 'type' => 'string', 'example' => '3306', 'title' => ''], 'IncrementBackupRetentionPeriod' => ['description' => 'The retention period for incremental backups, in days.', 'type' => 'string', 'example' => '365', 'title' => ''], 'IncrementDuplicationInfrequentAccessPeriod' => ['description' => 'The number of days after which incremental backups are converted to Infrequent Access storage.', 'type' => 'string', 'example' => '365', 'title' => ''], 'IncrementDuplicationArchivePeriod' => ['description' => 'The number of days after which incremental backups are converted to archive storage.', 'type' => 'string', 'example' => '365', 'title' => ''], 'LogBackupRetentionPeriod' => ['description' => 'The retention period for log backups, in days.', 'type' => 'string', 'example' => '365', 'title' => ''], 'LogDuplicationInfrequentAccessPeriod' => ['description' => 'The number of days after which log backups are converted to Infrequent Access storage.', 'type' => 'string', 'example' => '365', 'title' => ''], 'LogDuplicationArchivePeriod' => ['description' => 'The number of days after which log backups are converted to archive storage.', 'type' => 'string', 'example' => '365', 'title' => ''], 'BackupGatewayIdentifier' => ['description' => 'The unique ID of the backup gateway.', 'type' => 'string', 'example' => 'TESTGATEWAY', 'title' => ''], 'EnableMysqlPhysicalBackupBinLog' => ['description' => 'Indicates whether log backup is enabled for MySQL physical backups.', 'type' => 'boolean', 'title' => '', 'example' => 'false'], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'description' => 'The response items.', 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 403 => [ ['errorCode' => 'Request.Forbidden', 'errorMessage' => 'Have no Permissions', 'description' => ''], ], ], '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 \\"BackupPlanRegion\\": \\"cn-beijing\\",\\n \\"SourceEndpointHost\\": \\"127.0.0.1\\",\\n \\"InstanceChargeType\\": \\"PREPAY\\",\\n \\"InstanceExpiredTimestamp\\": 1764051253000,\\n \\"SourceEndpointEnableSsl\\": \\"true\\",\\n \\"StorageEncryptMethod\\": \\"encrypted\\",\\n \\"SourceEndpointPort\\": \\"3306\\",\\n \\"IncrementBackupRetentionPeriod\\": \\"365\\",\\n \\"IncrementDuplicationInfrequentAccessPeriod\\": \\"365\\",\\n \\"IncrementDuplicationArchivePeriod\\": \\"365\\",\\n \\"LogBackupRetentionPeriod\\": \\"365\\",\\n \\"LogDuplicationInfrequentAccessPeriod\\": \\"365\\",\\n \\"LogDuplicationArchivePeriod\\": \\"365\\",\\n \\"BackupGatewayIdentifier\\": \\"TESTGATEWAY\\",\\n \\"EnableMysqlPhysicalBackupBinLog\\": false\\n }\\n ]\\n }\\n}","type":"json"}]', 'title' => 'DescribeBackupPlanList', 'description' => 'Ensure Object Storage Service (OSS) is enabled before you use this operation. 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}'], ], ], ], ], ], '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' => 'BackupPlan', 'arn' => 'acs:dbs:{#regionId}:{#accountId}:backupplan/{#BackupPlanId}'], ], ], ], ], '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' => [ 'summary' => 'This operation lists full backup jobs in Database Backup (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.', '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 of the page 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' => 'ClientToken', 'in' => 'query', 'schema' => ['description' => 'A token that you can use to ensure the idempotence of the request.', 'type' => 'string', 'required' => false, 'example' => 'ETnLKlblzczshOTUbOCzxxxxxxx', 'title' => ''], ], [ 'name' => 'ShowStorageType', 'in' => 'query', 'schema' => ['description' => 'Specifies whether to return the storage type of the backup set.', '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 beginning of the time range to query. This value is a UNIX timestamp representing the number of seconds that have elapsed since January 1, 1970, 00:00:00 UTC.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1676887100', 'title' => ''], ], [ 'name' => 'EndTimestamp', 'in' => 'query', 'schema' => ['description' => 'The end of the time range to query. This value is a UNIX timestamp representing the number of seconds that have elapsed since January 1, 1970, 00:00:00 UTC.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1676887128', 'title' => ''], ], [ 'name' => 'ShowProgress', 'in' => 'query', 'schema' => ['description' => 'Specifies whether to return real-time information about the backup progress.', 'type' => 'string', 'example' => 'true', 'default' => 'false', 'title' => '', 'required' => false], ], [ 'name' => 'BackupSetStatus', 'in' => 'query', 'schema' => ['description' => 'The status of the backup set. You can use this parameter to filter backup sets.', 'type' => 'string', 'example' => 'finish', 'title' => '', 'required' => false], ], ], '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.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'RequestId' => ['description' => 'The request ID.', '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.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'TotalElements' => ['description' => 'The total number of full backup sets.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'PageSize' => ['description' => 'The number of entries 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 sets.', 'title' => '', 'type' => 'array', 'items' => [ 'description' => 'The details of a full backup set.', 'type' => 'object', 'properties' => [ 'FinishTime' => ['description' => 'The time when the backup task was complete. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.', 'type' => 'integer', 'format' => 'int64', 'example' => '1676887128000', 'title' => ''], 'BackupStatus' => ['description' => 'The status of the backup task. Valid values:'."\n" ."\n" .'- **schedule**: The backup task is pending.'."\n" ."\n" .'- **running**: The backup task is in progress.'."\n" ."\n" .'- **finish**: The backup task is complete.'."\n" ."\n" .'- **stop**: The backup task failed.'."\n" ."\n" .'- **pause**: The backup task is paused.', 'type' => 'string', 'example' => 'finish', 'title' => ''], 'SourceEndpointIpPort' => ['description' => 'The endpoint that is used to connect to the database.', 'type' => 'string', 'example' => '121.XXX.XXX.144:3306', 'title' => ''], 'CreateTime' => ['description' => 'The time when the backup task was created. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.', 'type' => 'integer', 'format' => 'int64', 'example' => '1676886947000', 'title' => ''], 'ErrMessage' => ['description' => 'The error message that is returned if the backup task fails.', 'type' => 'string', 'example' => 'NULL', 'title' => ''], 'BackupObjects' => ['description' => 'The backup objects.', 'type' => 'string', 'example' => '[{\\"DBName\\":\\"test\\"}]', 'title' => ''], 'EndTime' => ['description' => 'The time when the backup was complete. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.', 'type' => 'integer', 'format' => 'int64', 'example' => '1676887128000', 'title' => ''], 'StartTime' => ['description' => 'The time when the backup started. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.', 'type' => 'integer', 'format' => 'int64', 'example' => '1676887100000', 'title' => ''], 'BackupSetExpiredTime' => ['description' => 'The time when the backup set expires. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.', 'type' => 'integer', 'format' => 'int64', 'example' => '1677491900000', 'title' => ''], 'StorageMethod' => ['description' => 'The storage class of the backup set. Valid values:'."\n" ."\n" .'- **Standard**'."\n" ."\n" .'- **IA**: infrequent access'."\n" ."\n" .'- **Archive**'."\n" ."\n" .'- **UNKNOWN**: This value is returned if the storage class is not obtained.', 'type' => 'string', 'example' => 'Standard', 'title' => ''], 'BackupSetId' => ['description' => 'The ID of the backup set.', 'type' => 'string', 'example' => '1iukx5h******', 'title' => ''], 'BackupSize' => ['description' => 'The size of the backup set in bytes.', 'type' => 'integer', 'format' => 'int64', 'example' => '580', 'title' => ''], 'SourceEndpointInstanceType' => ['description' => 'The instance type of the source database.', 'type' => 'string', 'example' => 'rds', 'title' => ''], 'SourceEndpointInstanceId' => ['description' => 'The ID of the source instance.', 'type' => 'string', 'example' => 'rm-testxx', 'title' => ''], 'SourceEndpointRegion' => ['description' => 'The region in which the source instance resides.', 'type' => 'string', 'example' => 'cn-beijing', 'title' => ''], 'SourceEndpointHost' => ['description' => 'The endpoint of the source database.', 'type' => 'string', 'example' => '127.0.0.1', 'title' => ''], 'StorageEncryptMethod' => ['description' => 'The encryption method of the backup storage.', 'type' => 'string', 'example' => 'encrypted', 'title' => ''], 'CrossRoleName' => ['description' => 'The name of the RAM role that is created for cross-account backup.', 'type' => 'string', 'example' => 'ram-for-dbs', 'title' => ''], 'CrossAliyunId' => ['description' => 'The ID of the Alibaba Cloud account that is used for cross-account backup.', 'type' => 'string', 'example' => '2xxx7778xxxxxxxxxx', 'title' => ''], 'SourceEndpointEnableSsl' => ['description' => 'Indicates whether the SSL encryption is enabled for the source database.', 'type' => 'string', 'example' => 'true', 'title' => ''], 'LogicalStructureBackupProgress' => ['description' => 'The progress of the logical schema backup.', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''], 'LogicalFullBackupProgress' => ['description' => 'The progress of the logical full backup.', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''], 'BackupGatewayIdentifier' => ['description' => 'The ID of the backup gateway.', 'type' => 'string', 'example' => 'TESTGATEWAY', 'title' => ''], 'SourceEndpointUserName' => ['description' => 'The username of the source database.', 'type' => 'string', 'example' => 'dbs_backup', 'title' => ''], 'SourceEndpointPort' => ['description' => 'The port number of the source database.', 'type' => 'string', 'example' => '3306', 'title' => ''], ], 'title' => '', 'example' => '', ], 'example' => '', ], ], 'description' => 'The details of the full backup sets.', 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 403 => [ ['errorCode' => 'Request.Forbidden', 'errorMessage' => 'Have no Permissions', 'description' => ''], ], ], '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 \\"SourceEndpointInstanceType\\": \\"rds\\",\\n \\"SourceEndpointInstanceId\\": \\"rm-testxx\\",\\n \\"SourceEndpointRegion\\": \\"cn-beijing\\",\\n \\"SourceEndpointHost\\": \\"127.0.0.1\\",\\n \\"StorageEncryptMethod\\": \\"encrypted\\",\\n \\"CrossRoleName\\": \\"ram-for-dbs\\",\\n \\"CrossAliyunId\\": \\"2xxx7778xxxxxxxxxx\\",\\n \\"SourceEndpointEnableSsl\\": \\"true\\",\\n \\"LogicalStructureBackupProgress\\": 100,\\n \\"LogicalFullBackupProgress\\": 100,\\n \\"BackupGatewayIdentifier\\": \\"TESTGATEWAY\\",\\n \\"SourceEndpointUserName\\": \\"dbs_backup\\",\\n \\"SourceEndpointPort\\": \\"3306\\"\\n }\\n ]\\n }\\n}","type":"json"}]', 'title' => 'DescribeFullBackupList', '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' => 'BackupPlan', 'arn' => 'acs:dbs:{#regionId}:{#accountId}:backupplan/{#BackupPlanId}'], ], ], ], ], ], 'DescribeIncrementBackupList' => [ 'summary' => 'This operation queries the list of incremental backup tasks for 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 this ID.', 'type' => 'string', 'required' => true, 'example' => 'dbsqdss5tmh****', 'title' => ''], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => ['description' => 'The number of entries per page. Valid values: 30, 50, and 100.'."\n" ."\n" .'> Default value: 30.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '30', 'title' => ''], ], [ 'name' => 'PageNum', 'in' => 'query', 'schema' => ['description' => 'The page number. The value starts from 0, and the default is 0.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], ], [ 'name' => 'ClientToken', 'in' => 'query', 'schema' => ['description' => 'A client-generated token that ensures the idempotence of the request.', 'type' => 'string', 'required' => false, 'example' => 'ETnLKlblzczshOTUbOCzxxxxxxx', 'title' => ''], ], [ 'name' => 'ShowStorageType', 'in' => 'query', 'schema' => ['description' => 'Specifies whether to return 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 start timestamp of the backup query time range, in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1570701361528', 'title' => ''], ], [ 'name' => 'EndTimestamp', 'in' => 'query', 'schema' => ['description' => 'The end timestamp of the backup query time range, in milliseconds.', '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 succeeded. Valid values:'."\n" ."\n" .'- **true**: The request succeeded.'."\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 backups.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'PageSize' => ['description' => 'The page size.', 'type' => 'integer', 'format' => 'int32', 'example' => '30', 'title' => ''], 'Items' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'IncrementBackupFile' => [ 'description' => 'An array of objects. Each object contains details about an incremental backup.', 'type' => 'array', 'items' => [ 'description' => 'The details of the incremental backup.', 'type' => 'object', 'properties' => [ 'EndTime' => ['description' => 'The end time of the backup, represented as a timestamp in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1648434713000', 'title' => ''], 'BackupSetExpiredTime' => ['description' => 'The expiration time of the backup set, represented as a timestamp in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1711506719000', 'title' => ''], 'StartTime' => ['description' => 'The start time of the backup, represented as a timestamp in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1648433764000', 'title' => ''], 'StorageMethod' => ['description' => 'The storage class. Valid values:'."\n" ."\n" .'- **Standard**: Standard storage.'."\n" ."\n" .'- **IA**: Infrequent Access (IA)'."\n" ."\n" .'- **Archive**: Archive storage.'."\n" ."\n" .'- **UNKNOWN**: Unknown. This value is typically returned when the backup 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 backup status. Valid values:'."\n" ."\n" .'- **INIT**: Not started'."\n" ."\n" .'- **FILLING**: In progress'."\n" ."\n" .'- **COMPLETED**: Completed'."\n" ."\n" .'- **UNCOMPLETED**: Incomplete', 'type' => 'string', 'example' => 'FILLING', 'title' => ''], 'SourceEndpointIpPort' => ['description' => 'The source database endpoint.', 'type' => 'string', 'example' => '172.1XX.103.1:4XXX', 'title' => ''], 'BackupSize' => ['description' => 'The backup size, in bytes.', 'type' => 'integer', 'format' => 'int64', 'example' => '18535', 'title' => ''], 'SourceEndpointInstanceType' => ['description' => 'The type of the source database instance.', 'type' => 'string', 'example' => 'rds', 'title' => ''], 'SourceEndpointInstanceId' => ['description' => 'The ID of the source database instance.', 'type' => 'string', 'example' => 'rm-testxx', 'title' => ''], 'SourceEndpointRegion' => ['description' => 'The region of the source database instance.', 'type' => 'string', 'example' => 'cn-beijing', 'title' => ''], 'SourceEndpointHost' => ['description' => 'The hostname or IP address of the source database.', 'type' => 'string', 'example' => '127.0.0.1', 'title' => ''], 'SourceEndpointPort' => ['description' => 'The port number of the source database.', 'type' => 'string', 'example' => '3306', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 403 => [ ['errorCode' => 'Request.Forbidden', 'errorMessage' => 'Have no Permissions', 'description' => ''], ], ], '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 \\"SourceEndpointInstanceType\\": \\"rds\\",\\n \\"SourceEndpointInstanceId\\": \\"rm-testxx\\",\\n \\"SourceEndpointRegion\\": \\"cn-beijing\\",\\n \\"SourceEndpointHost\\": \\"127.0.0.1\\",\\n \\"SourceEndpointPort\\": \\"3306\\"\\n }\\n ]\\n }\\n}","type":"json"}]', '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' => 'BackupPlan', 'arn' => 'acs:dbs:{#regionId}:{#accountId}:backupplan/{#BackupPlanId}'], ], ], ], ], ], 'DescribeJobErrorCode' => [ 'summary' => 'Queries error code information for a Database Backup (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' => '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 request ID.', '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' => 'BackupPlan', 'arn' => 'acs:dbs:{#regionId}:{#accountId}:backupplan/{#BackupPlanId}'], ], ], ], ], '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' => 'This operation returns the time ranges available for restoring data from a backup plan.', '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 [DescribeBackupPlanList](~~2869825~~) to get this value.', 'type' => 'string', 'required' => true, 'example' => 'dbssl67c7mx****', 'title' => ''], ], [ 'name' => 'BeginTimestampForRestore', 'in' => 'query', 'schema' => ['description' => 'The start timestamp of the restorable time range.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1646674092000', 'title' => ''], ], [ 'name' => 'EndTimestampForRestore', 'in' => 'query', 'schema' => ['description' => 'The end timestamp of the restorable time range.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1646846814000', 'title' => ''], ], [ 'name' => 'ClientToken', 'in' => 'query', 'schema' => ['description' => 'A client token that ensures the idempotence of the request.', 'type' => 'string', 'required' => false, 'example' => 'ETnLKlblzczshOTUbOCzxxxxxxx', 'title' => ''], ], [ 'name' => 'RecentlyRestore', 'in' => 'query', 'schema' => ['description' => 'Specifies whether to enable recent restore.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The returned information.', 'type' => 'object', 'properties' => [ 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'E2BD9DFC-6760-5F49-97C5-DA739E29****', 'title' => ''], 'ErrCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'Param.NotFound', 'title' => ''], 'Success' => ['description' => 'Specifies whether the request succeeded. 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' => [ 'DBSRecoverRange' => [ 'description' => 'A list of restorable time ranges.', 'type' => 'array', 'items' => [ 'description' => 'Details of a restorable time range.', 'type' => 'object', 'properties' => [ 'EndTimestampForRestore' => ['description' => 'The end of the restorable time range. The value is a UNIX timestamp. Unit: milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1646760308000', 'title' => ''], 'SourceEndpointInstanceType' => ['description' => 'The type of the source database. This parameter is deprecated. Use `BackupSourceInstanceType` instead.', 'type' => 'string', 'example' => 'rds', 'title' => ''], 'RangeType' => ['description' => 'The type of the restorable time range. Valid values:'."\n" ."\n" .'- **point**: a discrete point in time that corresponds to a full backup.'."\n" ."\n" .'- **range**: a continuous time range. You can restore data to any point in time within this range.', 'type' => 'string', 'example' => 'point', 'title' => ''], 'BeginTimestampForRestore' => ['description' => 'The beginning of the restorable time range. The value is a UNIX timestamp. Unit: milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1646760282000', 'title' => ''], 'SourceEndpointInstanceID' => ['description' => 'The ID of the source database instance. This parameter is deprecated. Use `BackupSourceInstanceId` instead.', 'type' => 'string', 'example' => 'rm-bp106x9tk2c91****', 'title' => ''], 'FullBackupList' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'FullBackupDetail' => [ 'description' => 'The information about the full backup files at discrete time points. This parameter is returned only when `RangeType` is set to `point`.', 'type' => 'array', 'items' => [ 'description' => 'The details of a full backup file.', 'type' => 'object', 'properties' => [ 'EndTime' => ['description' => 'The time when the full backup ended. The value is a UNIX timestamp. Unit: milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1646760308000', 'title' => ''], 'StartTime' => ['description' => 'The time when the full backup started. The value is a UNIX timestamp. Unit: milliseconds.', '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' => '', ], 'BackupSourceInstanceType' => ['description' => 'The type of the backup source.', 'type' => 'string', 'example' => 'rds', 'title' => ''], 'BackupSourceInstanceId' => ['description' => 'The ID of the backup source.', 'type' => 'string', 'example' => 'rm-testxx', 'title' => ''], 'BackupSourceHost' => ['description' => 'The endpoint of the backup source.', 'type' => 'string', 'example' => '127.0.0.1', 'title' => ''], 'BackupSourcePort' => ['description' => 'The port number of the backup source.', 'type' => 'string', 'example' => '3306', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'description' => 'The detailed data.', 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 403 => [ ['errorCode' => 'Request.Forbidden', 'errorMessage' => 'Have no Permissions', 'description' => ''], ], ], '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 \\"BackupSourceInstanceType\\": \\"rds\\",\\n \\"BackupSourceInstanceId\\": \\"rm-testxx\\",\\n \\"BackupSourceHost\\": \\"127.0.0.1\\",\\n \\"BackupSourcePort\\": \\"3306\\"\\n }\\n ]\\n }\\n}","type":"json"}]', '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' => 'BackupPlan', 'arn' => 'acs:dbs:{#regionId}:{#accountId}:backupplan/{#BackupPlanId}'], ], ], ], ], ], 'DescribeRestoreTaskList' => [ 'summary' => 'Queries restore jobs 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.'."\n" ."\n" .'> You must specify either this parameter or `RestoreTaskId`.', 'type' => 'string', 'required' => false, 'example' => 'dbs1hvb0wwwXXXXX', 'title' => ''], ], [ 'name' => 'RestoreTaskId', 'in' => 'query', 'schema' => ['description' => 'The ID of the restore task. You can specify multiple IDs, separated by commas. You can call the [CreateRestoreTask](~~2869836~~) operation to obtain the restore task ID.'."\n" ."\n" .'> You must specify either this parameter or `BackupPlanId`. Specifying both parameters returns an error.', '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. Default value: 0.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], ], [ 'name' => 'ClientToken', 'in' => 'query', 'schema' => ['description' => 'A client-generated token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests.', 'type' => 'string', 'required' => false, 'example' => 'ETnLKlblzczshOTUbOCzxxxxxxx', 'title' => ''], ], [ 'name' => 'StartTimestamp', 'in' => 'query', 'schema' => ['description' => 'The beginning of the time range to query restore tasks. Specify the time in the UNIX timestamp format. The timestamp is a millisecond-level timestamp.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1570701361528', 'title' => ''], ], [ 'name' => 'EndTimestamp', 'in' => 'query', 'schema' => ['description' => 'The end of the time range to query restore tasks. Specify the time in the UNIX timestamp format. The timestamp is a millisecond-level timestamp.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1570701361528', '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.', '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 returned.', '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 returned per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '30', 'title' => ''], 'Items' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'RestoreTaskDetail' => [ 'description' => 'The details of the restore jobs.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'RestoreStatus' => ['description' => 'The status of the restore job. Valid values:'."\n" ."\n" .'- **init**: The restore job is initializing or the precheck has failed.'."\n" ."\n" .'- **running**: The restore job is running.'."\n" ."\n" .'- **stop**: The restore job has failed.'."\n" ."\n" .'- **pause**: The restore job is paused.'."\n" ."\n" .'- **check\\_pass**: The precheck was successful.', 'type' => 'string', 'example' => 'running', 'title' => ''], 'FullStruAfterRestoreProgress' => ['description' => 'The progress of the post-restore full schema restoration.', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''], 'CrossRoleName' => ['description' => 'The name of the RAM role used for cross-account backup.', 'type' => 'string', 'example' => 'test123', 'title' => ''], 'RestoreDir' => ['description' => 'The restore path.', 'type' => 'string', 'example' => '/home/test', 'title' => ''], 'CrossAliyunId' => ['description' => 'The UID of the Alibaba Cloud account used for cross-account backup.', 'type' => 'string', 'example' => '2xxx7778xxxxxxxxxx', 'title' => ''], 'RestoreObjects' => ['description' => 'The restore objects.', 'type' => 'string', 'example' => '[ { \\"DBName\\":\\"test\\" } ]', 'title' => ''], 'BackupPlanId' => ['description' => 'The ID of the backup plan.', 'type' => 'string', 'example' => 'dbsxxxx', 'title' => ''], 'DestinationEndpointRegion' => ['description' => 'The region of the destination instance.', 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''], 'RestoreTaskCreateTime' => ['description' => 'The time when the restore job was created, represented as a UNIX timestamp in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1554560477000', 'title' => ''], 'DestinationEndpointUserName' => ['description' => 'The database account of the destination endpoint.', 'type' => 'string', 'example' => 'testUser', 'title' => ''], 'RestoreTaskFinishTime' => ['description' => 'The time when the restore job was completed, represented as a UNIX timestamp in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1554560477000', 'title' => ''], 'DestinationEndpointIpPort' => ['description' => 'The connection address of the destination database instance.', 'type' => 'string', 'example' => '100.X.X.10:33204', 'title' => ''], 'DestinationEndpointDatabaseName' => ['description' => 'The database name of the destination endpoint.', 'type' => 'string', 'example' => 'test', 'title' => ''], 'DestinationEndpointInstanceType' => ['description' => 'The type of destination instance. Valid values:'."\n" ."\n" .'- **RDS**'."\n" ."\n" .'- **ECS**'."\n" ."\n" .'- **Express**: A database connected via Express Connect, VPN Gateway, or Smart Access Gateway.'."\n" ."\n" .'- **Agent**: A database connected via a backup gateway.'."\n" ."\n" .'- **DDS**: An ApsaraDB for MongoDB instance.'."\n" ."\n" .'- **Other**: A database connected over the internet via an IP address and port.'."\n" ."\n" .'- **dg**: A self-managed database without a public IP address, connected via Database Gateway (DG).', 'type' => 'string', 'example' => 'RDS', 'title' => ''], 'DestinationEndpointOracleSID' => ['description' => 'The Oracle SID.'."\n" ."\n" .'> This parameter is required for Oracle databases.', 'type' => 'string', 'example' => 'test', 'title' => ''], 'FullStruforeRestoreProgress' => ['description' => 'The progress of the pre-restore full schema restoration.', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''], 'ErrMessage' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'NULL', 'title' => ''], 'RestoreTaskId' => ['description' => 'The ID of the restore job.', 'type' => 'string', 'example' => '1iyixxxxxx', 'title' => ''], 'FullDataRestoreProgress' => ['description' => 'The progress of the full data restoration.', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''], 'ContinuousRestoreProgress' => ['description' => 'The progress of the incremental log restoration.', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''], 'DestinationEndpointInstanceID' => ['description' => 'The ID of the destination instance.', 'type' => 'string', 'example' => 'rm-bp1p8c2947XXX', 'title' => ''], 'BackupSetId' => ['description' => 'The ID of the full backup set used for the restoration.', 'type' => 'string', 'example' => 'urjlfmxxxxx', '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' => 'dbsr1g3xxxx_Restore_Task_1775009514575', 'title' => ''], 'RestoreTime' => ['description' => 'The point in time to which the data is restored, represented as a UNIX timestamp in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1554560477000', 'title' => ''], 'DestinationEndpointHost' => ['description' => 'The IP address or domain name of the destination instance.', 'type' => 'string', 'example' => '127.0.0.1', 'title' => ''], 'DestinationEndpointPort' => ['description' => 'The port number of the destination database.', 'type' => 'string', 'example' => '3306', 'title' => ''], 'DestinationEndpointEnableSsl' => ['description' => 'Indicates whether the connection to the destination database is SSL-encrypted.', 'type' => 'string', 'example' => 'true', 'title' => ''], 'BackupGatewayIdentifier' => ['description' => 'The unique ID of the backup gateway for the destination endpoint.', 'type' => 'string', 'example' => 'TESTGATEWAY', 'title' => ''], 'BackupSourceOssRegion' => ['description' => 'The OSS region of the backup source.', 'type' => 'string', 'example' => 'cn-beijing', 'title' => ''], 'RestoreDestinationMode' => ['description' => 'The method used to restore data to the destination endpoint.', 'type' => 'string', 'example' => 'EXIST_INSTANCE', 'title' => ''], 'PhysicalFullBackupRecoverProgress' => ['description' => 'The progress of the full physical restore. This parameter is applicable to physical backups of MySQL and SQL Server.', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''], 'PhysicalFullAndIncrementBackupRecoverProgress' => ['description' => 'The progress of the full and incremental physical restore. This parameter is applicable to physical backups of MySQL.', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''], 'PhysicalIncrementBackupRecoverProgress' => ['description' => 'The progress of the incremental physical restore. This parameter is applicable to physical backups of SQL Server.', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''], 'PhysicalDatabaseOnlineProgress' => ['description' => 'The progress of bringing the database online after a physical restore. This parameter is applicable to physical backups of SQL Server.', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''], 'PhysicalBackupRecoverProgress' => ['description' => 'The progress of the physical restoration. This parameter is applicable to physical backups of Oracle.', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 403 => [ ['errorCode' => 'Request.Forbidden', 'errorMessage' => 'Have no Permissions', 'description' => ''], ], ], '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\\": \\"/home/test\\",\\n \\"CrossAliyunId\\": \\"2xxx7778xxxxxxxxxx\\",\\n \\"RestoreObjects\\": \\"[ { \\\\\\\\\\\\\\"DBName\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"test\\\\\\\\\\\\\\" } ]\\",\\n \\"BackupPlanId\\": \\"dbsxxxx\\",\\n \\"DestinationEndpointRegion\\": \\"cn-hangzhou\\",\\n \\"RestoreTaskCreateTime\\": 1554560477000,\\n \\"DestinationEndpointUserName\\": \\"testUser\\",\\n \\"RestoreTaskFinishTime\\": 1554560477000,\\n \\"DestinationEndpointIpPort\\": \\"100.X.X.10:33204\\",\\n \\"DestinationEndpointDatabaseName\\": \\"test\\",\\n \\"DestinationEndpointInstanceType\\": \\"RDS\\",\\n \\"DestinationEndpointOracleSID\\": \\"test\\",\\n \\"FullStruforeRestoreProgress\\": 100,\\n \\"ErrMessage\\": \\"NULL\\",\\n \\"RestoreTaskId\\": \\"1iyixxxxxx\\",\\n \\"FullDataRestoreProgress\\": 100,\\n \\"ContinuousRestoreProgress\\": 100,\\n \\"DestinationEndpointInstanceID\\": \\"rm-bp1p8c2947XXX\\",\\n \\"BackupSetId\\": \\"urjlfmxxxxx\\",\\n \\"BackupGatewayId\\": 324234332,\\n \\"RestoreTaskName\\": \\"dbsr1g3xxxx_Restore_Task_1775009514575\\",\\n \\"RestoreTime\\": 1554560477000,\\n \\"DestinationEndpointHost\\": \\"127.0.0.1\\",\\n \\"DestinationEndpointPort\\": \\"3306\\",\\n \\"DestinationEndpointEnableSsl\\": \\"true\\",\\n \\"BackupGatewayIdentifier\\": \\"TESTGATEWAY\\",\\n \\"BackupSourceOssRegion\\": \\"cn-beijing\\",\\n \\"RestoreDestinationMode\\": \\"EXIST_INSTANCE\\",\\n \\"PhysicalFullBackupRecoverProgress\\": 100,\\n \\"PhysicalFullAndIncrementBackupRecoverProgress\\": 100,\\n \\"PhysicalIncrementBackupRecoverProgress\\": 100,\\n \\"PhysicalDatabaseOnlineProgress\\": 100,\\n \\"PhysicalBackupRecoverProgress\\": 100\\n }\\n ]\\n }\\n}","type":"json"}]', 'title' => 'DescribeRestoreTaskList', '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' => 'BackupPlan', 'arn' => 'acs:dbs:{#regionId}:{#accountId}:backupplan/{#BackupPlanId}'], ], ], ], ], 'extraInfo' => ' ', ], 'DisableBackupLog' => [ 'summary' => 'Disable incremental backup for a 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. To get this ID, call the [DescribeBackupPlanList](~~2869825~~) operation.', 'type' => 'string', 'required' => true, 'example' => 'dbstooi01****', 'title' => ''], ], [ 'name' => 'ClientToken', 'in' => 'query', 'schema' => ['description' => 'A client token to ensure the idempotence of the request.', 'type' => 'string', 'required' => false, 'example' => 'ETnLKlblzczshOTUbOCziJZNwH****', 'title' => ''], ], [ 'name' => 'DisableMysqlPhysicalBackupBinlogOnly', 'in' => 'query', 'schema' => ['description' => 'Specifies whether to disable only the log backup feature for a physical backup of a MySQL database.', 'type' => 'string', 'example' => 'false', 'title' => '', 'required' => false], ], ], '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 operation succeeded. Valid values:'."\n" ."\n" .'- true: The operation succeeded.'."\n" ."\n" .'- false: The operation 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' => 'dbstooi01****', 'title' => ''], 'NeedPrecheck' => ['description' => 'Indicates whether this change triggers a precheck. Valid values:'."\n" ."\n" .'- true: A precheck is triggered. You must then call [StartBackupPlan](~~2869816~~) to start the backup plan.'."\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' => ''], ], ], '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"}]', 'title' => 'DisableBackupLog', 'description' => '## Impact'."\n" ."\n" .'Calling this operation stops the specified backup plan from creating new incremental 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' => 'BackupPlan', 'arn' => 'acs:dbs:{#regionId}:{#accountId}:backupplan/{#BackupPlanId}'], ], ], ], ], ], 'EnableBackupLog' => [ 'summary' => 'Enable 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 plan ID. Call [DescribeBackupPlanList](~~2869825~~) to obtain this ID.', 'type' => 'string', 'required' => true, 'example' => 'dbstooi******', 'title' => ''], ], [ 'name' => 'ClientToken', 'in' => 'query', 'schema' => ['description' => 'A client-generated token that ensures the idempotency of the request.', 'type' => 'string', 'required' => false, 'example' => 'dbs', 'title' => ''], ], [ 'name' => 'EnableMysqlPhysicalBackupBinlog', 'in' => 'query', 'schema' => ['description' => 'Specifies whether to enable log backup for MySQL physical backups. Set the value to `true` to enable this feature.', 'type' => 'string', 'example' => 'true', 'title' => '', 'required' => false], ], ], '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 operation succeeded. Valid values:'."\n" ."\n" .'- `true`: The operation succeeded.'."\n" ."\n" .'- `false`: The operation failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'ErrMessage' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'findValidDBSJob error', 'title' => ''], 'BackupPlanId' => ['description' => 'The backup plan ID.', 'type' => 'string', 'example' => 'dbstooi******', 'title' => ''], 'NeedPrecheck' => ['description' => 'Indicates whether this change triggers a precheck. Valid values:'."\n" ."\n" .'- `true`: A precheck is triggered. You must call the [StartBackupPlan](~~2869816~~) operation to start the backup plan.'."\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' => ''], ], ], '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"}]', 'title' => 'EnableBackupLog', 'description' => '## Impact'."\n" ."\n" .'Enabling log backup does not incur direct charges. However, log backups generate backup traffic and storage usage. These resources are billed at the same rate as full backups. You can use the free quota from your backup plan or storage plan to offset these charges.', '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' => 'BackupPlan', 'arn' => 'acs:dbs:{#regionId}:{#accountId}:backupplan/{#BackupPlanId}'], ], ], ], ], ], '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. You can call the [DescribeBackupGatewayList](~~2869840~~) operation to obtain this parameter.'."\n" ."\n" .'> This parameter is required.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '160***', 'title' => ''], ], [ 'name' => 'SourceEndpointRegion', 'in' => 'query', 'schema' => ['description' => 'The region ID of the backup gateway.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''], ], [ 'name' => 'TaskId', 'in' => 'query', 'schema' => ['description' => 'The ID of the asynchronous task. You can call the [CreateGetDBListFromAgentTask](~~2869847~~) operation to obtain this parameter.', '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 to prevent repeated submissions. The value is generated by the client and must be unique among different requests. The value 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 response parameters.', 'type' => 'object', 'properties' => [ 'HttpStatusCode' => ['description' => 'The HTTP status code.', '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' => ''], 'DbList' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'dbName' => [ 'description' => 'The database list.', 'type' => 'array', 'items' => ['description' => 'The database list.', 'type' => 'string', 'example' => 'TaskDB', 'title' => ''], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 403 => [ ['errorCode' => 'Request.Forbidden', 'errorMessage' => 'Have no Permissions', 'description' => ''], ], ], 'title' => 'Retrieve database list by using a backup gateway', 'summary' => 'Retrieves database and table data from a physical backup by using a backup gateway.', 'description' => 'Call the [CreateGetDBListFromAgentTask](~~2869847~~) operation to create an asynchronous task and obtain the TaskId. Then, pass the TaskId to the GetDBListFromAgent operation to retrieve the database and table data from the physical backup.', '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' => [ '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', 'summary' => 'Modifies the objects included in a Database Backup Service (DBS) 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' => '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 plan. Call the [DescribeBackupPlanList](~~2869825~~) operation to query the backup plan ID.', 'type' => 'string', 'required' => true, 'example' => 'dbstooi01xxxx', 'title' => ''], ], [ 'name' => 'OpenAutoDownload', 'in' => 'query', 'schema' => ['description' => 'Specifies whether to enable automatic download. Default value: false.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], ], [ 'name' => 'BackupGatewayId', 'in' => 'query', 'schema' => ['description' => 'The ID of the backup gateway used for downloading backup sets.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '23312323', 'title' => ''], ], [ 'name' => 'FullDataFormat', 'in' => 'query', 'schema' => ['description' => 'The format of the full data in the backup set to download. Valid values:'."\n" .'- Native'."\n" .'- SQL'."\n" .'- CSV'."\n" .'- JSON'."\n" ."\n" .'> Default value: CSV.', 'type' => 'string', 'required' => false, 'example' => 'CSV', 'title' => ''], ], [ 'name' => 'IncrementDataFormat', 'in' => 'query', 'schema' => ['description' => 'The format of the incremental data in the backup set to download. Valid values:'."\n" .'- Native'."\n" .'- SQL'."\n" .'- CSV'."\n" .'- JSON'."\n" ."\n" .'> Default value: Native.', 'type' => 'string', 'required' => false, 'example' => 'Native', 'title' => ''], ], [ 'name' => 'BackupSetDownloadDir', 'in' => 'query', 'schema' => ['description' => 'The server directory for downloading backup sets.', 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''], ], [ 'name' => 'BackupSetDownloadTargetType', 'in' => 'query', 'schema' => ['description' => 'The target type for downloading backup sets.'."\n" .'> Default value: agent, which indicates that a backup gateway is installed. Currently, only this value is supported.', 'type' => 'string', 'required' => false, 'example' => 'agent', 'title' => ''], ], [ 'name' => 'BackupSetDownloadTargetTypeLocation', 'in' => 'query', 'schema' => ['description' => 'The target directory type for downloading backup sets. This parameter is required if automatic download is enabled. Valid values:'."\n" .'- local'."\n" .'- nas'."\n" .'- ftp'."\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 and prevent repeated 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-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' => 'dbstooi01exxxx', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 403 => [ ['errorCode' => 'Request.Forbidden', 'errorMessage' => 'Have no Permissions', 'description' => ''], ], ], 'title' => 'Set backup set download rules', 'summary' => 'Enables, modifies, or disables the automatic download feature.', 'description' => 'Before calling this operation, verify that the backup data is stored in the built-in OSS of DBS. Call the [DescribeBackupPlanList](~~2869825~~) operation to check the value of 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' => '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\\": \\"dbstooi01exxxx\\"\\n}","type":"json"}]', ], 'ModifyBackupSourceEndpoint' => [ 'summary' => 'Modify a DBS backup source endpoint.', '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 plan ID. You can call the [DescribeBackupPlanList](~~2869825~~) operation to get this value.', 'type' => 'string', 'required' => true, 'example' => 'dbs1h****usfa', 'title' => ''], ], [ 'name' => 'SourceEndpointInstanceType', 'in' => 'query', 'schema' => ['description' => 'The type of the source instance. You can call the [DescribeBackupPlanList](~~2869825~~) operation to get this value. Valid values:'."\n" ."\n" .'- **RDS**: an RDS instance'."\n" ."\n" .'- **ECS**: a self-managed database on an ECS instance'."\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**: an ApsaraDB for MongoDB instance'."\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 database region. You can call the [DescribeBackupPlanList](~~2869825~~) operation to get this value.'."\n" ."\n" .'> This parameter is required if the **SourceEndpointInstanceType** parameter is set to `RDS`, `ECS`, `DDS`, `Express`, or `Agent`.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''], ], [ 'name' => 'SourceEndpointInstanceID', 'in' => 'query', 'schema' => ['description' => 'The database instance ID. You can call the [DescribeBackupPlanList](~~2869825~~) operation to get this value.'."\n" ."\n" .'> This parameter is required if the **SourceEndpointInstanceType** parameter is set to `RDS`, `ECS`, `DDS`, or `Express`.', 'type' => 'string', 'required' => false, 'example' => 'rm-bp1p8c29479jv****', 'title' => ''], ], [ 'name' => 'SourceEndpointIP', 'in' => 'query', 'schema' => ['description' => 'The IP address of the database. You can call the [DescribeBackupPlanList](~~2869825~~) operation to get this value.'."\n" ."\n" .'> This parameter is required if the **SourceEndpointInstanceType** parameter 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. You can call the [DescribeBackupPlanList](~~2869825~~) operation to get this value.'."\n" ."\n" .'> This parameter is required if the **SourceEndpointInstanceType** parameter 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 for PostgreSQL and MongoDB databases.'."\n" ."\n" .'- This parameter is also required for Microsoft SQL Server databases when the **SourceEndpointInstanceType** parameter is set to \'Agent\'.', 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''], ], [ 'name' => 'SourceEndpointUserName', 'in' => 'query', 'schema' => ['description' => 'The username of the database account. You can call the [DescribeBackupPlanList](~~2869825~~) operation to get this value.'."\n" ."\n" .'This parameter is required for all database engines except for Redis and Microsoft SQL Server (when the **SourceEndpointInstanceType** parameter is set to \'Agent\').', 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''], ], [ 'name' => 'SourceEndpointPassword', 'in' => 'query', 'schema' => ['description' => 'The password for the database account.'."\n" ."\n" .'This parameter is required for all database engines except for Redis and Microsoft SQL Server (when the **SourceEndpointInstanceType** parameter is set to \'Agent\').', 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''], ], [ 'name' => 'BackupGatewayId', 'in' => 'query', 'schema' => ['description' => 'The backup gateway ID. You can call the [DescribeBackupPlanList](~~2869825~~) operation to get this value.'."\n" ."\n" .'> This parameter is required if the **SourceEndpointInstanceType** parameter is set to `Agent`.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '21321323213', 'title' => ''], ], [ 'name' => 'BackupObjects', 'in' => 'query', 'schema' => ['description' => 'Backup objects: This parameter is optional if the database is located on an agent, but required for all other scenarios. You can call the [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 SID. This parameter is required for Oracle databases.', 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''], ], [ 'name' => 'CrossAliyunId', 'in' => 'query', 'schema' => ['description' => 'The UID for cross-account backup.', 'type' => 'string', 'required' => false, 'example' => '2xxx7778xxxxxxxxxx', 'title' => ''], ], [ 'name' => 'CrossRoleName', 'in' => 'query', 'schema' => ['description' => 'The RAM role name for cross-account backup.', 'type' => 'string', 'required' => false, 'example' => 'test123', 'title' => ''], ], [ 'name' => 'ClientToken', 'in' => 'query', 'schema' => ['description' => 'A client-generated token to ensure request idempotence.', 'type' => 'string', 'required' => false, 'example' => 'ETnLKlblzczshOTUbOCzxxxxxxx', 'title' => ''], ], [ 'name' => 'EnableSourceEndpointSsl', 'in' => 'query', 'schema' => ['description' => 'Specifies whether to use an SSL connection to back up the source database.', 'type' => 'string', 'example' => 'true', 'title' => '', 'required' => false], ], [ 'name' => 'SslCaPem', 'in' => 'query', 'schema' => ['description' => 'The PEM certificate for the SSL connection.', 'type' => 'string', 'example' => '-----BEGIN CERTIFICATE----- ... -----END CERTIFICATE-----', 'title' => '', 'required' => false], ], [ 'name' => 'SourceEndpointOracleHome', 'in' => 'query', 'schema' => ['description' => 'The Oracle Home path.', 'type' => 'string', 'example' => '/home/test', 'title' => '', 'required' => false], ], ], '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 backup plan ID.', 'type' => 'string', 'example' => 'dbs1h****usfa', 'title' => ''], 'NeedPrecheck' => ['description' => 'Indicates whether the modification triggers a precheck. If this parameter is set to 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' => ''], ], ], '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"}]', 'title' => 'ModifyBackupSourceEndpoint', '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' => 'BackupPlan', 'arn' => 'acs:dbs:{#regionId}:{#accountId}:backupplan/{#BackupPlanId}'], ], ], ], ], ], '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' => 'Backup plan ID. Obtain this parameter\'s value by calling the [DescribeBackupPlanList](~~2869825~~) API.', 'type' => 'string', 'required' => true, 'example' => 'dbsqdss5tmh****', 'title' => ''], ], [ 'name' => 'BackupRetentionPeriod', 'in' => 'query', 'schema' => ['description' => 'Backup data retention period, in days. Valid values: 0 to 1825.'."\n" ."\n" .'> Default value: 730 days.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '730', 'title' => ''], ], [ 'name' => 'DuplicationInfrequentAccessPeriod', 'in' => 'query', 'schema' => ['description' => 'Time to convert to Infrequent Access storage. This value must be less than the Archive Storage period (DuplicationArchivePeriod parameter). For more information about Infrequent Access storage, see [Storage Type Overview](~~51374~~).'."\n" ."\n" .'> Default value: 180 days.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '190', 'title' => ''], ], [ 'name' => 'DuplicationArchivePeriod', 'in' => 'query', 'schema' => ['description' => 'Time to convert to Archive Storage. This value must be less than the backup data retention period (BackupRetentionPeriod parameter). For more information about Archive Storage, see [Storage Type Overview](~~51374~~).'."\n" ."\n" .'> Default value: 365 days.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '366', 'title' => ''], ], [ 'name' => 'ClientToken', 'in' => 'query', 'schema' => ['description' => 'An arbitrary string used to ensure the idempotence of the request and prevent duplicate submissions.', 'type' => 'string', 'required' => false, 'example' => 'dbstest', 'title' => ''], ], [ 'name' => 'IncrementBackupRetentionPeriod', 'in' => 'query', 'schema' => ['type' => 'string', 'example' => '365', 'description' => '', 'title' => ''], ], [ 'name' => 'IncrementDuplicationInfrequentAccessPeriod', 'in' => 'query', 'schema' => ['type' => 'string', 'example' => '365', 'description' => '', 'title' => ''], ], [ 'name' => 'IncrementDuplicationArchivePeriod', 'in' => 'query', 'schema' => ['type' => 'string', 'example' => '365', 'description' => '', 'title' => ''], ], [ 'name' => 'LogBackupRetentionPeriod', 'in' => 'query', 'schema' => ['type' => 'string', 'example' => '365', 'description' => '', 'title' => ''], ], [ 'name' => 'LogDuplicationInfrequentAccessPeriod', 'in' => 'query', 'schema' => ['type' => 'string', 'example' => '365', 'description' => '', 'title' => ''], ], [ 'name' => 'LogDuplicationArchivePeriod', 'in' => 'query', 'schema' => ['type' => 'string', 'example' => '365', 'description' => '', 'title' => ''], ], [ 'name' => 'BackupStorageEncryptMethod', 'in' => 'query', 'schema' => ['type' => 'string', 'example' => 'encrypted', 'description' => '', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'Return parameter details.', 'type' => 'object', 'properties' => [ 'HttpStatusCode' => ['description' => 'HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => 'E995F91F-6F89-503B-9F7D-502F58FD****', 'title' => ''], 'ErrCode' => ['description' => 'Error code.', 'type' => 'string', 'example' => 'Param.NotFound', 'title' => ''], 'Success' => ['description' => 'Indicates whether the request was successful. Return values:'."\n" ."\n" .'- **true**: The request was successful.'."\n" ."\n" .'- **false**: The request failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'ErrMessage' => ['description' => 'Error message.', 'type' => 'string', 'example' => 'findValidDBSJob error', 'title' => ''], 'BackupPlanId' => ['description' => 'Backup plan ID.', 'type' => 'string', 'example' => 'dbsqdss5tmh****', 'title' => ''], 'NeedPrecheck' => ['description' => 'Indicates whether this modification triggers a precheck. Return values:'."\n" ."\n" .'- **true**: A precheck is triggered. Manually call the [StartBackupPlan](~~2869818~~) API to start the backup plan.'."\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' => 'Modify the lifecycle of stored data in a backup plan.', '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' => 'BackupPlan', 'arn' => 'acs:dbs:{#regionId}:{#accountId}:backupplan/{#BackupPlanId}'], ], ], ], ], '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, 'example' => 'dbsqdss5tmh****', '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' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The details of the response.', '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' => 'D13761C3-9971-5C02-B789-3F3CD159****', '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' => ''], 'CreatedFullBackupsetId' => ['description' => 'The ID of the full backup set.', 'type' => 'string', 'example' => '1h7toien3****', 'title' => ''], 'BackupPlanId' => ['description' => 'The ID of the backup plan.', 'type' => 'string', 'example' => 'dbsqdss5tm****', 'title' => ''], ], '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.BakSetError', 'message' => 'DBS download task bak set error. Your backup set does not meet the requirements.', 'http_code' => 200, 'description' => 'Your backup set does not meet the requirements.'], ['code' => 'DBS.DownloadTask.CannotFind', 'message' => 'Can not find download task.', 'http_code' => 200, 'description' => 'Can not find download task.'], ['code' => 'DBS.DownloadTask.CustinIdNotSupport', 'message' => 'DBS DownloadTask CustinIdNotSupport.', 'http_code' => 200, 'description' => 'DBS DownloadTask CustinIdNotSupport.'], ['code' => 'DBS.DownloadTask.CustinNameNotSupport', 'message' => 'DBS DownloadTask CustinNameNotSupport.', 'http_code' => 200, 'description' => 'DBS DownloadTask CustinNameNotSupport.'], ['code' => 'DBS.DownloadTask.DbTypeNotSupport', 'message' => 'DBS DownloadTask DbTypeNotSupport.', 'http_code' => 200, 'description' => 'DBS DownloadTask DbTypeNotSupport.'], ['code' => 'DBS.DownloadTask.InstanceInfoNotSupport', 'message' => 'DBS DownloadTask InstanceInfoNotSupport.', 'http_code' => 200, 'description' => 'DBS DownloadTask InstanceInfoNotSupport.'], ['code' => 'DBS.DownloadTask.InstanceParamNotSupport', 'message' => 'DBS DownloadTask InstanceParamNotSupport.', 'http_code' => 200, 'description' => 'DBS DownloadTask InstanceParamNotSupport.'], ['code' => 'DBS.DownloadTask.InstanceStorageTypeNotSupport', 'message' => 'DBS DownloadTask InstanceStorageTypeNotSupport.', 'http_code' => 200, 'description' => ''], ['code' => 'DBS.DownloadTask.InstanceVersionNotSupport', 'message' => 'DBS DownloadTask InstanceVersionNotSupport.', 'http_code' => 200, 'description' => 'DBS DownloadTask InstanceVersionNotSupport.'], ['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.NotSupport', 'message' => 'DBS DownloadTask NotSupport.', 'http_code' => 200, 'description' => 'DBS DownloadTask NotSupport.'], ['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.DownloadTask.RegionNotSupport', 'message' => 'DBS DownloadTask RegionNotSupport.', 'http_code' => 200, 'description' => 'DBS DownloadTask RegionNotSupport.'], ['code' => 'DBS.DownloadTask.UserNotSupport', 'message' => 'DBS DownloadTask UserNotSupport.', 'http_code' => 200, 'description' => 'DBS DownloadTask UserNotSupport.'], ['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' => 'DBS.RegionNotSupport', 'message' => 'Request region is not allowed in current gateway.', 'http_code' => 400, 'description' => 'The current request accesses the wrong endpoint'], ['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' => 'DescribeBackupGatewayList', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'dbs:DescribeBackupGatewayList', 'authLevel' => 'resource', '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' => 'CreateFullBackupSetDownload', 'description' => '', 'operationType' => 'create', 'ramAction' => [ 'action' => 'dbs:CreateFullBackupSetDownload', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'DBS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'CreateRestoreTask', 'description' => '', 'operationType' => 'create', 'ramAction' => [ 'action' => 'dbs:CreateRestoreTask', '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' => 'CreateGetDBListFromAgentTask', 'description' => '', 'operationType' => 'create', 'ramAction' => [ 'action' => 'dbs:CreateGetDBListFromAgentTask', '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' => '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' => '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' => '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' => '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' => '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' => '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}'], ], ], ], [ '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' => 'ModifyBackupObjects', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'dbs:ModifyBackupObjects', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'DBS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'StartRestoreTask', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'dbs:StartRestoreTask', 'authLevel' => 'resource', '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' => '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' => 'InitializeDbsServiceLinkedRole', 'description' => '', 'operationType' => 'create', 'ramAction' => [ 'action' => 'dbs:InitializeDbsServiceLinkedRole', 'authLevel' => 'operate', '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' => 'GetDBListFromAgent', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'dbs:GetDBListFromAgent', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'DBS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'DescribeRegions', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'dbs:DescribeRegions', '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' => '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' => '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' => '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' => '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' => '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' => 'DescribePreCheckProgressList', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'dbs:DescribePreCheckProgressList', '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' => 'CreateIncrementBackupSetDownload', 'description' => '', 'operationType' => 'create', 'ramAction' => [ 'action' => 'dbs:CreateIncrementBackupSetDownload', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'DBS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ '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' => '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' => '*'], ], ], ], ], 'resourceTypes' => [ ['validationType' => 'always', 'resourceType' => 'BackupPlan', 'arn' => 'acs:dbs:{#regionId}:{#accountId}:backupplan/{#BackupPlanId}'], ['validationType' => 'always', 'resourceType' => 'RestoreTask', 'arn' => 'acs:dbs:{#regionId}:{#accountId}:restoretask/{#RestoreTaskId}'], ['validationType' => 'always', 'resourceType' => 'BackupPlan', 'arn' => 'acs:dbs:{#regionId}:{#accountId}:backupplan/*'], ], ], ];