From 7347bac4ab7e136157fc94777e6cf87ef9e08599 Mon Sep 17 00:00:00 2001 From: Zhineng Li Date: Fri, 13 Feb 2026 10:54:11 +0800 Subject: first commit --- data/zh_cn/dbs/2019-03-06/api-docs.php | 9820 ++++++++++++++++++++++++++++++++ data/zh_cn/dbs/2021-01-01/api-docs.php | 5073 +++++++++++++++++ 2 files changed, 14893 insertions(+) create mode 100644 data/zh_cn/dbs/2019-03-06/api-docs.php create mode 100644 data/zh_cn/dbs/2021-01-01/api-docs.php (limited to 'data/zh_cn/dbs') diff --git a/data/zh_cn/dbs/2019-03-06/api-docs.php b/data/zh_cn/dbs/2019-03-06/api-docs.php new file mode 100644 index 0000000..c66fa3d --- /dev/null +++ b/data/zh_cn/dbs/2019-03-06/api-docs.php @@ -0,0 +1,9820 @@ + '1.0', + 'info' => [ + 'style' => 'RPC', + 'product' => 'Dbs', + 'version' => '2019-03-06', + ], + 'directories' => [ + [ + 'children' => [ + 'CreateBackupPlan', + 'CreateAndStartBackupPlan', + 'StartBackupPlan', + 'EnableBackupLog', + 'StopBackupPlan', + 'DisableBackupLog', + 'ModifyBackupObjects', + 'ModifyBackupSourceEndpoint', + 'ModifyStorageStrategy', + 'ModifyBackupPlanName', + 'ModifyBackupStrategy', + 'DescribeBackupPlanList', + 'DescribeRestoreRangeInfo', + 'DescribeBackupPlanBilling', + 'ConfigureBackupPlan', + 'RenewBackupPlan', + 'UpgradeBackupPlan', + 'ReleaseBackupPlan', + ], + 'type' => 'directory', + 'title' => '备份计划', + 'id' => 46961, + ], + [ + 'children' => [ + 'DescribeIncrementBackupList', + 'DescribeFullBackupList', + ], + 'type' => 'directory', + 'title' => '备份任务', + 'id' => 46980, + ], + [ + 'children' => [ + 'CreateRestoreTask', + 'StartRestoreTask', + 'DescribeRestoreTaskList', + ], + 'type' => 'directory', + 'title' => '恢复任务', + 'id' => 46983, + ], + [ + 'children' => [ + 'DescribeBackupGatewayList', + ], + 'type' => 'directory', + 'title' => '备份网关', + 'id' => 46987, + ], + [ + 'children' => [ + 'CreateFullBackupSetDownload', + 'CreateIncrementBackupSetDownload', + 'ModifyBackupSetDownloadRules', + 'DescribeBackupSetDownloadTaskList', + ], + 'type' => 'directory', + 'title' => '备份集下载', + 'id' => 46998, + ], + [ + 'children' => [ + 'CreateGetDBListFromAgentTask', + 'DescribeNodeCidrList', + 'DescribeJobErrorCode', + 'DescribePreCheckProgressList', + 'DescribeDLAService', + 'GetDBListFromAgent', + 'DescribeRegions', + 'InitializeDbsServiceLinkedRole', + ], + 'type' => 'directory', + 'title' => '服务管理', + 'id' => 46989, + ], + ], + 'components' => [ + 'schemas' => [], + ], + 'apis' => [ + 'ConfigureBackupPlan' => [ + 'summary' => '该接口用于配置一个DBS备份计划。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREcbsKR7J6S', + ], + ], + 'parameters' => [ + [ + 'name' => 'BackupPlanId', + 'in' => 'query', + 'schema' => [ + 'description' => '备份计划ID，可通过调用[DescribeBackupPlanList](~~2869825~~)接口获取该参数的值。', + 'type' => 'string', + 'required' => true, + 'example' => 'dbstooi0*******', + ], + ], + [ + 'name' => 'SourceEndpointInstanceType', + 'in' => 'query', + 'schema' => [ + 'description' => '数据库所在位置，可通过调用[DescribeBackupPlanList](~~2869825~~)接口获取该参数的值。取值如下：'."\n" + ."\n" + .'- **RDS**'."\n" + .'- **ECS**'."\n" + .'- **Express**：通过专线/VPN网关/智能网关接入的数据库'."\n" + .'- **Agent**：通过备份网关接入的数据库'."\n" + .'- **DDS**：云MongoDB'."\n" + .'- **Other**：通过IP:Port直连的数据库', + 'type' => 'string', + 'required' => true, + 'example' => 'RDS', + ], + ], + [ + 'name' => 'SourceEndpointRegion', + 'in' => 'query', + 'schema' => [ + 'description' => '数据库地域，可通过调用[DescribeBackupPlanList](~~2869825~~)接口获取该参数的值。'."\n" + ."\n" + .'> **SourceEndpointInstanceType**为RDS、ECS、DDS、Express、Agent时，该参数必传。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'SourceEndpointInstanceID', + 'in' => 'query', + 'schema' => [ + 'description' => '数据库实例ID，可通过调用[DescribeBackupPlanList](~~2869825~~)接口获取该参数的值。'."\n" + ."\n" + .'> **SourceEndpoint**.**InstanceType**为**RDS**、**ECS**、**DDS**、**Express**时，该参数必传。', + 'type' => 'string', + 'required' => false, + 'example' => 'rm-uf6wjk5*********', + ], + ], + [ + 'name' => 'SourceEndpointIP', + 'in' => 'query', + 'schema' => [ + 'description' => '数据库连接地址，可通过调用[DescribeBackupPlanList](~~2869825~~)接口获取该参数的值。'."\n" + ."\n" + .'> **SourceEndpointInstanceType**为**express**、**agent**、**other**时，该参数必传。', + 'type' => 'string', + 'required' => false, + 'example' => 'rm-uf6wjk5*******.mysql.rds.aliyuncs.com', + ], + ], + [ + 'name' => 'SourceEndpointPort', + 'in' => 'query', + 'schema' => [ + 'description' => '数据库端口，可通过调用[DescribeBackupPlanList](~~2869825~~)接口获取该参数的值。'."\n" + ."\n" + .'> **SourceEndpoint**.**InstanceType**为**express**、**agent**、**other**、**ECS**时，该参数必传。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '3306', + ], + ], + [ + 'name' => 'SourceEndpointDatabaseName', + 'in' => 'query', + 'schema' => [ + 'description' => '数据库名称，可通过调用[DescribeBackupPlanList](~~2869825~~)接口获取该参数的值。'."\n" + ."\n" + .'> 数据库类型为**PostgreSQL**、**MongoDB**时，该参数必传。', + 'type' => 'string', + 'required' => false, + 'example' => 'testRDS', + ], + ], + [ + 'name' => 'SourceEndpointUserName', + 'in' => 'query', + 'schema' => [ + 'description' => '数据库账号。'."\n" + ."\n" + .'> 数据库类型为**Redis**，或者数据库所在位置为**agent**且数据库类型为**SQL Server**时该参数非必须，其他场景均必传。', + 'type' => 'string', + 'required' => false, + 'example' => 'testRDS', + ], + ], + [ + 'name' => 'SourceEndpointPassword', + 'in' => 'query', + 'schema' => [ + 'description' => '密码。'."\n" + ."\n" + .'> 数据库类型为**Redis**，或者数据库所在位置为**agent**且数据库类型为**SQL Server**时该参数非必须，其他场景均必传。', + 'type' => 'string', + 'required' => false, + 'example' => 'testPassword', + ], + ], + [ + 'name' => 'BackupGatewayId', + 'in' => 'query', + 'schema' => [ + 'description' => '备份网关ID，可通过调用[DescribeBackupPlanList](~~2869825~~)接口获取该参数的值。'."\n" + ."\n" + .'> **SourceEndpointInstanceType**为**agent**时，该参数必传。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '23313123312', + ], + ], + [ + 'name' => 'OSSBucketName', + 'in' => 'query', + 'schema' => [ + 'description' => 'OSS Bucket名称。'."\n" + ."\n" + .'> 系统默认自动生成新的名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'TestOssBucket', + ], + ], + [ + 'name' => 'BackupObjects', + 'in' => 'query', + 'schema' => [ + 'description' => '备份对象，可通过调用[DescribeBackupPlanList](~~2869825~~)接口获取该参数的值。', + 'type' => 'string', + 'required' => false, + 'example' => '[ { "DBName":"待备份库名", "SchemaName":"待备份 Schema 名", "TableIncludes":[{ "TableName":"待备份表表名" }], "TableExcludes":[{ "TableName":"待备份库名不需要备份表的表名" }] } ]', + ], + ], + [ + 'name' => 'BackupPeriod', + 'in' => 'query', + 'schema' => [ + 'description' => '全量备份周期，取值：'."\n" + .'- **Monday**：周一'."\n" + .'- **Tuesday**：周二'."\n" + .'- **Wednesday**：周三'."\n" + .'- **Thursday**：周四'."\n" + .'- **Friday**：周五'."\n" + .'- **Saturday**：周六'."\n" + .'- **Sunday**：周日', + 'type' => 'string', + 'required' => false, + 'example' => 'Monday', + ], + ], + [ + 'name' => 'BackupStartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '全量备份开始时间，格式为HH:mmZ（UTC时间）。可通过调用[DescribeBackupPlanList](~~2869825~~)接口获取该参数的值。', + 'type' => 'string', + 'required' => false, + 'example' => '14:22', + ], + ], + [ + 'name' => 'EnableBackupLog', + 'in' => 'query', + 'schema' => [ + 'description' => '是否开启增量日志备份，取值：'."\n" + .'- **true**：开启'."\n" + .'- **false**：关闭', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'BackupLogIntervalSeconds', + 'in' => 'query', + 'schema' => [ + 'description' => '增量时间间隔，以秒（s）为单位。'."\n" + .'> 仅支持物理备份。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1000', + ], + ], + [ + 'name' => 'BackupRetentionPeriod', + 'in' => 'query', + 'schema' => [ + 'description' => '备份数据保留时间，取值：0 ~ 1825，默认为730天。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '730', + ], + ], + [ + 'name' => 'DuplicationInfrequentAccessPeriod', + 'in' => 'query', + 'schema' => [ + 'description' => '转为低频访问存储时间，默认为180天。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '180', + ], + ], + [ + 'name' => 'DuplicationArchivePeriod', + 'in' => 'query', + 'schema' => [ + 'description' => '转为归档冷备存储时间，默认为365天。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '365', + ], + ], + [ + 'name' => 'BackupPlanName', + 'in' => 'query', + 'schema' => [ + 'description' => '自定义备份计划名称，可通过调用[DescribeBackupPlanList](~~2869825~~)接口获取该参数的值。', + 'type' => 'string', + 'required' => true, + 'example' => 'dbstooi0*******', + ], + ], + [ + 'name' => 'SourceEndpointOracleSID', + 'in' => 'query', + 'schema' => [ + 'description' => 'Oracle SID名称。'."\n" + ."\n" + .'> 数据库类型为Oracle时，该参数必传。', + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + [ + 'name' => 'BackupStorageType', + 'in' => 'query', + 'schema' => [ + 'description' => '内置存储类型：'."\n" + .'- 空（默认）：备份数据存储在用户OSS上。'."\n" + .'- system ：备份数据存储在DBS的内置OSS上。', + 'type' => 'string', + 'required' => false, + 'example' => '无', + ], + ], + [ + 'name' => 'BackupSpeedLimit', + 'in' => 'query', + 'schema' => [ + 'description' => '磁盘IO限制 ， 单位为KB/s。'."\n" + .'> 仅对MySQL物理备份生效。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '262144', + ], + ], + [ + 'name' => 'BackupRateLimit', + 'in' => 'query', + 'schema' => [ + 'description' => '网络带宽限制， 单位为KB/s ，最大允许10GB。'."\n" + .'> 仅对MySQL物理备份生效。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '262144', + ], + ], + [ + 'name' => 'BackupStrategyType', + 'in' => 'query', + 'schema' => [ + 'description' => '全量备份周期，取值：'."\n" + .'- **simple**：周期备份，和BackupPeriod、BackupStartTime配合使用。'."\n" + .'- **manual**：手动备份。'."\n" + ."\n" + .'> 默认为**simple**。', + 'type' => 'string', + 'required' => false, + 'example' => 'simple', + ], + ], + [ + 'name' => 'CrossAliyunId', + 'in' => 'query', + 'schema' => [ + 'description' => '跨阿里云账号备份的UID，可通过调用[DescribeRestoreTaskList](~~2869838~~)接口获取该参数的值。', + 'type' => 'string', + 'required' => false, + 'example' => '2xxx7778xxxxxxxxxx', + ], + ], + [ + 'name' => 'CrossRoleName', + 'in' => 'query', + 'schema' => [ + 'description' => '跨阿里云账号备份的RAM角色名称，可通过调用[DescribeRestoreTaskList](~~2869838~~)接口获取该参数的值。', + 'type' => 'string', + 'required' => false, + 'example' => 'test123', + ], + ], + [ + 'name' => 'AutoStartBackup', + 'in' => 'query', + 'schema' => [ + 'description' => '是否开启自动备份。'."\n" + ."\n" + .'- **true**：开启'."\n" + .'- **false**：不开启', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => '用于保证请求的幂等性，防止重复提交请求。由客户端生成该参数值，要保证在不同请求间唯一，最大值不超过64个ASCII字符，且该参数值中不能包含非ASCII字符。', + 'type' => 'string', + 'required' => false, + 'example' => 'ETnLKlblzczshOTUbOCzxxxxxxx', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '资源组ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'rg-aekzecovzti****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '详情信息如下。', + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'HTTP状态码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'F1FB49D4-B504-47F1-9F43-D7EAB33F****', + ], + 'ErrCode' => [ + 'description' => '错误码。', + 'type' => 'string', + 'example' => 'Param.NotFound', + ], + 'Success' => [ + 'description' => '请求是否成功，返回值如下：'."\n" + .'- **true**：请求成功'."\n" + .'- **false**：请求失败', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ErrMessage' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'The specified parameter %s value is not valid. ', + ], + 'BackupPlanId' => [ + 'description' => '备份计划ID。', + 'type' => 'string', + 'example' => 'dbstooi01ex****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'Request.Forbidden', + 'errorMessage' => 'Have no Permissions', + 'description' => '当前操作未被授权，请联系主账号在RAM控制台进行授权后再执行操作', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'title' => '配置备份计划', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + [ + 'createdAt' => '2022-07-28T07:13:06.000Z', + 'description' => '请求参数发生变更', + ], + [ + 'createdAt' => '2022-07-12T03:54:11.000Z', + 'description' => '错误码发生变更', + ], + ], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '10', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'ConfigureBackupPlan', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dbs:ConfigureBackupPlan', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DBS', + 'resourceType' => 'BackupPlan', + 'arn' => 'acs:dbs:{#regionId}:{#accountId}:backupplan/{#BackupPlanId}', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"F1FB49D4-B504-47F1-9F43-D7EAB33F****\\",\\n \\"ErrCode\\": \\"Param.NotFound\\",\\n \\"Success\\": true,\\n \\"ErrMessage\\": \\"The specified parameter %s value is not valid. \\",\\n \\"BackupPlanId\\": \\"dbstooi01ex****\\"\\n}","errorExample":""},{"type":"xml","example":"\\n D6E068C3-25BC-455A-85FE-45F0B22E****\\n 200\\n dbstooi01ex****\\n true\\n","errorExample":""}]', + ], + 'CreateAndStartBackupPlan' => [ + 'summary' => '该接口用于创建、配置并启动备份计划。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREcbsKR7J6S', + ], + ], + 'parameters' => [ + [ + 'name' => 'BackupPlanId', + 'in' => 'query', + 'schema' => [ + 'description' => ' '."\n" + .'备份计划ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'dbstooi0*******', + ], + ], + [ + 'name' => 'Region', + 'in' => 'query', + 'schema' => [ + 'description' => 'DBS支持地域，可调用[DescribeRegions](~~2869853~~)接口查看。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'InstanceClass', + 'in' => 'query', + 'schema' => [ + 'description' => '备份计划的规格，取值：'."\n" + .'- **micro**'."\n" + .'- **small**'."\n" + .'- **medium**'."\n" + .'- **large**'."\n" + .'- **xlarge**'."\n" + ."\n" + .'> 规格越高，备份与恢复的性能越高。更多信息，请参见[规格说明](~~84372~~)。', + 'type' => 'string', + 'required' => true, + 'example' => 'micro', + ], + ], + [ + 'name' => 'DatabaseType', + 'in' => 'query', + 'schema' => [ + 'description' => '数据库类型，取值：'."\n" + .'- **MySQL**'."\n" + .'- **MSSQL**'."\n" + .'- **Oracle**'."\n" + .'- **MariaDB**'."\n" + .'- **PostgreSQL**'."\n" + .'- **DRDS**'."\n" + .'- **MongoDB**'."\n" + .'- **Redis**', + 'type' => 'string', + 'required' => true, + 'example' => 'MySQL', + ], + ], + [ + 'name' => 'BackupMethod', + 'in' => 'query', + 'schema' => [ + 'description' => '备份方式，取值：'."\n" + .'- **logical**：逻辑备份'."\n" + .'- **physical**：物理备份', + 'type' => 'string', + 'required' => true, + 'example' => 'logical', + ], + ], + [ + 'name' => 'Period', + 'in' => 'query', + 'schema' => [ + 'description' => '指定预付费实例为包年或者包月类型，取值：'."\n" + .'- **Year**：包年'."\n" + .'- **Month**：包月', + 'type' => 'string', + 'required' => false, + 'example' => 'Year', + ], + ], + [ + 'name' => 'UsedTime', + 'in' => 'query', + 'schema' => [ + 'description' => '指定购买时长，取值：'."\n" + .'- 当参数**Period**为**Year**时，**UsedTime**取值为1~5。'."\n" + .'- 当参数**Period**为**Month**时，**UsedTime**取值为1~11。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PayType', + 'in' => 'query', + 'schema' => [ + 'description' => '支付方式，取值：'."\n" + ."\n" + .' **prepay**：预付费（包年包月）', + 'type' => 'string', + 'required' => false, + 'example' => 'postpay', + ], + ], + [ + 'name' => 'DatabaseRegion', + 'in' => 'query', + 'schema' => [ + 'description' => '数据库地域。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'StorageRegion', + 'in' => 'query', + 'schema' => [ + 'description' => '存储地域。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'InstanceType', + 'in' => 'query', + 'schema' => [ + 'description' => '数据库实例类型，取值：'."\n" + .'- **RDS**'."\n" + .'- **PolarDB**'."\n" + .'- **DDS**：阿里云MongoDB'."\n" + .'- **Kvstore**：阿里云Redis'."\n" + .'- **Other**：通过IP:Port接入的数据库'."\n" + .'- **dg**：无公网IP:Port的自建数据库（通过数据库网关DG接入）', + 'type' => 'string', + 'required' => false, + 'example' => 'RDS', + ], + ], + [ + 'name' => 'StorageType', + 'in' => 'query', + 'schema' => [ + 'description' => '该参数暂未开放使用。', + 'type' => 'string', + 'required' => false, + 'example' => '无', + ], + ], + [ + 'name' => 'FromApp', + 'in' => 'query', + 'schema' => [ + 'description' => '用于备注请求来源，默认值为OpenApi，无需手动设置。', + 'type' => 'string', + 'required' => false, + 'example' => 'OpenApi', + ], + ], + [ + 'name' => 'SourceEndpointInstanceType', + 'in' => 'query', + 'schema' => [ + 'description' => '数据库所在位置，取值：'."\n" + .'- **RDS**'."\n" + .'- **ECS**'."\n" + .'- **Express**：通过专线/VPN网关/智能网关接入的数据库'."\n" + .'- **Agent**：通过备份网关接入的数据库'."\n" + .'- **DDS**：云MongoDB'."\n" + .'- **Other**：通过IP:Port直连的数据库'."\n" + .'- **dg**：无公网IP:Port的自建数据库（通过数据库网关DG接入）', + 'type' => 'string', + 'required' => true, + 'example' => 'RDS', + ], + ], + [ + 'name' => 'SourceEndpointRegion', + 'in' => 'query', + 'schema' => [ + 'description' => '数据库地域。'."\n" + .'> **SourceEndpoint**.**InstanceType**为**RDS**、**ECS**、**DDS**、**Express**、**Agent**时，该参数必传。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'SourceEndpointInstanceID', + 'in' => 'query', + 'schema' => [ + 'description' => '数据库实例ID。'."\n" + ."\n" + .'> **SourceEndpoint**.**InstanceType**为**RDS**、**ECS**、**DDS**、**Express**时，该参数必传。'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'rm-uf6wjk5xxxxxxxxxx', + ], + ], + [ + 'name' => 'SourceEndpointIP', + 'in' => 'query', + 'schema' => [ + 'description' => '数据库连接地址。'."\n" + ."\n" + .'> **SourceEndpoint**.**InstanceType**为**express**、**agent**、**other**时，该参数必传。', + 'type' => 'string', + 'required' => false, + 'example' => 'rm-uf6wjk5xxxxxxx.mysql.rds.aliyuncs.com', + ], + ], + [ + 'name' => 'SourceEndpointPort', + 'in' => 'query', + 'schema' => [ + 'description' => '数据库端口。'."\n" + ."\n" + .'> **SourceEndpoint**.**InstanceType**为**express**、**agent**、**other**、**ECS**时，该参数必传。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '3306', + ], + ], + [ + 'name' => 'SourceEndpointDatabaseName', + 'in' => 'query', + 'schema' => [ + 'description' => '数据库名称。'."\n" + ."\n" + .'> 数据库类型为**PostgreSQL**、**MongoDB**时，该参数必传。', + 'type' => 'string', + 'required' => false, + 'example' => 'testRDS', + ], + ], + [ + 'name' => 'SourceEndpointUserName', + 'in' => 'query', + 'schema' => [ + 'description' => '数据库账号。'."\n" + ."\n" + .'> 数据库类型为**Redis**，或者数据库所在位置为**agent**且数据库类型为**MSSQL**时该参数非必须，其他场景均必传。', + 'type' => 'string', + 'required' => false, + 'example' => 'testRDS', + ], + ], + [ + 'name' => 'SourceEndpointPassword', + 'in' => 'query', + 'schema' => [ + 'description' => '密码。'."\n" + ."\n" + .'> 数据库类型为**Redis**，或者数据库所在位置为**agent**且数据库类型为**MSSQL**时该参数非必须，其他场景均必传。', + 'type' => 'string', + 'required' => false, + 'example' => 'testPassword', + ], + ], + [ + 'name' => 'BackupGatewayId', + 'in' => 'query', + 'schema' => [ + 'description' => '备份网关ID。'."\n" + ."\n" + .'> - **SourceEndpoint**.**InstanceType**为**agent**时，该参数必传。'."\n" + .'> - 如何创建备份网关，请参见[添加备份网关](~~93250~~)。'."\n" + .'> - 您可以通过[DescribeBackupGatewayList](~~2869840~~)查看已有备份网关列表。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '23313123312', + ], + ], + [ + 'name' => 'OSSBucketName', + 'in' => 'query', + 'schema' => [ + 'description' => 'OSS Bucket名称。'."\n" + .'默认：系统自动生成新的名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'TestOssBucket', + ], + ], + [ + 'name' => 'BackupObjects', + 'in' => 'query', + 'schema' => [ + 'description' => '备份对象。', + 'type' => 'string', + 'required' => false, + 'example' => '[ { "DBName":"待备份库名", "SchemaName":"待备份 Schema 名", "TableIncludes":[{ "TableName":"待备份表表名" }], "TableExcludes":[{ "TableName":"待备份库名不需要备份表的表名" }] } ]', + ], + ], + [ + 'name' => 'BackupPeriod', + 'in' => 'query', + 'schema' => [ + 'description' => '全量备份周期，取值：'."\n" + .'- **Monday**：周一'."\n" + .'- **Tuesday**：周二'."\n" + .'- **Wednesday**：周三'."\n" + .'- **Thursday**：周四'."\n" + .'- **Friday**：周五'."\n" + .'- **Saturday**：周六'."\n" + .'- **Sunday**：周日'."\n" + ."\n" + .'> 支持选择多个取值，用英文逗号（,）分开。', + 'type' => 'string', + 'required' => false, + 'example' => 'Monday', + ], + ], + [ + 'name' => 'BackupStartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '全量备份开始时间，格式为HH:mm（UTC时间）。', + 'type' => 'string', + 'required' => false, + 'example' => '14:22', + ], + ], + [ + 'name' => 'EnableBackupLog', + 'in' => 'query', + 'schema' => [ + 'description' => '是否开启增量日志备份，取值：'."\n" + .'- **true**：开启'."\n" + .'- **false**：关闭', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'BackupLogIntervalSeconds', + 'in' => 'query', + 'schema' => [ + 'description' => '增量时间间隔，以秒（s）为单位。'."\n" + .'> 仅选择**物理备份**时需要传入该参数。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1000', + ], + ], + [ + 'name' => 'BackupRetentionPeriod', + 'in' => 'query', + 'schema' => [ + 'description' => '备份数据保留时间，取值：0~1825，默认为730天。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '730', + ], + ], + [ + 'name' => 'DuplicationInfrequentAccessPeriod', + 'in' => 'query', + 'schema' => [ + 'description' => '转为低频访问存储时间，默认为180天。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '180', + ], + ], + [ + 'name' => 'DuplicationArchivePeriod', + 'in' => 'query', + 'schema' => [ + 'description' => '转为归档冷备存储时间，默认为365天。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '365', + ], + ], + [ + 'name' => 'BackupPlanName', + 'in' => 'query', + 'schema' => [ + 'description' => '自定义备份计划名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'dbstooi0*******', + ], + ], + [ + 'name' => 'SourceEndpointOracleSID', + 'in' => 'query', + 'schema' => [ + 'description' => 'Oracle SID名称，数据库类型为Oracle时，该参数必传。', + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + [ + 'name' => 'BackupStorageType', + 'in' => 'query', + 'schema' => [ + 'description' => '内置存储类型：'."\n" + .'- 空（默认）：备份数据存储在用户OSS上。'."\n" + .'- system ：备份数据存储在DBS的内置OSS上。', + 'type' => 'string', + 'required' => false, + 'example' => '无', + ], + ], + [ + 'name' => 'BackupSpeedLimit', + 'in' => 'query', + 'schema' => [ + 'description' => '磁盘IO限制， 单位为KB/s。'."\n" + .'> 该参数仅对MySQL物理备份生效。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '262144', + ], + ], + [ + 'name' => 'BackupRateLimit', + 'in' => 'query', + 'schema' => [ + 'description' => '网络带宽限制，单位为KB/s，最大允许10 GB。'."\n" + .'> 该参数仅对MySQL物理备份生效。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '262144', + ], + ], + [ + 'name' => 'BackupStrategyType', + 'in' => 'query', + 'schema' => [ + 'description' => '全量备份周期，取值：'."\n" + .'- **simple**：周期备份，和BackupPeriod、BackupStartTime配合使用。'."\n" + .'- **manual**：手动备份。'."\n" + ."\n" + .'> 默认为**simple**。', + 'type' => 'string', + 'required' => false, + 'example' => 'simple', + ], + ], + [ + 'name' => 'CrossAliyunId', + 'in' => 'query', + 'schema' => [ + 'description' => '跨阿里云账号备份的UID。', + 'type' => 'string', + 'required' => false, + 'example' => '1648821913******', + ], + ], + [ + 'name' => 'CrossRoleName', + 'in' => 'query', + 'schema' => [ + 'description' => '跨阿里云账号备份的RAM角色名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'test123', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => '用于保证请求的幂等性，防止重复提交请求。', + 'type' => 'string', + 'required' => false, + 'example' => 'ASDASDASDSADASFCZXVZ', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '资源组ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'rg-aekzecovzti****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回参数详情如下。', + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'HTTP状态码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '4F1888AC-1138-4995-B9FE-D2734F61C058', + ], + 'CreateBackupSet' => [ + 'description' => '是否开启备份集，返回值如下：'."\n" + .'- **true**：开启'."\n" + .'- **false**：关闭', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ErrCode' => [ + 'description' => '错误码。', + 'type' => 'string', + 'example' => 'Param.NotFound', + ], + 'Success' => [ + 'description' => '是否请求成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ErrMessage' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'The specified parameter %s value is not valid.', + ], + 'BackupPlanId' => [ + 'description' => '备份计划ID。', + 'type' => 'string', + 'example' => 'dbs1hvb0wwwe****', + ], + 'OrderId' => [ + 'description' => '订单ID。', + 'type' => 'string', + 'example' => '2056157***', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'Request.Forbidden', + 'errorMessage' => 'Have no Permissions', + 'description' => '当前操作未被授权，请联系主账号在RAM控制台进行授权后再执行操作', + ], + ], + ], + 'title' => '创建并启动备份计划', + 'description' => '请确保在使用该接口前，已充分了解数据库备份DBS产品的[收费方式和价格](~~70005~~)。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + [ + 'createdAt' => '2022-07-28T06:48:28.000Z', + 'description' => '请求参数发生变更', + ], + [ + 'createdAt' => '2022-07-12T03:54:06.000Z', + 'description' => '错误码发生变更', + ], + ], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '10', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'CreateAndStartBackupPlan', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'dbs:CreateAndStartBackupPlan', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DBS', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"4F1888AC-1138-4995-B9FE-D2734F61C058\\",\\n \\"CreateBackupSet\\": true,\\n \\"ErrCode\\": \\"Param.NotFound\\",\\n \\"Success\\": true,\\n \\"ErrMessage\\": \\"The specified parameter %s value is not valid.\\",\\n \\"BackupPlanId\\": \\"dbs1hvb0wwwe****\\",\\n \\"OrderId\\": \\"2056157***\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 3321E2F6-98E3-4B81-ADEC-9FD1BC06249A\\n 200\\n dbs1hrlzt68t7ko1\\n 208422747270728\\n true\\n","errorExample":""}]', + ], + 'CreateBackupPlan' => [ + 'summary' => '该接口用于创建一个DBS备份计划。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREcbsKR7J6S', + ], + ], + 'parameters' => [ + [ + 'name' => 'Region', + 'in' => 'query', + 'schema' => [ + 'description' => 'DBS地域，该参数为必填项，可通过[DescribeRegions](~~2869853~~)查看DBS支持地域。'."\n" + ."\n" + .'> 更多详情信息，请参见[服务接入点](~~2869810~~)。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'InstanceClass', + 'in' => 'query', + 'schema' => [ + 'description' => '规格，取值如下：'."\n" + ."\n" + .'- **micro**：入门型'."\n" + .'- **small**：低配型'."\n" + .'- **medium**：中配型'."\n" + .'- **large**：高配型'."\n" + .'- **xlarge**：高配型（无流量上限）'."\n" + ."\n" + .'> 规格越高，备份与恢复的性能越高，更多信息，请参见[规格说明](~~84372~~)。'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'micro', + ], + ], + [ + 'name' => 'DatabaseType', + 'in' => 'query', + 'schema' => [ + 'description' => '数据库类型，取值如下：'."\n" + ."\n" + .'- **MySQL**'."\n" + .'- **MSSQL**'."\n" + .'- **Oracle**'."\n" + .'- **MariaDB**'."\n" + .'- **PostgreSQL**'."\n" + .'- **DRDS**'."\n" + .'- **MongoDB**'."\n" + .'- **Redis**', + 'type' => 'string', + 'required' => true, + 'example' => 'MySQL', + ], + ], + [ + 'name' => 'BackupMethod', + 'in' => 'query', + 'schema' => [ + 'description' => '备份方式，取值如下：'."\n" + .'- **logical**：逻辑备份'."\n" + .'- **physical**：物理备份', + 'type' => 'string', + 'required' => true, + 'example' => 'logical', + ], + ], + [ + 'name' => 'Period', + 'in' => 'query', + 'schema' => [ + 'description' => '指定预付费实例为包年或者包月类型，取值如下：'."\n" + .'- **Year**：包年'."\n" + .'- **Month**：包月', + 'type' => 'string', + 'required' => false, + 'example' => 'Month', + ], + ], + [ + 'name' => 'UsedTime', + 'in' => 'query', + 'schema' => [ + 'description' => '指定购买时长，取值如下：'."\n" + .'- 当参数**Period**为**Year**时，**UsedTime**取值为1~5。'."\n" + .'- 当参数**Period**为**Month**时，**UsedTime**取值为1~11。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PayType', + 'in' => 'query', + 'schema' => [ + 'description' => '支付方式，取值如下：'."\n" + ."\n" + .' **prepay**：预付费（包年包月）', + 'type' => 'string', + 'required' => false, + 'example' => 'prepay', + ], + ], + [ + 'name' => 'DatabaseRegion', + 'in' => 'query', + 'schema' => [ + 'description' => '数据库地域。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'StorageRegion', + 'in' => 'query', + 'schema' => [ + 'description' => '存储地域。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'InstanceType', + 'in' => 'query', + 'schema' => [ + 'description' => '数据库实例类型，取值如下：'."\n" + .'- **RDS**'."\n" + .'- **PolarDB**'."\n" + .'- **DDS**：阿里云MongoDB'."\n" + .'- **Kvstore**：阿里云Redis'."\n" + .'- **Other**：通过IP:Port接入的数据库'."\n" + .'- **dg**：无公网IP:Port的自建数据库（通过数据库网关DG接入）', + 'type' => 'string', + 'required' => false, + 'example' => 'RDS', + ], + ], + [ + 'name' => 'StorageType', + 'in' => 'query', + 'schema' => [ + 'description' => '该参数暂未开放使用。', + 'type' => 'string', + 'required' => false, + 'example' => '无', + ], + ], + [ + 'name' => 'FromApp', + 'in' => 'query', + 'schema' => [ + 'description' => '用于备注请求来源，默认值为OpenAPI，无需手动设置。', + 'type' => 'string', + 'required' => false, + 'example' => 'OpenAPI', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => '输入任意字符串，用于保证请求幂等性。', + 'type' => 'string', + 'required' => false, + 'example' => 'KJSAHKJFHKJSHFKASHFKJADFHKDXXXX', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '资源组ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'rg-aekzecovzti****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回值详情如下。', + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'HTTP状态码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '7BCF6D62-885F-5A4A-91A1-679760E7****', + ], + 'ErrCode' => [ + 'description' => '错误码。', + 'type' => 'string', + 'example' => 'Param.NotFound', + ], + 'Success' => [ + 'description' => '请求是否成功，返回值如下：'."\n" + .'- **true**：请求成功'."\n" + .'- **false**：请求失败', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ErrMessage' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'The specified parameter %s value is not valid.', + ], + 'BackupPlanId' => [ + 'description' => '备份计划ID。', + 'type' => 'string', + 'example' => 'dbsrhahrsu2****', + ], + 'OrderId' => [ + 'description' => '订单ID。', + 'type' => 'string', + 'example' => '21437345592****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'Request.Forbidden', + 'errorMessage' => 'Have no Permissions', + 'description' => '当前操作未被授权，请联系主账号在RAM控制台进行授权后再执行操作', + ], + ], + ], + 'title' => '创建备份计划', + 'description' => '本接口对应的控制台操作，请参见[购买备份计划](~~65909~~)。', + 'changeSet' => [ + [ + 'createdAt' => '2022-07-28T06:48:28.000Z', + 'description' => '请求参数发生变更', + ], + [ + 'createdAt' => '2022-07-12T03:54:06.000Z', + 'description' => '错误码发生变更', + ], + ], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '10', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'CreateBackupPlan', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'dbs:CreateBackupPlan', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DBS', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"7BCF6D62-885F-5A4A-91A1-679760E7****\\",\\n \\"ErrCode\\": \\"Param.NotFound\\",\\n \\"Success\\": true,\\n \\"ErrMessage\\": \\"The specified parameter %s value is not valid.\\",\\n \\"BackupPlanId\\": \\"dbsrhahrsu2****\\",\\n \\"OrderId\\": \\"21437345592****\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 7BCF6D62-885F-5A4A-91A1-679760E7****\\n 200\\n dbsrhahrsu2****\\n 21437345592****\\n true\\n","errorExample":""}]', + ], + 'CreateFullBackupSetDownload' => [ + 'summary' => '该接口用于创建并启动全量备份集下载任务。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREcbsKR7J6S', + ], + ], + 'parameters' => [ + [ + 'name' => 'BackupSetId', + 'in' => 'query', + 'schema' => [ + 'description' => '全量备份集ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'dbs1hvXXXXX', + ], + ], + [ + 'name' => 'BackupSetDataFormat', + 'in' => 'query', + 'schema' => [ + 'description' => '全量备份集下载格式。取值：'."\n" + .'- **Native**'."\n" + .'- **SQL**'."\n" + .'- **CSV** '."\n" + .'- **JSON**'."\n" + ."\n" + .'> 默认CSV。'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'SQL', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => '用于保证请求的幂等性，防止重复提交请求。', + 'type' => 'string', + 'required' => false, + 'example' => 'ETnLKlblzczshOTUbOCzxxxxxxx', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'HTTP状态码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'D6E068C3-25BC-455A-85FE-45F0B22ECB1F', + ], + 'ErrCode' => [ + 'description' => '错误码。', + 'type' => 'string', + 'example' => 'Param.NotFound', + ], + 'Success' => [ + 'description' => '是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ErrMessage' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'The specified parameter %s value is not valid. ', + ], + 'BackupSetDownloadTaskId' => [ + 'description' => '备份集下载任务ID。', + 'type' => 'string', + 'example' => 'dbstooi01exxxxx', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'Request.Forbidden', + 'errorMessage' => 'Have no Permissions', + 'description' => '当前操作未被授权，请联系主账号在RAM控制台进行授权后再执行操作', + ], + ], + ], + 'title' => '创建全量备份集下载任务', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + [ + 'createdAt' => '2022-07-12T03:54:06.000Z', + 'description' => '错误码发生变更', + ], + ], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '10', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'CreateFullBackupSetDownload', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'dbs:CreateFullBackupSetDownload', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DBS', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"D6E068C3-25BC-455A-85FE-45F0B22ECB1F\\",\\n \\"ErrCode\\": \\"Param.NotFound\\",\\n \\"Success\\": true,\\n \\"ErrMessage\\": \\"The specified parameter %s value is not valid. \\",\\n \\"BackupSetDownloadTaskId\\": \\"dbstooi01exxxxx\\"\\n}","errorExample":""},{"type":"xml","example":"\\nD6E068C3-25BC-455A-85FE-45F0B22ECB1F\\n200\\ndbstooi01exxxxx\\ntrue\\n\\n","errorExample":""}]', + ], + 'CreateGetDBListFromAgentTask' => [ + 'summary' => '该接口用于通过备份网关获取数据库列表任务。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREcbsKR7J6S', + ], + ], + 'parameters' => [ + [ + 'name' => 'BackupGatewayId', + 'in' => 'query', + 'schema' => [ + 'description' => '备份网关ID，可通过调用[DescribeBackupPlanList](~~2869825~~)接口查看。'."\n" + ."\n" + .'> 此参数为必填项。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '160813', + ], + ], + [ + 'name' => 'DatabaseType', + 'in' => 'query', + 'schema' => [ + 'description' => '数据库类型，取值：'."\n" + ."\n" + .'- **MySQL**'."\n" + .'- **MSSQL**'."\n" + .'- **Oracle**'."\n" + .'- **MariaDB**'."\n" + .'- **PostgreSQL**'."\n" + .'- **DRDS**'."\n" + .'- **MongoDB**'."\n" + .'- **Redis**', + 'type' => 'string', + 'required' => false, + 'example' => 'MySQL', + ], + ], + [ + 'name' => 'SourceEndpointRegion', + 'in' => 'query', + 'schema' => [ + 'description' => '备份网关地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'SourceEndpointIP', + 'in' => 'query', + 'schema' => [ + 'description' => '数据库连接地址。', + 'type' => 'string', + 'required' => false, + 'example' => '123.0.XX.XX', + ], + ], + [ + 'name' => 'SourceEndpointPort', + 'in' => 'query', + 'schema' => [ + 'description' => '数据库连接端口。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '3306', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => '用于保证请求的幂等性，防止重复提交请求。由客户端生成该参数值，要保证在不同请求间唯一，最大值不超过64个ASCII字符，且该参数值中不能包含非ASCII字符。'."\n" + ."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'ETnLKlblzczshOTUbOCzxxxxxxxxxx', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => '错误码值。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '400', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'EB4DFD5E-3618-498D-BE35-4DBEA0072122', + ], + 'ErrCode' => [ + 'description' => '错误码字符串。'."\n", + 'type' => 'string', + 'example' => 'InvalidParameter', + ], + 'Success' => [ + 'description' => '请求状态。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ErrMessage' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'This backupPlan can\'t support this action', + ], + 'TaskId' => [ + 'description' => '异步任务ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '123456', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'Request.Forbidden', + 'errorMessage' => 'Have no Permissions', + 'description' => '当前操作未被授权，请联系主账号在RAM控制台进行授权后再执行操作', + ], + ], + ], + 'title' => '创建数据库列表任务', + 'description' => '本API操作会返回TaskId，您可以使用[GetDBListFromAgent](~~2869852~~)接口做结果查询。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + [ + 'createdAt' => '2022-07-12T03:54:06.000Z', + 'description' => '错误码发生变更', + ], + ], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '100', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'CreateGetDBListFromAgentTask', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'dbs:CreateGetDBListFromAgentTask', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DBS', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 400,\\n \\"RequestId\\": \\"EB4DFD5E-3618-498D-BE35-4DBEA0072122\\",\\n \\"ErrCode\\": \\"InvalidParameter\\",\\n \\"Success\\": true,\\n \\"ErrMessage\\": \\"This backupPlan can\'t support this action\\",\\n \\"TaskId\\": 123456\\n}","errorExample":""},{"type":"xml","example":"\\n123456\\nEB4DFD5E-3618-498D-BE35-4DBEA0072122\\n400\\nThis backupPlan can\'t support this action\\ntrue\\nInvalidParameter\\n","errorExample":""}]', + ], + 'CreateIncrementBackupSetDownload' => [ + 'summary' => '该接口用于创建并启动增量备份集下载任务。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREcbsKR7J6S', + ], + ], + 'parameters' => [ + [ + 'name' => 'BackupSetId', + 'in' => 'query', + 'schema' => [ + 'description' => '增量备份集任务ID，可调用[DescribeIncrementBackupList](~~2869833~~)接口获取**BackupSetJobId**。', + 'type' => 'string', + 'required' => true, + 'example' => 't4yh0g0g****', + ], + ], + [ + 'name' => 'BackupSetName', + 'in' => 'query', + 'schema' => [ + 'description' => '增量备份ID，可调用[DescribeIncrementBackupList](~~2869833~~)接口获取**BackupSetId**。', + 'type' => 'string', + 'required' => true, + 'example' => 'mysql-bin.000054', + ], + ], + [ + 'name' => 'BackupSetDataFormat', + 'in' => 'query', + 'schema' => [ + 'description' => '增量备份集下载格式。取值：'."\n" + .'- **Native**'."\n" + .'- **SQL**'."\n" + .'- **CSV** '."\n" + .'- **JSON**'."\n" + ."\n" + .'> 默认 Native。', + 'type' => 'string', + 'required' => false, + 'example' => 'Native', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => '用于保证请求的幂等性，防止重复提交请求。', + 'type' => 'string', + 'required' => false, + 'example' => 'ETnLKlblzczshOTUbOCz********', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'HTTP状态码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'D6E068C3-25BC-455A-85FE-45F0B22ECB1F', + ], + 'ErrCode' => [ + 'description' => '错误码。', + 'type' => 'string', + 'example' => 'Param.NotFound', + ], + 'Success' => [ + 'description' => '是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ErrMessage' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'The specified parameter %s value is not valid. ', + ], + 'BackupSetDownloadTaskId' => [ + 'description' => '备份集下载任务ID。', + 'type' => 'string', + 'example' => '1jydacm******', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'Request.Forbidden', + 'errorMessage' => 'Have no Permissions', + 'description' => '当前操作未被授权，请联系主账号在RAM控制台进行授权后再执行操作', + ], + ], + ], + 'title' => '创建增量备份集下载任务', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + [ + 'createdAt' => '2022-07-12T03:54:06.000Z', + 'description' => '错误码发生变更', + ], + ], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '10', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'CreateIncrementBackupSetDownload', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'dbs:CreateIncrementBackupSetDownload', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DBS', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"D6E068C3-25BC-455A-85FE-45F0B22ECB1F\\",\\n \\"ErrCode\\": \\"Param.NotFound\\",\\n \\"Success\\": true,\\n \\"ErrMessage\\": \\"The specified parameter %s value is not valid. \\",\\n \\"BackupSetDownloadTaskId\\": \\"1jydacm******\\"\\n}","errorExample":""},{"type":"xml","example":"\\nD6E068C3-25BC-455A-85FE-45F0B22ECB1F\\n200\\ndbstooi01exxxxx\\ntrue\\n","errorExample":""}]', + ], + 'CreateRestoreTask' => [ + 'summary' => '该接口用于创建DBS恢复任务。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREcbsKR7J6S', + ], + ], + 'parameters' => [ + [ + 'name' => 'BackupPlanId', + 'in' => 'query', + 'schema' => [ + 'description' => '备份计划ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'dbs1hvb0ww****', + ], + ], + [ + 'name' => 'DestinationEndpointInstanceType', + 'in' => 'query', + 'schema' => [ + 'description' => '数据库所在位置，取值：'."\n" + .'- **RDS**'."\n" + .'- **ECS**'."\n" + .'- **Express**：通过专线/VPN网关/智能网关接入的数据库'."\n" + .'- **Agent**：通过备份网关接入的数据库'."\n" + .'- **DDS**：云MongoDB'."\n" + .'- **Other**：通过IP:Port直连的数据库'."\n" + .'- **dg**：无公网IP:Port的自建数据库（通过数据库网关DG接入）', + 'type' => 'string', + 'required' => true, + 'example' => 'RDS', + ], + ], + [ + 'name' => 'DestinationEndpointRegion', + 'in' => 'query', + 'schema' => [ + 'description' => '数据库实例的地域。'."\n" + .'>**DestinationEndpointInstanceType**为RDS、ECS、DDS、Express、Agent时，该参数必传。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'DestinationEndpointInstanceID', + 'in' => 'query', + 'schema' => [ + 'description' => '数据库实例ID。'."\n" + ."\n" + .'> **DestinationEndpointInstanceType**为RDS、ECS、DDS、Express时，该参数必传。', + 'type' => 'string', + 'required' => false, + 'example' => 'rm-bp1p8c29*****', + ], + ], + [ + 'name' => 'DestinationEndpointIP', + 'in' => 'query', + 'schema' => [ + 'description' => '数据库连接地址。'."\n" + ."\n" + .'> **DestinationEndpointInstanceType**为express、agent、other，该参数必传。', + 'type' => 'string', + 'required' => false, + 'example' => 'rm-bp*****9jv8pxero.mysql.rds.aliyuncs.com', + ], + ], + [ + 'name' => 'DestinationEndpointPort', + 'in' => 'query', + 'schema' => [ + 'description' => '数据库端口。'."\n" + ."\n" + .'> **DestinationEndpointInstanceType**为express、agent、other、ECS，该参数必传。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '3306', + ], + ], + [ + 'name' => 'DestinationEndpointDatabaseName', + 'in' => 'query', + 'schema' => [ + 'description' => '数据库名称。'."\n" + ."\n" + .'> 数据库类型为PostgreSQL、MongoDB时，该参数必传。', + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + [ + 'name' => 'DestinationEndpointUserName', + 'in' => 'query', + 'schema' => [ + 'description' => '数据库账号。'."\n" + ."\n" + .'> 数据库类型为Redis，或者数据库所在位置为agent且数据库类型为MSSQL时该参数非必须，其他场景均必传。', + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + [ + 'name' => 'DestinationEndpointPassword', + 'in' => 'query', + 'schema' => [ + 'description' => '密码。'."\n" + ."\n" + .'> 数据库类型为Redis，或者数据库所在位置为agent且数据库类型为MSSQL时该参数非必须，其他场景均必传。', + 'type' => 'string', + 'required' => false, + 'example' => 'Test', + ], + ], + [ + 'name' => 'BackupGatewayId', + 'in' => 'query', + 'schema' => [ + 'description' => '备份网关ID。'."\n" + ."\n" + .'> **DestinationEndpointInstanceType**为agent时，该参数必传。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '4312****', + ], + ], + [ + 'name' => 'RestoreObjects', + 'in' => 'query', + 'schema' => [ + 'description' => '恢复对象。'."\n" + ."\n" + .'- 详情请参见下面的**RestoreObjects**参数定义，当数据库所在位置为agent时，该参数非必须，其他场景均必传。'."\n" + .'- 传入模板：`[{ "DBName": "待恢复库名", "NewDBName": "目标待恢复库名" }] `'."\n" + ."\n" + .'> 使用本API接口恢复对象仅支持恢复到数据库级别，如需配置指定表的恢复，请前往控制台进行操作。具体请参见[恢复数据库](~~85543~~)。', + 'type' => 'string', + 'required' => false, + 'example' => 'MySQL表级别恢复示例如下：'."\n" + .'[{\\"DBName\\":\\"dbname\\", \\"NewDBName\\":\\"dbname1\\"}]', + ], + ], + [ + 'name' => 'RestoreTime', + 'in' => 'query', + 'schema' => [ + 'description' => '恢复时间，取值：1554560477000。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1554560477000', + ], + ], + [ + 'name' => 'BackupSetId', + 'in' => 'query', + 'schema' => [ + 'description' => '恢复所使用的全量备份集ID，和RestoreTime互斥。', + 'type' => 'string', + 'required' => false, + 'example' => 'dbs1hvb0w*****', + ], + ], + [ + 'name' => 'RestoreTaskName', + 'in' => 'query', + 'schema' => [ + 'description' => '恢复任务名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'test', + ], + ], + [ + 'name' => 'DestinationEndpointOracleSID', + 'in' => 'query', + 'schema' => [ + 'description' => 'Oracle SID名称。'."\n" + ."\n" + .'> 数据库类型为Oracle时，该参数必传。', + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + [ + 'name' => 'RestoreDir', + 'in' => 'query', + 'schema' => [ + 'description' => '**DestinationEndpointInstanceType**为agent且备份计划为MySQL时必传。', + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + [ + 'name' => 'RestoreHome', + 'in' => 'query', + 'schema' => [ + 'description' => '数据库程序目录。', + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + [ + 'name' => 'DuplicateConflict', + 'in' => 'query', + 'schema' => [ + 'description' => '同名对象冲突处理方式，当前支持：'."\n" + ."\n" + .'**renamenew**：遇到同名对象则重命名', + 'type' => 'string', + 'required' => false, + 'example' => 'renamenew', + ], + ], + [ + 'name' => 'CrossAliyunId', + 'in' => 'query', + 'schema' => [ + 'description' => '跨阿里云账号备份的UID。', + 'type' => 'string', + 'required' => false, + 'example' => '2749528728********', + ], + ], + [ + 'name' => 'CrossRoleName', + 'in' => 'query', + 'schema' => [ + 'description' => '跨阿里云账号备份的RAM角色名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'test123', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => '用于保证请求的幂等性，防止重复提交请求。', + 'type' => 'string', + 'required' => false, + 'example' => 'ETnLKlblzczshOTUbOC********', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回参数详情如下。', + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'HTTP状态码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '60AF7C5D-EF4D-4D48-8FD5-C0823FDF28AC', + ], + 'ErrCode' => [ + 'description' => '错误码。', + 'type' => 'string', + 'example' => 'Param.NotFound', + ], + 'Success' => [ + 'description' => '是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ErrMessage' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'The specified parameter %s value is not valid. ', + ], + 'RestoreTaskId' => [ + 'description' => '恢复任务ID。', + 'type' => 'string', + 'example' => 's102h*****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'Request.Forbidden', + 'errorMessage' => 'Have no Permissions', + 'description' => '当前操作未被授权，请联系主账号在RAM控制台进行授权后再执行操作', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'title' => '创建恢复任务', + 'description' => '### 相关操作文档'."\n" + ."\n" + .'- [恢复数据库](~~85543~~)'."\n" + .'- [各类数据库恢复配置教程](~~197144~~)', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + [ + 'createdAt' => '2022-07-12T03:54:06.000Z', + 'description' => '错误码发生变更', + ], + ], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '10000', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'CreateRestoreTask', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'dbs:CreateRestoreTask', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DBS', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"60AF7C5D-EF4D-4D48-8FD5-C0823FDF28AC\\",\\n \\"ErrCode\\": \\"Param.NotFound\\",\\n \\"Success\\": true,\\n \\"ErrMessage\\": \\"The specified parameter %s value is not valid. \\",\\n \\"RestoreTaskId\\": \\"s102h*****\\"\\n}","errorExample":""},{"type":"xml","example":"\\ns102hXXXXX\\n60AF7C5D-EF4D-4D48-8FD5-C0823FDF28AC\\n200\\ntrue\\n\\n","errorExample":""}]', + ], + 'DescribeBackupGatewayList' => [ + 'summary' => '该接口用于查看DBS备份网关列表。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREcbsKR7J6S', + ], + ], + 'parameters' => [ + [ + 'name' => 'Region', + 'in' => 'query', + 'schema' => [ + 'description' => 'DBS地域，取值：'."\n" + .'- **cn-hangzhou**：公有云杭州'."\n" + .'- **cn-shanghai**：公有云上海'."\n" + .'- **cn-qingdao**：公有云青岛'."\n" + .'- **cn-beijing**：公有云北京'."\n" + .'- **cn-shenzhen**：公有云深圳'."\n" + .'- **cn-hongkong**：公有云中国香港'."\n" + .'- **ap-southeat-1**：公有云新加坡'."\n" + .'- **cn-hangzhou-finance**：金融云杭州'."\n" + .'- **cn-shanghai-finance**：金融云上海'."\n" + .'- **cn-shenzhen-finance**：金融云深圳', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'Identifier', + 'in' => 'query', + 'schema' => [ + 'description' => '备份网关唯一标识，支持多个查询，用英文逗号（,）分隔。', + 'type' => 'string', + 'required' => false, + 'example' => '7213527653217', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页的记录数，取值：'."\n" + .'- **30**'."\n" + .'- **50**'."\n" + .'- **100**'."\n" + ."\n" + .'> 默认为30。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '30', + ], + ], + [ + 'name' => 'PageNum', + 'in' => 'query', + 'schema' => [ + 'description' => '页码，大于等于0且不超过Integer的最大值，默认值为：0。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => '用于保证请求的幂等性，防止重复提交请求。', + 'type' => 'string', + 'required' => false, + 'example' => 'ETnLKlblzczshOTUbOCzxxxxxxx', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'HTTP状态码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'PageNum' => [ + 'description' => '页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '46361705-8531-492F-807E-A97E482DD4A1', + ], + 'ErrCode' => [ + 'description' => '错误码。', + 'type' => 'string', + 'example' => 'Param.NotFound', + ], + 'Success' => [ + 'description' => '是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ErrMessage' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'The specified parameter %s value is not valid. ', + ], + 'TotalPages' => [ + 'description' => '总页数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'TotalElements' => [ + 'description' => '总备份网关数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'PageSize' => [ + 'description' => '每页的记录数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '30', + ], + 'Items' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'BackupGateway' => [ + 'description' => '备份网关详情。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'DisplayName' => [ + 'description' => '备份网关显示名称。', + 'type' => 'string', + 'example' => 'test', + ], + 'BackupGatewayCreateTime' => [ + 'description' => '备份网关创建时间，取值1554560477000。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1554560477000', + ], + 'BackupGatewayId' => [ + 'description' => '备份网关ID。', + 'type' => 'string', + 'example' => '2321313123', + ], + 'Region' => [ + 'description' => '地域。', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'Identifier' => [ + 'description' => '备份网关唯一标识。', + 'type' => 'string', + 'example' => 'sgdsajhdgu', + ], + 'SourceEndpointInternetIP' => [ + 'description' => '安装备份网关的主机公网IP。', + 'type' => 'string', + 'example' => 'XX.XX.XX.XX', + ], + 'BackupGatewayStatus' => [ + 'description' => '备份网关状态，取值：'."\n" + .'- ONLINE：在线'."\n" + .'- OFFLINE：离线'."\n" + .'- STOPPED：停止'."\n" + .'- UPGRADING：升级中', + 'type' => 'string', + 'example' => 'ONLINE', + ], + 'SourceEndpointIntranetIP' => [ + 'description' => '安装备份网关的主机私网IP。', + 'type' => 'string', + 'example' => 'XX.XX.XX.XX', + ], + 'LastHeartbeatTime' => [ + 'description' => '上次心跳汇报时间，取值：1554560477000。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1554560477000', + ], + 'SourceEndpointHostname' => [ + 'description' => '安装备份网关的主机名称。', + 'type' => 'string', + 'example' => 'test', + ], + ], + 'description' => '', + ], + ], + ], + 'description' => '', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'Request.Forbidden', + 'errorMessage' => 'Have no Permissions', + 'description' => '当前操作未被授权，请联系主账号在RAM控制台进行授权后再执行操作', + ], + ], + ], + 'title' => '查看备份网关列表', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + [ + 'createdAt' => '2022-07-12T03:54:06.000Z', + 'description' => '错误码发生变更', + ], + ], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '100', + 'countWindow' => 60, + 'regionId' => '*', + 'api' => 'DescribeBackupGatewayList', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dbs:DescribeBackupGatewayList', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DBS', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"PageNum\\": 1,\\n \\"RequestId\\": \\"46361705-8531-492F-807E-A97E482DD4A1\\",\\n \\"ErrCode\\": \\"Param.NotFound\\",\\n \\"Success\\": true,\\n \\"ErrMessage\\": \\"The specified parameter %s value is not valid. \\",\\n \\"TotalPages\\": 1,\\n \\"TotalElements\\": 0,\\n \\"PageSize\\": 30,\\n \\"Items\\": {\\n \\"BackupGateway\\": [\\n {\\n \\"DisplayName\\": \\"test\\",\\n \\"BackupGatewayCreateTime\\": 1554560477000,\\n \\"BackupGatewayId\\": \\"2321313123\\",\\n \\"Region\\": \\"cn-hangzhou\\",\\n \\"Identifier\\": \\"sgdsajhdgu\\",\\n \\"SourceEndpointInternetIP\\": \\"XX.XX.XX.XX\\",\\n \\"BackupGatewayStatus\\": \\"ONLINE\\",\\n \\"SourceEndpointIntranetIP\\": \\"XX.XX.XX.XX\\",\\n \\"LastHeartbeatTime\\": 1554560477000,\\n \\"SourceEndpointHostname\\": \\"test\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"30\\n46361705-8531-492F-807E-A97E482DD4A1\\n0\\n200\\n0\\n\\n0\\ntrue","errorExample":""}]', + ], + 'DescribeBackupPlanBilling' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREcbsKR7J6S', + ], + ], + 'parameters' => [ + [ + 'name' => 'BackupPlanId', + 'in' => 'query', + 'schema' => [ + 'description' => '备份计划ID，可通过调用[DescribeBackupPlanList](~~2869825~~)接口获取该参数的值。', + 'type' => 'string', + 'required' => true, + 'example' => 'dbstooi01ex****', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => '用于保证请求的幂等性，防止重复提交请求。由客户端生成该参数值，要保证在不同请求间唯一，最大值不超过64个ASCII字符，且该参数值中不能包含非ASCII字符。'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'ETnLKlblzczshOTUbOCzxxxxxxxxxx', + ], + ], + [ + 'name' => 'ShowStorageType', + 'in' => 'query', + 'schema' => [ + 'description' => '是否展示存储类型。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => '错误码值。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '400', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'DD7BC7F5-4E3A-5DF3-BFF9-831503C4D9E3', + ], + 'ErrCode' => [ + 'description' => '错误码字符串。', + 'type' => 'string', + 'example' => 'InvalidParameter', + ], + 'Success' => [ + 'description' => '请求成功状态。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ErrMessage' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'This backupPlan can\'t support this action', + ], + 'Item' => [ + 'description' => '备份计划计费信息列表。', + 'type' => 'object', + 'properties' => [ + 'BuyCreateTimestamp' => [ + 'description' => '实例购买时间，格式为时间戳。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1658372830000', + ], + 'FullStorageSize' => [ + 'description' => '实例全量备份数据内置存储量，单位为字节（B）。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '151', + ], + 'BuyExpiredTimestamp' => [ + 'description' => '实例到期时间，格式为时间戳。'."\n" + .'> 该参数仅在BuyChargeType选择PREPAY时显示。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1661097600000', + ], + 'BuySpec' => [ + 'description' => '实例规格。', + 'type' => 'string', + 'example' => 'micro', + ], + 'QuotaEndTimestamp' => [ + 'description' => '免费备份流量计费周期结束时间，格式为时间戳。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1659283200000', + ], + 'IsExpired' => [ + 'description' => '实例是否过期。'."\n" + .'> 该参数仅在BuyChargeType选择PREPAY时显示。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'QuotaStartTimestamp' => [ + 'description' => '免费备份流量计费周期开始时间，格式为时间戳。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1656604800000', + ], + 'TotalFreeBytes' => [ + 'description' => '当月免费备份总流量，单位为字节（B）。'."\n" + .'> 该参数仅在BuyChargeType选择PREPAY且IsFreeBytesUnlimited为false时显示。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '858993459200', + ], + 'PaiedBytes' => [ + 'description' => '当月付费备份流量合计，单位为字节（B）。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'UsedFullBytes' => [ + 'description' => '当月付费全量备份流量，单位为字节（B）。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'IsFreeBytesUnlimited' => [ + 'description' => '实例是否为无备份流量上限规格。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ContStorageSize' => [ + 'description' => '实例增量备份数据内置存储量，单位为字节（B）。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10437039', + ], + 'BuyChargeType' => [ + 'description' => '购买费用类型，返回值如下：'."\n" + ."\n" + .'- **PREPAY**：预付费（包年包月）'."\n" + .'- **POSTPAY**：后付费（按量付费）', + 'type' => 'string', + 'example' => 'PREPAY', + ], + 'UsedIncrementBytes' => [ + 'description' => '当月付费增量备份流量，单位为字节（B）。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '9406734', + ], + ], + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'Request.Forbidden', + 'errorMessage' => 'Have no Permissions', + 'description' => '当前操作未被授权，请联系主账号在RAM控制台进行授权后再执行操作', + ], + ], + ], + 'title' => '查看备份计划计费信息', + 'summary' => '该接口用于查看备份计划计费信息。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + [ + 'createdAt' => '2022-08-18T07:56:56.000Z', + 'description' => '响应参数发生变更', + ], + [ + 'createdAt' => '2022-07-28T06:48:28.000Z', + 'description' => '响应参数发生变更', + ], + [ + 'createdAt' => '2022-07-12T03:54:06.000Z', + 'description' => '错误码发生变更', + ], + ], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '100', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'DescribeBackupPlanBilling', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dbs:DescribeBackupPlanBilling', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DBS', + 'resourceType' => 'BackupPlan', + 'arn' => 'acs:dbs:{#regionId}:{#accountId}:backupplan/{#BackupPlanId}', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 400,\\n \\"RequestId\\": \\"DD7BC7F5-4E3A-5DF3-BFF9-831503C4D9E3\\",\\n \\"ErrCode\\": \\"InvalidParameter\\",\\n \\"Success\\": true,\\n \\"ErrMessage\\": \\"This backupPlan can\'t support this action\\",\\n \\"Item\\": {\\n \\"BuyCreateTimestamp\\": 1658372830000,\\n \\"FullStorageSize\\": 151,\\n \\"BuyExpiredTimestamp\\": 1661097600000,\\n \\"BuySpec\\": \\"micro\\",\\n \\"QuotaEndTimestamp\\": 1659283200000,\\n \\"IsExpired\\": true,\\n \\"QuotaStartTimestamp\\": 1656604800000,\\n \\"TotalFreeBytes\\": 858993459200,\\n \\"PaiedBytes\\": 0,\\n \\"UsedFullBytes\\": 0,\\n \\"IsFreeBytesUnlimited\\": true,\\n \\"ContStorageSize\\": 10437039,\\n \\"BuyChargeType\\": \\"PREPAY\\",\\n \\"UsedIncrementBytes\\": 9406734\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n\\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n\\nEB4DFD5E-3618-498D-BE35-4DBEA0072122\\n400\\nThis backupPlan can\'t support this action\\ntrue\\nInvalidParameter\\n\\n","errorExample":""}]', + ], + 'DescribeBackupPlanList' => [ + 'summary' => '该接口用于查看一个DBS备份计划。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREcbsKR7J6S', + ], + ], + 'parameters' => [ + [ + 'name' => 'BackupPlanId', + 'in' => 'query', + 'schema' => [ + 'description' => '备份计划ID，支持查询多个备份计划，英文逗号“,”分隔。', + 'type' => 'string', + 'required' => false, + 'example' => 'dbstooi01exXXXX', + ], + ], + [ + 'name' => 'Region', + 'in' => 'query', + 'schema' => [ + 'description' => 'DBS地域，可通过调用[DescribeRegions](~~2869853~~)接口查看DBS支持地域。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页的记录数，取值为1~100。'."\n" + ."\n" + .'> 默认为**30**。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '30', + ], + ], + [ + 'name' => 'PageNum', + 'in' => 'query', + 'schema' => [ + 'description' => '页码，大于等于0且不超过Integer的最大值，默认值为：0。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'BackupPlanName', + 'in' => 'query', + 'schema' => [ + 'description' => '备份计划名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'test123', + ], + ], + [ + 'name' => 'BackupPlanStatus', + 'in' => 'query', + 'schema' => [ + 'description' => '备份计划状态，取值：'."\n" + ."\n" + .'* **wait**：未配置'."\n" + .'* **init**：未启动（预检查失败）'."\n" + .'* **running**：运行中'."\n" + .'* **stop**：失败'."\n" + .'* **pause**：暂停'."\n" + .'* **locked**：锁定中'."\n" + .'* **check_pass**：预检查通过', + 'type' => 'string', + 'required' => false, + 'example' => 'wait', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => '用于保证请求的幂等性，防止重复提交请求。', + 'type' => 'string', + 'required' => false, + 'example' => 'ASDASDASDSADASFCZXVZ', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '资源组ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'rg-aekzecovzti****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回参数详情如下。', + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'HTTP状态码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'PageNum' => [ + 'description' => '页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '4F1888AC-1138-4995-B9FE-D2734F61C058', + ], + 'ErrCode' => [ + 'description' => '错误码。', + 'type' => 'string', + 'example' => 'InvalidParameterValid', + ], + 'Success' => [ + 'description' => '是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ErrMessage' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'The specified parameter %s value is not valid. ', + ], + 'TotalPages' => [ + 'description' => '总页数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '4', + ], + 'TotalElements' => [ + 'description' => '总备份计划数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + ], + 'PageSize' => [ + 'description' => '每页的记录数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '30', + ], + 'Items' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'BackupPlanDetail' => [ + 'description' => '备份计划详情。', + 'type' => 'array', + 'items' => [ + 'description' => '返回值。', + 'type' => 'object', + 'properties' => [ + 'CrossRoleName' => [ + 'description' => '跨阿里云账号备份的RAM角色名称。', + 'type' => 'string', + 'example' => 'test123', + ], + 'SourceEndpointInstanceType' => [ + 'description' => '数据库所在位置，返回值如下：'."\n" + .'- **rds**'."\n" + .'- **ecs**'."\n" + .'- **express**：通过专线/VPN网关/智能网关接入的数据库'."\n" + .'- **agent**：通过备份网关接入的数据库'."\n" + .'- **dds**：云MongoDB'."\n" + .'- **other**：通过IP:Port直连的数据库', + 'type' => 'string', + 'example' => 'rds', + ], + 'BackupSetDownloadDir' => [ + 'description' => '备份集下载服务器目录。', + 'type' => 'string', + 'example' => '*/test/test123', + ], + 'SourceEndpointIpPort' => [ + 'description' => '数据库连接地址。', + 'type' => 'string', + 'example' => '100.*.*.10:33204', + ], + 'CrossAliyunId' => [ + 'description' => '跨阿里云账号备份的uid。', + 'type' => 'string', + 'example' => '2xxx7778xxxxxxxxxx', + ], + 'DuplicationArchivePeriod' => [ + 'description' => '转为归档冷备存储时间（天）。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '365', + ], + 'BackupPlanId' => [ + 'description' => '备份计划ID。', + 'type' => 'string', + 'example' => 'dbstooi01eXXXX', + ], + 'EndTimestampForRestore' => [ + 'description' => '数据库可恢复时间段的结束时间，格式为时间戳。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1554560477000', + ], + 'BackupPlanStatus' => [ + 'description' => '备份计划状态，返回值如下：'."\n" + .'- **wait**：未配置'."\n" + .'- **init**：未启动（预检查失败）'."\n" + .'- **running**：运行中'."\n" + .'- **stop**：失败'."\n" + .'- **pause**：暂停'."\n" + .'- **locked**：锁定中'."\n" + .'- **check_pass**：预检查通过', + 'type' => 'string', + 'example' => 'init', + ], + 'BackupSetDownloadFullDataFormat' => [ + 'description' => '备份集下载全量数据格式：'."\n" + .'* **Native**'."\n" + .'* **SQL**'."\n" + .'* **CSV**'."\n" + .'* **JSON**', + 'type' => 'string', + 'example' => 'SQL', + ], + 'BackupRetentionPeriod' => [ + 'description' => '备份数据保留时间，返回值：0~1825（天）。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '365', + ], + 'OSSBucketRegion' => [ + 'description' => 'OSS Bucket地域。', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'SourceEndpointOracleSID' => [ + 'description' => 'Oracle SID名称。', + 'type' => 'string', + 'example' => 'test', + ], + 'BackupStorageType' => [ + 'description' => '内置存储类型，返回值如下：'."\n" + ."\n" + .'- 空（默认）：备份数据存储在用户OSS上。'."\n" + .'- system ：备份数据存储在DBS的内置OSS上。', + 'type' => 'string', + 'example' => 'system', + ], + 'BackupMethod' => [ + 'description' => '备份方式，返回值如下：'."\n" + .'- **logical**：逻辑备份'."\n" + .'- **physical**：物理备份'."\n" + .'- **duplication**：转储备份', + 'type' => 'string', + 'example' => 'logical', + ], + 'SourceEndpointRegion' => [ + 'description' => '数据库地域。', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'BackupPeriod' => [ + 'description' => '全量备份周期，返回值如下：'."\n" + .'- **Monday**：周一'."\n" + .'- **Tuesday**：周二'."\n" + .'- **Wednesday**：周三'."\n" + .'- **Thursday**：周四'."\n" + .'- **Friday**：周五'."\n" + .'- **Saturday**：周六'."\n" + .'- **Sunday**：周日', + 'type' => 'string', + 'example' => 'Monday', + ], + 'SourceEndpointDatabaseName' => [ + 'description' => '数据库名称。', + 'type' => 'string', + 'example' => 'test', + ], + 'BackupSetDownloadGatewayId' => [ + 'description' => '备份集下载备份网关ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '123123', + ], + 'BackupPlanCreateTime' => [ + 'description' => '备份计划创建时间戳。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1582527713000', + ], + 'InstanceClass' => [ + 'description' => '规格，返回值如下：'."\n" + ."\n" + .'- **micro**：入门型'."\n" + .'- **small**：低配型'."\n" + .'- **medium**：中配型'."\n" + .'- **large**：高配型'."\n" + .'- **xlarge**：高配型（无流量上限）', + 'type' => 'string', + 'example' => 'micro', + ], + 'BackupSetDownloadTargetType' => [ + 'description' => '备份集下载目标类型。'."\n" + ."\n" + .'> 唯一取值：agent，表示已安装备份网关。', + 'type' => 'string', + 'example' => 'agent', + ], + 'DuplicationInfrequentAccessPeriod' => [ + 'description' => '转为低频访问存储时间（天）。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '180', + ], + 'BackupStartTime' => [ + 'description' => '全量备份开始时间，格式为HH:mm。', + 'type' => 'string', + 'example' => '14:22', + ], + 'ErrMessage' => [ + 'description' => '预检查任务异常信息。', + 'type' => 'string', + 'example' => ' can not connect to oracle instance orcl with user dbs', + ], + 'BackupObjects' => [ + 'description' => '备份对象。', + 'type' => 'string', + 'example' => '[ { \\"DBName\\":\\"待备份库名\\", \\"SchemaName\\":\\"待备份 Schema 名\\", \\"TableIncludes\\":[{ \\"TableName\\":\\"待备份表表名\\" }], \\"TableExcludes\\":[{ \\"TableName\\":\\"待备份库名不需要备份表的表名\\" }] } ]', + ], + 'BeginTimestampForRestore' => [ + 'description' => '可数据库恢复时间段的开始时间，返回值：1554560477000。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1554560477000', + ], + 'SourceEndpointInstanceID' => [ + 'description' => '数据库实例ID。', + 'type' => 'string', + 'example' => 'test', + ], + 'OpenBackupSetAutoDownload' => [ + 'description' => '是否开启自动备份集下载功能。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'BackupPlanName' => [ + 'description' => '备份计划名称。', + 'type' => 'string', + 'example' => 'dbstooi01e****', + ], + 'OSSBucketName' => [ + 'description' => 'OSS Bucket名称。', + 'type' => 'string', + 'example' => 'dbs-backup-1857XXXXX489', + ], + 'BackupGatewayId' => [ + 'description' => '备份网关ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '827362187368736', + ], + 'SourceEndpointUserName' => [ + 'description' => '数据库账号。', + 'type' => 'string', + 'example' => 'test', + ], + 'BackupSetDownloadIncrementDataFormat' => [ + 'description' => '备份集下载全量数据格式：'."\n" + .'* **Native**'."\n" + .'* **SQL**'."\n" + .'* **CSV**'."\n" + .'* **JSON**', + 'type' => 'string', + 'example' => 'SQL', + ], + 'EnableBackupLog' => [ + 'description' => '是否开启增量日志备份，返回值如下：'."\n" + .'- **true**：开启'."\n" + .'- **false**：关闭', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ResourceGroupId' => [ + 'description' => '资源组ID。', + 'type' => 'string', + 'example' => 'rg-aekzecovzti****', + ], + 'DatabaseType' => [ + 'description' => '数据库类型。', + 'type' => 'string', + 'example' => 'MySQL', + ], + ], + ], + ], + ], + 'description' => '', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'Request.Forbidden', + 'errorMessage' => 'Have no Permissions', + 'description' => '当前操作未被授权，请联系主账号在RAM控制台进行授权后再执行操作', + ], + ], + ], + 'title' => '查看备份计划', + 'description' => '请在使用本接口前，提前开通OSS服务，更多信息请参见[对象存储OSS](~~31817~~)。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + [ + 'createdAt' => '2023-03-28T07:35:02.000Z', + 'description' => '响应参数发生变更', + ], + [ + 'createdAt' => '2022-08-12T03:51:12.000Z', + 'description' => '响应参数发生变更', + ], + [ + 'createdAt' => '2022-07-28T06:48:28.000Z', + 'description' => '请求参数发生变更、响应参数发生变更', + ], + [ + 'createdAt' => '2022-07-12T03:54:06.000Z', + 'description' => '错误码发生变更', + ], + ], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '50', + 'countWindow' => 60, + 'regionId' => '*', + 'api' => 'DescribeBackupPlanList', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dbs:DescribeBackupPlanList', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DBS', + 'resourceType' => 'BackupPlan', + 'arn' => 'acs:dbs:{#regionId}:{#accountId}:backupplan/{#BackupPlanId}', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"PageNum\\": 1,\\n \\"RequestId\\": \\"4F1888AC-1138-4995-B9FE-D2734F61C058\\",\\n \\"ErrCode\\": \\"InvalidParameterValid\\",\\n \\"Success\\": true,\\n \\"ErrMessage\\": \\"The specified parameter %s value is not valid. \\",\\n \\"TotalPages\\": 4,\\n \\"TotalElements\\": 100,\\n \\"PageSize\\": 30,\\n \\"Items\\": {\\n \\"BackupPlanDetail\\": [\\n {\\n \\"CrossRoleName\\": \\"test123\\",\\n \\"SourceEndpointInstanceType\\": \\"rds\\",\\n \\"BackupSetDownloadDir\\": \\"*/test/test123\\",\\n \\"SourceEndpointIpPort\\": \\"100.*.*.10:33204\\",\\n \\"CrossAliyunId\\": \\"2xxx7778xxxxxxxxxx\\",\\n \\"DuplicationArchivePeriod\\": 365,\\n \\"BackupPlanId\\": \\"dbstooi01eXXXX\\",\\n \\"EndTimestampForRestore\\": 1554560477000,\\n \\"BackupPlanStatus\\": \\"init\\",\\n \\"BackupSetDownloadFullDataFormat\\": \\"SQL\\",\\n \\"BackupRetentionPeriod\\": 365,\\n \\"OSSBucketRegion\\": \\"cn-hangzhou\\",\\n \\"SourceEndpointOracleSID\\": \\"test\\",\\n \\"BackupStorageType\\": \\"system\\",\\n \\"BackupMethod\\": \\"logical\\",\\n \\"SourceEndpointRegion\\": \\"cn-hangzhou\\",\\n \\"BackupPeriod\\": \\"Monday\\",\\n \\"SourceEndpointDatabaseName\\": \\"test\\",\\n \\"BackupSetDownloadGatewayId\\": 123123,\\n \\"BackupPlanCreateTime\\": 1582527713000,\\n \\"InstanceClass\\": \\"micro\\",\\n \\"BackupSetDownloadTargetType\\": \\"agent\\",\\n \\"DuplicationInfrequentAccessPeriod\\": 180,\\n \\"BackupStartTime\\": \\"14:22\\",\\n \\"ErrMessage\\": \\" can not connect to oracle instance orcl with user dbs\\",\\n \\"BackupObjects\\": \\"[ { \\\\\\\\\\\\\\"DBName\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"待备份库名\\\\\\\\\\\\\\", \\\\\\\\\\\\\\"SchemaName\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"待备份 Schema 名\\\\\\\\\\\\\\", \\\\\\\\\\\\\\"TableIncludes\\\\\\\\\\\\\\":[{ \\\\\\\\\\\\\\"TableName\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"待备份表表名\\\\\\\\\\\\\\" }], \\\\\\\\\\\\\\"TableExcludes\\\\\\\\\\\\\\":[{ \\\\\\\\\\\\\\"TableName\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"待备份库名不需要备份表的表名\\\\\\\\\\\\\\" }] } ]\\",\\n \\"BeginTimestampForRestore\\": 1554560477000,\\n \\"SourceEndpointInstanceID\\": \\"test\\",\\n \\"OpenBackupSetAutoDownload\\": true,\\n \\"BackupPlanName\\": \\"dbstooi01e****\\",\\n \\"OSSBucketName\\": \\"dbs-backup-1857XXXXX489\\",\\n \\"BackupGatewayId\\": 827362187368736,\\n \\"SourceEndpointUserName\\": \\"test\\",\\n \\"BackupSetDownloadIncrementDataFormat\\": \\"SQL\\",\\n \\"EnableBackupLog\\": true,\\n \\"ResourceGroupId\\": \\"rg-aekzecovzti****\\",\\n \\"DatabaseType\\": \\"MySQL\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 30\\n 4F1888AC-1138-4995-B9FE-D2734F61C058\\n 0\\n 200\\n 1\\n \\n \\n dbXXXXX7ltj\\n logical\\n 1583000\\n MONDAY\\n [ { \\"DBName\\":\\"Database name to be backed up\\", \\"SchemaName\\":\\"Schema name to be backed up\\", \\"TableIncludes\\":[{ \\"TableName\\":\\"Table name of the table to be backed up\\" }], \\"TableExcludes\\":[{ \\"TableName\\":\\"The name of the database to be backed up does not need the name of the table to be backed up\\" }] } ]\\n rm-bp1p8XXXXXv8pxe\\n medium\\n cn-hangzhou\\n cn-hangzhou\\n 100.X.X.10:33204\\n 365\\n dbs-backup-1857XXXXX489\\n init\\n 14:22\\n true\\n dbXXXXXx7ltj\\n 730\\n rds\\n test\\n 180\\n \\n \\n 1\\n true\\n","errorExample":""}]', + ], + 'DescribeBackupSetDownloadTaskList' => [ + 'summary' => '该接口用于查看DBS备份集下载列表。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREcbsKR7J6S', + ], + ], + 'parameters' => [ + [ + 'name' => 'BackupPlanId', + 'in' => 'query', + 'schema' => [ + 'description' => '备份计划ID，可通过调用[DescribeBackupPlanList](~~2869825~~)接口获取该参数的值。'."\n" + ."\n" + .'> **BackupPlanId**或**BackupSetDownloadTaskId**任选其一作为请求参数必填项。', + 'type' => 'string', + 'required' => false, + 'example' => 'dbsqhnuhyw3****', + ], + ], + [ + 'name' => 'BackupSetDownloadTaskId', + 'in' => 'query', + 'schema' => [ + 'description' => '备份集下载任务ID。'."\n" + ."\n" + .'- 全量备份：可通过调用[CreateFullBackupSetDownload](~~2869842~~)接口获取该参数的值。'."\n" + .'- 增量备份：可通过调用[CreateIncrementBackupSetDownload](~~2869843~~)接口获取该参数的值。', + 'type' => 'string', + 'required' => false, + 'example' => 'urxgrxt7****', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页的记录数，取值30、50、100。'."\n" + ."\n" + .'> 默认每页记录数为30。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '30', + ], + ], + [ + 'name' => 'PageNum', + 'in' => 'query', + 'schema' => [ + 'description' => '页码，大于等于0且不超过Integer的最大值，默认值为0。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => '输入任意值，用于保证请求的幂等性，防止重复提交请求。', + 'type' => 'string', + 'required' => false, + 'example' => 'ETnLKlblzczshOTUbOCzXXXXXX', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回参数详情信息。', + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'HTTP状态码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'PageNum' => [ + 'description' => '页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '6DC3D286-E0E6-5988-A558-2184984B****', + ], + 'ErrCode' => [ + 'description' => '错误码。', + 'type' => 'string', + 'example' => 'Param.NotFound', + ], + 'Success' => [ + 'description' => '请求是否成功，返回值如下：'."\n" + .'- **true**：请求成功'."\n" + .'- **false**：请求失败', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ErrMessage' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'The specified parameter %s value is not valid.', + ], + 'TotalPages' => [ + 'description' => '总页数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'TotalElements' => [ + 'description' => '总备份集下载记录数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '每页的记录数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '30', + ], + 'Items' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'BackupSetDownloadTaskDetail' => [ + 'description' => '备份计划详情。', + 'type' => 'array', + 'items' => [ + 'description' => '备份计划详情。', + 'type' => 'object', + 'properties' => [ + 'BackupSetDownloadStatus' => [ + 'description' => '备份集下载状态，返回值如下：'."\n" + ."\n" + .'- **checking**：预检查中'."\n" + .'- **init**：预检查失败（未启动）'."\n" + .'- **check_pass**：预检查通过'."\n" + .'- **pause**：暂停'."\n" + .'- **schedule**：等待调度'."\n" + .'- **running**：运行中'."\n" + .'- **stop**：失败'."\n" + .'- **finish**：完成', + 'type' => 'string', + 'example' => 'finish', + ], + 'BackupSetDataSize' => [ + 'description' => '备份集数据大小。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '237837', + ], + 'BackupSetDownloadTargetType' => [ + 'description' => '备份集下载目标类型。'."\n" + ."\n" + .'> 仅自动下载显示，agent表示已安装备份网关。', + 'type' => 'string', + 'example' => '无', + ], + 'BackupSetDownloadDir' => [ + 'description' => '备份集下载服务器目录。'."\n" + ."\n" + .'> 仅自动下载有值。', + 'type' => 'string', + 'example' => '无', + ], + 'ErrMessage' => [ + 'description' => '异常信息。', + 'type' => 'string', + 'example' => 'java.lang.IndexOutOfBoundsException.', + ], + 'BackupSetDownloadCreateTime' => [ + 'description' => '创建时间戳。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1642044001000', + ], + 'BackupPlanId' => [ + 'description' => '备份计划ID。', + 'type' => 'string', + 'example' => 'qhnuhyw3****', + ], + 'BackupSetDbType' => [ + 'description' => '数据库类型。', + 'type' => 'string', + 'example' => 'MySQL', + ], + 'BackupSetDownloadInternetUrl' => [ + 'description' => '备份集公网下载地址。'."\n" + ."\n" + .'> 仅手工下载类型，且转换完成的有值。', + 'type' => 'string', + 'example' => '"//dbs-137XXXX-cn-hangzhou-1hr5cpbtmXXXX.oss-cn-hangzhou.example"', + ], + 'BackupSetId' => [ + 'description' => '源备份集ID。', + 'type' => 'string', + 'example' => '1h7za2yws****', + ], + 'BackupSetDownloadIntranetUrl' => [ + 'description' => '备份集内网下载地址。'."\n" + ."\n" + .'> 仅手工下载类型，且转换完成的有值。', + 'type' => 'string', + 'example' => '"//dbs-13XXXX-cn-hangzhou-1hr5cpbtmXXXX.oss-cn-hangzhou-internal.example"', + ], + 'BackupGatewayId' => [ + 'description' => '备份集备份网关，仅自动下载有值。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '无', + ], + 'BackupSetDownloadWay' => [ + 'description' => '下载类型，返回值如下：'."\n" + ."\n" + .'- **manual**：手工'."\n" + .'- **auto**：自动', + 'type' => 'string', + 'example' => 'manual', + ], + 'BackupSetDownloadFinishTime' => [ + 'description' => '完成时间戳。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1642044013000', + ], + 'BackupSetJobType' => [ + 'description' => '源备份集任务类型，返回值如下：'."\n" + ."\n" + .'- **cbs_backup_sub_full**：逻辑全量任务'."\n" + .'- **cbs_backup_sub_cont**：逻辑增量任务', + 'type' => 'string', + 'example' => 'cbs_backup_sub_cont', + ], + 'BackupSetDownloadTaskId' => [ + 'description' => '备份集下载任务ID。', + 'type' => 'string', + 'example' => 'urxgrxt7****', + ], + 'BackupSetDownloadTaskName' => [ + 'description' => '备份集下载任务名称。', + 'type' => 'string', + 'example' => '1h7za2yws****-ManualCont', + ], + 'BackupSetDataFormat' => [ + 'description' => '备份集下载数据格式，取值如下：'."\n" + ."\n" + .'- **Native**'."\n" + .'- **SQL**'."\n" + .'- **CSV** '."\n" + .'- **JSON**', + 'type' => 'string', + 'example' => 'Native', + ], + 'BackupSetCode' => [ + 'description' => '源备份集编码。', + 'type' => 'string', + 'example' => 'mysql-bin.00XXXX', + ], + ], + ], + ], + ], + 'description' => '', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'Request.Forbidden', + 'errorMessage' => 'Have no Permissions', + 'description' => '当前操作未被授权，请联系主账号在RAM控制台进行授权后再执行操作', + ], + ], + ], + 'title' => '查看备份集下载列表', + 'changeSet' => [ + [ + 'createdAt' => '2022-07-12T03:53:58.000Z', + 'description' => '错误码发生变更', + ], + ], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '100', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'DescribeBackupSetDownloadTaskList', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dbs:DescribeBackupSetDownloadTaskList', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DBS', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"PageNum\\": 0,\\n \\"RequestId\\": \\"6DC3D286-E0E6-5988-A558-2184984B****\\",\\n \\"ErrCode\\": \\"Param.NotFound\\",\\n \\"Success\\": true,\\n \\"ErrMessage\\": \\"The specified parameter %s value is not valid.\\",\\n \\"TotalPages\\": 1,\\n \\"TotalElements\\": 1,\\n \\"PageSize\\": 30,\\n \\"Items\\": {\\n \\"BackupSetDownloadTaskDetail\\": [\\n {\\n \\"BackupSetDownloadStatus\\": \\"finish\\",\\n \\"BackupSetDataSize\\": 237837,\\n \\"BackupSetDownloadTargetType\\": \\"无\\",\\n \\"BackupSetDownloadDir\\": \\"无\\",\\n \\"ErrMessage\\": \\"java.lang.IndexOutOfBoundsException.\\",\\n \\"BackupSetDownloadCreateTime\\": 1642044001000,\\n \\"BackupPlanId\\": \\"qhnuhyw3****\\",\\n \\"BackupSetDbType\\": \\"MySQL\\",\\n \\"BackupSetDownloadInternetUrl\\": \\"\\\\\\"//dbs-137XXXX-cn-hangzhou-1hr5cpbtmXXXX.oss-cn-hangzhou.example\\\\\\"\\",\\n \\"BackupSetId\\": \\"1h7za2yws****\\",\\n \\"BackupSetDownloadIntranetUrl\\": \\"\\\\\\"//dbs-13XXXX-cn-hangzhou-1hr5cpbtmXXXX.oss-cn-hangzhou-internal.example\\\\\\"\\",\\n \\"BackupGatewayId\\": 0,\\n \\"BackupSetDownloadWay\\": \\"manual\\",\\n \\"BackupSetDownloadFinishTime\\": 1642044013000,\\n \\"BackupSetJobType\\": \\"cbs_backup_sub_cont\\",\\n \\"BackupSetDownloadTaskId\\": \\"urxgrxt7****\\",\\n \\"BackupSetDownloadTaskName\\": \\"1h7za2yws****-ManualCont\\",\\n \\"BackupSetDataFormat\\": \\"Native\\",\\n \\"BackupSetCode\\": \\"mysql-bin.00XXXX\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 6DC3D286-E0E6-5988-A558-2184984B****\\n 30\\n 0\\n 200\\n 1\\n 1\\n \\n \\n MySQL\\n 1642044001000\\n 1h7za2yws****-ManualCont\\n manual\\n mysql-bin.00XXXX\\n 1h7za2yws****\\n finish\\n //dbs-13XXXX-cn-hangzhou-1hr5cpbtmXXXX.oss-cn-hangzhou-internal.example\\n //dbs-137XXXX-cn-hangzhou-1hr5cpbtmXXXX.oss-cn-hangzhou.example\\n urxgrxt7****\\n 1642044013000\\n cbs_backup_sub_cont\\n Native\\n qhnuhyw3****\\n 237837\\n \\n \\n true\\n","errorExample":""}]', + ], + 'DescribeDLAService' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREcbsKR7J6S', + ], + ], + 'parameters' => [ + [ + 'name' => 'BackupPlanId', + 'in' => 'query', + 'schema' => [ + 'description' => '备份计划ID，您可以调用[DescribeBackupPlanList](~~2869825~~)查询。', + 'type' => 'string', + 'required' => true, + 'example' => 'dbstooi01exXXXX', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => '任意字符串。', + 'type' => 'string', + 'required' => false, + 'example' => 'DBS', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'HTTP状态码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '4F1888AC-1138-4995-B9FE-D2734F61C058', + ], + 'ErrCode' => [ + 'description' => '错误码。', + 'type' => 'string', + 'example' => 'Param.NotFound', + ], + 'Success' => [ + 'description' => '是否请求成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'State' => [ + 'description' => '备份计划的DLA服务状态， 取值：'."\n" + .'- **Running**：运行中'."\n" + .'- **Closing**：关闭中'."\n" + .'- **Closed**：已关闭', + 'type' => 'string', + 'example' => 'Running', + ], + 'ErrMessage' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'The specified parameter %s value is not valid.', + ], + 'AutoAdd' => [ + 'description' => '是否开启增量数据自动入湖，开启后，系统会自动将新产生的备份集添加入湖，取值：'."\n" + .'- **true**：开启'."\n" + .'- **false**：不开启', + 'type' => 'boolean', + 'example' => 'true', + ], + 'HaveJobFailed' => [ + 'description' => '返回结果中是否存在失败的DLA任务，取值：'."\n" + .'- **true**：存在'."\n" + .'- **false**：不存在', + 'type' => 'boolean', + 'example' => 'false', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'Request.Forbidden', + 'errorMessage' => 'Have no Permissions', + 'description' => '当前操作未被授权，请联系主账号在RAM控制台进行授权后再执行操作', + ], + ], + ], + 'title' => '查看数据查询服务（DLA）', + 'summary' => '该接口用于查看备份计划的数据查询服务（DLA）。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + [ + 'createdAt' => '2022-07-12T03:53:58.000Z', + 'description' => '错误码发生变更', + ], + ], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '10', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'DescribeDLAService', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dbs:DescribeDLAService', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DBS', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"4F1888AC-1138-4995-B9FE-D2734F61C058\\",\\n \\"ErrCode\\": \\"Param.NotFound\\",\\n \\"Success\\": true,\\n \\"State\\": \\"Running\\",\\n \\"ErrMessage\\": \\"The specified parameter %s value is not valid.\\",\\n \\"AutoAdd\\": true,\\n \\"HaveJobFailed\\": false\\n}","errorExample":""},{"type":"xml","example":"\\n false\\n 6158A77E-AD6F-4C8F-BC0C-C8E1ABF836F3\\n false\\n Closed\\n 200\\n true\\n","errorExample":""}]', + ], + 'DescribeFullBackupList' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREcbsKR7J6S', + ], + ], + 'parameters' => [ + [ + 'name' => 'BackupPlanId', + 'in' => 'query', + 'schema' => [ + 'description' => '备份计划ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'dbsr179qz******', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页的记录数，取值：'."\n" + .'- 30'."\n" + .'- 50'."\n" + .'- 100'."\n" + ."\n" + .'默认为30。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '30', + ], + ], + [ + 'name' => 'PageNum', + 'in' => 'query', + 'schema' => [ + 'description' => '页码，大于等于0且不超过Integer的最大值，默认值为：0。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => '用于保证请求的幂等性，防止重复提交请求。', + 'type' => 'string', + 'required' => false, + 'example' => 'ETnLKlblzczshOTUbOCzxxxxxxx', + ], + ], + [ + 'name' => 'ShowStorageType', + 'in' => 'query', + 'schema' => [ + 'description' => '是否显示存储类型。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'BackupSetId', + 'in' => 'query', + 'schema' => [ + 'description' => '备份集ID。', + 'type' => 'string', + 'required' => false, + 'example' => '1iukx5h******', + ], + ], + [ + 'name' => 'StartTimestamp', + 'in' => 'query', + 'schema' => [ + 'description' => '开始备份时间。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1676887100', + ], + ], + [ + 'name' => 'EndTimestamp', + 'in' => 'query', + 'schema' => [ + 'description' => '结束备份时间。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1676887128', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回参数详情如下。', + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'HTTP状态码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'PageNum' => [ + 'description' => '页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '636BC118-6080-4119-A6B5-C199CEC1037D', + ], + 'ErrCode' => [ + 'description' => '错误码。'."\n", + 'type' => 'string', + 'example' => 'Param.NotFound', + ], + 'Success' => [ + 'description' => '是否执行成功。返回值：'."\n" + .'- **true**：执行成功。'."\n" + .'- **false**：执行失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ErrMessage' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'The specified parameter %s value is not valid. ', + ], + 'TotalPages' => [ + 'description' => '总页数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'TotalElements' => [ + 'description' => '总全量备份任务数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '每页的记录数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'Items' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'FullBackupFile' => [ + 'description' => '全量备份任务详情。', + 'type' => 'array', + 'items' => [ + 'description' => '全量备份任务详情。', + 'type' => 'object', + 'properties' => [ + 'FinishTime' => [ + 'description' => '任务结束时间戳。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1676887128000', + ], + 'BackupStatus' => [ + 'description' => '备份任务状态，取值：'."\n" + .'- schedule：初始化中'."\n" + .'- running：运行中'."\n" + .'- finish：完成'."\n" + .'- stop：失败'."\n" + .'- pause：暂停', + 'type' => 'string', + 'example' => 'finish', + ], + 'SourceEndpointIpPort' => [ + 'description' => '数据库连接地址。', + 'type' => 'string', + 'example' => '121.XXX.XXX.144:3306', + ], + 'CreateTime' => [ + 'description' => '任务开始时间戳。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1676886947000', + ], + 'ErrMessage' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'NULL', + ], + 'BackupObjects' => [ + 'description' => '备份对象。', + 'type' => 'string', + 'example' => '[{\\"DBName\\":\\"test\\"}]', + ], + 'EndTime' => [ + 'description' => '备份结束时间戳。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1676887128000', + ], + 'StartTime' => [ + 'description' => '备份开始时间。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1676887100000', + ], + 'BackupSetExpiredTime' => [ + 'description' => '备份集保留到期时间戳。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1677491900000', + ], + 'StorageMethod' => [ + 'description' => '存储类型，取值：'."\n" + .'- Standard：标准存储'."\n" + .'- IA：低频访问存储'."\n" + .'- Archive：归档存储'."\n" + .'- UNKNOWN：未知，通常是任务未完成时的状态', + 'type' => 'string', + 'example' => 'Standard', + ], + 'BackupSetId' => [ + 'description' => '备份集ID。', + 'type' => 'string', + 'example' => '1iukx5h******', + ], + 'BackupSize' => [ + 'description' => '备份大小。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '580', + ], + ], + ], + ], + ], + 'description' => '', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'Request.Forbidden', + 'errorMessage' => 'Have no Permissions', + 'description' => '当前操作未被授权，请联系主账号在RAM控制台进行授权后再执行操作', + ], + ], + ], + 'title' => '查看全量备份任务列表', + 'summary' => '该接口用于查看DBS全量备份任务列表。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + [ + 'createdAt' => '2022-07-12T03:53:58.000Z', + 'description' => '错误码发生变更', + ], + ], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '100', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'DescribeFullBackupList', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dbs:DescribeFullBackupList', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DBS', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"PageNum\\": 1,\\n \\"RequestId\\": \\"636BC118-6080-4119-A6B5-C199CEC1037D\\",\\n \\"ErrCode\\": \\"Param.NotFound\\",\\n \\"Success\\": true,\\n \\"ErrMessage\\": \\"The specified parameter %s value is not valid. \\",\\n \\"TotalPages\\": 1,\\n \\"TotalElements\\": 1,\\n \\"PageSize\\": 10,\\n \\"Items\\": {\\n \\"FullBackupFile\\": [\\n {\\n \\"FinishTime\\": 1676887128000,\\n \\"BackupStatus\\": \\"finish\\",\\n \\"SourceEndpointIpPort\\": \\"121.XXX.XXX.144:3306\\",\\n \\"CreateTime\\": 1676886947000,\\n \\"ErrMessage\\": \\"NULL\\",\\n \\"BackupObjects\\": \\"[{\\\\\\\\\\\\\\"DBName\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"test\\\\\\\\\\\\\\"}]\\",\\n \\"EndTime\\": 1676887128000,\\n \\"StartTime\\": 1676887100000,\\n \\"BackupSetExpiredTime\\": 1677491900000,\\n \\"StorageMethod\\": \\"Standard\\",\\n \\"BackupSetId\\": \\"1iukx5h******\\",\\n \\"BackupSize\\": 580\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n636BC118-6080-4119-A6B5-C199CEC1037D\\n30\\n0\\n200\\n1\\n1\\n\\n \\n 100.X.X.10:33204\\n Standard\\n [{\\"DBName\\":\\"test_y\\"}]\\n 1583741465000\\n 1583741466000\\n 151\\n 1583740896000\\n 1583741439000\\n 1646813439000\\n 1ibh2XXXXXXX\\n finish\\n \\n\\ntrue\\n","errorExample":""}]', + ], + 'DescribeIncrementBackupList' => [ + 'summary' => '该接口用于查看DBS增量备份任务列表。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREcbsKR7J6S', + ], + ], + 'parameters' => [ + [ + 'name' => 'BackupPlanId', + 'in' => 'query', + 'schema' => [ + 'description' => '备份计划ID，可通过调用[DescribeBackupPlanList](~~2869825~~)接口获取该参数的值。', + 'type' => 'string', + 'required' => true, + 'example' => 'dbsqdss5tmh****', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页的记录数，取值30、50、100。'."\n" + ."\n" + .'> 默认每页记录数为30。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '30', + ], + ], + [ + 'name' => 'PageNum', + 'in' => 'query', + 'schema' => [ + 'description' => '页码，大于等于0且不超过Integer的最大值，默认值为0。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => '任意字符串，用于保证请求的幂等性，防止重复提交请求。', + 'type' => 'string', + 'required' => false, + 'example' => 'ETnLKlblzczshOTUbOCzxxxxxxx', + ], + ], + [ + 'name' => 'ShowStorageType', + 'in' => 'query', + 'schema' => [ + 'description' => '是否显示存储类型，取值如下：'."\n" + ."\n" + .'- true'."\n" + .'- false'."\n" + ."\n" + .'> 默认true。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'StartTimestamp', + 'in' => 'query', + 'schema' => [ + 'description' => '开始备份时间戳。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1570701361528', + ], + ], + [ + 'name' => 'EndTimestamp', + 'in' => 'query', + 'schema' => [ + 'description' => '结束备份时间戳。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1570701361600', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'HTTP状态码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'PageNum' => [ + 'description' => '页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'A5D52069-E8AA-5056-8C5C-654C3610****', + ], + 'ErrCode' => [ + 'description' => '错误码。'."\n", + 'type' => 'string', + 'example' => 'Param.NotFound', + ], + 'Success' => [ + 'description' => '请求是否成功，返回值如下：'."\n" + .'- **true**：请求成功'."\n" + .'- **false**：请求失败', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ErrMessage' => [ + 'description' => '错误信息。'."\n", + 'type' => 'string', + 'example' => 'The specified parameter %s value is not valid. ', + ], + 'TotalPages' => [ + 'description' => '总页数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'TotalElements' => [ + 'description' => '增量备份任务总数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '每页的记录数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '30', + ], + 'Items' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'IncrementBackupFile' => [ + 'description' => '增量备份任务详情。', + 'type' => 'array', + 'items' => [ + 'description' => '增量备份任务详情信息如下。', + 'type' => 'object', + 'properties' => [ + 'EndTime' => [ + 'description' => '备份结束时间戳。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1648434713000', + ], + 'BackupSetExpiredTime' => [ + 'description' => '备份集保留到期时间戳。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1711506719000', + ], + 'StartTime' => [ + 'description' => '备份开始时间戳。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1648433764000', + ], + 'StorageMethod' => [ + 'description' => '存储类型，返回值如下：'."\n" + ."\n" + .'- **Standard**：标准存储'."\n" + .'- **IA**：低频访问存储'."\n" + .'- **Archive**：归档存储'."\n" + .'- **UNKNOWN**：未知，通常是任务未完成时的状态', + 'type' => 'string', + 'example' => 'Standard', + ], + 'BackupSetJobId' => [ + 'description' => '备份集任务ID。', + 'type' => 'string', + 'example' => '1hv5g9wk4****', + ], + 'BackupSetId' => [ + 'description' => '备份集ID。', + 'type' => 'string', + 'example' => 'mysql-bin.00****', + ], + 'BackupStatus' => [ + 'description' => '备份任务状态，返回值如下：'."\n" + ."\n" + .'- **INIT**：未启动'."\n" + .'- **FILLING**：备份中'."\n" + .'- **COMPLETED**：完成'."\n" + .'- **UNCOMPLETED**：未完成', + 'type' => 'string', + 'example' => 'FILLING', + ], + 'SourceEndpointIpPort' => [ + 'description' => '数据库连接地址。', + 'type' => 'string', + 'example' => '172.1XX.103.1:4XXX', + ], + 'BackupSize' => [ + 'description' => '备份大小。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '18535', + ], + ], + ], + ], + ], + 'description' => '', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'Request.Forbidden', + 'errorMessage' => 'Have no Permissions', + 'description' => '当前操作未被授权，请联系主账号在RAM控制台进行授权后再执行操作', + ], + ], + ], + 'title' => '查看增量备份任务列表', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + [ + 'createdAt' => '2022-07-12T03:53:58.000Z', + 'description' => '错误码发生变更', + ], + ], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '100', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'DescribeIncrementBackupList', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dbs:DescribeIncrementBackupList', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DBS', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"PageNum\\": 0,\\n \\"RequestId\\": \\"A5D52069-E8AA-5056-8C5C-654C3610****\\",\\n \\"ErrCode\\": \\"Param.NotFound\\",\\n \\"Success\\": true,\\n \\"ErrMessage\\": \\"The specified parameter %s value is not valid. \\",\\n \\"TotalPages\\": 1,\\n \\"TotalElements\\": 1,\\n \\"PageSize\\": 30,\\n \\"Items\\": {\\n \\"IncrementBackupFile\\": [\\n {\\n \\"EndTime\\": 1648434713000,\\n \\"BackupSetExpiredTime\\": 1711506719000,\\n \\"StartTime\\": 1648433764000,\\n \\"StorageMethod\\": \\"Standard\\",\\n \\"BackupSetJobId\\": \\"1hv5g9wk4****\\",\\n \\"BackupSetId\\": \\"mysql-bin.00****\\",\\n \\"BackupStatus\\": \\"FILLING\\",\\n \\"SourceEndpointIpPort\\": \\"172.1XX.103.1:4XXX\\",\\n \\"BackupSize\\": 18535\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n A5D52069-E8AA-5056-8C5C-654C3610****\\n 30\\n 0\\n 200\\n 1\\n 1\\n \\n \\n 172.1XX.103.1:4XXX\\n 1648434713000\\n 1hv5g9wk4****\\n 18535\\n 1648433764000\\n 1711506719000\\n mysql-bin.00****\\n FILLING\\n \\n \\n true\\n","errorExample":""}]', + ], + 'DescribeJobErrorCode' => [ + 'summary' => '该接口用于查看DBS任务错误码信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREcbsKR7J6S', + ], + ], + 'parameters' => [ + [ + 'name' => 'TaskId', + 'in' => 'query', + 'schema' => [ + 'description' => '全量备份或恢复任务ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'r1iv62ud****', + ], + ], + [ + 'name' => 'Language', + 'in' => 'query', + 'schema' => [ + 'description' => '错误信息语言，取值如下：'."\n" + ."\n" + .'- **en**：英文（默认值）'."\n" + .'- **cn**：中文', + 'type' => 'string', + 'required' => false, + 'example' => 'en', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => '用于保证请求的幂等性，防止重复提交请求。 '."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'ETnLKlblzczshOTUbOCz****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'HTTP状态码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'RequestId' => [ + 'description' => '请求ID.', + 'type' => 'string', + 'example' => '1FC2F86D-AFF4-4ED9-BB25-ADDE196CB2B5', + ], + 'ErrCode' => [ + 'description' => '错误码。'."\n", + 'type' => 'string', + 'example' => 'Param.NotFound', + ], + 'Success' => [ + 'description' => '是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ErrMessage' => [ + 'description' => '错误信息。'."\n", + 'type' => 'string', + 'example' => 'The specified parameter %s value is not valid. ', + ], + 'Item' => [ + 'description' => '错误码信息。', + 'type' => 'object', + 'properties' => [ + 'JobState' => [ + 'description' => '任务状态。', + 'type' => 'string', + 'example' => 'init', + ], + 'ErrorMessage' => [ + 'description' => '标准化错误信息。', + 'type' => 'string', + 'example' => 'Describe preCheck progress failed.', + ], + 'ErrorCode' => [ + 'description' => '错误码。', + 'type' => 'string', + 'example' => 'failed', + ], + 'JobId' => [ + 'description' => '全量备份或者恢复任务ID。', + 'type' => 'string', + 'example' => 'r1iv62ud****', + ], + 'JobType' => [ + 'description' => 'DBS内部任务类型id。', + 'type' => 'string', + 'example' => 'testId', + ], + 'Language' => [ + 'description' => '错误信息语言。', + 'type' => 'string', + 'example' => 'en', + ], + ], + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'Request.Forbidden', + 'errorMessage' => 'Have no Permissions', + 'description' => '当前操作未被授权，请联系主账号在RAM控制台进行授权后再执行操作', + ], + ], + ], + 'title' => '查看任务错误码信息', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + [ + 'createdAt' => '2022-07-12T03:53:58.000Z', + 'description' => '错误码发生变更', + ], + ], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '10', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'DescribeJobErrorCode', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dbs:DescribeJobErrorCode', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DBS', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"1FC2F86D-AFF4-4ED9-BB25-ADDE196CB2B5\\",\\n \\"ErrCode\\": \\"Param.NotFound\\",\\n \\"Success\\": true,\\n \\"ErrMessage\\": \\"The specified parameter %s value is not valid. \\",\\n \\"Item\\": {\\n \\"JobState\\": \\"init\\",\\n \\"ErrorMessage\\": \\"Describe preCheck progress failed.\\",\\n \\"ErrorCode\\": \\"failed\\",\\n \\"JobId\\": \\"r1iv62ud****\\",\\n \\"JobType\\": \\"testId\\",\\n \\"Language\\": \\"en\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n\\n en\\n tooi0XXXX\\n\\n1FC2F86D-AFF4-4ED9-BB25-ADDE196CB2B5\\n200\\ntrue\\n","errorExample":""}]', + ], + 'DescribeNodeCidrList' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREcbsKR7J6S', + ], + ], + 'parameters' => [ + [ + 'name' => 'Region', + 'in' => 'query', + 'schema' => [ + 'description' => 'DBS地域，可通过调用[DescribeRegions](~~2869853~~)接口查看DBS支持地域。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => '用于保证请求的幂等性，防止重复提交请求。 '."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'ETnLKlblzczshOTUbOCzxxxxxxx', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'HTTP状态码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '5B352E69-E7B1-4EA7-BB8E-29FFE969C791', + ], + 'ErrCode' => [ + 'description' => '错误码。'."\n", + 'type' => 'string', + 'example' => 'Param.NotFound', + ], + 'Success' => [ + 'description' => '是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ErrMessage' => [ + 'description' => '错误信息。'."\n", + 'type' => 'string', + 'example' => 'The specified parameter %s value is not valid. ', + ], + 'IntranetIPs' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'IntranetIP' => [ + 'description' => '内网网段列表。', + 'type' => 'array', + 'items' => [ + 'description' => '内网网段。', + 'type' => 'string', + 'example' => '"10.X.X.0/24"', + ], + ], + ], + 'description' => '', + ], + 'InternetIPs' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'InternetIP' => [ + 'description' => '公网网段列表。', + 'type' => 'array', + 'items' => [ + 'description' => '公网网段。', + 'type' => 'string', + 'example' => '"10.X.X.0/24"', + ], + ], + ], + 'description' => '', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'Request.Forbidden', + 'errorMessage' => 'Have no Permissions', + 'description' => '当前操作未被授权，请联系主账号在RAM控制台进行授权后再执行操作', + ], + ], + ], + 'title' => '查看DBS运行节点网段', + 'summary' => '该接口用于查看DBS运行节点网段列表。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + [ + 'createdAt' => '2022-07-12T03:53:58.000Z', + 'description' => '错误码发生变更', + ], + ], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '100', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'DescribeNodeCidrList', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dbs:DescribeNodeCidrList', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DBS', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"5B352E69-E7B1-4EA7-BB8E-29FFE969C791\\",\\n \\"ErrCode\\": \\"Param.NotFound\\",\\n \\"Success\\": true,\\n \\"ErrMessage\\": \\"The specified parameter %s value is not valid. \\",\\n \\"IntranetIPs\\": {\\n \\"IntranetIP\\": [\\n \\"\\\\\\"10.X.X.0/24\\\\\\"\\"\\n ]\\n },\\n \\"InternetIPs\\": {\\n \\"InternetIP\\": [\\n \\"\\\\\\"10.X.X.0/24\\\\\\"\\"\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"5B352E69-E7B1-4EA7-BB8E-29FFE969C791\\n\\n 118.X.X.0/24\\n 47.X.X.0/24\\n\\n200\\n\\n 10.X.X.0/24\\n 10.X.X.0/24\\n 10.X.X.0/24\\n\\ntrue","errorExample":""}]', + ], + 'DescribePreCheckProgressList' => [ + 'summary' => '该接口用于查看备份计划预检查进度和恢复任务预检查进度。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREcbsKR7J6S', + ], + ], + 'parameters' => [ + [ + 'name' => 'BackupPlanId', + 'in' => 'query', + 'schema' => [ + 'description' => '备份计划ID。'."\n" + ."\n" + .'> 请填入BackupPlanId或RestoreTaskId。', + 'type' => 'string', + 'required' => false, + 'example' => 'dbsr1l3ro21****', + ], + ], + [ + 'name' => 'RestoreTaskId', + 'in' => 'query', + 'schema' => [ + 'description' => '恢复任务ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'dbasdsa****', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => '用于保证请求的幂等性，防止重复提交请求。 '."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'ETnLKlblzczshOTUbOCziJZNwH****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回参数详情如下。', + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => '预检查状态，返回值如下：'."\n" + .'- **running**：运行中'."\n" + .'- **failed**：失败'."\n" + .'- **finish**：完成', + 'type' => 'string', + 'example' => 'finish', + ], + 'HttpStatusCode' => [ + 'description' => 'HTTP状态码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'C4A45FE1-A903-470D-B113-F12A4DF942AB', + ], + 'Progress' => [ + 'description' => '预检查进度，返回值范围：0~100。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + ], + 'ErrCode' => [ + 'description' => '错误码。'."\n", + 'type' => 'string', + 'example' => 'Param.NotFound', + ], + 'Success' => [ + 'description' => '返回是否成功，返回值如下：'."\n" + ."\n" + .'- **true**：返回成功'."\n" + .'- **false**：返回失败', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ErrMessage' => [ + 'description' => '错误信息。'."\n", + 'type' => 'string', + 'example' => 'The specified parameter %s value is not valid. ', + ], + 'Items' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'PreCheckProgressDetail' => [ + 'description' => '进度明细列表。', + 'type' => 'array', + 'items' => [ + 'description' => '返回参数。', + 'type' => 'object', + 'properties' => [ + 'FinishTime' => [ + 'description' => '完成时间，格式为Unix时间戳。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1704351396000', + ], + 'State' => [ + 'description' => '进度状态，返回值如下：'."\n" + .'- **init**：初始化'."\n" + .'- **warning**：警告'."\n" + .'- **catched**：异常'."\n" + .'- **running**：运行中'."\n" + .'- **failed**：失败'."\n" + .'- **finish**：完成', + 'type' => 'string', + 'example' => 'warning', + ], + 'BootTime' => [ + 'description' => '启动时间，格式为Unix时间戳。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1704351395000', + ], + 'JobId' => [ + 'description' => '进度ID。', + 'type' => 'string', + 'example' => 'qxwmxh2b****', + ], + 'Item' => [ + 'description' => '检查项编码。', + 'type' => 'string', + 'example' => 'CHECK_BINLOG_ON', + ], + 'ErrMsg' => [ + 'description' => '异常信息。', + 'type' => 'string', + 'example' => 'java.lang.RuntimeException: Could not find any schema ......', + ], + 'OrderNum' => [ + 'description' => '序号。', + 'type' => 'string', + 'example' => '30', + ], + 'Names' => [ + 'description' => '检查项分组。', + 'type' => 'string', + 'example' => 'CHECK_BINLOG_ON_DETAIL', + ], + ], + ], + ], + ], + 'description' => '', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'Request.Forbidden', + 'errorMessage' => 'Have no Permissions', + 'description' => '当前操作未被授权，请联系主账号在RAM控制台进行授权后再执行操作', + ], + ], + ], + 'title' => '查看预检查进度列表', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + [ + 'createdAt' => '2022-07-12T03:53:58.000Z', + 'description' => '错误码发生变更', + ], + ], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '100', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'DescribePreCheckProgressList', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dbs:DescribePreCheckProgressList', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DBS', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Status\\": \\"finish\\",\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"C4A45FE1-A903-470D-B113-F12A4DF942AB\\",\\n \\"Progress\\": 100,\\n \\"ErrCode\\": \\"Param.NotFound\\",\\n \\"Success\\": true,\\n \\"ErrMessage\\": \\"The specified parameter %s value is not valid. \\",\\n \\"Items\\": {\\n \\"PreCheckProgressDetail\\": [\\n {\\n \\"FinishTime\\": 1704351396000,\\n \\"State\\": \\"warning\\",\\n \\"BootTime\\": 1704351395000,\\n \\"JobId\\": \\"qxwmxh2b****\\",\\n \\"Item\\": \\"CHECK_BINLOG_ON\\",\\n \\"ErrMsg\\": \\"java.lang.RuntimeException: Could not find any schema ......\\",\\n \\"OrderNum\\": \\"30\\",\\n \\"Names\\": \\"CHECK_BINLOG_ON_DETAIL\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\nfailed\\n20\\nC4A45FE1-A903-470D-B113-F12A4DF942AB\\n200\\n\\n \\n CHECK_MYSQL_PASSOWRD_FORMAT_DETAIL\\n CHECK_MYSQL_PASSOWRD_FORMAT\\n 90\\n init\\n 1583734969000\\n uvk8f6fxnq5s\\n \\n\\njava.lang.RuntimeException: Could not find any schema ......\\ntrue\\n\\n\\n","errorExample":""}]', + ], + 'DescribeRegions' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREcbsKR7J6S', + ], + ], + 'parameters' => [ + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => '用于保证请求的幂等性，防止重复提交请求。由客户端生成该参数值，要保证在不同请求间唯一，最大值不超过64个ASCII字符，且该参数值中不能包含非ASCII字符。', + 'type' => 'string', + 'required' => false, + 'example' => 'ETnLKlblzczshOTUbOCzxxxxxxxxxx', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回值参数详情如下。', + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => '错误码值。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '400', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'EB4DFD5E-3618-498D-BE35-4DBEA0072122', + ], + 'ErrCode' => [ + 'description' => '错误码字符串。'."\n", + 'type' => 'string', + 'example' => 'InvalidParameter', + ], + 'Success' => [ + 'description' => '请求状态。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ErrMessage' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'This backupPlan can\'t support this action', + ], + 'Regions' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'RegionCode' => [ + 'description' => '支持地域列表。', + 'type' => 'array', + 'items' => [ + 'description' => '支持地域列表。', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + ], + ], + 'description' => '', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'Request.Forbidden', + 'errorMessage' => 'Have no Permissions', + 'description' => '当前操作未被授权，请联系主账号在RAM控制台进行授权后再执行操作', + ], + ], + ], + 'title' => '查看DBS支持地域', + 'summary' => '该接口用于查看DBS支持地域。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + [ + 'createdAt' => '2022-07-12T03:53:58.000Z', + 'description' => '错误码发生变更', + ], + ], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '100', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'DescribeRegions', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dbs:DescribeRegions', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DBS', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 400,\\n \\"RequestId\\": \\"EB4DFD5E-3618-498D-BE35-4DBEA0072122\\",\\n \\"ErrCode\\": \\"InvalidParameter\\",\\n \\"Success\\": true,\\n \\"ErrMessage\\": \\"This backupPlan can\'t support this action\\",\\n \\"Regions\\": {\\n \\"RegionCode\\": [\\n \\"cn-hangzhou\\"\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n EB4DFD5E-3618-498D-BE35-4DBEA0072122\\n 400\\n \\n \\n \\n This backupPlan can\'t support this action\\n true\\n InvalidParameter\\n","errorExample":""}]', + ], + 'DescribeRestoreRangeInfo' => [ + 'summary' => '该接口用于查看一个备份计划可恢复时间段详情。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREcbsKR7J6S', + ], + ], + 'parameters' => [ + [ + 'name' => 'BackupPlanId', + 'in' => 'query', + 'schema' => [ + 'description' => '备份计划ID，可通过调用[DescribeBackupPlanList](~~2869825~~)接口获取该参数的值。', + 'type' => 'string', + 'required' => true, + 'example' => 'dbssl67c7mx****', + ], + ], + [ + 'name' => 'BeginTimestampForRestore', + 'in' => 'query', + 'schema' => [ + 'description' => '查询可恢复开始时间，可通过调用[DescribeBackupPlanList](~~2869825~~)接口获取该参数的值。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1646674092000', + ], + ], + [ + 'name' => 'EndTimestampForRestore', + 'in' => 'query', + 'schema' => [ + 'description' => '查询可恢复结束时间，可通过调用[DescribeBackupPlanList](~~2869825~~)接口获取该参数的值。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1646846814000', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => '用于保证请求的幂等性，防止重复提交请求。 '."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'ETnLKlblzczshOTUbOCzxxxxxxx', + ], + ], + [ + 'name' => 'RecentlyRestore', + 'in' => 'query', + 'schema' => [ + 'description' => '是否开启最近恢复。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '接口返回信息如下。', + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'HTTP状态码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'E2BD9DFC-6760-5F49-97C5-DA739E29****', + ], + 'ErrCode' => [ + 'description' => '错误码。', + 'type' => 'string', + 'example' => 'Param.NotFound', + ], + 'Success' => [ + 'description' => '请求是否成功，返回值如下：'."\n" + .'- **true**：请求成功'."\n" + .'- **false**：请求失败', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ErrMessage' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'The specified parameter %s value is not valid. ', + ], + 'Items' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'DBSRecoverRange' => [ + 'description' => '可恢复时间段信息。', + 'type' => 'array', + 'items' => [ + 'description' => '具体详情记录。', + 'type' => 'object', + 'properties' => [ + 'EndTimestampForRestore' => [ + 'description' => '可恢复结束时间戳。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1646760308000', + ], + 'SourceEndpointInstanceType' => [ + 'description' => '数据库所在位置。', + 'type' => 'string', + 'example' => 'rds', + ], + 'RangeType' => [ + 'description' => '可恢复时间段类型，返回值如下：'."\n" + .'- **point**：该时间段为全量备份离散时间点。'."\n" + .'- **range**：该时间段为连续备份时间段，可指定任意时间。', + 'type' => 'string', + 'example' => 'point', + ], + 'BeginTimestampForRestore' => [ + 'description' => '可恢复开始时间戳。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1646760282000', + ], + 'SourceEndpointInstanceID' => [ + 'description' => '数据库实例ID。', + 'type' => 'string', + 'example' => 'rm-bp106x9tk2c91****', + ], + 'FullBackupList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'FullBackupDetail' => [ + 'description' => '当RangeType为point时，该字段展示这个时间段范围内所有的权利。备份点信息。', + 'type' => 'array', + 'items' => [ + 'description' => '具体详情如下。', + 'type' => 'object', + 'properties' => [ + 'EndTime' => [ + 'description' => '全量备份结束时间，返回值：1646760308000。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1646760308000', + ], + 'StartTime' => [ + 'description' => '全量备份开始时间，返回值：1646760282000。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1646760282000', + ], + 'BackupSetId' => [ + 'description' => '备份集ID。', + 'type' => 'string', + 'example' => 'qecnsxkd****', + ], + ], + ], + ], + ], + 'description' => '', + ], + ], + ], + ], + ], + 'description' => '', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'Request.Forbidden', + 'errorMessage' => 'Have no Permissions', + 'description' => '当前操作未被授权，请联系主账号在RAM控制台进行授权后再执行操作', + ], + ], + ], + 'title' => '查看可恢复时间段详情', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + [ + 'createdAt' => '2022-07-12T03:53:45.000Z', + 'description' => '错误码发生变更', + ], + ], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '100', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'DescribeRestoreRangeInfo', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dbs:DescribeRestoreRangeInfo', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DBS', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"E2BD9DFC-6760-5F49-97C5-DA739E29****\\",\\n \\"ErrCode\\": \\"Param.NotFound\\",\\n \\"Success\\": true,\\n \\"ErrMessage\\": \\"The specified parameter %s value is not valid. \\",\\n \\"Items\\": {\\n \\"DBSRecoverRange\\": [\\n {\\n \\"EndTimestampForRestore\\": 1646760308000,\\n \\"SourceEndpointInstanceType\\": \\"rds\\",\\n \\"RangeType\\": \\"point\\",\\n \\"BeginTimestampForRestore\\": 1646760282000,\\n \\"SourceEndpointInstanceID\\": \\"rm-bp106x9tk2c91****\\",\\n \\"FullBackupList\\": {\\n \\"FullBackupDetail\\": [\\n {\\n \\"EndTime\\": 1646760308000,\\n \\"StartTime\\": 1646760282000,\\n \\"BackupSetId\\": \\"qecnsxkd****\\"\\n }\\n ]\\n }\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n E2BD9DFC-6760-5F49-97C5-DA739E29****\\n 200\\n \\n \\n point\\n rm-bp106x9tk2c91****\\n \\n \\n 1646760308000\\n 1646760282000\\n qecnsxkd****\\n \\n \\n rds\\n 1646760308000\\n 1646760282000\\n \\n \\n true\\n","errorExample":""}]', + ], + 'DescribeRestoreTaskList' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREcbsKR7J6S', + ], + ], + 'parameters' => [ + [ + 'name' => 'BackupPlanId', + 'in' => 'query', + 'schema' => [ + 'description' => '备份计划ID。'."\n" + ."\n" + .'> 请填入本参数BackupPlanId或RestoreTaskId。', + 'type' => 'string', + 'required' => false, + 'example' => 'dbs1hvb0wwwXXXXX', + ], + ], + [ + 'name' => 'RestoreTaskId', + 'in' => 'query', + 'schema' => [ + 'description' => '恢复任务ID，支持多个查询，使用半角逗号（,）分隔。您可以调用[CreateRestoreTask](~~2869836~~)接口获取该参数。'."\n" + ."\n" + .'> 请填入本参数RestoreTaskId或BackupPlanId，同时填入时会导致报错。', + 'type' => 'string', + 'required' => false, + 'example' => 's102h7rf5anq', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页的记录数，取值为1~100。'."\n" + ."\n" + .'> 默认为30。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '30', + ], + ], + [ + 'name' => 'PageNum', + 'in' => 'query', + 'schema' => [ + 'description' => '页码，大于等于0且不超过Integer的最大值，默认值为：0。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => '用于保证请求的幂等性，防止重复提交请求。', + 'type' => 'string', + 'required' => false, + 'example' => 'ETnLKlblzczshOTUbOCzxxxxxxx', + ], + ], + [ + 'name' => 'StartTimestamp', + 'in' => 'query', + 'schema' => [ + 'description' => '开始备份时间。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1570701361528', + ], + ], + [ + 'name' => 'EndTimestamp', + 'in' => 'query', + 'schema' => [ + 'description' => '结束备份时间。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1570701361528', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回参数详情如下。', + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'HTTP状态码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'PageNum' => [ + 'description' => '页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '9C397502-B4F2-4E22-AD97-C81F0049F3F3', + ], + 'ErrCode' => [ + 'description' => '错误码。', + 'type' => 'string', + 'example' => 'Param.NotFound', + ], + 'Success' => [ + 'description' => '是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ErrMessage' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'The specified parameter %s value is not valid. ', + ], + 'TotalPages' => [ + 'description' => '总页数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'TotalElements' => [ + 'description' => '总恢复任务数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '每页的记录数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '30', + ], + 'Items' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'RestoreTaskDetail' => [ + 'description' => '备份计划详情。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'RestoreStatus' => [ + 'description' => '恢复任务状态，取值：'."\n" + .'- init：未启动或预检查失败'."\n" + .'- running：运行中'."\n" + .'- stop：失败'."\n" + .'- pause：暂停'."\n" + .'- check_pass：预检查通过', + 'type' => 'string', + 'example' => 'running', + ], + 'FullStruAfterRestoreProgress' => [ + 'description' => '全量结构后置恢复进度。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + ], + 'CrossRoleName' => [ + 'description' => '跨阿里云账号备份的RAM角色名称。', + 'type' => 'string', + 'example' => 'test123', + ], + 'RestoreDir' => [ + 'description' => '恢复路径。', + 'type' => 'string', + 'example' => '100.X.X.10:33204', + ], + 'CrossAliyunId' => [ + 'description' => '跨阿里云账号备份的UID。', + 'type' => 'string', + 'example' => '2xxx7778xxxxxxxxxx', + ], + 'RestoreObjects' => [ + 'description' => '恢复对象。', + 'type' => 'string', + 'example' => '[ { \\"DBName\\":\\"test\\" } ]', + ], + 'BackupPlanId' => [ + 'description' => '备份计划ID。', + 'type' => 'string', + 'example' => 'dbs1hvb0wXXXX', + ], + 'DestinationEndpointRegion' => [ + 'description' => '数据库地域。', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'RestoreTaskCreateTime' => [ + 'description' => '恢复任务创建时间，取值：1554560477000。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1554560477000', + ], + 'DestinationEndpointUserName' => [ + 'description' => '数据库账号。', + 'type' => 'string', + 'example' => 'test', + ], + 'RestoreTaskFinishTime' => [ + 'description' => '恢复任务完成时间，取值：1554560477000。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1554560477000', + ], + 'DestinationEndpointIpPort' => [ + 'description' => '数据库连接地址。', + 'type' => 'string', + 'example' => '100.X.X.10:33204', + ], + 'DestinationEndpointDatabaseName' => [ + 'description' => '数据库名称。', + 'type' => 'string', + 'example' => 'test', + ], + 'DestinationEndpointInstanceType' => [ + 'description' => '数据库所在位置，取值：'."\n" + .'- RDS'."\n" + .'- ECS'."\n" + .'- Express：通过专线/VPN网关/智能网关接入的数据库'."\n" + .'- agent：通过备份网关接入的数据库'."\n" + .'- dds：云MongoDB'."\n" + .'- other：通过IP:Port直连的数据库', + 'type' => 'string', + 'example' => 'RDS', + ], + 'DestinationEndpointOracleSID' => [ + 'description' => 'Oracle SID名称。', + 'type' => 'string', + 'example' => 'test', + ], + 'FullStruforeRestoreProgress' => [ + 'description' => '全量结构前置恢复进度。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'ErrMessage' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'NULL', + ], + 'RestoreTaskId' => [ + 'description' => '恢复任务ID。', + 'type' => 'string', + 'example' => 's1XXXXXX', + ], + 'FullDataRestoreProgress' => [ + 'description' => '全量数据恢复进度。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + ], + 'ContinuousRestoreProgress' => [ + 'description' => '增量日志恢复进度。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + ], + 'DestinationEndpointInstanceID' => [ + 'description' => '数据库实例ID。', + 'type' => 'string', + 'example' => 'rm-bp1p8c2947XXX', + ], + 'BackupSetId' => [ + 'description' => '恢复所使用的全量备份集ID。', + 'type' => 'string', + 'example' => '1ibh2f5uXXX', + ], + 'BackupGatewayId' => [ + 'description' => '备份网关ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '324234332', + ], + 'RestoreTaskName' => [ + 'description' => '恢复任务名称。', + 'type' => 'string', + 'example' => 'test', + ], + 'RestoreTime' => [ + 'description' => '恢复时间，取值：1554560477000。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1554560477000', + ], + ], + 'description' => '', + ], + ], + ], + 'description' => '', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'Request.Forbidden', + 'errorMessage' => 'Have no Permissions', + 'description' => '当前操作未被授权，请联系主账号在RAM控制台进行授权后再执行操作', + ], + ], + ], + 'title' => '查看恢复任务列表', + 'summary' => '该接口用于查看DBS恢复任务列表。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + [ + 'createdAt' => '2022-07-12T03:53:45.000Z', + 'description' => '错误码发生变更', + ], + ], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '100', + 'countWindow' => 60, + 'regionId' => '*', + 'api' => 'DescribeRestoreTaskList', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dbs:DescribeRestoreTaskList', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DBS', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"PageNum\\": 1,\\n \\"RequestId\\": \\"9C397502-B4F2-4E22-AD97-C81F0049F3F3\\",\\n \\"ErrCode\\": \\"Param.NotFound\\",\\n \\"Success\\": true,\\n \\"ErrMessage\\": \\"The specified parameter %s value is not valid. \\",\\n \\"TotalPages\\": 1,\\n \\"TotalElements\\": 1,\\n \\"PageSize\\": 30,\\n \\"Items\\": {\\n \\"RestoreTaskDetail\\": [\\n {\\n \\"RestoreStatus\\": \\"running\\",\\n \\"FullStruAfterRestoreProgress\\": 100,\\n \\"CrossRoleName\\": \\"test123\\",\\n \\"RestoreDir\\": \\"100.X.X.10:33204\\",\\n \\"CrossAliyunId\\": \\"2xxx7778xxxxxxxxxx\\",\\n \\"RestoreObjects\\": \\"[ { \\\\\\\\\\\\\\"DBName\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"test\\\\\\\\\\\\\\" } ]\\",\\n \\"BackupPlanId\\": \\"dbs1hvb0wXXXX\\",\\n \\"DestinationEndpointRegion\\": \\"cn-hangzhou\\",\\n \\"RestoreTaskCreateTime\\": 1554560477000,\\n \\"DestinationEndpointUserName\\": \\"test\\",\\n \\"RestoreTaskFinishTime\\": 1554560477000,\\n \\"DestinationEndpointIpPort\\": \\"100.X.X.10:33204\\",\\n \\"DestinationEndpointDatabaseName\\": \\"test\\",\\n \\"DestinationEndpointInstanceType\\": \\"RDS\\",\\n \\"DestinationEndpointOracleSID\\": \\"test\\",\\n \\"FullStruforeRestoreProgress\\": 0,\\n \\"ErrMessage\\": \\"NULL\\",\\n \\"RestoreTaskId\\": \\"s1XXXXXX\\",\\n \\"FullDataRestoreProgress\\": 100,\\n \\"ContinuousRestoreProgress\\": 100,\\n \\"DestinationEndpointInstanceID\\": \\"rm-bp1p8c2947XXX\\",\\n \\"BackupSetId\\": \\"1ibh2f5uXXX\\",\\n \\"BackupGatewayId\\": 324234332,\\n \\"RestoreTaskName\\": \\"test\\",\\n \\"RestoreTime\\": 1554560477000\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"30\\n9C397502-B4F2-4E22-AD97-C81F0049F3F3\\n0\\n200\\n1\\n\\n \\n 0\\n 0\\n 1ibXXXXX7qw\\n check_pass\\n rds\\n 1583741465000\\n cn-hangzhou\\n 0\\n s10XXXXnq\\n 100.X.X.10:33204\\n testygx\\n [ { \\"DBName\\":\\"test_ygx\\" } ]\\n test\\n dbs1hvb0wwweusfa\\n 1583743872000\\n rm-bp1p8c29479jv8pxe\\n \\n\\n1\\ntrue","errorExample":""}]', + ], + 'DisableBackupLog' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREcbsKR7J6S', + ], + ], + 'parameters' => [ + [ + 'name' => 'BackupPlanId', + 'in' => 'query', + 'schema' => [ + 'description' => '备份计划ID。您可以调用[DescribeBackupPlanList](~~2869825~~)查询。', + 'type' => 'string', + 'required' => true, + 'example' => 'dbstooi01****', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => '用于保证请求的幂等性，防止重复提交请求。', + 'type' => 'string', + 'required' => false, + 'example' => 'ETnLKlblzczshOTUbOCziJZNwH****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'HTTP状态码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'D6E068C3-25BC-455A-85FE-45F0B22ECB1F', + ], + 'ErrCode' => [ + 'description' => '错误码。', + 'type' => 'string', + 'example' => 'Param.NotFound', + ], + 'Success' => [ + 'description' => '是否执行成功。返回值：'."\n" + .'- true：执行成功'."\n" + .'- false：执行失败', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ErrMessage' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'findValidDBSJob error', + ], + 'BackupPlanId' => [ + 'description' => '备份计划ID。', + 'type' => 'string', + 'example' => 'dbstooi01****', + ], + 'NeedPrecheck' => [ + 'description' => '本次修改是否会触发预检查。返回值：'."\n" + .'- true：已触发预检查，且需要您手动调用[StartBackupPlan](~~2869816~~)接口，启动备份计划。'."\n" + .'- false：不会触发预检查。', + 'type' => 'boolean', + 'example' => 'false', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'Request.Forbidden', + 'errorMessage' => 'Have no Permissions', + 'description' => '当前操作未被授权，请联系主账号在RAM控制台进行授权后再执行操作', + ], + ], + ], + 'title' => '关闭增量备份', + 'summary' => '该接口用于关闭备份计划中的增量备份。', + 'description' => '## 影响'."\n" + .'关闭后，您的备份计划将不再进行增量备份。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + [ + 'createdAt' => '2022-07-12T03:53:45.000Z', + 'description' => '错误码发生变更', + ], + ], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '10', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'DisableBackupLog', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dbs:DisableBackupLog', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DBS', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"D6E068C3-25BC-455A-85FE-45F0B22ECB1F\\",\\n \\"ErrCode\\": \\"Param.NotFound\\",\\n \\"Success\\": true,\\n \\"ErrMessage\\": \\"findValidDBSJob error\\",\\n \\"BackupPlanId\\": \\"dbstooi01****\\",\\n \\"NeedPrecheck\\": false\\n}","errorExample":""},{"type":"xml","example":"D6E068C3-25BC-455A-85FE-45F0B22ECB1F\\n200\\ndbstooi01xxxx\\nfalse\\nfindValidDBSJob error\\ntrue\\nParam.NotFound","errorExample":""}]', + ], + 'EnableBackupLog' => [ + 'summary' => '该接口用于开启备份计划中的增量备份。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREcbsKR7J6S', + ], + ], + 'parameters' => [ + [ + 'name' => 'BackupPlanId', + 'in' => 'query', + 'schema' => [ + 'description' => '备份计划ID。您可以调用[DescribeBackupPlanList](~~2869825~~)查询。', + 'type' => 'string', + 'required' => true, + 'example' => 'dbstooi******', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => '任意字符串。', + 'type' => 'string', + 'required' => false, + 'example' => 'dbs', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'HTTP状态码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'D6E068C3-25BC-455A-85FE-45F0B22ECB1F', + ], + 'ErrCode' => [ + 'description' => '错误码。', + 'type' => 'string', + 'example' => 'Param.NotFound', + ], + 'Success' => [ + 'description' => '是否执行成功。返回值：'."\n" + .'- true：执行成功'."\n" + .'- false：执行失败', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ErrMessage' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'findValidDBSJob error', + ], + 'BackupPlanId' => [ + 'description' => '备份计划ID。', + 'type' => 'string', + 'example' => 'dbstooi******', + ], + 'NeedPrecheck' => [ + 'description' => '本次修改是否会触发预检查。返回值：'."\n" + .'- true：已触发预检查，且需要您手动调用[StartBackupPlan](~~2869816~~)接口，启动备份计划。'."\n" + .'- false：不会触发预检查。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'Request.Forbidden', + 'errorMessage' => 'Have no Permissions', + 'description' => '当前操作未被授权，请联系主账号在RAM控制台进行授权后再执行操作', + ], + ], + ], + 'title' => '开启增量备份', + 'description' => '## 影响'."\n" + .'开启增量备份不会产生任何费用，但因增量备份会生成对应的备份流量和存储量，该部分收费标准与全量备份的收费标准相同，且都可以用备份计划或存储包的免费额度进行抵扣。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + [ + 'createdAt' => '2022-07-12T03:53:45.000Z', + 'description' => '错误码发生变更', + ], + ], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '10', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'EnableBackupLog', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dbs:EnableBackupLog', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DBS', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"D6E068C3-25BC-455A-85FE-45F0B22ECB1F\\",\\n \\"ErrCode\\": \\"Param.NotFound\\",\\n \\"Success\\": true,\\n \\"ErrMessage\\": \\"findValidDBSJob error\\",\\n \\"BackupPlanId\\": \\"dbstooi******\\",\\n \\"NeedPrecheck\\": true\\n}","errorExample":""},{"type":"xml","example":"D6E068C3-25BC-455A-85FE-45F0B22ECB1F\\n200\\ndbstooi01xxxx\\nfalse\\nfindValidDBSJob error\\ntrue\\nParam.NotFound","errorExample":""}]', + ], + 'GetDBListFromAgent' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREcbsKR7J6S', + ], + ], + 'parameters' => [ + [ + 'name' => 'BackupGatewayId', + 'in' => 'query', + 'schema' => [ + 'description' => '备份网关ID，可通过调用[DescribeBackupGatewayList](~~2869840~~)接口获取该参数的值。'."\n" + ."\n" + .'> 此参数为必填项。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '160***', + ], + ], + [ + 'name' => 'SourceEndpointRegion', + 'in' => 'query', + 'schema' => [ + 'description' => '备份网关地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'TaskId', + 'in' => 'query', + 'schema' => [ + 'description' => '异步任务ID，调用[CreateGetDBListFromAgentTask](~~2869847~~)获取该参数的值。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '123456', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => '用于保证请求的幂等性，防止重复提交请求。由客户端生成该参数值，要保证在不同请求间唯一，最大值不超过64个ASCII字符，且该参数值中不能包含非ASCII字符。'."\n" + ."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'ETnLKlblzczshOTUbOCzxxxxxxxxxx', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回值详情如下。', + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => '错误码值。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '400', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'EB4DFD5E-3618-498D-BE35-4DBEA0072122', + ], + 'ErrCode' => [ + 'description' => '错误码字符串。'."\n", + 'type' => 'string', + 'example' => 'InvalidParameter', + ], + 'Success' => [ + 'description' => '请求成功状态。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ErrMessage' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'This backupPlan can\'t support this action', + ], + 'DbList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'dbName' => [ + 'description' => '数据库列表。', + 'type' => 'array', + 'items' => [ + 'description' => '数据库列表。', + 'type' => 'string', + 'example' => 'TaskDB', + ], + ], + ], + 'description' => '', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'Request.Forbidden', + 'errorMessage' => 'Have no Permissions', + 'description' => '当前操作未被授权，请联系主账号在RAM控制台进行授权后再执行操作', + ], + ], + ], + 'title' => '通过备份网关获取数据库列表', + 'summary' => '该接口用于通过备份网关获取物理备份的库表数据。', + 'description' => '您需要调用[CreateGetDBListFromAgentTask](~~2869847~~)接口创建一个异步任务获取TaskId（异步任务ID）。将TaskId传入GetDBListFromAgent接口后，即可获取物理备份库表数据。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + [ + 'createdAt' => '2022-07-12T03:53:45.000Z', + 'description' => '错误码发生变更', + ], + ], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '100', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'GetDBListFromAgent', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dbs:GetDBListFromAgent', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DBS', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 400,\\n \\"RequestId\\": \\"EB4DFD5E-3618-498D-BE35-4DBEA0072122\\",\\n \\"ErrCode\\": \\"InvalidParameter\\",\\n \\"Success\\": true,\\n \\"ErrMessage\\": \\"This backupPlan can\'t support this action\\",\\n \\"DbList\\": {\\n \\"dbName\\": [\\n \\"TaskDB\\"\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n EB4DFD5E-3618-498D-BE35-4DBEA0072122\\n 400\\n This backupPlan can\'t support this action\\n true\\n \\n TaskDB\\n \\n InvalidParameter\\n","errorExample":""}]', + ], + 'InitializeDbsServiceLinkedRole' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREcbsKR7J6S', + ], + ], + 'parameters' => [], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回参数详情如下。', + 'type' => 'object', + 'properties' => [ + 'Data' => [ + 'description' => '空值。', + 'type' => 'string', + 'example' => 'null', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '4F1888AC-1138-4995-B9FE-D2734F61C058', + ], + 'Success' => [ + 'description' => '请求是否成功，返回值如下：'."\n" + ."\n" + .'- **true**：请求成功。'."\n" + .'- **false**：请求失败。', + 'type' => 'string', + 'example' => 'true', + ], + 'ErrorCode' => [ + 'description' => '错误码。', + 'type' => 'string', + 'example' => 'EntityAlreadyExists.Role', + ], + 'ErrMessage' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'EntityAlreadyExists.Role : The role already exists:AliyunServiceRoleForDBS\\r\\nRequestId : 73******-3B4D-501A-9505-FA8B9******', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'Request.Forbidden', + 'errorMessage' => 'Have no Permissions', + 'description' => '当前操作未被授权，请联系主账号在RAM控制台进行授权后再执行操作', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'title' => '授权DBS服务关联角色', + 'summary' => '该接口用于将服务关联角色（AliyunServiceRoleForDBS）授权给DBS。', + 'description' => 'DBS接入您在阿里云购买的云数据库（如RDS、MongoDB、 Redis、PolarDB）或阿里云ECS上自建的数据库时， 需通过服务关联角色（AliyunServiceRoleForDBS）获取访问权限。更多信息，请参见[开通数据库备份DBS服务](~~162603~~)。', + 'requestParamsDescription' => '当前API无需请求参数。', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + [ + 'createdAt' => '2022-07-12T03:53:45.000Z', + 'description' => '错误码发生变更', + ], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'dbs:InitializeDbsServiceLinkedRole', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DBS', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Data\\": \\"null\\",\\n \\"RequestId\\": \\"4F1888AC-1138-4995-B9FE-D2734F61C058\\",\\n \\"Success\\": \\"true\\",\\n \\"ErrorCode\\": \\"EntityAlreadyExists.Role\\",\\n \\"ErrMessage\\": \\"EntityAlreadyExists.Role : The role already exists:AliyunServiceRoleForDBS\\\\\\\\r\\\\\\\\nRequestId : 73******-3B4D-501A-9505-FA8B9******\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n 1FB42980-238F-43DC-942D-097562C01B5B\\r\\n Success\\r\\n true \\r\\n","errorExample":""}]', + ], + 'ModifyBackupObjects' => [ + 'summary' => '该接口用于修改一个DBS备份计划的备份对象。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '105089', + 'abilityTreeNodes' => [ + 'FEATUREcbsUOJI4N', + ], + ], + 'parameters' => [ + [ + 'name' => 'BackupPlanId', + 'in' => 'query', + 'schema' => [ + 'description' => '备份计划ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'dbs1h****usfa', + ], + ], + [ + 'name' => 'BackupObjects', + 'in' => 'query', + 'schema' => [ + 'description' => 'BackupObjects 的定义格式为 JSON 字符串，定义如下：'."\n" + .'```'."\n" + .'['."\n" + .' {'."\n" + .' "DBName":"待备份库名",'."\n" + .' "SchemaName":"待备份 Schema 名",'."\n" + .' "TableIncludes":[{'."\n" + .' "TableName":"待备份表表名"'."\n" + .' }],'."\n" + .' "TableExcludes":[{'."\n" + .' "TableName":"待备份库名不需要备份表的表名"'."\n" + .' }]'."\n" + .' }'."\n" + .']'."\n" + .'```'."\n" + ."\n" + .'* 当用户只配置了`DBName`，不配置其他子对象的规则，那么表示迁移这个数据库下面的所有对象。'."\n" + .'* 当用户配置了`DBName`，且配置了部分对象的规则，那么不配置的对象默认不迁移。各种对象名的定义可以支持如下的正则表达式：'."\n" + .' * 点号`.`：表示匹配除`\\r\\n`之外的任何单个字符。'."\n" + .' * 星号`*`：表示匹配前面子表达式任意次，`h*llo`匹配 `hllo`、`heeeello`等字符串。'."\n" + .' * 问号`?`：表示匹配前面子表达式零次或1次，`h.?llo`匹配`hllo`、`hello`，但不能匹配`haello`。'."\n" + .' * 字符集合`[characters]`：表示匹配方括号内任意一个字符，例如`h[aello]`匹配`hallo`、`hello`。'."\n" + .' * 负值字符集合`[^characters]`：表示不匹配方括号内任意一个字符，例如`h[^ae]llo`匹配`hcllo`、`hdllo`，但是不能匹配`hallo`、`hello`。'."\n" + .' * 字符范围`[character1-character2]`：表示 `character1-character2`范围内的字符都可以匹配，例如 `[0-9]`、`[a-z]`。'."\n" + ."\n" + .'> `SchemaName` 和 `NewSchemaName`只用于 MSSQL，其他数据库的库名定义使用 `DBName`和`NewDBName`参数。', + 'type' => 'string', + 'required' => true, + 'example' => '[ { "DBName":"17xxx92xxxx374", "SchemaName":"gy9xnj8xxxxxx", "TableIncludes":[{ "TableName":"test1" }], "TableExcludes":[{ "TableName":"test2" }] } ]', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => '用于保证请求的幂等性，防止重复提交请求。', + 'type' => 'string', + 'required' => false, + 'example' => 'ETnLKlblzczshOTUbOCzxxxxxxx', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回参数详情如下。', + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'HTTP状态码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'D6E068C3-25BC-455A-85FE-45F0B22ECB1F', + ], + 'ErrCode' => [ + 'description' => '错误码。', + 'type' => 'string', + 'example' => 'InvalidParameter', + ], + 'Success' => [ + 'description' => '请求是否成功，返回值如下：'."\n" + ."\n" + .'- **true**：请求成功。'."\n" + .'- **false**：请求失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ErrMessage' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'The specified parameter %s value is not valid. ', + ], + 'BackupPlanId' => [ + 'description' => '备份计划ID。', + 'type' => 'string', + 'example' => 'dbs1h****usfa', + ], + 'NeedPrecheck' => [ + 'description' => '本次修改是否会触发预检查，如果为true则需要再调用[StartBackupPlan](~~2869816~~)接口启动备份计划。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'Request.Forbidden', + 'errorMessage' => 'Have no Permissions', + 'description' => '当前操作未被授权，请联系主账号在RAM控制台进行授权后再执行操作', + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'title' => '修改备份对象', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + [ + 'createdAt' => '2022-07-12T03:53:45.000Z', + 'description' => '错误码发生变更', + ], + ], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '10', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'ModifyBackupObjects', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dbs:ModifyBackupObjects', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DBS', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"D6E068C3-25BC-455A-85FE-45F0B22ECB1F\\",\\n \\"ErrCode\\": \\"InvalidParameter\\",\\n \\"Success\\": true,\\n \\"ErrMessage\\": \\"The specified parameter %s value is not valid. \\",\\n \\"BackupPlanId\\": \\"dbs1h****usfa\\",\\n \\"NeedPrecheck\\": true\\n}","errorExample":""},{"type":"xml","example":"\\nD6E068C3-25BC-455A-85FE-45F0B22ECB1F\\n200\\ndbs1h****usfa\\ntrue\\n","errorExample":""}]', + ], + 'ModifyBackupPlanName' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREcbsKR7J6S', + ], + ], + 'parameters' => [ + [ + 'name' => 'BackupPlanId', + 'in' => 'query', + 'schema' => [ + 'description' => '备份计划ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'dbstooi0XXXX', + ], + ], + [ + 'name' => 'BackupPlanName', + 'in' => 'query', + 'schema' => [ + 'description' => '备份计划名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'dbstooi0XXXX', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => '用于保证请求的幂等性，防止重复提交请求。', + 'type' => 'string', + 'required' => false, + 'example' => 'ETnLKlblzczshOTUbOCzxxxxxxx', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'HTTP状态码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'D6E068C3-25BC-455A-85FE-45F0B22ECB1F', + ], + 'ErrCode' => [ + 'description' => '错误码。', + 'type' => 'string', + 'example' => 'Param.NotFound', + ], + 'Success' => [ + 'description' => '是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ErrMessage' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'The specified parameter %s value is not valid. ', + ], + 'BackupPlanId' => [ + 'description' => '备份计划ID。', + 'type' => 'string', + 'example' => 'dbstooi0XXXX', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'Request.Forbidden', + 'errorMessage' => 'Have no Permissions', + 'description' => '当前操作未被授权，请联系主账号在RAM控制台进行授权后再执行操作', + ], + ], + ], + 'title' => '修改备份计划名称', + 'summary' => '该接口用于修改一个备份计划名称。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + [ + 'createdAt' => '2022-07-12T03:53:45.000Z', + 'description' => '错误码发生变更', + ], + ], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '10', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'ModifyBackupPlanName', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dbs:ModifyBackupPlanName', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DBS', + 'resourceType' => 'BackupPlan', + 'arn' => 'acs:dbs:{#regionId}:{#accountId}:backupplan/{#BackupPlanId}', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"D6E068C3-25BC-455A-85FE-45F0B22ECB1F\\",\\n \\"ErrCode\\": \\"Param.NotFound\\",\\n \\"Success\\": true,\\n \\"ErrMessage\\": \\"The specified parameter %s value is not valid. \\",\\n \\"BackupPlanId\\": \\"dbstooi0XXXX\\"\\n}","errorExample":""},{"type":"xml","example":"\\nD6E068C3-25BC-455A-85FE-45F0B22ECB1F\\n200\\ndbs1h****usfa\\ntrue\\n","errorExample":""}]', + ], + 'ModifyBackupSetDownloadRules' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREcbsKR7J6S', + ], + ], + 'parameters' => [ + [ + 'name' => 'BackupPlanId', + 'in' => 'query', + 'schema' => [ + 'description' => '备份计划ID，可通过调用[DescribeBackupPlanList](~~2869825~~)接口查看。', + 'type' => 'string', + 'required' => true, + 'example' => 'dbstooi01xxxx', + ], + ], + [ + 'name' => 'OpenAutoDownload', + 'in' => 'query', + 'schema' => [ + 'description' => '是否开启自动下载，默认false。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'BackupGatewayId', + 'in' => 'query', + 'schema' => [ + 'description' => '备份集下载备份网关ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '23312323', + ], + ], + [ + 'name' => 'FullDataFormat', + 'in' => 'query', + 'schema' => [ + 'description' => '备份集下载全量数据格式：'."\n" + .'- Native'."\n" + .'- SQL'."\n" + .'- CSV'."\n" + .'- JSON'."\n" + ."\n" + .'> 默认 CSV。'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'CSV', + ], + ], + [ + 'name' => 'IncrementDataFormat', + 'in' => 'query', + 'schema' => [ + 'description' => '备份集下载增量数据格式：'."\n" + .'- Native'."\n" + .'- SQL'."\n" + .'- CSV'."\n" + .'- JSON'."\n" + ."\n" + .'> 默认Native。', + 'type' => 'string', + 'required' => false, + 'example' => 'Native', + ], + ], + [ + 'name' => 'BackupSetDownloadDir', + 'in' => 'query', + 'schema' => [ + 'description' => '备份集下载服务器目录。', + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + [ + 'name' => 'BackupSetDownloadTargetType', + 'in' => 'query', + 'schema' => [ + 'description' => '备份集下载目标类型 。'."\n" + .'> 默认agent：已安装备份网关，目前仅此项。'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'agent', + ], + ], + [ + 'name' => 'BackupSetDownloadTargetTypeLocation', + 'in' => 'query', + 'schema' => [ + 'description' => '备份集下载目标目录类型，如果是开启自动下载，则必填，取值：'."\n" + .'- local'."\n" + .'- nas'."\n" + .'- ftp'."\n" + .'- minio'."\n" + ."\n" + .'> 默认为local。', + 'type' => 'string', + 'required' => false, + 'example' => 'local', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => '用于保证请求的幂等性，防止重复提交请求。', + 'type' => 'string', + 'required' => false, + 'example' => 'ETnLKlblzczshOTUbOCzxxxxxxx', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'HTTP状态码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'D6E068C3-25BC-455A-85FE-45F0B22ECB1F', + ], + 'ErrCode' => [ + 'description' => '错误码。', + 'type' => 'string', + 'example' => 'Param.NotFound', + ], + 'Success' => [ + 'description' => '是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ErrMessage' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'The specified parameter %s value is not valid. ', + ], + 'BackupPlanId' => [ + 'description' => '备份计划ID。', + 'type' => 'string', + 'example' => 'dbstooi01exxxx', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'Request.Forbidden', + 'errorMessage' => 'Have no Permissions', + 'description' => '当前操作未被授权，请联系主账号在RAM控制台进行授权后再执行操作', + ], + ], + ], + 'title' => '设置备份集下载规则', + 'summary' => '该接口用于开启、修改、关闭自动下载功能。', + 'description' => '使用本接口前请先确认备份数据是否存储在DBS的内置OSS上，您可通过调用[DescribeBackupPlanList](~~2869825~~)接口查看BackupStorageType取值情况。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + [ + 'createdAt' => '2022-07-12T03:53:45.000Z', + 'description' => '错误码发生变更', + ], + ], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '10', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'ModifyBackupSetDownloadRules', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dbs:ModifyBackupSetDownloadRules', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DBS', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"D6E068C3-25BC-455A-85FE-45F0B22ECB1F\\",\\n \\"ErrCode\\": \\"Param.NotFound\\",\\n \\"Success\\": true,\\n \\"ErrMessage\\": \\"The specified parameter %s value is not valid. \\",\\n \\"BackupPlanId\\": \\"dbstooi01exxxx\\"\\n}","errorExample":""},{"type":"xml","example":"D6E068C3-25BC-455A-85FE-45F0B22ECB1F\\n200\\ndbstooi01exxxx\\ntrue\\n","errorExample":""}]', + ], + 'ModifyBackupSourceEndpoint' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREcbsKR7J6S', + ], + ], + 'parameters' => [ + [ + 'name' => 'BackupPlanId', + 'in' => 'query', + 'schema' => [ + 'description' => '备份计划ID，可通过调用[DescribeBackupPlanList](~~2869825~~)接口获取该参数的值。', + 'type' => 'string', + 'required' => true, + 'example' => 'dbs1h****usfa', + ], + ], + [ + 'name' => 'SourceEndpointInstanceType', + 'in' => 'query', + 'schema' => [ + 'description' => '数据库所在位置，可通过调用[DescribeBackupPlanList](~~2869825~~)接口获取该参数的值。取值如下：'."\n" + ."\n" + .'- **RDS**'."\n" + .'- **ECS**'."\n" + .'- **Express**：通过专线/VPN网关/智能网关接入的数据库'."\n" + .'- **Agent**：通过备份网关接入的数据库'."\n" + .'- **DDS**：云MongoDB'."\n" + .'- **Other**：通过IP:Port直连的数据库', + 'type' => 'string', + 'required' => true, + 'example' => 'RDS', + ], + ], + [ + 'name' => 'SourceEndpointRegion', + 'in' => 'query', + 'schema' => [ + 'description' => '数据库地域，可通过调用[DescribeBackupPlanList](~~2869825~~)接口获取该参数的值。'."\n" + ."\n" + .'> **SourceEndpointInstanceType**为RDS、ECS、DDS、Express、Agent时，该参数必传。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'SourceEndpointInstanceID', + 'in' => 'query', + 'schema' => [ + 'description' => '数据库实例ID，可通过调用[DescribeBackupPlanList](~~2869825~~)接口获取该参数的值。'."\n" + ."\n" + .'> **SourceEndpointInstanceType**为RDS、ECS、DDS、Express时，该参数必传。', + 'type' => 'string', + 'required' => false, + 'example' => 'rm-bp1p8c29479jv****', + ], + ], + [ + 'name' => 'SourceEndpointIP', + 'in' => 'query', + 'schema' => [ + 'description' => '数据库连接地址，可通过调用[DescribeBackupPlanList](~~2869825~~)接口获取该参数的值。'."\n" + ."\n" + .'> **SourceEndpointInstanceType**为Express、Agent、Other时该参数必传。', + 'type' => 'string', + 'required' => false, + 'example' => '100.*.*.10:3306', + ], + ], + [ + 'name' => 'SourceEndpointPort', + 'in' => 'query', + 'schema' => [ + 'description' => '数据库端口，可通过调用[DescribeBackupPlanList](~~2869825~~)接口获取该参数的值。'."\n" + ."\n" + .'> **SourceEndpointInstanceType**为Express、Agent、Other、ECS，该参数必传。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '3306', + ], + ], + [ + 'name' => 'SourceEndpointDatabaseName', + 'in' => 'query', + 'schema' => [ + 'description' => '数据库名称。'."\n" + ."\n" + .'- 数据库类型为PostgreSQL、MongoDB时，该参数必传。'."\n" + .'- 数据库所在位置为Agent且数据库类型为MSSQL时，该参数必传。', + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + [ + 'name' => 'SourceEndpointUserName', + 'in' => 'query', + 'schema' => [ + 'description' => '数据库账号，可通过调用[DescribeBackupPlanList](~~2869825~~)接口获取该参数的值。'."\n" + ."\n" + .'数据库类型为Redis，或者数据库所在位置为Agent且数据库类型为MSSQL时该参数非必须，其他场景均必传。', + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + [ + 'name' => 'SourceEndpointPassword', + 'in' => 'query', + 'schema' => [ + 'description' => '密码。'."\n" + ."\n" + .'数据库类型为Redis，或者数据库所在位置为Agent且数据库类型为MSSQL时该参数非必须，其他场景均必传。', + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + [ + 'name' => 'BackupGatewayId', + 'in' => 'query', + 'schema' => [ + 'description' => '备份网关ID，可通过调用[DescribeBackupPlanList](~~2869825~~)接口获取该参数的值。'."\n" + ."\n" + .'> **SourceEndpointInstanceType**为Agent时，该参数必传。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '21321323213', + ], + ], + [ + 'name' => 'BackupObjects', + 'in' => 'query', + 'schema' => [ + 'description' => '备份对象，当数据库所在位置为Agent时，该参数非必须，其他场景均必传。可通过调用[DescribeBackupPlanList](~~2869825~~)接口获取该参数的值。', + 'type' => 'string', + 'required' => false, + 'example' => '[{ "DBName":"待备份库名", "SchemaName":"待备份 Schema 名", "TableIncludes":[{ "TableName":"待备份表表名" }], "TableExcludes":[{"TableName":"待备份库名不需要备份表的表名" }] } ]', + ], + ], + [ + 'name' => 'SourceEndpointOracleSID', + 'in' => 'query', + 'schema' => [ + 'description' => 'Oracle SID名称，数据库类型为Oracle时，该参数必传。', + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + [ + 'name' => 'CrossAliyunId', + 'in' => 'query', + 'schema' => [ + 'description' => '跨阿里云账号备份的UID，可通过调用[DescribeRestoreTaskList](~~2869838~~)接口获取该参数的值。', + 'type' => 'string', + 'required' => false, + 'example' => '2xxx7778xxxxxxxxxx', + ], + ], + [ + 'name' => 'CrossRoleName', + 'in' => 'query', + 'schema' => [ + 'description' => '跨阿里云账号备份的RAM角色名称，可通过调用[DescribeRestoreTaskList](~~2869838~~)接口获取该参数的值。', + 'type' => 'string', + 'required' => false, + 'example' => 'test123', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => '任意字符串，用于保证请求的幂等性，防止重复提交请求。', + 'type' => 'string', + 'required' => false, + 'example' => 'ETnLKlblzczshOTUbOCzxxxxxxx', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'HTTP状态码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'D6E068C3-25BC-455A-85FE-45F0B22E****', + ], + 'ErrCode' => [ + 'description' => '错误码。', + 'type' => 'string', + 'example' => 'Param.NotFound', + ], + 'Success' => [ + 'description' => '请求是否成功，返回值如下：'."\n" + .'- **true**：请求成功'."\n" + .'- **false**：请求失败', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ErrMessage' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'The specified parameter %s value is not valid. ', + ], + 'BackupPlanId' => [ + 'description' => '备份计划ID。', + 'type' => 'string', + 'example' => 'dbs1h****usfa', + ], + 'NeedPrecheck' => [ + 'description' => '本次修改是否会触发预检查，如果为true则需要再调用StartBackupPlan接口启动备份计划。', + 'type' => 'boolean', + 'example' => 'false', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'Request.Forbidden', + 'errorMessage' => 'Have no Permissions', + 'description' => '当前操作未被授权，请联系主账号在RAM控制台进行授权后再执行操作', + ], + ], + ], + 'title' => '修改数据库备份源', + 'summary' => '该接口用于修改数据库备份源。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + [ + 'createdAt' => '2022-07-12T03:53:30.000Z', + 'description' => '错误码发生变更', + ], + ], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '10', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'ModifyBackupSourceEndpoint', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dbs:ModifyBackupSourceEndpoint', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DBS', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"D6E068C3-25BC-455A-85FE-45F0B22E****\\",\\n \\"ErrCode\\": \\"Param.NotFound\\",\\n \\"Success\\": true,\\n \\"ErrMessage\\": \\"The specified parameter %s value is not valid. \\",\\n \\"BackupPlanId\\": \\"dbs1h****usfa\\",\\n \\"NeedPrecheck\\": false\\n}","errorExample":""},{"type":"xml","example":"\\n D6E068C3-25BC-455A-85FE-45F0B22E****\\n 200\\n dbs1h****usfa\\n false\\n true\\n","errorExample":""}]', + ], + 'ModifyBackupStrategy' => [ + 'summary' => '该接口用于修改备份计划的备份时间。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREcbsKR7J6S', + ], + ], + 'parameters' => [ + [ + 'name' => 'BackupPlanId', + 'in' => 'query', + 'schema' => [ + 'description' => '备份计划ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'dbstooi01XXXX', + ], + ], + [ + 'name' => 'BackupPeriod', + 'in' => 'query', + 'schema' => [ + 'description' => '全量备份周期，取值如下：'."\n" + .'- Monday：周一'."\n" + .'- Tuesday：周二'."\n" + .'- Wednesday：周三'."\n" + .'- Thursday：周四'."\n" + .'- Friday：周五'."\n" + .'- Saturday：周六'."\n" + .'- Sunday：周日'."\n" + ."\n" + .'> BackupPeriod值必须指定每周至少两天，且日期间用英文逗号（,）分隔。', + 'type' => 'string', + 'required' => true, + 'example' => 'Monday,Tuesday,Wednesday', + ], + ], + [ + 'name' => 'BackupStartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '全量备份开始时间，取值：格式：HH:mm。'."\n" + ."\n" + .'> 该参数必填。', + 'type' => 'string', + 'required' => false, + 'example' => '14:22', + ], + ], + [ + 'name' => 'BackupStrategyType', + 'in' => 'query', + 'schema' => [ + 'description' => '全量备份周期，取值：'."\n" + .'- **simple**：周期备份，和BackupPeriod、BackupStartTime配合使用。'."\n" + .'- **manual**：手动备份。'."\n" + ."\n" + .'> 默认为**simple**。', + 'type' => 'string', + 'required' => false, + 'example' => 'simple', + ], + ], + [ + 'name' => 'BackupLogIntervalSeconds', + 'in' => 'query', + 'schema' => [ + 'description' => '增量时间间隔，以秒（s）为单位。'."\n" + .'> 仅支持物理备份。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1000', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => '用于保证请求的幂等性，防止重复提交请求。', + 'type' => 'string', + 'required' => false, + 'example' => 'ETnLKlblzczshOTUbOCzxxxxxxx', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'HTTP状态码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'D6E068C3-25BC-455A-85FE-45F0B22ECB1F', + ], + 'ErrCode' => [ + 'description' => '错误码。', + 'type' => 'string', + 'example' => 'Param.NotFound', + ], + 'Success' => [ + 'description' => '是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ErrMessage' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'The specified parameter %s value is not valid. ', + ], + 'BackupPlanId' => [ + 'description' => '备份计划ID。', + 'type' => 'string', + 'example' => 'dbstooi01XXXX', + ], + 'NeedPrecheck' => [ + 'description' => '本次修改是否会触发预检查，如果为true则需要，再调用StartBackupPlan接口启动备份计划。', + 'type' => 'boolean', + 'example' => 'false', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'Request.Forbidden', + 'errorMessage' => 'Have no Permissions', + 'description' => '当前操作未被授权，请联系主账号在RAM控制台进行授权后再执行操作', + ], + ], + ], + 'title' => '修改备份时间', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + [ + 'createdAt' => '2022-07-12T03:53:30.000Z', + 'description' => '错误码发生变更', + ], + ], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '10', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'ModifyBackupStrategy', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dbs:ModifyBackupStrategy', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DBS', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"D6E068C3-25BC-455A-85FE-45F0B22ECB1F\\",\\n \\"ErrCode\\": \\"Param.NotFound\\",\\n \\"Success\\": true,\\n \\"ErrMessage\\": \\"The specified parameter %s value is not valid. \\",\\n \\"BackupPlanId\\": \\"dbstooi01XXXX\\",\\n \\"NeedPrecheck\\": false\\n}","errorExample":""},{"type":"xml","example":"\\n D6E068C3-25BC-455A-85FE-45F0B22ECB1F\\n 200\\n dbs1h****usfa\\n false\\n true\\n","errorExample":""}]', + ], + 'ModifyStorageStrategy' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREcbsKR7J6S', + ], + ], + 'parameters' => [ + [ + 'name' => 'BackupPlanId', + 'in' => 'query', + 'schema' => [ + 'description' => '备份计划ID，可通过调用[DescribeBackupPlanList](~~2869825~~)接口获取该参数的值。', + 'type' => 'string', + 'required' => true, + 'example' => 'dbsqdss5tmh****', + ], + ], + [ + 'name' => 'BackupRetentionPeriod', + 'in' => 'query', + 'schema' => [ + 'description' => '备份数据保留时间，单位为天，取值：0~1825。'."\n" + ."\n" + .'> 默认为730（天）。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '730', + ], + ], + [ + 'name' => 'DuplicationInfrequentAccessPeriod', + 'in' => 'query', + 'schema' => [ + 'description' => '转为低频访问存储时间。需要小于归档冷备存储时间（DuplicationArchivePeriod参数）。更多关于低频访问存储的说明，请参见[存储类型介绍](~~51374~~)。'."\n" + .'> 默认为180（天）。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '190', + ], + ], + [ + 'name' => 'DuplicationArchivePeriod', + 'in' => 'query', + 'schema' => [ + 'description' => '转为归档冷备存储时间。需要小于备份数据保留时间（BackupRetentionPeriod参数）。更多关于归档存储的说明，请参见[存储类型介绍](~~51374~~)。'."\n" + .'> 默认为365（天）。'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '366', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => '任意字符串，用于保证请求的幂等性，防止重复提交请求。', + 'type' => 'string', + 'required' => false, + 'example' => 'dbstest', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回参数详情。', + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'HTTP状态码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'E995F91F-6F89-503B-9F7D-502F58FD****', + ], + 'ErrCode' => [ + 'description' => '错误码。', + 'type' => 'string', + 'example' => 'Param.NotFound', + ], + 'Success' => [ + 'description' => '请求是否成功，返回值如下：'."\n" + .'- **true**：请求成功'."\n" + .'- **false**：请求失败', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ErrMessage' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'findValidDBSJob error', + ], + 'BackupPlanId' => [ + 'description' => '备份计划ID。', + 'type' => 'string', + 'example' => 'dbsqdss5tmh****', + ], + 'NeedPrecheck' => [ + 'description' => '本次修改是否会触发预检查，返回值如下：'."\n" + ."\n" + .'- **true**：已触发预检查，且需要您手动调用[StartBackupPlan](~~2869818~~)接口，启动备份计划。'."\n" + .'- **false**：不会触发预检查。', + 'type' => 'boolean', + 'example' => 'false', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'Request.Forbidden', + 'errorMessage' => 'Have no Permissions', + 'description' => '当前操作未被授权，请联系主账号在RAM控制台进行授权后再执行操作', + ], + ], + ], + 'title' => '修改存储数据的生命周期', + 'summary' => '该接口用于修改备份计划中的存储数据的生命周期。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + [ + 'createdAt' => '2022-07-12T03:53:30.000Z', + 'description' => '错误码发生变更', + ], + ], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '10', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'ModifyStorageStrategy', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dbs:ModifyStorageStrategy', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DBS', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"E995F91F-6F89-503B-9F7D-502F58FD****\\",\\n \\"ErrCode\\": \\"Param.NotFound\\",\\n \\"Success\\": true,\\n \\"ErrMessage\\": \\"findValidDBSJob error\\",\\n \\"BackupPlanId\\": \\"dbsqdss5tmh****\\",\\n \\"NeedPrecheck\\": false\\n}","errorExample":""},{"type":"xml","example":"\\n E995F91F-6F89-503B-9F7D-502F58FD****\\n 200\\n dbsqdss5tmh****\\n false\\n true\\n","errorExample":""}]', + ], + 'ReleaseBackupPlan' => [ + 'summary' => '该接口仅支持释放一个按量付费的备份计划。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREcbsKR7J6S', + ], + ], + 'parameters' => [ + [ + 'name' => 'BackupPlanId', + 'in' => 'query', + 'schema' => [ + 'description' => '备份计划ID。您可以调用[DescribeBackupPlanList](~~2869825~~)查询。', + 'type' => 'string', + 'required' => true, + 'example' => 'dbstooi01xxxx', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => '任意字符串。', + 'type' => 'string', + 'required' => false, + 'example' => 'dbs', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'HTTP状态码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'D6E068C3-25BC-455A-85FE-45F0B22ECB1F', + ], + 'ErrCode' => [ + 'description' => '错误码。', + 'type' => 'string', + 'example' => 'Param.NotFound', + ], + 'Success' => [ + 'description' => '是否执行成功。返回值：'."\n" + .'- true：执行成功'."\n" + .'- false：执行失败', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ErrMessage' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'findValidDBSJob error', + ], + 'BackupPlanId' => [ + 'description' => '备份计划ID。', + 'type' => 'string', + 'example' => 'dbstooi01xxxx', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'Request.Forbidden', + 'errorMessage' => 'Have no Permissions', + 'description' => '当前操作未被授权，请联系主账号在RAM控制台进行授权后再执行操作', + ], + ], + ], + 'title' => '释放备份计划', + 'description' => '## 影响'."\n" + .'释放后，您的备份实例即会停止服务，不再产生费用。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + [ + 'createdAt' => '2022-07-12T03:53:30.000Z', + 'description' => '错误码发生变更', + ], + ], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '10', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'ReleaseBackupPlan', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'dbs:ReleaseBackupPlan', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DBS', + 'resourceType' => 'BackupPlan', + 'arn' => 'acs:dbs:{#regionId}:{#accountId}:backupplan/{#BackupPlanId}', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"D6E068C3-25BC-455A-85FE-45F0B22ECB1F\\",\\n \\"ErrCode\\": \\"Param.NotFound\\",\\n \\"Success\\": true,\\n \\"ErrMessage\\": \\"findValidDBSJob error\\",\\n \\"BackupPlanId\\": \\"dbstooi01xxxx\\"\\n}","errorExample":""},{"type":"xml","example":"D6E068C3-25BC-455A-85FE-45F0B22ECB1F\\n200\\ndbstooi01xxxx\\nfindValidDBSJob error\\nfalse\\nParam.NotFound","errorExample":""}]', + ], + 'RenewBackupPlan' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREcbsKR7J6S', + ], + ], + 'parameters' => [ + [ + 'name' => 'BackupPlanId', + 'in' => 'query', + 'schema' => [ + 'description' => '备份计划ID，可通过调用[DescribeBackupPlanList](~~2869825~~)接口获取此参数的值。', + 'type' => 'string', + 'required' => true, + 'example' => 'dbstooi01exxx', + ], + ], + [ + 'name' => 'Period', + 'in' => 'query', + 'schema' => [ + 'description' => '指定预付费实例为包年或者包月类型，取值：'."\n" + .'- Year：包年'."\n" + .'- Month：包月', + 'type' => 'string', + 'required' => true, + 'example' => 'Month', + ], + ], + [ + 'name' => 'UsedTime', + 'in' => 'query', + 'schema' => [ + 'description' => '指定购买时长，取值：'."\n" + .'- 当参数Period为Year时，UsedTime取值为1~5。'."\n" + .'- 当参数Period为Month时，UsedTime取值为1~11。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => '用于保证请求的幂等性，防止重复提交请求。', + 'type' => 'string', + 'required' => false, + 'example' => 'HKAJHFIUEQWBFIJSNFOIWHN', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'Http状态码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'D6E068C3-25BC-455A-85FE-45F0B22ECB1F', + ], + 'ErrCode' => [ + 'description' => '错误码。', + 'type' => 'string', + 'example' => 'Param.NotFound', + ], + 'Success' => [ + 'description' => '是否调用成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ErrMessage' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'The specified parameter %s value is not valid. ', + ], + 'BackupPlanId' => [ + 'description' => '备份计划ID。', + 'type' => 'string', + 'example' => 'dbstooi01exxx', + ], + 'OrderId' => [ + 'description' => '订单ID。', + 'type' => 'string', + 'example' => '202020202020', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'Request.Forbidden', + 'errorMessage' => 'Have no Permissions', + 'description' => '当前操作未被授权，请联系主账号在RAM控制台进行授权后再执行操作', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'title' => '续费备份计划', + 'summary' => '该接口用于续费一个DBS备份计划。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + [ + 'createdAt' => '2022-07-12T03:53:31.000Z', + 'description' => '错误码发生变更', + ], + ], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '10', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'RenewBackupPlan', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dbs:RenewBackupPlan', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DBS', + 'resourceType' => 'BackupPlan', + 'arn' => 'acs:dbs:{#regionId}:{#accountId}:backupplan/{#BackupPlanId}', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"D6E068C3-25BC-455A-85FE-45F0B22ECB1F\\",\\n \\"ErrCode\\": \\"Param.NotFound\\",\\n \\"Success\\": true,\\n \\"ErrMessage\\": \\"The specified parameter %s value is not valid. \\",\\n \\"BackupPlanId\\": \\"dbstooi01exxx\\",\\n \\"OrderId\\": \\"202020202020\\"\\n}","errorExample":""},{"type":"xml","example":"\\nD6E068C3-25BC-455A-85FE-45F0B22ECB1F\\n200\\ndbs1h****usfa\\n2056157****\\ntrue\\n","errorExample":""}]', + ], + 'StartBackupPlan' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREcbsKR7J6S', + ], + ], + 'parameters' => [ + [ + 'name' => 'BackupPlanId', + 'in' => 'query', + 'schema' => [ + 'description' => '备份计划ID，可通过调用[DescribeBackupPlanList](~~2869825~~)接口获取该参数的值。', + 'type' => 'string', + 'required' => true, + 'example' => 'dbsqdss5tmh****', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => '用于保证请求的幂等性，防止重复提交请求。', + 'type' => 'string', + 'required' => false, + 'example' => 'ETnLKlblzczshOTUbOCzxxxxxxx', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回详情信息。', + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'HTTP·状态码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'D13761C3-9971-5C02-B789-3F3CD159****', + ], + 'ErrCode' => [ + 'description' => '错误码。', + 'type' => 'string', + 'example' => 'Param.NotFound', + ], + 'Success' => [ + 'description' => '请求是否成功，返回值如下：'."\n" + .'- **true**：请求成功'."\n" + .'- **false**：请求失败', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ErrMessage' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'The specified parameter %s value is not valid. ', + ], + 'CreatedFullBackupsetId' => [ + 'description' => '全量备份集ID。', + 'type' => 'string', + 'example' => '1h7toien3****', + ], + 'BackupPlanId' => [ + 'description' => '备份计划ID。', + 'type' => 'string', + 'example' => 'dbsqdss5tm****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'Request.Forbidden', + 'errorMessage' => 'Have no Permissions', + 'description' => '当前操作未被授权，请联系主账号在RAM控制台进行授权后再执行操作', + ], + ], + ], + 'title' => '启动备份计划', + 'summary' => '该接口用于启动一个DBS备份计划。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + [ + 'createdAt' => '2022-07-12T03:53:30.000Z', + 'description' => '错误码发生变更', + ], + ], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '10', + 'countWindow' => 60, + 'regionId' => '*', + 'api' => 'StartBackupPlan', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dbs:StartBackupPlan', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DBS', + 'resourceType' => 'BackupPlan', + 'arn' => 'acs:dbs:{#regionId}:{#accountId}:backupplan/{#BackupPlanId}', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"D13761C3-9971-5C02-B789-3F3CD159****\\",\\n \\"ErrCode\\": \\"Param.NotFound\\",\\n \\"Success\\": true,\\n \\"ErrMessage\\": \\"The specified parameter %s value is not valid. \\",\\n \\"CreatedFullBackupsetId\\": \\"1h7toien3****\\",\\n \\"BackupPlanId\\": \\"dbsqdss5tm****\\"\\n}","errorExample":""},{"type":"xml","example":"\\n D13761C3-9971-5C02-B789-3F3CD159****\\n 200\\n dbsqdss5tmh***\\n 1h7toien3****\\n true\\n","errorExample":""}]', + ], + 'StartRestoreTask' => [ + 'summary' => '该接口用于启动一个DBS恢复任务。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREcbsKR7J6S', + ], + ], + 'parameters' => [ + [ + 'name' => 'RestoreTaskId', + 'in' => 'query', + 'schema' => [ + 'description' => '恢复任务ID。', + 'type' => 'string', + 'required' => true, + 'example' => 's102h7rfXXXX', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => '用于保证请求的幂等性，防止重复提交请求。', + 'type' => 'string', + 'required' => false, + 'example' => 'ETnLKlblzczshOTUbOCzxxxxxxx', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'HTTP状态码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '60AF7C5D-EF4D-4D48-8FD5-C0823FDF28AC', + ], + 'ErrCode' => [ + 'description' => '错误码。', + 'type' => 'string', + 'example' => 'Param.NotFound', + ], + 'Success' => [ + 'description' => '是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ErrMessage' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'The specified parameter %s value is not valid.', + ], + 'RestoreTaskId' => [ + 'description' => '恢复任务ID。', + 'type' => 'string', + 'example' => 's102h7rfXXXX', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'Request.Forbidden', + 'errorMessage' => 'Have no Permissions', + 'description' => '当前操作未被授权，请联系主账号在RAM控制台进行授权后再执行操作', + ], + ], + ], + 'title' => '启动恢复任务', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + [ + 'createdAt' => '2022-07-12T03:53:30.000Z', + 'description' => '错误码发生变更', + ], + ], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '10000', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'StartRestoreTask', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dbs:StartRestoreTask', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DBS', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"60AF7C5D-EF4D-4D48-8FD5-C0823FDF28AC\\",\\n \\"ErrCode\\": \\"Param.NotFound\\",\\n \\"Success\\": true,\\n \\"ErrMessage\\": \\"The specified parameter %s value is not valid.\\",\\n \\"RestoreTaskId\\": \\"s102h7rfXXXX\\"\\n}","errorExample":""},{"type":"xml","example":"s102h7rf5anq\\n60AF7C5D-EF4D-4D48-8FD5-C0823FDF28AC\\n200\\ntrue","errorExample":""}]', + ], + 'StopBackupPlan' => [ + 'summary' => '该接口用于暂停一个DBS备份计划。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREcbsKR7J6S', + ], + ], + 'parameters' => [ + [ + 'name' => 'BackupPlanId', + 'in' => 'query', + 'schema' => [ + 'description' => '备份计划ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'dbstooi01XXXX', + ], + ], + [ + 'name' => 'StopMethod', + 'in' => 'query', + 'schema' => [ + 'description' => '暂停方式，取值：'."\n" + .'- ALL：暂停备份计划、全量数据备份任务、增量日志备份任务、恢复任务'."\n" + .'- PLAN：只暂停备份计划'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'ALL', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => '用于保证请求的幂等性，防止重复提交请求。', + 'type' => 'string', + 'required' => false, + 'example' => 'ETnLKlblzczshOTUbOCzxxxxxxx', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'HTTP状态码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'D6E068C3-25BC-455A-85FE-45F0B22ECB1F', + ], + 'ErrCode' => [ + 'description' => '错误码。', + 'type' => 'string', + 'example' => 'Param.NotFound', + ], + 'Success' => [ + 'description' => '是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ErrMessage' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'The specified parameter %s value is not valid. ', + ], + 'BackupPlanId' => [ + 'description' => '备份计划ID。', + 'type' => 'string', + 'example' => 'dbs1h****usfa', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'Request.Forbidden', + 'errorMessage' => 'Have no Permissions', + 'description' => '当前操作未被授权，请联系主账号在RAM控制台进行授权后再执行操作', + ], + ], + ], + 'title' => '暂停备份计划', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + [ + 'createdAt' => '2022-07-12T03:53:31.000Z', + 'description' => '错误码发生变更', + ], + ], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '10', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'StopBackupPlan', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dbs:StopBackupPlan', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DBS', + 'resourceType' => 'BackupPlan', + 'arn' => 'acs:dbs:{#regionId}:{#accountId}:backupplan/{#BackupPlanId}', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"D6E068C3-25BC-455A-85FE-45F0B22ECB1F\\",\\n \\"ErrCode\\": \\"Param.NotFound\\",\\n \\"Success\\": true,\\n \\"ErrMessage\\": \\"The specified parameter %s value is not valid. \\",\\n \\"BackupPlanId\\": \\"dbs1h****usfa\\"\\n}","errorExample":""},{"type":"xml","example":"\\nD6E068C3-25BC-455A-85FE-45F0B22ECB1F\\n200\\ndbs1h****usfa\\ntrue\\n","errorExample":""}]', + ], + 'UpgradeBackupPlan' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREcbsKR7J6S', + ], + ], + 'parameters' => [ + [ + 'name' => 'BackupPlanId', + 'in' => 'query', + 'schema' => [ + 'description' => '备份计划ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'dbstooi01eXXXX', + ], + ], + [ + 'name' => 'InstanceClass', + 'in' => 'query', + 'schema' => [ + 'description' => '规格，取值：'."\n" + .'- micro'."\n" + .'- small'."\n" + .'- medium'."\n" + .'- large'."\n" + .'- xlarge', + 'type' => 'string', + 'required' => true, + 'example' => 'micro', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => '用于保证请求的幂等性，防止重复提交请求。', + 'type' => 'string', + 'required' => false, + 'example' => 'ETnLKlblzczshOTUbOCzxxxxxxx', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'Http状态码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'D6E068C3-25BC-455A-85FE-45F0B22ECB1F', + ], + 'ErrCode' => [ + 'description' => '错误码。', + 'type' => 'string', + 'example' => 'Param.NotFound', + ], + 'Success' => [ + 'description' => '是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ErrMessage' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'The specified parameter %s value is not valid. ', + ], + 'BackupPlanId' => [ + 'description' => '备份计划ID。', + 'type' => 'string', + 'example' => 'dbstooi01XXXX', + ], + 'OrderId' => [ + 'description' => '订单ID。', + 'type' => 'string', + 'example' => '2056157****', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'Request.Forbidden', + 'errorMessage' => 'Have no Permissions', + 'description' => '当前操作未被授权，请联系主账号在RAM控制台进行授权后再执行操作', + ], + ], + ], + 'title' => '升级备份计划', + 'summary' => '该接口用于升级一个DBS备份计划。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + [ + 'createdAt' => '2022-07-12T03:53:30.000Z', + 'description' => '错误码发生变更', + ], + ], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '10', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'UpgradeBackupPlan', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dbs:UpgradeBackupPlan', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DBS', + 'resourceType' => 'BackupPlan', + 'arn' => 'acs:dbs:{#regionId}:{#accountId}:backupplan/{#BackupPlanId}', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"D6E068C3-25BC-455A-85FE-45F0B22ECB1F\\",\\n \\"ErrCode\\": \\"Param.NotFound\\",\\n \\"Success\\": true,\\n \\"ErrMessage\\": \\"The specified parameter %s value is not valid. \\",\\n \\"BackupPlanId\\": \\"dbstooi01XXXX\\",\\n \\"OrderId\\": \\"2056157****\\"\\n}","errorExample":""},{"type":"xml","example":"\\nD6E068C3-25BC-455A-85FE-45F0B22ECB1F\\n200\\ndbs1h****usfa\\n2056157****\\ntrue\\n","errorExample":""}]', + ], + ], + 'endpoints' => [ + [ + 'regionId' => 'cn-wulanchabu', + 'regionName' => '华北6（乌兰察布）', + 'areaId' => 'asiaPacific', + 'areaName' => '亚太', + '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' => '华北2（北京）', + 'areaId' => 'asiaPacific', + 'areaName' => '亚太', + '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' => '华北1（青岛）', + 'areaId' => 'asiaPacific', + 'areaName' => '亚太', + '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' => '华东2（上海）', + 'areaId' => 'asiaPacific', + 'areaName' => '亚太', + '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' => '中国香港', + 'areaId' => 'asiaPacific', + 'areaName' => '亚太', + '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' => '华北3（张家口）', + 'areaId' => 'asiaPacific', + 'areaName' => '亚太', + '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' => '华南1（深圳）', + 'areaId' => 'asiaPacific', + 'areaName' => '亚太', + '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' => '日本（东京）', + 'areaId' => 'asiaPacific', + 'areaName' => '亚太', + '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' => '西南1（成都）', + 'areaId' => 'asiaPacific', + 'areaName' => '亚太', + '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' => '新加坡', + 'areaId' => 'asiaPacific', + 'areaName' => '亚太', + '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' => '马来西亚（吉隆坡）', + 'areaId' => 'asiaPacific', + 'areaName' => '亚太', + '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' => '华北5（呼和浩特）', + 'areaId' => 'asiaPacific', + 'areaName' => '亚太', + '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' => '印度尼西亚（雅加达）', + 'areaId' => 'asiaPacific', + 'areaName' => '亚太', + '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' => '华东1（杭州）', + 'areaId' => 'asiaPacific', + 'areaName' => '亚太', + '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' => '美国（弗吉尼亚）', + 'areaId' => 'europeAmerica', + 'areaName' => '欧洲与美洲', + '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' => '英国（伦敦）', + 'areaId' => 'europeAmerica', + 'areaName' => '欧洲与美洲', + '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' => '美国（硅谷）', + 'areaId' => 'europeAmerica', + 'areaName' => '欧洲与美洲', + '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' => '德国（法兰克福）', + 'areaId' => 'europeAmerica', + 'areaName' => '欧洲与美洲', + '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' => '华南1 金融云', + 'areaId' => 'industryCloud', + 'areaName' => '行业云', + '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' => '华东2 金融云', + 'areaId' => 'industryCloud', + 'areaName' => '行业云', + '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' => '华东1 金融云', + 'areaId' => 'industryCloud', + 'areaName' => '行业云', + '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' => '备份计划配置错误', + ], + [ + 'code' => 'BackupPlanNotDescribe', + 'message' => 'describe backup plan failed -> null', + 'http_code' => 200, + 'description' => '查询备份计划列表失败', + ], + [ + 'code' => 'BackupPlanNotModify', + 'message' => 'modify backup source endpoint fail', + 'http_code' => 200, + 'description' => '修改备份源endpoint失败', + ], + [ + 'code' => 'DBS.DisasterCenter.NoPermission', + 'message' => 'no permission for this action.', + 'http_code' => 403, + 'description' => '该操作无权限。', + ], + [ + 'code' => 'DBS.DownloadTask.CannotFind', + 'message' => 'Can not find download task.', + 'http_code' => 200, + 'description' => '无法找到高级下载任务。', + ], + [ + 'code' => 'DBS.DownloadTask.JobAlreadyExist', + 'message' => 'Job already submit in recent days, please check it.', + 'http_code' => 200, + 'description' => '相同备份集的高级下载任务在近几天被提交过，请检查。', + ], + [ + 'code' => 'DBS.DownloadTask.OnlyOneRunningOrFailedTask', + 'message' => 'There can be only one running or failed task for the instance.', + 'http_code' => 200, + 'description' => '当前实例只能同时存在一个运行中/失败的任务。', + ], + [ + 'code' => 'DBS.DownloadTask.OssForbid', + 'message' => 'OSS is forbidden to access. Please check your OSS bucket.', + 'http_code' => 200, + 'description' => '访问OSS被拒绝。请检查您的OSS权限配置。', + ], + [ + 'code' => 'DBS.DownloadTask.OssStorageTypeInvalid', + 'message' => 'Unsupported bucket storage. Please make sure that your OSS bucket\'s storgae type is standard.', + 'http_code' => 200, + 'description' => '当前OSS bucket类型不支持。请确保您的OSS bucket类型是标准存储类型。', + ], + [ + 'code' => 'DBS.NoPermissionException', + 'message' => 'Rejected by ValidationChecker.', + 'http_code' => 403, + 'description' => 'Rejected by ValidationChecker.', + ], + [ + 'code' => 'DBS.NotExists', + 'message' => 'data source do not existed.', + 'http_code' => 404, + 'description' => 'DBS.NotExists', + ], + [ + 'code' => 'Forbidden.InstanceNotFound', + 'message' => 'instance not found', + 'http_code' => 200, + 'description' => '实例不存在', + ], + [ + 'code' => 'InternalError', + 'message' => 'internal error', + 'http_code' => 500, + 'description' => '内部错误', + ], + [ + 'code' => 'OperationDenied.JobStatus', + 'message' => 'The operation is not permitted.', + 'http_code' => 200, + 'description' => '当前操作不被允许', + ], + [ + 'code' => 'Request.Forbidden', + 'message' => 'Have no Permissions', + 'http_code' => 403, + 'description' => '当前操作未被授权，请联系主账号在RAM控制台进行授权后再执行操作', + ], + [ + 'code' => 'UserError', + 'message' => 'user error', + 'http_code' => 200, + 'description' => '用户使用问题', + ], + [ + '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' => '响应参数发生变更', + 'api' => 'DescribeBackupPlanList', + ], + ], + 'createdAt' => '2023-03-28T07:34:58.000Z', + 'description' => '', + ], + [ + 'apis' => [ + [ + 'description' => '响应参数发生变更', + 'api' => 'DescribeBackupPlanBilling', + ], + ], + 'createdAt' => '2022-08-18T07:57:14.000Z', + 'description' => '审计', + ], + [ + 'apis' => [ + [ + 'description' => '响应参数发生变更', + 'api' => 'DescribeBackupPlanList', + ], + ], + 'createdAt' => '2022-08-12T03:51:35.000Z', + 'description' => '接入rmc', + ], + [ + 'apis' => [ + [ + 'description' => '请求参数发生变更', + 'api' => 'ConfigureBackupPlan', + ], + ], + 'createdAt' => '2022-07-28T07:13:26.000Z', + 'description' => '操作审计', + ], + [ + 'apis' => [ + [ + 'description' => '请求参数发生变更', + 'api' => 'CreateAndStartBackupPlan', + ], + [ + 'description' => '请求参数发生变更', + 'api' => 'CreateBackupPlan', + ], + [ + 'description' => '响应参数发生变更', + 'api' => 'DescribeBackupPlanBilling', + ], + [ + 'description' => '请求参数发生变更、响应参数发生变更', + 'api' => 'DescribeBackupPlanList', + ], + ], + 'createdAt' => '2022-07-28T06:54:59.000Z', + 'description' => '操作审计', + ], + [ + 'apis' => [ + [ + 'description' => '错误码发生变更', + 'api' => 'ConfigureBackupPlan', + ], + [ + 'description' => '错误码发生变更', + 'api' => 'CreateAndStartBackupPlan', + ], + [ + 'description' => '错误码发生变更', + 'api' => 'CreateBackupPlan', + ], + [ + 'description' => '错误码发生变更', + 'api' => 'CreateFullBackupSetDownload', + ], + [ + 'description' => '错误码发生变更', + 'api' => 'CreateGetDBListFromAgentTask', + ], + [ + 'description' => '错误码发生变更', + 'api' => 'CreateIncrementBackupSetDownload', + ], + [ + 'description' => '错误码发生变更', + 'api' => 'CreateRestoreTask', + ], + [ + 'description' => '错误码发生变更', + 'api' => 'DescribeBackupGatewayList', + ], + [ + 'description' => '错误码发生变更', + 'api' => 'DescribeBackupPlanBilling', + ], + [ + 'description' => '错误码发生变更', + 'api' => 'DescribeBackupPlanList', + ], + ], + 'createdAt' => '2022-07-12T03:54:35.000Z', + 'description' => '补齐api信息', + ], + ], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '50', + 'countWindow' => 60, + 'regionId' => '*', + 'api' => 'DescribeBackupPlanList', + ], + [ + 'threshold' => '10', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'ModifyBackupSetDownloadRules', + ], + [ + 'threshold' => '10', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'ReleaseBackupPlan', + ], + [ + 'threshold' => '10', + 'countWindow' => 60, + 'regionId' => '*', + 'api' => 'StartBackupPlan', + ], + [ + 'threshold' => '10', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'RenewBackupPlan', + ], + [ + 'threshold' => '10', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'DescribeJobErrorCode', + ], + [ + 'threshold' => '100', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'GetDBListFromAgent', + ], + [ + 'threshold' => '10', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'ModifyStorageStrategy', + ], + [ + 'threshold' => '10', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'UpgradeBackupPlan', + ], + [ + 'threshold' => '10', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'DisableBackupLog', + ], + [ + 'threshold' => '10', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'ModifyBackupPlanName', + ], + [ + 'threshold' => '100', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'DescribeBackupSetDownloadTaskList', + ], + [ + 'threshold' => '100', + 'countWindow' => 60, + 'regionId' => '*', + 'api' => 'DescribeBackupGatewayList', + ], + [ + 'threshold' => '10', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'ModifyBackupSourceEndpoint', + ], + [ + 'threshold' => '100', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'DescribeRegions', + ], + [ + 'threshold' => '10', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'CreateAndStartBackupPlan', + ], + [ + 'threshold' => '10', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'CreateIncrementBackupSetDownload', + ], + [ + 'threshold' => '10', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'ModifyBackupStrategy', + ], + [ + 'threshold' => '100', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'DescribeRestoreRangeInfo', + ], + [ + 'threshold' => '10', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'CreateBackupPlan', + ], + [ + 'threshold' => '100', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'CreateGetDBListFromAgentTask', + ], + [ + 'threshold' => '100', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'DescribeFullBackupList', + ], + [ + 'threshold' => '100', + 'countWindow' => 60, + 'regionId' => '*', + 'api' => 'DescribeRestoreTaskList', + ], + [ + 'threshold' => '10', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'StopBackupPlan', + ], + [ + 'threshold' => '10', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'CreateFullBackupSetDownload', + ], + [ + 'threshold' => '10', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'DescribeDLAService', + ], + [ + 'threshold' => '100', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'DescribePreCheckProgressList', + ], + [ + 'threshold' => '10', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'EnableBackupLog', + ], + [ + 'threshold' => '10', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'ModifyBackupObjects', + ], + [ + 'threshold' => '10000', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'CreateRestoreTask', + ], + [ + 'threshold' => '100', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'DescribeIncrementBackupList', + ], + [ + 'threshold' => '10', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'ConfigureBackupPlan', + ], + [ + 'threshold' => '100', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'DescribeBackupPlanBilling', + ], + [ + 'threshold' => '-1', + 'countWindow' => 1, + 'regionId' => '*', + ], + [ + 'threshold' => '10000', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'StartRestoreTask', + ], + [ + 'threshold' => '100', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'DescribeNodeCidrList', + ], + ], + ], + 'ram' => [ + 'productCode' => 'DBS', + 'productName' => '数据库备份', + 'ramCodes' => [ + 'dbs', + ], + 'ramLevel' => '资源级', + 'ramConditions' => [], + 'ramActions' => [ + [ + 'apiName' => 'InitializeDbsServiceLinkedRole', + 'description' => '授权DBS服务关联角色', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'dbs:InitializeDbsServiceLinkedRole', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DBS', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'StartBackupPlan', + 'description' => '启动备份计划', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dbs:StartBackupPlan', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DBS', + 'resourceType' => 'BackupPlan', + 'arn' => 'acs:dbs:{#regionId}:{#accountId}:backupplan/{#BackupPlanId}', + ], + ], + ], + ], + [ + 'apiName' => 'RenewBackupPlan', + 'description' => '续费备份计划', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dbs:RenewBackupPlan', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DBS', + 'resourceType' => 'BackupPlan', + 'arn' => 'acs:dbs:{#regionId}:{#accountId}:backupplan/{#BackupPlanId}', + ], + ], + ], + ], + [ + 'apiName' => 'DescribeFullBackupList', + 'description' => '查看全量备份任务列表', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dbs:DescribeFullBackupList', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DBS', + 'resourceType' => 'BackupPlan', + 'arn' => 'acs:dbs:{#regionId}:{#accountId}:backupplan/{#BackupPlanId}', + ], + ], + ], + ], + [ + 'apiName' => 'CreateIncrementBackupSetDownload', + 'description' => '创建增量备份集下载任务', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'dbs:CreateIncrementBackupSetDownload', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DBS', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'CreateBackupPlan', + 'description' => '创建备份计划', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'dbs:CreateBackupPlan', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DBS', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'EnableBackupLog', + 'description' => '开启增量备份', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dbs:EnableBackupLog', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DBS', + 'resourceType' => 'BackupPlan', + 'arn' => 'acs:dbs:{#regionId}:{#accountId}:backupplan/{#BackupPlanId}', + ], + ], + ], + ], + [ + 'apiName' => 'ModifyBackupPlanName', + 'description' => '修改备份计划名称', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dbs:ModifyBackupPlanName', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DBS', + 'resourceType' => 'BackupPlan', + 'arn' => 'acs:dbs:{#regionId}:{#accountId}:backupplan/{#BackupPlanId}', + ], + ], + ], + ], + [ + 'apiName' => 'DisableBackupLog', + 'description' => '关闭增量备份', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dbs:DisableBackupLog', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DBS', + 'resourceType' => 'BackupPlan', + 'arn' => 'acs:dbs:{#regionId}:{#accountId}:backupplan/{#BackupPlanId}', + ], + ], + ], + ], + [ + 'apiName' => 'ModifyBackupSetDownloadRules', + 'description' => '设置备份集下载规则', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dbs:ModifyBackupSetDownloadRules', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DBS', + 'resourceType' => 'BackupPlan', + 'arn' => 'acs:dbs:{#regionId}:{#accountId}:backupplan/{#BackupPlanId}', + ], + ], + ], + ], + [ + 'apiName' => 'DescribeDLAService', + 'description' => '查看数据查询服务（DLA）', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dbs:DescribeDLAService', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DBS', + 'resourceType' => 'BackupPlan', + 'arn' => 'acs:dbs:{#regionId}:{#accountId}:backupplan/{#BackupPlanId}', + ], + ], + ], + ], + [ + 'apiName' => 'ModifyBackupObjects', + 'description' => '修改备份对象', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dbs:ModifyBackupObjects', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DBS', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'DescribeIncrementBackupList', + 'description' => '查看增量备份任务列表', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dbs:DescribeIncrementBackupList', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DBS', + 'resourceType' => 'BackupPlan', + 'arn' => 'acs:dbs:{#regionId}:{#accountId}:backupplan/{#BackupPlanId}', + ], + ], + ], + ], + [ + 'apiName' => 'StopBackupPlan', + 'description' => '暂停备份计划', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dbs:StopBackupPlan', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DBS', + 'resourceType' => 'BackupPlan', + 'arn' => 'acs:dbs:{#regionId}:{#accountId}:backupplan/{#BackupPlanId}', + ], + ], + ], + ], + [ + 'apiName' => 'CreateRestoreTask', + 'description' => '创建恢复任务', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'dbs:CreateRestoreTask', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DBS', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'UpgradeBackupPlan', + 'description' => '升级备份计划', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dbs:UpgradeBackupPlan', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DBS', + 'resourceType' => 'BackupPlan', + 'arn' => 'acs:dbs:{#regionId}:{#accountId}:backupplan/{#BackupPlanId}', + ], + ], + ], + ], + [ + 'apiName' => 'CreateGetDBListFromAgentTask', + 'description' => '创建数据库列表任务', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'dbs:CreateGetDBListFromAgentTask', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DBS', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'ConfigureBackupPlan', + 'description' => '配置备份计划', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dbs:ConfigureBackupPlan', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DBS', + 'resourceType' => 'BackupPlan', + 'arn' => 'acs:dbs:{#regionId}:{#accountId}:backupplan/{#BackupPlanId}', + ], + ], + ], + ], + [ + 'apiName' => 'CreateFullBackupSetDownload', + 'description' => '创建全量备份集下载任务', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'dbs:CreateFullBackupSetDownload', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DBS', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'ModifyStorageStrategy', + 'description' => '修改存储数据的生命周期', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dbs:ModifyStorageStrategy', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DBS', + 'resourceType' => 'BackupPlan', + 'arn' => 'acs:dbs:{#regionId}:{#accountId}:backupplan/{#BackupPlanId}', + ], + ], + ], + ], + [ + 'apiName' => 'CreateAndStartBackupPlan', + 'description' => '创建并启动备份计划', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'dbs:CreateAndStartBackupPlan', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DBS', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'ModifyBackupStrategy', + 'description' => '修改备份时间', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dbs:ModifyBackupStrategy', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DBS', + 'resourceType' => 'BackupPlan', + 'arn' => 'acs:dbs:{#regionId}:{#accountId}:backupplan/{#BackupPlanId}', + ], + ], + ], + ], + [ + 'apiName' => 'StartRestoreTask', + 'description' => '启动恢复任务', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dbs:StartRestoreTask', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DBS', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'DescribeNodeCidrList', + 'description' => '查看DBS运行节点网段', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dbs:DescribeNodeCidrList', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DBS', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'DescribeBackupGatewayList', + 'description' => '查看备份网关列表', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dbs:DescribeBackupGatewayList', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DBS', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'DescribeBackupSetDownloadTaskList', + 'description' => '查看备份集下载列表', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dbs:DescribeBackupSetDownloadTaskList', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DBS', + 'resourceType' => 'BackupPlan', + 'arn' => 'acs:dbs:{#regionId}:{#accountId}:backupplan/{#BackupPlanId}', + ], + ], + ], + ], + [ + 'apiName' => 'ReleaseBackupPlan', + 'description' => '释放备份计划', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'dbs:ReleaseBackupPlan', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DBS', + 'resourceType' => 'BackupPlan', + 'arn' => 'acs:dbs:{#regionId}:{#accountId}:backupplan/{#BackupPlanId}', + ], + ], + ], + ], + [ + 'apiName' => 'GetDBListFromAgent', + 'description' => '通过备份网关获取数据库列表', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dbs:GetDBListFromAgent', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DBS', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'DescribeRestoreRangeInfo', + 'description' => '查看可恢复时间段详情', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dbs:DescribeRestoreRangeInfo', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DBS', + 'resourceType' => 'BackupPlan', + 'arn' => 'acs:dbs:{#regionId}:{#accountId}:backupplan/{#BackupPlanId}', + ], + ], + ], + ], + [ + 'apiName' => 'DescribeBackupPlanList', + 'description' => '查看备份计划', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dbs:DescribeBackupPlanList', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DBS', + 'resourceType' => 'BackupPlan', + 'arn' => 'acs:dbs:{#regionId}:{#accountId}:backupplan/{#BackupPlanId}', + ], + ], + ], + ], + [ + 'apiName' => 'DescribeRegions', + 'description' => '查看DBS支持地域', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dbs:DescribeRegions', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DBS', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'DescribePreCheckProgressList', + 'description' => '查看预检查进度列表', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dbs:DescribePreCheckProgressList', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DBS', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'DescribeRestoreTaskList', + 'description' => '查看恢复任务列表', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dbs:DescribeRestoreTaskList', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DBS', + 'resourceType' => 'BackupPlan', + 'arn' => 'acs:dbs:{#regionId}:{#accountId}:backupplan/{#BackupPlanId}', + ], + ], + ], + ], + [ + 'apiName' => 'DescribeJobErrorCode', + 'description' => '查看任务错误码信息', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dbs:DescribeJobErrorCode', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DBS', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'DescribeBackupPlanBilling', + 'description' => '查看备份计划计费信息', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dbs:DescribeBackupPlanBilling', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DBS', + 'resourceType' => 'BackupPlan', + 'arn' => 'acs:dbs:{#regionId}:{#accountId}:backupplan/{#BackupPlanId}', + ], + ], + ], + ], + [ + 'apiName' => 'ModifyBackupSourceEndpoint', + 'description' => '修改数据库备份源', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dbs:ModifyBackupSourceEndpoint', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DBS', + 'resourceType' => 'BackupPlan', + 'arn' => 'acs:dbs:{#regionId}:{#accountId}:backupplan/{#BackupPlanId}', + ], + ], + ], + ], + ], + 'resourceTypes' => [ + [ + 'validationType' => 'always', + 'resourceType' => 'BackupPlan', + 'arn' => 'acs:dbs:{#regionId}:{#accountId}:backupplan/{#BackupPlanId}', + ], + [ + 'validationType' => 'always', + 'resourceType' => 'BackupPlan', + 'arn' => 'acs:dbs:{#regionId}:{#accountId}:backupplan/*', + ], + [ + 'validationType' => 'always', + 'resourceType' => 'RestoreTask', + 'arn' => 'acs:dbs:{#regionId}:{#accountId}:restoretask/{#RestoreTaskId}', + ], + ], + ], +]; diff --git a/data/zh_cn/dbs/2021-01-01/api-docs.php b/data/zh_cn/dbs/2021-01-01/api-docs.php new file mode 100644 index 0000000..bb53bf8 --- /dev/null +++ b/data/zh_cn/dbs/2021-01-01/api-docs.php @@ -0,0 +1,5073 @@ + '1.0', + 'info' => [ + 'style' => 'RPC', + 'product' => 'Dbs', + 'version' => '2021-01-01', + ], + 'directories' => [ + [ + 'children' => [ + 'DescribeDownloadBackupSetStorageInfo', + 'DescribeDownloadSupport', + 'CreateDownload', + 'DescribeDownloadTask', + 'RetryDownloadTask', + ], + 'type' => 'directory', + 'title' => '高级下载', + 'id' => 47065, + ], + [ + 'children' => [ + 'ChangeResourceGroup', + 'DescribeBackupPolicy', + 'DescribeBackupDataList', + 'CreateAdvancedPolicy', + 'ModifyBackupPolicy', + 'DeleteSandboxInstance', + 'DescribeSandboxRecoveryTime', + 'DescribeSandboxInstances', + 'DescribeSandboxBackupSets', + 'DescribeCostInfoByDbsInstance', + ], + 'type' => 'directory', + 'title' => '其他', + 'id' => 47070, + ], + ], + 'components' => [ + 'schemas' => [], + ], + 'apis' => [ + 'ChangeResourceGroup' => [ + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'ResourceId', + 'in' => 'query', + 'schema' => [ + 'description' => '资源ID。 ', + 'type' => 'string', + 'required' => true, + 'example' => 'dbs1jyajqk******', + ], + ], + [ + 'name' => 'NewResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '要替换的新的资源组ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'rg-aekz4kee6******', + ], + ], + [ + 'name' => 'ResourceType', + 'in' => 'query', + 'schema' => [ + 'description' => '资源类型，固定为backupplan。', + 'type' => 'string', + 'required' => true, + 'example' => 'backupplan', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => '用于保证请求的幂等性，防止重复提交请求。', + 'type' => 'string', + 'required' => false, + 'example' => 'dbs', + ], + ], + [ + 'name' => 'RegionCode', + 'in' => 'query', + 'schema' => [ + 'description' => '实例所在地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Data' => [ + 'description' => '是否转组成功，返回值如下：'."\n" + ."\n" + .'- **true**：成功'."\n" + .'- **false**：失败', + 'type' => 'string', + 'example' => 'true', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '04EBD9F5-F06F-5302-8499-005C72*******', + ], + 'ErrCode' => [ + 'description' => '调用出错时返回的错误码。', + 'type' => 'string', + 'example' => 'Request.Forbidden', + ], + 'Success' => [ + 'description' => '请求是否成功，返回值如下：'."\n" + .'- **true**：请求成功'."\n" + .'- **false**：请求失败', + 'type' => 'string', + 'example' => 'true', + ], + 'ErrMessage' => [ + 'description' => '调用错误时返回的错误信息。'."\n", + 'type' => 'string', + 'example' => 'RAM DENY', + ], + 'Code' => [ + 'description' => '接口状态码。', + 'type' => 'string', + 'example' => 'Param.NotFound', + ], + 'Message' => [ + 'description' => '附加信息', + 'type' => 'string', + 'example' => 'The resource group is forbidden to operate', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'Request.Forbidden', + 'errorMessage' => 'Have no Permissions', + 'description' => '当前操作未被授权，请联系主账号在RAM控制台进行授权后再执行操作', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'title' => 'DBS资源转组API', + 'summary' => '资源转组。', + 'changeSet' => [ + [ + 'createdAt' => '2023-12-22T02:05:16.000Z', + 'description' => '请求参数发生变更', + ], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dbs:ChangeResourceGroup', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DBS', + 'resourceType' => '全部资源', + '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' => [ + 'title' => '地域', + 'description' => '备份集所在地域。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + ], + ], + [ + 'name' => 'InstanceName', + 'in' => 'query', + 'schema' => [ + 'title' => '实例名', + 'description' => 'PolarDB实例ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'pc-2ze3nrr64c5****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回参数详情。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '1EFBAC73-4A72-5AD0-BE27-932491FCB848', + ], + 'Message' => [ + 'description' => '返回信息。', + 'type' => 'string', + 'example' => 'instanceName can not be empty.', + ], + 'Data' => [ + 'description' => '高级备份策略是否生效，返回值如下：'."\n" + ."\n" + .'- **true**：生效'."\n" + .'- **false**：未生效', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ErrMessage' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'The specified parameter %s value is not valid. ', + ], + 'Code' => [ + 'description' => '状态码。', + 'type' => 'string', + 'example' => 'Success', + ], + 'Success' => [ + 'description' => '是否执行成功。返回值：'."\n" + .'- true：执行成功'."\n" + .'- false：执行失败', + 'type' => 'string', + 'example' => 'true', + ], + 'ErrCode' => [ + 'description' => '错误码。', + 'type' => 'string', + 'example' => 'Success', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'Request.Forbidden', + 'errorMessage' => 'Have no Permissions', + 'description' => '当前操作未被授权，请联系主账号在RAM控制台进行授权后再执行操作', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'title' => '开启高级备份策略', + 'summary' => '为PolarDB实例开启高级备份策略。', + 'description' => '### 适用引擎'."\n" + .'PolarDB MySQL版'."\n" + ."\n" + .'> 当前该接口仅针对特定客户开放使用，如有需求，请到DBS客户咨询群（钉钉群号：35585947）申请使用。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dbs:CreateAdvancedPolicy', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DBS', + 'resourceType' => '全部资源', + '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' => '创建高级下载任务。', + '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' => '实例所在地域ID，您可调用[DescribeDBInstanceAttribute（RDS实例）](~~26231~~)或[DescribeDBClusterAttribute（PolarDB实例）](~~2319132~~)查询。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-beijing', + ], + ], + [ + 'name' => 'InstanceName', + 'in' => 'query', + 'schema' => [ + 'description' => '实例ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'rm-wz994c1t1****', + ], + ], + [ + 'name' => 'BakSetType', + 'in' => 'query', + 'schema' => [ + 'description' => '下载任务类型，取值如下：'."\n" + ."\n" + .'- **full**：全量备份集下载。'."\n" + .'- **pitr**：任意时间点下载。', + 'type' => 'string', + 'required' => false, + 'example' => 'full', + ], + ], + [ + 'name' => 'BakSetId', + 'in' => 'query', + 'schema' => [ + 'description' => '备份集ID，您可调用[DescribeBackups（RDS实例）](~~26273~~)或[DescribeBackups（PolarDB实例）](~~2319224~~)接口获取该参数值。'."\n" + ."\n" + .'> 当BakSetType=full时，该参数必填。', + 'type' => 'string', + 'required' => false, + 'example' => '146005****', + ], + ], + [ + 'name' => 'DownloadPointInTime', + 'in' => 'query', + 'schema' => [ + 'description' => '下载任意时间点。Long类型时间戳形式，单位为毫秒（ms）。'."\n" + ."\n" + .'> 当BakSetType=pitr时，该参数必填。', + 'type' => 'string', + 'required' => false, + 'example' => '1661331864000', + ], + ], + [ + 'name' => 'BakSetSize', + 'in' => 'query', + 'schema' => [ + 'description' => '全量备份集大小，您可调用[DescribeBackups（RDS实例）](~~26273~~)或[DescribeBackups（PolarDB实例）](~~2319224~~)接口查询，单位为字节（Byte）。', + 'type' => 'string', + 'required' => false, + 'example' => '216****', + ], + ], + [ + 'name' => 'FormatType', + 'in' => 'query', + 'schema' => [ + 'description' => '下载转换的目标格式，取值如下：'."\n" + ."\n" + .'- **CSV**'."\n" + .'- **SQL**'."\n" + .'- **Parquet**'."\n" + ."\n" + .'> 该参数为必填项。', + 'type' => 'string', + 'required' => false, + 'example' => 'CSV', + ], + ], + [ + 'name' => 'TargetType', + 'in' => 'query', + 'schema' => [ + 'description' => '下载目标类型，取值如下：'."\n" + ."\n" + .'- **OSS**'."\n" + .'- **URL**', + 'type' => 'string', + 'required' => false, + 'example' => 'OSS', + ], + ], + [ + 'name' => 'TargetBucket', + 'in' => 'query', + 'schema' => [ + 'description' => 'OSS Bucket名称。'."\n" + ."\n" + .'- 当TargetType=OSS时，该参数必填。'."\n" + .'- 请确认您的账号已拥有**AliyunDBSDefaultRole**权限，如何授权，请参见[RAM资源授权](~~26307~~)。您也可访问控制台根据操作指引去授权。', + 'type' => 'string', + 'required' => false, + 'example' => 'test123', + ], + ], + [ + 'name' => 'TargetPath', + 'in' => 'query', + 'schema' => [ + 'description' => '数据下载目标路径。'."\n" + ."\n" + .'> 当TargetType=OSS时，该参数必填。', + 'type' => 'string', + 'required' => false, + 'example' => 'test_db/path', + ], + ], + [ + 'name' => 'TargetOssRegion', + 'in' => 'query', + 'schema' => [ + 'description' => 'OSS Bucket所在地域。'."\n" + ."\n" + .'> 当TargetType=OSS时，该参数必填。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-beijing', + ], + ], + [ + 'name' => 'PrimaryKeyTypeOnly', + 'in' => 'query', + 'schema' => [ + 'description' => '仅MongoDB引擎需要填写该字段。用于标识库表中主键类型是否唯一。'."\n" + .'是: true; 否: false。', + 'type' => 'string', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'IsCluster', + 'in' => 'query', + 'schema' => [ + 'description' => '仅MongoDB引擎需要填写该字段。用于标识当前实例是否为分片集群。'."\n" + .'类型为MongoDB分片集群: true; 类型为其他: false。', + 'type' => 'string', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'AdminDatabase', + 'in' => 'query', + 'schema' => [ + 'description' => '仅MongoDB引擎需要填写该字段。用于标识鉴权库名称。默认名称为admin。', + 'type' => 'string', + 'required' => false, + 'example' => 'admin', + ], + ], + [ + 'name' => 'UseZstd', + 'in' => 'query', + 'schema' => [ + 'description' => '用于标识压缩包采纳的压缩算法是否为zstd。默认为false。', + 'type' => 'string', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'ClusterName', + 'in' => 'query', + 'schema' => [ + 'description' => '仅MongoDB引擎分片集群需要填写该字段。分片集群ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'dds-0xid8e5336******', + ], + ], + [ + 'name' => 'IsPhysical', + 'in' => 'query', + 'schema' => [ + 'type' => 'boolean', + 'required' => false, + 'description' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回值如下。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'A08F908D-2C35-583F-93C1-ED80753F****', + ], + 'ErrCode' => [ + 'description' => '错误码。'."\n", + 'type' => 'string', + 'example' => 'DBS.ParamIsInValid', + ], + 'Success' => [ + 'description' => '请求是否成功，返回值如下：'."\n" + .'- **true**：请求成功。'."\n" + .'- **false**：请求失败。', + 'type' => 'string', + 'example' => 'true', + ], + 'ErrMessage' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'formatType can not be empty', + ], + 'Code' => [ + 'description' => '状态码。', + 'type' => 'string', + 'example' => 'DBS.ParamIsInValid', + ], + 'Message' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'formatType can not be empty', + ], + 'Data' => [ + 'description' => '返回数据如下。', + 'type' => 'object', + 'properties' => [ + 'BakSetId' => [ + 'description' => '全量备份集ID。', + 'type' => 'string', + 'example' => '146005****', + ], + 'DownloadStatus' => [ + 'description' => '下载任务的状态，返回值如下：'."\n" + ."\n" + .'- initializing：初始化。'."\n" + .'- queueing：排队中。'."\n" + .'- running：下载中。'."\n" + .'- failed：下载失败。'."\n" + .'- finished：下载成功。'."\n" + .'- expired：下载过期。'."\n" + ."\n" + .'> 下载目标为URL的任务完成3天后会过期。', + 'type' => 'string', + 'example' => 'initializing', + ], + 'Progress' => [ + 'description' => '已下载表数量/表总数。'."\n" + ."\n" + .'> 如果任务当前处理准备阶段，该进度返回为0/0。', + 'type' => 'string', + 'example' => '0/0', + ], + 'BackupSetTime' => [ + 'description' => '任意时间点下载任务时所对应的时间点，返回格式为时间戳形式。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1661373070000', + ], + 'RegionCode' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'example' => 'cn-beijing', + ], + 'TargetPath' => [ + 'description' => '数据下载目标路径。'."\n" + ."\n" + .'> 当**TargetType=OSS**时，该参数返回。', + 'type' => 'string', + 'example' => 'test_db/path', + ], + 'DbList' => [ + 'description' => '当下载任务为库表过滤任务时，该字段返回对应库表信息。', + 'type' => 'string', + 'example' => 'testdb', + ], + 'ExportDataSize' => [ + 'description' => '导出数据量，单位为字节（Byte）。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'ImportDataSize' => [ + 'description' => '处理数据量，单位为字节（Byte）。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'GmtCreate' => [ + 'description' => '任务创建时间，返回格式为时间戳形式。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1661940917570', + ], + 'TaskId' => [ + 'description' => '下载任务ID。', + 'type' => 'string', + 'example' => 'dt-qxnsfq5s****', + ], + 'Format' => [ + 'description' => '目标转换格式。', + 'type' => 'string', + 'example' => 'CSV', + ], + 'TargetType' => [ + 'description' => '下载目标类型。', + 'type' => 'string', + 'example' => 'URL', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 200 => [ + [ + 'errorCode' => 'DBS.DownloadTask.CannotFind', + 'errorMessage' => 'Can not find download task.', + 'description' => '无法找到高级下载任务。', + ], + [ + 'errorCode' => 'DBS.DownloadTask.JobAlreadyExist', + 'errorMessage' => 'Job already submit in recent days, please check it.', + 'description' => '相同备份集的高级下载任务在近几天被提交过，请检查。', + ], + [ + 'errorCode' => 'DBS.DownloadTask.OnlyOneRunningOrFailedTask', + 'errorMessage' => 'There can be only one running or failed task for the instance.', + 'description' => '当前实例只能同时存在一个运行中/失败的任务。', + ], + [ + 'errorCode' => 'DBS.DownloadTask.OssForbid', + 'errorMessage' => 'OSS is forbidden to access. Please check your OSS bucket.', + 'description' => '访问OSS被拒绝。请检查您的OSS权限配置。', + ], + [ + 'errorCode' => 'DBS.DownloadTask.OssStorageTypeInvalid', + 'errorMessage' => 'Unsupported bucket storage. Please make sure that your OSS bucket\'s storgae type is standard.', + 'description' => '当前OSS bucket类型不支持。请确保您的OSS bucket类型是标准存储类型。', + ], + [ + 'errorCode' => 'Forbidden.InstanceNotFound', + 'errorMessage' => 'instance not found', + 'description' => '实例不存在', + ], + ], + 403 => [ + [ + 'errorCode' => 'Request.Forbidden', + 'errorMessage' => 'Have no Permissions', + 'description' => '当前操作未被授权，请联系主账号在RAM控制台进行授权后再执行操作', + ], + [ + 'errorCode' => 'DBS.NoPermissionException', + 'errorMessage' => 'Rejected by ValidationChecker.', + 'description' => 'Rejected by ValidationChecker.', + ], + ], + [ + [ + 'errorCode' => 'DBS.NotExists', + 'errorMessage' => 'data source do not existed.', + 'description' => 'DBS.NotExists', + ], + ], + ], + 'responseDemo' => '[{"type":"json","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}","errorExample":""},{"type":"xml","example":"\\n A08F908D-2C35-583F-93C1-ED80753F****\\n \\n 0/0\\n 1661373070000\\n dt-qxnsfq5s****\\n cn-beijing\\n 0\\n 146005****\\n 1661940917570\\n csv\\n initializing\\n 0\\n URL\\n \\n Success\\n true\\n Success\\n","errorExample":""}]', + 'title' => '创建下载任务', + 'description' => '### 适用引擎'."\n" + ."\n" + .'- RDS MySQL（云盘系列）'."\n" + .'- RDS PostgreSQL'."\n" + .'- PolarDB MySQL版'."\n" + .'- MongoDB'."\n" + ."\n" + .'### 相关功能文档'."\n" + .'对于符合条件的实例，您可以按任意时间点或按指定备份集创建高级下载任务，并支持选择下载目标为URL或直接将数据写入您的OSS中，后续方便您进行数据分析以及离线归档。'."\n" + .'- [RDS MySQL下载备份](~~98819~~)'."\n" + .'- [RDS PostgreSQL下载备份](~~96774~~)'."\n" + .'- [PolarDB MySQL版下载备份](~~2627635~~)'."\n" + .'- [MongoDB下载备份](~~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' => '删除沙箱实例。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'delete', + ], + 'parameters' => [ + [ + 'name' => 'BackupPlanId', + 'in' => 'query', + 'schema' => [ + 'description' => '备份计划ID。'."\n" + .'> 若您的实例为RDS MySQL，请通过[自动添加数据源](~~193091~~)功能，将RDS自动添加至DBS中，即可获取备份计划ID。', + 'type' => 'string', + 'required' => true, + 'example' => '1hxxxx8xxxxxa', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '沙箱实例ID。', + 'type' => 'string', + 'required' => true, + 'example' => '1jxxxxnxxx1xc', + ], + ], + [ + 'name' => 'ZoneId', + 'in' => 'query', + 'schema' => [ + 'description' => '目标沙箱实例的可用区ID，该可用区ID需要是PrivateLink服务支持的可用区ID。可通过[DescribeZones](~~469326~~)接口查询指定地域中可用区的列表。'."\n" + ."\n" + .'> 使用沙箱功能前需要先开通[PrivateLink](~~459882~~)服务，可通过[OpenPrivateLinkService](~~469322~~)接口开通私网连接服务。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou-b', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Data' => [ + 'description' => '报错信息。', + 'type' => 'string', + 'example' => 'operation forbidden due to sandbox is creating.', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '4F1888AC-1138-4995-B9FE-D2734F61C058', + ], + 'ErrCode' => [ + 'description' => '错误码。', + 'type' => 'string', + 'example' => 'Param.NotFound', + ], + 'Success' => [ + 'description' => '是否请求成功。', + 'type' => 'string', + 'example' => 'true', + ], + 'ErrMessage' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'The specified parameter %s value is not valid.', + ], + 'Code' => [ + 'description' => '错误码。', + 'type' => 'string', + 'example' => 'Param.NotFound', + ], + 'Message' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'The specified parameter %s value is not valid.', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'Request.Forbidden', + 'errorMessage' => 'Have no Permissions', + 'description' => '当前操作未被授权，请联系主账号在RAM控制台进行授权后再执行操作', + ], + ], + ], + 'title' => '释放沙箱实例', + 'description' => '当前接口仅支持DBS API服务2021-01-01版本。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' | 错误码 | 报错消息 | 可能原因 |'."\n" + .'| --------------------------- | ---------------------------------------------- | ------------------------------------------------------------ |'."\n" + .'| Operation.DeniedByJobStatus | operation forbidden due to sandbox is creating | 无法释放正在创建中的沙箱实例。请在沙箱实例处于运行中时，再进行删除。 |', + 'changeSet' => [ + [ + 'createdAt' => '2023-08-18T09:25:36.000Z', + 'description' => '请求参数发生变更', + ], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'dbs:DeleteSandboxInstance', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DBS', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","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}","errorExample":""},{"type":"xml","example":"41F0B1A5-A615-5C2E-AC01-D511F040D421\\nSuccess\\ntrue\\nSuccess","errorExample":""}]', + ], + 'DescribeBackupDataList' => [ + 'summary' => '查询PolarDB MySQL版备份数据详情。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '171434', + 'abilityTreeNodes' => [ + 'FEATUREcbsUOJI4N', + ], + ], + 'parameters' => [ + [ + 'name' => 'InstanceName', + 'in' => 'query', + 'schema' => [ + 'title' => '实例名称', + 'description' => 'PolarDB实例ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'pc-2ze3nrr64c5******', + ], + ], + [ + 'name' => 'RegionCode', + 'in' => 'query', + 'schema' => [ + 'title' => '地域', + 'description' => '备份集所在地域。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'SceneType', + 'in' => 'query', + 'schema' => [ + 'title' => '场景类型', + 'description' => '备份场景类型，当前仅支持**LEVEL_1**，即实例所在地域的一级备份。', + 'type' => 'string', + 'required' => false, + 'example' => 'LEVEL_1', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'title' => '查询开始时间，格式：yyyy-MM-ddTHH:mmZ', + 'description' => '查询开始时间，格式：yyyy-MM-ddTHH:mm:ssZ（UTC 时间）。', + 'type' => 'string', + 'required' => false, + 'example' => '2024-04-17T17:00:16Z', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'title' => '查询结束时间，格式：yyyy-MM-ddTHH:mmZ', + 'description' => '查询结束时间，需要大于查询开始时间。格式：yyyy-MM-ddTHH:mm:ssZ（UTC 时间）。', + 'type' => 'string', + 'required' => false, + 'example' => '2024-04-17T17:00:32Z', + ], + ], + [ + 'name' => 'BackupStatus', + 'in' => 'query', + 'schema' => [ + 'title' => '备份集状态，OK-备份成功；ERROR-备份失败；', + 'description' => '备份集状态，取值如下：'."\n" + ."\n" + .'- **OK**：备份成功'."\n" + .'- **ERROR**：备份失败', + 'type' => 'string', + 'required' => false, + 'example' => 'OK', + ], + ], + [ + 'name' => 'BackupId', + 'in' => 'query', + 'schema' => [ + 'title' => '备份集ID', + 'description' => '备份集ID。', + 'type' => 'string', + 'required' => false, + 'example' => '213064****', + ], + ], + [ + 'name' => 'BackupMethod', + 'in' => 'query', + 'schema' => [ + 'title' => '备份方法：Physical-物理备份；Logical-逻辑备份；Snapshot-快照备份；', + 'description' => '备份方式，取值如下：'."\n" + ."\n" + .'- **Physical**：物理备份'."\n" + .'- **Logical**：逻辑备份'."\n" + .'- **Snapshot**：快照备份', + 'type' => 'string', + 'required' => false, + 'example' => 'Snapshot', + ], + ], + [ + 'name' => 'BackupMode', + 'in' => 'query', + 'schema' => [ + 'title' => '备份模式：Automated-自动备份；Manual-手动备份；', + 'description' => '备份模式，取值如下：'."\n" + ."\n" + .'- **Automated**：系统自动备份'."\n" + .'- **Manual**：手动备份', + 'type' => 'string', + 'required' => false, + 'example' => 'Automated', + ], + ], + [ + 'name' => 'BackupType', + 'in' => 'query', + 'schema' => [ + 'title' => '备份类型：FullBackup-全量备份；IncrementBackup-增量备份；', + 'description' => '备份类型，取值如下：'."\n" + ."\n" + .'- **FullBackup**：全量备份'."\n" + .'- **IncrementBackup**：增量备份', + 'type' => 'string', + 'required' => false, + 'example' => 'FullBackup', + ], + ], + [ + 'name' => 'BackupScale', + 'in' => 'query', + 'schema' => [ + 'title' => '备份规格：DBInstance-实例备份；DBTable-库表备份；', + 'description' => '备份规格，取值如下：'."\n" + ."\n" + .'- **DBInstance**：实例备份'."\n" + .'- **DBTable**：库表备份', + 'type' => 'string', + 'required' => false, + 'example' => 'DBInstance', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'title' => '分页每页大小，默认为20', + 'description' => '每页记录数，默认值为20。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'title' => '分页页码，从1开始，默认为1', + 'description' => '页码，取值范围为大于0但不超过Integer最大值的整数，默认值为1。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'InstanceIsDeleted', + 'in' => 'query', + 'schema' => [ + 'title' => '实例是否已删除', + 'description' => '实例是否已删除，取值如下：'."\n" + ."\n" + .'- **true**：已删除'."\n" + .'- **false**：未删除（默认值）', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'InstanceRegion', + 'in' => 'query', + 'schema' => [ + 'title' => '实例原地域', + 'description' => '原实例所在地域。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'DataSourceId', + 'in' => 'query', + 'schema' => [ + 'title' => '数据源ID', + 'description' => '预留参数，暂无需关注。', + 'type' => 'string', + 'required' => false, + 'example' => 'test****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回参数详情。', + 'type' => 'object', + 'properties' => [ + 'Data' => [ + 'description' => '返回数据如下。', + 'type' => 'object', + 'properties' => [ + 'Content' => [ + 'description' => '任务详情。', + 'type' => 'array', + 'items' => [ + 'description' => '任务详情。', + 'type' => 'object', + 'properties' => [ + 'BackupId' => [ + 'title' => '备份集ID', + 'description' => '备份集ID。', + 'type' => 'string', + 'example' => '213088****', + ], + 'BackupName' => [ + 'title' => '备份集名称', + 'description' => '备份集名称。', + 'type' => 'string', + 'example' => 'logic_backup', + ], + 'BackupMode' => [ + 'title' => '备份模式：Automated-自动备份；Manual-手动备份；', + 'description' => '备份模式，返回值如下：'."\n" + ."\n" + .'- **Automated**：系统自动备份'."\n" + .'- **Manual**：手动备份', + 'type' => 'string', + 'example' => 'Automated', + ], + 'BackupType' => [ + 'title' => '备份类型：FullBackup-全量备份；IncrementBackup-增量备份；', + 'description' => '备份类型，返回值如下：'."\n" + ."\n" + .'- **FullBackup**：全量备份'."\n" + .'- **IncrementBackup**：增量备份', + 'type' => 'string', + 'example' => 'FullBackup', + ], + 'BackupScale' => [ + 'title' => '备份规格：DBInstance-实例备份；DBTable-库表备份；', + 'description' => '备份规格，返回值如下：'."\n" + ."\n" + .'- **DBInstance**：实例备份'."\n" + .'- **DBTable**：库表备份', + 'type' => 'string', + 'example' => 'DBInstance', + ], + 'BackupMethod' => [ + 'title' => '备份方法：Physical-物理备份；Logical-逻辑备份；Snapshot-快照备份；', + 'description' => '备份方式，返回值如下：'."\n" + ."\n" + .'- **Physical**：物理备份'."\n" + .'- **Logical**：逻辑备份'."\n" + .'- **Snapshot**：快照备份', + 'type' => 'string', + 'example' => 'Snapshot', + ], + 'BackupSize' => [ + 'title' => '备份集大小，单位Byte', + 'description' => '备份集大小，单位Byte。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '25669140480', + ], + 'BackupStatus' => [ + 'title' => '备份集状态，OK-备份成功；ERROR-备份失败；', + 'description' => '备份集状态，返回值如下：'."\n" + ."\n" + .'- **OK**：备份成功'."\n" + .'- **ERROR**：备份失败', + 'type' => 'string', + 'example' => 'OK', + ], + 'BackupStartTime' => [ + 'title' => '备份开始时间，格式：yyyy-MM-ddTHH:mmZ', + 'description' => '备份开始时间，格式：yyyy-MM-ddTHH:mm:ssZ（UTC 时间）。', + 'type' => 'string', + 'example' => '2024-04-17T17:00:16Z', + ], + 'BackupEndTime' => [ + 'title' => '备份结束时间，格式：yyyy-MM-ddTHH:mmZ', + 'description' => '备份结束时间，格式：yyyy-MM-ddTHH:mm:ssZ（UTC 时间）。', + 'type' => 'string', + 'example' => '2024-04-17T17:00:32Z', + ], + 'ConsistentTime' => [ + 'title' => '一致性时间点：UnixTimestamp秒级时间戳', + 'description' => '一致性快照的时间点，格式为Unix时间戳，单位为秒（s）。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1713373221', + ], + 'BackupLocation' => [ + 'title' => '备份存储路径', + 'description' => '备份存储路径。', + 'type' => 'string', + 'example' => 'logic', + ], + 'InstanceName' => [ + 'title' => '实例名称', + 'description' => '实例ID。', + 'type' => 'string', + 'example' => 'pc-2ze3nrr64c5******', + ], + 'Engine' => [ + 'title' => '引擎类型', + 'description' => '引擎类型。', + 'type' => 'string', + 'example' => 'polardb_mysql', + ], + 'EngineVersion' => [ + 'title' => '引擎版本', + 'description' => '引擎版本。', + 'type' => 'string', + 'example' => '5.7', + ], + 'SupportDeletion' => [ + 'title' => '备份集是否支持删除', + 'description' => '备份集是否支持删除，返回值如下：'."\n" + ."\n" + .'- **0**：支持'."\n" + .'- **1**：不支持', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'Encryption' => [ + 'title' => '加密信息', + 'description' => '加密信息。', + 'type' => 'string', + 'example' => 'psk2', + ], + 'IsAvail' => [ + 'title' => '备份集是否可用，1-可用；0-不可用；', + 'description' => '备份集是否可用，返回值如下：'."\n" + ."\n" + .'- **1**：可用'."\n" + .'- **0**：不可用', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Checksum' => [ + 'title' => '校验码', + 'description' => '校验码。', + 'type' => 'string', + 'example' => '84a4c16431f969712e6895992719****', + ], + 'BackupDownloadURL' => [ + 'title' => '备份集公网下载链接', + 'description' => '备份集公网下载地址。'."\n" + ."\n" + .'> 仅当BackupMethod为**Physical**（物理备份）或**Logical**（逻辑备份）时，返回该参数。', + 'type' => 'string', + 'example' => 'http://oss.com/****', + ], + 'BackupIntranetDownloadURL' => [ + 'title' => '备份集内网下载链接', + 'description' => '备份集内网下载地址。'."\n" + .'> 仅当BackupMethod为**Physical**（物理备份）或**Logical**（逻辑备份）时，返回该参数。', + 'type' => 'string', + 'example' => 'http://oss.com/****', + ], + 'ExpectExpireType' => [ + 'title' => '备份集预期过期类型', + 'description' => '备份集预期过期类型，返回值如下：'."\n" + ."\n" + .'- NEVER'."\n" + .'- EXPIRED'."\n" + .'- DELAY', + 'type' => 'string', + 'example' => 'DELAY', + ], + 'ExpectExpireTime' => [ + 'title' => '备份集预期过期时间，格式：yyyy-MM-ddTHH:mmZ', + 'description' => '备份集预期过期时间，格式：yyyy-MM-ddTHH:mm:ssZ（UTC 时间）。', + 'type' => 'string', + 'example' => '2024-04-19T05:00:49Z', + ], + 'PolarSnapshot' => [ + 'title' => 'PolarDB二级转储信息', + 'description' => 'PolarDB二级转储信息。'."\n" + ."\n" + .'> 仅当PolarDB实例开启同地域二级转储功能，并且一级备份转储成功后，才会返回PolarSnapshot相关信息。', + 'type' => 'object', + 'properties' => [ + 'DumpId' => [ + 'title' => '转储ID', + 'description' => '转储ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => 'abc****', + ], + 'DumpSize' => [ + 'title' => '转储备份大小，单位为Byte', + 'description' => '转储备份大小，单位为Byte。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '25669140589', + ], + 'expectExpireType' => [ + 'title' => '备份集预期过期类型', + 'description' => '备份集预期过期类型，返回值如下：'."\n" + ."\n" + .'- NEVER'."\n" + .'- EXPIRED'."\n" + .'- DELAY', + 'type' => 'string', + 'example' => 'DELAY', + ], + 'ExpectExpireTime' => [ + 'title' => '备份集预期过期时间，格式：yyyy-MM-ddTHH:mmZ', + 'description' => '备份集预期过期时间，格式：yyyy-MM-ddTHH:mm:ssZ（UTC 时间）。', + 'type' => 'string', + 'example' => '2024-04-19T05:00:49Z', + ], + ], + ], + ], + ], + ], + 'PageSize' => [ + 'title' => '分页大小', + 'description' => '分页大小。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '20', + ], + 'PageNumber' => [ + 'title' => '分页页码', + 'description' => '分页页码。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'TotalPages' => [ + 'title' => '分页总页数', + 'description' => '分页总页数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'TotalElements' => [ + 'title' => '总个数', + 'description' => '备份集总个数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'Extra' => [ + 'title' => '额外信息', + 'description' => '额外信息。', + 'type' => 'string', + 'example' => 'dbtest', + ], + ], + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '95A5FFD0-7F46-5A7D-9DFE-6A376B4E2A28', + ], + 'ErrCode' => [ + 'description' => '错误码。'."\n", + 'type' => 'string', + 'example' => 'Request.Forbidden ', + ], + 'Success' => [ + 'description' => '请求是否成功，返回值如下：'."\n" + .'- **true**：请求成功'."\n" + .'- **false**：请求失败', + 'type' => 'string', + 'example' => 'true', + ], + 'ErrMessage' => [ + 'description' => '错误信息。'."\n", + 'type' => 'string', + 'example' => 'The specified parameter %s value is not valid. ', + ], + 'Code' => [ + 'description' => '状态码。', + 'type' => 'string', + 'example' => 'Success', + ], + 'Message' => [ + 'description' => '返回信息。', + 'type' => 'string', + 'example' => 'The specified parameter %s value is not valid.', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'Request.Forbidden', + 'errorMessage' => 'Have no Permissions', + 'description' => '当前操作未被授权，请联系主账号在RAM控制台进行授权后再执行操作', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'title' => '查询备份数据', + 'description' => '### 适用引擎'."\n" + .'PolarDB MySQL版'."\n" + ."\n" + .'> 当前该接口仅针对特定客户开放使用，如有需求，请到DBS客户咨询群（钉钉群号：35585947）申请使用。'."\n" + ."\n" + .'### 相关功能文档'."\n" + .'[PolarDB MySQL版备份操作](~~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' => '备份集所在地域。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-beijing', + ], + ], + [ + 'name' => 'InstanceName', + 'in' => 'query', + 'schema' => [ + 'title' => '实例名', + 'description' => 'PolarDB实例ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'pc-2ze3nrr64c5****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回参数详情。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '54A63B3B-AA10-1CC3-A6BB-6CCE98D19628', + ], + 'Message' => [ + 'description' => '返回信息。', + 'type' => 'string', + 'example' => 'instanceName can not be empty.', + ], + 'Data' => [ + 'description' => '备份策略详情。', + 'type' => 'object', + 'properties' => [ + 'PreferredBackupDate' => [ + 'title' => '基础备份的备份周期'."\n", + 'description' => '基础备份的备份周期，以一个7位数返回，从左到右每一位分别对应周一到周日，其中1代表备份，0代表不进行备份。', + 'type' => 'string', + 'example' => '1010101', + ], + 'PreferredBackupWindowBegin' => [ + 'title' => '基础备份窗口开始时间', + 'description' => '基础备份窗口开始时间。', + 'type' => 'string', + 'example' => '23:00Z', + ], + 'PreferredBackupWindow' => [ + 'title' => '基础备份窗口', + 'description' => '基础备份窗口。', + 'type' => 'string', + 'example' => '23:00Z-24:00Z', + ], + 'BackupRetentionPeriod' => [ + 'title' => '基础备份保留时间，若开启高级备份策略，则为一级备份策略中得最长保留时间', + 'description' => '基础备份保留时间，若开启高级备份策略，则为一级备份策略中的最长保留时间。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '7', + ], + 'BackupRetentionPolicyOnClusterDeletion' => [ + 'title' => '已删除实例的归档备份保留策略。取值：'."\n" + .'0：不保留'."\n" + .'1：保留最后一个'."\n" + .'2：全部保留', + 'description' => '已删除实例的归档备份保留策略，返回值如下：'."\n" + ."\n" + .'- **NONE**：不保留'."\n" + .'- **LATEST**：保留最后一个'."\n" + .'- **ALL**：全部保留', + 'type' => 'string', + 'example' => 'LATEST', + ], + 'HighFrequencyBakInterval' => [ + 'title' => '高频备份时间', + 'description' => '高频备份时间。例如120表示每两小时备份一次，单位为分钟。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '120', + ], + 'BackupPriority' => [ + 'title' => '备库备份的设置。返回值：'."\n" + .'1：优先备库'."\n" + .'2：强制主库', + 'description' => '备库备份的设置策略，返回值如下：'."\n" + ."\n" + .'- **1**：优先备库'."\n" + .'- **2**：强制主库'."\n" + ."\n\n" + .'> 该参数仅适用于RDS SQL Server实例，其他引擎返回值为**0**。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'EnableLogBackup' => [ + 'title' => '是否开启日志备份', + 'description' => '是否开启日志备份，返回值如下：'."\n" + ."\n" + .'- **1**：开启'."\n" + .'- **0**：未开启', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'LogBackupRetention' => [ + 'title' => '日志备份保留周期', + 'description' => '日志备份保留周期。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '7', + ], + 'LogBackupLocalRetentionNumber' => [ + 'title' => '本地日志文件保留个数', + 'description' => '本地日志文件保留个数。', + 'type' => 'string', + 'example' => '10', + ], + 'EnableBackup' => [ + 'title' => '是否开启备份', + 'description' => '是否开启备份。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'LocalLogRetentionSpace' => [ + 'title' => '本地日志最大空间使用率。', + 'description' => '本地日志最大空间使用率。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '30', + ], + 'HighSpaceUsageProtection' => [ + 'title' => '在磁盘水位过高时是否强制日志', + 'description' => '实例使用空间大于80%，或者剩余空间小于 5 GB时，是否强制清理日志：'."\n" + ."\n" + .'- **Disable**：不清理'."\n" + .'- **Enable**：清理', + 'type' => 'string', + 'example' => 'Enable', + ], + 'Category' => [ + 'title' => '是否开启秒级备份，仅对MySQL生效', + 'description' => '是否开启秒级备份，返回值如下：'."\n" + ."\n" + .'- **Flash**：已开启秒级备份'."\n" + .'- **Standard**：普通备份'."\n" + ."\n" + .'> 该参数仅对MySQL生效。', + 'type' => 'string', + 'example' => 'Standard', + ], + 'IncBackupInterval' => [ + 'title' => '高频增量备份间隔', + 'description' => '高频增量备份间隔。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '-1', + ], + 'EnableIncBackup' => [ + 'title' => '是否开启增量备份', + 'description' => '是否开启增量备份。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'BackupMethod' => [ + 'title' => '备份方式 S - 快照备份 P-物理备份', + 'description' => '备份方式，返回值如下：'."\n" + ."\n" + .'- **Physical**：物理备份'."\n" + .'- **Snapshot**：快照备份', + 'type' => 'string', + 'example' => 'Physical', + ], + 'AdvanceLogPolicies' => [ + 'description' => '日志备份策略详情。', + 'type' => 'array', + 'items' => [ + 'description' => '策略详情。', + 'type' => 'object', + 'properties' => [ + 'PolicyId' => [ + 'title' => '备份策略ID', + 'description' => '备份策略ID。', + 'type' => 'string', + 'example' => 'dc13b153acc91141789122c23835****', + ], + 'SrcType' => [ + 'title' => '备份策略源类型'."\n" + .' db - 数据库'."\n" + .' level1 - 一级备份'."\n" + .' level2 - 二级备份'."\n" + .' level2Cross - 二级跨地域备份', + 'description' => '备份策略源类型，返回值如下：'."\n" + ."\n" + .'- **db**：数据库'."\n" + .'- **level1**：一级备份'."\n" + .'- **level2**：二级备份'."\n" + .'- **level2Cross**：二级跨地域备份', + 'type' => 'string', + 'example' => 'level1', + ], + 'SrcRegion' => [ + 'title' => '备份策略源region', + 'description' => '备份策略源地域。', + 'type' => 'string', + 'example' => 'cn-beijing', + ], + 'DestType' => [ + 'title' => '备份策略目标类型'."\n" + .' db - 数据库'."\n" + .' level1 - 一级备份'."\n" + .' level2 - 二级备份'."\n" + .' level2Cross - 二级跨地域备份', + 'description' => '备份策略目标类型，返回值如下：'."\n" + ."\n" + .'- **db**：数据库'."\n" + .'- **level1**：一级备份'."\n" + .'- **level2**：二级备份'."\n" + .'- **level2Cross**：二级跨地域备份', + 'type' => 'string', + 'example' => 'level1', + ], + 'DestRegion' => [ + 'title' => '备份策略目标region', + 'description' => '备份策略目标地域。', + 'type' => 'string', + 'example' => 'cn-shanghai', + ], + 'EnableLogBackup' => [ + 'title' => '是否开启日志备份', + 'description' => '预留参数，无需关注。', + 'type' => 'integer', + 'example' => '1', + 'format' => 'int64', + ], + 'LogRetentionType' => [ + 'title' => '日志备份保留类型'."\n" + .' Never - 永不过期'."\n" + .' Delay - 按天过期', + 'description' => '日志备份保留类型，返回值如下：'."\n" + ."\n" + .'- **never**：永不过期'."\n" + .'- **delay**：固定天数过期', + 'type' => 'string', + 'example' => 'delay', + ], + 'LogRetentionValue' => [ + 'title' => '日志备份保留时间', + 'description' => '日志备份保留时间。', + 'type' => 'string', + 'example' => '3', + ], + 'FilterType' => [ + 'type' => 'string', + ], + 'FilterKey' => [ + 'type' => 'string', + ], + 'FilterValue' => [ + 'type' => 'string', + ], + ], + ], + ], + 'AdvanceDataPolicies' => [ + 'description' => '数据备份策略详情。', + 'type' => 'array', + 'items' => [ + 'description' => '策略详情。', + 'type' => 'object', + 'properties' => [ + 'PolicyId' => [ + 'title' => '高级策略ID', + 'description' => '高级策略ID。', + 'type' => 'string', + 'example' => '71930ac2e9f15e41615e10627c******', + ], + 'FilterType' => [ + 'title' => '高级策略筛选类型'."\n" + .' Crontab - 周期调度'."\n" + .' Event - 事件调度', + 'description' => '高级策略筛选类型，返回值如下：'."\n" + ."\n" + .'- **crontab**：周期调度'."\n" + .'- **event**：事件调度', + 'type' => 'string', + 'example' => 'crontab', + ], + 'FilterKey' => [ + 'title' => '调度类型，当前仅当filterType为crontab时有效'."\n" + .'dayOfWeek - 按周调度'."\n" + .'dayOfMonth - 按月调度'."\n" + .'dayOfYear - 按年调度'."\n" + .'backupInterval - 固定间隔调度', + 'description' => '调度类型，返回值如下：'."\n" + ."\n" + .'- **dayOfWeek**：按周调度'."\n" + .'- **dayOfMonth**：按月调度'."\n" + .'- **dayOfYear**：按年调度'."\n" + .'- **backupInterval**：固定间隔调度'."\n" + ."\n" + .'> 仅当FilterType为**crontab**时，返回该参数。', + 'type' => 'string', + 'example' => 'dayOfWeek', + ], + 'FilterValue' => [ + 'title' => '具体Filter的值', + 'description' => '备份周期。', + 'type' => 'string', + 'example' => '1,2,3,4,5,6,7', + ], + 'DumpAction' => [ + 'title' => '转储策略'."\n" + .' Copy - 复制'."\n" + .' Move - 转储', + 'description' => '转储策略详情，返回值如下：'."\n" + ."\n" + .'- **copy**：复制'."\n" + .'- **move**：转储', + 'type' => 'string', + 'example' => 'copy', + ], + 'RetentionType' => [ + 'title' => '保留周期类型'."\n" + .' Never - 永不过期'."\n" + .' Delay - 固定天数过期', + 'description' => '备份集保留周期类型，返回值如下：'."\n" + ."\n" + .'- **never**：永不过期'."\n" + .'- **delay**：固定天数过期', + 'type' => 'string', + 'example' => 'delay', + ], + 'RetentionValue' => [ + 'title' => '过期天数', + 'description' => '过期天数。', + 'type' => 'string', + 'example' => '7', + ], + 'SrcType' => [ + 'title' => '备份策略源类型'."\n" + .' db - 数据库'."\n" + .' level1 - 一级备份'."\n" + .' level2 - 二级备份'."\n" + .' level2Cross - 二级跨地域备份', + 'description' => '备份策略源类型，返回值如下：'."\n" + ."\n" + .'- **db**：数据库'."\n" + .'- **level1**：一级备份'."\n" + .'- **level2**：二级备份'."\n" + .'- **level2Cross**：二级跨地域备份', + 'type' => 'string', + 'example' => 'db', + ], + 'SrcRegion' => [ + 'title' => '备份策略源region', + 'description' => '备份策略源地域。', + 'type' => 'string', + 'example' => 'cn-beijing', + ], + 'DestType' => [ + 'title' => '备份策略目标类型'."\n" + .' db - 数据库'."\n" + .' level1 - 一级备份'."\n" + .' level2 - 二级备份'."\n" + .' level2Cross - 二级跨地域备份', + 'description' => '备份策略目标类型，返回值如下：'."\n" + ."\n" + .'- **db**：数据库'."\n" + .'- **level1**：一级备份'."\n" + .'- **level2**：二级备份'."\n" + .'- **level2Cross**：二级跨地域备份', + 'type' => 'string', + 'example' => 'level1', + ], + 'DestRegion' => [ + 'title' => '备份策略目标region', + 'description' => '备份策略目标地域。', + 'type' => 'string', + 'example' => 'cn-beijing', + ], + 'BakType' => [ + 'title' => '备份类型 F - 全量 L 日志', + 'description' => '备份类型，返回值如下：'."\n" + ."\n" + .'- **F**：全量备份'."\n" + .'- **L**：日志备份', + 'type' => 'string', + 'example' => 'F', + ], + 'AutoCreated' => [ + 'title' => '是否系统自动生成', + 'description' => '是否为系统自动生成的备份策略，返回值如下：'."\n" + ."\n" + .'- **true**：系统生成策略'."\n" + .'- **false**：用户自定义策略', + 'type' => 'boolean', + 'example' => 'true', + ], + 'StorageClass' => [ + 'type' => 'string', + ], + ], + ], + ], + 'AdvanceIncPolicies' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'PolicyId' => [ + 'type' => 'string', + ], + 'FilterType' => [ + 'type' => 'string', + ], + 'FilterKey' => [ + 'type' => 'string', + ], + 'FilterValue' => [ + 'type' => 'string', + ], + 'DumpAction' => [ + 'type' => 'string', + ], + 'RetentionType' => [ + 'type' => 'string', + ], + 'RetentionValue' => [ + 'type' => 'string', + ], + 'SrcType' => [ + 'type' => 'string', + ], + 'SrcRegion' => [ + 'type' => 'string', + ], + 'DestType' => [ + 'type' => 'string', + ], + 'DestRegion' => [ + 'type' => 'string', + ], + 'BakType' => [ + 'type' => 'string', + ], + 'AutoCreated' => [ + 'type' => 'boolean', + ], + ], + ], + ], + ], + ], + 'ErrMessage' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'The specified parameter %s value is not valid. ', + ], + 'Code' => [ + 'description' => '状态码。', + 'type' => 'string', + 'example' => 'Success', + ], + 'Success' => [ + 'description' => '请求是否成功，返回值如下：'."\n" + .'- **true**：请求成功'."\n" + .'- **false**：请求失败', + 'type' => 'string', + 'example' => 'true', + ], + 'ErrCode' => [ + 'description' => '错误码。', + 'type' => 'string', + 'example' => 'Success', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'Request.Forbidden', + 'errorMessage' => 'Have no Permissions', + 'description' => '当前操作未被授权，请联系主账号在RAM控制台进行授权后再执行操作', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'title' => '查询备份策略', + 'summary' => '查询PolarDB实例备份策略。', + 'description' => '### 适用引擎'."\n" + .'PolarDB MySQL版'."\n" + ."\n" + .'> 当前该接口仅针对特定客户开放使用，如有需求，请到DBS客户咨询群（钉钉群号：35585947）申请使用。'."\n" + ."\n" + .'### 相关功能文档'."\n" + .'[PolarDB MySQL版备份策略](~~280422~~)', + 'changeSet' => [ + [ + 'createdAt' => '2024-05-28T13:59:23.000Z', + 'description' => '响应参数发生变更', + ], + [ + 'createdAt' => '2024-05-17T02:21:41.000Z', + 'description' => '响应参数发生变更', + ], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dbs:DescribeBackupPolicy', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DBS', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"54A63B3B-AA10-1CC3-A6BB-6CCE98D19628\\",\\n \\"Message\\": \\"instanceName can not be empty.\\",\\n \\"Data\\": {\\n \\"PreferredBackupDate\\": \\"1010101\\",\\n \\"PreferredBackupWindowBegin\\": \\"23:00Z\\",\\n \\"PreferredBackupWindow\\": \\"23:00Z-24:00Z\\",\\n \\"BackupRetentionPeriod\\": 7,\\n \\"BackupRetentionPolicyOnClusterDeletion\\": \\"LATEST\\",\\n \\"HighFrequencyBakInterval\\": 120,\\n \\"BackupPriority\\": 0,\\n \\"EnableLogBackup\\": 1,\\n \\"LogBackupRetention\\": 7,\\n \\"LogBackupLocalRetentionNumber\\": \\"10\\",\\n \\"EnableBackup\\": 1,\\n \\"LocalLogRetentionSpace\\": 30,\\n \\"HighSpaceUsageProtection\\": \\"Enable\\",\\n \\"Category\\": \\"Standard\\",\\n \\"IncBackupInterval\\": -1,\\n \\"EnableIncBackup\\": 0,\\n \\"BackupMethod\\": \\"Physical\\",\\n \\"AdvanceLogPolicies\\": [\\n {\\n \\"PolicyId\\": \\"dc13b153acc91141789122c23835****\\",\\n \\"SrcType\\": \\"level1\\",\\n \\"SrcRegion\\": \\"cn-beijing\\",\\n \\"DestType\\": \\"level1\\",\\n \\"DestRegion\\": \\"cn-shanghai\\",\\n \\"EnableLogBackup\\": 1,\\n \\"LogRetentionType\\": \\"delay\\",\\n \\"LogRetentionValue\\": \\"3\\",\\n \\"FilterType\\": \\"\\",\\n \\"FilterKey\\": \\"\\",\\n \\"FilterValue\\": \\"\\"\\n }\\n ],\\n \\"AdvanceDataPolicies\\": [\\n {\\n \\"PolicyId\\": \\"71930ac2e9f15e41615e10627c******\\",\\n \\"FilterType\\": \\"crontab\\",\\n \\"FilterKey\\": \\"dayOfWeek\\",\\n \\"FilterValue\\": \\"1,2,3,4,5,6,7\\",\\n \\"DumpAction\\": \\"copy\\",\\n \\"RetentionType\\": \\"delay\\",\\n \\"RetentionValue\\": \\"7\\",\\n \\"SrcType\\": \\"db\\",\\n \\"SrcRegion\\": \\"cn-beijing\\",\\n \\"DestType\\": \\"level1\\",\\n \\"DestRegion\\": \\"cn-beijing\\",\\n \\"BakType\\": \\"F\\",\\n \\"AutoCreated\\": true,\\n \\"StorageClass\\": \\"\\"\\n }\\n ],\\n \\"AdvanceIncPolicies\\": [\\n {\\n \\"PolicyId\\": \\"\\",\\n \\"FilterType\\": \\"\\",\\n \\"FilterKey\\": \\"\\",\\n \\"FilterValue\\": \\"\\",\\n \\"DumpAction\\": \\"\\",\\n \\"RetentionType\\": \\"\\",\\n \\"RetentionValue\\": \\"\\",\\n \\"SrcType\\": \\"\\",\\n \\"SrcRegion\\": \\"\\",\\n \\"DestType\\": \\"\\",\\n \\"DestRegion\\": \\"\\",\\n \\"BakType\\": \\"\\",\\n \\"AutoCreated\\": true\\n }\\n ]\\n },\\n \\"ErrMessage\\": \\"The specified parameter %s value is not valid. \\",\\n \\"Code\\": \\"Success\\",\\n \\"Success\\": \\"true\\",\\n \\"ErrCode\\": \\"Success\\"\\n}","type":"json"}]', + ], + 'DescribeCostInfoByDbsInstance' => [ + 'summary' => '根据dbs实例id获取费用列表', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'RegionCode', + 'in' => 'query', + 'schema' => [ + 'description' => '实例所在地域ID，您可以在账单里看到地域信息', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'BackupPlanId', + 'in' => 'query', + 'schema' => [ + 'description' => '备份计费实例ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'dbsr1l3ro21****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Data' => [ + 'description' => '参数说明：'."\n" + .'- **commodity**：商品'."\n" + .'- **product**：产品'."\n" + .'- **moduleCode**：计费项'."\n" + .'- **instanceName**：沙箱实例ID。'."\n" + .'- **backupSetId**：备份集ID。'."\n" + .'- **instanceName**：引擎实例名'."\n" + .'- **backupPlanId**：备份计费实例ID。', + '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" + .' }', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '9C397502-B4F2-4E22-AD97-C81F0049F3F3', + ], + 'ErrCode' => [ + 'description' => '错误码。'."\n", + 'type' => 'string', + 'example' => 'Param.NotFound', + ], + 'Success' => [ + 'description' => '是否请求成功。', + 'type' => 'string', + 'example' => 'true', + ], + 'ErrMessage' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'The specified parameter %s value is not valid. ', + ], + 'Code' => [ + 'description' => '状态码。', + 'type' => 'string', + 'example' => 'Success', + ], + 'Message' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'The specified parameter %s value is not valid.', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'Request.Forbidden', + 'errorMessage' => 'Have no Permissions', + 'description' => '当前操作未被授权，请联系主账号在RAM控制台进行授权后再执行操作', + ], + ], + ], + 'title' => '根据dbs实例id获取收费详情。', + 'description' => '当前接口仅支持DBS API服务2021-01-01版本。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dbs:DescribeCostInfoByDbsInstance', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DBS', + 'resourceType' => '全部资源', + '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' => '查看下载备份集的存储信息。', + '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' => '实例所在地域ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'Duration', + 'in' => 'query', + 'schema' => [ + 'description' => '下载目标为URL时，设置链接有效时长。'."\n" + ."\n" + .'- 默认URL有效时长为2小时（7200秒）。'."\n" + .'- 有效时长范围可设置5分钟（300秒）~1天（86400秒）。'."\n" + .'- 请转化为秒（s）后传入该值，例如设置链接有效时长为5分钟时，传入300。', + 'type' => 'string', + 'required' => true, + 'example' => '300', + ], + ], + [ + 'name' => 'InstanceName', + 'in' => 'query', + 'schema' => [ + 'description' => '实例ID。'."\n" + ."\n" + .'> 如果您填写了**InstanceName**，也需填写**BackupSetId**。', + 'type' => 'string', + 'required' => false, + 'example' => 'rm-uf6qqf569n435****', + ], + ], + [ + 'name' => 'TaskId', + 'in' => 'query', + 'schema' => [ + 'description' => '下载任务ID。'."\n" + ."\n" + .'- 如果不填写任务**TaskId**，则需要填写**BackupSetId**和**InstanceName**。'."\n" + .'- 您可在单击目标实例中的**备份恢复**，在**备份下载**页签下查看**任务ID**。', + 'type' => 'string', + 'required' => false, + 'example' => 'dt-s0ugzak9****', + ], + ], + [ + 'name' => 'BackupSetId', + 'in' => 'query', + 'schema' => [ + 'description' => '备份集ID。', + 'type' => 'string', + 'required' => false, + 'example' => '30****', + ], + ], + [ + 'name' => 'ClusterName', + 'in' => 'query', + 'schema' => [ + 'title' => '仅MongoDB依赖，分片集群的集群名', + 'description' => '仅MongoDB依赖，分片集群的集群名', + 'type' => 'string', + 'required' => false, + 'example' => 'dds-example', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回值如下。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '44B8C2F5-919D-5D29-BCD5-DEB03467****', + ], + 'ErrCode' => [ + 'description' => '错误码。'."\n", + 'type' => 'string', + 'example' => 'DBS.ParamIsInValid', + ], + 'Success' => [ + 'description' => '是否执行成功。返回值：'."\n" + .'- **true**：执行成功'."\n" + .'- **false**：执行失败', + 'type' => 'string', + 'example' => 'true', + ], + 'ErrMessage' => [ + 'description' => '错误信息。'."\n", + 'type' => 'string', + 'example' => 'Argument: regionCode Must not be empty', + ], + 'Code' => [ + 'description' => '错误码。', + 'type' => 'string', + 'example' => 'DBS.ParamIsInValid', + ], + 'Message' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'Argument: regionCode Must not be empty', + ], + 'Data' => [ + 'description' => '返回数据如下。', + 'type' => 'object', + 'properties' => [ + 'PublicUrl' => [ + 'description' => '备份集公网下载地址。', + 'type' => 'string', + 'example' => 'http://dbs-137383785969****-cn-hangzhou-1iv12nblw****.oss-cn-hangzhou.aliyuncs.com/dt-u7u4bufa****/dbs_target_file_path/test_456', + ], + 'PrivateUrl' => [ + 'description' => '备份集私网下载地址。', + 'type' => 'string', + 'example' => 'http://dbs-137383785969****-cn-hangzhou-1iv12nblw****.oss-cn-hangzhou-internal.aliyuncs.com/dt-u7u4bufa****/dbs_target_file_path/test_123', + ], + 'ExpirationTime' => [ + 'description' => '链接有效期。'."\n" + ."\n" + .'> 返回值为时间戳形式。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1661329050', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'Request.Forbidden', + 'errorMessage' => 'Have no Permissions', + 'description' => '当前操作未被授权，请联系主账号在RAM控制台进行授权后再执行操作', + ], + ], + ], + 'responseDemo' => '[{"type":"json","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}","errorExample":""},{"type":"xml","example":"\\n 44B8C2F5-919D-5D29-BCD5-DEB03467****\\n \\n http://dbs-137383785969****-cn-hangzhou-1iv12nblw****.oss-cn-hangzhou-internal.aliyuncs.com/dt-u7u4bufa****/dbs_target_file_path/test_123\\n http://dbs-137383785969****-cn-hangzhou-1iv12nblw****.oss-cn-hangzhou.aliyuncs.com/dt-u7u4bufa****/dbs_target_file_path/test_456\\n 1661329050\\n \\n Success\\n true\\n Success\\n","errorExample":""}]', + 'title' => '查看下载备份集的存储信息', + 'description' => '### 适用引擎'."\n" + ."\n" + .'- RDS MySQL（云盘系列）'."\n" + .'- RDS PostgreSQL'."\n" + .'- PolarDB MySQL版'."\n" + .'- MongoDB'."\n" + ."\n" + .'### 相关功能文档'."\n" + ."\n" + .'- [RDS MySQL下载备份](~~98819~~)'."\n" + .'- [RDS PostgreSQL下载备份](~~96774~~)'."\n" + .'- [PolarDB MySQL版下载备份](~~2627635~~)'."\n" + .'- [MongoDB下载备份](~~55011~~)', + 'changeSet' => [ + [ + 'createdAt' => '2022-08-25T07:43:22.000Z', + 'description' => '请求参数发生变更', + ], + [ + 'createdAt' => '2022-08-03T09:23:52.000Z', + 'description' => 'OpenAPI 下线', + ], + ], + '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' => '查询当前实例是否支持高级下载。', + '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' => '实例所在地域ID，您可以调用[DescribeDBInstanceAttribute](~~26231~~)查询。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'InstanceName', + 'in' => 'query', + 'schema' => [ + 'description' => '实例ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'rm-bp1a48p922r4b****', + ], + ], + [ + 'name' => 'ClusterName', + 'in' => 'query', + 'schema' => [ + 'title' => '仅MongoDB依赖，分片集群的集群名', + 'description' => '仅MongoDB依赖，分片集群的集群名', + 'type' => 'string', + 'required' => false, + 'example' => 'dds-example', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回值如下。', + 'type' => 'object', + 'properties' => [ + 'Data' => [ + 'description' => '是否支持高级下载功能，返回值如下：'."\n" + ."\n" + .'- **true**：支持'."\n" + .'- **false**：不支持'."\n", + 'type' => 'string', + 'example' => 'true', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'F1A186F7-7B34-5C11-A903-EE23876B****', + ], + 'ErrCode' => [ + 'description' => '调用出错时返回的错误码。', + 'type' => 'string', + 'example' => 'DBS.ParamIsInValid', + ], + 'Success' => [ + 'description' => '请求是否成功，返回值如下：'."\n" + .'- **true**：请求成功'."\n" + .'- **false**：请求失败', + 'type' => 'string', + 'example' => 'true', + ], + 'ErrMessage' => [ + 'description' => '调用错误时返回的错误信息。'."\n", + 'type' => 'string', + 'example' => 'Argument: regionCode Must not be empty', + ], + 'Code' => [ + 'description' => '错误码。', + 'type' => 'string', + 'example' => 'DBS.ParamIsInValid', + ], + 'Message' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'Argument: regionCode Must not be empty', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'Request.Forbidden', + 'errorMessage' => 'Have no Permissions', + 'description' => '当前操作未被授权，请联系主账号在RAM控制台进行授权后再执行操作', + ], + ], + ], + 'staticInfo' => [], + 'responseDemo' => '[{"type":"json","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}","errorExample":""},{"type":"xml","example":"\\n F1A186F7-7B34-5C11-A903-EE23876B****\\n true\\n Success\\n true\\n Success\\n","errorExample":""}]', + 'title' => '查询当前实例是否支持高级下载', + 'description' => '### 适用引擎'."\n" + ."\n" + .'- RDS MySQL（云盘系列）'."\n" + .'- RDS PostgreSQL'."\n" + .'- PolarDB MySQL版'."\n" + .'- MongoDB'."\n" + ."\n" + .'### 相关功能文档'."\n" + ."\n" + .'您可以按任意时间点或按指定备份集创建高级下载任务，并支持选择下载目标为URL或直接将数据写入您的OSS中，后续方便您进行数据分析以及离线归档。'."\n" + ."\n" + .'- [RDS MySQL下载备份](~~98819~~)'."\n" + .'- [RDS PostgreSQL下载备份](~~96774~~)'."\n" + .'- [PolarDB MySQL版下载备份](~~2627635~~)'."\n" + .'- [MongoDB下载备份](~~55011~~)', + 'changeSet' => [ + [ + 'createdAt' => '2022-08-25T07:43:22.000Z', + 'description' => '请求参数发生变更', + ], + [ + 'createdAt' => '2022-08-03T09:23:52.000Z', + 'description' => 'OpenAPI 下线', + ], + ], + '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' => '查询RDS MySQL、RDS PostgreSQL、PolarDB MySQL版实例的高级下载任务列表。', + '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' => '实例所在地域ID，您可以调用[DescribeDBInstanceAttribute](~~26231~~)查询。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'InstanceName', + 'in' => 'query', + 'schema' => [ + 'description' => '实例ID。'."\n" + ."\n" + .'> 该参数为必填项。', + 'type' => 'string', + 'required' => false, + 'example' => 'rm-bp1imnmcjxdz7****', + ], + ], + [ + 'name' => 'DatasourceId', + 'in' => 'query', + 'schema' => [ + 'description' => '数据源DBS标记ID，传入格式为：*ds-${实例ID}_${regionId}*。', + 'type' => 'string', + 'required' => false, + 'example' => 'ds-rm-2ze8g2am97624****_cn-hangzhou', + ], + ], + [ + 'name' => 'BackupSetId', + 'in' => 'query', + 'schema' => [ + 'description' => '创建下载任务时生成的备份集ID，您可调用[DescribeBackups](~~26273~~)接口查询。', + 'type' => 'string', + 'required' => false, + 'example' => '216****', + ], + ], + [ + 'name' => 'State', + 'in' => 'query', + 'schema' => [ + 'description' => '下载任务的状态，取值如下：'."\n" + ."\n" + .'- **initializing**：初始化。'."\n" + .'- **queueing**：排队中。'."\n" + .'- **running**：下载中。'."\n" + .'- **failed**：下载失败。'."\n" + .'- **finished**：下载成功。'."\n" + .'- **expired**：下载过期。', + 'type' => 'string', + 'required' => false, + 'example' => 'queueing', + ], + ], + [ + 'name' => 'TaskType', + 'in' => 'query', + 'schema' => [ + 'description' => '下载任务类型，取值如下：'."\n" + ."\n" + .'- **full**：全量备份集下载。'."\n" + .'- **pit**r：任意时间点下载。', + 'type' => 'string', + 'required' => false, + 'example' => 'full', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '按创建时间区间的起始点查询，Long类型时间戳形式，单位为毫秒（ms）。', + 'type' => 'string', + 'required' => false, + 'example' => '1661941554000', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '按创建时间区间的终止点查询，Long类型时间戳形式，单位为毫秒（ms）。', + 'type' => 'string', + 'required' => false, + 'example' => '1661941556000', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页的记录数。', + 'type' => 'string', + 'required' => false, + 'example' => '50', + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => '当前页码。', + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'OrderDirect', + 'in' => 'query', + 'schema' => [ + 'description' => '排序方向，取值如下：'."\n" + ."\n" + .'- **asc**：正序。'."\n" + .'- **desc**：倒序，为默认值。'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'desc', + ], + ], + [ + 'name' => 'OrderColumn', + 'in' => 'query', + 'schema' => [ + 'description' => '默认按创建时间排序，取值：**gmt_create**。', + 'type' => 'string', + 'required' => false, + 'example' => 'gmt_create', + ], + ], + [ + 'name' => 'ClusterName', + 'in' => 'query', + 'schema' => [ + 'title' => '仅MongoDB依赖，分片集群的集群名', + 'description' => '仅MongoDB依赖，分片集群的集群名', + 'type' => 'string', + 'required' => false, + 'example' => 'dds-example', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回参数如下。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '5D285EB9-A443-592D-9F3D-A888FAC3****', + ], + 'ErrCode' => [ + 'description' => '错误码。', + 'type' => 'string', + 'example' => 'DBS.InternalError', + ], + 'Success' => [ + 'description' => '请求是否成功，返回值如下：'."\n" + .'- **true**：请求成功。'."\n" + .'- **false**：请求失败。', + 'type' => 'string', + 'example' => 'true', + ], + 'ErrMessage' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'instanceName can not be empty', + ], + 'Code' => [ + 'description' => '错误码。', + 'type' => 'string', + 'example' => 'DBS.InternalError', + ], + 'Message' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'instanceName can not be empty', + ], + 'Data' => [ + 'description' => '任务详情。', + 'type' => 'object', + 'properties' => [ + 'PageNumber' => [ + 'description' => '页码，大于0且不超过Integer的最大值，默认值为1。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'TotalPages' => [ + 'description' => '总页数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2', + ], + 'Extra' => [ + 'description' => '备份数据上云任务的附加信息。', + 'type' => 'string', + 'example' => 'dbtest', + ], + 'TotalElements' => [ + 'description' => '总备份任务数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '每页的记录数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + 'Content' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'List' => [ + 'description' => '任务详情。', + 'type' => 'array', + 'items' => [ + 'description' => '任务详情。', + 'type' => 'object', + 'properties' => [ + 'TaskId' => [ + 'description' => '下载任务ID。', + 'type' => 'string', + 'example' => 'dt-qxntlvgu****', + ], + 'RegionCode' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'Format' => [ + 'description' => '下载转换的目标格式，返回值如下：'."\n" + ."\n" + .'- **csv**'."\n" + .'- **SQL**'."\n" + .'- **Parquet**', + 'type' => 'string', + 'example' => 'csv', + ], + 'DbList' => [ + 'description' => '数据库列表。', + 'type' => 'string', + 'example' => '[dbtest]', + ], + 'BakSetId' => [ + 'description' => '全量备份集ID。', + 'type' => 'string', + 'example' => '148261****', + ], + 'DownloadStatus' => [ + 'description' => '下载任务的状态，返回值如下：'."\n" + ."\n" + .'- **initializing**：初始化。'."\n" + .'- **queueing**：排队中。'."\n" + .'- **running**：下载中。'."\n" + .'- **failed**：下载失败。'."\n" + .'- **finished**：下载成功。'."\n" + .'- **expired**：下载过期。', + 'type' => 'string', + 'example' => 'queueing', + ], + 'ExportDataSize' => [ + 'description' => '导出数据量，单位为字节（Byte）。', + 'type' => 'string', + 'example' => '0', + ], + 'ImportDataSize' => [ + 'description' => '处理数据量，单位为字节（Byte）。', + 'type' => 'string', + 'example' => '0', + ], + 'BackupSetTime' => [ + 'description' => '任意时间点下载任务时所对应的时间点，Long类型时间戳，单位为毫秒（ms）。', + 'type' => 'string', + 'example' => '1663162216000', + ], + 'TargetType' => [ + 'description' => '下载目标类型，返回值如下：'."\n" + ."\n" + .'- **OSS**'."\n" + .'- **URL**', + 'type' => 'string', + 'example' => 'URL', + ], + 'TargetPath' => [ + 'description' => '当**TargetType=OSS**时，返回数据下载目标路径。', + 'type' => 'string', + 'example' => 'test_db/path', + ], + 'Progress' => [ + 'description' => '已导出表数量/需导出表总数量。', + 'type' => 'string', + 'example' => '0/0', + ], + 'GmtCreate' => [ + 'description' => '任务创建时间，返回格式为时间戳形式。', + 'type' => 'string', + 'example' => '1663321957000', + ], + ], + ], + ], + ], + 'description' => '', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'Request.Forbidden', + 'errorMessage' => 'Have no Permissions', + 'description' => '当前操作未被授权，请联系主账号在RAM控制台进行授权后再执行操作', + ], + ], + ], + 'responseDemo' => '[{"type":"json","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}","errorExample":""},{"type":"xml","example":"\\n 5D285EB9-A443-592D-9F3D-A888FAC3****\\n \\n 0\\n 20\\n \\n \\n 148261****\\n 0/0\\n 1663321957000\\n dt-qxntlvgu****\\n csv\\n 1663162216000\\n cn-hangzhou\\n queueing\\n 0\\n URL\\n 0\\n \\n \\n 148145****\\n 0/0\\n 1663321935000\\n dt-uvbegmuc****\\n csv\\n 1663055892000\\n cn-hangzhou\\n running\\n 0\\n URL\\n 0\\n \\n \\n \\n Success\\n true\\n Success\\n","errorExample":""}]', + 'title' => '查询下载任务列表', + 'description' => '### 适用引擎'."\n" + ."\n" + .'- RDS MySQL（云盘系列）'."\n" + .'- RDS PostgreSQL'."\n" + .'- PolarDB MySQL版'."\n" + .'- MongoDB'."\n" + ."\n" + .'### 相关功能文档'."\n" + ."\n" + .'- [RDS MySQL下载备份](~~98819~~)'."\n" + .'- [RDS PostgreSQL下载备份](~~96774~~)'."\n" + .'- [PolarDB MySQL版下载备份](~~2627635~~)'."\n" + .'- [MongoDB下载备份](~~55011~~)', + 'changeSet' => [ + [ + 'createdAt' => '2022-11-16T11:43:03.000Z', + 'description' => '响应参数发生变更', + ], + ], + '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' => '查询沙箱备份集。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'BackupPlanId', + 'in' => 'query', + 'schema' => [ + 'description' => '备份计划ID。'."\n" + .'> 若您的实例为RDS MySQL，请通过[自动添加数据源](~~193091~~)功能，将RDS自动添加至DBS中，即可获取备份计划ID。', + 'type' => 'string', + 'required' => true, + 'example' => '1hxxxx8xxxxxa', + ], + ], + [ + 'name' => 'BackupSetId', + 'in' => 'query', + 'schema' => [ + 'description' => '备份集ID。若您传入该参数，仅返回该备份集的快照信息；若不传入该参数，将返回该备份计划的所有快照信息。', + 'type' => 'string', + 'required' => false, + 'example' => '1xxxx2xxxxx1e', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页的记录数。取值如下：'."\n" + .'- 30（默认）'."\n" + .'- 50'."\n" + .'- 100', + 'type' => 'string', + 'required' => false, + 'example' => '30', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '页码，大于0且不超过Integer的最大值，默认值为1。', + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Data' => [ + 'description' => '参数说明：'."\n" + .'- **backupSetTime**：快照时间点，格式为yyyy-MM-ddTHH:mm:ssZ（UTC时间）。'."\n" + .'- **backupSetId**：备份集ID。'."\n" + .'- **backupSetType**：快照类型，**Full**表示全量备份集快照、**Inc**表示增量备份快照。'."\n" + .'- **backupPlanId**：备份计划ID。', + '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 },', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '4F1888AC-1138-4995-B9FE-D2734F61C058', + ], + 'ErrCode' => [ + 'description' => '错误码。', + 'type' => 'string', + 'example' => 'Param.NotFound', + ], + 'Success' => [ + 'description' => '是否请求成功。', + 'type' => 'string', + 'example' => 'true', + ], + 'ErrMessage' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'The specified parameter %s value is not valid.', + ], + 'Code' => [ + 'description' => '错误码。', + 'type' => 'string', + 'example' => 'Param.NotFound', + ], + 'Message' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'The specified parameter %s value is not valid.', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'Request.Forbidden', + 'errorMessage' => 'Have no Permissions', + 'description' => '当前操作未被授权，请联系主账号在RAM控制台进行授权后再执行操作', + ], + ], + ], + 'title' => '查询快照列表', + 'description' => '执行该操作前，您需要先开启数据库实例的沙箱功能，详情请参见[RDS MySQL应急恢复](~~203154~~)或[自建MySQL应急恢复（沙箱实例）](~~185577~~)。'."\n" + .'当前接口仅支持DBS API服务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' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","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}","errorExample":""},{"type":"xml","example":"3A6295D0-93C3-1FA4-8D5C-97B05379F519\\n\\n 2\\n 2\\n \\n 2021-08-28T23:12:31Z\\n Inc_1hxxxx8xxxxxa_20210801064200_mysql-bin.000134\\n Inc\\n 1hxxxx8xxxxxa\\n \\n \\n 2021-08-28T22:42:28Z\\n 1hxxxx8xxxxxa_20210829064228\\n FULL\\n 1hxxxx8xxxxxa\\n \\n 2\\n\\nSuccess\\ntrue\\nSuccess","errorExample":""}]', + ], + 'DescribeSandboxInstances' => [ + 'summary' => '查看当前账号下的沙箱实例列表。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'BackupPlanId', + 'in' => 'query', + 'schema' => [ + 'description' => '备份计划ID，您可以通过[DescribeBackupPlanList](~~437215~~)接口获取该参数。'."\n" + .'> 若您的实例为RDS MySQL，请通过[自动添加数据源](~~193091~~)功能，将RDS自动添加至DBS中，即可获取备份计划ID。', + 'type' => 'string', + 'required' => true, + 'example' => '1hxxxx8xxxxxa', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '沙箱实例ID，您可以通过[CreateSandboxInstance](~~437252~~)接口获取该参数。', + 'type' => 'string', + 'required' => false, + 'example' => '1jxxxxnxxx1xc', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页的记录数。取值：'."\n" + .'- 30（默认）'."\n" + .'- 50'."\n" + .'- 100', + 'type' => 'string', + 'required' => false, + 'example' => '30', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '页码，大于0且不超过Integer的最大值，默认值为1。', + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Data' => [ + 'description' => '参数说明：'."\n" + .'- **connectionString**：沙箱实例的连接字符串，格式为IP:Port。当SandboxType为**Sandbox**时，该参数表示沙箱实例的连接地址；当SandboxType为**NFS**时，该参数表示NFS挂载地址。'."\n" + .'- **restoreSeconds**：创建沙箱实例所需的时长，单位为秒。'."\n" + .'- **restoreTime**：恢复的时间点，格式为yyyy-MM-ddTHH:mm:ssZ（UTC时间）。'."\n" + .'- **instanceId**：沙箱实例ID。'."\n" + .'- **backupSetId**：备份集ID。'."\n" + .'- **createTime**：沙箱实例的创建时间，格式为yyyy-MM-ddTHH:mm:ssZ（UTC时间）。'."\n" + .'- **backupPlanId**：备份计划ID。'."\n" + .'- **vpcId**：专有网络VPC（Virtual Private Cloud） ID。'."\n" + .'- **vpcSwitchId**：VPC交换机ID。'."\n" + .'- **sandboxSpecification**：沙箱实例规格。'."\n" + .'- **status**：沙箱实例状态，运行中（**running**）、预检查通过（**check_pass**）、异常（**stop**）。'."\n", + '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 }', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '4F1888AC-1138-4995-B9FE-D2734F61C058', + ], + 'ErrCode' => [ + 'description' => '错误码。', + 'type' => 'string', + 'example' => 'Param.NotFound', + ], + 'Success' => [ + 'description' => '是否请求成功。', + 'type' => 'string', + 'example' => 'true', + ], + 'ErrMessage' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'The specified parameter %s value is not valid.', + ], + 'Code' => [ + 'description' => '错误码。', + 'type' => 'string', + 'example' => 'Param.NotFound', + ], + 'Message' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'The specified parameter %s value is not valid.', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'Request.Forbidden', + 'errorMessage' => 'Have no Permissions', + 'description' => '当前操作未被授权，请联系主账号在RAM控制台进行授权后再执行操作', + ], + ], + ], + 'title' => '查看沙箱实例列表', + 'description' => '当前接口仅支持DBS API服务2021-01-01版本。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' | 错误码 | 报错消息 | 可能原因 |'."\n" + .'| -------------- | -------------------------- | -------------------------------------- |'."\n" + .'| DBS.NotExisted | no valid job exist with id | InstanceId参数所对应的备份计划不存在。 |', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dbs:DescribeSandboxInstances', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DBS', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","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}","errorExample":""},{"type":"xml","example":"96A7FD36-9C81-5AA1-A605-C98ED00B0931\\n\\n 2\\n 2\\n \\n 172.27.135.92:3306\\n 64\\n 2021-08-16T13:25:21Z\\n 1jxxxxx9xxxxh\\n BINLOG_1hxxxx8xxxxxa_20210811152624_mysql-bin.000031\\n 2021-08-16T13:43:09Z\\n 1hxxxx8xxxxxa\\n vpc-bp1dxxxxxjy0xxxxx1xxp\\n MYSQL_1C_1M_SD\\n running\\n vsw-bp1bxxxxxumxxxxxwxxx9\\n \\n \\n 172.26.178.229:3306\\n 15\\n 2021-08-11T07:26:24Z\\n 1jxxxxx9xxxms\\n 1hxxxx8xxxxxa_20210811152624\\n 2021-08-12T07:40:29Z\\n 1hxxxx8xxxxxa\\n vpc-bp1dxxxxxjy0xxxxx1xxp\\n MYSQL_1C_1M_SD\\n running\\n vsw-bp1bxxxxxumxxxxxwxx2w\\n \\n 2\\n\\nSuccess\\ntrue\\nSuccess","errorExample":""}]', + ], + 'DescribeSandboxRecoveryTime' => [ + 'summary' => '查看沙箱实例的可恢复时间范围。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'BackupPlanId', + 'in' => 'query', + 'schema' => [ + 'description' => '备份计划ID，您可以通过[DescribeBackupPlanList](~~437215~~)接口获取该参数。获取到的备份计划ID传入时，必须去掉前缀dbs，否则将调用失败。'."\n" + ."\n" + .'> 若您的实例为RDS MySQL，请通过[自动添加数据源](~~193091~~)功能，将RDS自动添加至DBS中，即可获取备份计划ID。', + 'type' => 'string', + 'required' => true, + 'example' => '1jyjal15l****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '4F1888AC-1138-4995-B9FE-D2734F61C058', + ], + 'ErrCode' => [ + 'description' => '错误码。', + 'type' => 'string', + 'example' => 'Param.NotFound', + ], + 'Success' => [ + 'description' => '是否请求成功。', + 'type' => 'string', + 'example' => 'true', + ], + 'ErrMessage' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'The specified parameter %s value is not valid.', + ], + 'Code' => [ + 'description' => '错误码。', + 'type' => 'string', + 'example' => 'Param.NotFound', + ], + 'Message' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'The specified parameter %s value is not valid.', + ], + 'Data' => [ + 'description' => '返回参数。', + 'type' => 'object', + 'properties' => [ + 'RecoveryEndTime' => [ + 'description' => '可恢复的截止时间，格式：yyyy-MM-ddTHH:mm:ssZ（UTC时间）。', + 'type' => 'string', + 'example' => '2021-08-02T12:01:01Z', + ], + 'BackupPlanId' => [ + 'description' => '沙箱实例的备份计划。', + 'type' => 'string', + 'example' => '1hxxxx8xxxxxa', + ], + 'RecoveryBeginTime' => [ + 'description' => '可恢复的开始时间，格式：yyyy-MM-ddTHH:mm:ssZ（UTC时间）。', + 'type' => 'string', + 'example' => '2021-08-01T12:01:01Z', + ], + ], + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'Request.Forbidden', + 'errorMessage' => 'Have no Permissions', + 'description' => '当前操作未被授权，请联系主账号在RAM控制台进行授权后再执行操作', + ], + ], + ], + 'title' => '查看可恢复时间范围', + 'description' => '执行该操作前，您需要先开启数据库实例的沙箱功能，详情请参见[RDS MySQL应急恢复](~~203154~~)或[自建MySQL应急恢复（沙箱实例）](~~185577~~)。'."\n" + .'当前接口仅支持DBS API服务2021-01-01版本。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dbs:DescribeSandboxRecoveryTime', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DBS', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","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}","errorExample":""},{"type":"xml","example":"2FC5BFF1-C6AB-594A-9C54-34F9E3A67380\\n\\n 2021-08-30T10:49:18Z\\n 2021-08-23T13:25:12Z\\n 1hxxxx8xxxxxa\\n\\nSuccess\\ntrue\\nSuccess","errorExample":""}]', + ], + 'ModifyBackupPolicy' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '221284', + 'abilityTreeNodes' => [ + 'FEATUREcbsYWT1H7', + 'FEATUREcbsPNQ3FN', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionCode', + 'in' => 'query', + 'schema' => [ + 'description' => '备份集所在地域。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + ], + ], + [ + 'name' => 'PreferredBackupWindowBegin', + 'in' => 'query', + 'schema' => [ + 'description' => '基础备份窗口开始时间。', + 'type' => 'string', + 'required' => false, + 'example' => '17:00Z', + ], + ], + [ + 'name' => 'InstanceName', + 'in' => 'query', + 'schema' => [ + 'description' => 'PolarDB实例ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'pc-2ze3nrr64c5****', + ], + ], + [ + 'name' => 'Category', + 'in' => 'query', + 'schema' => [ + 'description' => '备份类型'."\n" + .'- **Flash**：秒级备份'."\n" + .'- **Standard**：普通备份', + 'type' => 'string', + 'required' => false, + 'example' => 'Flash', + ], + ], + [ + 'name' => 'AdvanceLogPolicies', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'type' => 'array', + 'items' => [ + 'title' => '', + 'type' => 'object', + 'properties' => [ + 'LogRetentionType' => [ + 'type' => 'string', + ], + 'DestType' => [ + 'type' => 'string', + ], + 'FilterType' => [ + 'type' => 'string', + ], + 'ActionType' => [ + 'type' => 'string', + ], + 'SrcRegion' => [ + 'type' => 'string', + ], + 'EnableLogBackup' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + 'SrcType' => [ + 'type' => 'string', + 'required' => false, + ], + 'LogRetentionValue' => [ + 'type' => 'string', + ], + 'PolicyId' => [ + 'type' => 'string', + ], + 'FilterKey' => [ + 'type' => 'string', + ], + 'DestRegion' => [ + 'type' => 'string', + ], + 'FilterValue' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + [ + 'name' => 'AdvanceDataPolicies', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '数据备份策略详情。', + 'type' => 'array', + 'items' => [ + 'title' => '', + 'description' => '策略详情。', + 'type' => 'object', + 'properties' => [ + 'DestType' => [ + 'title' => '备份策略目标类型'."\n" + .' db - 数据库'."\n" + .' level1 - 一级备份'."\n" + .' level2 - 二级备份'."\n" + .' level2Cross - 二级跨地域备份', + 'description' => '备份策略目标类型，取值如下：'."\n" + ."\n" + .'- **db**：数据库'."\n" + .'- **level1**：一级备份'."\n" + .'- **level2**：二级备份'."\n" + .'- **level2Cross**：二级跨地域备份', + 'type' => 'string', + 'required' => false, + 'example' => 'level1', + ], + 'FilterType' => [ + 'title' => '高级策略筛选类型'."\n" + .' Crontab - 周期调度'."\n" + .' Event - 事件调度', + 'description' => '高级策略筛选类型，取值如下：'."\n" + ."\n" + .'- **crontab**：周期调度'."\n" + .'- **event**：事件调度', + 'type' => 'string', + 'required' => false, + 'example' => 'crontab', + ], + 'ActionType' => [ + 'title' => '操作类型，CREATE，UPDATE，DELETE', + 'description' => '操作类型，取值如下：'."\n" + ."\n" + .'- **CREATE**：新增'."\n" + .'- **UPDATE**：修改'."\n" + .'- **DELETE**：删除', + 'type' => 'string', + 'required' => false, + 'example' => 'UPDATE', + ], + 'SrcRegion' => [ + 'title' => '备份策略源region', + 'description' => '备份策略源地域。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + ], + 'SrcType' => [ + 'title' => '备份策略源类型'."\n" + .' db - 数据库'."\n" + .' level1 - 一级备份'."\n" + .' level2 - 二级备份'."\n" + .' level2Cross - 二级跨地域备份', + 'description' => '备份策略源类型，取值如下：'."\n" + ."\n" + .'- **db**：数据库'."\n" + .'- **level1**：一级备份'."\n" + .'- **level2**：二级备份'."\n" + .'- **level2Cross**：二级跨地域备份', + 'type' => 'string', + 'required' => false, + 'example' => 'db', + ], + 'OnlyPreserveOneEachDay' => [ + 'title' => '一天之前的高频备份集，是否只保留每天一个', + 'description' => '一天之前的高频备份集，是否只保留每天一个', + 'type' => 'boolean', + 'required' => false, + ], + 'RetentionValue' => [ + 'title' => '过期天数', + 'description' => '过期天数。', + 'type' => 'string', + 'required' => false, + 'example' => '4', + ], + 'PolicyId' => [ + 'title' => '高级策略ID', + 'description' => '高级策略ID，可调用[DescribeBackupPolicy](~~2869783~~)查看。', + 'type' => 'string', + 'required' => false, + 'example' => '6s67c7i3y8f8p72808p******', + ], + 'FilterKey' => [ + 'title' => '调度类型，当前仅当filterType为crontab时有效'."\n" + .'dayOfWeek - 按周调度'."\n" + .'dayOfMonth - 按月调度'."\n" + .'dayOfYear - 按年调度'."\n" + .'backupInterval - 固定间隔调度', + 'description' => '调度类型，取值如下：'."\n" + ."\n" + .'- **dayOfWeek**：按周调度'."\n" + .'- **dayOfMonth**：按月调度'."\n" + .'- **dayOfYear**：按年调度'."\n" + .'- **backupInterval**：固定间隔调度'."\n" + ."\n" + .'> 仅当FilterType为**crontab**时，返回该参数。', + 'type' => 'string', + 'required' => false, + 'example' => 'backupInterval', + ], + 'DestRegion' => [ + 'title' => '备份策略目标region', + 'description' => '备份策略目标地域。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + ], + 'FilterValue' => [ + 'title' => '具体Filter的值', + 'description' => '备份周期。', + 'type' => 'string', + 'required' => false, + 'example' => '180', + ], + 'RetentionType' => [ + 'title' => '保留周期类型'."\n" + .' Never - 永不过期'."\n" + .' Delay - 固定天数过期', + 'description' => '备份集保留周期类型，取值如下：'."\n" + ."\n" + .'- **never**：永不过期'."\n" + .'- **delay**：固定天数过期', + 'type' => 'string', + 'required' => false, + 'example' => 'delay', + ], + 'StorageClass' => [ + 'type' => 'string', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + [ + 'name' => 'AdvanceIncPolicies', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'type' => 'array', + 'items' => [ + 'title' => '', + 'type' => 'object', + 'properties' => [ + 'DestType' => [ + 'type' => 'string', + ], + 'FilterType' => [ + 'type' => 'string', + ], + 'ActionType' => [ + 'type' => 'string', + ], + 'SrcRegion' => [ + 'type' => 'string', + ], + 'SrcType' => [ + 'type' => 'string', + 'required' => false, + ], + 'OnlyPreserveOneEachDay' => [ + 'type' => 'boolean', + ], + 'RetentionValue' => [ + 'type' => 'string', + ], + 'PolicyId' => [ + 'type' => 'string', + ], + 'FilterKey' => [ + 'type' => 'string', + ], + 'DestRegion' => [ + 'type' => 'string', + ], + 'FilterValue' => [ + 'type' => 'string', + ], + 'RetentionType' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + [ + 'name' => 'BackupRetentionPolicyOnClusterDeletion', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + ], + ], + [ + 'name' => 'BackupMethod', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + ], + ], + [ + 'name' => 'BackupPriority', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + ], + [ + 'name' => 'EnableIncBackup', + 'in' => 'query', + 'schema' => [ + 'type' => 'boolean', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回参数详情。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'D570F209-A166-50C6-98A3-155A20B218B7', + ], + 'Message' => [ + 'description' => '返回信息。', + 'type' => 'string', + 'example' => 'instanceName can not be empty.', + ], + 'Data' => [ + 'description' => '备份策略详情。', + 'type' => 'object', + 'properties' => [ + 'PreferredBackupWindowBegin' => [ + 'title' => '基础备份窗口开始时间', + 'description' => '基础备份窗口开始时间。', + 'type' => 'string', + 'example' => '17:00Z', + ], + 'PreferredBackupWindow' => [ + 'title' => '基础备份窗口', + 'description' => '基础备份窗口。', + 'type' => 'string', + 'example' => '17:00Z-18:00Z', + ], + 'Category' => [ + 'description' => '是否开启秒级备份，返回值如下：'."\n" + ."\n" + .'- **Flash**：已开启秒级备份'."\n" + .'- **Standard**：普通备份'."\n" + ."\n" + .'> 该参数仅对MySQL生效。', + 'type' => 'string', + 'example' => 'Standard', + ], + 'AdvanceLogPolicies' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'LogRetentionType' => [ + 'type' => 'string', + ], + 'DestType' => [ + 'type' => 'string', + ], + 'FilterType' => [ + 'type' => 'string', + ], + 'SrcRegion' => [ + 'type' => 'string', + ], + 'EnableLogBackup' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + 'SrcType' => [ + 'type' => 'string', + ], + 'PolicyId' => [ + 'type' => 'string', + ], + 'DestRegion' => [ + 'type' => 'string', + ], + 'LogRetentionValue' => [ + 'type' => 'string', + ], + 'FilterKey' => [ + 'type' => 'string', + ], + 'FilterValue' => [ + 'type' => 'string', + ], + ], + ], + ], + 'AdvanceDataPolicies' => [ + 'description' => '数据备份策略详情。', + 'type' => 'array', + 'items' => [ + 'description' => '策略详情。', + 'type' => 'object', + 'properties' => [ + 'RetentionValue' => [ + 'title' => '过期天数', + 'description' => '过期天数。', + 'type' => 'string', + 'example' => '4', + ], + 'BakType' => [ + 'title' => '备份类型 F - 全量 L 日志', + 'description' => '备份类型，返回值如下：'."\n" + ."\n" + .'- **F**：全量备份'."\n" + .'- **L**：日志备份', + 'type' => 'string', + 'example' => 'F', + ], + 'FilterKey' => [ + 'title' => '调度类型，当前仅当filterType为crontab时有效'."\n" + .'dayOfWeek - 按周调度'."\n" + .'dayOfMonth - 按月调度'."\n" + .'dayOfYear - 按年调度'."\n" + .'backupInterval - 固定间隔调度', + 'description' => '调度类型，返回值如下：'."\n" + ."\n" + .'- **dayOfWeek**：按周调度'."\n" + .'- **dayOfMonth**：按月调度'."\n" + .'- **dayOfYear**：按年调度'."\n" + .'- **backupInterval**：固定间隔调度'."\n" + ."\n" + .'> 仅当FilterType为**crontab**时，返回该参数。', + 'type' => 'string', + 'example' => 'backupInterval', + ], + 'FilterValue' => [ + 'title' => '具体Filter的值', + 'description' => '备份周期。', + 'type' => 'string', + 'example' => '180', + ], + 'DestType' => [ + 'title' => '备份策略目标类型'."\n" + .' db - 数据库'."\n" + .' level1 - 一级备份'."\n" + .' level2 - 二级备份'."\n" + .' level2Cross - 二级跨地域备份', + 'description' => '备份策略目标类型，返回值如下：'."\n" + ."\n" + .'- **db**：数据库'."\n" + .'- **level1**：一级备份'."\n" + .'- **level2**：二级备份'."\n" + .'- **level2Cross**：二级跨地域备份', + 'type' => 'string', + 'example' => 'level1', + ], + 'FilterType' => [ + 'title' => '高级策略筛选类型'."\n" + .' Crontab - 周期调度'."\n" + .' Event - 事件调度', + 'description' => '高级策略筛选类型，返回值如下：'."\n" + ."\n" + .'- **crontab**：周期调度'."\n" + .'- **event**：事件调度', + 'type' => 'string', + 'example' => 'crontab', + ], + 'SrcRegion' => [ + 'title' => '备份策略源region', + 'description' => '备份策略源地域。', + 'type' => 'string', + 'example' => 'cn-shanghai', + ], + 'AutoCreated' => [ + 'title' => '是否系统自动生成', + 'description' => '是否为系统自动生成的备份策略，返回值如下：'."\n" + ."\n" + .'- **true**：系统生成策略'."\n" + .'- **false**：用户自定义策略', + 'type' => 'boolean', + 'example' => 'false', + ], + 'SrcType' => [ + 'title' => '备份策略源类型'."\n" + .' db - 数据库'."\n" + .' level1 - 一级备份'."\n" + .' level2 - 二级备份'."\n" + .' level2Cross - 二级跨地域备份', + 'description' => '备份策略源类型，返回值如下：'."\n" + ."\n" + .'- **db**：数据库'."\n" + .'- **level1**：一级备份'."\n" + .'- **level2**：二级备份'."\n" + .'- **level2Cross**：二级跨地域备份', + 'type' => 'string', + 'example' => 'db', + ], + 'OnlyPreserveOneEachDay' => [ + 'description' => 'onlyPreserveOneEachDay'."\n" + .'- **true**：每天只保留一个'."\n" + .'- **false**：全保留', + 'type' => 'boolean', + 'example' => 'true', + ], + 'DumpAction' => [ + 'title' => '转储策略'."\n" + .' Copy - 复制'."\n" + .' Move - 转储', + 'description' => '转储策略详情，返回值如下：'."\n" + ."\n" + .'- **copy**：复制'."\n" + .'- **move**：转储', + 'type' => 'string', + 'example' => 'copy', + ], + 'PolicyId' => [ + 'title' => '高级策略ID', + 'description' => '高级策略ID。', + 'type' => 'string', + 'example' => 'dc13b153acc91141789122c23835****', + ], + 'DestRegion' => [ + 'title' => '备份策略目标region', + 'description' => '备份策略目标地域。', + 'type' => 'string', + 'example' => 'cn-shanghai', + ], + 'RetentionType' => [ + 'title' => '保留周期类型'."\n" + .' Never - 永不过期'."\n" + .' Delay - 固定天数过期', + 'description' => '备份集保留周期类型，返回值如下：'."\n" + ."\n" + .'- **never**：永不过期'."\n" + .'- **delay**：固定天数过期', + 'type' => 'string', + 'example' => 'delay', + ], + 'StorageClass' => [ + 'type' => 'string', + ], + ], + ], + ], + 'AdvanceIncPolicies' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'RetentionValue' => [ + 'type' => 'string', + ], + 'BakType' => [ + 'type' => 'string', + ], + 'FilterKey' => [ + 'type' => 'string', + ], + 'FilterValue' => [ + 'type' => 'string', + ], + 'DestType' => [ + 'type' => 'string', + ], + 'FilterType' => [ + 'type' => 'string', + ], + 'SrcRegion' => [ + 'type' => 'string', + ], + 'AutoCreated' => [ + 'type' => 'boolean', + ], + 'SrcType' => [ + 'type' => 'string', + ], + 'OnlyPreserveOneEachDay' => [ + 'type' => 'boolean', + ], + 'DumpAction' => [ + 'type' => 'string', + ], + 'PolicyId' => [ + 'type' => 'string', + ], + 'DestRegion' => [ + 'type' => 'string', + ], + 'RetentionType' => [ + 'type' => 'string', + ], + ], + ], + ], + 'BackupRetentionPolicyOnClusterDeletion' => [ + 'type' => 'string', + ], + 'BackupMethod' => [ + 'type' => 'string', + ], + 'BackupPriority' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'EnableIncBackup' => [ + 'type' => 'boolean', + ], + ], + ], + 'ErrMessage' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'The specified parameter %s value is not valid.', + ], + 'Code' => [ + 'description' => '状态码。', + 'type' => 'string', + 'example' => 'Success', + ], + 'Success' => [ + 'description' => '请求是否成功，返回值如下：'."\n" + .'- **true**：请求成功'."\n" + .'- **false**：请求失败', + 'type' => 'string', + 'example' => 'true', + ], + 'ErrCode' => [ + 'description' => '错误码。', + 'type' => 'string', + 'example' => 'Success', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'Request.Forbidden', + 'errorMessage' => 'Have no Permissions', + 'description' => '当前操作未被授权，请联系主账号在RAM控制台进行授权后再执行操作', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'title' => '修改备份策略', + 'summary' => '修改PolarDB实例备份策略。', + 'description' => '### 适用引擎'."\n" + .'PolarDB MySQL版'."\n" + ."\n" + .'> 当前该接口仅针对特定客户开放使用，如有需求，请到DBS客户咨询群（钉钉群号：35585947）申请使用。', + 'changeSet' => [ + [ + 'createdAt' => '2024-09-24T08:37:35.000Z', + 'description' => '请求参数发生变更、响应参数发生变更', + ], + [ + 'createdAt' => '2024-05-28T13:59:23.000Z', + 'description' => '请求参数发生变更', + ], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dbs:ModifyBackupPolicy', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DBS', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D570F209-A166-50C6-98A3-155A20B218B7\\",\\n \\"Message\\": \\"instanceName can not be empty.\\",\\n \\"Data\\": {\\n \\"PreferredBackupWindowBegin\\": \\"17:00Z\\",\\n \\"PreferredBackupWindow\\": \\"17:00Z-18:00Z\\",\\n \\"Category\\": \\"Standard\\",\\n \\"AdvanceLogPolicies\\": [\\n {\\n \\"LogRetentionType\\": \\"\\",\\n \\"DestType\\": \\"\\",\\n \\"FilterType\\": \\"\\",\\n \\"SrcRegion\\": \\"\\",\\n \\"EnableLogBackup\\": 0,\\n \\"SrcType\\": \\"\\",\\n \\"PolicyId\\": \\"\\",\\n \\"DestRegion\\": \\"\\",\\n \\"LogRetentionValue\\": \\"\\",\\n \\"FilterKey\\": \\"\\",\\n \\"FilterValue\\": \\"\\"\\n }\\n ],\\n \\"AdvanceDataPolicies\\": [\\n {\\n \\"RetentionValue\\": \\"4\\",\\n \\"BakType\\": \\"F\\",\\n \\"FilterKey\\": \\"backupInterval\\",\\n \\"FilterValue\\": \\"180\\",\\n \\"DestType\\": \\"level1\\",\\n \\"FilterType\\": \\"crontab\\",\\n \\"SrcRegion\\": \\"cn-shanghai\\",\\n \\"AutoCreated\\": false,\\n \\"SrcType\\": \\"db\\",\\n \\"OnlyPreserveOneEachDay\\": true,\\n \\"DumpAction\\": \\"copy\\",\\n \\"PolicyId\\": \\"dc13b153acc91141789122c23835****\\",\\n \\"DestRegion\\": \\"cn-shanghai\\",\\n \\"RetentionType\\": \\"delay\\",\\n \\"StorageClass\\": \\"\\"\\n }\\n ],\\n \\"AdvanceIncPolicies\\": [\\n {\\n \\"RetentionValue\\": \\"\\",\\n \\"BakType\\": \\"\\",\\n \\"FilterKey\\": \\"\\",\\n \\"FilterValue\\": \\"\\",\\n \\"DestType\\": \\"\\",\\n \\"FilterType\\": \\"\\",\\n \\"SrcRegion\\": \\"\\",\\n \\"AutoCreated\\": true,\\n \\"SrcType\\": \\"\\",\\n \\"OnlyPreserveOneEachDay\\": true,\\n \\"DumpAction\\": \\"\\",\\n \\"PolicyId\\": \\"\\",\\n \\"DestRegion\\": \\"\\",\\n \\"RetentionType\\": \\"\\"\\n }\\n ],\\n \\"BackupRetentionPolicyOnClusterDeletion\\": \\"\\",\\n \\"BackupMethod\\": \\"\\",\\n \\"BackupPriority\\": 0,\\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' => '重试失败的高级下载任务。', + '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' => [ + 'description' => '实例所在地域ID，您可调用[DescribeDBInstanceAttribute（RDS实例）](~~26231~~)或[DescribeDBClusterAttribute（PolarDB实例）](~~2319132~~)查询。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'TaskId', + 'in' => 'query', + 'schema' => [ + 'description' => '任务ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'dt-example', + ], + ], + [ + 'name' => 'InstanceName', + 'in' => 'query', + 'schema' => [ + 'description' => '实例ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'rm-example', + ], + ], + [ + 'name' => 'ClusterName', + 'in' => 'query', + 'schema' => [ + 'title' => '仅MongoDB依赖，分片集群的集群名', + 'description' => '仅MongoDB依赖，分片集群的集群名', + 'type' => 'string', + 'required' => false, + 'example' => 'dds-example', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Data' => [ + 'description' => '下载任务详情。', + 'type' => 'string', + 'example' => '暂无', + ], + 'RequestId' => [ + 'description' => '请求id。', + 'type' => 'string', + 'example' => '49FE4E8E-39B9-56DE-BC07-5AEBFAXXXXXX', + ], + 'ErrCode' => [ + 'description' => '错误码。', + 'type' => 'string', + 'example' => 'Success', + ], + 'Success' => [ + 'description' => '是否成功。', + 'type' => 'string', + 'example' => 'True', + ], + 'ErrMessage' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'The specified parameter %s value is not valid.', + ], + 'Code' => [ + 'description' => '错误码。', + 'type' => 'string', + 'example' => 'Success', + ], + 'Message' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'instanceName can not be empty.', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'Request.Forbidden', + 'errorMessage' => 'Have no Permissions', + 'description' => '当前操作未被授权，请联系主账号在RAM控制台进行授权后再执行操作', + ], + ], + ], + 'title' => '重试高级下载任务', + 'description' => '### 适用引擎'."\n" + ."\n" + .'- RDS MySQL（云盘系列）'."\n" + .'- RDS PostgreSQL'."\n" + .'- PolarDB MySQL版'."\n" + .'- MongoDB'."\n" + ."\n" + .'### 相关功能文档'."\n" + ."\n" + .'- [RDS MySQL下载备份](~~98819~~)'."\n" + .'- [RDS PostgreSQL下载备份](~~96774~~)'."\n" + .'- [PolarDB MySQL版下载备份](~~2627635~~)'."\n" + .'- [MongoDB下载备份](~~55011~~)', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dbs:RetryDownloadTask', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DBS', + 'resourceType' => '全部资源', + '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' => '华北6（乌兰察布）', + 'areaId' => 'asiaPacific', + 'areaName' => '亚太', + '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' => '华北2（北京）', + 'areaId' => 'asiaPacific', + 'areaName' => '亚太', + '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' => '华北1（青岛）', + 'areaId' => 'asiaPacific', + 'areaName' => '亚太', + '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' => '华东2（上海）', + 'areaId' => 'asiaPacific', + 'areaName' => '亚太', + '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' => '中国香港', + 'areaId' => 'asiaPacific', + 'areaName' => '亚太', + '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' => '华北3（张家口）', + 'areaId' => 'asiaPacific', + 'areaName' => '亚太', + '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' => '华南1（深圳）', + 'areaId' => 'asiaPacific', + 'areaName' => '亚太', + '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' => '日本（东京）', + 'areaId' => 'asiaPacific', + 'areaName' => '亚太', + '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' => '西南1（成都）', + 'areaId' => 'asiaPacific', + 'areaName' => '亚太', + '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' => '新加坡', + 'areaId' => 'asiaPacific', + 'areaName' => '亚太', + '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' => '马来西亚（吉隆坡）', + 'areaId' => 'asiaPacific', + 'areaName' => '亚太', + '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' => '华北5（呼和浩特）', + 'areaId' => 'asiaPacific', + 'areaName' => '亚太', + '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' => '印度尼西亚（雅加达）', + 'areaId' => 'asiaPacific', + 'areaName' => '亚太', + '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' => '华东1（杭州）', + 'areaId' => 'asiaPacific', + 'areaName' => '亚太', + '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' => '美国（弗吉尼亚）', + 'areaId' => 'europeAmerica', + 'areaName' => '欧洲与美洲', + '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' => '英国（伦敦）', + 'areaId' => 'europeAmerica', + 'areaName' => '欧洲与美洲', + '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' => '美国（硅谷）', + 'areaId' => 'europeAmerica', + 'areaName' => '欧洲与美洲', + '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' => '德国（法兰克福）', + 'areaId' => 'europeAmerica', + 'areaName' => '欧洲与美洲', + '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' => '华南1 金融云', + 'areaId' => 'industryCloud', + 'areaName' => '行业云', + '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' => '华东2 金融云', + 'areaId' => 'industryCloud', + 'areaName' => '行业云', + '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' => '华东1 金融云', + 'areaId' => 'industryCloud', + 'areaName' => '行业云', + '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' => '备份计划配置错误', + ], + [ + 'code' => 'BackupPlanNotDescribe', + 'message' => 'describe backup plan failed -> null', + 'http_code' => 200, + 'description' => '查询备份计划列表失败', + ], + [ + 'code' => 'BackupPlanNotModify', + 'message' => 'modify backup source endpoint fail', + 'http_code' => 200, + 'description' => '修改备份源endpoint失败', + ], + [ + 'code' => 'DBS.DisasterCenter.NoPermission', + 'message' => 'no permission for this action.', + 'http_code' => 403, + 'description' => '该操作无权限。', + ], + [ + 'code' => 'DBS.DownloadTask.CannotFind', + 'message' => 'Can not find download task.', + 'http_code' => 200, + 'description' => '无法找到高级下载任务。', + ], + [ + 'code' => 'DBS.DownloadTask.JobAlreadyExist', + 'message' => 'Job already submit in recent days, please check it.', + 'http_code' => 200, + 'description' => '相同备份集的高级下载任务在近几天被提交过，请检查。', + ], + [ + 'code' => 'DBS.DownloadTask.OnlyOneRunningOrFailedTask', + 'message' => 'There can be only one running or failed task for the instance.', + 'http_code' => 200, + 'description' => '当前实例只能同时存在一个运行中/失败的任务。', + ], + [ + 'code' => 'DBS.DownloadTask.OssForbid', + 'message' => 'OSS is forbidden to access. Please check your OSS bucket.', + 'http_code' => 200, + 'description' => '访问OSS被拒绝。请检查您的OSS权限配置。', + ], + [ + 'code' => 'DBS.DownloadTask.OssStorageTypeInvalid', + 'message' => 'Unsupported bucket storage. Please make sure that your OSS bucket\'s storgae type is standard.', + 'http_code' => 200, + 'description' => '当前OSS bucket类型不支持。请确保您的OSS bucket类型是标准存储类型。', + ], + [ + 'code' => 'DBS.NoPermissionException', + 'message' => 'Rejected by ValidationChecker.', + 'http_code' => 403, + 'description' => 'Rejected by ValidationChecker.', + ], + [ + 'code' => 'DBS.NotExists', + 'message' => 'data source do not existed.', + 'http_code' => 404, + 'description' => 'DBS.NotExists', + ], + [ + 'code' => 'Forbidden.InstanceNotFound', + 'message' => 'instance not found', + 'http_code' => 200, + 'description' => '实例不存在', + ], + [ + 'code' => 'InternalError', + 'message' => 'internal error', + 'http_code' => 500, + 'description' => '内部错误', + ], + [ + 'code' => 'OperationDenied.JobStatus', + 'message' => 'The operation is not permitted.', + 'http_code' => 200, + 'description' => '当前操作不被允许', + ], + [ + 'code' => 'Request.Forbidden', + 'message' => 'Have no Permissions', + 'http_code' => 403, + 'description' => '当前操作未被授权，请联系主账号在RAM控制台进行授权后再执行操作', + ], + [ + 'code' => 'UserError', + 'message' => 'user error', + 'http_code' => 200, + 'description' => '用户使用问题', + ], + [ + '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' => '请求参数发生变更、响应参数发生变更', + 'api' => 'ModifyBackupPolicy', + ], + ], + 'createdAt' => '2024-09-24T08:37:03.000Z', + 'description' => '', + ], + [ + 'apis' => [ + [ + 'description' => '响应参数发生变更', + 'api' => 'DescribeBackupPolicy', + ], + [ + 'description' => '请求参数发生变更', + 'api' => 'ModifyBackupPolicy', + ], + ], + 'createdAt' => '2024-05-28T13:59:17.000Z', + 'description' => '', + ], + [ + 'apis' => [ + [ + 'description' => '响应参数发生变更', + 'api' => 'DescribeBackupPolicy', + ], + ], + 'createdAt' => '2024-05-16T11:16:56.000Z', + 'description' => '', + ], + [ + 'apis' => [ + [ + 'description' => '请求参数发生变更', + 'api' => 'ChangeResourceGroup', + ], + ], + 'createdAt' => '2023-12-21T13:43:30.000Z', + 'description' => '', + ], + [ + 'apis' => [ + [ + 'description' => '请求参数发生变更', + 'api' => 'CreateSandboxInstance', + ], + [ + 'description' => '请求参数发生变更', + 'api' => 'DeleteSandboxInstance', + ], + ], + 'createdAt' => '2023-08-18T07:28:29.000Z', + 'description' => '', + ], + [ + 'apis' => [ + [ + 'description' => '响应参数发生变更', + 'api' => 'DescribeDownloadTask', + ], + ], + 'createdAt' => '2022-11-16T11:45:26.000Z', + 'description' => 'DescribeDownloadTask更新，修改分页相关返回字段名', + ], + [ + 'apis' => [ + [ + 'description' => 'OpenAPI 下线', + 'api' => 'DescribeDBTablesRecoveryBackupSet', + ], + [ + 'description' => 'OpenAPI 下线', + 'api' => 'DescribeDBTablesRecoveryState', + ], + [ + 'description' => 'OpenAPI 下线', + 'api' => 'DescribeDBTablesRecoveryTimeRange', + ], + [ + 'description' => 'OpenAPI 下线', + 'api' => 'ModifyDBTablesRecoveryState', + ], + [ + 'description' => 'OpenAPI 下线', + 'api' => 'SupportDBTableRecovery', + ], + ], + 'createdAt' => '2022-10-18T14:32:36.000Z', + 'description' => '极速库表恢复openapi', + ], + [ + 'apis' => [ + [ + 'description' => '请求参数发生变更', + 'api' => 'DescribeDownloadBackupSetStorageInfo', + ], + [ + 'description' => '请求参数发生变更', + 'api' => 'DescribeDownloadSupport', + ], + ], + 'createdAt' => '2022-08-25T07:44:08.000Z', + 'description' => '修改参数必填属性', + ], + [ + 'apis' => [ + [ + 'description' => 'OpenAPI 下线', + 'api' => 'DescribeDownloadBackupSetStorageInfo', + ], + [ + 'description' => 'OpenAPI 下线', + 'api' => 'DescribeDownloadSupport', + ], + ], + 'createdAt' => '2022-08-03T09:24:36.000Z', + 'description' => 'DBS高级下载V3.2发布', + ], + [ + 'apis' => [ + [ + 'description' => 'OpenAPI 下线', + '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' => '数据库备份', + 'ramCodes' => [ + 'dbs', + ], + 'ramLevel' => '资源级', + 'ramConditions' => [], + 'ramActions' => [ + [ + 'apiName' => 'CreateAdvancedPolicy', + 'description' => '开启高级备份策略', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dbs:CreateAdvancedPolicy', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DBS', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'CreateDownload', + 'description' => '创建下载任务', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'dbs:CreateDownload', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DBS', + 'resourceType' => 'DBInstance', + 'arn' => 'acs:rds:{#regionId}:{#accountId}:dbinstance/{#DbInstanceId}', + ], + ], + ], + ], + [ + 'apiName' => 'DescribeDownloadTask', + 'description' => '查询下载任务列表', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dbs:DescribeDownloadTask', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DBS', + 'resourceType' => 'DBInstance', + 'arn' => 'acs:rds:{#regionId}:{#accountId}:dbinstance/{#DbInstanceId}', + ], + ], + ], + ], + [ + 'apiName' => 'DescribeBackupDataList', + 'description' => '查询备份数据', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'dbs:DescribeBackupDataList', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'conditional', + 'product' => 'DBS', + 'resourceType' => 'DBInstance', + 'arn' => 'acs:rds:{#regionId}:{#accountId}:dbinstance/{#DbInstanceId}', + ], + ], + ], + ], + [ + 'apiName' => 'DescribeCostInfoByDbsInstance', + 'description' => '根据dbs实例id获取收费详情。', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dbs:DescribeCostInfoByDbsInstance', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DBS', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'DescribeSandboxInstances', + 'description' => '查看沙箱实例列表', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dbs:DescribeSandboxInstances', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DBS', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'DescribeDownloadBackupSetStorageInfo', + 'description' => '查看下载备份集的存储信息', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dbs:DescribeDownloadBackupSetStorageInfo', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DBS', + 'resourceType' => 'BackupPlan', + 'arn' => 'acs:dbs:{#regionId}:{#accountId}:backupplan/{#BackupPlanId}', + ], + ], + ], + ], + [ + 'apiName' => 'ChangeResourceGroup', + 'description' => 'DBS资源转组API', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dbs:ChangeResourceGroup', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DBS', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'DeleteSandboxInstance', + 'description' => '释放沙箱实例', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'dbs:DeleteSandboxInstance', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DBS', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'DescribeBackupPolicy', + 'description' => '查询备份策略', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dbs:DescribeBackupPolicy', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DBS', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'DescribeSandboxRecoveryTime', + 'description' => '查看可恢复时间范围', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dbs:DescribeSandboxRecoveryTime', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DBS', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'DescribeSandboxBackupSets', + 'description' => '查询快照列表', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dbs:DescribeSandboxBackupSets', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DBS', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'RetryDownloadTask', + 'description' => '重试高级下载任务', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dbs:RetryDownloadTask', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DBS', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'DescribeDownloadSupport', + 'description' => '查询当前实例是否支持高级下载', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dbs:DescribeDownloadSupport', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DBS', + 'resourceType' => 'BackupPlan', + 'arn' => 'acs:dbs:{#regionId}:{#accountId}:backupplan/{#BackupPlanId}', + ], + ], + ], + ], + [ + 'apiName' => 'ModifyBackupPolicy', + 'description' => '修改备份策略', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dbs:ModifyBackupPolicy', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DBS', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + ], + 'resourceTypes' => [ + [ + 'validationType' => 'always', + 'resourceType' => 'DBInstance', + 'arn' => 'acs:rds:{#regionId}:{#accountId}:dbinstance/{#DbInstanceId}', + ], + [ + 'validationType' => 'always', + 'resourceType' => 'BackupPlan', + 'arn' => 'acs:dbs:{#regionId}:{#accountId}:backupplan/{#BackupPlanId}', + ], + [ + 'validationType' => 'always', + 'resourceType' => 'DataSource', + 'arn' => 'acs:dbs:{#regionId}:{#accountId}:', + ], + ], + ], +]; -- cgit v1.2.3