'1.0', 'info' => ['style' => 'RPC', 'product' => 'Dbs', 'version' => '2021-01-01'], 'directories' => [ [ 'children' => ['DescribeDownloadBackupSetStorageInfo', 'DescribeDownloadSupport', 'CreateDownload', 'DescribeDownloadTask', 'RetryDownloadTask'], 'type' => 'directory', 'title' => 'Advanced download', ], [ 'children' => ['DescribeBackupDataList', 'CreateAdvancedPolicy', 'DeleteSandboxInstance', 'DescribeSandboxRecoveryTime', 'DescribeSandboxInstances', 'DescribeSandboxBackupSets', 'DescribeCostInfoByDbsInstance', 'ChangeResourceGroup', 'DescribeBackupPolicy', 'ModifyBackupPolicy'], 'type' => 'directory', 'title' => 'Others', ], ], 'components' => [ 'schemas' => [], ], 'apis' => [ 'ChangeResourceGroup' => [ 'methods' => ['get', 'post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'ResourceId', 'in' => 'query', 'schema' => ['description' => 'The ID of the resource.', 'type' => 'string', 'required' => true, 'example' => 'dbs1jyajqk******', 'title' => ''], ], [ 'name' => 'NewResourceGroupId', 'in' => 'query', 'schema' => ['description' => 'The ID of the new resource group.', 'type' => 'string', 'required' => true, 'example' => 'rg-aekz4kee6******', 'title' => ''], ], [ 'name' => 'ResourceType', 'in' => 'query', 'schema' => ['description' => 'The resource type. Set the value to backupplan.', 'type' => 'string', 'required' => true, 'example' => 'backupplan', 'title' => ''], ], [ 'name' => 'ClientToken', 'in' => 'query', 'schema' => ['description' => 'A client token to ensure that the request is idempotent. This prevents the same request from being submitted multiple times.', 'type' => 'string', 'required' => false, 'example' => 'dbs', 'title' => ''], ], [ 'name' => 'RegionCode', 'in' => 'query', 'schema' => ['description' => 'The ID of the region where the instance resides.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Data' => ['description' => 'Indicates whether the resource group was changed. Valid values:'."\n" ."\n" .'- **true**: The request was successful.'."\n" ."\n" .'- **false**: The request failed.', 'type' => 'string', 'example' => 'true', 'title' => ''], 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => '04EBD9F5-F06F-5302-8499-005C72*******', 'title' => ''], 'ErrCode' => ['description' => 'The error code returned if the call fails.', 'type' => 'string', 'example' => 'Request.Forbidden', 'title' => ''], 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" ."\n" .'- **true**: The request was successful.'."\n" ."\n" .'- **false**: The request failed.', 'type' => 'string', 'example' => 'true', 'title' => ''], 'ErrMessage' => ['description' => 'The error message returned if the call fails.', 'type' => 'string', 'example' => 'RAM DENY', 'title' => ''], 'Code' => ['description' => 'The status code of the API.', 'type' => 'string', 'example' => 'Param.NotFound', 'title' => ''], 'Message' => ['description' => 'Additional information.', 'type' => 'string', 'example' => 'The resource group is forbidden to operate', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 403 => [ ['errorCode' => 'Request.Forbidden', 'errorMessage' => 'Have no Permissions', 'description' => ''], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'ChangeResourceGroup', 'summary' => 'Changes the resource group of a resource.', 'changeSet' => [ ['createdAt' => '2023-12-22T02:05:16.000Z', 'description' => 'Request parameters changed'], ], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'dbs:ChangeResourceGroup', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'DBS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": \\"true\\",\\n \\"RequestId\\": \\"04EBD9F5-F06F-5302-8499-005C72*******\\",\\n \\"ErrCode\\": \\"Request.Forbidden\\",\\n \\"Success\\": \\"true\\",\\n \\"ErrMessage\\": \\"RAM DENY\\",\\n \\"Code\\": \\"Param.NotFound\\",\\n \\"Message\\": \\"The resource group is forbidden to operate\\"\\n}","type":"json"}]', ], 'CreateAdvancedPolicy' => [ 'methods' => ['post', 'get'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '221987', 'abilityTreeNodes' => ['FEATUREcbsXXHSAX'], ], 'parameters' => [ [ 'name' => 'RegionCode', 'in' => 'query', 'schema' => ['description' => 'The region in which backup sets reside.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'cn-shanghai'], ], [ 'name' => 'InstanceName', 'in' => 'query', 'schema' => ['description' => 'The ID of the PolarDB instance.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'pc-2ze3nrr64c5****'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '1EFBAC73-4A72-5AD0-BE27-932491FCB848', 'title' => ''], 'Message' => ['description' => 'The returned message.', 'type' => 'string', 'example' => 'instanceName can not be empty.', 'title' => ''], 'Data' => ['description' => 'Indicates whether the advanced backup policy takes effect. Valid values:'."\n" ."\n" .'- **true**'."\n" ."\n" .'- **false**', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'ErrMessage' => ['description' => 'The error message returned if the request failed.', 'type' => 'string', 'example' => 'The specified parameter %s value is not valid. ', 'title' => ''], 'Code' => ['description' => 'The response code.', 'type' => 'string', 'example' => 'Success', 'title' => ''], 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" ."\n" .'- true'."\n" ."\n" .'- false', 'type' => 'string', 'example' => 'true', 'title' => ''], 'ErrCode' => ['description' => 'The error code returned if the request failed.', 'type' => 'string', 'example' => 'Success', 'title' => ''], ], 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 403 => [ ['errorCode' => 'Request.Forbidden', 'errorMessage' => 'Have no Permissions', 'description' => ''], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'CreateAdvancedPolicy', 'summary' => 'Enables an advanced backup policy for a PolarDB instance.', 'description' => '### [](#)Supported database engines'."\n" ."\n" .'PolarDB for MySQL'."\n" ."\n" .'> This API operation is available only to specific customers. If you want to call this API operation, join the Database Backup (DBS) DingTalk group (ID 35585947) for customer consultation to request permissions.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'dbs:CreateAdvancedPolicy', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'DBS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1EFBAC73-4A72-5AD0-BE27-932491FCB848\\",\\n \\"Message\\": \\"instanceName can not be empty.\\",\\n \\"Data\\": true,\\n \\"ErrMessage\\": \\"The specified parameter %s value is not valid. \\",\\n \\"Code\\": \\"Success\\",\\n \\"Success\\": \\"true\\",\\n \\"ErrCode\\": \\"Success\\"\\n}","type":"json"}]', ], 'CreateDownload' => [ 'summary' => 'Create an Advanced Download Task.', 'methods' => ['get', 'post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '119762', 'abilityTreeNodes' => ['FEATUREcbs04Q4EK'], ], 'parameters' => [ [ 'name' => 'RegionCode', 'in' => 'query', 'schema' => ['description' => 'The ID of the region where the instance is located. You can call the [DescribeDBInstanceAttribute](~~26231~~) operation for an ApsaraDB RDS instance or the [DescribeDBClusterAttribute](~~2319132~~) operation for a PolarDB cluster to query the region ID.', 'type' => 'string', 'required' => true, 'example' => 'cn-beijing', 'title' => ''], ], [ 'name' => 'InstanceName', 'in' => 'query', 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'rm-wz994c1t1****', 'title' => ''], ], [ 'name' => 'BakSetType', 'in' => 'query', 'schema' => ['description' => 'The type of the download task. Valid values:'."\n" ."\n" .'- **full**: Downloads a full backup set.'."\n" ."\n" .'- **pitr**: Downloads data from a point in time.', 'type' => 'string', 'required' => false, 'example' => 'full', 'title' => ''], ], [ 'name' => 'BakSetId', 'in' => 'query', 'schema' => ['description' => 'The ID of the backup set. You can call the [DescribeBackups](~~26273~~) operation for an ApsaraDB RDS instance or the [DescribeBackups](~~2319224~~) operation for a PolarDB cluster to obtain the backup set ID.'."\n" ."\n" .'> This parameter is required if `BakSetType` is set to `full`.', 'type' => 'string', 'required' => false, 'example' => '146005****', 'title' => ''], ], [ 'name' => 'DownloadPointInTime', 'in' => 'query', 'schema' => ['description' => 'The point in time for the download. Specify a Unix timestamp in milliseconds (ms).'."\n" ."\n" .'> This parameter is required if `BakSetType` is set to `pitr`.', 'type' => 'string', 'required' => false, 'example' => '1661331864000', 'title' => ''], ], [ 'name' => 'BakSetSize', 'in' => 'query', 'schema' => ['description' => 'The size of the full backup set, in bytes. You can call the [DescribeBackups](~~26273~~) operation for an ApsaraDB RDS instance or the [DescribeBackups](~~2319224~~) operation for a PolarDB cluster to query the size.', 'type' => 'string', 'required' => false, 'example' => '216****', 'title' => ''], ], [ 'name' => 'FormatType', 'in' => 'query', 'schema' => [ 'description' => 'The target format of the downloaded data. Valid values:'."\n" ."\n" .'- **CSV**'."\n" ."\n" .'- **SQL**'."\n" ."\n" .'- **Parquet**'."\n" ."\n" .'- **Bson**'."\n" ."\n" .'- **qp.xb**'."\n" ."\n" .'> This parameter is required. The `Bson` format is available only for MongoDB instances. The `qp.xb` format is available only for ApsaraDB RDS for MySQL instances.', 'enumValueTitles' => ['qp.xb' => 'qp.xb', 'csv' => 'CSV', 'bson' => 'Bson', 'csv-with-header' => 'csv-with-header', 'parquet' => 'Parquet', 'sql' => 'SQL'], 'type' => 'string', 'required' => false, 'example' => 'CSV', 'title' => '', ], ], [ 'name' => 'TargetType', 'in' => 'query', 'schema' => ['description' => 'The destination type for the download. Valid values:'."\n" ."\n" .'- **OSS**'."\n" ."\n" .'- **URL**', 'type' => 'string', 'required' => false, 'example' => 'OSS', 'title' => ''], ], [ 'name' => 'TargetBucket', 'in' => 'query', 'schema' => ['description' => 'The name of the destination OSS bucket.'."\n" ."\n" .'- This parameter is required if `TargetType` is set to `OSS`.'."\n" ."\n" .'- Make sure that your account is granted the **AliyunDBSDefaultRole** role. For more information, see [Grant permissions to a RAM role](~~26307~~). You can also grant the role in the console by following the on-screen instructions.', 'type' => 'string', 'required' => false, 'example' => 'test123', 'title' => ''], ], [ 'name' => 'TargetPath', 'in' => 'query', 'schema' => ['description' => 'The destination path for the downloaded data.'."\n" ."\n" .'> This parameter is required if `TargetType` is set to `OSS`.', 'type' => 'string', 'required' => false, 'example' => 'test_db/path', 'title' => ''], ], [ 'name' => 'TargetOssRegion', 'in' => 'query', 'schema' => ['description' => 'The region where the destination OSS bucket is located.'."\n" ."\n" .'> This parameter is required if `TargetType` is set to `OSS`.', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing', 'title' => ''], ], [ 'name' => 'PrimaryKeyTypeOnly', 'in' => 'query', 'schema' => ['description' => 'This parameter is required only for MongoDB instances. It specifies whether the primary key in a table is unique. Set the value to `true` if the primary key is unique, or `false` otherwise.', 'type' => 'string', 'required' => false, 'example' => 'false', 'title' => ''], ], [ 'name' => 'IsCluster', 'in' => 'query', 'schema' => ['description' => 'This parameter is required only for MongoDB instances. Set the value to `true` if the instance is a sharded cluster, or `false` otherwise.', 'type' => 'string', 'required' => false, 'example' => 'false', 'title' => ''], ], [ 'name' => 'AdminDatabase', 'in' => 'query', 'schema' => ['description' => 'This parameter is required only for MongoDB instances. It specifies the name of the authentication database. The default value is `admin`.', 'type' => 'string', 'required' => false, 'example' => 'admin', 'title' => ''], ], [ 'name' => 'UseZstd', 'in' => 'query', 'schema' => ['description' => 'Specifies whether to use the zstd compression algorithm. Default value: `false`.', 'type' => 'string', 'required' => false, 'example' => 'false', 'title' => ''], ], [ 'name' => 'ClusterName', 'in' => 'query', 'schema' => ['description' => 'This parameter is required only for MongoDB sharded clusters. It specifies the ID of the sharded cluster.', 'type' => 'string', 'required' => false, 'example' => 'dds-0xid8e5336******', 'title' => ''], ], [ 'name' => 'IsPhysical', 'in' => 'query', 'schema' => ['description' => 'This parameter is required only when you download data in the `qp.xb` format from an ApsaraDB RDS for MySQL instance. In this case, set the value to `true`.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response data.', 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'A08F908D-2C35-583F-93C1-ED80753F****', 'title' => ''], 'ErrCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'DBS.ParamIsInValid', 'title' => ''], 'Success' => ['description' => 'Indicates whether the request succeeded. Valid values:'."\n" ."\n" .'- **true**: The request succeeded.'."\n" ."\n" .'- **false**: The request failed.', 'type' => 'string', 'example' => 'true', 'title' => ''], 'ErrMessage' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'formatType can not be empty', 'title' => ''], 'Code' => ['description' => 'The status code.', 'type' => 'string', 'example' => 'DBS.ParamIsInValid', 'title' => ''], 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'formatType can not be empty', 'title' => ''], 'Data' => [ 'description' => 'The details of the download task.', 'type' => 'object', 'properties' => [ 'BakSetId' => ['description' => 'The ID of the full backup set.', 'type' => 'string', 'example' => '146005****', 'title' => ''], 'DownloadStatus' => ['description' => 'The status of the download task. Valid values:'."\n" ."\n" .'- **initializing**: The task is initializing.'."\n" ."\n" .'- **queueing**: The task is queued.'."\n" ."\n" .'- **running**: The task is running.'."\n" ."\n" .'- **failed**: The task failed.'."\n" ."\n" .'- **finished**: The task is complete.'."\n" ."\n" .'- **expired**: The task has expired.'."\n" ."\n" .'> If the download destination is a URL, the link expires three days after the task completes.', 'type' => 'string', 'example' => 'initializing', 'title' => ''], 'Progress' => ['description' => 'The number of tables downloaded versus the total number of tables.'."\n" ."\n" .'> If the task is initializing, `0/0` is returned.', 'type' => 'string', 'example' => '0/0', 'title' => ''], 'BackupSetTime' => ['description' => 'The point-in-time of the backup set, returned as a UNIX timestamp in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1661373070000', 'title' => ''], 'RegionCode' => ['description' => 'The region ID.', 'type' => 'string', 'example' => 'cn-beijing', 'title' => ''], 'TargetPath' => ['description' => 'The destination path for the data download.'."\n" ."\n" .'> This parameter is returned only when `TargetType` is `OSS`.', 'type' => 'string', 'example' => 'test_db/path', 'title' => ''], 'DbList' => ['description' => 'If the download is for specific databases or tables, this parameter lists their names.', 'type' => 'string', 'example' => 'testdb', 'title' => ''], 'ExportDataSize' => ['description' => 'The size of the exported data, in bytes.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'ImportDataSize' => ['description' => 'The size of the processed data, in bytes.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'GmtCreate' => ['description' => 'The creation time of the task, returned as a UNIX timestamp in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1661940917570', 'title' => ''], 'TaskId' => ['description' => 'The ID of the download task.', 'type' => 'string', 'example' => 'dt-qxnsfq5s****', 'title' => ''], 'Format' => ['description' => 'The format to which the data is converted.', 'type' => 'string', 'example' => 'CSV', 'title' => ''], 'TargetType' => ['description' => 'The destination type for the download.', 'type' => 'string', 'example' => 'URL', 'title' => ''], ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 200 => [ ['errorCode' => 'DBS.DownloadTask.CannotFind', 'errorMessage' => 'Can not find download task.', 'description' => 'Can not find download task.'], ['errorCode' => 'DBS.DownloadTask.JobAlreadyExist', 'errorMessage' => 'Job already submit in recent days, please check it.', 'description' => 'Job already submit in recent days, please check it.'], ['errorCode' => 'DBS.DownloadTask.OnlyOneRunningOrFailedTask', 'errorMessage' => 'There can be only one running or failed task for the instance.', 'description' => 'The current instance can only have one running/failed task at the same time.'], ['errorCode' => 'DBS.DownloadTask.OssForbid', 'errorMessage' => 'OSS is forbidden to access. Please check your OSS bucket.', 'description' => 'OSS is forbidden to access. Please check your OSS bucket.'], ['errorCode' => 'DBS.DownloadTask.OssStorageTypeInvalid', 'errorMessage' => 'Unsupported bucket storage. Please make sure that your OSS bucket\'s storgae type is standard.', 'description' => 'Unsupported bucket storage. Please make sure that your OSS bucket\'s storgae type is standard.'], ['errorCode' => 'Forbidden.InstanceNotFound', 'errorMessage' => 'instance not found', 'description' => 'The instance does not exist.'], ['errorCode' => 'DBS.DownloadTask.BakSetError', 'errorMessage' => 'DBS download task bak set error. Your backup set does not meet the requirements.', 'description' => 'Your backup set does not meet the requirements.'], ['errorCode' => 'DBS.DownloadTask.CustinIdNotSupport', 'errorMessage' => 'DBS DownloadTask CustinIdNotSupport.', 'description' => 'DBS DownloadTask CustinIdNotSupport.'], ['errorCode' => 'DBS.DownloadTask.CustinNameNotSupport', 'errorMessage' => 'DBS DownloadTask CustinNameNotSupport.', 'description' => 'DBS DownloadTask CustinNameNotSupport.'], ['errorCode' => 'DBS.DownloadTask.DbTypeNotSupport', 'errorMessage' => 'DBS DownloadTask DbTypeNotSupport.', 'description' => 'DBS DownloadTask DbTypeNotSupport.'], ['errorCode' => 'DBS.DownloadTask.InstanceInfoNotSupport', 'errorMessage' => 'DBS DownloadTask InstanceInfoNotSupport.', 'description' => 'DBS DownloadTask InstanceInfoNotSupport.'], ['errorCode' => 'DBS.DownloadTask.InstanceParamNotSupport', 'errorMessage' => 'DBS DownloadTask InstanceParamNotSupport.', 'description' => 'DBS DownloadTask InstanceParamNotSupport.'], ['errorCode' => 'DBS.DownloadTask.InstanceStorageTypeNotSupport', 'errorMessage' => 'DBS DownloadTask InstanceStorageTypeNotSupport.', 'description' => ''], ['errorCode' => 'DBS.DownloadTask.InstanceVersionNotSupport', 'errorMessage' => 'DBS DownloadTask InstanceVersionNotSupport.', 'description' => 'DBS DownloadTask InstanceVersionNotSupport.'], ['errorCode' => 'DBS.DownloadTask.NotSupport', 'errorMessage' => 'DBS DownloadTask NotSupport.', 'description' => 'DBS DownloadTask NotSupport.'], ['errorCode' => 'DBS.DownloadTask.RegionNotSupport', 'errorMessage' => 'DBS DownloadTask RegionNotSupport.', 'description' => 'DBS DownloadTask RegionNotSupport.'], ['errorCode' => 'DBS.DownloadTask.UserNotSupport', 'errorMessage' => 'DBS DownloadTask UserNotSupport.', 'description' => 'DBS DownloadTask UserNotSupport.'], ], 403 => [ ['errorCode' => 'Request.Forbidden', 'errorMessage' => 'Have no Permissions', 'description' => ''], ['errorCode' => 'DBS.NoPermissionException', 'errorMessage' => 'Rejected by ValidationChecker.', 'description' => ''], ], [ ['errorCode' => 'DBS.NotExists', 'errorMessage' => 'data source do not existed.', 'description' => 'DBS.NotExists'], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A08F908D-2C35-583F-93C1-ED80753F****\\",\\n \\"ErrCode\\": \\"DBS.ParamIsInValid\\",\\n \\"Success\\": \\"true\\",\\n \\"ErrMessage\\": \\"formatType can not be empty\\",\\n \\"Code\\": \\"DBS.ParamIsInValid\\",\\n \\"Message\\": \\"formatType can not be empty\\",\\n \\"Data\\": {\\n \\"BakSetId\\": \\"146005****\\",\\n \\"DownloadStatus\\": \\"initializing\\",\\n \\"Progress\\": \\"0/0\\",\\n \\"BackupSetTime\\": 1661373070000,\\n \\"RegionCode\\": \\"cn-beijing\\",\\n \\"TargetPath\\": \\"test_db/path\\",\\n \\"DbList\\": \\"testdb\\",\\n \\"ExportDataSize\\": 0,\\n \\"ImportDataSize\\": 0,\\n \\"GmtCreate\\": 1661940917570,\\n \\"TaskId\\": \\"dt-qxnsfq5s****\\",\\n \\"Format\\": \\"CSV\\",\\n \\"TargetType\\": \\"URL\\"\\n }\\n}","type":"json"}]', 'title' => 'CreateDownload', 'description' => '### Supported engines'."\n" ."\n" .'- RDS MySQL (Cloud Disk instances)'."\n" ."\n" .'- RDS PostgreSQL'."\n" ."\n" .'- PolarDB for MySQL'."\n" ."\n" .'- ApsaraDB for MongoDB'."\n" ."\n" .'### Related documentation'."\n" ."\n" .'For eligible instances, you can create an Advanced Download Task for a specific Backup Set or for any point in time. You can set the download destination to a URL or write the data directly to your Object Storage Service (OSS) bucket for data analytics and offline archiving.'."\n" ."\n" .'- [Download an RDS MySQL backup](~~98819~~)'."\n" ."\n" .'- [Download an RDS PostgreSQL backup](~~96774~~)'."\n" ."\n" .'- [Download a PolarDB for MySQL backup](~~2627635~~)'."\n" ."\n" .'- [Download an ApsaraDB for MongoDB backup](~~55011~~)', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'dbs:CreateDownload', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'DBS', 'resourceType' => 'DBInstance', 'arn' => 'acs:rds:{#regionId}:{#accountId}:dbinstance/{#DbInstanceId}'], ], ], ], ], ], 'DeleteSandboxInstance' => [ 'summary' => 'Deletes a sandbox instance.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'systemTags' => ['operationType' => 'delete'], 'parameters' => [ [ 'name' => 'BackupPlanId', 'in' => 'query', 'schema' => ['description' => 'The ID of the backup plan.'."\n" ."\n" .'> If your instance is an ApsaraDB RDS for MySQL instance, use the [auto-add data source](~~193091~~) feature to add the RDS instance to DBS and obtain the backup plan ID.', 'type' => 'string', 'required' => true, 'example' => '1hxxxx8xxxxxa', 'title' => ''], ], [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'The ID of the sandbox instance.', 'type' => 'string', 'required' => true, 'example' => '1jxxxxnxxx1xc', 'title' => ''], ], [ 'name' => 'ZoneId', 'in' => 'query', 'schema' => ['description' => 'The zone ID of the destination sandbox instance. The zone must be supported by PrivateLink. Call the [DescribeZones](~~469326~~) operation to query the list of zones in a specific region.'."\n" ."\n" .'> Before using the sandbox feature, enable [PrivateLink](~~459882~~). Call the [OpenPrivateLinkService](~~469322~~) operation to enable PrivateLink.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou-b', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Data' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'operation forbidden due to sandbox is creating.', 'title' => ''], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '4F1888AC-1138-4995-B9FE-D2734F61C058', 'title' => ''], 'ErrCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'Param.NotFound', 'title' => ''], 'Success' => ['description' => 'Indicates whether the request is successful.', 'type' => 'string', 'example' => 'true', 'title' => ''], 'ErrMessage' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'The specified parameter %s value is not valid.', 'title' => ''], 'Code' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'Param.NotFound', 'title' => ''], 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'The specified parameter %s value is not valid.', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 403 => [ ['errorCode' => 'Request.Forbidden', 'errorMessage' => 'Have no Permissions', 'description' => ''], ], ], 'title' => 'DeleteSandboxInstance', 'description' => 'This operation is only available for the 2021-01-01 version of the DBS API.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => '|Error code|Error message|Description|'."\n" .'|---|---|---|'."\n" .'|Operation.DeniedByJobStatus|operation forbidden due to sandbox is creating|The error message returned because the sandbox instance is being created and cannot be released. Release the sandbox instance when it is running.|', 'changeSet' => [ ['createdAt' => '2023-08-18T09:25:36.000Z', 'description' => 'Request parameters changed'], ], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'delete', 'ramAction' => [ 'action' => 'dbs:DeleteSandboxInstance', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'DBS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": \\"operation forbidden due to sandbox is creating.\\",\\n \\"RequestId\\": \\"4F1888AC-1138-4995-B9FE-D2734F61C058\\",\\n \\"ErrCode\\": \\"Param.NotFound\\",\\n \\"Success\\": \\"true\\",\\n \\"ErrMessage\\": \\"The specified parameter %s value is not valid.\\",\\n \\"Code\\": \\"Param.NotFound\\",\\n \\"Message\\": \\"The specified parameter %s value is not valid.\\"\\n}","type":"json"}]', ], 'DescribeBackupDataList' => [ 'summary' => 'Queries backup data for a PolarDB for MySQL cluster.', 'methods' => ['get', 'post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '171434', 'abilityTreeNodes' => ['FEATUREcbsUOJI4N'], ], 'parameters' => [ [ 'name' => 'InstanceName', 'in' => 'query', 'schema' => ['description' => 'The ID of the PolarDB cluster.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'pc-2ze3nrr64c5******'], ], [ 'name' => 'RegionCode', 'in' => 'query', 'schema' => ['description' => 'The region where the backup set is located.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'cn-hangzhou'], ], [ 'name' => 'SceneType', 'in' => 'query', 'schema' => ['description' => 'The backup scenario. This parameter supports only **LEVEL\\_1**, which indicates a level-1 backup in the region where the instance resides.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'LEVEL_1'], ], [ 'name' => 'StartTime', 'in' => 'query', 'schema' => ['description' => 'The start of the time range to query. Specify the time in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => '2024-04-17T17:00:16Z'], ], [ 'name' => 'EndTime', 'in' => 'query', 'schema' => ['description' => 'The end of the time range to query. The end time must be later than the start time. Specify the time in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => '2024-04-17T17:00:32Z'], ], [ 'name' => 'BackupStatus', 'in' => 'query', 'schema' => ['description' => 'The status of the backup set. Valid values:'."\n" ."\n" .'- **OK**: The backup is successful.'."\n" ."\n" .'- **ERROR**: The backup failed.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'OK'], ], [ 'name' => 'BackupId', 'in' => 'query', 'schema' => ['description' => 'The ID of the backup set.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => '213064****'], ], [ 'name' => 'BackupMethod', 'in' => 'query', 'schema' => ['description' => 'The backup method. Valid values:'."\n" ."\n" .'- **Physical**: physical backup'."\n" ."\n" .'- **Logical**: logical backup'."\n" ."\n" .'- **Snapshot**: snapshot backup', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'Snapshot'], ], [ 'name' => 'BackupMode', 'in' => 'query', 'schema' => ['description' => 'The backup mode. Valid values:'."\n" ."\n" .'- **Automated**: automatic backup'."\n" ."\n" .'- **Manual**: manual backup', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'Automated'], ], [ 'name' => 'BackupType', 'in' => 'query', 'schema' => ['description' => 'The backup type. Valid values:'."\n" ."\n" .'- **FullBackup**: full backup'."\n" ."\n" .'- **IncrementBackup**: incremental backup', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'FullBackup'], ], [ 'name' => 'BackupScale', 'in' => 'query', 'schema' => ['description' => 'The backup scope. Valid values:'."\n" ."\n" .'- **DBInstance**: instance backup'."\n" ."\n" .'- **DBTable**: database and table backup', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'DBInstance'], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => ['description' => 'The number of entries to return on each page. The default value is 20.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'title' => '', 'example' => '20'], ], [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => ['description' => 'The page number. The value must be an integer that is greater than 0 and does not exceed the maximum value of the integer data type. The default value is 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'title' => '', 'example' => '1'], ], [ 'name' => 'InstanceIsDeleted', 'in' => 'query', 'schema' => ['description' => 'Specifies whether the instance is deleted. Valid values:'."\n" ."\n" .'- **true**: The instance is deleted.'."\n" ."\n" .'- **false**: The instance is not deleted. This is the default value.', 'type' => 'boolean', 'title' => '', 'required' => false, 'example' => 'false'], ], [ 'name' => 'InstanceRegion', 'in' => 'query', 'schema' => ['description' => 'The original region of the instance.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'cn-hangzhou'], ], [ 'name' => 'DataSourceId', 'in' => 'query', 'schema' => ['description' => 'This parameter is reserved and does not need to be specified.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'test****'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The details of the returned parameters.', 'type' => 'object', 'properties' => [ 'Data' => [ 'description' => 'The returned data.', 'type' => 'object', 'properties' => [ 'Content' => [ 'description' => 'The details of the task.', 'type' => 'array', 'items' => [ 'description' => 'The details of the task.', 'type' => 'object', 'properties' => [ 'BackupId' => ['description' => 'The ID of the backup set.', 'type' => 'string', 'title' => '', 'example' => '213088****'], 'BackupName' => ['description' => 'The name of the backup set.', 'type' => 'string', 'title' => '', 'example' => 'logic_backup'], 'BackupMode' => ['description' => 'The backup mode. Valid values:'."\n" ."\n" .'- **Automated**: automatic backup'."\n" ."\n" .'- **Manual**: manual backup', 'type' => 'string', 'title' => '', 'example' => 'Automated'], 'BackupType' => ['description' => 'The backup type. Valid values:'."\n" ."\n" .'- **FullBackup**: full backup'."\n" ."\n" .'- **IncrementBackup**: incremental backup', 'type' => 'string', 'title' => '', 'example' => 'FullBackup'], 'BackupScale' => ['description' => 'The backup scope. Valid values:'."\n" ."\n" .'- **DBInstance**: instance backup'."\n" ."\n" .'- **DBTable**: database and table backup', 'type' => 'string', 'title' => '', 'example' => 'DBInstance'], 'BackupMethod' => ['description' => 'The backup method. Valid values:'."\n" ."\n" .'- **Physical**: physical backup'."\n" ."\n" .'- **Logical**: logical backup'."\n" ."\n" .'- **Snapshot**: snapshot backup', 'type' => 'string', 'title' => '', 'example' => 'Snapshot'], 'BackupSize' => ['description' => 'The size of the backup set in bytes.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '25669140480'], 'BackupStatus' => ['description' => 'The status of the backup set. Valid values:'."\n" ."\n" .'- **OK**: The backup is successful.'."\n" ."\n" .'- **ERROR**: The backup failed.', 'type' => 'string', 'title' => '', 'example' => 'OK'], 'BackupStartTime' => ['description' => 'The start time of the backup. The time is in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.', 'type' => 'string', 'title' => '', 'example' => '2024-04-17T17:00:16Z'], 'BackupEndTime' => ['description' => 'The end time of the backup. The time is in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.', 'type' => 'string', 'title' => '', 'example' => '2024-04-17T17:00:32Z'], 'ConsistentTime' => ['description' => 'The point in time of the consistent snapshot. The value is a UNIX timestamp. Unit: seconds.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1713373221'], 'BackupLocation' => ['description' => 'The storage path of the backup.', 'type' => 'string', 'title' => '', 'example' => 'logic'], 'InstanceName' => ['description' => 'The ID of the instance.', 'type' => 'string', 'title' => '', 'example' => 'pc-2ze3nrr64c5******'], 'Engine' => ['description' => 'The database engine type.', 'type' => 'string', 'title' => '', 'example' => 'polardb_mysql'], 'EngineVersion' => ['description' => 'The database engine version.', 'type' => 'string', 'title' => '', 'example' => '5.7'], 'SupportDeletion' => ['description' => 'Indicates whether the backup set can be deleted. Valid values:'."\n" ."\n" .'- **0**: The backup set can be deleted.'."\n" ."\n" .'- **1**: The backup set cannot be deleted.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '0'], 'Encryption' => ['description' => 'The encryption information.', 'type' => 'string', 'title' => '', 'example' => 'psk2'], 'IsAvail' => ['description' => 'Indicates whether the backup set is available. Valid values:'."\n" ."\n" .'- **1**: The backup set is available.'."\n" ."\n" .'- **0**: The backup set is unavailable.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '1'], 'Checksum' => ['description' => 'The checksum.', 'type' => 'string', 'title' => '', 'example' => '84a4c16431f969712e6895992719****'], 'BackupDownloadURL' => ['description' => 'The public download URL of the backup set.'."\n" ."\n" .'> This parameter is returned only when BackupMethod is set to **Physical** (physical backup) or **Logical** (logical backup).', 'type' => 'string', 'title' => '', 'example' => 'http://oss.com/****'], 'BackupIntranetDownloadURL' => ['description' => 'The internal download URL of the backup set.'."\n" ."\n" .'> This parameter is returned only when BackupMethod is set to **Physical** (physical backup) or **Logical** (logical backup).', 'type' => 'string', 'title' => '', 'example' => 'http://oss.com/****'], 'ExpectExpireType' => ['description' => 'The expected expiration type of the backup set. Valid values:'."\n" ."\n" .'- NEVER'."\n" ."\n" .'- EXPIRED'."\n" ."\n" .'- DELAY', 'type' => 'string', 'title' => '', 'example' => 'DELAY'], 'ExpectExpireTime' => ['description' => 'The expected expiration time of the backup set. The time is in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.', 'type' => 'string', 'title' => '', 'example' => '2024-04-19T05:00:49Z'], 'PolarSnapshot' => [ 'title' => '', 'description' => 'The information about the level-2 dump of the PolarDB cluster.'."\n" ."\n" .'> The PolarSnapshot-related information is returned only after the level-2 dump feature is enabled for the PolarDB cluster in the same region and the level-1 backup is successfully dumped.', 'type' => 'object', 'properties' => [ 'DumpId' => ['description' => 'The ID of the dump.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => 'abc****'], 'DumpSize' => ['description' => 'The size of the dump backup in bytes.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '25669140589'], 'expectExpireType' => ['description' => 'The expected expiration type of the backup set. Valid values:'."\n" ."\n" .'- NEVER'."\n" ."\n" .'- EXPIRED'."\n" ."\n" .'- DELAY', 'type' => 'string', 'title' => '', 'example' => 'DELAY'], 'ExpectExpireTime' => ['description' => 'The expected expiration time of the backup set. The time is in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.', 'type' => 'string', 'title' => '', 'example' => '2024-04-19T05:00:49Z'], ], 'example' => '', ], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], 'PageSize' => ['description' => 'The page size.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '20'], 'PageNumber' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1'], 'TotalPages' => ['description' => 'The total number of pages.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1'], 'TotalElements' => ['description' => 'The total number of backup sets.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1'], 'Extra' => ['description' => 'Extra information.', 'type' => 'string', 'title' => '', 'example' => 'dbtest'], ], 'title' => '', 'example' => '', ], 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => '95A5FFD0-7F46-5A7D-9DFE-6A376B4E2A28', 'title' => ''], 'ErrCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'Request.Forbidden ', 'title' => ''], 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" ."\n" .'- **true**: The request was successful.'."\n" ."\n" .'- **false**: The request failed.', 'type' => 'string', 'example' => 'true', 'title' => ''], 'ErrMessage' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'The specified parameter %s value is not valid. ', 'title' => ''], 'Code' => ['description' => 'The status code.', 'type' => 'string', 'example' => 'Success', 'title' => ''], 'Message' => ['description' => 'The returned message.', 'type' => 'string', 'example' => 'The specified parameter %s value is not valid.', 'title' => ''], ], 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 403 => [ ['errorCode' => 'Request.Forbidden', 'errorMessage' => 'Have no Permissions', 'description' => ''], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'DescribeBackupDataList', 'description' => '### Applicable engines'."\n" ."\n" .'PolarDB for MySQL'."\n" ."\n" .'> This API operation is available only to specific customers. To use this operation, join the DBS Customer Service DingTalk group (ID: 35585947) to request access.'."\n" ."\n" .'### Related documents'."\n" ."\n" .'[Back up a PolarDB for MySQL cluster](~~88172~~)', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'list', 'ramAction' => [ 'action' => 'dbs:DescribeBackupDataList', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'conditional', 'product' => 'DBS', 'resourceType' => 'DBInstance', 'arn' => 'acs:rds:{#regionId}:{#accountId}:dbinstance/{#DbInstanceId}'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"Content\\": [\\n {\\n \\"BackupId\\": \\"213088****\\",\\n \\"BackupName\\": \\"logic_backup\\",\\n \\"BackupMode\\": \\"Automated\\",\\n \\"BackupType\\": \\"FullBackup\\",\\n \\"BackupScale\\": \\"DBInstance\\",\\n \\"BackupMethod\\": \\"Snapshot\\",\\n \\"BackupSize\\": 25669140480,\\n \\"BackupStatus\\": \\"OK\\",\\n \\"BackupStartTime\\": \\"2024-04-17T17:00:16Z\\",\\n \\"BackupEndTime\\": \\"2024-04-17T17:00:32Z\\",\\n \\"ConsistentTime\\": 1713373221,\\n \\"BackupLocation\\": \\"logic\\",\\n \\"InstanceName\\": \\"pc-2ze3nrr64c5******\\",\\n \\"Engine\\": \\"polardb_mysql\\",\\n \\"EngineVersion\\": \\"5.7\\",\\n \\"SupportDeletion\\": 0,\\n \\"Encryption\\": \\"psk2\\",\\n \\"IsAvail\\": 1,\\n \\"Checksum\\": \\"84a4c16431f969712e6895992719****\\",\\n \\"BackupDownloadURL\\": \\"http://oss.com/****\\",\\n \\"BackupIntranetDownloadURL\\": \\"http://oss.com/****\\",\\n \\"ExpectExpireType\\": \\"DELAY\\",\\n \\"ExpectExpireTime\\": \\"2024-04-19T05:00:49Z\\",\\n \\"PolarSnapshot\\": {\\n \\"DumpId\\": 0,\\n \\"DumpSize\\": 25669140589,\\n \\"expectExpireType\\": \\"DELAY\\",\\n \\"ExpectExpireTime\\": \\"2024-04-19T05:00:49Z\\"\\n }\\n }\\n ],\\n \\"PageSize\\": 20,\\n \\"PageNumber\\": 1,\\n \\"TotalPages\\": 1,\\n \\"TotalElements\\": 1,\\n \\"Extra\\": \\"dbtest\\"\\n },\\n \\"RequestId\\": \\"95A5FFD0-7F46-5A7D-9DFE-6A376B4E2A28\\",\\n \\"ErrCode\\": \\"Request.Forbidden\\\\t\\",\\n \\"Success\\": \\"true\\",\\n \\"ErrMessage\\": \\"The specified parameter %s value is not valid. \\",\\n \\"Code\\": \\"Success\\",\\n \\"Message\\": \\"The specified parameter %s value is not valid.\\"\\n}","type":"json"}]', ], 'DescribeBackupPolicy' => [ 'methods' => ['post', 'get'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '215256', 'abilityTreeNodes' => ['FEATUREcbsPNQ3FN'], ], 'parameters' => [ [ 'name' => 'RegionCode', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'The region where the backup set is located.', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing'], ], [ 'name' => 'InstanceName', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'The PolarDB instance ID.', 'type' => 'string', 'required' => false, 'example' => 'pc-2ze3nrr64c5****'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '54A63B3B-AA10-1CC3-A6BB-6CCE98D19628', 'title' => ''], 'Message' => ['description' => 'The returned message.', 'type' => 'string', 'example' => 'instanceName can not be empty.', 'title' => ''], 'Data' => [ 'description' => 'The backup policy details.', 'type' => 'object', 'properties' => [ 'PreferredBackupDate' => ['title' => '', 'description' => 'The backup cycle for basic backup. A 7-digit string is returned, where each digit from left to right corresponds to Monday through Sunday. 1 indicates backup is performed, and 0 indicates no backup.', 'type' => 'string', 'example' => '1010101'], 'PreferredBackupWindowBegin' => ['title' => '', 'description' => 'The start time of the basic backup window.', 'type' => 'string', 'example' => '23:00Z'], 'PreferredBackupWindow' => ['title' => '', 'description' => 'The basic backup window.', 'type' => 'string', 'example' => '23:00Z-24:00Z'], 'BackupRetentionPeriod' => ['title' => '', 'description' => 'The basic backup retention period. If the advanced backup policy is enabled, this is the longest retention period in the level-1 backup policy.', 'type' => 'integer', 'format' => 'int32', 'example' => '7'], 'BackupRetentionPolicyOnClusterDeletion' => ['title' => '', 'description' => 'The archive backup retention policy for deleted instances. Valid values:'."\n" ."\n" .'- **NONE**: Do not retain'."\n" .'- **LATEST**: Retain the last one'."\n" .'- **ALL**: Retain all', 'type' => 'string', 'example' => 'LATEST'], 'HighFrequencyBakInterval' => ['title' => '', 'description' => 'The high-frequency backup interval. For example, 120 indicates a backup every two hours. Unit: minutes.', 'type' => 'integer', 'format' => 'int32', 'example' => '120'], 'BackupPriority' => ['title' => '', 'description' => 'The secondary instance backup setting. Valid values:'."\n" ."\n" .'- **1**: Prefer secondary instance'."\n" .'- **2**: Force primary instance'."\n" ."\n" .'> This parameter applies only to RDS SQL Server instances. For other engines, the return value is **0**.', 'type' => 'integer', 'format' => 'int32', 'example' => '0'], 'EnableLogBackup' => ['title' => '', 'description' => 'Indicates whether log backup is enabled. Valid values:'."\n" ."\n" .'- **1**: Enabled'."\n" .'- **0**: Disabled', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], 'LogBackupRetention' => ['title' => '', 'description' => 'The log backup retention period.', 'type' => 'integer', 'format' => 'int32', 'example' => '7'], 'LogBackupLocalRetentionNumber' => ['title' => '', 'description' => 'The number of local log files retained.', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], 'EnableBackup' => ['title' => '', 'description' => 'Indicates whether backup is enabled.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], 'LocalLogRetentionSpace' => ['title' => '', 'description' => 'The maximum local log space usage rate.', 'type' => 'integer', 'format' => 'int32', 'example' => '30'], 'HighSpaceUsageProtection' => ['title' => '', 'description' => 'Indicates whether to force log cleanup when instance space usage exceeds 80% or remaining space is less than 5 GB:'."\n" ."\n" .'- **Disable**: Do not clean up'."\n" .'- **Enable**: Clean up', 'type' => 'string', 'example' => 'Enable'], 'Category' => ['title' => '', 'description' => 'Indicates whether second-level backup is enabled. Valid values:'."\n" ."\n" .'- **Flash**: Second-level backup enabled'."\n" .'- **Standard**: Standard backup'."\n" ."\n" .'> This parameter only applies to MySQL.', 'type' => 'string', 'example' => 'Standard'], 'IncBackupInterval' => ['title' => '', 'description' => 'The high-frequency incremental backup interval.', 'type' => 'integer', 'format' => 'int32', 'example' => '-1'], 'EnableIncBackup' => ['title' => '', 'description' => 'Indicates whether incremental backup is enabled.', 'type' => 'integer', 'format' => 'int32', 'example' => '0'], 'BackupMethod' => ['title' => '', 'description' => 'The backup method. Valid values:'."\n" ."\n" .'- **Physical**: Physical backup'."\n" .'- **Snapshot**: Snapshot backup', 'type' => 'string', 'example' => 'Physical'], 'AdvanceLogPolicies' => [ 'description' => 'The log backup policy details.', 'type' => 'array', 'items' => [ 'description' => 'The policy details.', 'type' => 'object', 'properties' => [ 'PolicyId' => ['title' => '', 'description' => 'The backup policy ID.', 'type' => 'string', 'example' => 'dc13b153acc91141789122c23835****'], 'SrcType' => ['title' => '', 'description' => 'The backup policy source type. Valid values:'."\n" ."\n" .'- **db**: Database'."\n" .'- **level1**: Level-1 backup'."\n" .'- **level2**: Level-2 backup'."\n" .'- **level2Cross**: Level-2 cross-region backup', 'type' => 'string', 'example' => 'level1'], 'SrcRegion' => ['title' => '', 'description' => 'The backup policy source region.', 'type' => 'string', 'example' => 'cn-beijing'], 'DestType' => ['title' => '', 'description' => 'The backup policy destination type. Valid values:'."\n" ."\n" .'- **db**: Database'."\n" .'- **level1**: Level-1 backup'."\n" .'- **level2**: Level-2 backup'."\n" .'- **level2Cross**: Level-2 cross-region backup', 'type' => 'string', 'example' => 'level1'], 'DestRegion' => ['title' => '', 'description' => 'The backup policy destination region.', 'type' => 'string', 'example' => 'cn-shanghai'], 'EnableLogBackup' => ['description' => 'Reserved parameter. No attention required.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], 'LogRetentionType' => ['title' => '', 'description' => 'The log backup retention type. Valid values:'."\n" ."\n" .'- **never**: Never expire'."\n" .'- **delay**: Expire after fixed number of days', 'type' => 'string', 'example' => 'delay'], 'LogRetentionValue' => ['title' => '', 'description' => 'The log backup retention period.', 'type' => 'string', 'example' => '3'], 'FilterType' => ['description' => 'The advanced policy filter type. Valid values:'."\n" ."\n" .'crontab: Scheduled periodically'."\n" ."\n" .'event: Event-triggered', 'type' => 'string', 'example' => 'crontab', 'title' => ''], 'FilterKey' => ['description' => 'The scheduling type. Valid values:'."\n" ."\n" .'dayOfWeek: Weekly schedule'."\n" ."\n" .'dayOfMonth: Monthly schedule'."\n" ."\n" .'dayOfYear: Yearly schedule'."\n" ."\n" .'backupInterval: Fixed interval schedule'."\n" ."\n" .'Note: This parameter is returned only when FilterType is crontab.', 'type' => 'string', 'example' => 'dayOfWeek', 'title' => ''], 'FilterValue' => ['description' => 'The backup cycle.', 'type' => 'string', 'example' => '1,2,3,4,5,6,7', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], 'AdvanceDataPolicies' => [ 'description' => 'The data backup policy details.', 'type' => 'array', 'items' => [ 'description' => 'The policy details.', 'type' => 'object', 'properties' => [ 'PolicyId' => ['title' => '', 'description' => 'The advanced policy ID.', 'type' => 'string', 'example' => '71930ac2e9f15e41615e10627c******'], 'FilterType' => ['title' => '', 'description' => 'The advanced policy filter type. Valid values:'."\n" ."\n" .'- **crontab**: Scheduled periodically'."\n" .'- **event**: Event-triggered', 'type' => 'string', 'example' => 'crontab'], 'FilterKey' => ['title' => '', 'description' => 'The scheduling type. Valid values:'."\n" ."\n" .'- **dayOfWeek**: Weekly schedule'."\n" .'- **dayOfMonth**: Monthly schedule'."\n" .'- **dayOfYear**: Yearly schedule'."\n" .'- **backupInterval**: Fixed interval schedule'."\n" ."\n" .'> This parameter is returned only when FilterType is **crontab**.', 'type' => 'string', 'example' => 'dayOfWeek'], 'FilterValue' => ['title' => '', 'description' => 'The backup cycle.', 'type' => 'string', 'example' => '1,2,3,4,5,6,7'], 'DumpAction' => ['title' => '', 'description' => 'The dump policy. Valid values:'."\n" ."\n" .'- **copy**: Copy'."\n" .'- **move**: Dump', 'type' => 'string', 'example' => 'copy'], 'RetentionType' => ['title' => '', 'description' => 'The backup set retention period type. Valid values:'."\n" ."\n" .'- **never**: Never expire'."\n" .'- **delay**: Expire after fixed number of days', 'type' => 'string', 'example' => 'delay'], 'RetentionValue' => ['title' => '', 'description' => 'The number of days before expiration.', 'type' => 'string', 'example' => '7'], 'SrcType' => ['title' => '', 'description' => 'The backup policy source type. Valid values:'."\n" ."\n" .'- **db**: Database'."\n" .'- **level1**: Level-1 backup'."\n" .'- **level2**: Level-2 backup'."\n" .'- **level2Cross**: Level-2 cross-region backup', 'type' => 'string', 'example' => 'db'], 'SrcRegion' => ['title' => '', 'description' => 'The backup policy source region.', 'type' => 'string', 'example' => 'cn-beijing'], 'DestType' => ['title' => '', 'description' => 'The backup policy destination type. Valid values:'."\n" ."\n" .'- **db**: Database'."\n" .'- **level1**: Level-1 backup'."\n" .'- **level2**: Level-2 backup'."\n" .'- **level2Cross**: Level-2 cross-region backup', 'type' => 'string', 'example' => 'level1'], 'DestRegion' => ['title' => '', 'description' => 'The backup policy destination region.', 'type' => 'string', 'example' => 'cn-beijing'], 'BakType' => ['title' => '', 'description' => 'The backup type. Valid values:'."\n" ."\n" .'- **F**: Full backup'."\n" .'- **L**: Log backup', 'type' => 'string', 'example' => 'F'], 'AutoCreated' => ['title' => '', 'description' => 'Indicates whether this is a system-automatically generated backup policy. Valid values:'."\n" ."\n" .'- **true**: System-generated policy'."\n" .'- **false**: User-defined policy', 'type' => 'boolean', 'example' => 'true'], 'StorageClass' => ['description' => 'The data storage type.', 'type' => 'string', 'example' => 'STANDARD', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], 'AdvanceIncPolicies' => [ 'description' => 'The advanced incremental backup policies.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'PolicyId' => ['title' => '', 'description' => 'The advanced policy ID.', 'type' => 'string', 'example' => 'smp-l0bfdmlr4c***'], 'FilterType' => ['title' => '', 'description' => 'The advanced policy filter type. Valid values:'."\n" ."\n" .'- **crontab**: Scheduled periodically'."\n" .'- **event**: Event-triggered', 'type' => 'string', 'example' => 'crontab'], 'FilterKey' => ['title' => '', 'description' => 'The scheduling type. Only valid when FilterType is crontab. Valid values:'."\n" ."\n" .'- **dayOfWeek**: Weekly schedule'."\n" .'- **dayOfMonth**: Monthly schedule'."\n" .'- **dayOfYear**: Yearly schedule'."\n" .'- **backupInterval**: Fixed interval schedule', 'type' => 'string', 'example' => 'dayOfMonth'], 'FilterValue' => ['title' => '', 'description' => 'The specific filter value.', 'type' => 'string', 'example' => '1'], 'DumpAction' => ['title' => '', 'description' => 'The dump policy. Valid values:'."\n" ."\n" .'- **Copy**: Copy'."\n" .'- **Move**: Dump', 'type' => 'string', 'example' => 'Copy'], 'RetentionType' => ['title' => '', 'description' => 'The retention period type. Valid values:'."\n" ."\n" .'- **Never**: Never expire'."\n" .'- **Delay**: Expire after fixed number of days', 'type' => 'string', 'example' => 'delay'], 'RetentionValue' => ['title' => '', 'description' => 'The number of days before expiration.', 'type' => 'string', 'example' => '365'], 'SrcType' => ['title' => '', 'description' => 'The backup policy source type. Valid values:'."\n" ."\n" .'- **db**: Database'."\n" .'- **level1**: Level-1 backup'."\n" .'- **level2**: Level-2 backup'."\n" .'- **level2Cross**: Level-2 cross-region backup', 'type' => 'string', 'example' => 'db'], 'SrcRegion' => ['title' => '', 'description' => 'The backup policy source region.', 'type' => 'string', 'example' => 'cn-hangzhou'], 'DestType' => ['title' => '', 'description' => 'The backup policy destination type. Valid values:'."\n" ."\n" .'- **db**: Database'."\n" .'- **level1**: Level-1 backup'."\n" .'- **level2**: Level-2 backup'."\n" .'- **level2Cross**: Level-2 cross-region backup', 'type' => 'string', 'example' => 'db'], 'DestRegion' => ['title' => '', 'description' => 'The backup policy destination region.', 'type' => 'string', 'example' => 'cn-hangzhou'], 'BakType' => ['title' => '', 'description' => 'The backup type. Valid values:'."\n" ."\n" .'- **F**: Full backup'."\n" .'- **L**: Log backup', 'type' => 'string', 'example' => 'F'], 'AutoCreated' => ['title' => '', 'description' => 'Indicates whether this is system-automatically generated.', 'type' => 'boolean', 'example' => 'true'], ], 'description' => '', 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], 'PreferredNextBackupTime' => ['type' => 'string', 'example' => '2025-07-08T16:05Z', 'description' => '', 'title' => ''], 'EnablePitrProtection' => ['type' => 'boolean', 'description' => '', 'title' => '', 'example' => ''], 'LogBackupLocalRetention' => ['type' => 'integer', 'format' => 'int32', 'example' => '7', 'description' => '', 'title' => ''], 'ColdRetention' => ['type' => 'integer', 'format' => 'int32', 'example' => '30', 'description' => '', 'title' => ''], 'ColdKeepPolicy' => ['type' => 'integer', 'format' => 'int32', 'example' => '1', 'description' => '', 'title' => ''], 'ColdKeepCount' => ['type' => 'integer', 'format' => 'int32', 'example' => '1', 'description' => '', 'title' => ''], ], 'title' => '', 'example' => '', ], 'ErrMessage' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'The specified parameter %s value is not valid. ', 'title' => ''], 'Code' => ['description' => 'The status code.', 'type' => 'string', 'example' => 'Success', 'title' => ''], 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" .'- **true**: The request was successful.'."\n" .'- **false**: The request failed.', 'type' => 'string', 'example' => 'true', 'title' => ''], 'ErrCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'Success', 'title' => ''], ], 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 403 => [ ['errorCode' => 'Request.Forbidden', 'errorMessage' => 'Have no Permissions', 'description' => ''], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'DescribeBackupPolicy', 'summary' => 'Queries the backup policy of a PolarDB instance.', 'description' => '### Supported engines'."\n" .'PolarDB MySQL Edition'."\n" ."\n" .'> This API is currently available only to specific customers. If you need access, please apply through the DBS customer consultation group (DingTalk group number: 35585947).'."\n" ."\n" .'### Related documentation'."\n" .'[PolarDB MySQL Edition backup policy](~~280422~~)', 'changeSet' => [ ['createdAt' => '2024-05-28T13:59:23.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2024-05-17T02:21:41.000Z', 'description' => 'Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'dbs:DescribeBackupPolicy', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'DBS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"54A63B3B-AA10-1CC3-A6BB-6CCE98D19628\\",\\n \\"Message\\": \\"instanceName can not be empty.\\",\\n \\"Data\\": {\\n \\"PreferredBackupDate\\": \\"1010101\\",\\n \\"PreferredBackupWindowBegin\\": \\"23:00Z\\",\\n \\"PreferredBackupWindow\\": \\"23:00Z-24:00Z\\",\\n \\"BackupRetentionPeriod\\": 7,\\n \\"BackupRetentionPolicyOnClusterDeletion\\": \\"LATEST\\",\\n \\"HighFrequencyBakInterval\\": 120,\\n \\"BackupPriority\\": 0,\\n \\"EnableLogBackup\\": 1,\\n \\"LogBackupRetention\\": 7,\\n \\"LogBackupLocalRetentionNumber\\": 10,\\n \\"EnableBackup\\": 1,\\n \\"LocalLogRetentionSpace\\": 30,\\n \\"HighSpaceUsageProtection\\": \\"Enable\\",\\n \\"Category\\": \\"Standard\\",\\n \\"IncBackupInterval\\": -1,\\n \\"EnableIncBackup\\": 0,\\n \\"BackupMethod\\": \\"Physical\\",\\n \\"AdvanceLogPolicies\\": [\\n {\\n \\"PolicyId\\": \\"dc13b153acc91141789122c23835****\\",\\n \\"SrcType\\": \\"level1\\",\\n \\"SrcRegion\\": \\"cn-beijing\\",\\n \\"DestType\\": \\"level1\\",\\n \\"DestRegion\\": \\"cn-shanghai\\",\\n \\"EnableLogBackup\\": 1,\\n \\"LogRetentionType\\": \\"delay\\",\\n \\"LogRetentionValue\\": \\"3\\",\\n \\"FilterType\\": \\"crontab\\",\\n \\"FilterKey\\": \\"dayOfWeek\\",\\n \\"FilterValue\\": \\"1,2,3,4,5,6,7\\"\\n }\\n ],\\n \\"AdvanceDataPolicies\\": [\\n {\\n \\"PolicyId\\": \\"71930ac2e9f15e41615e10627c******\\",\\n \\"FilterType\\": \\"crontab\\",\\n \\"FilterKey\\": \\"dayOfWeek\\",\\n \\"FilterValue\\": \\"1,2,3,4,5,6,7\\",\\n \\"DumpAction\\": \\"copy\\",\\n \\"RetentionType\\": \\"delay\\",\\n \\"RetentionValue\\": \\"7\\",\\n \\"SrcType\\": \\"db\\",\\n \\"SrcRegion\\": \\"cn-beijing\\",\\n \\"DestType\\": \\"level1\\",\\n \\"DestRegion\\": \\"cn-beijing\\",\\n \\"BakType\\": \\"F\\",\\n \\"AutoCreated\\": true,\\n \\"StorageClass\\": \\"STANDARD\\"\\n }\\n ],\\n \\"AdvanceIncPolicies\\": [\\n {\\n \\"PolicyId\\": \\"smp-l0bfdmlr4c***\\",\\n \\"FilterType\\": \\"crontab\\",\\n \\"FilterKey\\": \\"dayOfMonth\\",\\n \\"FilterValue\\": \\"1\\",\\n \\"DumpAction\\": \\"Copy\\",\\n \\"RetentionType\\": \\"delay\\",\\n \\"RetentionValue\\": \\"365\\",\\n \\"SrcType\\": \\"db\\",\\n \\"SrcRegion\\": \\"cn-hangzhou\\",\\n \\"DestType\\": \\"db\\",\\n \\"DestRegion\\": \\"cn-hangzhou\\",\\n \\"BakType\\": \\"F\\",\\n \\"AutoCreated\\": true\\n }\\n ],\\n \\"PreferredNextBackupTime\\": \\"2025-07-08T16:05Z\\",\\n \\"EnablePitrProtection\\": false,\\n \\"LogBackupLocalRetention\\": 7,\\n \\"ColdRetention\\": 30,\\n \\"ColdKeepPolicy\\": 1,\\n \\"ColdKeepCount\\": 1\\n },\\n \\"ErrMessage\\": \\"The specified parameter %s value is not valid. \\",\\n \\"Code\\": \\"Success\\",\\n \\"Success\\": \\"true\\",\\n \\"ErrCode\\": \\"Success\\"\\n}","type":"json"}]', ], 'DescribeCostInfoByDbsInstance' => [ 'summary' => 'Queries the costs for a DBS instance.', 'methods' => ['get', 'post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'RegionCode', 'in' => 'query', 'schema' => ['description' => 'The ID of the region where the instance is located. You can find this information in your bill.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''], ], [ 'name' => 'BackupPlanId', 'in' => 'query', 'schema' => ['description' => 'The ID of the backup billing instance.', 'type' => 'string', 'required' => false, 'example' => 'dbsr1l3ro21****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'type' => 'object', 'properties' => [ 'Data' => ['description' => 'Parameter descriptions:'."\n" ."\n" .'- **commodity**: The commodity.'."\n" ."\n" .'- **product**: The product.'."\n" ."\n" .'- **moduleCode**: The billing item.'."\n" ."\n" .'- **instanceName**: The sandbox instance ID.'."\n" ."\n" .'- **backupSetId**: The backup set ID.'."\n" ."\n" .'- **instanceName**: The name of the engine instance.'."\n" ."\n" .'- **backupPlanId**: The ID of the backup billing instance.', 'type' => 'string', 'example' => '{'."\n" .' "backupPlanComment": "",'."\n" .' "commodity": "cbs_post",'."\n" .' "product": "cbs",'."\n" .' "moduleCode": "BackupStorageSize",'."\n" .' "instanceName": "d-2zefd6337d766294",'."\n" .' "backupPlanId": "dbs:d-2zefd6337d766294",'."\n" .' "moduleName": "mongodb"'."\n" .' }', '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' => 'string', 'example' => 'true', 'title' => ''], 'ErrMessage' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'The specified parameter %s value is not valid. ', 'title' => ''], 'Code' => ['description' => 'The status code.', 'type' => 'string', 'example' => 'Success', 'title' => ''], 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'The specified parameter %s value is not valid.', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 403 => [ ['errorCode' => 'Request.Forbidden', 'errorMessage' => 'Have no Permissions', 'description' => ''], ], ], 'title' => 'DescribeCostInfoByDbsInstance', 'description' => 'This operation is available only in version 2021-01-01 of the DBS API.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'dbs:DescribeCostInfoByDbsInstance', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'DBS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": \\"{\\\\n \\\\\\"backupPlanComment\\\\\\": \\\\\\"\\\\\\",\\\\n \\\\\\"commodity\\\\\\": \\\\\\"cbs_post\\\\\\",\\\\n \\\\\\"product\\\\\\": \\\\\\"cbs\\\\\\",\\\\n \\\\\\"moduleCode\\\\\\": \\\\\\"BackupStorageSize\\\\\\",\\\\n \\\\\\"instanceName\\\\\\": \\\\\\"d-2zefd6337d766294\\\\\\",\\\\n \\\\\\"backupPlanId\\\\\\": \\\\\\"dbs:d-2zefd6337d766294\\\\\\",\\\\n \\\\\\"moduleName\\\\\\": \\\\\\"mongodb\\\\\\"\\\\n }\\",\\n \\"RequestId\\": \\"9C397502-B4F2-4E22-AD97-C81F0049F3F3\\",\\n \\"ErrCode\\": \\"Param.NotFound\\",\\n \\"Success\\": \\"true\\",\\n \\"ErrMessage\\": \\"The specified parameter %s value is not valid. \\",\\n \\"Code\\": \\"Success\\",\\n \\"Message\\": \\"The specified parameter %s value is not valid.\\"\\n}","type":"json"}]', ], 'DescribeDownloadBackupSetStorageInfo' => [ 'summary' => 'Queries the storage information for downloading a backup set.', 'methods' => ['get', 'post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '135676', 'abilityTreeNodes' => ['FEATUREcbs04Q4EK'], ], 'parameters' => [ [ 'name' => 'RegionCode', 'in' => 'query', 'schema' => ['description' => 'The ID of the region where the instance resides.', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ 'name' => 'Duration', 'in' => 'query', 'schema' => ['description' => 'If the download destination is a URL, this parameter specifies the validity period of the link.'."\n" ."\n" .'- The default validity period of a URL is 2 hours (7,200 seconds).'."\n" ."\n" .'- You can set the validity period to a value from 5 minutes (300 seconds) to 1 day (86,400 seconds).'."\n" ."\n" .'- Convert the value to seconds before you pass it. For example, to set the validity period to 5 minutes, pass 300.', 'type' => 'string', 'required' => true, 'example' => '300', 'title' => ''], ], [ 'name' => 'InstanceName', 'in' => 'query', 'schema' => ['description' => 'The instance ID.'."\n" ."\n" .'> If you specify **InstanceName**, you must also specify **BackupSetId**.', 'type' => 'string', 'required' => false, 'example' => 'rm-uf6qqf569n435****', 'title' => ''], ], [ 'name' => 'TaskId', 'in' => 'query', 'schema' => ['description' => 'The ID of the download task.'."\n" ."\n" .'- If you do not specify **TaskId**, you must specify **BackupSetId** and **InstanceName**.'."\n" ."\n" .'- To view the task ID, click **Backup and Restoration** for the target instance and go to the **Backup Download** tab.', 'type' => 'string', 'required' => false, 'example' => 'dt-s0ugzak9****', 'title' => ''], ], [ 'name' => 'BackupSetId', 'in' => 'query', 'schema' => ['description' => 'The ID of the backup set.', 'type' => 'string', 'required' => false, 'example' => '30****', 'title' => ''], ], [ 'name' => 'ClusterName', 'in' => 'query', 'schema' => ['description' => 'This parameter is required only for MongoDB instances. It specifies the name of the sharded cluster.', 'type' => 'string', 'example' => 'dds-example', 'title' => '', 'required' => false], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The returned data.', 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '44B8C2F5-919D-5D29-BCD5-DEB03467****', 'title' => ''], 'ErrCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'DBS.ParamIsInValid', 'title' => ''], 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" ."\n" .'- **true**: The request was successful.'."\n" ."\n" .'- **false**: The request failed.', 'type' => 'string', 'example' => 'true', 'title' => ''], 'ErrMessage' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'Argument: regionCode Must not be empty', 'title' => ''], 'Code' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'DBS.ParamIsInValid', 'title' => ''], 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'Argument: regionCode Must not be empty', 'title' => ''], 'Data' => [ 'description' => 'The returned data.', 'type' => 'object', 'properties' => [ 'PublicUrl' => ['description' => 'The public URL to download the backup set.', 'type' => 'string', 'example' => 'http://dbs-137383785969****-cn-hangzhou-1iv12nblw****.oss-cn-hangzhou.aliyuncs.com/dt-u7u4bufa****/dbs_target_file_path/test_456', 'title' => ''], 'PrivateUrl' => ['description' => 'The private URL to download the backup set.', 'type' => 'string', 'example' => 'http://dbs-137383785969****-cn-hangzhou-1iv12nblw****.oss-cn-hangzhou-internal.aliyuncs.com/dt-u7u4bufa****/dbs_target_file_path/test_123', 'title' => ''], 'ExpirationTime' => ['description' => 'The validity period of the link.'."\n" ."\n" .'> The value is a UNIX timestamp.', 'type' => 'integer', 'format' => 'int64', 'example' => '1661329050', 'title' => ''], ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 403 => [ ['errorCode' => 'Request.Forbidden', 'errorMessage' => 'Have no Permissions', 'description' => ''], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"44B8C2F5-919D-5D29-BCD5-DEB03467****\\",\\n \\"ErrCode\\": \\"DBS.ParamIsInValid\\",\\n \\"Success\\": \\"true\\",\\n \\"ErrMessage\\": \\"Argument: regionCode Must not be empty\\",\\n \\"Code\\": \\"DBS.ParamIsInValid\\",\\n \\"Message\\": \\"Argument: regionCode Must not be empty\\",\\n \\"Data\\": {\\n \\"PublicUrl\\": \\"http://dbs-137383785969****-cn-hangzhou-1iv12nblw****.oss-cn-hangzhou.aliyuncs.com/dt-u7u4bufa****/dbs_target_file_path/test_456\\",\\n \\"PrivateUrl\\": \\"http://dbs-137383785969****-cn-hangzhou-1iv12nblw****.oss-cn-hangzhou-internal.aliyuncs.com/dt-u7u4bufa****/dbs_target_file_path/test_123\\",\\n \\"ExpirationTime\\": 1661329050\\n }\\n}","type":"json"}]', 'title' => 'DescribeDownloadBackupSetStorageInfo', 'description' => '### Applicable engines'."\n" ."\n" .'- RDS MySQL (cloud disk edition)'."\n" ."\n" .'- RDS PostgreSQL'."\n" ."\n" .'- PolarDB for MySQL'."\n" ."\n" .'- MongoDB'."\n" ."\n" .'### Related documents'."\n" ."\n" .'- [Download an RDS MySQL backup](~~98819~~)'."\n" ."\n" .'- [Download an RDS PostgreSQL backup](~~96774~~)'."\n" ."\n" .'- [Download a PolarDB for MySQL backup](~~2627635~~)'."\n" ."\n" .'- [Download a MongoDB backup](~~55011~~)', 'changeSet' => [ ['createdAt' => '2022-08-25T07:43:22.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2022-08-03T09:23:52.000Z', 'description' => 'OpenAPI offline'], ], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'dbs:DescribeDownloadBackupSetStorageInfo', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'DBS', 'resourceType' => 'BackupPlan', 'arn' => 'acs:dbs:{#regionId}:{#accountId}:backupplan/{#BackupPlanId}'], ], ], ], ], ], 'DescribeDownloadSupport' => [ 'summary' => 'Queries whether the current instance supports the Advanced Download feature.', 'methods' => ['get', 'post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREcbs04Q4EK'], ], 'parameters' => [ [ 'name' => 'RegionCode', 'in' => 'query', 'schema' => ['description' => 'The region ID of the instance. You can call the [DescribeDBInstanceAttribute](~~26231~~) operation to query the region ID.', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ 'name' => 'InstanceName', 'in' => 'query', 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'rm-bp1a48p922r4b****', 'title' => ''], ], [ 'name' => 'ClusterName', 'in' => 'query', 'schema' => ['description' => 'The name of the sharded cluster. This parameter is required only for MongoDB sharded cluster instances.', 'type' => 'string', 'example' => 'dds-example', 'title' => '', 'required' => false], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response.', 'type' => 'object', 'properties' => [ 'Data' => ['description' => 'Indicates whether the Advanced Download feature is supported. Valid values:'."\n" ."\n" .'- **true**: The feature is supported.'."\n" ."\n" .'- **false**: The feature is not supported.', 'type' => 'string', 'example' => 'true', 'title' => ''], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'F1A186F7-7B34-5C11-A903-EE23876B****', 'title' => ''], 'ErrCode' => ['description' => 'The error code returned if the call fails.', 'type' => 'string', 'example' => 'DBS.ParamIsInValid', 'title' => ''], 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" ."\n" .'- **true**: The request was successful.'."\n" ."\n" .'- **false**: The request failed.', 'type' => 'string', 'example' => 'true', 'title' => ''], 'ErrMessage' => ['description' => 'The error message returned if the call fails.', 'type' => 'string', 'example' => 'Argument: regionCode Must not be empty', 'title' => ''], 'Code' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'DBS.ParamIsInValid', 'title' => ''], 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'Argument: regionCode Must not be empty', 'title' => ''], ], 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 403 => [ ['errorCode' => 'Request.Forbidden', 'errorMessage' => 'Have no Permissions', 'description' => ''], ], ], 'staticInfo' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": \\"true\\",\\n \\"RequestId\\": \\"F1A186F7-7B34-5C11-A903-EE23876B****\\",\\n \\"ErrCode\\": \\"DBS.ParamIsInValid\\",\\n \\"Success\\": \\"true\\",\\n \\"ErrMessage\\": \\"Argument: regionCode Must not be empty\\",\\n \\"Code\\": \\"DBS.ParamIsInValid\\",\\n \\"Message\\": \\"Argument: regionCode Must not be empty\\"\\n}","type":"json"}]', 'title' => 'DescribeDownloadSupport', 'description' => '### Applicable engines'."\n" ."\n" .'- RDS MySQL (with cloud disks)'."\n" ."\n" .'- RDS PostgreSQL'."\n" ."\n" .'- PolarDB for MySQL'."\n" ."\n" .'- MongoDB'."\n" ."\n" .'### Related documents'."\n" ."\n" .'You can create an Advanced Download task for a point in time or a specific backup set. You can specify a URL as the download destination or write the data directly to your Object Storage Service (OSS) bucket for data analytics and offline archiving.'."\n" ."\n" .'- [Download an RDS MySQL backup](~~98819~~)'."\n" ."\n" .'- [Download an RDS PostgreSQL backup](~~96774~~)'."\n" ."\n" .'- [Download a PolarDB for MySQL backup](~~2627635~~)'."\n" ."\n" .'- [Download a MongoDB backup](~~55011~~)', 'changeSet' => [ ['createdAt' => '2022-08-25T07:43:22.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2022-08-03T09:23:52.000Z', 'description' => 'OpenAPI offline'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '400', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeDownloadSupport'], ], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'dbs:DescribeDownloadSupport', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'DBS', 'resourceType' => 'BackupPlan', 'arn' => 'acs:dbs:{#regionId}:{#accountId}:backupplan/{#BackupPlanId}'], ], ], ], ], ], 'DescribeDownloadTask' => [ 'summary' => 'Queries a list of advanced download tasks for RDS for MySQL, RDS for PostgreSQL, and PolarDB for MySQL instances.', 'methods' => ['get', 'post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREcbs04Q4EK'], ], 'parameters' => [ [ 'name' => 'RegionCode', 'in' => 'query', 'schema' => ['description' => 'The ID of the region where the instance resides. To obtain the region ID, call [DescribeDBInstanceAttribute](~~26231~~).', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ 'name' => 'InstanceName', 'in' => 'query', 'schema' => ['description' => 'The instance ID.'."\n" ."\n" .'> This parameter is required.', 'type' => 'string', 'required' => false, 'example' => 'rm-bp1imnmcjxdz7****', 'title' => ''], ], [ 'name' => 'DatasourceId', 'in' => 'query', 'schema' => ['description' => 'The ID of the data source in DBS. The format is: *ds-${Instance ID}\\_${Region ID}*.', 'type' => 'string', 'required' => false, 'example' => 'ds-rm-2ze8g2am97624****_cn-hangzhou', 'title' => ''], ], [ 'name' => 'BackupSetId', 'in' => 'query', 'schema' => ['description' => 'The ID of the backup set. To obtain the backup set ID, call [DescribeBackups](~~26273~~).', 'type' => 'string', 'required' => false, 'example' => '216****', 'title' => ''], ], [ 'name' => 'State', 'in' => 'query', 'schema' => ['description' => 'The state of the download task. Valid values:'."\n" ."\n" .'- **initializing**: The task is being initialized.'."\n" ."\n" .'- **queueing**: The task is in a queue.'."\n" ."\n" .'- **running**: The task is running.'."\n" ."\n" .'- **failed**: The task failed.'."\n" ."\n" .'- **finished**: The task is successful.'."\n" ."\n" .'- **expired**: The download has expired.', 'type' => 'string', 'required' => false, 'example' => 'queueing', 'title' => ''], ], [ 'name' => 'TaskType', 'in' => 'query', 'schema' => ['description' => 'The type of the download task. Valid values:'."\n" ."\n" .'- **full**: full backup set download.'."\n" ."\n" .'- **pitr**: point-in-time recovery download.', 'type' => 'string', 'required' => false, 'example' => 'full', 'title' => ''], ], [ 'name' => 'StartTime', 'in' => 'query', 'schema' => ['description' => 'The start of the time range to query tasks based on their creation time. This is a UNIX timestamp in milliseconds (ms).', 'type' => 'string', 'required' => false, 'example' => '1661941554000', 'title' => ''], ], [ 'name' => 'EndTime', 'in' => 'query', 'schema' => ['description' => 'The end of the time range to query tasks based on their creation time. This is a UNIX timestamp in milliseconds (ms).', 'type' => 'string', 'required' => false, 'example' => '1661941556000', 'title' => ''], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => ['description' => 'The number of entries to return on each page.', 'type' => 'string', 'required' => false, 'example' => '50', 'title' => ''], ], [ 'name' => 'CurrentPage', 'in' => 'query', 'schema' => ['description' => 'The page number.', 'type' => 'string', 'required' => false, 'example' => '1', 'title' => ''], ], [ 'name' => 'OrderDirect', 'in' => 'query', 'schema' => ['description' => 'The sorting direction. Valid values:'."\n" ."\n" .'- **asc**: ascending order.'."\n" ."\n" .'- **desc**: descending order. This is the default value.', 'type' => 'string', 'required' => false, 'example' => 'desc', 'title' => ''], ], [ 'name' => 'OrderColumn', 'in' => 'query', 'schema' => ['description' => 'The field used for sorting. The default value is **gmt\\_create**, which indicates the creation time.', 'type' => 'string', 'required' => false, 'example' => 'gmt_create', 'title' => ''], ], [ 'name' => 'ClusterName', 'in' => 'query', 'schema' => ['description' => 'The name of the sharded cluster. This parameter is required only for MongoDB instances.', 'type' => 'string', 'example' => 'dds-example', 'title' => '', 'required' => false], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The returned parameters.', 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '5D285EB9-A443-592D-9F3D-A888FAC3****', 'title' => ''], 'ErrCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'DBS.InternalError', 'title' => ''], 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" ."\n" .'- **true**: The request was successful.'."\n" ."\n" .'- **false**: The request failed.', 'type' => 'string', 'example' => 'true', 'title' => ''], 'ErrMessage' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'instanceName can not be empty', 'title' => ''], 'Code' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'DBS.InternalError', 'title' => ''], 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'instanceName can not be empty', 'title' => ''], 'Data' => [ 'description' => 'The task details.', 'type' => 'object', 'properties' => [ 'PageNumber' => ['description' => 'The page number. It must be greater than 0 and not exceed the maximum value of the integer data type. Default value: 1.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], 'TotalPages' => ['description' => 'The total number of pages.', 'type' => 'integer', 'format' => 'int64', 'example' => '2', 'title' => ''], 'Extra' => ['description' => 'Additional information about the task that is used to back up data to the cloud.', 'type' => 'string', 'example' => 'dbtest', 'title' => ''], 'TotalElements' => ['description' => 'The total number of download tasks.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], 'PageSize' => ['description' => 'The number of entries returned per page.', 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'title' => ''], 'Content' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'List' => [ 'description' => 'The task details.', 'type' => 'array', 'items' => [ 'description' => 'The task details.', 'type' => 'object', 'properties' => [ 'TaskId' => ['description' => 'The download task ID.', 'type' => 'string', 'example' => 'dt-qxntlvgu****', 'title' => ''], 'RegionCode' => ['description' => 'The region ID.', 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''], 'Format' => ['description' => 'The destination format to which the downloaded data is converted. Valid values:'."\n" ."\n" .'- **csv**'."\n" ."\n" .'- **SQL**'."\n" ."\n" .'- **Parquet**', 'type' => 'string', 'example' => 'csv', 'title' => ''], 'DbList' => ['description' => 'The list of databases.', 'type' => 'string', 'example' => '[dbtest]', 'title' => ''], 'BakSetId' => ['description' => 'The ID of the full backup set.', 'type' => 'string', 'example' => '148261****', 'title' => ''], 'DownloadStatus' => ['description' => 'The state of the download task. Valid values:'."\n" ."\n" .'- **initializing**: The task is being initialized.'."\n" ."\n" .'- **queueing**: The task is in a queue.'."\n" ."\n" .'- **running**: The task is running.'."\n" ."\n" .'- **failed**: The task failed.'."\n" ."\n" .'- **finished**: The task is successful.'."\n" ."\n" .'- **expired**: The download has expired.', 'type' => 'string', 'example' => 'queueing', 'title' => ''], 'ExportDataSize' => ['description' => 'The volume of exported data, in bytes.', 'type' => 'string', 'example' => '0', 'title' => ''], 'ImportDataSize' => ['description' => 'The volume of processed data, in bytes.', 'type' => 'string', 'example' => '0', 'title' => ''], 'BackupSetTime' => ['description' => 'The point in time of the point-in-time download task. This is a UNIX timestamp in milliseconds (ms).', 'type' => 'string', 'example' => '1663162216000', 'title' => ''], 'TargetType' => ['description' => 'The type of the download destination. Valid values:'."\n" ."\n" .'- **OSS**'."\n" ."\n" .'- **URL**', 'type' => 'string', 'example' => 'URL', 'title' => ''], 'TargetPath' => ['description' => 'The destination path of the downloaded data. This parameter is returned when TargetType is set to **OSS**.', 'type' => 'string', 'example' => 'test_db/path', 'title' => ''], 'Progress' => ['description' => 'The number of exported tables/The total number of tables to be exported.', 'type' => 'string', 'example' => '0/0', 'title' => ''], 'GmtCreate' => ['description' => 'The time when the task was created. This is a UNIX timestamp in milliseconds.', 'type' => 'string', 'example' => '1663321957000', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 403 => [ ['errorCode' => 'Request.Forbidden', 'errorMessage' => 'Have no Permissions', 'description' => ''], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5D285EB9-A443-592D-9F3D-A888FAC3****\\",\\n \\"ErrCode\\": \\"DBS.InternalError\\",\\n \\"Success\\": \\"true\\",\\n \\"ErrMessage\\": \\"instanceName can not be empty\\",\\n \\"Code\\": \\"DBS.InternalError\\",\\n \\"Message\\": \\"instanceName can not be empty\\",\\n \\"Data\\": {\\n \\"PageNumber\\": 1,\\n \\"TotalPages\\": 2,\\n \\"Extra\\": \\"dbtest\\",\\n \\"TotalElements\\": 1,\\n \\"PageSize\\": 10,\\n \\"Content\\": {\\n \\"List\\": [\\n {\\n \\"TaskId\\": \\"dt-qxntlvgu****\\",\\n \\"RegionCode\\": \\"cn-hangzhou\\",\\n \\"Format\\": \\"csv\\",\\n \\"DbList\\": \\"[dbtest]\\",\\n \\"BakSetId\\": \\"148261****\\",\\n \\"DownloadStatus\\": \\"queueing\\",\\n \\"ExportDataSize\\": \\"0\\",\\n \\"ImportDataSize\\": \\"0\\",\\n \\"BackupSetTime\\": \\"1663162216000\\",\\n \\"TargetType\\": \\"URL\\",\\n \\"TargetPath\\": \\"test_db/path\\",\\n \\"Progress\\": \\"0/0\\",\\n \\"GmtCreate\\": \\"1663321957000\\"\\n }\\n ]\\n }\\n }\\n}","type":"json"}]', 'title' => 'DescribeDownloadTask', 'description' => '### Applicable engines'."\n" ."\n" .'- ApsaraDB RDS for MySQL instances that use cloud disks'."\n" ."\n" .'- ApsaraDB RDS for PostgreSQL'."\n" ."\n" .'- PolarDB for MySQL'."\n" ."\n" .'- MongoDB'."\n" ."\n" .'### Related documents'."\n" ."\n" .'- [Download the backup of an ApsaraDB RDS for MySQL instance](~~98819~~)'."\n" ."\n" .'- [Download the backup of an ApsaraDB RDS for PostgreSQL instance](~~96774~~)'."\n" ."\n" .'- [Download the backup of a PolarDB for MySQL instance](~~2627635~~)'."\n" ."\n" .'- [Download the backup of a MongoDB instance](~~55011~~)', 'changeSet' => [ ['createdAt' => '2022-11-16T11:43:03.000Z', 'description' => 'Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'dbs:DescribeDownloadTask', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'DBS', 'resourceType' => 'DBInstance', 'arn' => 'acs:rds:{#regionId}:{#accountId}:dbinstance/{#DbInstanceId}'], ], ], ], ], ], 'DescribeSandboxBackupSets' => [ 'summary' => 'Queries sandbox backup sets.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'BackupPlanId', 'in' => 'query', 'schema' => ['description' => 'The ID of the backup plan.'."\n" ."\n" .'> If your instance is an RDS for MySQL instance, automatically add the RDS instance to DBS to obtain the backup plan ID. For more information, see [Automatically add a data source](~~193091~~).', 'type' => 'string', 'required' => true, 'example' => '1hxxxx8xxxxxa', 'title' => ''], ], [ 'name' => 'BackupSetId', 'in' => 'query', 'schema' => ['description' => 'The ID of the backup set. If you specify this parameter, the operation returns information about the snapshots of only this backup set. If you do not specify this parameter, the operation returns information about the snapshots of all backup sets that are created for the backup plan.', 'type' => 'string', 'required' => false, 'example' => '1xxxx2xxxxx1e', 'title' => ''], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => ['description' => 'The number of entries per page. Valid values:'."\n" ."\n" .'- 30 (default)'."\n" ."\n" .'- 50'."\n" ."\n" .'- 100', 'type' => 'string', 'required' => false, 'example' => '30', 'title' => ''], ], [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => ['description' => 'The page number. The value must be greater than 0 and cannot exceed the maximum value of the integer data type. Default value: 1.', 'type' => 'string', 'required' => false, 'example' => '1', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Data' => ['description' => 'The data returned. The value of this parameter is a JSON string. The JSON string contains the following fields:'."\n" ."\n" .'- **backupSetTime**: The point in time of the snapshot. The time is in the yyyy-MM-ddTHH:mm:ssZ format and is displayed in Coordinated Universal Time (UTC).'."\n" ."\n" .'- **backupSetId**: The ID of the backup set.'."\n" ."\n" .'- **backupSetType**: The type of the snapshot. Valid values: **Full** (full backup) and **Inc** (incremental backup).'."\n" ."\n" .'- **backupPlanId**: The ID of the backup plan.', 'type' => 'string', 'example' => ' "Data": { "number": 2, "size": 2, "content": [ { "backupSetTime": "2021-08-28T23:12:31Z", "backupSetId": "Inc_1hxxxx8xxxxxa_20210801064200_mysql-bin.000134", "backupSetType": "Inc", "backupPlanId": "1hxxxx8xxxxxa" }, { "backupSetTime": "2021-08-28T22:42:28Z", "backupSetId": "1hxxxx8xxxxxa_20210829064228", "backupSetType": "FULL", "backupPlanId": "1hxxxx8xxxxxa" } ], "totalElements": 2 },', 'title' => ''], 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => '4F1888AC-1138-4995-B9FE-D2734F61C058', 'title' => ''], 'ErrCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'Param.NotFound', 'title' => ''], 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'string', 'example' => 'true', 'title' => ''], 'ErrMessage' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'The specified parameter %s value is not valid.', 'title' => ''], 'Code' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'Param.NotFound', 'title' => ''], 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'The specified parameter %s value is not valid.', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 403 => [ ['errorCode' => 'Request.Forbidden', 'errorMessage' => 'Have no Permissions', 'description' => ''], ], ], 'title' => 'DescribeSandboxBackupSets', 'description' => 'You must enable the sandbox feature for the database instance before you perform this operation. For more information, see [Emergency recovery for an RDS for MySQL instance](~~203154~~) or [Emergency recovery for a self-managed MySQL database (sandbox instance)](~~185577~~). This operation is supported only in DBS API version 2021-01-01.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'dbs:DescribeSandboxBackupSets', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'DBS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": \\" \\\\\\"Data\\\\\\": { \\\\\\"number\\\\\\": 2, \\\\\\"size\\\\\\": 2, \\\\\\"content\\\\\\": [ { \\\\\\"backupSetTime\\\\\\": \\\\\\"2021-08-28T23:12:31Z\\\\\\", \\\\\\"backupSetId\\\\\\": \\\\\\"Inc_1hxxxx8xxxxxa_20210801064200_mysql-bin.000134\\\\\\", \\\\\\"backupSetType\\\\\\": \\\\\\"Inc\\\\\\", \\\\\\"backupPlanId\\\\\\": \\\\\\"1hxxxx8xxxxxa\\\\\\" }, { \\\\\\"backupSetTime\\\\\\": \\\\\\"2021-08-28T22:42:28Z\\\\\\", \\\\\\"backupSetId\\\\\\": \\\\\\"1hxxxx8xxxxxa_20210829064228\\\\\\", \\\\\\"backupSetType\\\\\\": \\\\\\"FULL\\\\\\", \\\\\\"backupPlanId\\\\\\": \\\\\\"1hxxxx8xxxxxa\\\\\\" } ], \\\\\\"totalElements\\\\\\": 2 },\\",\\n \\"RequestId\\": \\"4F1888AC-1138-4995-B9FE-D2734F61C058\\",\\n \\"ErrCode\\": \\"Param.NotFound\\",\\n \\"Success\\": \\"true\\",\\n \\"ErrMessage\\": \\"The specified parameter %s value is not valid.\\",\\n \\"Code\\": \\"Param.NotFound\\",\\n \\"Message\\": \\"The specified parameter %s value is not valid.\\"\\n}","type":"json"}]', ], 'DescribeSandboxInstances' => [ 'summary' => 'Queries sandbox instances that are created within an account.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'BackupPlanId', 'in' => 'query', 'schema' => ['description' => 'The ID of the backup schedule. You can call the [DescribeBackupPlanList](~~437215~~) operation to obtain the ID of the backup schedule.'."\n" ."\n" .'> If your instance is an ApsaraDB RDS for MySQL instance, you can [configure automatic access to a data source](~~193091~~) to automatically add the instance to DBS and obtain the ID of the backup schedule.', 'type' => 'string', 'required' => true, 'example' => '1hxxxx8xxxxxa', 'title' => ''], ], [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'The ID of the sandbox instance. You can call the [CreateSandboxInstance](~~437252~~) operation to obtain the ID of the sandbox instance.', 'type' => 'string', 'required' => false, 'example' => '1jxxxxnxxx1xc', 'title' => ''], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => ['description' => 'The number of entries to return on each page. Valid values:'."\n" ."\n" .'- 30\\. This is the default value.'."\n" ."\n" .'- 50'."\n" ."\n" .'- 100', 'type' => 'string', 'required' => false, 'example' => '30', 'title' => ''], ], [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => ['description' => 'The number of the page to return. The value must be an integer that is greater than 0. Default value: 1.', 'type' => 'string', 'required' => false, 'example' => '1', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Data' => ['description' => 'The response parameters.'."\n" ."\n" .'- **connectionString**: the connection string of the sandbox instance, in the format of IP address:Port number. This parameter indicates the endpoint of the sandbox instance if the value of the SandboxType parameter is **Sandbox**. This parameter indicates the Network File System (NFS) mount address if the value of the SandboxType parameter is **NFS**.'."\n" ."\n" .'- **restoreSeconds**: the time required to create the sandbox instance. Unit: seconds.'."\n" ."\n" .'- **restoreTime**: the point in time to which the sandbox instance is restored. The time follows the ISO 8601 standard in the yyyy-MM-ddThh:mm:ssZ format. The time is displayed in UTC.'."\n" ."\n" .'- **instanceId**: the ID of the sandbox instance.'."\n" ."\n" .'- **backupSetId**: the ID of the backup set.'."\n" ."\n" .'- **createTime**: the point in time when the sandbox instance was created. The time follows the ISO 8601 standard in the yyyy-MM-ddThh:mm:ssZ format. The time is displayed in UTC.'."\n" ."\n" .'- **backupPlanId**: the ID of the backup schedule.'."\n" ."\n" .'- **vpcId**: the ID of the virtual private cloud (VPC).'."\n" ."\n" .'- **vpcSwitchId**: the ID of the VSwitch.'."\n" ."\n" .'- **sandboxSpecification**: the specifications of the sandbox instance.'."\n" ."\n" .'- **status**: the status of the sandbox instance. Valid values: **running**, **check\\_pass**, and **stop**.', 'type' => 'string', 'example' => ' { "number": 1, "size": 1, "content": [ { "connectionString": "172.26.178.229:3306", "restoreSeconds": 15, "restoreTime": "2021-08-11T07:26:24Z", "instanceId": "1jxxxxx9xxxms", "backupSetId": "1hxxxx8xxxxxa_20210811152624", "createTime": "2021-08-12T07:40:29Z", "backupPlanId": "1hxxxx8xxxxxa", "vpcId": "vpc-bp1dxxxxxjy0xxxxx1xxp", "sandboxSpecification": "MYSQL_1C_1M_SD", "status": "running", "vpcSwitchId": "vsw-bp1bxxxxxumxxxxxwxx2w" } ], "totalElements": 1 }', 'title' => ''], 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => '4F1888AC-1138-4995-B9FE-D2734F61C058', 'title' => ''], 'ErrCode' => ['description' => 'The error code returned if the request fails.', 'type' => 'string', 'example' => 'Param.NotFound', 'title' => ''], 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'string', 'example' => 'true', 'title' => ''], 'ErrMessage' => ['description' => 'The error message returned if the request fails.', 'type' => 'string', 'example' => 'The specified parameter %s value is not valid.', 'title' => ''], 'Code' => ['description' => 'The error code returned if the request fails.', 'type' => 'string', 'example' => 'Param.NotFound', 'title' => ''], 'Message' => ['description' => 'The error message returned if the request fails.', 'type' => 'string', 'example' => 'The specified parameter %s value is not valid.', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 403 => [ ['errorCode' => 'Request.Forbidden', 'errorMessage' => 'Have no Permissions', 'description' => ''], ], ], 'title' => 'DescribeSandboxInstances', 'description' => 'This operation is available only in Database Backup (DBS) API of the 2021-01-01 version.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => '|Error code|Error message|Description|'."\n" .'|---|---|---|'."\n" .'|DBS.NotExisted|no valid job exist with id|The error message returned because no backup schedule exists for the instance specified by the InstanceId parameter.|', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'dbs:DescribeSandboxInstances', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'DBS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": \\" { \\\\\\"number\\\\\\": 1, \\\\\\"size\\\\\\": 1, \\\\\\"content\\\\\\": [ { \\\\\\"connectionString\\\\\\": \\\\\\"172.26.178.229:3306\\\\\\", \\\\\\"restoreSeconds\\\\\\": 15, \\\\\\"restoreTime\\\\\\": \\\\\\"2021-08-11T07:26:24Z\\\\\\", \\\\\\"instanceId\\\\\\": \\\\\\"1jxxxxx9xxxms\\\\\\", \\\\\\"backupSetId\\\\\\": \\\\\\"1hxxxx8xxxxxa_20210811152624\\\\\\", \\\\\\"createTime\\\\\\": \\\\\\"2021-08-12T07:40:29Z\\\\\\", \\\\\\"backupPlanId\\\\\\": \\\\\\"1hxxxx8xxxxxa\\\\\\", \\\\\\"vpcId\\\\\\": \\\\\\"vpc-bp1dxxxxxjy0xxxxx1xxp\\\\\\", \\\\\\"sandboxSpecification\\\\\\": \\\\\\"MYSQL_1C_1M_SD\\\\\\", \\\\\\"status\\\\\\": \\\\\\"running\\\\\\", \\\\\\"vpcSwitchId\\\\\\": \\\\\\"vsw-bp1bxxxxxumxxxxxwxx2w\\\\\\" } ], \\\\\\"totalElements\\\\\\": 1 }\\",\\n \\"RequestId\\": \\"4F1888AC-1138-4995-B9FE-D2734F61C058\\",\\n \\"ErrCode\\": \\"Param.NotFound\\",\\n \\"Success\\": \\"true\\",\\n \\"ErrMessage\\": \\"The specified parameter %s value is not valid.\\",\\n \\"Code\\": \\"Param.NotFound\\",\\n \\"Message\\": \\"The specified parameter %s value is not valid.\\"\\n}","type":"json"}]', ], 'DescribeSandboxRecoveryTime' => [ 'summary' => 'Queries the recoverable time range of a sandbox instance.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'BackupPlanId', 'in' => 'query', 'schema' => ['description' => 'The ID of the backup schedule. You can call the [DescribeBackupPlanList](~~437215~~) operation to obtain the ID of the backup schedule. If you set this parameter to the backup schedule ID obtained by calling the DescribeBackupPlanList operation, the dbs prefix must be removed. Otherwise, the call fails.'."\n" ."\n" .'> If your instance is an ApsaraDB RDS for MySQL instance, you can [configure automatic access to a data source](~~193091~~) to automatically add the instance to DBS and obtain the ID of the backup schedule.', 'type' => 'string', 'required' => true, 'example' => '1jyjal15l****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => '4F1888AC-1138-4995-B9FE-D2734F61C058', 'title' => ''], 'ErrCode' => ['description' => 'The error code returned if the request fails.', 'type' => 'string', 'example' => 'Param.NotFound', 'title' => ''], 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'string', 'example' => 'true', 'title' => ''], 'ErrMessage' => ['description' => 'The error message returned if the request fails.', 'type' => 'string', 'example' => 'The specified parameter %s value is not valid.', 'title' => ''], 'Code' => ['description' => 'The error code returned if the request fails.', 'type' => 'string', 'example' => 'Param.NotFound', 'title' => ''], 'Message' => ['description' => 'The error message returned if the request fails.', 'type' => 'string', 'example' => 'The specified parameter %s value is not valid.', 'title' => ''], 'Data' => [ 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ 'RecoveryEndTime' => ['description' => 'The end of the time range during which the sandbox instance can be restored. The time follows the ISO 8601 standard in the yyyy-MM-ddThh:mm:ssZ format. The time is displayed in UTC.', 'type' => 'string', 'example' => '2021-08-02T12:01:01Z', 'title' => ''], 'BackupPlanId' => ['description' => 'The backup schedule of the sandbox instance.', 'type' => 'string', 'example' => '1hxxxx8xxxxxa', 'title' => ''], 'RecoveryBeginTime' => ['description' => 'The beginning of the time range during which the sandbox instance can be restored. The time follows the ISO 8601 standard in the yyyy-MM-ddThh:mm:ssZ format. The time is displayed in UTC.', 'type' => 'string', 'example' => '2021-08-01T12:01:01Z', 'title' => ''], ], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 403 => [ ['errorCode' => 'Request.Forbidden', 'errorMessage' => 'Have no Permissions', 'description' => ''], ], ], 'title' => 'DescribeSandboxRecoveryTime', 'description' => 'Before you call this operation, you must enable the sandbox feature for the database instance. For more information, see [Use the emergency recovery feature of an ApsaraDB RDS for MySQL instance](~~203154~~) or [Create a sandbox instance for emergency disaster recovery of a self-managed MySQL database](~~185577~~). This operation is available only in Database Backup (DBS) API of the 2021-01-01 version.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'dbs:DescribeSandboxRecoveryTime', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'DBS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4F1888AC-1138-4995-B9FE-D2734F61C058\\",\\n \\"ErrCode\\": \\"Param.NotFound\\",\\n \\"Success\\": \\"true\\",\\n \\"ErrMessage\\": \\"The specified parameter %s value is not valid.\\",\\n \\"Code\\": \\"Param.NotFound\\",\\n \\"Message\\": \\"The specified parameter %s value is not valid.\\",\\n \\"Data\\": {\\n \\"RecoveryEndTime\\": \\"2021-08-02T12:01:01Z\\",\\n \\"BackupPlanId\\": \\"1hxxxx8xxxxxa\\",\\n \\"RecoveryBeginTime\\": \\"2021-08-01T12:01:01Z\\"\\n }\\n}","type":"json"}]', ], 'ModifyBackupPolicy' => [ 'summary' => 'Modifies the backup policy of a PolarDB instance.', 'methods' => ['post', 'get'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '221284', 'abilityTreeNodes' => ['FEATUREcbsYWT1H7', 'FEATUREcbsPNQ3FN'], ], 'parameters' => [ [ 'name' => 'RegionCode', 'in' => 'query', 'schema' => ['description' => 'The region where the backup set resides.', 'type' => 'string', 'required' => false, 'example' => 'cn-shanghai', 'title' => ''], ], [ 'name' => 'PreferredBackupWindowBegin', 'in' => 'query', 'schema' => ['description' => 'The start time of the basic backup window.', 'type' => 'string', 'required' => false, 'example' => '17:00Z', 'title' => ''], ], [ 'name' => 'InstanceName', 'in' => 'query', 'schema' => ['description' => 'The PolarDB instance ID.', 'type' => 'string', 'required' => false, 'example' => 'pc-2ze3nrr64c5****', 'title' => ''], ], [ 'name' => 'Category', 'in' => 'query', 'schema' => ['description' => 'The backup type. Valid values:'."\n" .'- **Flash**: backup within seconds'."\n" .'- **Standard**: basic backup.', 'type' => 'string', 'required' => false, 'example' => 'Flash', 'title' => ''], ], [ 'name' => 'AdvanceLogPolicies', 'in' => 'query', 'style' => 'json', 'schema' => [ 'description' => 'The destination region of the backup policy.', 'type' => 'array', 'items' => [ 'title' => '', 'description' => 'The source region of the backup policy.', 'type' => 'object', 'properties' => [ 'LogRetentionType' => ['title' => '', 'description' => 'The retention period type. Valid values:'."\n" .'- Never: never expires'."\n" .'- Delay: expires after a fixed number of days.', 'type' => 'string', 'required' => false, 'example' => 'Never'], 'DestType' => ['title' => '', 'description' => 'The destination type of the backup policy. Valid values:'."\n" .'- db: database'."\n" .'- level1: primary backup'."\n" .'- level2: secondary backup'."\n" .'- level2Cross: secondary cross-region backup.', 'type' => 'string', 'required' => false, 'example' => 'level1'], 'FilterType' => ['title' => '', 'description' => 'The advanced policy filter type. Valid values:'."\n" .'- Crontab: periodic scheduling'."\n" .'- Event: event-based scheduling.', 'type' => 'string', 'required' => false, 'example' => 'crontab'], 'ActionType' => ['title' => '', 'description' => 'The operation type. Valid values: CREATE, UPDATE, and DELETE.', 'type' => 'string', 'required' => false, 'example' => 'CREATE'], 'SrcRegion' => ['title' => '', 'description' => 'The source region of the backup policy.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'], 'EnableLogBackup' => ['description' => 'Specifies whether log backup is enabled. Valid values:'."\n" ."\n" .'- **1**: Enabled.'."\n" .'- **0**: Disabled.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'title' => ''], 'SrcType' => ['title' => '', 'description' => 'The source type of the backup policy. Valid values:'."\n" .'- db: database'."\n" .'- level1: primary backup'."\n" .'- level2: secondary backup'."\n" .'- level2Cross: secondary cross-region backup.', 'type' => 'string', 'required' => false, 'example' => 'db'], 'LogRetentionValue' => ['title' => '', 'description' => 'The number of days before expiration.', 'type' => 'string', 'required' => false, 'example' => '30'], 'PolicyId' => ['title' => '', 'description' => 'The advanced policy ID.', 'type' => 'string', 'required' => false, 'example' => '31289676-bb8d-4dee-b83e-******'], 'FilterKey' => ['title' => '', 'description' => 'The scheduling type. This parameter is valid only when FilterType is set to crontab. Valid values:'."\n" .'- dayOfWeek: weekly scheduling'."\n" .'- dayOfMonth: monthly scheduling'."\n" .'- dayOfYear: yearly scheduling'."\n" .'- backupInterval: fixed interval scheduling.', 'type' => 'string', 'required' => false, 'example' => 'dayOfMonth'], 'DestRegion' => ['title' => '', 'description' => 'The destination region of the backup policy.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'], 'FilterValue' => ['title' => '', 'description' => 'The specific filter value.', 'type' => 'string', 'required' => false, 'example' => '1'], ], 'required' => false, 'example' => '', ], 'required' => false, 'title' => '', 'example' => '', ], ], [ 'name' => 'AdvanceDataPolicies', 'in' => 'query', 'style' => 'json', 'schema' => [ 'description' => 'The details of the data backup policy.', 'type' => 'array', 'items' => [ 'title' => '', 'description' => 'The policy details.', 'type' => 'object', 'properties' => [ 'DestType' => ['title' => '', 'description' => 'The destination type of the backup policy. Valid values:'."\n" ."\n" .'- **db**: database'."\n" .'- **level1**: primary backup'."\n" .'- **level2**: secondary backup'."\n" .'- **level2Cross**: secondary cross-region backup.', 'type' => 'string', 'required' => false, 'example' => 'level1'], 'FilterType' => ['title' => '', 'description' => 'The advanced policy filter type. Valid values:'."\n" ."\n" .'- **crontab**: periodic scheduling'."\n" .'- **event**: event-based scheduling.', 'type' => 'string', 'required' => false, 'example' => 'crontab'], 'ActionType' => ['title' => '', 'description' => 'The operation type. Valid values:'."\n" ."\n" .'- **CREATE**: Create.'."\n" .'- **UPDATE**: Update.'."\n" .'- **DELETE**: Delete.', 'type' => 'string', 'required' => false, 'example' => 'UPDATE'], 'SrcRegion' => ['title' => '', 'description' => 'The source region of the backup policy.', 'type' => 'string', 'required' => false, 'example' => 'cn-shanghai'], 'SrcType' => ['title' => '', 'description' => 'The source type of the backup policy. Valid values:'."\n" ."\n" .'- **db**: database'."\n" .'- **level1**: primary backup'."\n" .'- **level2**: secondary backup'."\n" .'- **level2Cross**: secondary cross-region backup.', 'type' => 'string', 'required' => false, 'example' => 'db'], 'OnlyPreserveOneEachDay' => ['title' => '', 'description' => 'Specifies whether to retain only one high-frequency backup set per day for backups older than one day.', 'type' => 'boolean', 'required' => false, 'example' => 'true'], 'RetentionValue' => ['title' => '', 'description' => 'The number of days before expiration.', 'type' => 'string', 'required' => false, 'example' => '4'], 'PolicyId' => ['title' => '', 'description' => 'The advanced policy ID. You can call [DescribeBackupPolicy](~~2869783~~) to query this value.', 'type' => 'string', 'required' => false, 'example' => '6s67c7i3y8f8p72808p******'], 'FilterKey' => ['title' => '', 'description' => 'The scheduling type. Valid values:'."\n" ."\n" .'- **dayOfWeek**: weekly scheduling'."\n" .'- **dayOfMonth**: monthly scheduling'."\n" .'- **dayOfYear**: yearly scheduling'."\n" .'- **backupInterval**: fixed interval scheduling'."\n" ."\n" .'> This parameter is returned only when FilterType is set to **crontab**.', 'type' => 'string', 'required' => false, 'example' => 'backupInterval'], 'DestRegion' => ['title' => '', 'description' => 'The destination region of the backup policy.', 'type' => 'string', 'required' => false, 'example' => 'cn-shanghai'], 'FilterValue' => ['title' => '', 'description' => 'The backup cycle.', 'type' => 'string', 'required' => false, 'example' => '180'], 'RetentionType' => ['title' => '', 'description' => 'The retention period type of the backup set. Valid values:'."\n" ."\n" .'- **never**: Never expires.'."\n" .'- **delay**: Expires after a fixed number of days.', 'type' => 'string', 'required' => false, 'example' => 'delay'], 'StorageClass' => ['description' => 'The storage class of the bucket. Valid values:'."\n" ."\n" .'- Standard (default): Standard storage.'."\n" .'- IA: Infrequent Access storage.'."\n" .'- Archive: Archive storage.'."\n" .'- ColdArchive: Cold Archive storage.'."\n" .'- DeepColdArchive: Deep Cold Archive storage.', 'type' => 'string', 'required' => false, 'example' => 'Standard', 'title' => ''], ], 'required' => false, 'example' => '', ], 'required' => false, 'title' => '', 'example' => '', ], ], [ 'name' => 'AdvanceIncPolicies', 'in' => 'query', 'style' => 'json', 'schema' => [ 'description' => 'The destination region of the backup policy.', 'type' => 'array', 'items' => [ 'title' => '', 'description' => 'The source region of the backup policy.', 'type' => 'object', 'properties' => [ 'DestType' => ['title' => '', 'description' => 'The destination type of the backup policy. Valid values:'."\n" .'- db: database'."\n" .'- level1: primary backup'."\n" .'- level2: secondary backup'."\n" .'- level2Cross: secondary cross-region backup.', 'type' => 'string', 'required' => false, 'example' => 'level1'], 'FilterType' => ['title' => '', 'description' => 'The advanced policy filter type. Valid values:'."\n" .'- Crontab: periodic scheduling'."\n" .'- Event: event-based scheduling.', 'type' => 'string', 'required' => false, 'example' => 'crontab'], 'ActionType' => ['title' => '', 'description' => 'The operation type. Valid values: CREATE, UPDATE, and DELETE.', 'type' => 'string', 'required' => false, 'example' => 'CREATE'], 'SrcRegion' => ['title' => '', 'description' => 'The source region of the backup policy.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'], 'SrcType' => ['title' => '', 'description' => 'The source type of the backup policy. Valid values:'."\n" .'- db: database'."\n" .'- level1: primary backup'."\n" .'- level2: secondary backup'."\n" .'- level2Cross: secondary cross-region backup.', 'type' => 'string', 'required' => false, 'example' => 'db'], 'OnlyPreserveOneEachDay' => ['title' => '', 'description' => 'Specifies whether to retain only one high-frequency backup set per day for backups older than one day.', 'type' => 'boolean', 'required' => false, 'example' => 'true'], 'RetentionValue' => ['title' => '', 'description' => 'The number of days before expiration.', 'type' => 'string', 'required' => false, 'example' => '365'], 'PolicyId' => ['title' => '', 'description' => 'The advanced policy ID.', 'type' => 'string', 'required' => false, 'example' => '1'], 'FilterKey' => ['title' => '', 'description' => 'The scheduling type. This parameter is valid only when FilterType is set to crontab. Valid values:'."\n" .'- dayOfWeek: weekly scheduling'."\n" .'- dayOfMonth: monthly scheduling'."\n" .'- dayOfYear: yearly scheduling'."\n" .'- backupInterval: fixed interval scheduling.', 'type' => 'string', 'required' => false, 'example' => 'dayOfMonth'], 'DestRegion' => ['title' => '', 'description' => 'The destination region of the backup policy.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'], 'FilterValue' => ['title' => '', 'description' => 'The specific filter value.', 'type' => 'string', 'required' => false, 'example' => '1'], 'RetentionType' => ['title' => '', 'description' => 'The retention period type. Valid values:'."\n" .'- Never: never expires'."\n" .'- Delay: expires after a fixed number of days.', 'type' => 'string', 'required' => false, 'example' => 'delay'], ], 'required' => false, 'example' => '', ], 'required' => false, 'title' => '', 'example' => '', ], ], [ 'name' => 'BackupRetentionPolicyOnClusterDeletion', 'in' => 'query', 'schema' => ['description' => 'The archive backup data retention policy for deleted instances. Valid values:'."\n" ."\n" .'- **NONE**: Not retained.'."\n" .'- **LATEST**: Only the last backup is retained.'."\n" .'- **ALL**: All backups are retained.', 'type' => 'string', 'required' => false, 'example' => '0', 'title' => ''], ], [ 'name' => 'BackupMethod', 'in' => 'query', 'schema' => ['description' => 'The backup method. Valid values:'."\n" .'- **logical**: logical backup'."\n" .'- **physical**: physical backup.', 'type' => 'string', 'required' => false, 'example' => 'logical', 'title' => ''], ], [ 'name' => 'BackupPriority', 'in' => 'query', 'schema' => ['description' => 'The backup policy for the secondary instance. Valid values:'."\n" ."\n" .'- **1**: Secondary instance preferred.'."\n" .'- **2**: Primary instance forced.'."\n" ."\n\n" .'> This parameter applies only to ApsaraDB RDS for SQL Server instances. For other engines, the value **0** is returned.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '2', 'title' => ''], ], [ 'name' => 'EnableIncBackup', 'in' => 'query', 'schema' => ['description' => 'Specifies whether to enable incremental backup.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], ], [ 'name' => 'BackupRetentionPeriod', 'in' => 'query', 'schema' => ['title' => '', 'type' => 'integer', 'format' => 'int32', 'example' => '7', 'description' => ''], ], [ 'name' => 'HighFrequencyBakInterval', 'in' => 'query', 'schema' => ['title' => '', 'type' => 'integer', 'format' => 'int32', 'example' => '120', 'description' => ''], ], [ 'name' => 'EnableLogBackup', 'in' => 'query', 'schema' => ['title' => '', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'description' => ''], ], [ 'name' => 'LogBackupRetention', 'in' => 'query', 'schema' => ['title' => '', 'type' => 'integer', 'format' => 'int32', 'example' => '7', 'description' => ''], ], [ 'name' => 'LogBackupLocalRetentionNumber', 'in' => 'query', 'schema' => ['title' => '', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'description' => ''], ], [ 'name' => 'LocalLogRetentionSpace', 'in' => 'query', 'schema' => ['title' => '', 'type' => 'integer', 'format' => 'int32', 'example' => '30', 'description' => ''], ], [ 'name' => 'HighSpaceUsageProtection', 'in' => 'query', 'schema' => [ 'title' => '', 'type' => 'string', 'example' => 'enable', 'enum' => ['enable', 'disable'], 'description' => '', ], ], [ 'name' => 'IncBackupInterval', 'in' => 'query', 'schema' => ['title' => '', 'type' => 'integer', 'format' => 'int32', 'example' => '120', 'description' => ''], ], [ 'name' => 'EnablePitrProtection', 'in' => 'query', 'schema' => ['title' => '', 'type' => 'boolean', 'description' => '', 'example' => ''], ], [ 'name' => 'PreferredBackupDate', 'in' => 'query', 'schema' => ['title' => '', 'type' => 'string', 'example' => '1111111', 'description' => ''], ], [ 'name' => 'LogBackupLocalRetention', 'in' => 'query', 'schema' => ['title' => '', 'type' => 'integer', 'format' => 'int32', 'example' => '7', 'description' => ''], ], [ 'name' => 'ColdRetention', 'in' => 'query', 'schema' => ['title' => '', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'description' => ''], ], [ 'name' => 'ColdKeepCount', 'in' => 'query', 'schema' => ['title' => '', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'description' => ''], ], [ 'name' => 'ColdKeepPolicy', 'in' => 'query', 'schema' => [ 'title' => '', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'enum' => ['0', '1', '2'], 'description' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'D570F209-A166-50C6-98A3-155A20B218B7', 'title' => ''], 'Message' => ['description' => 'The returned message.', 'type' => 'string', 'example' => 'instanceName can not be empty.', 'title' => ''], 'Data' => [ 'description' => 'The backup policy details.', 'type' => 'object', 'properties' => [ 'PreferredBackupWindowBegin' => ['title' => '', 'description' => 'The start time of the basic backup window.', 'type' => 'string', 'example' => '17:00Z'], 'PreferredBackupWindow' => ['title' => '', 'description' => 'The basic backup window.', 'type' => 'string', 'example' => '17:00Z-18:00Z'], 'Category' => ['description' => 'Indicates whether backup within seconds is enabled. Valid values:'."\n" ."\n" .'- **Flash**: Backup within seconds is enabled.'."\n" .'- **Standard**: Basic backup.'."\n" ."\n" .'> This parameter applies only to MySQL.', 'type' => 'string', 'example' => 'Standard', 'title' => ''], 'AdvanceLogPolicies' => [ 'description' => 'The policy details.', 'type' => 'array', 'items' => [ 'description' => 'The policy details.', 'type' => 'object', 'properties' => [ 'LogRetentionType' => ['title' => '', 'description' => 'The log backup retention type. Valid values:'."\n" .'- Never: never expires'."\n" .'- Delay: expires after a specified number of days.', 'type' => 'string', 'example' => 'delay'], 'DestType' => ['title' => '', 'description' => 'The destination type of the backup policy. Valid values:'."\n" .'- db: database'."\n" .'- level1: primary backup'."\n" .'- level2: secondary backup'."\n" .'- level2Cross: secondary cross-region backup.', 'type' => 'string', 'example' => 'level1'], 'FilterType' => ['description' => 'The advanced policy filter type. Valid values:'."\n" ."\n" .'- **crontab**: periodic scheduling'."\n" .'- **event**: event-based scheduling.', 'type' => 'string', 'example' => 'crontab', 'title' => ''], 'SrcRegion' => ['title' => '', 'description' => 'The source region of the backup policy.', 'type' => 'string', 'example' => 'cn-beijing'], 'EnableLogBackup' => ['description' => 'Reserved parameter. Ignore this parameter.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], 'SrcType' => ['title' => '', 'description' => 'The source type of the backup policy. Valid values:'."\n" .'- db: database'."\n" .'- level1: primary backup'."\n" .'- level2: secondary backup'."\n" .'- level2Cross: secondary cross-region backup.', 'type' => 'string', 'example' => 'level1'], 'PolicyId' => ['title' => '', 'description' => 'The backup policy ID.', 'type' => 'string', 'example' => 'dc13b153acc91141789122c23835****'], 'DestRegion' => ['title' => '', 'description' => 'The destination region of the backup policy.', 'type' => 'string', 'example' => 'cn-shanghai'], 'LogRetentionValue' => ['title' => '', 'description' => 'The log backup retention period.', 'type' => 'string', 'example' => '3'], 'FilterKey' => ['description' => 'The scheduling type. This parameter is valid only when FilterType is set to crontab. Valid values:'."\n" .'- dayOfWeek: weekly scheduling'."\n" .'- dayOfMonth: monthly scheduling'."\n" .'- dayOfYear: yearly scheduling'."\n" .'- backupInterval: fixed interval scheduling.', 'type' => 'string', 'example' => 'dayOfMonth', 'title' => ''], 'FilterValue' => ['description' => 'The backup cycle.', 'type' => 'string', 'example' => '1', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], 'AdvanceDataPolicies' => [ 'description' => 'The details of the data backup policy.', 'type' => 'array', 'items' => [ 'description' => 'The policy details.', 'type' => 'object', 'properties' => [ 'RetentionValue' => ['title' => '', 'description' => 'The number of days before expiration.', 'type' => 'string', 'example' => '4'], 'BakType' => ['title' => '', 'description' => 'The backup type. Valid values:'."\n" ."\n" .'- **F**: full backup'."\n" .'- **L**: log backup.', 'type' => 'string', 'example' => 'F'], 'FilterKey' => ['title' => '', 'description' => 'The scheduling type. Valid values:'."\n" ."\n" .'- **dayOfWeek**: weekly scheduling'."\n" .'- **dayOfMonth**: monthly scheduling'."\n" .'- **dayOfYear**: yearly scheduling'."\n" .'- **backupInterval**: fixed interval scheduling'."\n" ."\n" .'> This parameter is returned only when FilterType is set to **crontab**.', 'type' => 'string', 'example' => 'backupInterval'], 'FilterValue' => ['title' => '', 'description' => 'The backup cycle.', 'type' => 'string', 'example' => '180'], 'DestType' => ['title' => '', 'description' => 'The destination type of the backup policy. Valid values:'."\n" ."\n" .'- **db**: database'."\n" .'- **level1**: primary backup'."\n" .'- **level2**: secondary backup'."\n" .'- **level2Cross**: secondary cross-region backup.', 'type' => 'string', 'example' => 'level1'], 'FilterType' => ['title' => '', 'description' => 'The advanced policy filter type. Valid values:'."\n" ."\n" .'- **crontab**: periodic scheduling'."\n" .'- **event**: event-based scheduling.', 'type' => 'string', 'example' => 'crontab'], 'SrcRegion' => ['title' => '', 'description' => 'The source region of the backup policy.', 'type' => 'string', 'example' => 'cn-shanghai'], 'AutoCreated' => ['title' => '', 'description' => 'Indicates whether the backup policy is automatically generated by the system. Valid values:'."\n" ."\n" .'- **true**: System-generated policy.'."\n" .'- **false**: User-defined policy.', 'type' => 'boolean', 'example' => 'false'], 'SrcType' => ['title' => '', 'description' => 'The source type of the backup policy. Valid values:'."\n" ."\n" .'- **db**: database'."\n" .'- **level1**: primary backup'."\n" .'- **level2**: secondary backup'."\n" .'- **level2Cross**: secondary cross-region backup.', 'type' => 'string', 'example' => 'db'], 'OnlyPreserveOneEachDay' => ['description' => 'Indicates whether to retain only one backup set per day. Valid values:'."\n" .'- **true**: Only one backup set is retained per day.'."\n" .'- **false**: All backup sets are retained.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'DumpAction' => ['title' => '', 'description' => 'The dump policy details. Valid values:'."\n" ."\n" .'- **copy**: Copy.'."\n" .'- **move**: Move.', 'type' => 'string', 'example' => 'copy'], 'PolicyId' => ['title' => '', 'description' => 'The advanced policy ID.', 'type' => 'string', 'example' => 'dc13b153acc91141789122c23835****'], 'DestRegion' => ['title' => '', 'description' => 'The destination region of the backup policy.', 'type' => 'string', 'example' => 'cn-shanghai'], 'RetentionType' => ['title' => '', 'description' => 'The retention period type of the backup set. Valid values:'."\n" ."\n" .'- **never**: Never expires.'."\n" .'- **delay**: Expires after a fixed number of days.', 'type' => 'string', 'example' => 'delay'], 'StorageClass' => ['description' => 'The data storage class.', 'type' => 'string', 'example' => 'ARCHIVE', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], 'AdvanceIncPolicies' => [ 'description' => 'The retention period type. Valid values:'."\n" .'- Never: never expires'."\n" .'- Delay: expires after a fixed number of days.', 'type' => 'array', 'items' => [ 'description' => 'The destination type of the backup policy. Valid values:'."\n" .'- db: database'."\n" .'- level1: primary backup'."\n" .'- level2: secondary backup'."\n" .'- level2Cross: secondary cross-region backup.', 'type' => 'object', 'properties' => [ 'RetentionValue' => ['title' => '', 'description' => 'The number of days before expiration.', 'type' => 'string', 'example' => '365'], 'BakType' => ['title' => '', 'description' => 'The backup type. Valid values:'."\n" .'- F: full backup'."\n" .'- L: log backup.', 'type' => 'string', 'example' => 'F'], 'FilterKey' => ['title' => '', 'description' => 'The scheduling type. This parameter is valid only when FilterType is set to crontab. Valid values:'."\n" .'- dayOfWeek: weekly scheduling'."\n" .'- dayOfMonth: monthly scheduling'."\n" .'- dayOfYear: yearly scheduling'."\n" .'- backupInterval: fixed interval scheduling.', 'type' => 'string', 'example' => 'dayOfMonth'], 'FilterValue' => ['title' => '', 'description' => 'The specific filter value.', 'type' => 'string', 'example' => '1'], 'DestType' => ['title' => '', 'description' => 'The destination type of the backup policy. Valid values:'."\n" .'- db: database'."\n" .'- level1: primary backup'."\n" .'- level2: secondary backup'."\n" .'- level2Cross: secondary cross-region backup.', 'type' => 'string', 'example' => 'level1'], 'FilterType' => ['title' => '', 'description' => 'The advanced policy filter type. Valid values:'."\n" .'- Crontab: periodic scheduling'."\n" .'- Event: event-based scheduling.', 'type' => 'string', 'example' => 'Crontab'], 'SrcRegion' => ['title' => '', 'description' => 'The source region of the backup policy.', 'type' => 'string', 'example' => 'cn-hangzhou'], 'AutoCreated' => ['title' => '', 'description' => 'Indicates whether the policy is automatically generated by the system.', 'type' => 'boolean', 'example' => 'true'], 'SrcType' => ['title' => '', 'description' => 'The source type of the backup policy. Valid values:'."\n" .'- db: database'."\n" .'- level1: primary backup'."\n" .'- level2: secondary backup'."\n" .'- level2Cross: secondary cross-region backup.', 'type' => 'string', 'example' => 'db'], 'OnlyPreserveOneEachDay' => ['description' => 'The 24-hour backup data retention policy. Valid values:'."\n" .'- **true**: Only the first backup set of the day is retained for backups older than 24 hours.'."\n" .'- **false**: All backup sets are retained.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'DumpAction' => ['title' => '', 'description' => 'The dump policy. Valid values:'."\n" .'- Copy: Copy.'."\n" .'- Move: Move.', 'type' => 'string', 'example' => 'Copy'], 'PolicyId' => ['title' => '', 'description' => 'The advanced policy ID.', 'type' => 'string', 'example' => 'smp-8sv763r9boydzb***'], 'DestRegion' => ['title' => '', 'description' => 'The destination region of the backup policy.', 'type' => 'string', 'example' => 'cn-hangzhou'], 'RetentionType' => ['title' => '', 'description' => 'The retention period type. Valid values:'."\n" .'- Never: never expires'."\n" .'- Delay: expires after a fixed number of days.', 'type' => 'string', 'example' => 'Delay'], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], 'BackupRetentionPolicyOnClusterDeletion' => ['description' => 'The archive backup data retention policy for deleted instances. Valid values:'."\n" ."\n" .'- **NONE**: Not retained.'."\n" .'- **LATEST**: Only the last backup is retained.'."\n" .'- **ALL**: All backups are retained.', 'type' => 'string', 'example' => 'LATEST', 'title' => ''], 'BackupMethod' => ['description' => 'The backup method. Valid values:'."\n" ."\n" .'- **Physical**: physical backup'."\n" .'- **Snapshot**: snapshot backup.', 'type' => 'string', 'example' => 'Physical', 'title' => ''], 'BackupPriority' => ['description' => 'The backup policy for the secondary instance. Valid values:'."\n" ."\n" .'- **1**: Secondary instance preferred.'."\n" .'- **2**: Primary instance forced.'."\n" ."\n\n" .'> This parameter applies only to ApsaraDB RDS for SQL Server instances. For other engines, the value **0** is returned.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'EnableIncBackup' => ['description' => 'Specifies whether to enable incremental backup.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], 'title' => '', 'example' => '', ], 'ErrMessage' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'The specified parameter %s value is not valid.', 'title' => ''], 'Code' => ['description' => 'The status code.', 'type' => 'string', 'example' => 'Success', 'title' => ''], 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" .'- **true**: The request was successful.'."\n" .'- **false**: The request failed.', 'type' => 'string', 'example' => 'true', 'title' => ''], 'ErrCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'Success', 'title' => ''], ], 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 403 => [ ['errorCode' => 'Request.Forbidden', 'errorMessage' => 'Have no Permissions', 'description' => ''], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], 'title' => 'Modify backup policy', 'description' => '### Applicable engine'."\n" .'PolarDB for MySQL'."\n" ."\n" .'> This operation is currently available only to specific customers. To use this operation, submit a request in the DBS customer consultation group (DingTalk group ID: 35585947).', 'changeSet' => [ ['createdAt' => '2024-09-24T08:37:35.000Z', 'description' => 'Request parameters changed, Response parameters changed'], ['createdAt' => '2024-05-28T13:59:23.000Z', 'description' => 'Request parameters changed'], ], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'dbs:ModifyBackupPolicy', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'DBS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D570F209-A166-50C6-98A3-155A20B218B7\\",\\n \\"Message\\": \\"instanceName can not be empty.\\",\\n \\"Data\\": {\\n \\"PreferredBackupWindowBegin\\": \\"17:00Z\\",\\n \\"PreferredBackupWindow\\": \\"17:00Z-18:00Z\\",\\n \\"Category\\": \\"Standard\\",\\n \\"AdvanceLogPolicies\\": [\\n {\\n \\"LogRetentionType\\": \\"delay\\",\\n \\"DestType\\": \\"level1\\",\\n \\"FilterType\\": \\"crontab\\",\\n \\"SrcRegion\\": \\"cn-beijing\\",\\n \\"EnableLogBackup\\": 1,\\n \\"SrcType\\": \\"level1\\",\\n \\"PolicyId\\": \\"dc13b153acc91141789122c23835****\\",\\n \\"DestRegion\\": \\"cn-shanghai\\",\\n \\"LogRetentionValue\\": \\"3\\",\\n \\"FilterKey\\": \\"dayOfMonth\\",\\n \\"FilterValue\\": \\"1\\"\\n }\\n ],\\n \\"AdvanceDataPolicies\\": [\\n {\\n \\"RetentionValue\\": \\"4\\",\\n \\"BakType\\": \\"F\\",\\n \\"FilterKey\\": \\"backupInterval\\",\\n \\"FilterValue\\": \\"180\\",\\n \\"DestType\\": \\"level1\\",\\n \\"FilterType\\": \\"crontab\\",\\n \\"SrcRegion\\": \\"cn-shanghai\\",\\n \\"AutoCreated\\": false,\\n \\"SrcType\\": \\"db\\",\\n \\"OnlyPreserveOneEachDay\\": true,\\n \\"DumpAction\\": \\"copy\\",\\n \\"PolicyId\\": \\"dc13b153acc91141789122c23835****\\",\\n \\"DestRegion\\": \\"cn-shanghai\\",\\n \\"RetentionType\\": \\"delay\\",\\n \\"StorageClass\\": \\"ARCHIVE\\"\\n }\\n ],\\n \\"AdvanceIncPolicies\\": [\\n {\\n \\"RetentionValue\\": \\"365\\",\\n \\"BakType\\": \\"F\\",\\n \\"FilterKey\\": \\"dayOfMonth\\",\\n \\"FilterValue\\": \\"1\\",\\n \\"DestType\\": \\"level1\\",\\n \\"FilterType\\": \\"Crontab\\",\\n \\"SrcRegion\\": \\"cn-hangzhou\\",\\n \\"AutoCreated\\": true,\\n \\"SrcType\\": \\"db\\",\\n \\"OnlyPreserveOneEachDay\\": true,\\n \\"DumpAction\\": \\"Copy\\",\\n \\"PolicyId\\": \\"smp-8sv763r9boydzb***\\",\\n \\"DestRegion\\": \\"cn-hangzhou\\",\\n \\"RetentionType\\": \\"Delay\\"\\n }\\n ],\\n \\"BackupRetentionPolicyOnClusterDeletion\\": \\"LATEST\\",\\n \\"BackupMethod\\": \\"Physical\\",\\n \\"BackupPriority\\": 1,\\n \\"EnableIncBackup\\": true\\n },\\n \\"ErrMessage\\": \\"The specified parameter %s value is not valid.\\",\\n \\"Code\\": \\"Success\\",\\n \\"Success\\": \\"true\\",\\n \\"ErrCode\\": \\"Success\\"\\n}","type":"json"}]', ], 'RetryDownloadTask' => [ 'summary' => 'Retries a failed advanced download task.', 'methods' => ['get', 'post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREcbs04Q4EK'], ], 'parameters' => [ [ 'name' => 'RegionCode', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => false, 'description' => 'The ID of the region where the instance resides. To query the region ID, call [DescribeDBInstanceAttribute](~~26231~~) for an RDS instance or [DescribeDBClusterAttribute](~~2319132~~) for a PolarDB cluster.', 'title' => '', 'example' => 'cn-hangzhou'], ], [ 'name' => 'TaskId', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => false, 'description' => 'The task ID.', 'title' => '', 'example' => 'dt-example'], ], [ 'name' => 'InstanceName', 'in' => 'query', 'schema' => ['type' => 'string', 'description' => 'The instance ID.', 'required' => false, 'title' => '', 'example' => 'rm-example'], ], [ 'name' => 'ClusterName', 'in' => 'query', 'schema' => ['type' => 'string', 'description' => 'The name of the sharded cluster. This parameter is required only for MongoDB instances.', 'title' => '', 'required' => false, 'example' => 'dds-example'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Data' => ['type' => 'string', 'description' => 'The details of the download task.', 'title' => '', 'example' => '暂无'], 'RequestId' => ['type' => 'string', 'description' => 'The request ID.', 'title' => '', 'example' => '49FE4E8E-39B9-56DE-BC07-5AEBFAXXXXXX'], 'ErrCode' => ['type' => 'string', 'description' => 'The error code.', 'title' => '', 'example' => 'Success'], 'Success' => ['type' => 'string', 'description' => 'Indicates whether the request was successful.', 'title' => '', 'example' => 'True'], 'ErrMessage' => ['type' => 'string', 'description' => 'The error message.', 'title' => '', 'example' => 'The specified parameter %s value is not valid.'], 'Code' => ['type' => 'string', 'description' => 'The error code.', 'title' => '', 'example' => 'Success'], 'Message' => ['type' => 'string', 'description' => 'The error message.', 'title' => '', 'example' => 'instanceName can not be empty.'], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 403 => [ ['errorCode' => 'Request.Forbidden', 'errorMessage' => 'Have no Permissions', 'description' => ''], ], ], 'title' => 'RetryDownloadTask', 'description' => '### Applicable engines'."\n" ."\n" .'- RDS for MySQL (with cloud disks)'."\n" ."\n" .'- RDS for PostgreSQL'."\n" ."\n" .'- PolarDB for MySQL'."\n" ."\n" .'- MongoDB'."\n" ."\n" .'### Related documents'."\n" ."\n" .'- [Download a backup of an RDS for MySQL instance](~~98819~~)'."\n" ."\n" .'- [Download a backup of an RDS for PostgreSQL instance](~~96774~~)'."\n" ."\n" .'- [Download a backup of a PolarDB for MySQL cluster](~~2627635~~)'."\n" ."\n" .'- [Download a backup of a MongoDB instance](~~55011~~)', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'dbs:RetryDownloadTask', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'DBS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": \\"暂无\\",\\n \\"RequestId\\": \\"49FE4E8E-39B9-56DE-BC07-5AEBFAXXXXXX\\",\\n \\"ErrCode\\": \\"Success\\",\\n \\"Success\\": \\"True\\",\\n \\"ErrMessage\\": \\"The specified parameter %s value is not valid.\\",\\n \\"Code\\": \\"Success\\",\\n \\"Message\\": \\"instanceName can not be empty.\\"\\n}","type":"json"}]', ], ], 'endpoints' => [ ['regionId' => 'cn-wulanchabu', 'regionName' => 'China (Ulanqab)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'dbs-api.cn-wulanchabu.aliyuncs.com', 'endpoint' => 'dbs-api.cn-wulanchabu.aliyuncs.com', 'vpc' => 'dbs-api-vpc.cn-wulanchabu.aliyuncs.com'], ['regionId' => 'cn-beijing', 'regionName' => 'China (Beijing)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'dbs-api.cn-hangzhou.aliyuncs.com', 'endpoint' => 'dbs-api.cn-hangzhou.aliyuncs.com', 'vpc' => 'dbs-api-vpc.cn-beijing.aliyuncs.com'], ['regionId' => 'cn-qingdao', 'regionName' => 'China (Qingdao)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'dbs-api.cn-hangzhou.aliyuncs.com', 'endpoint' => 'dbs-api.cn-hangzhou.aliyuncs.com', 'vpc' => 'dbs-api-vpc.cn-qingdao.aliyuncs.com'], ['regionId' => 'cn-shanghai', 'regionName' => 'China (Shanghai)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'dbs-api.cn-hangzhou.aliyuncs.com', 'endpoint' => 'dbs-api.cn-hangzhou.aliyuncs.com', 'vpc' => 'dbs-api-vpc.cn-shanghai.aliyuncs.com'], ['regionId' => 'cn-hongkong', 'regionName' => 'China (Hong Kong)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'dbs-api.cn-hangzhou.aliyuncs.com', 'endpoint' => 'dbs-api.cn-hangzhou.aliyuncs.com', 'vpc' => 'dbs-api-vpc.cn-hongkong.aliyuncs.com'], ['regionId' => 'cn-zhangjiakou', 'regionName' => 'China (Zhangjiakou)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'dbs-api.cn-zhangjiakou.aliyuncs.com', 'endpoint' => 'dbs-api.cn-zhangjiakou.aliyuncs.com', 'vpc' => 'dbs-api-vpc.cn-zhangjiakou.aliyuncs.com'], ['regionId' => 'cn-shenzhen', 'regionName' => 'China (Shenzhen)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'dbs-api.cn-hangzhou.aliyuncs.com', 'endpoint' => 'dbs-api.cn-hangzhou.aliyuncs.com', 'vpc' => 'dbs-api-vpc.cn-shenzhen.aliyuncs.com'], ['regionId' => 'ap-northeast-1', 'regionName' => 'Japan (Tokyo)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'dbs-api.ap-northeast-1.aliyuncs.com', 'endpoint' => 'dbs-api.ap-northeast-1.aliyuncs.com', 'vpc' => 'dbs-api-vpc.ap-northeast-1.aliyuncs.com'], ['regionId' => 'cn-chengdu', 'regionName' => 'China (Chengdu)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'dbs-api.cn-chengdu.aliyuncs.com', 'endpoint' => 'dbs-api.cn-chengdu.aliyuncs.com', 'vpc' => 'dbs-api-vpc.cn-chengdu.aliyuncs.com'], ['regionId' => 'ap-southeast-1', 'regionName' => 'Singapore', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'dbs-api.ap-southeast-1.aliyuncs.com', 'endpoint' => 'dbs-api.ap-southeast-1.aliyuncs.com', 'vpc' => 'dbs-api-vpc.ap-southeast-1.aliyuncs.com'], ['regionId' => 'ap-southeast-3', 'regionName' => 'Malaysia (Kuala Lumpur)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'dbs-api.ap-southeast-3.aliyuncs.com', 'endpoint' => 'dbs-api.ap-southeast-3.aliyuncs.com', 'vpc' => 'dbs-api-vpc.ap-southeast-3.aliyuncs.com'], ['regionId' => 'cn-huhehaote', 'regionName' => 'China (Hohhot)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'dbs-api.cn-huhehaote.aliyuncs.com', 'endpoint' => 'dbs-api.cn-huhehaote.aliyuncs.com', 'vpc' => 'dbs-api-vpc.cn-huhehaote.aliyuncs.com'], ['regionId' => 'ap-southeast-5', 'regionName' => 'Indonesia (Jakarta)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'dbs-api.ap-southeast-5.aliyuncs.com', 'endpoint' => 'dbs-api.ap-southeast-5.aliyuncs.com', 'vpc' => 'dbs-api-vpc.ap-southeast-5.aliyuncs.com'], ['regionId' => 'cn-hangzhou', 'regionName' => 'China (Hangzhou)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'dbs-api.cn-hangzhou.aliyuncs.com', 'endpoint' => 'dbs-api.cn-hangzhou.aliyuncs.com', 'vpc' => 'dbs-api-vpc.cn-hangzhou.aliyuncs.com'], ['regionId' => 'us-east-1', 'regionName' => 'US (Virginia)', 'areaId' => 'europeAmerica', 'areaName' => 'Europe & Americas', 'public' => 'dbs-api.cn-hangzhou.aliyuncs.com', 'endpoint' => 'dbs-api.cn-hangzhou.aliyuncs.com', 'vpc' => 'dbs-api-vpc.us-east-1.aliyuncs.com'], ['regionId' => 'eu-west-1', 'regionName' => 'UK (London)', 'areaId' => 'europeAmerica', 'areaName' => 'Europe & Americas', 'public' => 'dbs-api.eu-west-1.aliyuncs.com', 'endpoint' => 'dbs-api.eu-west-1.aliyuncs.com', 'vpc' => 'dbs-api-vpc.eu-west-1.aliyuncs.com'], ['regionId' => 'us-west-1', 'regionName' => 'US (Silicon Valley)', 'areaId' => 'europeAmerica', 'areaName' => 'Europe & Americas', 'public' => 'dbs-api.cn-hangzhou.aliyuncs.com', 'endpoint' => 'dbs-api.cn-hangzhou.aliyuncs.com', 'vpc' => 'dbs-api-vpc.us-west-1.aliyuncs.com'], ['regionId' => 'eu-central-1', 'regionName' => 'Germany (Frankfurt)', 'areaId' => 'europeAmerica', 'areaName' => 'Europe & Americas', 'public' => 'dbs-api.eu-central-1.aliyuncs.com', 'endpoint' => 'dbs-api.eu-central-1.aliyuncs.com', 'vpc' => 'dbs-api-vpc.eu-central-1.aliyuncs.com'], ['regionId' => 'cn-shenzhen-finance-1', 'regionName' => 'China South 1 Finance', 'areaId' => 'industryCloud', 'areaName' => 'Industry Cloud', 'public' => 'dbs-api.cn-hangzhou.aliyuncs.com', 'endpoint' => 'dbs-api.cn-hangzhou.aliyuncs.com', 'vpc' => 'dbs-api-vpc.cn-shenzhen-finance-1.aliyuncs.com'], ['regionId' => 'cn-shanghai-finance-1', 'regionName' => 'China East 2 Finance', 'areaId' => 'industryCloud', 'areaName' => 'Industry Cloud', 'public' => 'dbs-api.cn-hangzhou.aliyuncs.com', 'endpoint' => 'dbs-api.cn-hangzhou.aliyuncs.com', 'vpc' => 'dbs-api-vpc.cn-shanghai-finance-1.aliyuncs.com'], ['regionId' => 'cn-hangzhou-finance', 'regionName' => 'China East 1 Finance', 'areaId' => 'industryCloud', 'areaName' => 'Industry Cloud', 'public' => 'dbs-api.cn-hangzhou.aliyuncs.com', 'endpoint' => 'dbs-api.cn-hangzhou.aliyuncs.com', 'vpc' => ''], ], 'errorCodes' => [ ['code' => 'BackupPlanNotConfigure', 'message' => 'ConfigureBackupPlanRequest Error', 'http_code' => 200, 'description' => 'The backup schedule is incorrectly configured.'], ['code' => 'BackupPlanNotDescribe', 'message' => 'describe backup plan failed -> null', 'http_code' => 200, 'description' => 'Failed to query the list of backup schedules.'], ['code' => 'BackupPlanNotModify', 'message' => 'modify backup source endpoint fail', 'http_code' => 200, 'description' => 'Failed to modify the backup source endpoint.'], ['code' => 'DBS.DisasterCenter.NoPermission', 'message' => 'no permission for this action.', 'http_code' => 403, 'description' => 'No permission for this operation.'], ['code' => 'DBS.DownloadTask.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' => 'Request parameters changed, Response parameters changed', 'api' => 'ModifyBackupPolicy'], ], 'createdAt' => '2024-09-24T08:37:03.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Response parameters changed', 'api' => 'DescribeBackupPolicy'], ['description' => 'Request parameters changed', 'api' => 'ModifyBackupPolicy'], ], 'createdAt' => '2024-05-28T13:59:17.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Response parameters changed', 'api' => 'DescribeBackupPolicy'], ], 'createdAt' => '2024-05-16T11:16:56.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Request parameters changed', 'api' => 'ChangeResourceGroup'], ], 'createdAt' => '2023-12-21T13:43:30.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Request parameters changed', 'api' => 'CreateSandboxInstance'], ['description' => 'Request parameters changed', 'api' => 'DeleteSandboxInstance'], ], 'createdAt' => '2023-08-18T07:28:29.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Response parameters changed', 'api' => 'DescribeDownloadTask'], ], 'createdAt' => '2022-11-16T11:45:26.000Z', 'description' => 'DescribeDownloadTask更新，修改分页相关返回字段名', ], [ 'apis' => [ ['description' => 'OpenAPI offline', 'api' => 'DescribeDBTablesRecoveryBackupSet'], ['description' => 'OpenAPI offline', 'api' => 'DescribeDBTablesRecoveryState'], ['description' => 'OpenAPI offline', 'api' => 'DescribeDBTablesRecoveryTimeRange'], ['description' => 'OpenAPI offline', 'api' => 'ModifyDBTablesRecoveryState'], ['description' => 'OpenAPI offline', 'api' => 'SupportDBTableRecovery'], ], 'createdAt' => '2022-10-18T14:32:36.000Z', 'description' => '极速库表恢复openapi', ], [ 'apis' => [ ['description' => 'Request parameters changed', 'api' => 'DescribeDownloadBackupSetStorageInfo'], ['description' => 'Request parameters changed', 'api' => 'DescribeDownloadSupport'], ], 'createdAt' => '2022-08-25T07:44:08.000Z', 'description' => '修改参数必填属性', ], [ 'apis' => [ ['description' => 'OpenAPI offline', 'api' => 'DescribeDownloadBackupSetStorageInfo'], ['description' => 'OpenAPI offline', 'api' => 'DescribeDownloadSupport'], ], 'createdAt' => '2022-08-03T09:24:36.000Z', 'description' => 'DBS高级下载V3.2发布', ], [ 'apis' => [ ['description' => 'OpenAPI offline', 'api' => 'DescribeAvailableCrossRegion'], ], 'createdAt' => '2022-07-15T06:34:03.000Z', 'description' => '发布新接口', ], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '-1', 'countWindow' => 1, 'regionId' => '*'], ['threshold' => '400', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeDownloadSupport'], ], ], 'ram' => [ 'productCode' => 'DBS', 'productName' => 'Database Backup', 'ramCodes' => ['dbs'], 'ramLevel' => 'RESOURCE', 'ramConditions' => [], 'ramActions' => [ [ 'apiName' => 'DescribeSandboxBackupSets', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'dbs:DescribeSandboxBackupSets', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'DBS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'DescribeBackupDataList', 'description' => '', 'operationType' => 'list', 'ramAction' => [ 'action' => 'dbs:DescribeBackupDataList', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'conditional', 'product' => 'DBS', 'resourceType' => 'DBInstance', 'arn' => 'acs:rds:{#regionId}:{#accountId}:dbinstance/{#DbInstanceId}'], ], ], ], [ 'apiName' => 'RetryDownloadTask', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'dbs:RetryDownloadTask', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'DBS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'ModifyBackupPolicy', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'dbs:ModifyBackupPolicy', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'DBS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'CreateDownload', 'description' => '', 'operationType' => 'create', 'ramAction' => [ 'action' => 'dbs:CreateDownload', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'DBS', 'resourceType' => 'DBInstance', 'arn' => 'acs:rds:{#regionId}:{#accountId}:dbinstance/{#DbInstanceId}'], ], ], ], [ 'apiName' => 'DescribeBackupPolicy', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'dbs:DescribeBackupPolicy', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'DBS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'ChangeResourceGroup', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'dbs:ChangeResourceGroup', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'DBS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'DescribeSandboxRecoveryTime', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'dbs:DescribeSandboxRecoveryTime', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'DBS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'DescribeSandboxInstances', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'dbs:DescribeSandboxInstances', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'DBS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'CreateAdvancedPolicy', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'dbs:CreateAdvancedPolicy', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'DBS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'DeleteSandboxInstance', 'description' => '', 'operationType' => 'delete', 'ramAction' => [ 'action' => 'dbs:DeleteSandboxInstance', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'DBS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'DescribeCostInfoByDbsInstance', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'dbs:DescribeCostInfoByDbsInstance', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'DBS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'DescribeDownloadSupport', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'dbs:DescribeDownloadSupport', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'DBS', 'resourceType' => 'BackupPlan', 'arn' => 'acs:dbs:{#regionId}:{#accountId}:backupplan/{#BackupPlanId}'], ], ], ], [ 'apiName' => 'DescribeDownloadBackupSetStorageInfo', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'dbs:DescribeDownloadBackupSetStorageInfo', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'DBS', 'resourceType' => 'BackupPlan', 'arn' => 'acs:dbs:{#regionId}:{#accountId}:backupplan/{#BackupPlanId}'], ], ], ], [ 'apiName' => 'DescribeDownloadTask', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'dbs:DescribeDownloadTask', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'DBS', 'resourceType' => 'DBInstance', 'arn' => 'acs:rds:{#regionId}:{#accountId}:dbinstance/{#DbInstanceId}'], ], ], ], ], 'resourceTypes' => [ ['validationType' => 'conditional', 'resourceType' => 'DBInstance', 'arn' => 'acs:rds:{#regionId}:{#accountId}:dbinstance/{#DbInstanceId}'], ['validationType' => 'always', 'resourceType' => 'BackupPlan', 'arn' => 'acs:dbs:{#regionId}:{#accountId}:backupplan/{#BackupPlanId}'], ['validationType' => 'always', 'resourceType' => 'DataSource', 'arn' => 'acs:dbs:{#regionId}:{#accountId}:'], ], ], ];