'1.0', 'info' => [ 'style' => 'RPC', 'product' => 'Drds', 'version' => '2019-01-23', ], 'directories' => [ [ 'id' => 117683, 'title' => '实例管理', 'type' => 'directory', 'children' => [ 'CreateDrdsInstance', 'CreateOrderForRds', 'ModifyDrdsInstanceDescription', 'UpdateResourceGroupAttribute', 'DescribeDrdsInstances', 'DescribeDrdsDbInstance', 'DescribeDrdsInstance', 'DescribeDrdsParams', 'DescribeDrdsTasks', 'DescribeHotDbList', 'DescribeInstanceSwitchAzone', 'DescribeInstanceSwitchNetwork', 'DescribeInstDbLogInfo', 'DescribePreCheckResult', 'DescribeRdsCommodity', 'RemoveDrdsInstance', ], ], [ 'id' => 117700, 'title' => '数据库管理', 'type' => 'directory', 'children' => [ 'CreateDrdsDB', 'DescribeDrdsDBs', 'DescribeDrdsDB', 'DescribeDrdsDbInstances', 'DescribeDrdsDbRdsNameList', 'DescribeDrdsShardingDbs', 'CheckDrdsDbName', 'RemoveDrdsDbFailedRecord', 'RemoveDrdsDb', ], ], [ 'id' => 117711, 'title' => '存储管理', 'type' => 'directory', 'children' => [ 'ModifyRdsReadWeight', 'DescribeRdsPerformanceSummary', 'DescribeRdsSuperAccountInstances', 'DescribeDrdsDBCluster', 'DescribeRDSPerformance', 'DescribeDbInstances', 'DescribeDbInstanceDbs', ], ], [ 'id' => 117719, 'title' => '账号管理', 'type' => 'directory', 'children' => [ 'CreateInstanceAccount', 'RemoveInstanceAccount', ], ], [ 'id' => 117722, 'title' => 'SQL审计', 'type' => 'directory', 'children' => [ 'EnableSqlAudit', 'DisableSqlAudit', 'DescribeDrdsSqlAuditStatus', 'DescribeInstDbSlsInfo', 'DescribeDrdsSlowSqls', 'CheckSqlAuditEnableStatus', ], ], [ 'id' => 117729, 'title' => '备份和恢复', 'type' => 'directory', 'children' => [ 'StartRestore', 'SetBackupPolicy', 'EnableSqlFlashbackMatchSwitch', 'DescribeBackMenu', 'DescribeRestoreOrder', 'DescribeBackupDbs', 'DescribeBackupSets', 'DescribeBackupPolicy', 'DescribeBackupTimes', 'RemoveBackupsSet', 'PutStartBackup', ], ], [ 'id' => 117741, 'title' => '网络和连接', 'type' => 'directory', 'children' => [ 'CreateInstanceInternetAddress', 'UpdateInstanceNetwork', 'ReleaseInstanceInternetAddress', ], ], [ 'id' => 117745, 'title' => '安全', 'type' => 'directory', 'children' => [ 'ModifyDrdsIpWhiteList', 'DescribeDrdsDBIpWhiteList', ], ], [ 'id' => 117748, 'title' => '扩容管理', 'type' => 'directory', 'children' => [ 'SubmitCleanTask', 'SubmitSmoothExpandPreCheck', 'CheckExpandStatus', 'SubmitHotExpandTask', 'SubmitHotExpandPreCheckTask', ], ], [ 'id' => 117756, 'title' => '任务管理', 'type' => 'directory', 'children' => [ 'DescribeSqlFlashbakTask', 'SubmitSqlFlashbackTask', ], ], [ 'id' => 117759, 'title' => '表拆分', 'type' => 'directory', 'children' => [ 'CreateShardTask', 'DescribeInstanceAccounts', 'DescribeExpandLogicTableInfoList', 'DescribeTable', 'DescribeTableListByType', 'DescribeShardTaskInfo', 'ValidateShardTask', ], ], [ 'id' => 117768, 'title' => '广播表', 'type' => 'directory', 'children' => [ 'SetupBroadcastTables', 'DescribeBroadcastTables', 'SwitchGlobalBroadcastType', ], ], [ 'id' => 117772, 'title' => '数据表管理', 'type' => 'directory', 'children' => [ 'SetupTable', 'DescribeTables', ], ], [ 'id' => 117775, 'title' => '标签和参数设置', 'type' => 'directory', 'children' => [ 'SetupDrdsParams', 'ListTagResources', 'TagResources', 'UntagResources', ], ], [ 'id' => 117780, 'title' => '实例版本', 'type' => 'directory', 'children' => [ 'DescribeDrdsInstanceVersion', 'DescribeDrdsInstanceLevelTasks', 'UpgradeInstanceVersion', ], ], [ 'id' => 117784, 'title' => '性能监控', 'type' => 'directory', 'children' => [ 'DescribeDrdsInstanceMonitor', 'DescribeDrdsInstanceDbMonitor', ], ], [ 'id' => 169169, 'title' => '其他', 'type' => 'directory', 'children' => [ 'ChangeAccountPassword', 'ChangeInstanceAzone', 'DescribeBackupLocal', 'DescribeDrdsRdsInstances', 'DescribeRecycleBinStatus', 'DescribeRecycleBinTables', 'EnableInstanceIpv6Address', 'FlashbackRecycleBinTable', 'GetDrdsDbRdsRelationInfo', 'ManagePrivateRds', 'ModifyAccountDescription', 'ModifyAccountPrivilege', 'ModifyPolarDbReadWeight', 'RefreshDrdsAtomUrl', 'RemoveRecycleBinTable', 'RestartDrdsInstance', 'RollbackInstanceVersion', 'SetBackupLocal', 'SetupRecycleBinStatus', 'SubmitSmoothExpandPreCheckTask', 'UpdatePrivateRdsClass', 'UpgradeHiStoreInstance', ], ], ], 'components' => [ 'schemas' => [], ], 'apis' => [ 'CreateDrdsInstance' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', ], 'parameters' => [ [ 'name' => 'Description', 'in' => 'query', 'schema' => [ 'description' => '实例描述，需满足如下要求：'."\n" ."\n" .'- 不能以http://或https://开头。'."\n" .'- 必须以字母或中文开头，可包含大小写字母、中文、数字、下划线（_）或短划线（-）。'."\n" .'- 长度为2~256个字符。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'test', ], ], [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => '地域ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', ], ], [ 'name' => 'ZoneId', 'in' => 'query', 'schema' => [ 'description' => '可用区ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou-e', ], ], [ 'name' => 'Type', 'in' => 'query', 'schema' => [ 'description' => '实例类型，仅支持PRIVATE，即专享实例。'."\n" ."\n" .'> 您也可以传入1表示专享实例。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'PRIVATE', 'enum' => [ 'PRIVATE', 'PUBLIC', '1', '0', ], ], ], [ 'name' => 'Quantity', 'in' => 'query', 'schema' => [ 'description' => '创建实例的数量，仅支持传入1，即一次只能创建一个实例。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '1', ], ], [ 'name' => 'InstanceSeries', 'in' => 'query', 'schema' => [ 'description' => '实例系列参数，取值范围如下：'."\n" ."\n" .'- **drds.sn2.4c16g**：入门版'."\n" .'- **drds.sn2.8c32g**：标准版'."\n" .'- **drds.sn2.16c64g**：企业版', 'type' => 'string', 'required' => true, 'example' => 'drds.sn2.4c16g', ], ], [ 'name' => 'Specification', 'in' => 'query', 'schema' => [ 'description' => '实例规格码，取值由实例系列加具体实例规格组成，例如drds.sn2.4c16g.8c32g。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'drds.sn2.4c16g.8C32g', ], ], [ 'name' => 'ClientToken', 'in' => 'query', 'schema' => [ 'description' => '用于保证请求的幂等性，防止重复提交请求。由客户端生成该参数值，要保证在不同请求间唯一，最大值不超过64个ASCII字符，且该参数值中不能包含非ASCII字符。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'c1dd299c-10c6-11ea-bbbb-************', ], ], [ 'name' => 'PayType', 'in' => 'query', 'schema' => [ 'description' => '付费类型，取值范围如下：'."\n" ."\n" .'- **drdsPre**：包年包月（也称预付费）。'."\n" .'- **drdsPost**：按量付费（也称后付费）。'."\n" .'- **drdsRo**：创建只读实例时，默认按量付费模式。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'drdsPost', ], ], [ 'name' => 'VpcId', 'in' => 'query', 'schema' => [ 'description' => '专有网络ID。', 'type' => 'string', 'required' => false, 'example' => 'vpc-**********', ], ], [ 'name' => 'VswitchId', 'in' => 'query', 'schema' => [ 'description' => '虚拟交换机ID。', 'type' => 'string', 'required' => false, 'example' => 'vsw-**********', ], ], [ 'name' => 'isHa', 'in' => 'query', 'schema' => [ 'description' => '是否为高可用实例。', 'type' => 'boolean', 'required' => false, 'example' => 'true', ], ], [ 'name' => 'PricingCycle', 'in' => 'query', 'schema' => [ 'description' => '指定预付费实例为包年或包月类型，取值范围如下：'."\n" ."\n" .'- **year**：年'."\n" .'- **month**：月'."\n" ."\n" .'> 若付费类型为drdsPre，该参数为必传参数。', 'type' => 'string', 'required' => false, 'example' => 'month', 'enum' => [ 'year', 'month', ], ], ], [ 'name' => 'Duration', 'in' => 'query', 'schema' => [ 'description' => '包年或包月实例的购买时长。'."\n" ."\n" .'- 当PricingCycle为year时，取值范围为1~3。'."\n" .'- 当PricingCycle为month时，取值范围为1~9。'."\n" ."\n" .'> 仅当付费类型是drdsPre时该参数生效。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], [ 'name' => 'IsAutoRenew', 'in' => 'query', 'schema' => [ 'description' => '是否自动续费，取值范围如下：'."\n" ."\n" .'- **true**：如果按月购买则自动续费一个月，如果按年购买则自动续费一年。'."\n" .'- **false**：不自动续费。'."\n" ."\n" .'> 仅当付费类型为drdsPre时该参数生效。', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'default' => 'false', ], ], [ 'name' => 'MasterInstId', 'in' => 'query', 'schema' => [ 'description' => '主实例ID，仅在创建只读实例时填写。', 'type' => 'string', 'required' => false, 'example' => 'drds***********', ], ], [ 'name' => 'MySQLVersion', 'in' => 'query', 'schema' => [ 'description' => '实例支持的MySQL版本，取值范围如下：'."\n" ."\n" .'- **5**：与MySQL 5.x完全兼容（默认）'."\n" .'- **8**：与MySQL 8.0完全兼容'."\n" ."\n" .'> 仅当创建主实例时该参数生效，只读实例的MySQL版本默认与主实例相同。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '5', ], ], [ 'name' => 'ResourceGroupId', 'in' => 'query', 'schema' => [ 'description' => '资源组ID。', 'type' => 'string', 'required' => false, 'example' => 'rg-************', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Success' => [ 'description' => '请求是否成功。', 'type' => 'boolean', 'example' => 'true', ], 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => 'D99D4644-A70D-49A3-B8B4-767ACC50SE2R', ], 'Data' => [ 'description' => '结果详情。', 'type' => 'object', 'properties' => [ 'OrderId' => [ 'description' => '订单ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '111111111111111', ], 'DrdsInstanceIdList' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'drdsInstanceIdList' => [ 'description' => '实例信息。', 'type' => 'array', 'items' => [ 'description' => '实例ID。', 'type' => 'string', 'example' => 'drds************', ], ], ], ], ], ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'ParameterError', 'errorMessage' => 'Parameter error', ], [ 'errorCode' => 'ActionUnauthorized', 'errorMessage' => 'The specified action is not available for you', ], [ 'errorCode' => 'ServiceUnable', 'errorMessage' => 'The service is not available now, please try again later', ], [ 'errorCode' => 'OperationDenied', 'errorMessage' => 'drds service is not enable for you', ], [ 'errorCode' => 'QuotaExceeded.DRDSInstance', 'errorMessage' => 'The quota of create instance exceeds.', ], [ 'errorCode' => 'InvalidRegionId.NotFound', 'errorMessage' => 'The RegionId provided does not exist in our records.', ], [ 'errorCode' => 'InvalidDescription.MalFormed', 'errorMessage' => 'The specified parameter description is not valid.', ], [ 'errorCode' => 'CommunicateWithManager.Error', 'errorMessage' => 'Internal Error. Communicate with drds manager error', ], [ 'errorCode' => 'InvalidVSwitchId', 'errorMessage' => 'Invalid vswitchId', ], [ 'errorCode' => 'InvalidVpcId', 'errorMessage' => 'Invalid vpcId, or the region of vpc does not match', ], [ 'errorCode' => 'InvalidZoneId.Mismatch', 'errorMessage' => 'zone is illegal in this order', ], [ 'errorCode' => 'LowInventory.ServerError', 'errorMessage' => 'low inventory error', ], [ 'errorCode' => 'publicInstanceAlreadExist.Error', 'errorMessage' => 'a public Drds instance is exist', ], [ 'errorCode' => 'CreateDRDSInstanceId.Error', 'errorMessage' => 'create Drds instance id error', ], [ 'errorCode' => 'ResourceInsufficient', 'errorMessage' => 'resource is Insufficient', ], [ 'errorCode' => 'AnotherOrderExist.Error', 'errorMessage' => 'there is another order', ], [ 'errorCode' => 'InstanceExceedLimit.Error', 'errorMessage' => 'instance number has exceeded', ], [ 'errorCode' => 'InvalidParameter.Quantity', 'errorMessage' => 'Invalid parameter of quantity', ], [ 'errorCode' => 'InvalidParameter.RegionId', 'errorMessage' => 'Invalid parameter of region id', ], [ 'errorCode' => 'InvalidParameter.ZoneId', 'errorMessage' => 'Invalid parameter of zone id', ], [ 'errorCode' => 'InvalidParameter.PayType', 'errorMessage' => 'Invalid parameter of pay type', ], [ 'errorCode' => 'InvalidParameter.Spection', 'errorMessage' => 'Invalid parameter of specification', ], [ 'errorCode' => 'InvalidParameter.Series', 'errorMessage' => 'Invalid parameter of series', ], [ 'errorCode' => 'InvalidParameter.duration_pricingCycle', 'errorMessage' => 'when payType=drdsPre, duration and pricingCycle is required', ], [ 'errorCode' => 'InvalidParameter.year.duration', 'errorMessage' => 'when pricingCycle=year, duration must between 1 to 3', ], [ 'errorCode' => 'InvalidParameter.month.duration', 'errorMessage' => 'when pricingCycle=month, duration must between 1 to 9', ], [ 'errorCode' => 'InvalidDRDSInstanceType.Error', 'errorMessage' => 'Invalid parameter of Type, public is not supported', ], [ 'errorCode' => 'QueryVSwitchFailed.InvalidVpcIdOrServerError', 'errorMessage' => 'Query VSwitch failed, please check vpcId', ], [ 'errorCode' => 'RegionNotSupportVPC.Error', 'errorMessage' => 'This region does not support vpc instance', ], [ 'errorCode' => 'UserAccountVerify.Failed', 'errorMessage' => 'User account verify failed. Please verify first', ], ], 500 => [ [ 'errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"D99D4644-A70D-49A3-B8B4-767ACC50SE2R\\",\\n \\"Data\\": {\\n \\"OrderId\\": 111111111111111,\\n \\"DrdsInstanceIdList\\": {\\n \\"drdsInstanceIdList\\": [\\n \\"drds************\\"\\n ]\\n }\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n true\\n D99D4644-A70D-49A3-B8B4-767ACC50SE2R\\n \\n 111111111111111\\n drds************\\n \\n","errorExample":""}]', 'title' => '创建一个实例', 'summary' => '创建新实例。', ], 'CreateOrderForRds' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'systemTags' => [ 'operationType' => 'create', 'abilityTreeCode' => '75962', 'abilityTreeNodes' => [ 'FEATUREdrdsHFP8VD', ], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => '地域Id', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'cn-hangzhou', ], ], [ 'name' => 'Params', 'in' => 'query', 'schema' => [ 'description' => 'RDS下单参数JOSN，参考[创建RDS实例](~~26228~~)。', 'type' => 'string', 'required' => true, 'example' => '{"key":"value"}', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Data' => [ 'description' => '购买成功的RDS实例ID', 'type' => 'string', 'example' => '[rm-***********]', ], 'RequestId' => [ 'description' => '请求ID', 'type' => 'string', 'example' => '9819BC51-D33D-4EB1-B80F-A89A20******', ], 'Success' => [ 'description' => '成功标识', 'type' => 'boolean', 'example' => 'true', ], ], ], ], ], 'errorCodes' => [ 500 => [ [ 'errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"Data\\": \\"[rm-***********]\\",\\n \\"RequestId\\": \\"9819BC51-D33D-4EB1-B80F-A89A20******\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":" \\n [rm-***********]\\n\\t9819BC51-D33D-4EB1-B80F-A89A20******\\n\\ttrue\\n","errorExample":""}]', 'title' => '创建购买RDS的订单', 'summary' => '调用CreateOrderForRds接口创建购买RDS的订单。', 'description' => '请确保在使用该接口前，已充分了解本产品的收费方式和[价格](https://www.aliyun.com/price/product#/rds/detail)。', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'ModifyDrdsInstanceDescription' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'systemTags' => [ 'operationType' => 'update', ], 'parameters' => [ [ 'name' => 'DrdsInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'DRDS实例ID。', 'type' => 'string', 'required' => true, 'example' => 'drds************', ], ], [ 'name' => 'Description', 'in' => 'query', 'schema' => [ 'description' => '实例描述信息。', 'type' => 'string', 'required' => true, 'example' => 'test', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Success' => [ 'description' => '请求结果。', 'type' => 'boolean', 'example' => 'true', ], 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => 'C44CA24C-C7C4-4C0F-8AC9-1343F2******', ], ], ], ], ], 'errorCodes' => [], 'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"C44CA24C-C7C4-4C0F-8AC9-1343F2******\\"\\n}","errorExample":""},{"type":"xml","example":"C44CA24C-C7C4-4C0F-8AC9-1343F2******\\ntrue","errorExample":""}]', 'title' => '修改实例描述', 'summary' => '调用ModifyDrdsInstanceDescription接口修改实例描述。', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'UpdateResourceGroupAttribute' => [ 'methods' => [ 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'abilityTreeCode' => '53946', 'abilityTreeNodes' => [ 'FEATUREdrds25BO3L', ], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => '目标实例的地域ID。'."\n" .'> 您可以调用[DescribeDrdsInstances](~~139284~~)接口查看账号下的实例详情，包括地域ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', ], ], [ 'name' => 'DrdsInstanceId', 'in' => 'query', 'schema' => [ 'description' => '目标实例ID。'."\n" .'> 您可以调用[DescribeDrdsInstances](~~139284~~)接口查看账号下的实例详情，包括实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'drds***********', ], ], [ 'name' => 'NewResourceGroupId', 'in' => 'query', 'schema' => [ 'description' => '目标资源组ID。'."\n" .'> 您可以调用[ListResourceGroups](~~158855~~)接口查看资源组详情，包括资源组ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'rg-***************', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => '91C7CAB5-3B2E-4FB6-893C-0162C0******', ], ], ], ], ], 'errorCodes' => [ 404 => [ [ 'errorCode' => 'DRDSDB.NotExist', 'errorMessage' => 'The database does not exist.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"91C7CAB5-3B2E-4FB6-893C-0162C0******\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n91C7CAB5-3B2E-4FB6-893C-0162C0******\\r\\n","errorExample":""}]', 'title' => '将实例转移至新的资源组', 'summary' => '调用UpdateResourceGroupAttribute接口将实例转移至新的资源组。', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'DescribeDrdsInstances' => [ 'summary' => '通过DescribeDrdsInstances接口查询DRDS实例列表。', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '76004', 'abilityTreeNodes' => [ 'FEATUREdrdsQ69M1H', ], ], 'parameters' => [ [ 'name' => 'Type', 'in' => 'query', 'schema' => [ 'description' => '实例类型。'."\n" .'- **共享实例**：0'."\n" .'- **专享实例**：1', 'type' => 'string', 'required' => false, 'example' => '1', 'enum' => [ 'PRIVATE', 'PUBLIC', '1', '0', ], ], ], [ 'name' => 'Description', 'in' => 'query', 'schema' => [ 'description' => '实例的描述。', 'type' => 'string', 'required' => false, 'example' => 'drds_test', ], ], [ 'name' => 'Expired', 'in' => 'query', 'schema' => [ 'description' => '是否过期。', 'type' => 'boolean', 'required' => false, 'example' => 'false', ], ], [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => [ 'description' => '页码。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'default' => '1', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => '每页大小。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20', 'default' => '20', ], ], [ 'name' => 'ResourceGroupId', 'in' => 'query', 'schema' => [ 'description' => '资源组ID，可以为空。', 'type' => 'string', 'required' => false, 'example' => 'NULL', ], ], [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => '地域ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'enum' => [ 'cn-shenzhen', 'cn-beijing', 'cn-shenzhen-finance-1', 'cn-north-2-gov-1', 'cn-qingdao', 'cn-shanghai', 'cn-shanghai-finance-1', 'cn-hongkong', 'cn-hangzhou-finance', 'ap-southeast-1', 'cn-huhehaote', 'us-east-1', 'cn-zhangjiakou', 'cn-hangzhou', 'us-west-1', 'cn-wulanchabu', 'eu-central-1', 'ap-southeast-5', 'cn-zhengzhou-jva', 'ap-northeast-1', 'cn-shanghai-cloudspe', 'ap-southeast-6', 'ap-southeast-7', ], ], ], [ 'name' => 'Mix', 'in' => 'query', 'schema' => [ 'description' => '是否支持混合查询。', 'type' => 'boolean', 'required' => false, 'example' => 'FALSE', ], ], [ 'name' => 'ProductVersion', 'in' => 'query', 'schema' => [ 'description' => '产品版本号，可取值为V1或V2。', 'type' => 'string', 'required' => false, 'example' => 'V1', ], ], [ 'name' => 'Tag', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => '标签属性列表。', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Key' => [ 'description' => '标签的键。', 'type' => 'string', 'required' => false, 'example' => 'acs:newretail:domain', ], 'Value' => [ 'description' => '标签的值。', 'type' => 'string', 'required' => false, 'example' => 'NEW_RETAIL', ], ], 'required' => false, ], 'required' => false, 'maxItems' => 50, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => '8734773E-7B21-4A22-9106-CBD245F8****', ], 'PageNumber' => [ 'description' => '页码。', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'PageSize' => [ 'description' => '每页大小。', 'type' => 'integer', 'format' => 'int32', 'example' => '20', ], 'Total' => [ 'description' => '实例总数。', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'Instances' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'Instance' => [ 'description' => '实例列表。', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'VpcId' => [ 'description' => '虚拟专用网络ID。', 'type' => 'string', 'example' => 'vpc-bp**********', ], 'Status' => [ 'description' => '实例状态。', 'type' => 'string', 'example' => 'RUN', ], 'Type' => [ 'description' => '实例类型。'."\n" .'- **PUBLIC**：共享实例'."\n" .'- **PRIVATE**：独享实例', 'type' => 'string', 'example' => 'PRIVATE', ], 'CommodityCode' => [ 'description' => '商品代码。', 'type' => 'string', 'example' => 'drdsPost', ], 'MachineType' => [ 'description' => '实例机器类型，仅支持ecs。', 'type' => 'string', 'example' => 'ecs', ], 'CreateTime' => [ 'description' => '创建时间戳。', 'type' => 'integer', 'format' => 'int64', 'example' => '1568620311000', ], 'VersionAction' => [ 'description' => '实例版本可用操作。', 'type' => 'string', 'example' => 'Upgradable', ], 'InstanceSeries' => [ 'description' => '实例规格系列。', 'type' => 'string', 'example' => 'drds.sn2.4c16g', ], 'NetworkType' => [ 'description' => '网络类型。'."\n" .'- **CLASSIC**：经典网络'."\n" .'- **VPC**：专有网络', 'type' => 'string', 'example' => 'CLASSIC', ], 'Label' => [ 'description' => '实例标签。'."\n" ."\n" .'- **NORMAL**：普通实例'."\n" ."\n" .'- **HA**：高可用实例'."\n" ."\n" .'- **VPC**：VPC实例', 'type' => 'string', 'example' => 'NORMAL', ], 'ProductVersion' => [ 'description' => '产品版本号。', 'type' => 'string', 'example' => 'V1', ], 'InstanceSpec' => [ 'description' => '实例规格。', 'type' => 'string', 'example' => 'drds.sn2.4c16g.8C32G', ], 'RegionId' => [ 'description' => '地域ID。', 'type' => 'string', 'example' => 'cn-hangzhou-e', ], 'VpcCloudInstanceId' => [ 'description' => 'VPC集群中的实例ID。', 'type' => 'string', 'example' => 'drdssen12****', ], 'Description' => [ 'description' => '实例描述。', 'type' => 'string', 'example' => 'drds_test', ], 'Version' => [ 'description' => '实例版本。', 'type' => 'integer', 'format' => 'int64', 'example' => '0', ], 'ResourceGroupId' => [ 'description' => '资源组ID。', 'type' => 'string', 'example' => 'rg-aek2ljh3ye4****', ], 'ZoneId' => [ 'description' => '可用区。', 'type' => 'string', 'example' => 'vsw-bpxxxxxxxxxxxxx96', ], 'DrdsInstanceId' => [ 'description' => '实例ID。', 'type' => 'string', 'example' => 'drdssen12****', ], 'ExpireDate' => [ 'description' => '过期时间戳。', 'type' => 'integer', 'format' => 'int64', 'example' => '4724323200000', ], 'MasterInstanceId' => [ 'description' => '主实例ID。', 'type' => 'string', 'example' => 'drdssen12****', ], 'OrderInstanceId' => [ 'description' => '购买的实例ID。', 'type' => 'string', 'example' => 'drdssen12****', ], 'InstRole' => [ 'description' => '实例角色。'."\n" .'- **MASTER**：主实例'."\n" .'- **SLAVE**：分析型只读实例'."\n" .'- **SLAVE_FLOW**：并发型只读实例', 'type' => 'string', 'example' => 'MASTER', ], 'Vips' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'Vip' => [ 'description' => 'VIP列表。', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'VpcId' => [ 'description' => '虚拟专用网络ID。', 'type' => 'string', 'example' => 'vpc-bpxxxxxxxxxxxy', ], 'Type' => [ 'description' => 'VIP类型。'."\n" .'- **intranet**：内网'."\n" .'- **internet**：外网', 'type' => 'string', 'example' => 'intranet', ], 'VswitchId' => [ 'description' => '虚拟交换机ID。', 'type' => 'string', 'example' => 'vsw-bpxxxxxxxxxxxxx96', ], 'Port' => [ 'description' => 'VIP开放端口。', 'type' => 'string', 'example' => '3306', ], 'IP' => [ 'description' => 'IP地址。', 'type' => 'string', 'example' => '10.23.***.***', ], 'dns' => [ 'description' => 'VIP绑定的域名。', 'type' => 'string', 'example' => 'drdssen1243as.drds.aliyuncs.com', ], ], ], ], ], ], 'ReadOnlyDBInstanceIds' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'ReadOnlyDBInstanceId' => [ 'type' => 'array', 'items' => [ 'description' => '只读实例ID列表。', 'type' => 'string', 'example' => 'drdssen12****', ], ], ], ], 'series' => [ 'description' => '实例系列，取值如下：'."\n" ."\n" .'- **starter**：入门版'."\n" .'- **enterprise**：企业版'."\n" .'- **standard**：标准版', 'type' => 'string', 'example' => 'enterprise', ], ], ], ], ], ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'ActionUnauthorized', 'errorMessage' => 'The specified action is not available for you', ], [ 'errorCode' => 'ServiceUnable', 'errorMessage' => 'The service is not available now, please try again later', ], [ 'errorCode' => 'InvalidRegionId.NotFound', 'errorMessage' => 'The RegionId provided does not exist in our records.', ], ], 500 => [ [ 'errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"8734773E-7B21-4A22-9106-CBD245F8****\\",\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 20,\\n \\"Total\\": 1,\\n \\"Instances\\": {\\n \\"Instance\\": [\\n {\\n \\"VpcId\\": \\"vpc-bp**********\\",\\n \\"Status\\": \\"RUN\\",\\n \\"Type\\": \\"PRIVATE\\",\\n \\"CommodityCode\\": \\"drdsPost\\",\\n \\"MachineType\\": \\"ecs\\",\\n \\"CreateTime\\": 1568620311000,\\n \\"VersionAction\\": \\"Upgradable\\",\\n \\"InstanceSeries\\": \\"drds.sn2.4c16g\\",\\n \\"NetworkType\\": \\"CLASSIC\\",\\n \\"Label\\": \\"NORMAL\\",\\n \\"ProductVersion\\": \\"V1\\",\\n \\"InstanceSpec\\": \\"drds.sn2.4c16g.8C32G\\",\\n \\"RegionId\\": \\"cn-hangzhou-e\\",\\n \\"VpcCloudInstanceId\\": \\"drdssen12****\\",\\n \\"Description\\": \\"drds_test\\",\\n \\"Version\\": 0,\\n \\"ResourceGroupId\\": \\"rg-aek2ljh3ye4****\\",\\n \\"ZoneId\\": \\"vsw-bpxxxxxxxxxxxxx96\\",\\n \\"DrdsInstanceId\\": \\"drdssen12****\\",\\n \\"ExpireDate\\": 4724323200000,\\n \\"MasterInstanceId\\": \\"drdssen12****\\",\\n \\"OrderInstanceId\\": \\"drdssen12****\\",\\n \\"InstRole\\": \\"MASTER\\",\\n \\"Vips\\": {\\n \\"Vip\\": [\\n {\\n \\"VpcId\\": \\"vpc-bpxxxxxxxxxxxy\\",\\n \\"Type\\": \\"intranet\\",\\n \\"VswitchId\\": \\"vsw-bpxxxxxxxxxxxxx96\\",\\n \\"Port\\": \\"3306\\",\\n \\"IP\\": \\"10.23.***.***\\",\\n \\"dns\\": \\"drdssen1243as.drds.aliyuncs.com\\"\\n }\\n ]\\n },\\n \\"ReadOnlyDBInstanceIds\\": {\\n \\"ReadOnlyDBInstanceId\\": [\\n \\"drdssen12****\\"\\n ]\\n },\\n \\"series\\": \\"enterprise\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 8734773E-7B21-4A22-9106-CBD245F8****\\n 1\\n 20\\n 1\\n \\n vpc-bp**********\\n RUN\\n PRIVATE\\n drdsPost\\n ecs\\n 1568620311000\\n Upgradable\\n drds.sn2.4c16g\\n CLASSIC\\n NORMAL\\n V1\\n drds.sn2.4c16g.8C32G\\n cn-hangzhou-e\\n drdssen12****\\n drds_test\\n 0\\n rg-aek2ljh3ye4****\\n vsw-bpxxxxxxxxxxxxx96\\n drdssen12****\\n 4724323200000\\n drdssen12****\\n drdssen12****\\n MASTER\\n \\n vpc-bpxxxxxxxxxxxy\\n intranet\\n vsw-bpxxxxxxxxxxxxx96\\n 3306\\n 10.23.***.***\\n drdssen1243as.drds.aliyuncs.com\\n \\n drdssen12****\\n enterprise\\n \\n","errorExample":""}]', 'title' => '查询DRDS实例列表', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'DescribeDrdsDbInstance' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'systemTags' => [ 'operationType' => 'get', 'abilityTreeCode' => '75989', 'abilityTreeNodes' => [ 'FEATUREdrds25BO3L', ], ], 'parameters' => [ [ 'name' => 'DrdsInstanceId', 'in' => 'query', 'schema' => [ 'description' => '实例名称。'."\n" ."\n", 'type' => 'string', 'required' => true, 'example' => 'drdshbga1138****', ], ], [ 'name' => 'DbName', 'in' => 'query', 'schema' => [ 'description' => '数据库名称。', 'type' => 'string', 'required' => true, 'example' => 'drds_test', ], ], [ 'name' => 'DbInstanceId', 'in' => 'query', 'schema' => [ 'description' => '私有定制RDS实例ID。', 'type' => 'string', 'required' => true, 'example' => 'rm-bp1t1mk5a5bdj****', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Success' => [ 'description' => '请求是否成功。', 'type' => 'boolean', 'example' => 'true', ], 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => '4FE09970-CA69-4144-88CA-67FB4BTY56G3', ], 'DbInstance' => [ 'description' => '私有定制RDS实例详情。', 'type' => 'object', 'properties' => [ 'ExpireTime' => [ 'description' => '实例过期时间，格式为Unix时间戳，单位为秒。'."\n" .'>仅预付费实例支持该参数。', 'type' => 'string', 'example' => '12341434315', ], 'PayType' => [ 'description' => '实例付费类型，取值范围如下：'."\n" ."\n" .'- **Prepaid**：包年包月（即预付费）'."\n" .'- **Postaid**：按量付费（即后付费或按小时付费）', 'type' => 'string', 'example' => 'Postpaid', ], 'DBInstanceStatus' => [ 'description' => '实例状态。', 'type' => 'string', 'example' => '1', ], 'NetworkType' => [ 'description' => '实例网络类型，目前仅支持专有网络**VPC**。', 'type' => 'string', 'example' => 'VPC', ], 'Port' => [ 'description' => '实例访问端口。', 'type' => 'integer', 'format' => 'int32', 'example' => '3306', ], 'EngineVersion' => [ 'description' => '实例引擎版本，目前仅支持**5.7**版本。', 'type' => 'string', 'example' => '5.7', ], 'DmInstanceId' => [ 'description' => '资源ID。', 'type' => 'string', 'example' => 'dm-*************', ], 'ConnectUrl' => [ 'description' => '私有定制RDS连接地址。', 'type' => 'string', 'example' => 'rm-***************.mysql.rds.aliyuncs.com', ], 'ReadWeight' => [ 'description' => '实例读比例。', 'type' => 'integer', 'format' => 'int32', 'example' => '70', ], 'RdsInstType' => [ 'description' => '实例类型。', 'type' => 'string', 'example' => 'RDS', ], 'RemainDays' => [ 'description' => '实例过期剩余天数。', 'type' => 'string', 'example' => '0', ], 'DBInstanceId' => [ 'description' => '私有定制RDS实例ID。', 'type' => 'string', 'example' => 'rm-***************', ], 'DbInstType' => [ 'description' => '实例类型，取值范围如下：'."\n" ."\n" .'- **Primary**：主实例'."\n" .'- **ReadOnly**：只读实例', 'type' => 'string', 'example' => 'Primary', ], 'Engine' => [ 'description' => '实例引擎，目前仅支持**MySQL**。', 'type' => 'string', 'example' => 'MySQL', ], 'ReadOnlyInstances' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'ReadOnlyInstance' => [ 'description' => '只读实例列表。', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'ExpireTime' => [ 'description' => '实例过期时间戳。', 'type' => 'string', 'example' => '1823487328173', ], 'PayType' => [ 'description' => '实例购买类型。', 'type' => 'string', 'example' => 'Postpaid', ], 'VersionAction' => [ 'description' => '无效字段', 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], 'DBInstanceStatus' => [ 'description' => '实例状态。', 'type' => 'string', 'example' => '1', ], 'NetworkType' => [ 'description' => '实例网络类型。', 'type' => 'string', 'example' => 'VPC', ], 'Port' => [ 'description' => '实例访问端口。', 'type' => 'integer', 'format' => 'int32', 'example' => '3306', ], 'EngineVersion' => [ 'description' => '实例引擎版本。', 'type' => 'string', 'example' => '5.7', ], 'DmInstanceId' => [ 'description' => '资源ID。', 'type' => 'string', 'example' => 'dm-*************', ], 'ConnectUrl' => [ 'description' => '只读实例连接地址。', 'type' => 'string', 'example' => 'rm-bp1ub71ct9skc3yxx.mysql.rds.aliyuncs.com', ], 'ReadWeight' => [ 'description' => '实例读比例。', 'type' => 'integer', 'format' => 'int32', 'example' => '30', ], 'RdsInstType' => [ 'description' => '实例类型。', 'type' => 'string', 'example' => 'RDS', ], 'RemainDays' => [ 'description' => '实例过期剩余天数。', 'type' => 'string', 'example' => '0', ], 'DBInstanceId' => [ 'description' => '只读实例ID。', 'type' => 'string', 'example' => 'rm-bp1ub71ct9skc****', ], 'DbInstType' => [ 'description' => '实例类型。', 'type' => 'string', 'example' => 'RDS', ], 'Engine' => [ 'description' => '实例引擎。', 'type' => 'string', 'example' => 'MySQL', ], ], ], ], ], ], ], ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'InvalidParameter.MasterDbInstanceRelease', 'errorMessage' => 'The master db instance has been released', ], ], 500 => [ [ 'errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"4FE09970-CA69-4144-88CA-67FB4BTY56G3\\",\\n \\"DbInstance\\": {\\n \\"ExpireTime\\": \\"12341434315\\",\\n \\"PayType\\": \\"Postpaid\\",\\n \\"DBInstanceStatus\\": \\"1\\",\\n \\"NetworkType\\": \\"VPC\\",\\n \\"Port\\": 3306,\\n \\"EngineVersion\\": \\"5.7\\",\\n \\"DmInstanceId\\": \\"dm-*************\\",\\n \\"ConnectUrl\\": \\"rm-***************.mysql.rds.aliyuncs.com\\",\\n \\"ReadWeight\\": 70,\\n \\"RdsInstType\\": \\"RDS\\",\\n \\"RemainDays\\": \\"0\\",\\n \\"DBInstanceId\\": \\"rm-***************\\",\\n \\"DbInstType\\": \\"Primary\\",\\n \\"Engine\\": \\"MySQL\\",\\n \\"ReadOnlyInstances\\": {\\n \\"ReadOnlyInstance\\": [\\n {\\n \\"ExpireTime\\": \\"1823487328173\\",\\n \\"PayType\\": \\"Postpaid\\",\\n \\"VersionAction\\": 0,\\n \\"DBInstanceStatus\\": \\"1\\",\\n \\"NetworkType\\": \\"VPC\\",\\n \\"Port\\": 3306,\\n \\"EngineVersion\\": \\"5.7\\",\\n \\"DmInstanceId\\": \\"dm-*************\\",\\n \\"ConnectUrl\\": \\"rm-bp1ub71ct9skc3yxx.mysql.rds.aliyuncs.com\\",\\n \\"ReadWeight\\": 30,\\n \\"RdsInstType\\": \\"RDS\\",\\n \\"RemainDays\\": \\"0\\",\\n \\"DBInstanceId\\": \\"rm-bp1ub71ct9skc****\\",\\n \\"DbInstType\\": \\"RDS\\",\\n \\"Engine\\": \\"MySQL\\"\\n }\\n ]\\n }\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n true\\n 4FE09970-CA69-4144-88CA-67FB4BTY56G3\\n \\n 12341434315\\n Postpaid\\n 1\\n VPC\\n 3306\\n 5.7\\n dm-*************\\n rm-***************.mysql.rds.aliyuncs.com\\n 70\\n RDS\\n 0\\n rm-***************\\n Primary\\n MySQL\\n \\n 1823487328173\\n Postpaid\\n 0\\n 1\\n VPC\\n 3306\\n 5.7\\n dm-*************\\n rm-bp1ub71ct9skc3yxx.mysql.rds.aliyuncs.com\\n 30\\n RDS\\n 0\\n rm-bp1ub71ct9skc****\\n RDS\\n MySQL\\n \\n \\n","errorExample":""}]', 'title' => '查询 RDS 存储实例详情', 'summary' => '查询 DRDS 的 RDS 存储实例详情。', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'DescribeDrdsInstance' => [ 'summary' => '调用DescribeDrdsInstance接口查询实例详情。', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '76000', 'abilityTreeNodes' => [ 'FEATUREdrds25BO3L', ], ], 'parameters' => [ [ 'name' => 'DrdsInstanceId', 'in' => 'query', 'schema' => [ 'description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'drdshbga1138****', ], ], [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => '地域ID。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'cn-hangzhou', 'default' => 'center', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Success' => [ 'description' => '请求是否成功。', 'type' => 'boolean', 'example' => 'true', ], 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => 'B4F76641-BA45-4320-BE7C-9C62CFDAC9B2', ], 'Data' => [ 'description' => '实例详情列表。', 'type' => 'object', 'properties' => [ 'Type' => [ 'description' => '实例类型，独享实例PRIVATE，共享实例PUBLIC。', 'type' => 'string', 'example' => 'PRIVATE', ], 'Status' => [ 'description' => '实例状态。', 'type' => 'string', 'example' => 'RUN', ], 'CreateTime' => [ 'description' => '实例创建的时间戳。', 'type' => 'integer', 'format' => 'int64', 'example' => '1568620311000', ], 'VersionAction' => [ 'description' => '实例版本可用操作。', 'type' => 'string', 'example' => 'Upgradeable', ], 'StorageType' => [ 'description' => '存储实例类型。', 'type' => 'string', 'example' => 'RDS', ], 'NetworkType' => [ 'description' => '网络类型，经典网络CLASSIC，VPC网络为VPC。', 'type' => 'string', 'example' => 'CLASSIC', ], 'Label' => [ 'description' => '实例标签：'."\n" ."\n" .'- **普通实例**： **NORMAL**'."\n" ."\n" .'- **高可用实例**： **HA**'."\n" ."\n" .'- **VPC实例**：**VPC**', 'type' => 'string', 'example' => 'NORMAL', ], 'MysqlVersion' => [ 'description' => '实例支持的MySQL版本。', 'type' => 'integer', 'format' => 'int32', 'example' => '5', ], 'InstanceSpec' => [ 'description' => '实例规格。', 'type' => 'string', 'example' => 'drds.sn2.4c16g.8C32G', ], 'VpcCloudInstanceId' => [ 'description' => 'VPC集群中的实例ID。', 'type' => 'string', 'example' => 'drdssen12****', ], 'Description' => [ 'description' => '实例描述。', 'type' => 'string', 'example' => 'drds_test', ], 'Version' => [ 'description' => '实例版本，目前为空。', 'type' => 'integer', 'format' => 'int64', 'example' => '0', ], 'ExpireDate' => [ 'description' => '实例过期的时间戳。', 'type' => 'integer', 'format' => 'int64', 'example' => '4724323200000', ], 'MasterInstanceId' => [ 'description' => '主实例ID。'."\n" ."\n" .'> 当实例类型为只读实例时，才会返回该参数。', 'type' => 'string', 'example' => 'drdssen1243as', ], 'CommodityCode' => [ 'description' => '商品代码。', 'type' => 'string', 'example' => 'drdsPost', ], 'MachineType' => [ 'description' => '实例机器类型，固定为**ecs**。', 'type' => 'string', 'example' => 'ecs', ], 'InstanceSeries' => [ 'description' => '实例规格系列。', 'type' => 'string', 'example' => 'drds.sn2.4c16g', ], 'ProductVersion' => [ 'description' => '产品版本。', 'type' => 'string', 'example' => '5.3.*', ], 'RegionId' => [ 'description' => '地域ID。', 'type' => 'string', 'example' => 'cn-hangzhou', ], 'ResourceGroupId' => [ 'description' => '资源组ID，可以为空。', 'type' => 'string', 'example' => 'NULL', ], 'DrdsInstanceId' => [ 'description' => '实例ID。', 'type' => 'string', 'example' => 'drdssen1243as', ], 'ZoneId' => [ 'description' => '可用区ID。', 'type' => 'string', 'example' => 'cn-hangzhou-e', ], 'InstRole' => [ 'description' => '实例角色，取值如下：'."\n" ."\n" .'- **主实例**： MASTER'."\n" .'- **分析型只读实例**：SLAVE'."\n" .'- **并发型只读实例**：SLAVE_FLOW', 'type' => 'string', 'example' => 'MASTER', ], 'OrderInstanceId' => [ 'description' => '购买的实例ID。', 'type' => 'string', 'example' => 'drdssen12****', ], 'Vips' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'Vip' => [ 'description' => 'VIP列表。', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Type' => [ 'description' => 'VIP 类型，内网 intranet，外网 internet', 'type' => 'string', 'example' => 'intranet', ], 'VpcId' => [ 'description' => 'VPC的ID。', 'type' => 'string', 'example' => 'vpc-bp**********', ], 'VswitchId' => [ 'description' => '虚拟交换机的ID。', 'type' => 'string', 'example' => 'vsw-bp***********', ], 'Dns' => [ 'description' => 'VIP绑定的域名。', 'type' => 'string', 'example' => 'drdssen1243as.drds.aliyuncs.com', ], 'Port' => [ 'description' => 'VIP开放端口。', 'type' => 'string', 'example' => '3306', ], 'ExpireDays' => [ 'description' => 'VIP过期剩余天数。', 'type' => 'integer', 'format' => 'int64', 'example' => '0', ], 'RemoveWeight' => [ 'type' => 'boolean', 'required' => false, ], ], ], ], ], ], 'ReadOnlyDBInstanceIds' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'ReadOnlyDBInstanceId' => [ 'description' => '只读实例ID列表。', 'type' => 'array', 'items' => [ 'description' => '只读实例ID列表。', 'type' => 'string', 'example' => 'drdssen12****', ], ], ], ], ], ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'ActionUnauthorized', 'errorMessage' => 'The specified action is not available for you', ], [ 'errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', ], ], 404 => [ [ 'errorCode' => 'InvalidDRDSInstanceId.NotFound', 'errorMessage' => 'The DrdsInstanceId provided does not exist in our records.', ], [ 'errorCode' => 'DrdsInstance.NotExists', 'errorMessage' => 'The DRDS instance does not exist.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"B4F76641-BA45-4320-BE7C-9C62CFDAC9B2\\",\\n \\"Data\\": {\\n \\"Type\\": \\"PRIVATE\\",\\n \\"Status\\": \\"RUN\\",\\n \\"CreateTime\\": 1568620311000,\\n \\"VersionAction\\": \\"Upgradeable\\",\\n \\"StorageType\\": \\"RDS\\",\\n \\"NetworkType\\": \\"CLASSIC\\",\\n \\"Label\\": \\"NORMAL\\",\\n \\"MysqlVersion\\": 5,\\n \\"InstanceSpec\\": \\"drds.sn2.4c16g.8C32G\\",\\n \\"VpcCloudInstanceId\\": \\"drdssen12****\\",\\n \\"Description\\": \\"drds_test\\",\\n \\"Version\\": 0,\\n \\"ExpireDate\\": 4724323200000,\\n \\"MasterInstanceId\\": \\"drdssen1243as\\",\\n \\"CommodityCode\\": \\"drdsPost\\",\\n \\"MachineType\\": \\"ecs\\",\\n \\"InstanceSeries\\": \\"drds.sn2.4c16g\\",\\n \\"ProductVersion\\": \\"5.3.*\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"ResourceGroupId\\": \\"NULL\\",\\n \\"DrdsInstanceId\\": \\"drdssen1243as\\",\\n \\"ZoneId\\": \\"cn-hangzhou-e\\",\\n \\"InstRole\\": \\"MASTER\\",\\n \\"OrderInstanceId\\": \\"drdssen12****\\",\\n \\"Vips\\": {\\n \\"Vip\\": [\\n {\\n \\"Type\\": \\"intranet\\",\\n \\"VpcId\\": \\"vpc-bp**********\\",\\n \\"VswitchId\\": \\"vsw-bp***********\\",\\n \\"Dns\\": \\"drdssen1243as.drds.aliyuncs.com\\",\\n \\"Port\\": \\"3306\\",\\n \\"ExpireDays\\": 0,\\n \\"RemoveWeight\\": true\\n }\\n ]\\n },\\n \\"ReadOnlyDBInstanceIds\\": {\\n \\"ReadOnlyDBInstanceId\\": [\\n \\"drdssen12****\\"\\n ]\\n }\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n true\\n B4F76641-BA45-4320-BE7C-9C62CFDAC9B2\\n \\n PRIVATE\\n RUN\\n 1568620311000\\n Upgradeable\\n RDS\\n CLASSIC\\n NORMAL\\n 5\\n drds.sn2.4c16g.8C32G\\n drdssen12****\\n drds_test\\n 0\\n 4724323200000\\n drdssen1243as\\n drdsPost\\n ecs\\n drds.sn2.4c16g\\n 5.3.*\\n cn-hangzhou\\n NULL\\n drdssen1243as\\n cn-hangzhou-e\\n MASTER\\n drdssen12****\\n \\n intranet\\n vpc-bp**********\\n vsw-bp***********\\n drdssen1243as.drds.aliyuncs.com\\n 3306\\n 0\\n \\n drdssen12****\\n \\n","errorExample":""}]', 'title' => '查询 DRDS 实例详情', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'DescribeDrdsParams' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'systemTags' => [ 'operationType' => 'get', 'abilityTreeCode' => '76006', 'abilityTreeNodes' => [ 'FEATUREdrds25BO3L', ], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => '地域ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'default' => 'center', ], ], [ 'name' => 'DrdsInstanceId', 'in' => 'query', 'schema' => [ 'description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'DescribeDrdsParams', ], ], [ 'name' => 'ParamLevel', 'in' => 'query', 'schema' => [ 'description' => '参数级别，取值：'."\n" .'* **INSTANCE**：实例级别'."\n" .'* **DB**：数据库级别', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'INSTANCE', ], ], [ 'name' => 'DbName', 'in' => 'query', 'schema' => [ 'description' => '数据库名称。', 'type' => 'string', 'required' => false, 'example' => 'drds_test', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Success' => [ 'description' => '查询是否成功。', 'type' => 'boolean', 'example' => 'true', ], 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => '2F7F8080-9132-4279-85D0-B7E5C4305162', ], 'List' => [ 'description' => '参数列表。', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'ParamDefaultValue' => [ 'description' => '参数默认值。', 'type' => 'string', 'example' => '1000', ], 'ParamLevel' => [ 'description' => '参数级别。', 'type' => 'string', 'example' => 'INSTANCE', ], 'ParamName' => [ 'description' => '参数名称。', 'type' => 'string', 'example' => '慢SQL阈值', ], 'ParamType' => [ 'description' => '参数类型。', 'type' => 'string', 'example' => 'CONFIG', ], 'ParamValue' => [ 'description' => '参数值。', 'type' => 'string', 'example' => '1000', ], 'NeedRestart' => [ 'description' => '是否需要重启。', 'type' => 'boolean', 'example' => 'true', ], 'ParamRanges' => [ 'description' => '参数值区间。', 'type' => 'string', 'example' => '[1000-900000]', ], 'DbName' => [ 'description' => '数据库名称。', 'type' => 'string', 'example' => 'drds_test', ], 'ParamEnglishName' => [ 'description' => '参数英文名称。', 'type' => 'string', 'example' => 'SLOW_SQL_TIME', ], 'ParamDesc' => [ 'description' => '参数描述。', 'type' => 'string', 'example' => '慢SQL阈值（单位：ms）', ], 'ParamVariableName' => [ 'description' => '参数变量名称。', 'type' => 'string', 'example' => 'slowSqlTime', ], ], ], ], ], ], ], ], 'errorCodes' => [ 500 => [ [ 'errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"2F7F8080-9132-4279-85D0-B7E5C4305162\\",\\n \\"List\\": [\\n {\\n \\"ParamDefaultValue\\": \\"1000\\",\\n \\"DbName\\": \\"drds_test\\",\\n \\"ParamLevel\\": \\"INSTANCE\\",\\n \\"ParamName\\": \\"慢SQL阈值\\",\\n \\"ParamEnglishName\\": \\"SLOW_SQL_TIME\\",\\n \\"ParamType\\": \\"CONFIG\\",\\n \\"ParamValue\\": \\"1000\\",\\n \\"ParamDesc\\": \\"慢SQL阈值（单位：ms）\\",\\n \\"NeedRestart\\": true,\\n \\"ParamVariableName\\": \\"slowSqlTime\\",\\n \\"ParamRanges\\": \\"[1000-900000]\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n2F7F8080-9132-4279-85D0-B7E5C4305162\\n\\n [1000-900000]\\n INSTANCE\\n slowSqlTime\\n SLOW_SQL_TIME\\n 1000\\n 1000\\n true\\n drds_test\\n 慢SQL阈值\\n CONFIG\\n 慢SQL阈值（单位：ms）\\n\\ntrue\\n","errorExample":""}]', 'title' => '查询 DRDS 的参数列表', 'summary' => '调用DescribeDrdsParams接口查询参数列表。', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'DescribeDrdsTasks' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'DrdsInstanceId', 'in' => 'query', 'schema' => [ 'description' => '实例ID。', 'type' => 'string', 'required' => true, 'example' => 'drdsxxxxxxxxxxxx', ], ], [ 'name' => 'DbName', 'in' => 'query', 'schema' => [ 'description' => '数据库名称。', 'type' => 'string', 'required' => false, 'example' => 'test', ], ], [ 'name' => 'TaskType', 'in' => 'query', 'schema' => [ 'description' => '任务类型。', 'type' => 'string', 'required' => false, 'example' => 'test', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Success' => [ 'description' => '是否成功。', 'type' => 'boolean', 'example' => 'true', ], 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => 'CD412DF7-F21D-44CE-88FF-ED24917174A8', ], 'Tasks' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'Task' => [ 'description' => '任务列表。', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'State' => [ 'description' => '任务状态。', 'type' => 'string', 'example' => 'FAILED', ], 'Content' => [ 'description' => '任务内容。', 'type' => 'string', 'example' => 'upgrade_instance', ], 'Id' => [ 'description' => '任务ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '64148', ], ], ], ], ], ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'ActionUnauthorized', 'errorMessage' => 'The specified action is not available for you', ], ], 404 => [ [ 'errorCode' => 'InvalidDRDSInstanceId.NotFound', 'errorMessage' => 'The DrdsInstanceId provided does not exist in our records.', ], ], 500 => [ [ 'errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"CD412DF7-F21D-44CE-88FF-ED24917174A8\\",\\n \\"Tasks\\": {\\n \\"Task\\": [\\n {\\n \\"State\\": \\"FAILED\\",\\n \\"Content\\": \\"upgrade_instance\\",\\n \\"Id\\": 64148\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n\\n \\n FAILED\\n upgrade_instance\\n 64148\\n \\n\\nCD412DF7-F21D-44CE-88FF-ED24917174A8\\ntrue\\n","errorExample":""}]', 'title' => '查询实例变更任务', 'summary' => '调用DescribeDrdsTasks接口查询实例变更任务。', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'DescribeHotDbList' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'systemTags' => [ 'operationType' => 'get', 'abilityTreeCode' => '76024', 'abilityTreeNodes' => [ 'FEATUREdrds7SC2V6', ], ], 'parameters' => [ [ 'name' => 'DrdsInstanceId', 'in' => 'query', 'schema' => [ 'description' => '实例ID。', 'type' => 'string', 'required' => true, 'example' => 'drds**********', ], ], [ 'name' => 'DbName', 'in' => 'query', 'schema' => [ 'description' => '数据库名称。', 'type' => 'string', 'required' => true, 'example' => 'test', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Msg' => [ 'description' => '信息。', 'type' => 'string', 'example' => 'msg', ], 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => '0B6B7BDC-575D-4A77-A4F8-24B7EF******', ], 'Success' => [ 'description' => '请求是否成功。', 'type' => 'boolean', 'example' => 'true', ], 'Data' => [ 'description' => '结果。', 'type' => 'object', 'properties' => [ 'RandomCode' => [ 'description' => '随机数。', 'type' => 'string', 'example' => 'jzhz', ], 'List' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'InstanceDb' => [ 'description' => '列表。', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'InstanceName' => [ 'description' => '实例名称。', 'type' => 'string', 'example' => 'instanceName', ], 'HotDbList' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'data' => [ 'type' => 'array', 'items' => [ 'description' => '热点库列表。', 'type' => 'string', 'example' => 'hot_dtstest0512_****_****', ], ], ], ], ], ], ], ], ], ], ], ], ], ], ], 'errorCodes' => [ 500 => [ [ 'errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"Msg\\": \\"msg\\",\\n \\"RequestId\\": \\"0B6B7BDC-575D-4A77-A4F8-24B7EF******\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"RandomCode\\": \\"jzhz\\",\\n \\"List\\": {\\n \\"InstanceDb\\": [\\n {\\n \\"InstanceName\\": \\"instanceName\\",\\n \\"HotDbList\\": {\\n \\"data\\": [\\n \\"hot_dtstest0512_****_****\\"\\n ]\\n }\\n }\\n ]\\n }\\n }\\n}","errorExample":""},{"type":"xml","example":"\\nmsg\\n0B6B7BDC-575D-4A77-A4F8-24B7EF******\\n\\n \\n \\n instanceName\\n \\n \\n \\n hot_dtstest0512_****_****\\n \\n \\n \\n jzhz\\n\\ntrue\\n","errorExample":""}]', 'title' => '查看热点扩容db列表', 'summary' => '调用DescribeHotDbList接口查看热点扩容的数据库列表。', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'DescribeInstanceSwitchAzone' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'systemTags' => [ 'operationType' => 'get', 'abilityTreeCode' => '76026', 'abilityTreeNodes' => [ 'FEATUREdrds7CT80F', ], ], 'parameters' => [ [ 'name' => 'DrdsInstanceId', 'in' => 'query', 'schema' => [ 'description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'drdsxxxxxxxxxxxx', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Success' => [ 'description' => '是否成功。', 'type' => 'boolean', 'example' => 'true', ], 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => 'DSSDF-SEWE-23ERW', ], 'Result' => [ 'description' => '查询结果列表。', 'type' => 'object', 'properties' => [ 'OriginAzoneId' => [ 'description' => '源可用区ID。', 'type' => 'string', 'example' => 'cn-hangzhou-a', ], 'SwitchAble' => [ 'description' => '是否可以切换可用区。', 'type' => 'boolean', 'example' => 'true', ], 'RegionId' => [ 'description' => '地域ID。', 'type' => 'string', 'example' => 'cn-hangzhou', ], 'TargetAzones' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'TargetAzone' => [ 'type' => 'array', 'items' => [ 'description' => '目标可用区。', 'type' => 'string', 'example' => 'cn-hangzhou-a,cn-hangzhou-b', ], ], ], ], ], ], ], ], ], ], 'errorCodes' => [ 500 => [ [ 'errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"DSSDF-SEWE-23ERW\\",\\n \\"Result\\": {\\n \\"OriginAzoneId\\": \\"cn-hangzhou-a\\",\\n \\"SwitchAble\\": true,\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"TargetAzones\\": {\\n \\"TargetAzone\\": [\\n \\"cn-hangzhou-a,cn-hangzhou-b\\"\\n ]\\n }\\n }\\n}","errorExample":""},{"type":"xml","example":"\\nDSSDF-SEWE-23ERW\\ntrue\\n\\n cn-hangzhou-a\\n \\n cn-hangzhou-a,cn-hangzhou-b\\n \\n cn-hangzhou\\n true\\n\\n","errorExample":""}]', 'title' => '查看是否切换可用区', 'summary' => '调用DescribeInstanceSwitchAzone接口查看是否可以切换可用区。', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'DescribeInstanceSwitchNetwork' => [ 'summary' => '调用DescribeInstanceSwitchNetwork查询实例是否可以切换网络。', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '76027', 'abilityTreeNodes' => [ 'FEATUREdrdsBRC5LQ', ], ], 'parameters' => [ [ 'name' => 'DrdsInstanceId', 'in' => 'query', 'schema' => [ 'description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'drds*********', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Success' => [ 'description' => '是否成功。', 'type' => 'boolean', 'example' => 'true', ], 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => '03E12FE3-1638-483E-A9B6-1A9120SER56T', ], 'VpcInfos' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'VpcInfo' => [ 'description' => '专有网络VPC详情。', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'VpcId' => [ 'description' => '专有网络VPC的ID。', 'type' => 'string', 'example' => 'vpc_id', ], 'VpcName' => [ 'description' => '专有网络VPC名称。', 'type' => 'string', 'example' => 'vpc_name', ], 'RegionId' => [ 'description' => '地域ID。', 'type' => 'string', 'example' => 'cn-hangzhou', ], 'VswitchInfos' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'VswitchInfo' => [ 'description' => '交换机列表。', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'VpcId' => [ 'description' => '专有网络VPC的ID。', 'type' => 'string', 'example' => 'vpc_id', ], 'DrdsSupported' => [ 'description' => '是否支持实例。', 'type' => 'boolean', 'example' => 'true', ], 'VswitchId' => [ 'description' => '交换机的ID。', 'type' => 'string', 'example' => 'vswitch_id', ], 'AzoneId' => [ 'description' => '可用区ID。', 'type' => 'string', 'example' => 'cn-hangzhou-a', ], 'VswitchName' => [ 'description' => '交换机的名称。', 'type' => 'string', 'example' => 'vswitch_name', ], ], ], ], ], ], ], ], ], ], ], ], ], ], ], 'errorCodes' => [ 500 => [ [ 'errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"03E12FE3-1638-483E-A9B6-1A9120SER56T\\",\\n \\"VpcInfos\\": {\\n \\"VpcInfo\\": [\\n {\\n \\"VpcId\\": \\"vpc_id\\",\\n \\"VpcName\\": \\"vpc_name\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"VswitchInfos\\": {\\n \\"VswitchInfo\\": [\\n {\\n \\"VpcId\\": \\"vpc_id\\",\\n \\"DrdsSupported\\": true,\\n \\"VswitchId\\": \\"vswitch_id\\",\\n \\"AzoneId\\": \\"cn-hangzhou-a\\",\\n \\"VswitchName\\": \\"vswitch_name\\"\\n }\\n ]\\n }\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"03E12FE3-1638-483E-A9B6-1A9120SER56T\\n\\n \\n vpc_id\\n vpc_name\\n cn-hangzhou\\n \\n \\n true\\n vpc_id\\n vswitch_name\\n cn-hangzhou-a\\n vswitch_id\\n \\n \\n \\n\\ntrue","errorExample":""}]', 'title' => '查询实例是否可以切换网络', 'description' => '****', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'DescribeInstDbLogInfo' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'systemTags' => [ 'operationType' => 'get', 'abilityTreeCode' => '76028', 'abilityTreeNodes' => [ 'FEATUREdrdsAS582G', ], ], 'parameters' => [ [ 'name' => 'DrdsInstanceId', 'in' => 'query', 'schema' => [ 'description' => '实例ID。', 'type' => 'string', 'required' => true, 'example' => 'drds*********', ], ], [ 'name' => 'DbName', 'in' => 'query', 'schema' => [ 'description' => '数据库名称。', 'type' => 'string', 'required' => true, 'example' => 'drds_test', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Success' => [ 'description' => '是否成功。', 'type' => 'boolean', 'example' => 'true', ], 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => 'A5438952-70EE-4FA5-87A9-080DB0ASD45F', ], 'LogTimeRange' => [ 'description' => '可查询时间。', 'type' => 'object', 'properties' => [ 'SupportOldestTime' => [ 'description' => '结束时间。', 'type' => 'integer', 'format' => 'int64', 'example' => '1568367711', ], 'SupportLatestTime' => [ 'description' => '开始时间。', 'type' => 'integer', 'format' => 'int64', 'example' => '1568267711', ], ], ], ], ], ], ], 'errorCodes' => [ 500 => [ [ 'errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"A5438952-70EE-4FA5-87A9-080DB0ASD45F\\",\\n \\"LogTimeRange\\": {\\n \\"SupportOldestTime\\": 1568367711,\\n \\"SupportLatestTime\\": 1568267711\\n }\\n}","errorExample":""},{"type":"xml","example":"A5438952-70EE-4FA5-87A9-080DB0ASD45F\\n\\n 1568367711\\n 1568267711\\n\\ntrue","errorExample":""}]', 'title' => '查询支持导入历史SQL数据时间范围', 'summary' => '查询数据库支持导入历史SQL数据的时间范围。', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'DescribePreCheckResult' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => '地域ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'default' => 'center', ], ], [ 'name' => 'DrdsInstanceId', 'in' => 'query', 'schema' => [ 'description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'drdshbga76p6****', ], ], [ 'name' => 'TaskId', 'in' => 'query', 'schema' => [ 'description' => '任务ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '4561', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Success' => [ 'description' => '请求是否成功。', 'type' => 'boolean', 'example' => 'true', ], 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => 'DescribePreCheckResult', ], 'PreCheckResult' => [ 'description' => '预检结果。', 'type' => 'object', 'properties' => [ 'PreCheckName' => [ 'description' => '预检名称。', 'type' => 'string', 'example' => '是否有唯一键', ], 'State' => [ 'description' => '状态。', 'type' => 'string', 'example' => 'FAIL', ], 'SubCheckItems' => [ 'description' => '子预检任务详情。', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'ErrorMsgCode' => [ 'description' => '报错code。', 'type' => 'string', 'example' => '1004', ], 'PreCheckItemName' => [ 'description' => '预检名称。', 'type' => 'string', 'example' => '唯一键', ], 'State' => [ 'description' => '任务状态。', 'type' => 'string', 'example' => '成功', ], 'ErrorMsgParams' => [ 'type' => 'array', 'items' => [ 'description' => '报错参数。', 'type' => 'string', 'example' => 'table1', ], ], ], ], ], ], ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => '%s', 'errorMessage' => '%s', ], ], 500 => [ [ 'errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"DescribePreCheckResult\\",\\n \\"PreCheckResult\\": {\\n \\"PreCheckName\\": \\"是否有唯一键\\",\\n \\"State\\": \\"FAIL\\",\\n \\"SubCheckItems\\": [\\n {\\n \\"ErrorMsgCode\\": \\"1004\\",\\n \\"PreCheckItemName\\": \\"唯一键\\",\\n \\"State\\": \\"成功\\",\\n \\"ErrorMsgParams\\": [\\n \\"table1\\"\\n ]\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n FAIL\\n 是否有唯一键\\n \\n 唯一键\\n 成功\\n 1004\\n table1\\n \\n\\nDescribePreCheckResult\\ntrue","errorExample":""}]', 'title' => '查看预检结果', 'summary' => '调用DescribePreCheckResult接口查看预检结果。', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'DescribeRdsCommodity' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'DrdsInstanceId', 'in' => 'query', 'schema' => [ 'description' => '实例ID。', 'type' => 'string', 'required' => true, 'example' => 'drds***********', ], ], [ 'name' => 'CommodityCode', 'in' => 'query', 'schema' => [ 'description' => '商品代码。', 'type' => 'string', 'required' => true, 'example' => 'drdsPost', ], ], [ 'name' => 'OrderType', 'in' => 'query', 'schema' => [ 'description' => '订单类型。', 'type' => 'string', 'required' => false, 'example' => '1', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Data' => [ 'description' => '结果。', 'type' => 'string', 'example' => 'test', ], 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => 'DC3ABA3E-0F8A-4596-9104-F5155C34315B', ], 'Success' => [ 'description' => '请求结果。', 'type' => 'boolean', 'example' => 'true', ], ], ], ], ], 'errorCodes' => [ 500 => [ [ 'errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"Data\\": \\"test\\",\\n \\"RequestId\\": \\"DC3ABA3E-0F8A-4596-9104-F5155C34315B\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"DC3ABA3E-0F8A-4596-9104-F5155C34315B\\ntest\\ntrue","errorExample":""}]', 'title' => '查看RDS售卖数据', 'summary' => '调用DescribeRdsCommodity接口查询存储层售卖数据。', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'RemoveDrdsInstance' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'DrdsInstanceId', 'in' => 'query', 'schema' => [ 'description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'drds************', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Success' => [ 'description' => '请求结果。', 'type' => 'boolean', 'example' => 'true', ], 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => 'A3140FC7-B78B-4D8E-B0C8-926D28******', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'ReleasePrepayInstance', 'errorMessage' => 'The pay type of this drds instance is prepay', ], [ 'errorCode' => 'RemoveDrdsDBFirst', 'errorMessage' => 'There are Drds DB exist in this instance. Please delete drds db first', ], ], 500 => [ [ 'errorCode' => 'ERR_INSTANCE_RELEASE_ALREADY', 'errorMessage' => '实例已释放', ], [ 'errorCode' => 'ERR_INSTANCE_CAN_NOT_RELEASE', 'errorMessage' => '实例暂时无法释放', ], [ 'errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"A3140FC7-B78B-4D8E-B0C8-926D28******\\"\\n}","errorExample":""},{"type":"xml","example":"\\nA3140FC7-B78B-4D8E-B0C8-926D28******\\ntrue\\n","errorExample":""}]', 'title' => '释放目标实例', 'summary' => '调用RemoveDrdsInstance接口释放目标实例。', 'description' => '> * 只能释放按量付费（后付费）实例。'."\n" .'* 实例处于变配中或关联有数据库时，无法调用本接口释放实例。', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'CreateDrdsDB' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'systemTags' => [ 'operationType' => 'create', ], 'parameters' => [ [ 'name' => 'DrdsInstanceId', 'in' => 'query', 'schema' => [ 'description' => '实例ID。', 'type' => 'string', 'required' => true, 'example' => 'drdshbgal154****', ], ], [ 'name' => 'DbName', 'in' => 'query', 'schema' => [ 'description' => '数据库名称。', 'type' => 'string', 'required' => false, 'example' => 'testdb', ], ], [ 'name' => 'Encode', 'in' => 'query', 'schema' => [ 'description' => '数据库所用编码。', 'type' => 'string', 'required' => false, 'example' => 'utf8', 'default' => 'utf8mb4', ], ], [ 'name' => 'Password', 'in' => 'query', 'schema' => [ 'description' => '数据库访问密码。', 'type' => 'string', 'required' => false, 'example' => 'drds_sample_password', ], ], [ 'name' => 'Type', 'in' => 'query', 'schema' => [ 'description' => '库的拆分方式。取值范围如下：'."\n" ."\n" .'- **HORIZONTAL**：表示水平拆分，即通常所说的分库分表方式。'."\n" .'- **VERTICAL**：表示垂直拆分。', 'type' => 'string', 'required' => false, 'example' => 'HORIZONTAL', 'default' => 'HORIZONTAL', ], ], [ 'name' => 'DbInstType', 'in' => 'query', 'schema' => [ 'description' => '挂载的存储类型，目前仅支持RDS。 ', 'type' => 'string', 'required' => false, 'example' => 'RDS', 'default' => 'RDS', ], ], [ 'name' => 'DbInstanceIsCreating', 'in' => 'query', 'schema' => [ 'description' => '建库所涉及的RDS是否正在创建中。', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'default' => 'false', ], ], [ 'name' => 'AccountName', 'in' => 'query', 'schema' => [ 'description' => '该参数仅在垂直拆分时使用。'."\n" .'参数表示垂直拆分场景下，拥有所有RDS上相应数据库访问权限的一个账号名称。', 'type' => 'string', 'required' => false, 'example' => 'drds_sample_account', ], ], [ 'name' => 'RdsInstance', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => 'RDS实例列表。', 'type' => 'array', 'items' => [ 'description' => '该参数仅在水平拆分时必填，参数是一个符合JSON数组格式的字符串。', 'type' => 'string', 'required' => false, 'example' => '["drds_sample_rds_id1", "drds_sample_rds_id2"]', ], 'required' => false, 'example' => '["drds_sample_rds_id1", "drds_sample_rds_id2"]', 'maxItems' => 1000, ], ], [ 'name' => 'RdsSuperAccount', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => 'RDS超级账户信息列表。', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Password' => [ 'description' => 'RDS超级账号密码。', 'type' => 'string', 'required' => false, 'example' => 'drds_sample_rds_super_password', ], 'DbInstanceId' => [ 'description' => 'RDS实例ID。', 'type' => 'string', 'required' => false, 'example' => 'drds_sample_rds_id', ], 'AccountName' => [ 'description' => 'RDS超级账号名称。', 'type' => 'string', 'required' => false, 'example' => 'drds_sample_rds_super_account', ], ], 'required' => false, ], 'required' => false, 'maxItems' => 1000, ], ], [ 'name' => 'InstDbName', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => '数据库列表。', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'DbInstanceId' => [ 'description' => '需要垂直拆分的RDS ID，该参数仅在垂直拆分时使用。'."\n", 'type' => 'string', 'required' => false, 'example' => 'drds_sample_rds_id', ], 'ShardDbName' => [ 'description' => '拆分数据库列表。', 'type' => 'array', 'items' => [ 'description' => '参数表示对应RDS实例中需要垂直拆分的数据库列表，参数是一个符合JSON数组格式的字符串。'."\n" .'该参数仅在垂直拆分时使用。', 'type' => 'string', 'required' => false, 'example' => '["db1", "db2"]', ], 'required' => false, 'example' => '["drds_sample_db1", "drds_sample_db2"]', 'maxItems' => 30, ], ], 'required' => false, ], 'required' => false, 'maxItems' => 100, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Success' => [ 'description' => '请求结果。', 'type' => 'boolean', 'example' => 'true', ], 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => 'FF13E47D-4E38-4A5A-BA68-32A554AD45T6', ], ], ], ], ], 'errorCodes' => [ 404 => [ [ 'errorCode' => 'InvalidInstance.CreateDbForSlave', 'errorMessage' => 'Db Creation in slave drds instance not support.', ], [ 'errorCode' => 'InvalidParameter.InstDbName', 'errorMessage' => 'The parameter InstDbName is empty', ], ], 500 => [ [ 'errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"FF13E47D-4E38-4A5A-BA68-32A554AD45T6\\"\\n}","errorExample":""},{"type":"xml","example":"\\n true\\n FF13E47D-4E38-4A5A-BA68-32A554AD45T6\\n","errorExample":""}]', 'title' => '创建数据库实例', 'summary' => '创建DRDS数据库。', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'DescribeDrdsDBs' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'DrdsInstanceId', 'in' => 'query', 'schema' => [ 'description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'drdshbga1138****', ], ], [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => [ 'description' => '页码，取值为大于0且不超过Integer数据类型的最大值，默认值为**1**。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'default' => '1', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => '每页记录数，取值为**30**、**50**或**100**。'."\n" ."\n" .'默认值为**30**。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '30', 'default' => '1000', ], ], [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => '地域ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'PageSize' => [ 'description' => '每页记录数。', 'type' => 'string', 'example' => '30', ], 'PageNumber' => [ 'description' => '页码。', 'type' => 'string', 'example' => '1', ], 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => '006B7D19-8CDB-4AA6-AAE7-23C107GS3W2T', ], 'Total' => [ 'description' => '数据库列表的总数量。', 'type' => 'string', 'example' => '1', ], 'Success' => [ 'description' => '请求是否成功。', 'type' => 'boolean', 'example' => 'true', ], 'Data' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'Db' => [ 'description' => '数据库列表。', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Status' => [ 'description' => '数据库状态。', 'type' => 'string', 'example' => 'NORMAL', ], 'DbName' => [ 'description' => '数据库名称。', 'type' => 'string', 'example' => 'drds_test', ], 'Schema' => [ 'description' => '系统为拆分后的数据库分配的schema ID。', 'type' => 'string', 'example' => 'drds_test_1563773871118kxqd', ], 'CreateTime' => [ 'description' => '数据库创建时间，格式为Unix时间戳，单位为毫秒。', 'type' => 'string', 'example' => '1563773824000', ], 'Mode' => [ 'description' => '数据库拆分模式，取值范围如下：'."\n" .'* **HORIZONTAL**：水平拆分'."\n" .'* **VERTICAL**：垂直拆分', 'type' => 'string', 'example' => 'HORIZONTAL', ], 'DbInstType' => [ 'description' => '数据库类型，取值为**RDS**或**POLARDB**。', 'type' => 'string', 'example' => 'RDS', ], ], ], ], ], ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'ActionUnauthorized', 'errorMessage' => 'The specified action is not available for you', ], ], 404 => [ [ 'errorCode' => 'InvalidDRDSInstanceId.NotFound', 'errorMessage' => 'The DrdsInstanceId provided does not exist in our records.', ], ], 500 => [ [ 'errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"PageSize\\": \\"30\\",\\n \\"PageNumber\\": \\"1\\",\\n \\"RequestId\\": \\"006B7D19-8CDB-4AA6-AAE7-23C107GS3W2T\\",\\n \\"Total\\": \\"1\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"Db\\": [\\n {\\n \\"Status\\": \\"NORMAL\\",\\n \\"DbName\\": \\"drds_test\\",\\n \\"Schema\\": \\"drds_test_1563773871118kxqd\\",\\n \\"CreateTime\\": \\"1563773824000\\",\\n \\"Mode\\": \\"HORIZONTAL\\",\\n \\"DbInstType\\": \\"RDS\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 30\\n 1\\n 006B7D19-8CDB-4AA6-AAE7-23C107GS3W2T\\n 1\\n true\\n \\n NORMAL\\n drds_test\\n drds_test_1563773871118kxqd\\n 1563773824000\\n HORIZONTAL\\n RDS\\n \\n","errorExample":""}]', 'title' => '查看实例下的数据库列表', 'summary' => '调用DescribeDrdsDBs接口查看实例下的数据库详情。', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'DescribeDrdsDB' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'DrdsInstanceId', 'in' => 'query', 'schema' => [ 'description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'drds*********', ], ], [ 'name' => 'DbName', 'in' => 'query', 'schema' => [ 'description' => '数据库名称。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'db_test', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Success' => [ 'description' => '请求结果。', 'type' => 'boolean', 'example' => 'true', ], 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => '58FB0EC7-CF71-4E48-92FB-CF070D******', ], 'Data' => [ 'description' => '数据库详情。', 'type' => 'object', 'properties' => [ 'Status' => [ 'description' => '数据库状态，取值范围如下：'."\n" .'* **TO_BE_INIT**：创建中'."\n" .'* **NORMAL**：运行中', 'type' => 'string', 'example' => 'NORMAL', ], 'DbName' => [ 'description' => '数据库名称。', 'type' => 'string', 'example' => 'db_test', ], 'Schema' => [ 'description' => '数据库物理名。', 'type' => 'string', 'example' => 'db_test*******************', ], 'CreateTime' => [ 'description' => '数据库创建的时间点，格式为Unix时间戳，单位为毫秒（ms）。', 'type' => 'string', 'example' => '1602050276000', ], 'Mode' => [ 'description' => '数据库拆分方式，取值范围如下：'."\n" .'* **HORIZONTAL**：水平拆分'."\n" .'* **VERTICAL**：垂直拆分', 'type' => 'string', 'example' => 'HORIZONTAL', ], 'DbInstType' => [ 'description' => '数据库的存储类型。', 'type' => 'string', 'example' => 'RDS', ], 'InstRole' => [ 'description' => '数据库所属的实例类型，取值范围如下：'."\n" .'* **MASTER**：主实例'."\n" .'* **SLAVE**：只读实例', 'type' => 'string', 'example' => 'MASTER', ], ], ], ], ], ], ], 'errorCodes' => [ 404 => [ [ 'errorCode' => 'InvalidDbName.NotFound', 'errorMessage' => 'The Drds DbName provided does not exist in our records.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"58FB0EC7-CF71-4E48-92FB-CF070D******\\",\\n \\"Data\\": {\\n \\"Status\\": \\"NORMAL\\",\\n \\"DbName\\": \\"db_test\\",\\n \\"Schema\\": \\"db_test*******************\\",\\n \\"CreateTime\\": \\"1602050276000\\",\\n \\"Mode\\": \\"HORIZONTAL\\",\\n \\"DbInstType\\": \\"RDS\\",\\n \\"InstRole\\": \\"MASTER\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"58FB0EC7-CF71-4E48-92FB-CF070D******\\n\\n NORMAL\\n RDS\\n MASTER\\n db_test*******************\\n HORIZONTAL\\n 1602050276000\\n db_test\\n\\ntrue","errorExample":""}]', 'title' => '查看实例下的数据库详情', 'summary' => '调用DescribeDrdsDB接口查询实例下的数据库详情。', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'DescribeDrdsDbInstances' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'DrdsInstanceId', 'in' => 'query', 'schema' => [ 'description' => '实例ID。', 'type' => 'string', 'required' => true, 'example' => 'drdshbga1138****', ], ], [ 'name' => 'DbName', 'in' => 'query', 'schema' => [ 'description' => '数据库名称。', 'type' => 'string', 'required' => true, 'example' => 'dbname', ], ], [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => [ 'description' => '页码。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'default' => '1', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => '每页数量。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '30', 'default' => '20', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'PageSize' => [ 'description' => '每页大小。', 'type' => 'string', 'example' => '10', ], 'PageNumber' => [ 'description' => '页码。', 'type' => 'string', 'example' => '1', ], 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => '2F7F8080-9132-4279-85D0-B7E5C4305162', ], 'Total' => [ 'description' => 'RDS主实例总数。', 'type' => 'string', 'example' => '1', ], 'Success' => [ 'description' => '请求是否成功。', 'type' => 'boolean', 'example' => 'true', ], 'DbInstances' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'DbInstance' => [ 'description' => '数据库下的存储实例列表。', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'ExpireTime' => [ 'description' => '存储实例过期时间。', 'type' => 'string', 'example' => '1237486127634', ], 'PayType' => [ 'description' => '付费类型。', 'type' => 'string', 'example' => 'PostPaid', ], 'DBInstanceStatus' => [ 'description' => '- 0：创建中'."\n" .'- 1：运行中'."\n" .'- 3：删除中'."\n" .'- 5：重启中'."\n" .'- 6：升降级中'."\n" .'- 7：备份中'."\n" .'- 8：内外网切换中'."\n" .'- 9：迁移中'."\n" .'- 11：迁移数据中'."\n" .'- 12：生成灾备实例中'."\n" .'- 13：数据导入中'."\n" .'- 14：从其他 RDS 实例导入数据中'."\n" .'- 15：容灾切换中'."\n" .'- 16：创建临时实例中'."\n" .'- 17：网络创建中'."\n" .'- 18：实例克隆中'."\n" .'- 19：链路切换中'."\n" .'- 20：只读实例迁移中', 'type' => 'string', 'example' => '1', ], 'NetworkType' => [ 'description' => '网络类型。', 'type' => 'string', 'example' => 'VPC', ], 'Port' => [ 'description' => '端口。', 'type' => 'integer', 'format' => 'int32', 'example' => '3306', ], 'EngineVersion' => [ 'description' => '存储引擎版本，比如RDS for MySQL的5.7、5.6、5.5。', 'type' => 'string', 'example' => '5.7', ], 'DmInstanceId' => [ 'description' => '资源ID。', 'type' => 'string', 'example' => 'dm-hbgau1zp****', ], 'ConnectUrl' => [ 'description' => '存储实例的链接地址，调用对应存储（比如RDS）接口返回的链接地址。', 'type' => 'string', 'example' => 'rm-bp1t1mk5a5b******.mysql.rds.aliyuncs.com', ], 'ReadWeight' => [ 'description' => '在数据库中的读写权重。', 'type' => 'integer', 'format' => 'int32', 'example' => '30', ], 'RdsInstType' => [ 'description' => '是RDS主实例还是只读实例。', 'type' => 'string', 'example' => 'Primary', ], 'RemainDays' => [ 'description' => '预付费实例剩余过期天数。', 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], 'DBInstanceId' => [ 'description' => '存储实例ID。', 'type' => 'string', 'example' => 'rm-bp1t1mk5a5bdj****', ], 'DbInstType' => [ 'description' => '存储实例类型，仅支持RDS。', 'type' => 'string', 'example' => 'RDS', ], 'Engine' => [ 'description' => '存储引擎，比如RDS的MySQL。', 'type' => 'string', 'example' => 'MySQL', ], 'ReadOnlyInstances' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'ReadOnlyInstance' => [ 'description' => '存储实例的只读实例列表。', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'ExpireTime' => [ 'description' => '存储实例过期时间戳。', 'type' => 'string', 'example' => '123421352351234', ], 'PayType' => [ 'description' => '付费类型。', 'type' => 'string', 'example' => 'Postpaid', ], 'DBInstanceStatus' => [ 'description' => '存储实例状态。', 'type' => 'string', 'example' => '1', ], 'NetworkType' => [ 'description' => '实例网络类型。', 'type' => 'string', 'example' => 'VPC', ], 'Port' => [ 'description' => '实例访问端口。', 'type' => 'integer', 'format' => 'int32', 'example' => '3306', ], 'EngineVersion' => [ 'description' => '存储实例引擎版本。', 'type' => 'string', 'example' => '5.7', ], 'DmInstanceId' => [ 'description' => '资源ID。', 'type' => 'string', 'example' => 'dm-hbgau1zp****', ], 'ConnectUrl' => [ 'description' => '存储实例的链接地址，调用对应存储（比如RDS）接口返回的链接地址。', 'type' => 'string', 'example' => 'rm-bp1t1mk5a5b******.mysql.rds.aliyuncs.com', ], 'ReadWeight' => [ 'description' => '实例读写比例。', 'type' => 'integer', 'format' => 'int32', 'example' => '70', ], 'RdsInstType' => [ 'description' => '实例类型。', 'type' => 'string', 'example' => 'RDS', ], 'InstanceName' => [ 'description' => '保留字段。', 'type' => 'string', 'example' => '**', ], 'RemainDays' => [ 'description' => '实例过期剩余天数。', 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], 'DbInstType' => [ 'description' => '存储实例类型。', 'type' => 'string', 'example' => 'RDS', ], 'Engine' => [ 'description' => '存储实例引擎。', 'type' => 'string', 'example' => 'MySQL', ], ], ], ], ], ], ], ], ], ], ], ], ], ], ], 'errorCodes' => [ 500 => [ [ 'errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"PageSize\\": \\"10\\",\\n \\"PageNumber\\": \\"1\\",\\n \\"RequestId\\": \\"2F7F8080-9132-4279-85D0-B7E5C4305162\\",\\n \\"Total\\": \\"1\\",\\n \\"Success\\": true,\\n \\"DbInstances\\": {\\n \\"DbInstance\\": [\\n {\\n \\"ExpireTime\\": \\"1237486127634\\",\\n \\"PayType\\": \\"PostPaid\\",\\n \\"DBInstanceStatus\\": \\"1\\",\\n \\"NetworkType\\": \\"VPC\\",\\n \\"Port\\": 3306,\\n \\"EngineVersion\\": \\"5.7\\",\\n \\"DmInstanceId\\": \\"dm-hbgau1zp****\\",\\n \\"ConnectUrl\\": \\"rm-bp1t1mk5a5b******.mysql.rds.aliyuncs.com\\",\\n \\"ReadWeight\\": 30,\\n \\"RdsInstType\\": \\"Primary\\",\\n \\"RemainDays\\": 0,\\n \\"DBInstanceId\\": \\"rm-bp1t1mk5a5bdj****\\",\\n \\"DbInstType\\": \\"RDS\\",\\n \\"Engine\\": \\"MySQL\\",\\n \\"ReadOnlyInstances\\": {\\n \\"ReadOnlyInstance\\": [\\n {\\n \\"ExpireTime\\": \\"123421352351234\\",\\n \\"PayType\\": \\"Postpaid\\",\\n \\"DBInstanceStatus\\": \\"1\\",\\n \\"NetworkType\\": \\"VPC\\",\\n \\"Port\\": 3306,\\n \\"EngineVersion\\": \\"5.7\\",\\n \\"DmInstanceId\\": \\"dm-hbgau1zp****\\",\\n \\"ConnectUrl\\": \\"rm-bp1t1mk5a5b******.mysql.rds.aliyuncs.com\\",\\n \\"ReadWeight\\": 70,\\n \\"RdsInstType\\": \\"RDS\\",\\n \\"InstanceName\\": \\"**\\",\\n \\"RemainDays\\": 0,\\n \\"DbInstType\\": \\"RDS\\",\\n \\"Engine\\": \\"MySQL\\"\\n }\\n ]\\n }\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 10\\n 1\\n 2F7F8080-9132-4279-85D0-B7E5C4305162\\n 1\\n true\\n \\n 1237486127634\\n PostPaid\\n 1\\n VPC\\n 3306\\n 5.7\\n dm-hbgau1zp****\\n rm-bp1t1mk5a5b******.mysql.rds.aliyuncs.com\\n 30\\n Primary\\n 0\\n rm-bp1t1mk5a5bdj****\\n RDS\\n MySQL\\n \\n 123421352351234\\n Postpaid\\n 1\\n VPC\\n 3306\\n 5.7\\n dm-hbgau1zp****\\n rm-bp1t1mk5a5b******.mysql.rds.aliyuncs.com\\n 70\\n RDS\\n **\\n 0\\n RDS\\n MySQL\\n \\n \\n","errorExample":""}]', 'title' => '查询数据库 RDS 列表', 'summary' => '查询 DRDS 数据库下面的 RDS 列表。', 'description' => '查询 DRDS 数据库下面的 RDS 主实例列表，每个 RDS 主实例的 ReadOnlyInstances 属性是该 RDS 在当前数据库中使用的 RDS 只读实例列表', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'DescribeDrdsDbRdsNameList' => [ 'summary' => '调用DescribeDrdsDbRdsNameList接口查询存储实例列表。', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREdrds25BO3L', ], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'type' => 'string', 'required' => false, 'docRequired' => true, 'default' => 'center', ], ], [ 'name' => 'DrdsInstanceId', 'in' => 'query', 'schema' => [ 'description' => '实例ID。'."\n", 'type' => 'string', 'required' => true, 'example' => 'drdsxxxxxxxxxxx', ], ], [ 'name' => 'DbName', 'in' => 'query', 'schema' => [ 'description' => '数据库名称。', 'type' => 'string', 'required' => true, 'example' => 'drds_test', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Success' => [ 'description' => '请求是否成功。', 'type' => 'boolean', 'example' => 'true', ], 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => '7E6FA2BF-05F2-44DD-95C0-D1B5B8xxxxxx', ], 'InstanceNameList' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'InstanceName' => [ 'type' => 'array', 'items' => [ 'description' => '存储实例ID列表。', 'type' => 'string', 'example' => 'rm-bpxxxxxxxxxxxxxxx', ], ], ], ], ], ], ], ], 'errorCodes' => [ 500 => [ [ 'errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"7E6FA2BF-05F2-44DD-95C0-D1B5B8xxxxxx\\",\\n \\"InstanceNameList\\": {\\n \\"InstanceName\\": [\\n \\"rm-bpxxxxxxxxxxxxxxx\\"\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n\\t37537B38-A663-45CB-A81F-E3B202BB2415\\n\\t\\n\\t\\trm-m5xxxxxxxxx82\\n\\t\\n\\ttrue\\n\\t","errorExample":""}]', 'title' => '查询 DRDS 数据库存储实例列表', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'DescribeDrdsShardingDbs' => [ 'summary' => '调用DescribeDrdsShardingDbs接口查询PolarDB-X下的水平拆分数据库。', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'DrdsInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'PolarDB-X的实例ID。', 'type' => 'string', 'required' => true, 'example' => 'drdshbgaf3c63qbo', ], ], [ 'name' => 'DbName', 'in' => 'query', 'schema' => [ 'description' => 'PolarDB-X实例的数据库名称。', 'type' => 'string', 'required' => true, 'example' => 'drds_test', ], ], [ 'name' => 'DbNamePattern', 'in' => 'query', 'schema' => [ 'description' => '数据库匹配格式。', 'type' => 'string', 'required' => false, 'example' => 'test', ], ], [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => [ 'description' => '当前页数。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => '每页大小。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '20', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Success' => [ 'description' => '请求是否成功。', 'type' => 'boolean', 'example' => 'true', ], 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => '509BDE17-505A-4B3B-854D-30D3F092502F', ], 'ShardingDbs' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'ShardingDb' => [ 'description' => '返回结果列表。', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'MinPoolSize' => [ 'description' => '连接池最小个数。', 'type' => 'integer', 'format' => 'int32', 'example' => '5', ], 'MaxPoolSize' => [ 'description' => '连接池最大个数。', 'type' => 'integer', 'format' => 'int32', 'example' => '60', ], 'DbInstanceId' => [ 'description' => 'RDS实例ID。', 'type' => 'string', 'example' => 'rm-bp1hjzn0yv5j2****', ], 'ConnectUrl' => [ 'description' => '连接url。', 'type' => 'string', 'example' => '100.100.64.100:11569', ], 'GroupName' => [ 'description' => '物理分片名称。', 'type' => 'string', 'example' => 'TEMP1_1568171495522SABE_KUP4_0000', ], 'DbType' => [ 'description' => '数据库类型。', 'type' => 'string', 'example' => 'mysql', ], 'IdleTimeOut' => [ 'description' => '空闲超时时间。', 'type' => 'integer', 'format' => 'int32', 'example' => '30', ], 'ShardingDbName' => [ 'description' => '物理分库名。', 'type' => 'string', 'example' => 'temp1_zhk1_0000', ], 'BlockingTimeout' => [ 'description' => '控制事务为获取锁而需要等待的时长。', 'type' => 'integer', 'format' => 'int32', 'example' => '5000', ], 'PreparedStatementCacheSize' => [ 'description' => '结果缓存大小。', 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], 'ConnectionProperties' => [ 'description' => '连接串属性。', 'type' => 'string', 'example' => 'connectTimeout=3000;autoReconnect=true;failOverReadOnly=false;socketTimeout=900000;rewriteBatchedStatements=true;characterEncoding=utf8', ], 'UserName' => [ 'description' => '连接RDS的用户名。', 'type' => 'string', 'example' => 'pg284mi8', ], 'DbStatus' => [ 'description' => '数据库状态。', 'type' => 'string', 'example' => 'running', ], ], ], ], ], ], 'PageNumber' => [ 'description' => '当前页数。', 'type' => 'string', 'example' => '1', ], 'PageSize' => [ 'description' => '每页大小。', 'type' => 'string', 'example' => '20', ], 'Total' => [ 'description' => '返回的列表总数量。', 'type' => 'string', 'example' => '1', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'ActionUnauthorized', 'errorMessage' => 'The specified action is not available for you', ], [ 'errorCode' => 'ServiceUnable', 'errorMessage' => 'The service is not available now, please try again later', ], [ 'errorCode' => 'InvalidParameter.Mismatch', 'errorMessage' => 'The specified parameter does not match.', ], [ 'errorCode' => 'InvalidDbname.MalFormed', 'errorMessage' => 'The specified db name does not match.', ], [ 'errorCode' => 'InvalidDRDSInstanceId.NotFound', 'errorMessage' => 'The DrdsInstanceId provided does not exist in our records', ], [ 'errorCode' => 'InvalidDbName.NotFound', 'errorMessage' => 'The Drds DbName provided does not exist in our records', ], ], 404 => [ [ 'errorCode' => 'InvalidDRDSInstanceId.NotFound', 'errorMessage' => 'The DrdsInstanceId provided does not exist in our records.', ], [ 'errorCode' => 'InvalidDbName.NotFound', 'errorMessage' => 'The Drds DbName provided does not exist in our records.', ], ], 500 => [ [ 'errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"509BDE17-505A-4B3B-854D-30D3F092502F\\",\\n \\"ShardingDbs\\": {\\n \\"ShardingDb\\": [\\n {\\n \\"MinPoolSize\\": 5,\\n \\"MaxPoolSize\\": 60,\\n \\"DbInstanceId\\": \\"rm-bp1hjzn0yv5j2****\\",\\n \\"ConnectUrl\\": \\"100.100.64.100:11569\\",\\n \\"GroupName\\": \\"TEMP1_1568171495522SABE_KUP4_0000\\",\\n \\"DbType\\": \\"mysql\\",\\n \\"IdleTimeOut\\": 30,\\n \\"ShardingDbName\\": \\"temp1_zhk1_0000\\",\\n \\"BlockingTimeout\\": 5000,\\n \\"PreparedStatementCacheSize\\": 0,\\n \\"ConnectionProperties\\": \\"connectTimeout=3000;autoReconnect=true;failOverReadOnly=false;socketTimeout=900000;rewriteBatchedStatements=true;characterEncoding=utf8\\",\\n \\"UserName\\": \\"pg284mi8\\",\\n \\"DbStatus\\": \\"running\\"\\n }\\n ]\\n },\\n \\"PageNumber\\": \\"1\\",\\n \\"PageSize\\": \\"20\\",\\n \\"Total\\": \\"1\\"\\n}","errorExample":""},{"type":"xml","example":"\\n true\\n 509BDE17-505A-4B3B-854D-30D3F092502F\\n \\n 5\\n 60\\n rm-bp1hjzn0yv5j2****\\n 100.100.64.100:11569\\n TEMP1_1568171495522SABE_KUP4_0000\\n mysql\\n 30\\n temp1_zhk1_0000\\n 5000\\n 0\\n connectTimeout=3000;autoReconnect=true;failOverReadOnly=false;socketTimeout=900000;rewriteBatchedStatements=true;characterEncoding=utf8\\n pg284mi8\\n running\\n \\n 1\\n 20\\n 1\\n","errorExample":""}]', 'title' => '查询DRDS下水平拆分数据库', ], 'CheckDrdsDbName' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'systemTags' => [], 'parameters' => [ [ 'name' => 'DrdsInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'DRDS 实例 ID', 'type' => 'string', 'required' => true, 'example' => 'drds********', ], ], [ 'name' => 'DbName', 'in' => 'query', 'schema' => [ 'description' => 'DRDS 数据库名', 'type' => 'string', 'required' => true, 'example' => 'drds_test', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => '请求 ID', 'type' => 'string', 'example' => 'CF38538C-68BD-4278-B58F-EDE96F******', ], 'Result' => [ 'description' => '检查结果。true：数据库名合法， false：数据库名不合法', 'type' => 'boolean', 'example' => 'true', ], 'Success' => [ 'description' => '是否成功', 'type' => 'boolean', 'example' => 'true', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'InvalidDbName.Empty', 'errorMessage' => 'DbName can not be empty', ], ], 404 => [ [ 'errorCode' => 'InvalidDbName.Keyword', 'errorMessage' => 'Current DbName is the keyword', ], [ 'errorCode' => 'InvalidDbName.DuplicatedInPublic', 'errorMessage' => 'Current DbName is duplicated in public instance', ], [ 'errorCode' => 'InvalidDbName.Duplicated', 'errorMessage' => 'Current DbName provided has already existed in our records.', ], ], 500 => [ [ 'errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"CF38538C-68BD-4278-B58F-EDE96F******\\",\\n \\"Result\\": true,\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"true\\nCF38538C-68BD-4278-B58F-EDE96F******\\ntrue","errorExample":""}]', 'title' => '检查DRDS的数据库名是否合法', 'summary' => '调用CheckDrdsDbName接口检查DRDS的数据库名是否合法。', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'RemoveDrdsDbFailedRecord' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'systemTags' => [ 'operationType' => 'none', 'abilityTreeCode' => '76107', 'abilityTreeNodes' => [ 'FEATUREdrds25BO3L', ], ], 'parameters' => [ [ 'name' => 'DrdsInstanceId', 'in' => 'query', 'schema' => [ 'description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'drds************', ], ], [ 'name' => 'DbName', 'in' => 'query', 'schema' => [ 'description' => '数据库名称。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'test', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => 'D98BC610-5A91-453A-BC44-5873EF******', ], 'Result' => [ 'description' => '请求结果。', 'type' => 'boolean', 'example' => 'true', ], 'Success' => [ 'description' => '是否调用成功。', 'type' => 'boolean', 'example' => 'true', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'InvalidDbName.Empty', 'errorMessage' => 'DbName can not be empty', ], ], 500 => [ [ 'errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"D98BC610-5A91-453A-BC44-5873EF******\\",\\n \\"Result\\": true,\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"D98BC610-5A91-453A-BC44-5873EF******\\ntrue\\ntrue","errorExample":""}]', 'title' => '删除建库失败记录', 'summary' => '调用RemoveDrdsDbFailedRecord接口删除建库失败记录。', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'RemoveDrdsDb' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'systemTags' => [], 'parameters' => [ [ 'name' => 'DrdsInstanceId', 'in' => 'query', 'schema' => [ 'description' => '目标数据库所属的DRDS实例ID。', 'type' => 'string', 'required' => true, 'example' => 'drds************', ], ], [ 'name' => 'DbName', 'in' => 'query', 'schema' => [ 'description' => '目标数据库名称。', 'type' => 'string', 'required' => true, 'example' => 'test', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Success' => [ 'description' => '当前API是否请求成功。', 'type' => 'boolean', 'example' => 'true', ], 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => 'B12FC174-D5CE-4A6E-83C1-0F8F86******', ], ], ], ], ], 'errorCodes' => [ 500 => [ [ 'errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"B12FC174-D5CE-4A6E-83C1-0F8F86******\\"\\n}","errorExample":""},{"type":"xml","example":"B12FC174-D5CE-4A6E-83C1-0F8F86******\\ntrue","errorExample":""}]', 'title' => '删除数据库', 'summary' => '删除DRDS下面的数据库。', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'ModifyRdsReadWeight' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'systemTags' => [ 'operationType' => 'update', ], 'parameters' => [ [ 'name' => 'DrdsInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'DRDS实例ID。', 'type' => 'string', 'required' => true, 'example' => 'drds************', ], ], [ 'name' => 'DbName', 'in' => 'query', 'schema' => [ 'description' => '数据库名称。', 'type' => 'string', 'required' => true, 'example' => 'test', ], ], [ 'name' => 'InstanceNames', 'in' => 'query', 'schema' => [ 'description' => 'RDS实例列表，多个列表间用英文逗号（,）隔开。', 'type' => 'string', 'required' => true, 'example' => 'rm-****************,rm-****************', ], ], [ 'name' => 'Weights', 'in' => 'query', 'schema' => [ 'description' => 'RDS各个实例对应的权重值，多个权重间用英文逗号（,）隔开。', 'type' => 'string', 'required' => true, 'example' => '14,86', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Success' => [ 'description' => '请求结果。', 'type' => 'boolean', 'example' => 'true', ], 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => 'B12FC174-D5CE-4A6E-83C1-0F8F86******', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'InvalidParameter.InvalidDbName', 'errorMessage' => 'The dbName does not exist in this drds instance', ], [ 'errorCode' => 'InvalidParameter.ReadWeighAndRdsNotMapping', 'errorMessage' => 'The parameter read weight and rds instance not mapping', ], [ 'errorCode' => 'InvalidParameter.InvalidReadWeight', 'errorMessage' => 'The parameter read weight is invalid', ], ], 500 => [ [ 'errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"B12FC174-D5CE-4A6E-83C1-0F8F86******\\"\\n}","errorExample":""},{"type":"xml","example":"B12FC174-D5CE-4A6E-83C1-0F8F86******\\ntrue","errorExample":""}]', 'title' => '修改RDS实例的读写权重', 'summary' => '调用ModifyRdsReadWeight接口修改RDS实例的读写权重。', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'DescribeRdsPerformanceSummary' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => '地域ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'default' => 'center', ], ], [ 'name' => 'DrdsInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'DRDS实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'drds************', ], ], [ 'name' => 'RdsInstanceId', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => 'RDS实例列表。', 'type' => 'array', 'items' => [ 'type' => 'string', ], 'required' => true, 'example' => 'rm-*****************', 'maxItems' => 100, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Success' => [ 'description' => '当前API是否请求成功'."\n" ."\n", 'type' => 'boolean', 'example' => 'true', ], 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => 'B6876277-ECFD-4658-AC1E-A7FAD8******', ], 'RdsPerformanceInfos' => [ 'description' => '对象集合。', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Cpu' => [ 'description' => 'RDS的CPU使用情况。', 'type' => 'number', 'format' => 'float', 'example' => '0.26', ], 'ActiveSessions' => [ 'description' => '当前RDS实例活跃会话数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], 'TotalSessions' => [ 'description' => '当前RDS会话总数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '162', ], 'RdsId' => [ 'description' => 'RDS实例ID。', 'type' => 'string', 'example' => 'rm-**************', ], 'Iops' => [ 'description' => 'RDS的IOPS数据。', 'type' => 'number', 'format' => 'float', 'example' => '17.62', ], 'SpaceUsage' => [ 'description' => 'RDS的磁盘使用量，单位为MB。', 'type' => 'integer', 'format' => 'int64', 'example' => '4145144777', ], ], ], ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => '%s', 'errorMessage' => '%s', ], ], 500 => [ [ 'errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"B6876277-ECFD-4658-AC1E-A7FAD8******\\",\\n \\"RdsPerformanceInfos\\": [\\n {\\n \\"Cpu\\": 0.26,\\n \\"ActiveSessions\\": 0,\\n \\"TotalSessions\\": 162,\\n \\"RdsId\\": \\"rm-**************\\",\\n \\"Iops\\": 17.62,\\n \\"SpaceUsage\\": 4145144777\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"B6876277-ECFD-4658-AC1E-A7FAD8******\\n\\n 162\\n 4145144777\\n 0.26\\n 17.62\\n rm-**************\\n 0\\n\\ntrue","errorExample":""}]', 'title' => '查询RDS性能（如CPU）详情', 'summary' => '调用DescribeRdsPerformanceSummary接口查询RDS性能（如CPU）详情。', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'DescribeRdsSuperAccountInstances' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'DrdsInstanceId', 'in' => 'query', 'schema' => [ 'description' => '实例ID。', 'type' => 'string', 'required' => true, 'example' => 'drds************', ], ], [ 'name' => 'DbInstType', 'in' => 'query', 'schema' => [ 'description' => '数据库实例类型，默认值为**RDS**。', 'type' => 'string', 'required' => false, 'example' => 'RDS', 'default' => 'RDS', ], ], [ 'name' => 'RdsInstance', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => 'RDS实例ID列表。', 'type' => 'array', 'items' => [ 'type' => 'string', ], 'required' => true, 'example' => '[\'rm-*****************\',\'rm-*****************\']', 'maxItems' => 30, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => '5D64DE5944A1E541E0******', ], 'DbInstances' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'DbInstance' => [ 'type' => 'array', 'items' => [ 'description' => '高权限账号集合对象。', 'type' => 'string', 'example' => 'rm-*****************', ], ], ], ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'ActionUnauthorized', 'errorMessage' => 'The specified action is not available for you', ], ], 500 => [ [ 'errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"5D64DE5944A1E541E0******\\",\\n \\"DbInstances\\": {\\n \\"DbInstance\\": [\\n \\"rm-*****************\\"\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"4DFD4978-FA5F-4C3C-A30D-AD4D164AD674\\n\\n","errorExample":""}]', 'title' => '获取RDS高权限账号', 'summary' => '调用DescribeRdsSuperAccountInstances获取RDS高权限账号。', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'DescribeDrdsDBCluster' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'systemTags' => [ 'operationType' => 'get', 'abilityTreeCode' => '75988', 'abilityTreeNodes' => [ 'FEATUREdrdsDBGOD6', ], ], 'parameters' => [ [ 'name' => 'DrdsInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'DRDS实例ID。', 'type' => 'string', 'required' => true, 'example' => 'drds*********', ], ], [ 'name' => 'DbName', 'in' => 'query', 'schema' => [ 'description' => 'DRDS数据库名称。', 'type' => 'string', 'required' => true, 'example' => 'drds_test', ], ], [ 'name' => 'DbInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'PolarDB集群ID。', 'type' => 'string', 'required' => true, 'example' => 'pc-*****************', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Success' => [ 'description' => '请求结果。', 'type' => 'boolean', 'example' => 'true', ], 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => '60A77FD6-0DE4-4A34-B6FB-9C2673******', ], 'DbInstance' => [ 'description' => 'PolarDB的实例信息。', 'type' => 'object', 'properties' => [ 'ExpireTime' => [ 'description' => 'PolarDB实例过期时间。', 'type' => 'string', 'example' => '2019-09-27 11:22:33', ], 'PayType' => [ 'description' => 'PolarDB实例购买类型。', 'type' => 'string', 'example' => 'Postpaid', ], 'DBInstanceStatus' => [ 'description' => 'PolarDB实例状态。', 'type' => 'string', 'example' => '1', ], 'NetworkType' => [ 'description' => 'PolarDB实例网络类型。', 'type' => 'string', 'example' => 'VPC', ], 'Port' => [ 'description' => 'PolarDB访问端口。', 'type' => 'integer', 'format' => 'int32', 'example' => '3306', ], 'EngineVersion' => [ 'description' => 'DRDS数据库存储引擎版本。', 'type' => 'string', 'example' => '8.0', ], 'RdsInstType' => [ 'description' => 'RDS实例类型，PolarDB集群不支持该参数。', 'type' => 'string', 'example' => 'ignore', ], 'RemainDays' => [ 'description' => 'PolarDB实例剩余天数。', 'type' => 'string', 'example' => '0', ], 'DBInstanceId' => [ 'description' => 'PolarDB集群ID。', 'type' => 'string', 'example' => 'pc-*****************', ], 'DbInstType' => [ 'description' => 'DRDS数据库存储类型。', 'type' => 'string', 'example' => 'POLARDB', ], 'Engine' => [ 'description' => 'DRDS数据库存储引擎类型。', 'type' => 'string', 'example' => 'POLARDB', ], 'ReadMode' => [ 'description' => '数据库存储类型为PolarDB时，DRDS的读流量配置模式。'."\n" ."\n" .'取值范围如下：'."\n" .'* **DEFAULT**： 默认模式（即读流量全部发往PolarDB读写节点）。'."\n" .'* **CUSTOM**： 用户自定义模式（即您可以自定义流量发往读写节点和只读节点的配比）。'."\n" .'* **BALANCE**：读均衡模式（读流量由PolarDB集群的读负载模块自动分配，也可以理解为读流量均衡分配到各个节点）。', 'type' => 'string', 'example' => 'CUSTOM', ], 'Endpoints' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'Endpoint' => [ 'description' => 'DRDS管理的PolarDB读写分离连接地址。', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'ReadWeight' => [ 'description' => 'DRDS数据库管理的该连接地址的读比例。', 'type' => 'integer', 'format' => 'int32', 'example' => '85', ], 'EndpointId' => [ 'description' => 'PolarDB连接地址ID。', 'type' => 'string', 'example' => 'pe-*****************', ], 'NodeIds' => [ 'description' => 'PolarDB连接地址下的节点ID列表，多个节点间用英文逗号（,）隔开。', 'type' => 'string', 'example' => 'pi-*****************,pi-*****************', ], ], ], ], ], ], 'DBNodes' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'DBNode' => [ 'description' => 'PolarDB集群中的节点信息。', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'DBNodeRole' => [ 'description' => 'PolarDB集群中节点的角色，取值范围如下：'."\n" .'* **Reader**'."\n" .'* **Writer**', 'type' => 'string', 'example' => 'Reader', ], 'ZoneId' => [ 'description' => 'PolarDB集群节点的可用区ID。', 'type' => 'string', 'example' => 'cn-hangzhou-i', ], 'DBNodeId' => [ 'description' => 'PolarDB集群中节点的ID。', 'type' => 'string', 'example' => 'pi-***************', ], 'DBNodeStatus' => [ 'description' => 'PolarDB集群节点的状态。', 'type' => 'string', 'example' => 'Running', ], ], ], ], ], ], ], ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'InvalidParameter.MasterDbInstanceRelease', 'errorMessage' => 'The master db instance has been released', ], ], 500 => [ [ 'errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"60A77FD6-0DE4-4A34-B6FB-9C2673******\\",\\n \\"DbInstance\\": {\\n \\"ExpireTime\\": \\"2019-09-27 11:22:33\\",\\n \\"PayType\\": \\"Postpaid\\",\\n \\"DBInstanceStatus\\": \\"1\\",\\n \\"NetworkType\\": \\"VPC\\",\\n \\"Port\\": 3306,\\n \\"EngineVersion\\": \\"8.0\\",\\n \\"RdsInstType\\": \\"ignore\\",\\n \\"RemainDays\\": \\"0\\",\\n \\"DBInstanceId\\": \\"pc-*****************\\",\\n \\"DbInstType\\": \\"POLARDB\\",\\n \\"Engine\\": \\"POLARDB\\",\\n \\"ReadMode\\": \\"CUSTOM\\",\\n \\"Endpoints\\": {\\n \\"Endpoint\\": [\\n {\\n \\"ReadWeight\\": 85,\\n \\"EndpointId\\": \\"pe-*****************\\",\\n \\"NodeIds\\": \\"pi-*****************,pi-*****************\\"\\n }\\n ]\\n },\\n \\"DBNodes\\": {\\n \\"DBNode\\": [\\n {\\n \\"DBNodeRole\\": \\"Reader\\",\\n \\"ZoneId\\": \\"cn-hangzhou-i\\",\\n \\"DBNodeId\\": \\"pi-***************\\",\\n \\"DBNodeStatus\\": \\"Running\\"\\n }\\n ]\\n }\\n }\\n}","errorExample":""},{"type":"xml","example":"60A77FD6-0DE4-4A34-B6FB-9C2673******\\n\\n POLARDB\\n 8.0\\n 1\\n 3306\\n Postpaid\\n \\n \\n 85\\n pi-*****************\\n pc-*****************\\n \\n \\n 15\\n pi-*****************,pi-*****************\\n pe-*****************\\n \\n \\n pc-*****************\\n \\n \\n Running\\n cn-hangzhou-i\\n Reader\\n pi-*****************\\n \\n \\n Running\\n cn-hangzhou-i\\n Writer\\n pi-*****************\\n \\n \\n Running\\n cn-hangzhou-i\\n Reader\\n pi-*****************\\n \\n \\n VPC\\n CUSTOM\\n \\n 0\\n POLARDB\\n\\ntrue","errorExample":""}]', 'title' => '查询逻辑库下PolarDB集群具体信息', 'summary' => '查询DRDS逻辑库下PolarDB集群具体信息。', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'DescribeRDSPerformance' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'DrdsInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'PolarDB-X实例ID。'."\n" ."\n" .'DRDS实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'drds*********', ], ], [ 'name' => 'RdsInstanceId', 'in' => 'query', 'schema' => [ 'description' => '存储层RDS实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'rm-************', ], ], [ 'name' => 'Keys', 'in' => 'query', 'schema' => [ 'description' => '性能监控指标，允许一次传入多个指标进行查询，多个指标参数间用英文逗号（,）隔开。'."\n" .'> 更多关于性能监控指标详情，请参见[存储监控](~~186705~~)。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'MySQL_MemCpuUsage', ], ], [ 'name' => 'StartTime', 'in' => 'query', 'schema' => [ 'description' => '查询开始时间，格式为Unix时间戳（UTC时间），单位为毫秒。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1603123290000', ], ], [ 'name' => 'EndTime', 'in' => 'query', 'schema' => [ 'description' => '查询结束时间，格式为Unix时间戳（UTC时间），单位为毫秒。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1603209690000', ], ], [ 'name' => 'DbInstType', 'in' => 'query', 'schema' => [ 'description' => '数据库引擎类型。', 'type' => 'string', 'required' => false, 'example' => 'mysql', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Success' => [ 'description' => '请求是否成功。', 'type' => 'boolean', 'example' => 'true', ], 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => 'DB53EC68-463C-4187-8D2B-C2AD8C******', ], 'Data' => [ 'description' => '查询结果集。', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Key' => [ 'description' => '监控指标名称。', 'type' => 'string', 'example' => 'cpuusage', ], 'NodeName' => [ 'description' => '节点名称。'."\n" .'>仅数据库存储类型为PolarDB MySQL时返回该参数，RDS MySQL不会返回该参数。', 'type' => 'string', 'example' => 'pi-*************', ], 'Unit' => [ 'description' => '监控指标的单位。', 'type' => 'string', 'example' => '%', ], 'NodeNum' => [ 'description' => '节点数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'Values' => [ 'description' => '监控指标数据详情。', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Date' => [ 'description' => '获取监控指标数值的时间点，格式为Unix时间戳（UTC时间），单位为毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1603209660000', ], 'Value' => [ 'description' => '监控指标数值。', 'type' => 'string', 'example' => '0.58', ], ], ], ], ], ], ], ], ], ], ], 'errorCodes' => [ 404 => [ [ 'errorCode' => 'Monitor.QueryRdsFailure', 'errorMessage' => 'Failed to query RDS monitor info.', ], ], 500 => [ [ 'errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"DB53EC68-463C-4187-8D2B-C2AD8C******\\",\\n \\"Data\\": [\\n {\\n \\"Key\\": \\"cpuusage\\",\\n \\"NodeName\\": \\"pi-*************\\",\\n \\"Unit\\": \\"%\\",\\n \\"NodeNum\\": 1,\\n \\"Values\\": [\\n {\\n \\"Date\\": 1603209660000,\\n \\"Value\\": \\"0.58\\"\\n }\\n ]\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\nDB53EC68-463C-4187-8D2B-C2AD8C******\\n\\n 1\\n \\n 0.58\\n 1603209660000\\n \\n %\\n cpuusage\\n\\n\\n 1\\n \\n 9.75\\n 1603209660000\\n \\n %\\n memusage\\n\\ntrue\\n","errorExample":""}]', 'title' => '查询存储层RDS性能数据详情', 'summary' => '调用DescribeRDSPerformance接口查询存储层RDS性能数据详情。', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'DescribeDbInstances' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'systemTags' => [ 'operationType' => 'get', 'abilityTreeCode' => '75986', 'abilityTreeNodes' => [ 'FEATUREdrdsD0NTUP', ], ], 'parameters' => [ [ 'name' => 'DrdsInstanceId', 'in' => 'query', 'schema' => [ 'description' => '实例ID。', 'type' => 'string', 'required' => true, 'example' => 'drds************', ], ], [ 'name' => 'Search', 'in' => 'query', 'schema' => [ 'description' => '存储层实例ID或集群ID。', 'type' => 'string', 'required' => false, 'example' => 'pc-***************', ], ], [ 'name' => 'DbInstType', 'in' => 'query', 'schema' => [ 'description' => '存储层类型，取值为POLARDB或RDS。', 'type' => 'string', 'required' => false, 'example' => 'POLARDB', 'default' => 'RDS', ], ], [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => [ 'description' => '分页页码。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'default' => '1', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => '分页每页大小。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'default' => '30', ], ], [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => '地域ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'default' => 'center', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => '293275B3-8FC0-4619-A26E-6F062FASD56R', ], 'Items' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'DBInstance' => [ 'description' => '实例详情列表。', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'InstanceNetworkType' => [ 'description' => '存储层实例网络类型，取值范围如下：'."\n" ."\n" .'- **VPC**：专有网络'."\n" .'- **CLASSIC**：经典网络', 'type' => 'string', 'example' => 'VPC', ], 'DBInstanceType' => [ 'description' => '存储层实例类型。', 'type' => 'string', 'example' => 'Primary', ], 'ZoneId' => [ 'description' => '可用区ID。', 'type' => 'string', 'example' => 'cn-hangzhou-a', ], 'DBInstanceStatus' => [ 'description' => '存储层实例状态，取值范围如下：'."\n" ."\n" .'- **0**：创建中'."\n" .'- **1**：使用中'."\n" .'- **3**：删除中'."\n" .'- **5**：重启中'."\n" .'- **6**：升降级中'."\n" .'- **7**：恢复中'."\n" .'- **8**：内外网切换中', 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], 'DBInstanceId' => [ 'description' => '存储层实例ID。', 'type' => 'string', 'example' => 'rm-****************', ], 'Engine' => [ 'description' => '存储层实例内核。', 'type' => 'string', 'example' => '存储层实例内核。', ], 'DBInstanceDescription' => [ 'description' => '存储层实例描述。', 'type' => 'string', 'example' => 'test', ], 'EngineVersion' => [ 'description' => '存储层实例内核版本。', 'type' => 'string', 'example' => '5.7', ], 'RegionId' => [ 'description' => '地域ID。', 'type' => 'string', 'example' => 'cn-hangzhou', ], 'ReadOnlyDBInstanceId' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'ReadOnlyDBInstanceId' => [ 'description' => '存储层实例下的只读实例。', 'type' => 'array', 'items' => [ 'description' => '存储层实例下的只读实例。', 'type' => 'string', 'example' => '[]', ], ], ], ], 'AllowAllCategory' => [ 'type' => 'boolean', ], ], ], ], ], ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'ActionUnauthorized', 'errorMessage' => 'The specified action is not available for you', ], ], 404 => [ [ 'errorCode' => 'InvalidDRDSInstanceId.NotFound', 'errorMessage' => 'The DrdsInstanceId provided does not exist in our records.', ], [ 'errorCode' => 'InvalidDbName.NotFound', 'errorMessage' => 'The Drds DbName provided does not exist in our records.', ], ], 500 => [ [ 'errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"293275B3-8FC0-4619-A26E-6F062FASD56R\\",\\n \\"Items\\": {\\n \\"DBInstance\\": [\\n {\\n \\"InstanceNetworkType\\": \\"VPC\\",\\n \\"DBInstanceType\\": \\"Primary\\",\\n \\"ZoneId\\": \\"cn-hangzhou-a\\",\\n \\"DBInstanceStatus\\": 0,\\n \\"DBInstanceId\\": \\"rm-****************\\",\\n \\"Engine\\": \\"存储层实例内核。\\",\\n \\"DBInstanceDescription\\": \\"test\\",\\n \\"EngineVersion\\": \\"5.7\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"ReadOnlyDBInstanceId\\": {\\n \\"ReadOnlyDBInstanceId\\": [\\n \\"[]\\"\\n ]\\n },\\n \\"AllowAllCategory\\": true\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 293275B3-8FC0-4619-A26E-6F062FASD56R\\n \\n VPC\\n Primary\\n cn-hangzhou-a\\n 0\\n rm-****************\\n 存储层实例内核。\\n test\\n 5.7\\n cn-hangzhou\\n []\\n \\n","errorExample":""}]', 'title' => '查看存储层实例列表', 'summary' => '查看存储层（如RDS或PolarDB）的实例列表。', ], 'DescribeDbInstanceDbs' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'abilityTreeCode' => '75985', 'abilityTreeNodes' => [ 'FEATUREdrds8KEOBF', ], ], 'parameters' => [ [ 'name' => 'DrdsInstanceId', 'in' => 'query', 'schema' => [ 'description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'drds************', ], ], [ 'name' => 'DbInstanceId', 'in' => 'query', 'schema' => [ 'description' => '存储层数据库所属实例的ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pc-****************', ], ], [ 'name' => 'AccountName', 'in' => 'query', 'schema' => [ 'description' => 'PolarDB-X高级账号名称，若没有高级账号则无需填写。关于高级账号，详情请参见[账号管理](https://help.aliyun.com/document_detail/98664.html)。'."\n" ."\n" .'DRDS高级账号名称，若无高级账号则无需填写。'."\n", 'type' => 'string', 'required' => false, 'example' => 'test', ], ], [ 'name' => 'Password', 'in' => 'query', 'schema' => [ 'description' => 'PolarDB-X高级账号密码，若没有高级账号则无需填写。关于高级账号，详情请参见[账号管理](https://help.aliyun.com/document_detail/98664.html)。'."\n" ."\n" .'DRDS高级账号密码，若没有高级账号则无需填写。'."\n", 'type' => 'string', 'required' => false, 'example' => 'pwd_111111', ], ], [ 'name' => 'DbInstType', 'in' => 'query', 'schema' => [ 'description' => '数据库存储类型，取值为**POLARDB**或**RDS**。', 'type' => 'string', 'required' => false, 'example' => 'POLARDB', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => 'E9F3D991-08DE-4B74-BE0E-06B809******', ], 'Success' => [ 'description' => '请求结果。', 'type' => 'boolean', 'example' => 'true', ], 'Total' => [ 'description' => '数据库总数。', 'type' => 'string', 'example' => '1', ], 'Databases' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'Database' => [ 'description' => '数据库详情列表。', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Status' => [ 'description' => '数据库状态，取值范围如下：'."\n" .'* **0**：创建中'."\n" .'* **1**：可用'."\n" .'* **3**：正在删除 ', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'DbName' => [ 'description' => '数据库名称。', 'type' => 'string', 'example' => 'db_test', ], 'Description' => [ 'description' => '数据库描述。', 'type' => 'string', 'example' => 'test', ], ], ], ], ], ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'ActionUnauthorized', 'errorMessage' => 'The specified action is not available for you', ], ], 404 => [ [ 'errorCode' => 'InvalidDRDSInstanceId.NotFound', 'errorMessage' => 'The DrdsInstanceId provided does not exist in our records.', ], ], 500 => [ [ 'errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"E9F3D991-08DE-4B74-BE0E-06B809******\\",\\n \\"Success\\": true,\\n \\"Total\\": \\"1\\",\\n \\"Databases\\": {\\n \\"Database\\": [\\n {\\n \\"Status\\": 1,\\n \\"DbName\\": \\"db_test\\",\\n \\"Description\\": \\"test\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n \\n 1\\n test\\n db_test\\n \\n\\n1\\nE9F3D991-08DE-4B74-BE0E-06B809******\\ntrue","errorExample":""}]', 'title' => '查看目标存储实例下的数据库列表', 'summary' => '调用DescribeDbInstanceDbs接口查看目标存储实例下的数据库列表。', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'CreateInstanceAccount' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'systemTags' => [ 'operationType' => 'create', ], 'parameters' => [ [ 'name' => 'DrdsInstanceId', 'in' => 'query', 'schema' => [ 'description' => '实例ID。', 'type' => 'string', 'required' => true, 'example' => 'drdsjiii1b49****', ], ], [ 'name' => 'AccountName', 'in' => 'query', 'schema' => [ 'description' => '账号名称。', 'type' => 'string', 'required' => true, 'example' => 'drds_sample_account', ], ], [ 'name' => 'Password', 'in' => 'query', 'schema' => [ 'description' => '账号密码。', 'type' => 'string', 'required' => true, 'example' => 'drds_sample_password', ], ], [ 'name' => 'DbPrivilege', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => '数据库访问权限列表。', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'DbName' => [ 'description' => '数据库名称。', 'type' => 'string', 'required' => false, 'example' => 'test123', ], 'Privilege' => [ 'description' => '需要创建的账号对数据库的访问权限。', 'type' => 'string', 'required' => false, 'example' => 'DDL', ], ], 'required' => false, ], 'required' => true, 'maxItems' => 1000, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Success' => [ 'description' => '请求是否成功。', 'type' => 'boolean', 'example' => 'true', ], 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => 'FF13E47D-4E38-4A5A-BA68-4E610EVF56DC', ], ], ], ], ], 'errorCodes' => [ 404 => [ [ 'errorCode' => 'OperationFailed.CreateAccount', 'errorMessage' => 'Create account failed.', ], ], 500 => [ [ 'errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"FF13E47D-4E38-4A5A-BA68-4E610EVF56DC\\"\\n}","errorExample":""},{"type":"xml","example":"\\n true\\n FF13E47D-4E38-4A5A-BA68-4E610EVF56DC\\n","errorExample":""}]', 'title' => '创建 DRDS 实例级账号', 'summary' => '调用CreateInstanceAccount接口创建DRDS实例级账号。', ], 'RemoveInstanceAccount' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'systemTags' => [], 'parameters' => [ [ 'name' => 'DrdsInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'DRDS实例ID。', 'type' => 'string', 'required' => true, 'example' => 'drds***********', ], ], [ 'name' => 'AccountName', 'in' => 'query', 'schema' => [ 'description' => '账号名称。', 'type' => 'string', 'required' => true, 'example' => 'test', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Success' => [ 'description' => '请求结果。', 'type' => 'boolean', 'example' => 'true', ], 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => 'A3140FC7-B78B-4D8E-B0C8-926D28******', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'OperationFailed.RemoveInstanceAccount', 'errorMessage' => 'Remove instance account failed', ], ], 500 => [ [ 'errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"A3140FC7-B78B-4D8E-B0C8-926D28******\\"\\n}","errorExample":""},{"type":"xml","example":"A3140FC7-B78B-4D8E-B0C8-926D28******\\ntrue","errorExample":""}]', 'title' => '删除实例管理账号', 'summary' => '调用RemoveInstanceAccount接口删除实例管理账号。', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'EnableSqlAudit' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'systemTags' => [ 'operationType' => 'update', ], 'parameters' => [ [ 'name' => 'DrdsInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'DRDS实例ID。', 'type' => 'string', 'required' => true, 'example' => 'drds***********', ], ], [ 'name' => 'DbName', 'in' => 'query', 'schema' => [ 'description' => '开启SQL审计的数据库名称。 ', 'type' => 'string', 'required' => true, 'example' => 'test', ], ], [ 'name' => 'IsRecall', 'in' => 'query', 'schema' => [ 'description' => '是否回溯历史SQL进行审计。', 'type' => 'boolean', 'required' => false, 'example' => 'true', ], ], [ 'name' => 'RecallStartTimestamp', 'in' => 'query', 'schema' => [ 'description' => '回溯开始时间，格式为时间戳（单位为毫秒）。', 'type' => 'string', 'required' => false, 'example' => '1568875132000', ], ], [ 'name' => 'RecallEndTimestamp', 'in' => 'query', 'schema' => [ 'description' => '回溯结束时间，格式为时间戳（单位为毫秒）。'."\n" .'>回溯结束时间需晚于开始时间。', 'type' => 'string', 'required' => false, 'example' => '1568875132000', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => '463A5F0F-12AD-4544-A902-B2B983******', ], 'Result' => [ 'description' => 'SQL审计功能是否开启成功。', 'type' => 'boolean', 'example' => 'true', ], 'Success' => [ 'description' => '请求结果。', 'type' => 'boolean', 'example' => 'true', ], ], ], ], ], 'errorCodes' => [ 500 => [ [ 'errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"463A5F0F-12AD-4544-A902-B2B983******\\",\\n \\"Result\\": true,\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"true\\n463A5F0F-12AD-4544-A902-B2B983******\\ntrue","errorExample":""}]', 'title' => '开启SQL审计功能', 'summary' => '调用EnableSqlAudit接口开启SQL审计功能。', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'DisableSqlAudit' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'systemTags' => [ 'operationType' => 'update', ], 'parameters' => [ [ 'name' => 'DrdsInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'DRDS实例ID。', 'type' => 'string', 'required' => true, 'example' => 'drds***********', ], ], [ 'name' => 'DbName', 'in' => 'query', 'schema' => [ 'description' => 'DRDS的数据库名称。', 'type' => 'string', 'required' => true, 'example' => 'drds_test', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => 'E273749A-9A33-44CF-ABE7-0CB19C******', ], 'Result' => [ 'description' => '返回结果。', 'type' => 'boolean', 'example' => 'true', ], 'Success' => [ 'description' => '当前API是否请求成功。', 'type' => 'boolean', 'example' => 'true', ], ], ], ], ], 'errorCodes' => [ 500 => [ [ 'errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"E273749A-9A33-44CF-ABE7-0CB19C******\\",\\n \\"Result\\": true,\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"E273749A-9A33-44CF-ABE7-0CB19C******\\ntrue\\ntrue","errorExample":""}]', 'title' => '取消SQL审计', 'summary' => '调用DisableSqlAudit接口取消SQL审计。', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'DescribeDrdsSqlAuditStatus' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'DrdsInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'DRDS实例ID。', 'type' => 'string', 'required' => true, 'example' => 'drds************', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Success' => [ 'description' => '请求结果。', 'type' => 'boolean', 'example' => 'true', ], 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => 'DC3ABA3E-0F8A-4596-9104-F5155C******', ], 'Data' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'Data' => [ 'description' => '结果集。', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'ExtraSlsLogStore' => [ 'description' => '外部投递的SLS LogStore。'."\n" .'>仅当开启外部投递时会显示该参数。', 'type' => 'string', 'example' => 'test', ], 'DbName' => [ 'description' => '数据库名称。', 'type' => 'string', 'example' => 'test', ], 'Detailed' => [ 'description' => '是否支持完整的报表，取值为true或false。', 'type' => 'string', 'example' => 'true', ], 'ExtraWriteEnabled' => [ 'description' => '是否开启外部投递，取值为true或false。', 'type' => 'boolean', 'example' => 'false', ], 'Enabled' => [ 'description' => '是否可用，取值为true或false。', 'type' => 'string', 'example' => 'true', ], 'ExtraAliUid' => [ 'description' => '外部投递的Uid。'."\n" .'>仅当开启外部投递时会显示该参数。', 'type' => 'integer', 'format' => 'int64', 'example' => '111', ], 'ExtraSlsProject' => [ 'description' => '外部投递的SLS project。'."\n" .'>仅当开启外部投递时会显示该参数。', 'type' => 'string', 'example' => 'test', ], ], ], ], ], ], ], ], ], ], 'errorCodes' => [ 500 => [ [ 'errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"DC3ABA3E-0F8A-4596-9104-F5155C******\\",\\n \\"Data\\": {\\n \\"Data\\": [\\n {\\n \\"ExtraSlsLogStore\\": \\"test\\",\\n \\"DbName\\": \\"test\\",\\n \\"Detailed\\": \\"true\\",\\n \\"ExtraWriteEnabled\\": false,\\n \\"Enabled\\": \\"true\\",\\n \\"ExtraAliUid\\": 111,\\n \\"ExtraSlsProject\\": \\"test\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"DC3ABA3E-0F8A-4596-9104-F5155C******\\n\\n \\n 111\\n test\\n false\\n true\\n test\\n test\\n true\\n \\n\\ntrue","errorExample":""}]', 'title' => '查询DRDS SQL审计信息', 'summary' => '调用DescribeDrdsSqlAuditStatus接口查询DRDS SQL审计信息。', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'DescribeInstDbSlsInfo' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'DrdsInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'DRDS实例ID。', 'type' => 'string', 'required' => true, 'example' => 'drds***********', ], ], [ 'name' => 'DbName', 'in' => 'query', 'schema' => [ 'description' => '数据库名称。', 'type' => 'string', 'required' => true, 'example' => 'test', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Success' => [ 'description' => '是否成功。', 'type' => 'boolean', 'example' => 'true', ], 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => 'DC3ABA3E-0F8A-4596-9104-F5155C******', ], 'AuditInfo' => [ 'description' => 'SQL审计详情。', 'type' => 'object', 'properties' => [ 'LogStore' => [ 'description' => 'LogStore的名称。', 'type' => 'string', 'example' => 'test', ], 'Project' => [ 'description' => 'SLS Project的名称。', 'type' => 'string', 'example' => 'test', ], ], ], ], ], ], ], 'errorCodes' => [ 500 => [ [ 'errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"DC3ABA3E-0F8A-4596-9104-F5155C******\\",\\n \\"AuditInfo\\": {\\n \\"LogStore\\": \\"test\\",\\n \\"Project\\": \\"test\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n \\n test\\n test\\n \\n DC3ABA3E-0F8A-4596-9104-F5155C******\\n true\\n","errorExample":""}]', 'title' => '查询SLS和LogStore名称', 'summary' => '查询SQL审计时使用的SLS Project和LogStore的名称。', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'DescribeDrdsSlowSqls' => [ 'summary' => '查看DRDS慢SQL。', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '76009', 'abilityTreeNodes' => [ 'FEATUREdrds25BO3L', ], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'type' => 'string', 'required' => false, 'docRequired' => true, 'default' => 'center', ], ], [ 'name' => 'DrdsInstanceId', 'in' => 'query', 'schema' => [ 'description' => '实例ID。', 'type' => 'string', 'required' => true, 'example' => 'drds***************', ], ], [ 'name' => 'DbName', 'in' => 'query', 'schema' => [ 'description' => '数据库名称。', 'type' => 'string', 'required' => true, 'example' => 'test_db', ], ], [ 'name' => 'ExeTime', 'in' => 'query', 'schema' => [ 'description' => 'SQL执行时间，单位为毫秒（ms）。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '1000', ], ], [ 'name' => 'StartTime', 'in' => 'query', 'schema' => [ 'description' => 'SQL查询结束时间，格式为Unix时间戳，单位为毫秒（UTC时间）。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '1568269711000', ], ], [ 'name' => 'EndTime', 'in' => 'query', 'schema' => [ 'description' => 'SQL查询开始时间，格式为Unix时间戳，单位为毫秒（UTC时间）。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '1568267711000', ], ], [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => [ 'description' => '页数。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'default' => '1', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => '每页记录数。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20', 'default' => '30', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'PageSize' => [ 'description' => '每页记录数。', 'type' => 'integer', 'format' => 'int32', 'example' => '20', ], 'PageNumber' => [ 'description' => '页数。', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => '509BDE17-505A-4B3B-854D-30D3F0******', ], 'Total' => [ 'description' => '总记录数。', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'Success' => [ 'description' => '请求是否成功。', 'type' => 'boolean', 'example' => 'true', ], 'Items' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'Item' => [ 'description' => '慢SQL详情。', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'SendTime' => [ 'description' => '慢SQL发送时间，单位为毫秒（ms）。', 'type' => 'integer', 'format' => 'int64', 'example' => '1568267711', ], 'Host' => [ 'description' => '执行机器的IP。', 'type' => 'string', 'example' => '10.0.***.***', ], 'Sql' => [ 'description' => '慢SQL内容。', 'type' => 'string', 'example' => 'SELECT count(1) from payment_order where order_status = \'08\';', ], 'ResponseTime' => [ 'description' => '响应时间，单位为毫秒（ms）。', 'type' => 'integer', 'format' => 'int64', 'example' => '1568267711', ], 'Schema' => [ 'description' => '数据库名称。', 'type' => 'string', 'example' => 'user', ], ], ], ], ], ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'ActionUnauthorized', 'errorMessage' => 'The specified action is not available for you', ], [ 'errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', ], ], 404 => [ [ 'errorCode' => 'InvalidDRDSInstanceId.NotFound', 'errorMessage' => 'The DrdsInstanceId provided does not exist in our records.', ], [ 'errorCode' => 'InvalidDbName.NotFound', 'errorMessage' => 'The Drds DbName provided does not exist in our records.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"PageSize\\": 20,\\n \\"PageNumber\\": 1,\\n \\"RequestId\\": \\"509BDE17-505A-4B3B-854D-30D3F0******\\",\\n \\"Total\\": 1,\\n \\"Success\\": true,\\n \\"Items\\": {\\n \\"Item\\": [\\n {\\n \\"SendTime\\": 1568267711,\\n \\"Host\\": \\"10.0.***.***\\",\\n \\"Sql\\": \\"SELECT count(1) from payment_order where order_status = \'08\';\\",\\n \\"ResponseTime\\": 1568267711,\\n \\"Schema\\": \\"user\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n509BDE17-505A-4B3B-854D-30D3F0******\\n20\\n1\\n1\\n\\n \\n 1568267711\\n user\\n 1568267711\\n 10.0.***.***\\n SELECT count(1) from payment_order where order_status = \'08\';\\n \\n\\ntrue\\n","errorExample":""}]', 'title' => '查看慢SQL', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'CheckSqlAuditEnableStatus' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'systemTags' => [ 'operationType' => 'none', 'abilityTreeCode' => '75944', 'abilityTreeNodes' => [ 'FEATUREdrdsB0CUNV', ], ], 'parameters' => [ [ 'name' => 'DrdsInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'DRDS实例ID。', 'type' => 'string', 'required' => true, 'example' => 'drds************', ], ], [ 'name' => 'DbName', 'in' => 'query', 'schema' => [ 'description' => '数据库名称。', 'type' => 'string', 'required' => true, 'example' => 'test', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Status' => [ 'description' => 'SQL审计功能开启状态，取值范围如下：'."\n" .'* enabled：已开启'."\n" .'* disabled：未开启', 'type' => 'string', 'example' => 'enabled', ], 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => 'FF13E47D-4E38-4A5A-BA68-32A554******', ], 'Success' => [ 'description' => '请求是否成功。', 'type' => 'boolean', 'example' => 'true', ], ], ], ], ], 'errorCodes' => [ 500 => [ [ 'errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"Status\\": \\"enabled\\",\\n \\"RequestId\\": \\"FF13E47D-4E38-4A5A-BA68-32A554******\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\"disabled\\"\\nFF13E47D-4E38-4A5A-BA68-32A554******\\ntrue","errorExample":""}]', 'title' => '校验DRDS逻辑库SQL审计是否已开启', 'summary' => '调用CheckSqlAuditEnableStatus接口校验DRDS逻辑库SQL审计是否已开启。', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'StartRestore' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'systemTags' => [ 'operationType' => 'update', ], 'parameters' => [ [ 'name' => 'DrdsInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'DRDS实例ID。', 'type' => 'string', 'required' => true, 'example' => 'rds********', ], ], [ 'name' => 'PreferredBackupTime', 'in' => 'query', 'schema' => [ 'description' => '实例的恢复时间，格式为`yyyy-MM-dd HH:mm:ss`。', 'type' => 'string', 'required' => false, 'example' => '2019-09-10 20:18:18', ], ], [ 'name' => 'BackupMode', 'in' => 'query', 'schema' => [ 'description' => '备份方式，取值范围如下：'."\n" .'* logic：逻辑备份'."\n" .'* phy：快速备份', 'type' => 'string', 'required' => false, 'example' => 'phy', ], ], [ 'name' => 'BackupLevel', 'in' => 'query', 'schema' => [ 'description' => '备份级别，取值范围如下：'."\n" .'* db：数据库级别'."\n" .'* instance：实例级别', 'type' => 'string', 'required' => false, 'example' => 'db', ], ], [ 'name' => 'BackupDbNames', 'in' => 'query', 'schema' => [ 'description' => '需要恢复的数据库名列表，多个数据库之间用英文逗号（,）分隔。'."\n" .'> 如不填任何数据库名称则默认恢复实例下所有数据库。', 'type' => 'string', 'required' => false, 'example' => 'test1,test2', ], ], [ 'name' => 'BackupId', 'in' => 'query', 'schema' => [ 'description' => 'DRDS备份集ID。'."\n" .'> 若不填该参数，则默认按时间点（PreferredBackupTime）恢复。', 'type' => 'string', 'required' => false, 'example' => '23***', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => '721C71DD-D3D0-4327-BFDD-678326******', ], 'Result' => [ 'description' => '返回结果。', 'type' => 'string', 'example' => 'success', ], 'Success' => [ 'description' => '请求结果。', 'type' => 'boolean', 'example' => 'true', ], ], ], ], ], 'errorCodes' => [ 500 => [ [ 'errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"721C71DD-D3D0-4327-BFDD-678326******\\",\\n \\"Result\\": \\"success\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"success\\n721C71DD-D3D0-4327-BFDD-678326******\\ntrue","errorExample":""}]', 'title' => '启动基于备份的恢复任务', 'summary' => '调用StartRestore接口启动基于备份的恢复任务。', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'SetBackupPolicy' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'systemTags' => [ 'operationType' => 'update', ], 'parameters' => [ [ 'name' => 'DrdsInstanceId', 'in' => 'query', 'schema' => [ 'description' => '实例ID。', 'type' => 'string', 'required' => true, 'example' => 'drds************', ], ], [ 'name' => 'PreferredBackupPeriod', 'in' => 'query', 'schema' => [ 'description' => '备份周期，取值范围如下：'."\n" .'* 0：周一'."\n" .'* 1：周二'."\n" .'* 2：周三'."\n" .'* 3：周四'."\n" .'* 4：周五'."\n" .'* 5：周六'."\n" .'* 6：周日', 'type' => 'string', 'required' => false, 'example' => '0', ], ], [ 'name' => 'PreferredBackupStartTime', 'in' => 'query', 'schema' => [ 'description' => '开始备份时间。', 'type' => 'string', 'required' => false, 'example' => '11:30:30', ], ], [ 'name' => 'PreferredBackupEndTime', 'in' => 'query', 'schema' => [ 'description' => '结束备份时间。', 'type' => 'string', 'required' => false, 'example' => '12:30:30', ], ], [ 'name' => 'BackupMode', 'in' => 'query', 'schema' => [ 'description' => '备份模式，取值范围如下：'."\n" .'* **logic**：逻辑备份'."\n" .'* **phy**：物理备份', 'type' => 'string', 'required' => false, 'example' => 'phy', ], ], [ 'name' => 'BackupLevel', 'in' => 'query', 'schema' => [ 'description' => '备份级别，取值范围如下：'."\n" .'* db：数据库级'."\n" .'* instance：实例级', 'type' => 'string', 'required' => false, 'example' => 'db', ], ], [ 'name' => 'BackupDbNames', 'in' => 'query', 'schema' => [ 'description' => '备份涉及到的数据库，多个数据库间用英文逗号（,）隔开。'."\n" .'> 仅当备份级别为数据库级时该参数才生效。', 'type' => 'string', 'required' => false, 'example' => 'test1,test2', ], ], [ 'name' => 'BackupLog', 'in' => 'query', 'schema' => [ 'description' => '备份日志是否开启，取值范围如下：'."\n" .'* 1：开启'."\n" .'* 0：关闭', 'type' => 'string', 'required' => false, 'example' => '1', ], ], [ 'name' => 'DataBackupRetentionPeriod', 'in' => 'query', 'schema' => [ 'description' => '数据备份保留天数，取值范围为7~730天。', 'type' => 'string', 'required' => false, 'example' => '7', ], ], [ 'name' => 'LogBackupRetentionPeriod', 'in' => 'query', 'schema' => [ 'description' => '日志保留天数，取值范围为7~730天，且必须小于或等于数据备份天数。', 'type' => 'string', 'required' => false, 'example' => '7', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => 'A3140FC7-B78B-4D8E-B0C8-926D28******', ], 'Result' => [ 'description' => '备份策略是否设置成功。', 'type' => 'string', 'example' => 'success', ], 'Success' => [ 'description' => '请求结果。', 'type' => 'boolean', 'example' => 'true', ], ], ], ], ], 'errorCodes' => [ 500 => [ [ 'errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"A3140FC7-B78B-4D8E-B0C8-926D28******\\",\\n \\"Result\\": \\"success\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"A3140FC7-B78B-4D8E-B0C8-926D28******\\nsuccess\\ntrue","errorExample":""}]', 'title' => '设置备份策略', 'summary' => '调用SetBackupPolicy接口设置备份策略。', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'EnableSqlFlashbackMatchSwitch' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'systemTags' => [ 'operationType' => 'update', 'abilityTreeCode' => '76062', 'abilityTreeNodes' => [ 'FEATUREdrds73QXOU', ], ], 'parameters' => [ [ 'name' => 'DrdsInstanceId', 'in' => 'query', 'schema' => [ 'description' => '实例ID。', 'type' => 'string', 'required' => true, 'example' => 'drds***********', ], ], [ 'name' => 'DbName', 'in' => 'query', 'schema' => [ 'description' => '目标数据库名称。', 'type' => 'string', 'required' => true, 'example' => 'test', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => '463A5F0F-12AD-4544-A902-B2B983******', ], 'Result' => [ 'description' => '开启结果。', 'type' => 'boolean', 'example' => 'true', ], 'Success' => [ 'description' => '请求结果。'."\n", 'type' => 'boolean', 'example' => 'true', ], ], ], ], ], 'errorCodes' => [ 500 => [ [ 'errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"463A5F0F-12AD-4544-A902-B2B983******\\",\\n \\"Result\\": true,\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"true\\n463A5F0F-12AD-4544-A902-B2B983******\\ntrue","errorExample":""}]', 'title' => '实现SQL闪回时精确恢复数据', 'summary' => '此时DRDS数据库使用的RDS的BINLOG中会增加执行QUERY的信息。', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'DescribeBackMenu' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'DrdsInstanceId', 'in' => 'query', 'schema' => [ 'description' => '实例ID。', 'type' => 'string', 'required' => true, 'example' => 'drds***********', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Success' => [ 'description' => '请求结果。', 'type' => 'boolean', 'example' => 'true', ], 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => '60C21BE4-EDFE-454C-95ED-3A5C74******', ], 'List' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'list' => [ 'description' => '备份信息列表。', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Support' => [ 'description' => '是否支持备份恢复。', 'type' => 'boolean', 'example' => 'true', ], 'MenuName' => [ 'description' => '备份方式，取值范围如下：'."\n" .'* **logic**：逻辑备份'."\n" .'* **phy**：物理备份', 'type' => 'string', 'example' => 'phy', ], ], ], ], ], ], ], ], ], ], 'errorCodes' => [ 500 => [ [ 'errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"60C21BE4-EDFE-454C-95ED-3A5C74******\\",\\n \\"List\\": {\\n \\"list\\": [\\n {\\n \\"Support\\": true,\\n \\"MenuName\\": \\"phy\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n phy\\n true\\n\\n\\n logic\\n true\\n\\n60C21BE4-EDFE-454C-95ED-3A5C74******\\ntrue","errorExample":""}]', 'title' => '查询实例是否支持备份恢复', 'summary' => '调用DescribeBackMenu接口查询实例是否支持备份恢复。', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'DescribeRestoreOrder' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'DrdsInstanceId', 'in' => 'query', 'schema' => [ 'description' => '实例ID', 'type' => 'string', 'required' => true, 'example' => 'drds************', ], ], [ 'name' => 'PreferredBackupTime', 'in' => 'query', 'schema' => [ 'description' => '备份时间。', 'type' => 'string', 'required' => false, 'example' => '2019-09-16 15:12:53', ], ], [ 'name' => 'BackupMode', 'in' => 'query', 'schema' => [ 'description' => '备份模式，取值为**logic**或**phy**。', 'type' => 'string', 'required' => false, 'example' => 'phy', ], ], [ 'name' => 'BackupLevel', 'in' => 'query', 'schema' => [ 'description' => '备份级别，取值范围如下：'."\n" .'* **db**：库级别'."\n" .'* **instance**：实例级别', 'type' => 'string', 'required' => false, 'example' => 'db', ], ], [ 'name' => 'BackupDbNames', 'in' => 'query', 'schema' => [ 'description' => '备份涉及的数据库名称。', 'type' => 'string', 'required' => false, 'example' => 'drds_flashback', ], ], [ 'name' => 'BackupId', 'in' => 'query', 'schema' => [ 'description' => '备份ID。', 'type' => 'string', 'required' => false, 'example' => '1918df27-4563-11e9-8403-af4fbe******', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Success' => [ 'description' => '当前API是否请求成功。', 'type' => 'boolean', 'example' => 'true', ], 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => '0AD2DE5D-B86B-40B5-9678-487D37******', ], 'RestoreOrderDO' => [ 'description' => '返回数据对象。', 'type' => 'object', 'properties' => [ 'DrdsOrderDOList' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'DrdsOrderDOList' => [ 'description' => '恢复的订单信息。', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'VpcId' => [ 'description' => '专有网络ID。', 'type' => 'string', 'example' => 'vpc-*******************', ], 'Network' => [ 'description' => '网络类型，取值范围如下：'."\n" .'* **classic**：经典网络'."\n" .'* **vpc**：专有网络', 'type' => 'string', 'example' => 'vpc', ], 'VSwtichId' => [ 'description' => '专有网络交换机ID。', 'type' => 'string', 'example' => 'vsw-*******************', ], 'InstSpec' => [ 'description' => '实例规格。', 'type' => 'string', 'example' => '4C8G * 2', ], 'AzoneId' => [ 'description' => '可用区ID。', 'type' => 'string', 'example' => 'cn-hangzhou-e', ], 'RegionId' => [ 'description' => '地域ID。', 'type' => 'string', 'example' => 'cn-hangzhou', ], ], ], ], ], ], 'RdsOrderDOList' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'RdsOrderDOList' => [ 'description' => '恢复的RDS订单信息。', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Network' => [ 'description' => '网络类型，取值范围如下：'."\n" .'* **classic**：经典网络'."\n" .'* **vpc**：专有网络', 'type' => 'string', 'example' => 'VPC', ], 'Version' => [ 'description' => '版本号。', 'type' => 'string', 'example' => '5.6', ], 'InstanceClass' => [ 'description' => '实例规格。', 'type' => 'string', 'example' => 'rds.mysql.s2.large', ], 'DbInstanceStorage' => [ 'description' => '磁盘容量。', 'type' => 'string', 'example' => '10240', ], 'Num' => [ 'description' => '数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '1', ], 'Engine' => [ 'description' => '存储引擎。', 'type' => 'string', 'example' => 'MYSQL', ], 'AzoneId' => [ 'description' => '可用区ID。', 'type' => 'string', 'example' => 'cn-hangzhou-g', ], 'RegionId' => [ 'description' => '地域ID。', 'type' => 'string', 'example' => 'cn-hangzhou', ], ], ], ], ], ], 'PolarOrderDOList' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'PolarOrderDOList' => [ 'description' => '恢复的PolarDB订单信息。', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Network' => [ 'description' => '网络类型，取值范围如下：'."\n" .'* **classic**：经典网络'."\n" .'* **vpc**：专有网络', 'type' => 'string', 'example' => 'VPC', ], 'Version' => [ 'description' => '版本号。', 'type' => 'string', 'example' => '5.6', ], 'InstanceClass' => [ 'description' => '实例规格', 'type' => 'string', 'example' => 'polar.mysql.x4.large', ], 'DbInstanceStorage' => [ 'description' => '磁盘容量。', 'type' => 'string', 'example' => '10240', ], 'Num' => [ 'description' => '数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '1', ], 'Engine' => [ 'description' => 'PolarDB存储引擎。', 'type' => 'string', 'example' => 'POLARDB', ], 'AzoneId' => [ 'description' => '可用区ID。', 'type' => 'string', 'example' => 'cn-hangzhou-g', ], 'RegionId' => [ 'description' => '地域ID。', 'type' => 'string', 'example' => 'cn-hangzhou', ], ], ], ], ], ], ], ], ], ], ], ], 'errorCodes' => [ 500 => [ [ 'errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"0AD2DE5D-B86B-40B5-9678-487D37******\\",\\n \\"RestoreOrderDO\\": {\\n \\"DrdsOrderDOList\\": {\\n \\"DrdsOrderDOList\\": [\\n {\\n \\"VpcId\\": \\"vpc-*******************\\",\\n \\"Network\\": \\"vpc\\",\\n \\"VSwtichId\\": \\"vsw-*******************\\",\\n \\"InstSpec\\": \\"4C8G * 2\\",\\n \\"AzoneId\\": \\"cn-hangzhou-e\\",\\n \\"RegionId\\": \\"cn-hangzhou\\"\\n }\\n ]\\n },\\n \\"RdsOrderDOList\\": {\\n \\"RdsOrderDOList\\": [\\n {\\n \\"Network\\": \\"VPC\\",\\n \\"Version\\": \\"5.6\\",\\n \\"InstanceClass\\": \\"rds.mysql.s2.large\\",\\n \\"DbInstanceStorage\\": \\"10240\\",\\n \\"Num\\": 1,\\n \\"Engine\\": \\"MYSQL\\",\\n \\"AzoneId\\": \\"cn-hangzhou-g\\",\\n \\"RegionId\\": \\"cn-hangzhou\\"\\n }\\n ]\\n },\\n \\"PolarOrderDOList\\": {\\n \\"PolarOrderDOList\\": [\\n {\\n \\"Network\\": \\"VPC\\",\\n \\"Version\\": \\"5.6\\",\\n \\"InstanceClass\\": \\"polar.mysql.x4.large\\",\\n \\"DbInstanceStorage\\": \\"10240\\",\\n \\"Num\\": 1,\\n \\"Engine\\": \\"POLARDB\\",\\n \\"AzoneId\\": \\"cn-hangzhou-g\\",\\n \\"RegionId\\": \\"cn-hangzhou\\"\\n }\\n ]\\n }\\n }\\n}","errorExample":""},{"type":"xml","example":"0AD2DE5D-B86B-40B5-9678-487D37******\\n\\n \\n \\n \\n \\n 4C8G * 2\\n cn-hangzhou-e\\n vpc\\n cn-hangzhou\\n vpc-*******************\\n \\n \\n \\n \\n polar.mysql.x4.large\\n 1\\n cn-hangzhou-g\\n VPC\\n cn-hangzhou\\n 10240\\n 5.6\\n POLARDB\\n \\n \\n polar.mysql.x4.large\\n 1\\n cn-hangzhou-g\\n VPC\\n cn-hangzhou\\n 10240\\n 5.6\\n POLARDB\\n \\n \\n\\ntrue","errorExample":""}]', 'title' => '查看本次恢复购买订单详情', 'summary' => '查看本次恢复购买的订单详情。', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'DescribeBackupDbs' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'DrdsInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'DRDS实例ID。', 'type' => 'string', 'required' => true, 'example' => 'drds************', ], ], [ 'name' => 'PreferredRestoreTime', 'in' => 'query', 'schema' => [ 'description' => '按恢复时间查询。', 'type' => 'string', 'required' => false, 'example' => '1568632541236', ], ], [ 'name' => 'BackupId', 'in' => 'query', 'schema' => [ 'description' => '按备份集ID查询', 'type' => 'string', 'required' => false, 'example' => '201908367', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Success' => [ 'description' => '请求结果。', 'type' => 'boolean', 'example' => 'true', ], 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => '842DFA7F-B09B-42A2-B115-E684AE******', ], 'DbNames' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'dbName' => [ 'type' => 'array', 'items' => [ 'description' => '数据库列表。', 'type' => 'string', 'example' => '["db1","db2"]', ], ], ], ], ], ], ], ], 'errorCodes' => [ 500 => [ [ 'errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"842DFA7F-B09B-42A2-B115-E684AE******\\",\\n \\"DbNames\\": {\\n \\"dbName\\": [\\n \\"[\\\\\\"db1\\\\\\",\\\\\\"db2\\\\\\"]\\"\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n\\n842DFA7F-B09B-42A2-B115-E684AE******\\ntrue","errorExample":""}]', 'title' => '查询可以恢复的数据库列表', 'summary' => '调用DescribeBackupDbs接口查询可以恢复的数据库列表。', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'DescribeBackupSets' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'DrdsInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'DRDS实例ID。', 'type' => 'string', 'required' => true, 'example' => 'drds***********', ], ], [ 'name' => 'StartTime', 'in' => 'query', 'schema' => [ 'description' => '查询开始时间，格式为时间戳（单位为毫秒）。', 'type' => 'string', 'required' => true, 'example' => '1591327800000', ], ], [ 'name' => 'EndTime', 'in' => 'query', 'schema' => [ 'description' => '查询结束时间，格式为时间戳（单位为毫秒）。'."\n" .'> 查询结束时间需晚于查询开始时间', 'type' => 'string', 'required' => true, 'example' => '1591326000000', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Success' => [ 'description' => '请求结果。', 'type' => 'boolean', 'example' => 'true', ], 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => '7103AEE3-9025-442F-B82B-BABD0A******', ], 'BackupSets' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'backupSet' => [ 'description' => '备份集列表。', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'EnableRecovery' => [ 'description' => '该备份集是否可恢复。', 'type' => 'boolean', 'example' => 'false', ], 'Status' => [ 'description' => '备份状态，取值范围如下：'."\n" .'* -1：失败'."\n" .'* 0：未开始'."\n" .'* 1：运行中'."\n" .'* 2：成功', 'type' => 'integer', 'format' => 'int64', 'example' => '2', ], 'BackupConsitentTime' => [ 'description' => '备份恢复持续时间。', 'type' => 'string', 'example' => '2020-06-05 11:31:38', ], 'BackupType' => [ 'description' => '备份类型，取值范围如下：'."\n" .'* manual：手动备份'."\n" .'* auto：自动备份', 'type' => 'string', 'example' => 'manual', ], 'BackupStartTime' => [ 'description' => '备份开始时间，格式为时间戳（单位为毫秒）。', 'type' => 'integer', 'format' => 'int64', 'example' => '1591327754000', ], 'BackupLevel' => [ 'description' => '备份级别，取值范围如下：'."\n" .'* db：数据库级别'."\n" .'* instance：实例级别', 'type' => 'string', 'example' => 'instance', ], 'BackupMode' => [ 'description' => '备份方式，取值范围如下：'."\n" .'* logic：逻辑备份'."\n" .'* phy：快速备份', 'type' => 'string', 'example' => 'logic', ], 'BackupEndTime' => [ 'description' => '备份结束时间，格式为时间戳（单位为毫秒）。'."\n" .'> 0表示未结束。', 'type' => 'integer', 'format' => 'int64', 'example' => '1591327899000', ], 'Id' => [ 'description' => '备份集ID。', 'type' => 'string', 'example' => 'ba30d5c4-a6dc-11ea-bd40-************', ], 'BackupTotalSize' => [ 'description' => '备份集大小，单位为M。', 'type' => 'string', 'example' => '93.24', ], 'BackupDbs' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'backupDb' => [ 'type' => 'array', 'items' => [ 'description' => '备份的数据库列表。', 'type' => 'string', 'example' => '["dts********"]', ], ], ], ], ], ], ], ], ], ], ], ], ], 'errorCodes' => [ 500 => [ [ 'errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"7103AEE3-9025-442F-B82B-BABD0A******\\",\\n \\"BackupSets\\": {\\n \\"backupSet\\": [\\n {\\n \\"EnableRecovery\\": false,\\n \\"Status\\": 2,\\n \\"BackupConsitentTime\\": \\"2020-06-05 11:31:38\\",\\n \\"BackupType\\": \\"manual\\",\\n \\"BackupStartTime\\": 1591327754000,\\n \\"BackupLevel\\": \\"instance\\",\\n \\"BackupMode\\": \\"logic\\",\\n \\"BackupEndTime\\": 1591327899000,\\n \\"Id\\": \\"ba30d5c4-a6dc-11ea-bd40-************\\",\\n \\"BackupTotalSize\\": \\"93.24\\",\\n \\"BackupDbs\\": {\\n \\"backupDb\\": [\\n \\"[\\\\\\"dts********\\\\\\"]\\"\\n ]\\n }\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"7103AEE3-9025-442F-B82B-BABD0A******\\n\\n \\n 2\\n 93.24\\n 2020-06-05 11:31:38\\n 1591327899000\\n logic\\n instance\\n 1591327754000\\n manual\\n \\n dts********\\n \\n ba30d5c4-a6dc-11ea-bd40-************\\n true\\n \\n\\ntrue","errorExample":""}]', 'title' => '查询备份集信息', 'summary' => '调用DescribeBackupSets接口查询备份集信息。', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'DescribeBackupPolicy' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'DrdsInstanceId', 'in' => 'query', 'schema' => [ 'description' => '实例ID。', 'type' => 'string', 'required' => true, 'example' => 'drdshbga71nn****', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Success' => [ 'description' => '操作是否成功。取值：true：成功。false：失败。', 'type' => 'boolean', 'example' => 'true', ], 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => '8FAF3989-79CD-4A67-8FFD-97899B64SD5T', ], 'BackupPolicyDO' => [ 'description' => '备份策略设置详情。', 'type' => 'object', 'properties' => [ 'BackupDbName' => [ 'description' => '此api无返回', 'type' => 'string', 'enumValueTitles' => [], 'example' => 'null', ], 'LogBackupRetentionPeriod' => [ 'description' => '日志备份保留天数。', 'type' => 'integer', 'format' => 'int64', 'example' => '10', ], 'DataBackupRetentionPeriod' => [ 'description' => '数据备份保留时，单位为天。', 'type' => 'integer', 'format' => 'int64', 'example' => '10', ], 'BackupType' => [ 'description' => '备份类型，取值范围如下：'."\n" ."\n" .'- manual：手动备份'."\n" .'- auto：自动备份', 'type' => 'string', 'example' => 'auto', ], 'BackupLevel' => [ 'description' => '备份级别，取值范围如下：'."\n" ."\n" .'- db：数据库级别'."\n" .'- instance：实例级别', 'type' => 'string', 'example' => 'db', ], 'LocalLogRetentionHours' => [ 'description' => '此api无返回', 'type' => 'integer', 'format' => 'int64', 'example' => '0', ], 'HighSpaceUsageProtection' => [ 'description' => '此api无返回', 'type' => 'integer', 'format' => 'int64', ], 'GmtModified' => [ 'description' => '此api无返回', 'type' => 'integer', 'format' => 'int64', 'example' => '0', ], 'BackupRetentionPeriod' => [ 'description' => '备份保留天数。', 'type' => 'integer', 'format' => 'int64', 'example' => '8', ], 'BackupPolicyMode' => [ 'description' => '备份策略模式，取值范围如下：'."\n" ."\n" .'- DataBackupPolicy：数据备份策略'."\n" .'- LogBackupPolicy：日志备份策略', 'type' => 'string', 'example' => 'DataBackupPolicy', ], 'PreferredBackupPeriod' => [ 'description' => '备份周期，允许传入多个时间周期，多个周期间用英文逗号（,）分隔，取值范围如下：'."\n" .'- 1: 星期日'."\n" .'- 2: 星期一'."\n" .'- 3: 星期二'."\n" .'- 4: 星期三'."\n" .'- 5: 星期四'."\n" .'- 6: 星期五'."\n" .'- 7: 星期六', 'type' => 'string', 'example' => '2', ], 'LocalLogRetentionSpace' => [ 'description' => '此api无返回', 'type' => 'integer', 'format' => 'int64', 'example' => '0', ], 'BackupAppName' => [ 'description' => '此api无返回', 'type' => 'string', 'example' => 'null', ], 'PreferredBackupTime' => [ 'description' => '备份的时间段（UTC时间）。', 'type' => 'string', 'example' => '22:00:00-23:00:00', ], 'GmtCreate' => [ 'description' => '此api无返回', 'type' => 'integer', 'format' => 'int64', 'example' => '0', ], 'BackupMode' => [ 'description' => '备份方式，取值范围如下：'."\n" .'* **logic**：逻辑备份'."\n" .'* **phy**：快速备份', 'type' => 'string', 'example' => 'phy', ], 'BackupLog' => [ 'description' => '是否开启备份日志，取值范围如下：'."\n" .'* **1**：开启'."\n" .'* **0**：关闭', 'type' => 'string', 'example' => '1', ], 'NextBackupActuallyTime' => [ 'description' => '此api无返回', 'type' => 'string', 'example' => 'null', ], ], ], ], ], ], ], 'errorCodes' => [ 500 => [ [ 'errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"8FAF3989-79CD-4A67-8FFD-97899B64SD5T\\",\\n \\"BackupPolicyDO\\": {\\n \\"BackupDbName\\": \\"null\\",\\n \\"LogBackupRetentionPeriod\\": 10,\\n \\"DataBackupRetentionPeriod\\": 10,\\n \\"BackupType\\": \\"auto\\",\\n \\"BackupLevel\\": \\"db\\",\\n \\"LocalLogRetentionHours\\": 0,\\n \\"HighSpaceUsageProtection\\": 0,\\n \\"GmtModified\\": 0,\\n \\"BackupRetentionPeriod\\": 8,\\n \\"BackupPolicyMode\\": \\"DataBackupPolicy\\",\\n \\"PreferredBackupPeriod\\": \\"2\\",\\n \\"LocalLogRetentionSpace\\": 0,\\n \\"BackupAppName\\": \\"null\\",\\n \\"PreferredBackupTime\\": \\"22:00:00-23:00:00\\",\\n \\"GmtCreate\\": 0,\\n \\"BackupMode\\": \\"phy\\",\\n \\"BackupLog\\": \\"1\\",\\n \\"NextBackupActuallyTime\\": \\"null\\"\\n }\\n}","type":"json"}]', 'title' => '查看集群自动备份策略', 'summary' => '调用DescribeBackupPolicy接口查看备份策略设置详情。', ], 'DescribeBackupTimes' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'DrdsInstanceId', 'in' => 'query', 'schema' => [ 'description' => '实例ID。', 'type' => 'string', 'required' => true, 'example' => 'drdshbga71nn****', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Success' => [ 'description' => '请求结果。', 'type' => 'boolean', 'example' => 'true', ], 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => '4780A19F-5ECB-4C56-AD20-966A3FF9DE5R', ], 'RestoreTime' => [ 'description' => '可恢复时间详情。', 'type' => 'object', 'properties' => [ 'EndTime' => [ 'description' => '结束时间，格式为Unix时间戳（UTC时间），单位为毫秒。', 'type' => 'string', 'example' => '1568636922671', ], 'StartTime' => [ 'description' => '开始时间，格式为Unix时间戳（UTC时间），单位为毫秒。', 'type' => 'string', 'example' => '1568632853000', ], ], ], ], ], ], ], 'errorCodes' => [ 500 => [ [ 'errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"4780A19F-5ECB-4C56-AD20-966A3FF9DE5R\\",\\n \\"RestoreTime\\": {\\n \\"EndTime\\": \\"1568636922671\\",\\n \\"StartTime\\": \\"1568632853000\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"4780A19F-5ECB-4C56-AD20-966A3FF9DE5R\\ntrue\\n\\n 1568636922671\\n 1568632853000\\n","errorExample":""}]', 'title' => '查询实例可恢复到的目标时间', 'summary' => '调用DescribeBackupTimes接口查看实例可恢复到的目标时间。', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'RemoveBackupsSet' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'systemTags' => [ 'operationType' => 'none', 'abilityTreeCode' => '76103', 'abilityTreeNodes' => [ 'FEATUREdrdsE1M93A', ], ], 'parameters' => [ [ 'name' => 'DrdsInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'DRDS实例ID。', 'type' => 'string', 'required' => true, 'example' => 'drds************', ], ], [ 'name' => 'BackupId', 'in' => 'query', 'schema' => [ 'description' => '备份集ID，您可以调用[DescribeBackupSets](~~139331~~)接口查询备份集ID。', 'type' => 'string', 'required' => true, 'example' => 'ba30d5c4-a6dc-11ea-bd40-************', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => '70FED5BE-4DDC-4556-AD35-5A6D27******', ], 'Result' => [ 'description' => '返回结果。', 'type' => 'string', 'example' => 'success', ], 'Success' => [ 'description' => '当前API是否请求成功。', 'type' => 'boolean', 'example' => 'true', ], ], ], ], ], 'errorCodes' => [ 500 => [ [ 'errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"70FED5BE-4DDC-4556-AD35-5A6D27******\\",\\n \\"Result\\": \\"success\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"70FED5BE-4DDC-4556-AD35-5A6D27******\\ntrue\\nsuccess","errorExample":""}]', 'title' => '删除备份集', 'summary' => '调用RemoveBackupsSet接口删除备份集。', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'PutStartBackup' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'systemTags' => [ 'operationType' => 'none', 'abilityTreeCode' => '76095', 'abilityTreeNodes' => [ 'FEATUREdrds8KEOBF', ], ], 'parameters' => [ [ 'name' => 'DrdsInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'DRDS实例ID。', 'type' => 'string', 'required' => true, 'example' => 'drds****c6vxxyzd', ], ], [ 'name' => 'BackupMode', 'in' => 'query', 'schema' => [ 'description' => '备份模式，详情请参见[备份模式](~~108631~~)，取值范围如下：'."\n" .'* phy：快速备份'."\n" .'* logic：一致性备份', 'type' => 'string', 'required' => false, 'example' => 'phy', ], ], [ 'name' => 'BackupLevel', 'in' => 'query', 'schema' => [ 'description' => '备份等级，取值范围如下： '."\n" .'* instance：实例级 '."\n" .'* db：数据库级 ', 'type' => 'string', 'required' => false, 'example' => 'db', ], ], [ 'name' => 'BackupDbNames', 'in' => 'query', 'schema' => [ 'description' => '如果是数据库级备份，需要指定需要备份的数据库列表，多个数据库间用英文逗号（,）分隔。', 'type' => 'string', 'required' => false, 'example' => 'db_1, db_2', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => '5D64DE5944A1E541E0******', ], 'Result' => [ 'description' => '请求结果描述。', 'type' => 'string', 'example' => 'success', ], 'Success' => [ 'description' => '当前API是否请求成功。', 'type' => 'boolean', 'example' => 'true', ], ], ], ], ], 'errorCodes' => [ 500 => [ [ 'errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"5D64DE5944A1E541E0******\\",\\n \\"Result\\": \\"success\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"200\\n\\n 07D9CC74-2707-4234-BC5A-1F11AE******\\n true\\n success\\n","errorExample":""}]', 'title' => '通过提交数据备份任务', 'summary' => '通过调用PutStartBackup接口提交数据备份任务。', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'CreateInstanceInternetAddress' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'systemTags' => [ 'operationType' => 'create', ], 'parameters' => [ [ 'name' => 'DrdsInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'DRDS实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'drds****************', ], ], [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => 'DRDS实例所属的地域ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'default' => 'center', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Code' => [ 'description' => '错误码。'."\n" .'> 仅当接口调用出错时会出现该参数。', 'type' => 'integer', 'format' => 'int32', 'example' => '404', ], 'Data' => [ 'description' => '创建公网IP是否成功。', 'type' => 'boolean', 'example' => 'true', ], 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => '1DF6052F-15E2-4E69-9628-D6BCC3******', ], 'Success' => [ 'description' => '请求是否成功。', 'type' => 'boolean', 'example' => 'true', ], ], ], ], ], 'errorCodes' => [ 500 => [ [ 'errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error. 默认错误码', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": 404,\\n \\"Data\\": true,\\n \\"RequestId\\": \\"1DF6052F-15E2-4E69-9628-D6BCC3******\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"true\\n1DF6052F-15E2-4E69-9628-D6BCC3******\\ntrue","errorExample":""}]', 'title' => '为DRDS实例创建公网IP', 'summary' => '调用CreateInstanceInternetAddress接口为DRDS实例创建公网IP。', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'UpdateInstanceNetwork' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'systemTags' => [ 'operationType' => 'update', 'abilityTreeCode' => '76149', 'abilityTreeNodes' => [ 'FEATUREdrdsBRC5LQ', ], ], 'parameters' => [ [ 'name' => 'DrdsInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'DRDS实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'drds******', ], ], [ 'name' => 'SrcInstanceNetworkType', 'in' => 'query', 'schema' => [ 'description' => 'DRDS实例当前的网络类型，取值范围如下：'."\n" .'* vpc：专有网络'."\n" .'* classic：经典网络', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'classic', ], ], [ 'name' => 'RetainClassic', 'in' => 'query', 'schema' => [ 'description' => '是否保留经典网络地址。', 'type' => 'boolean', 'required' => false, 'example' => 'true', ], ], [ 'name' => 'ClassicExpiredDays', 'in' => 'query', 'schema' => [ 'description' => '经典网络地址保留天数。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '30', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Success' => [ 'description' => '请求结果。', 'type' => 'boolean', 'example' => 'true', ], 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => 'DSSDF-SEWE-*****', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'ERR_INSTANCE_CANNOT_SWITCH_NETWORK_FOR_PUBLIC', 'errorMessage' => 'Public instance cannot switch network to VPC', ], ], 500 => [ [ 'errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"DSSDF-SEWE-*****\\"\\n}","errorExample":""},{"type":"xml","example":"DSSDF-SEWE-*****\\ntrue","errorExample":""}]', 'title' => '切换DRDS实例的网络类型', 'summary' => '调用UpdateInstanceNetwork接口切换DRDS实例的网络类型。', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'ReleaseInstanceInternetAddress' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'systemTags' => [], 'parameters' => [ [ 'name' => 'DrdsInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'DRDS实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'drds************', ], ], [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => '实例所在地域。', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing', 'default' => 'center', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Data' => [ 'description' => '当前API返回结果。', 'type' => 'boolean', 'example' => 'true', ], 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => 'FD17CD3C-3355-49E8-9231-FE2DB0******', ], ], ], ], ], 'errorCodes' => [ 500 => [ [ 'errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error. 默认错误码', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"Data\\": true,\\n \\"RequestId\\": \\"FD17CD3C-3355-49E8-9231-FE2DB0******\\"\\n}","errorExample":""},{"type":"xml","example":"FD17CD3C-3355-49E8-9231-FE2DB0******\\ntrue","errorExample":""}]', 'title' => '释放实例外网地址', 'summary' => '保证实例安全性。', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'ModifyDrdsIpWhiteList' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'systemTags' => [ 'operationType' => 'update', 'abilityTreeCode' => '76084', 'abilityTreeNodes' => [ 'FEATUREdrdsJOW4UL', ], ], 'parameters' => [ [ 'name' => 'DrdsInstanceId', 'in' => 'query', 'schema' => [ 'description' => '实例ID。', 'type' => 'string', 'required' => true, 'example' => 'drds****c6vxxyzd', ], ], [ 'name' => 'DbName', 'in' => 'query', 'schema' => [ 'description' => '数据库名称。', 'type' => 'string', 'required' => true, 'example' => 'test', ], ], [ 'name' => 'IpWhiteList', 'in' => 'query', 'schema' => [ 'description' => '修改后的白名单列表，多个白名单IP间用英文（,）分隔。', 'type' => 'string', 'required' => true, 'example' => '127.***.***.***,10.***.***.***', ], ], [ 'name' => 'Mode', 'in' => 'query', 'schema' => [ 'description' => '修改模式，取值范围如下：'."\n" .'* `true`：追加修改 '."\n" .'* `false`：覆盖修改', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'default' => 'false', ], ], [ 'name' => 'GroupName', 'in' => 'query', 'schema' => [ 'description' => '白名单分组。', 'type' => 'string', 'required' => false, 'example' => 'drds_******', ], ], [ 'name' => 'GroupAttribute', 'in' => 'query', 'schema' => [ 'description' => '白名单分组描述。', 'type' => 'string', 'required' => false, 'example' => '分组1', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Success' => [ 'description' => '当前API是否请求成功。', 'type' => 'boolean', 'example' => 'true', ], 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => '933A1EC2-8260-4D4F-A56A-73BA27******', ], ], ], ], ], 'errorCodes' => [ 500 => [ [ 'errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"933A1EC2-8260-4D4F-A56A-73BA27******\\"\\n}","errorExample":""},{"type":"xml","example":"933A1EC2-8260-4D4F-A56A-73BA27******\\ntrue","errorExample":""}]', 'title' => '修改数据库白名单', 'summary' => '调用ModifyDrdsIpWhiteList接口修改数据库白名单。', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'DescribeDrdsDBIpWhiteList' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => '实例所在地域。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'cn-hangzhou', 'default' => 'center', ], ], [ 'name' => 'DrdsInstanceId', 'in' => 'query', 'schema' => [ 'description' => '实例ID。', 'type' => 'string', 'required' => true, 'example' => 'drds********', ], ], [ 'name' => 'DbName', 'in' => 'query', 'schema' => [ 'description' => '数据库名称。', 'type' => 'string', 'required' => true, 'example' => 'test_db', ], ], [ 'name' => 'GroupName', 'in' => 'query', 'schema' => [ 'description' => '白名单分组名称。', 'type' => 'string', 'required' => false, 'example' => 'group1', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Success' => [ 'description' => '请求是否成功。', 'type' => 'boolean', 'example' => 'true', ], 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => '017453B9-0001-4745-87BF-DD612D850ED0', ], 'IpWhiteList' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'Ip' => [ 'type' => 'array', 'items' => [ 'description' => 'IP白名单列表。', 'type' => 'string', 'example' => '10.23.***.***,10.23.***.***/24', ], ], ], ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'ActionUnauthorized', 'errorMessage' => 'The specified action is not available for you', ], ], 404 => [ [ 'errorCode' => 'InvalidDRDSInstanceId.NotFound', 'errorMessage' => 'The DrdsInstanceId provided does not exist in our records.', ], [ 'errorCode' => 'InvalidDbName.NotFound', 'errorMessage' => 'The Drds DbName provided does not exist in our records.', ], ], 500 => [ [ 'errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"017453B9-0001-4745-87BF-DD612D850ED0\\",\\n \\"IpWhiteList\\": {\\n \\"Ip\\": [\\n \\"10.23.***.***,10.23.***.***/24\\"\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n true\\n 017453B9-0001-4745-87BF-DD612D850ED0\\n 10.23.***.***,10.23.***.***/24\\n","errorExample":""}]', 'title' => '获取IP白名单列表', 'summary' => '查看目标数据库的IP白名单列表。', ], 'SubmitCleanTask' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'systemTags' => [], 'parameters' => [ [ 'name' => 'DrdsInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'DRDS实例ID。', 'type' => 'string', 'required' => true, 'example' => 'drds*********', ], ], [ 'name' => 'DbName', 'in' => 'query', 'schema' => [ 'description' => '扩容数据库的名称。', 'type' => 'string', 'required' => true, 'example' => 'test', ], ], [ 'name' => 'ParentJobId', 'in' => 'query', 'schema' => [ 'description' => '该扩容任务的任务ID，提交扩容任务的请求会返回。', 'type' => 'string', 'required' => true, 'example' => '123', ], ], [ 'name' => 'JobId', 'in' => 'query', 'schema' => [ 'description' => '该扩容任务的JobId，与ParentJobId取值相同。', 'type' => 'string', 'required' => true, 'example' => '123', ], ], [ 'name' => 'ExpandType', 'in' => 'query', 'schema' => [ 'description' => '扩容类型，取值范围如下：'."\n" .'* smooth_expand：平滑扩容'."\n" .'* hot_expand：热点扩容', 'type' => 'string', 'required' => true, 'example' => 'smooth_expand', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Success' => [ 'description' => '请求是否成功。', 'type' => 'boolean', 'example' => 'true', ], 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => 'DSSDF-SEWE-*****', ], ], ], ], ], 'errorCodes' => [ 500 => [ [ 'errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"DSSDF-SEWE-*****\\"\\n}","errorExample":""},{"type":"xml","example":"DSSDF-SEWE-*****\\ntrue","errorExample":""}]', 'title' => '提交清理扩容任务', 'summary' => '调用SubmitCleanTask接口提交清理扩容任务。', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'SubmitSmoothExpandPreCheck' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'systemTags' => [], 'parameters' => [ [ 'name' => 'DrdsInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'DRDS实例ID。', 'type' => 'string', 'required' => true, 'example' => 'drds*******', ], ], [ 'name' => 'DbName', 'in' => 'query', 'schema' => [ 'description' => 'DRDS数据库名称。', 'type' => 'string', 'required' => true, 'example' => 'test', ], ], [ 'name' => 'DbInstType', 'in' => 'query', 'schema' => [ 'description' => '数据库的类型，取值范围如下：'."\n" .'* RDS'."\n" .'* POLARDB', 'type' => 'string', 'required' => true, 'example' => 'RDS', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Msg' => [ 'description' => '提交任务的结果。', 'type' => 'string', 'example' => 'success', ], 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => 'FE104D26-AC19-49B5-AC67-947F69******', ], 'TaskId' => [ 'description' => '任务ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '11111', ], 'Success' => [ 'description' => '请求是否成功。', 'type' => 'boolean', 'example' => 'true', ], ], ], ], ], 'errorCodes' => [ 500 => [ [ 'errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"Msg\\": \\"success\\",\\n \\"RequestId\\": \\"FE104D26-AC19-49B5-AC67-947F69******\\",\\n \\"TaskId\\": 11111,\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"FE104D26-AC19-49B5-AC67-947F69******\\n97358\\ntrue\\nsuccess","errorExample":""}]', 'title' => '提交平滑扩容预检任务', 'summary' => '调用SubmitSmoothExpandPreCheck接口提交平滑扩容预检任务。', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'CheckExpandStatus' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'systemTags' => [], 'parameters' => [ [ 'name' => 'DrdsInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'DRDS实例ID。', 'type' => 'string', 'required' => true, 'example' => 'drds***********', ], ], [ 'name' => 'DbName', 'in' => 'query', 'schema' => [ 'description' => '数据库名称。', 'type' => 'string', 'required' => true, 'example' => 'test', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Success' => [ 'description' => '请求结果。', 'type' => 'boolean', 'example' => 'true', ], 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => '7CDBA7D5-8D62-4D24-9C65-510D62******', ], 'Data' => [ 'description' => '校验结果。', 'type' => 'object', 'properties' => [ 'Msg' => [ 'description' => '附加说明信息。', 'type' => 'string', 'example' => 'success', ], 'IsActive' => [ 'description' => '是否可进行扩容操作。', 'type' => 'boolean', 'example' => 'true', ], ], ], ], ], ], ], 'errorCodes' => [ 500 => [ [ 'errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"7CDBA7D5-8D62-4D24-9C65-510D62******\\",\\n \\"Data\\": {\\n \\"Msg\\": \\"success\\",\\n \\"IsActive\\": true\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n true\\n \\n\\n7CDBA7D5-8D62-4D24-9C65-510D62******\\ntrue","errorExample":""}]', 'title' => '校验数据库是否可进行扩容操作', 'summary' => '校验DRDS数据库是否可进行平滑扩容等扩容操作。', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'SubmitHotExpandTask' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'systemTags' => [ 'operationType' => 'none', 'abilityTreeCode' => '76135', 'abilityTreeNodes' => [ 'FEATUREdrdsR9AYAV', ], ], 'parameters' => [ [ 'name' => 'DrdsInstanceId', 'in' => 'query', 'schema' => [ 'description' => '实例ID。', 'type' => 'string', 'required' => true, 'example' => 'drdshbga1138****', ], ], [ 'name' => 'DbName', 'in' => 'query', 'schema' => [ 'description' => '数据库名称。', 'type' => 'string', 'required' => true, 'example' => 'test', ], ], [ 'name' => 'TaskName', 'in' => 'query', 'schema' => [ 'description' => '任务名称。', 'type' => 'string', 'required' => false, 'example' => 'test', ], ], [ 'name' => 'TaskDesc', 'in' => 'query', 'schema' => [ 'description' => '任务描述。', 'type' => 'string', 'required' => false, 'example' => 'test', ], ], [ 'name' => 'InstanceDbMapping', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => '目标实例数据列表。', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'DbList' => [ 'description' => '目标热点分库。', 'type' => 'string', 'required' => true, 'example' => 'hot_test_****_****', ], 'InstanceName' => [ 'description' => '目标热点库所在的RDS实例名称。', 'type' => 'string', 'required' => false, 'example' => 'rm-bp1t1mk5a5bdj****', ], ], 'required' => false, ], 'required' => true, 'maxItems' => 30, ], ], [ 'name' => 'Mapping', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => '目标数据库数据列表。', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'HotDbName' => [ 'description' => '热点库名称。', 'type' => 'string', 'required' => false, 'example' => 'hot_test_****_****', ], 'ShardTbValue' => [ 'description' => '表级拆分键值。', 'type' => 'string', 'required' => false, 'example' => 'test', ], 'HotTableName' => [ 'description' => '热点分表名称，必须以逻辑表名为前缀。', 'type' => 'string', 'required' => false, 'example' => 'test_table_*****', ], 'ShardDbValue' => [ 'description' => '数据库级拆分键值。', 'type' => 'string', 'required' => false, 'example' => 'test', ], 'TbShardColumn' => [ 'description' => '关联表表拆分键。', 'type' => 'string', 'required' => false, 'example' => 'platform', ], 'DbShardColumn' => [ 'description' => '关联表数据库拆分键。', 'type' => 'string', 'required' => false, 'example' => 'platform', ], 'LogicTable' => [ 'description' => '热点扩容的逻辑表名称。', 'type' => 'string', 'required' => false, 'example' => 'test_table', ], ], 'required' => false, ], 'required' => true, 'maxItems' => 30, ], ], [ 'name' => 'SupperAccountMapping', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => '超级账户数据列表。', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'InstanceName' => [ 'description' => '拥有高权限的RDS实例ID。', 'type' => 'string', 'required' => false, 'example' => 'rm-bp1t1mk5a5bdj****', ], 'SupperAccount' => [ 'description' => 'RDS实例高权限账号的名称。', 'type' => 'string', 'required' => false, 'example' => 'test', ], 'SupperPassword' => [ 'description' => 'RDS实例高权限账号的密码。', 'type' => 'string', 'required' => false, 'example' => '11111111', ], ], 'required' => false, ], 'required' => false, 'maxItems' => 1000, ], ], [ 'name' => 'ExtendedMapping', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => '扩容数据列表。', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'SrcDb' => [ 'description' => '源物理分库名称。', 'type' => 'string', 'required' => false, 'example' => 'test', ], 'SrcInstanceId' => [ 'description' => '源物理分库所在RDS实例ID。', 'type' => 'string', 'required' => false, 'example' => 'rm-bp1t1mk5a5bdj****', ], ], 'required' => false, ], 'required' => true, 'maxItems' => 30, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Success' => [ 'description' => '请求是否成功。', 'type' => 'boolean', 'example' => 'true', ], 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => '0B6B7BDC-575D-4A77-A4F8-24B7EFERV45Y', ], ], ], ], ], 'errorCodes' => [ 500 => [ [ 'errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"0B6B7BDC-575D-4A77-A4F8-24B7EFERV45Y\\"\\n}","errorExample":""},{"type":"xml","example":"\\n true\\n 0B6B7BDC-575D-4A77-A4F8-24B7EFERV45Y\\n","errorExample":""}]', 'title' => '提交热点扩容任务', 'summary' => '调用SubmitHotExpandTask接口提交热点扩容任务。', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'SubmitHotExpandPreCheckTask' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'systemTags' => [ 'operationType' => 'none', 'abilityTreeCode' => '76134', 'abilityTreeNodes' => [ 'FEATUREdrdsR9AYAV', ], ], 'parameters' => [ [ 'name' => 'DrdsInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'DRDS实例ID。', 'type' => 'string', 'required' => true, 'example' => 'drd*********', ], ], [ 'name' => 'DbName', 'in' => 'query', 'schema' => [ 'description' => 'DRDS数据库名称。', 'type' => 'string', 'required' => true, 'example' => 'test', ], ], [ 'name' => 'DbInstType', 'in' => 'query', 'schema' => [ 'description' => '数据库的类型，取值范围如下：'."\n" .'* RDS'."\n" .'* POLARDB', 'type' => 'string', 'required' => true, 'example' => 'RDS', ], ], [ 'name' => 'TableList', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => '表名。', 'type' => 'array', 'items' => [ 'type' => 'string', ], 'required' => false, 'example' => 'test', 'maxItems' => 30, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Msg' => [ 'description' => '提交任务的结果。', 'type' => 'string', 'example' => 'scucess', ], 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => 'FE104D26-AC19-49B5-AC67-947F69*****', ], 'TaskId' => [ 'description' => '任务ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '11111', ], 'Success' => [ 'description' => '请求是否成功。', 'type' => 'boolean', 'example' => 'true', ], ], ], ], ], 'errorCodes' => [ 500 => [ [ 'errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"Msg\\": \\"scucess\\",\\n \\"RequestId\\": \\"FE104D26-AC19-49B5-AC67-947F69*****\\",\\n \\"TaskId\\": 11111,\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"FE104D26-AC19-49B5-AC67-947F69*****\\n97358\\ntrue\\nsuccess","errorExample":""}]', 'title' => '提交热点扩容预检任务', 'summary' => '主要包括无主键表的检查。', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'DescribeSqlFlashbakTask' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'DrdsInstanceId', 'in' => 'query', 'schema' => [ 'description' => '实例ID。', 'type' => 'string', 'required' => true, 'example' => 'drds****c6vxxyzd', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Success' => [ 'description' => '请求是否成功。', 'type' => 'boolean', 'example' => 'true', ], 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => '5D64DE59-44A1-E541-E0CB-B7E5C4305162', ], 'SqlFlashbackTasks' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'SqlFlashbackTask' => [ 'description' => '闪回任务返回对象。', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'TableName' => [ 'description' => '数据所属的表。', 'type' => 'string', 'example' => 'drds_params', ], 'SearchEndTime' => [ 'description' => '搜索的结束时间。', 'type' => 'integer', 'format' => 'int64', 'example' => '1568509597000', ], 'ExpireTime' => [ 'description' => '下载地址过期时间。', 'type' => 'integer', 'format' => 'int64', 'example' => '1569216270000', ], 'DownloadUrl' => [ 'description' => '下载地址。', 'type' => 'string', 'example' => 'http://...', ], 'RecallProgress' => [ 'description' => '逆向召回进度。', 'type' => 'integer', 'format' => 'int32', 'example' => '10', ], 'SqlPk' => [ 'description' => 'SQL设计的主键值。', 'type' => 'string', 'example' => 'id', ], 'InstId' => [ 'description' => '实例ID。', 'type' => 'string', 'example' => 'drdshbga76p6****', ], 'RecallType' => [ 'description' => '回溯类型，取值如下：'."\n" ."\n" .'- **0**：精确查找'."\n" .'- **1**：模糊查找', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'SearchStartTime' => [ 'description' => '搜索的开始时间。', 'type' => 'integer', 'format' => 'int64', 'example' => '1568609597000', ], 'GmtModified' => [ 'description' => '修改时间。', 'type' => 'integer', 'format' => 'int64', 'example' => '1568611469000', ], 'SqlCounter' => [ 'description' => '恢复的数据行数。', 'type' => 'integer', 'format' => 'int64', 'example' => '0', ], 'DbName' => [ 'description' => '闪回任务的数据库名。', 'type' => 'string', 'example' => 'drds_flashback', ], 'RecallRestoreType' => [ 'description' => '恢复类型，取值如下：'."\n" ."\n" .'- **1**：镜像恢复'."\n" .'- **2**：逆向恢复', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'GmtCreate' => [ 'description' => '创建时间。', 'type' => 'integer', 'format' => 'int64', 'example' => '1568611408000', ], 'TraceId' => [ 'description' => 'SQL的trace_id。', 'type' => 'string', 'example' => 'trace', ], 'Id' => [ 'description' => '主键ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '238', ], 'RecallStatus' => [ 'description' => '数据召回任务状态。', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'SqlType' => [ 'description' => 'SQL的类型。', 'type' => 'string', 'example' => 'Insert,Update,Delete', ], ], ], ], ], ], ], ], ], ], 'errorCodes' => [ 500 => [ [ 'errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"5D64DE59-44A1-E541-E0CB-B7E5C4305162\\",\\n \\"SqlFlashbackTasks\\": {\\n \\"SqlFlashbackTask\\": [\\n {\\n \\"TableName\\": \\"drds_params\\",\\n \\"SearchEndTime\\": 1568509597000,\\n \\"ExpireTime\\": 1569216270000,\\n \\"DownloadUrl\\": \\"http://...\\",\\n \\"RecallProgress\\": 10,\\n \\"InstId\\": \\"drdshbga76p6****\\",\\n \\"SqlPk\\": \\"id\\",\\n \\"RecallType\\": 1,\\n \\"GmtModified\\": 1568611469000,\\n \\"SearchStartTime\\": 1568609597000,\\n \\"DbName\\": \\"drds_flashback\\",\\n \\"SqlCounter\\": 0,\\n \\"RecallRestoreType\\": 1,\\n \\"GmtCreate\\": 1568611408000,\\n \\"TraceId\\": \\"trace\\",\\n \\"Id\\": 238,\\n \\"SqlType\\": \\"Insert,Update,Delete\\",\\n \\"RecallStatus\\": 1\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n \\n 1568611469000\\n 1568509597000\\n 1\\n id\\n 1\\n drds_params\\n 1568611408000\\n 1568609597000\\n drdshbga76p6****\\n 1\\n trace\\n Insert,Update,Delete\\n drds_flashback\\n 238\\n 1569216270000\\n 0\\n 10\\n http://...\\n \\n\\n5D64DE59-44A1-E541-E0CB-B7E5C4305162\\ntrue","errorExample":""}]', 'title' => '查看闪回任务的列表', 'summary' => '查看闪回任务的列表。', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'SubmitSqlFlashbackTask' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'systemTags' => [], 'parameters' => [ [ 'name' => 'DrdsInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'DRDS实例ID。', 'type' => 'string', 'required' => true, 'example' => 'drds*********', ], ], [ 'name' => 'DbName', 'in' => 'query', 'schema' => [ 'description' => 'DRDS数据库名称。', 'type' => 'string', 'required' => true, 'example' => 'test', ], ], [ 'name' => 'StartTime', 'in' => 'query', 'schema' => [ 'description' => '执行闪回SQL的开始时间。', 'type' => 'string', 'required' => true, 'example' => '2019-09-10 20:23:23', ], ], [ 'name' => 'EndTime', 'in' => 'query', 'schema' => [ 'description' => '闪回SQL执行的结束时间。', 'type' => 'string', 'required' => true, 'example' => '2019-09-10 23:23:23', ], ], [ 'name' => 'TraceId', 'in' => 'query', 'schema' => [ 'description' => '闪回SQL的Trace ID。', 'type' => 'string', 'required' => false, 'example' => 'ase*****', ], ], [ 'name' => 'TableName', 'in' => 'query', 'schema' => [ 'description' => '执行闪回SQL操作的表名。', 'type' => 'string', 'required' => false, 'example' => 'test', ], ], [ 'name' => 'SqlType', 'in' => 'query', 'schema' => [ 'description' => 'SQL的类型，取值范围为INSERT、UPDATE、DELETE，多种类型间用英文逗号（,）分隔。', 'type' => 'string', 'required' => false, 'example' => 'INSERT,UPDATE', ], ], [ 'name' => 'SqlPk', 'in' => 'query', 'schema' => [ 'description' => '闪回SQL的主键。', 'type' => 'string', 'required' => false, 'example' => '11111', ], ], [ 'name' => 'RecallType', 'in' => 'query', 'schema' => [ 'description' => '精确匹配或者模糊匹配，取值范围如下：'."\n" .'* 0：精确匹配'."\n" .'* 1：模糊匹配', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', ], ], [ 'name' => 'RecallRestoreType', 'in' => 'query', 'schema' => [ 'description' => '恢复类型，取值范围如下：'."\n" .'* 1：镜像恢复'."\n" .'* 0：逆向恢复', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '0', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => 'DSSDF-SEWE-*****', ], 'Success' => [ 'description' => '请求结果。', 'type' => 'boolean', 'example' => 'true', ], 'TaskId' => [ 'description' => '任务ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '1111', ], ], ], ], ], 'errorCodes' => [ 500 => [ [ 'errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"DSSDF-SEWE-*****\\",\\n \\"Success\\": true,\\n \\"TaskId\\": 1111\\n}","errorExample":""},{"type":"xml","example":"\\n\\tDSSDF-SEWE-*****\\n\\tTrue\\n 1111\\n","errorExample":""}]', 'title' => '提交SQL闪回任务', 'summary' => '调用SubmitSqlFlashbackTask接口提交SQL闪回任务。', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'CreateShardTask' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'systemTags' => [ 'operationType' => 'create', 'abilityTreeCode' => '75963', 'abilityTreeNodes' => [ 'FEATUREdrdsD6TUSC', ], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => '地域ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'default' => 'center', ], ], [ 'name' => 'DrdsInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'DRDS实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'drds************', ], ], [ 'name' => 'DbName', 'in' => 'query', 'schema' => [ 'description' => '数据库名称。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'test', ], ], [ 'name' => 'SourceTableName', 'in' => 'query', 'schema' => [ 'description' => '源表表名。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'test_tb1', ], ], [ 'name' => 'TargetTableName', 'in' => 'query', 'schema' => [ 'description' => '目标表表名。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'test_tb2', 'maxLength' => 100, 'minLength' => 1, ], ], [ 'name' => 'TaskType', 'in' => 'query', 'schema' => [ 'description' => '任务类型，取值范围为`SHARD_TO_SINGLE`、`SINGLE_TO_SHARD`、 `SHARD_TO_SHARD`。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'SINGLE_TO_SHARD', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Data' => [ 'description' => '任务创建结果', 'type' => 'boolean', 'example' => 'true', ], 'RequestId' => [ 'description' => '请求id', 'type' => 'string', 'example' => 'F8997D95-94AD-416A-AE70-E24D08******', ], 'Success' => [ 'description' => '请求结果', 'type' => 'boolean', 'example' => 'true', ], ], ], ], ], 'errorCodes' => [ 500 => [ [ 'errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"Data\\": true,\\n \\"RequestId\\": \\"F8997D95-94AD-416A-AE70-E24D08******\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"true\\nF8997D95-94AD-416A-AE70-E24D08******\\ntrue","errorExample":""}]', 'title' => '创建拆分任务', 'summary' => '调用CreateShardTask接口创建拆分任务。', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'DescribeInstanceAccounts' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'DrdsInstanceId', 'in' => 'query', 'schema' => [ 'description' => '实例ID。', 'type' => 'string', 'required' => true, 'example' => 'drds*********', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Success' => [ 'description' => '请求是否成功。', 'type' => 'boolean', 'example' => 'true', ], 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => 'E2E4056D-57EB-4353-8355-2E6284******', ], 'InstanceAccounts' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'InstanceAccount' => [ 'description' => '实例账号列表。', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Host' => [ 'description' => '可以访问数据库的IP地址。**%**表示任何IP地址都能访问。'."\n", 'type' => 'string', 'example' => '%', ], 'Description' => [ 'description' => '账号备注。高级账号默认为**Created by DRDS**，普通账号无任何备注。备注信息可以在账号管理中自定义修改。', 'type' => 'string', 'example' => 'Created by DRDS', ], 'AccountType' => [ 'description' => '账号类型。'."\n" .'- **0**表示高级账号。'."\n" .'- **1**表示普通账号。', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'AccountName' => [ 'description' => '账号名称。', 'type' => 'string', 'example' => 'test_rds3', ], 'DbPrivileges' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'DbPrivilege' => [ 'description' => '数据库权限信息。', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'DbName' => [ 'description' => '数据库名称。', 'type' => 'string', 'example' => 'test_rds3', ], 'Privilege' => [ 'description' => '账号权限。'."\n" .'- **R**：读权限。'."\n" .'- **W**：写权限。'."\n" .'- **DDL**：执行DDL操作的权限。'."\n" .'- **DML**：执行DML操作的权限。', 'type' => 'string', 'example' => 'R', ], ], ], ], ], ], ], ], ], ], ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'ActionUnauthorized', 'errorMessage' => 'The specified action is not available for you', ], ], 404 => [ [ 'errorCode' => 'InvalidDRDSInstanceId.NotFound', 'errorMessage' => 'The DrdsInstanceId provided does not exist in our records.', ], ], 500 => [ [ 'errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', ], ], ], 'staticInfo' => [], 'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"E2E4056D-57EB-4353-8355-2E6284******\\",\\n \\"InstanceAccounts\\": {\\n \\"InstanceAccount\\": [\\n {\\n \\"Host\\": \\"%\\",\\n \\"Description\\": \\"Created by DRDS\\",\\n \\"AccountType\\": 1,\\n \\"AccountName\\": \\"test_rds3\\",\\n \\"DbPrivileges\\": {\\n \\"DbPrivilege\\": [\\n {\\n \\"DbName\\": \\"test_rds3\\",\\n \\"Privilege\\": \\"R\\"\\n }\\n ]\\n }\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n \\n \\n Created by DRDS\\n \\n \\n drds_flashback\\n ROOT\\n \\n \\n %\\n drds_flashback\\n 0\\n \\n \\n \\n 2D77B55F-50C4-4FC5-A89A-7746B7D5781D\\n true\\n","errorExample":""}]', 'title' => '查看实例账号信息', 'summary' => '调用DescribeInstanceAccounts接口查询实例账号信息。', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'DescribeExpandLogicTableInfoList' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'systemTags' => [ 'operationType' => 'get', 'abilityTreeCode' => '76018', 'abilityTreeNodes' => [ 'FEATUREdrdsT4VUG1', ], ], 'parameters' => [ [ 'name' => 'DrdsInstanceId', 'in' => 'query', 'schema' => [ 'description' => '实例ID。', 'type' => 'string', 'required' => true, 'example' => 'drds************', ], ], [ 'name' => 'DbName', 'in' => 'query', 'schema' => [ 'description' => '数据库名称。', 'type' => 'string', 'required' => true, 'example' => 'drds_flashback', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Success' => [ 'description' => '请求是否成功。', 'type' => 'boolean', 'example' => 'true', ], 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => '0B6B7BDC-575D-4A77-A4F8-24B7EF******', ], 'Data' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'data' => [ 'description' => '结果。', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'ShardTbKey' => [ 'description' => '表拆分键。', 'type' => 'string', 'example' => 'address', ], 'TableName' => [ 'description' => '数据表名。', 'type' => 'string', 'example' => 'employee_split2', ], 'ShardDbKey' => [ 'description' => '库拆分键。', 'type' => 'string', 'example' => 'id', ], ], ], ], ], ], ], ], ], ], 'errorCodes' => [ 500 => [ [ 'errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"0B6B7BDC-575D-4A77-A4F8-24B7EF******\\",\\n \\"Data\\": {\\n \\"data\\": [\\n {\\n \\"ShardTbKey\\": \\"address\\",\\n \\"TableName\\": \\"employee_split2\\",\\n \\"ShardDbKey\\": \\"id\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n0B6B7BDC-575D-4A77-A4F8-24B7EF******\\n\\n \\n employee_split2\\n address\\n id\\n \\n\\ntrue\\n","errorExample":""}]', 'title' => '查看逻辑表拆分建', 'summary' => '调用DescribeExpandLogicTableInfoList接口查看拆分键。', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'DescribeTable' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'systemTags' => [ 'operationType' => 'get', 'abilityTreeCode' => '76053', 'abilityTreeNodes' => [ 'FEATUREdrds25BO3L', ], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => '地域ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'default' => 'center', ], ], [ 'name' => 'DrdsInstanceId', 'in' => 'query', 'schema' => [ 'description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'drds*********', ], ], [ 'name' => 'DbName', 'in' => 'query', 'schema' => [ 'description' => '数据库名。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'drds_flashback', ], ], [ 'name' => 'TableName', 'in' => 'query', 'schema' => [ 'description' => '表名。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'employee_split', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Success' => [ 'description' => '当前API是否请求成功。', 'type' => 'boolean', 'example' => 'true', ], 'RequestId' => [ 'description' => '请求唯一ID，如果遇到问题请提供这个请求ID，由工作人员为您排查。', 'type' => 'string', 'example' => 'B5644ABB-559A-4A1C-83F2-9E7209******', ], 'Data' => [ 'description' => '返回数据。', 'type' => 'object', 'properties' => [ 'List' => [ 'description' => '返回数据集合。', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Index' => [ 'description' => '主键。', 'type' => 'string', 'example' => 'PRI', ], 'IsAllowNull' => [ 'description' => '是否允许为空。', 'type' => 'string', 'example' => 'NO', ], 'ColumnName' => [ 'description' => '列名。', 'type' => 'string', 'example' => 'Id', ], 'IsPk' => [ 'description' => '是否为主键。', 'type' => 'string', 'example' => 'YES', ], 'ColumnType' => [ 'description' => '列类型。', 'type' => 'string', 'example' => 'bigint(20)', ], 'Extra' => [ 'description' => 'Extra', 'type' => 'string', 'example' => 'auto_increment', ], ], ], ], ], ], ], ], ], ], 'errorCodes' => [ 500 => [ [ 'errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"B5644ABB-559A-4A1C-83F2-9E7209******\\",\\n \\"Data\\": {\\n \\"List\\": [\\n {\\n \\"Index\\": \\"PRI\\",\\n \\"IsAllowNull\\": \\"NO\\",\\n \\"ColumnName\\": \\"Id\\",\\n \\"IsPk\\": \\"YES\\",\\n \\"ColumnType\\": \\"bigint(20)\\",\\n \\"Extra\\": \\"auto_increment\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"B5644ABB-559A-4A1C-83F2-9E7209******\\n\\n \\n Id\\n bigint(20)\\n auto_increment\\n NO\\n YES\\n PRI\\n \\n\\ntrue","errorExample":""}]', 'title' => '获取 Table 结构信息', 'summary' => '调用DescribeTable接口查询table结构信息。', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'DescribeTableListByType' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'systemTags' => [ 'operationType' => 'get', 'abilityTreeCode' => '76054', 'abilityTreeNodes' => [ 'FEATUREdrdsTIBR6Q', ], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => '地域ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'default' => 'center', ], ], [ 'name' => 'DrdsInstanceId', 'in' => 'query', 'schema' => [ 'description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'drdshbga76p6****', ], ], [ 'name' => 'DbName', 'in' => 'query', 'schema' => [ 'description' => '数据库名称。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'drds_flash****', ], ], [ 'name' => 'Query', 'in' => 'query', 'schema' => [ 'description' => '搜索字段。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'drdshbga76p61861', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => '每页大小。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100', 'minimum' => '1', 'example' => '10', 'default' => '10', ], ], [ 'name' => 'CurrentPage', 'in' => 'query', 'schema' => [ 'description' => '当前页。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'minimum' => '1', 'example' => '1', 'default' => '1', ], ], [ 'name' => 'TableType', 'in' => 'query', 'schema' => [ 'description' => '表类型。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'SINGLE', 'enum' => [ 'SINGLE', 'SHARD', ], ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'PageSize' => [ 'description' => '每页大小。', 'type' => 'integer', 'format' => 'int32', 'example' => '10', ], 'PageNumber' => [ 'description' => '第几页。', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'RequestId' => [ 'description' => '请求唯一ID，如果遇到问题请提供这个请求ID，由工作人员为您排查。', 'type' => 'string', 'example' => 'B360F47B-59E3-4D1C-BA03-6BFB1C993F88', ], 'Total' => [ 'description' => '总数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'Success' => [ 'description' => '请求是否成功。', 'type' => 'boolean', 'example' => 'true', ], 'List' => [ 'description' => '返回集合。', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Property' => [ 'description' => '属性。', 'type' => 'string', 'example' => 'single', ], 'TableName' => [ 'description' => '表名称。', 'type' => 'string', 'example' => 'employee_split', ], ], ], ], ], ], ], ], 'errorCodes' => [ 500 => [ [ 'errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"PageSize\\": 10,\\n \\"PageNumber\\": 1,\\n \\"RequestId\\": \\"B360F47B-59E3-4D1C-BA03-6BFB1C993F88\\",\\n \\"Total\\": 1,\\n \\"Success\\": true,\\n \\"List\\": [\\n {\\n \\"Property\\": \\"single\\",\\n \\"TableName\\": \\"employee_split\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"10\\nB360F47B-59E3-4D1C-BA03-6BFB1C993F88\\n1\\n1\\n\\n employee_split\\n single\\n\\ntrue","errorExample":""}]', 'title' => '根据类型获取表集合', 'summary' => '调用DescribeTableListByType接口根据类型获取表集合。', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'DescribeShardTaskInfo' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'systemTags' => [ 'operationType' => 'get', 'abilityTreeCode' => '76048', 'abilityTreeNodes' => [ 'FEATUREdrdsD6TUSC', ], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => '地域ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'default' => 'center', ], ], [ 'name' => 'DrdsInstanceId', 'in' => 'query', 'schema' => [ 'description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'drds*********', ], ], [ 'name' => 'DbName', 'in' => 'query', 'schema' => [ 'description' => '数据库名。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'jjjjjj_ppppp', ], ], [ 'name' => 'SourceTableName', 'in' => 'query', 'schema' => [ 'description' => '源表名称。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'a1', ], ], [ 'name' => 'TargetTableName', 'in' => 'query', 'schema' => [ 'description' => '目标表名称。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'a2', 'maxLength' => 100, 'minLength' => 1, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Success' => [ 'description' => '请求是否成功。'."\n", 'type' => 'boolean', 'example' => 'true', ], 'RequestId' => [ 'description' => '请求唯一ID，如果遇到问题请提供这个请求ID，由工作人员为您排查。', 'type' => 'string', 'example' => '5D64DE5944A1E541E0CB908A', ], 'Data' => [ 'description' => '返回数据。', 'type' => 'object', 'properties' => [ 'Status' => [ 'description' => '状态。', 'type' => 'string', 'example' => '增量追平', ], 'Stage' => [ 'description' => '当前阶段。', 'type' => 'string', 'example' => '2', ], 'Progress' => [ 'description' => '进度。', 'type' => 'string', 'example' => '70', ], 'Expired' => [ 'description' => '过期时间。', 'type' => 'string', 'example' => '0', ], 'TargetTableName' => [ 'description' => '目标表名。', 'type' => 'string', 'example' => 'a2', ], 'SourceTableName' => [ 'description' => '源表名。', 'type' => 'string', 'example' => 'a1', ], 'Full' => [ 'description' => '全量迁移。', 'type' => 'object', 'properties' => [ 'StartTime' => [ 'description' => '开始时间。', 'type' => 'string', 'example' => '2019-09-16 15:11:53', ], 'Progress' => [ 'description' => '当前进度。', 'type' => 'integer', 'format' => 'int32', 'example' => '100', ], 'Tps' => [ 'description' => '数据库每秒处理的事务数。', 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], 'Total' => [ 'description' => '任务数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '2', ], 'Expired' => [ 'description' => '任务过期时间。', 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], ], ], 'FullCheck' => [ 'description' => '全量检查。', 'type' => 'object', 'properties' => [ 'StartTime' => [ 'description' => '开始时间。', 'type' => 'string', 'example' => '2019-09-16 15:12:53', ], 'Progress' => [ 'description' => '当前进度。', 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], 'Tps' => [ 'description' => '数据库每秒处理的事务数。', 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], 'Total' => [ 'description' => '任务总数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], 'Expired' => [ 'description' => '过期时间。', 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], ], ], 'FullRevise' => [ 'description' => '全量订正。', 'type' => 'object', 'properties' => [ 'StartTime' => [ 'description' => '开始时间。', 'type' => 'string', 'example' => '2019-09-16 15:12:53', ], 'Progress' => [ 'description' => '当前进度。', 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], 'Tps' => [ 'description' => '数据库每秒处理的事务数。', 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], 'Total' => [ 'description' => '任务数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], 'Expired' => [ 'description' => '过期时间。', 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], ], ], 'Review' => [ 'description' => '检查。', 'type' => 'object', 'properties' => [ 'StartTime' => [ 'description' => '开始时间。', 'type' => 'string', 'example' => '2019-09-16 15:12:53', ], 'Progress' => [ 'description' => '进度。', 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], 'Tps' => [ 'description' => '数据库每秒处理的事务数。', 'type' => 'integer', 'format' => 'int32', 'example' => '10', ], 'Total' => [ 'description' => '任务数。', 'type' => 'integer', 'format' => 'int32', 'example' => '5', ], 'Expired' => [ 'description' => '过期。', 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], ], ], 'Increment' => [ 'description' => '增量。', 'type' => 'object', 'properties' => [ 'Delay' => [ 'description' => '延迟。', 'type' => 'integer', 'format' => 'int32', 'example' => '1568617906', ], 'StartTime' => [ 'description' => '开始时间。', 'type' => 'string', 'example' => '2019-09-16 15:12:53', ], 'Tps' => [ 'description' => '数据库每秒处理的事务数。', 'type' => 'integer', 'format' => 'int32', 'example' => '10', ], ], ], ], ], ], ], ], ], 'errorCodes' => [ 500 => [ [ 'errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"5D64DE5944A1E541E0CB908A\\",\\n \\"Data\\": {\\n \\"Status\\": \\"增量追平\\",\\n \\"Stage\\": \\"2\\",\\n \\"Progress\\": \\"70\\",\\n \\"Expired\\": \\"0\\",\\n \\"TargetTableName\\": \\"a2\\",\\n \\"SourceTableName\\": \\"a1\\",\\n \\"Full\\": {\\n \\"StartTime\\": \\"2019-09-16 15:11:53\\",\\n \\"Progress\\": 100,\\n \\"Tps\\": 0,\\n \\"Total\\": 2,\\n \\"Expired\\": 0\\n },\\n \\"FullCheck\\": {\\n \\"StartTime\\": \\"2019-09-16 15:12:53\\",\\n \\"Progress\\": 0,\\n \\"Tps\\": 0,\\n \\"Total\\": 0,\\n \\"Expired\\": 0\\n },\\n \\"FullRevise\\": {\\n \\"StartTime\\": \\"2019-09-16 15:12:53\\",\\n \\"Progress\\": 0,\\n \\"Tps\\": 0,\\n \\"Total\\": 0,\\n \\"Expired\\": 0\\n },\\n \\"Review\\": {\\n \\"StartTime\\": \\"2019-09-16 15:12:53\\",\\n \\"Progress\\": 0,\\n \\"Tps\\": 10,\\n \\"Total\\": 5,\\n \\"Expired\\": 0\\n },\\n \\"Increment\\": {\\n \\"Delay\\": 1568617906,\\n \\"StartTime\\": \\"2019-09-16 15:12:53\\",\\n \\"Tps\\": 10\\n }\\n }\\n}","errorExample":""},{"type":"xml","example":"5D64DE5944A1E541E0CB908A\\n\\n 增量追平\\n a1\\n 70\\n 2\\n 0\\n a2\\n \\n 100\\n 0\\n 2\\n 2019-09-16 15:11:53\\n 0\\n \\n \\n 0\\n 0\\n 0\\n 2019-09-16 15:12:53\\n 0\\n \\n \\n 0\\n 0\\n 0\\n 2019-09-16 15:12:53\\n 0\\n \\n \\n 0\\n 10\\n 5\\n 2019-09-16 15:12:53\\n 0\\n \\n \\n 10\\n 2019-09-16 15:12:53\\n 1568617906\\n \\n\\ntrue","errorExample":""}]', 'title' => '拆分变更工具详情', 'summary' => '调用DescribeShardTaskInfo查询拆分变更工具详情。', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'ValidateShardTask' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'systemTags' => [ 'operationType' => 'none', 'abilityTreeCode' => '76153', 'abilityTreeNodes' => [ 'FEATUREdrdsTIBR6Q', ], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => '地域ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'default' => 'center', ], ], [ 'name' => 'DrdsInstanceId', 'in' => 'query', 'schema' => [ 'description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'drds23ds****', ], ], [ 'name' => 'DbName', 'in' => 'query', 'schema' => [ 'description' => '数据库名称。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'test', ], ], [ 'name' => 'SourceTableName', 'in' => 'query', 'schema' => [ 'description' => '源表名称。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'buyer', ], ], [ 'name' => 'TargetTableName', 'in' => 'query', 'schema' => [ 'description' => '目标表名称。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'buyer_new', 'maxLength' => 100, 'minLength' => 1, ], ], [ 'name' => 'TaskType', 'in' => 'query', 'schema' => [ 'description' => '任务类型。 取值：'."\n" .'* **SINGLE\\_TO\\_SHARD**：单表转分表'."\n" .'* **SHARD\\_TO\\_SINGLE**： 分表转单表'."\n" .'* **SHARD\\_TO\\_SHARD**：分表转分表', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'SINGLE_TO_SHARD', 'minLength' => 1, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Success' => [ 'description' => '请求是否成功。', 'type' => 'boolean', 'example' => 'true', ], 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => '0B6B7BDC-575D-4A77-A4F8-24B7EFAS45FG', ], 'List' => [ 'description' => '检查结果列表。', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Result' => [ 'description' => '检查结果。取值：'."\n" .'* **0**：检查通过'."\n" .'* **1**：检查不通过', 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], 'Item' => [ 'description' => '检查项。', 'type' => 'string', 'example' => 'same_schema', ], ], ], ], ], ], ], ], 'errorCodes' => [ 500 => [ [ 'errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"0B6B7BDC-575D-4A77-A4F8-24B7EFAS45FG\\",\\n \\"List\\": [\\n {\\n \\"Result\\": 0,\\n \\"Item\\": \\"same_schema\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"0B6B7BDC-575D-4A77-A4F8-24B7EFAS45FG\\n\\n same_schema\\n 0\\n\\ntrue","errorExample":""}]', 'title' => '校验拆分变更任务是否合法', 'summary' => '调用ValidateShardTask接口校验拆分变更任务是否合法。', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'SetupBroadcastTables' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'systemTags' => [ 'operationType' => 'update', 'abilityTreeCode' => '76118', 'abilityTreeNodes' => [ 'FEATUREdrds6IJXJ3', ], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => '实例所在地域ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'default' => 'center', ], ], [ 'name' => 'DrdsInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'DRDS实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'drds************', ], ], [ 'name' => 'DbName', 'in' => 'query', 'schema' => [ 'description' => 'DRDS数据库名称。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'test', ], ], [ 'name' => 'Active', 'in' => 'query', 'schema' => [ 'description' => '激活广播表开关。', 'type' => 'boolean', 'required' => true, 'docRequired' => true, 'example' => 'true', ], ], [ 'name' => 'TableName', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => 'DRDS表格名称。', 'type' => 'array', 'items' => [ 'type' => 'string', ], 'required' => true, 'example' => 'test', 'maxItems' => 20, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Data' => [ 'description' => '广播表设置是否成功。', 'type' => 'boolean', 'example' => 'true', ], 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => 'A3140FC7-B78B-4D8E-B0C8-926D28******', ], 'Success' => [ 'description' => '当前API是否请求成功。', 'type' => 'boolean', 'example' => 'true', ], ], ], ], ], 'errorCodes' => [ 500 => [ [ 'errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"Data\\": true,\\n \\"RequestId\\": \\"A3140FC7-B78B-4D8E-B0C8-926D28******\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"A3140FC7-B78B-4D8E-B0C8-926D28******\\ntrue\\ntrue","errorExample":""}]', 'title' => '设置广播表', 'summary' => '调用SetupBroadcastTables接口设置广播表。', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'DescribeBroadcastTables' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'systemTags' => [ 'operationType' => 'get', 'abilityTreeCode' => '75974', 'abilityTreeNodes' => [ 'FEATUREdrdsTIBR6Q', ], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => '地域ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'default' => 'center', ], ], [ 'name' => 'DrdsInstanceId', 'in' => 'query', 'schema' => [ 'description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'drds************', ], ], [ 'name' => 'DbName', 'in' => 'query', 'schema' => [ 'description' => '数据库名称。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'test_db', ], ], [ 'name' => 'Query', 'in' => 'query', 'schema' => [ 'description' => '查询内容。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'tb1', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => '每页大小。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100', 'minimum' => '1', 'example' => '10', 'default' => '10', ], ], [ 'name' => 'CurrentPage', 'in' => 'query', 'schema' => [ 'description' => '当前页数。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'minimum' => '1', 'example' => '1', 'default' => '1', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => '86E420ED-43F2-4788-A58C-921849******', ], 'Success' => [ 'description' => '请求结果。', 'type' => 'boolean', 'example' => 'true', ], 'IsShard' => [ 'description' => '是否拆分。', 'type' => 'boolean', 'example' => 'true', ], 'PageNumber' => [ 'description' => '分页当前页数。', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'PageSize' => [ 'description' => '每页大小。', 'type' => 'integer', 'format' => 'int32', 'example' => '40', ], 'Total' => [ 'description' => '总条数。', 'type' => 'integer', 'format' => 'int32', 'example' => '2', ], 'List' => [ 'description' => '广播表列表。', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Status' => [ 'description' => '广播表激活状态，取值范围如下：'."\n" .'* **1**：激活'."\n" .'* **2**：激活中'."\n" .'* **3**：激活异常', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'IsShard' => [ 'description' => '是否拆分表。', 'type' => 'boolean', 'example' => 'false', ], 'Broadcast' => [ 'description' => '是否是广播表。', 'type' => 'boolean', 'example' => 'true', ], 'Table' => [ 'description' => '表名称。', 'type' => 'string', 'example' => 'nation', ], 'DbInstType' => [ 'description' => '数据库存储类型，取值范围如下：'."\n" .'* **0**：RDS'."\n" .'* **4**：PolarDB', 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], 'BroadcastType' => [ 'description' => '广播表类型，取值：'."\n" .'* **1**：多写模式'."\n" .'* **2**：同步模式', 'type' => 'string', 'example' => '1', ], ], ], ], ], ], ], ], 'errorCodes' => [ 500 => [ [ 'errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"86E420ED-43F2-4788-A58C-921849******\\",\\n \\"Success\\": true,\\n \\"IsShard\\": true,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 40,\\n \\"Total\\": 2,\\n \\"List\\": [\\n {\\n \\"Status\\": 1,\\n \\"IsShard\\": false,\\n \\"Broadcast\\": true,\\n \\"Table\\": \\"nation\\",\\n \\"DbInstType\\": 0,\\n \\"BroadcastType\\": \\"1\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n true\\n 86E420ED-43F2-4788-A58C-921849******\\n 40\\n 1\\n 2\\n \\n 1\\n 0\\n false\\n nation\\n true\\n 1\\n \\n true\\n","errorExample":""}]', 'title' => '查询广播表', 'summary' => '调用DescribeBroadcastTables接口查询广播表。', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'SwitchGlobalBroadcastType' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'systemTags' => [ 'operationType' => 'none', 'abilityTreeCode' => '76146', 'abilityTreeNodes' => [ 'FEATUREdrds25BO3L', ], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => '地域ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'default' => 'center', ], ], [ 'name' => 'DrdsInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'DRDS实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'drds********', ], ], [ 'name' => 'DbName', 'in' => 'query', 'schema' => [ 'description' => 'DRDS数据库名称。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'test', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Data' => [ 'description' => '广播表从多写切换成异步链路模式是否成功。', 'type' => 'boolean', 'example' => 'true', ], 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => 'DSSDF-SEWE-*****', ], 'Success' => [ 'description' => '请求是否成功。', 'type' => 'boolean', 'example' => 'true', ], ], ], ], ], 'errorCodes' => [ 500 => [ [ 'errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"Data\\": true,\\n \\"RequestId\\": \\"DSSDF-SEWE-*****\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"DSSDF-SEWE-*****\\ntrue\\ntrue","errorExample":""}]', 'title' => '将广播表从多写切换成异步链路模式', 'summary' => '调用SwitchGlobalBroadcastType接口将广播表从多写切换成异步链路模式。', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'SetupTable' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'systemTags' => [ 'operationType' => 'update', 'abilityTreeCode' => '76121', 'abilityTreeNodes' => [ 'FEATUREdrdsTIBR6Q', ], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => '地域ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'default' => 'center', ], ], [ 'name' => 'DrdsInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'DRDS实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'drds************', ], ], [ 'name' => 'DbName', 'in' => 'query', 'schema' => [ 'description' => '表所在的数据库名称。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'test', ], ], [ 'name' => 'AllowFullTableScan', 'in' => 'query', 'schema' => [ 'description' => '是否允许全表扫描。', 'type' => 'boolean', 'required' => true, 'docRequired' => true, 'example' => 'true', ], ], [ 'name' => 'TableName', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => '关联的表名。', 'type' => 'array', 'items' => [ 'type' => 'string', ], 'required' => true, 'example' => 'test', 'maxItems' => 20, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Data' => [ 'description' => '全表扫描是否使用。', 'type' => 'boolean', 'example' => 'true', ], 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => 'A3140FC7-B78B-4D8E-B0C8-926D28******', ], 'Success' => [ 'description' => '请求结果。', 'type' => 'boolean', 'example' => 'true', ], ], ], ], ], 'errorCodes' => [ 500 => [ [ 'errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"Data\\": true,\\n \\"RequestId\\": \\"A3140FC7-B78B-4D8E-B0C8-926D28******\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"A3140FC7-B78B-4D8E-B0C8-926D28******\\ntrue\\ntrue","errorExample":""}]', 'title' => '使用全表扫描', 'summary' => '调用SetupTable接口使用全表扫描。', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'DescribeTables' => [ 'summary' => '调用DescribeTables接口获取表信息列表。', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'DrdsInstanceId', 'in' => 'query', 'schema' => [ 'description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'drds************', ], ], [ 'name' => 'DbName', 'in' => 'query', 'schema' => [ 'description' => '数据库名称。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'test', ], ], [ 'name' => 'Query', 'in' => 'query', 'schema' => [ 'description' => '查询条件，取值为目标实例ID。', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'drds************', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => '每页大小。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100', 'minimum' => '1', 'example' => '10', 'default' => '10', ], ], [ 'name' => 'CurrentPage', 'in' => 'query', 'schema' => [ 'description' => '当前页数。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'minimum' => '1', 'example' => '1', 'default' => '1', ], ], [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => '地域ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'PageSize' => [ 'description' => '每页大小。', 'type' => 'integer', 'format' => 'int32', 'example' => '10', ], 'PageNumber' => [ 'description' => '页数。', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => '83AC3D7E-461C-4D87-8ACD-6CC295******', ], 'Total' => [ 'description' => '总数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'Success' => [ 'description' => '请求是否成功。', 'type' => 'boolean', 'example' => 'true', ], 'List' => [ 'description' => '返回的表信息列表。', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Status' => [ 'description' => '拆分任务状态，取值范围如下：'."\n" ."\n" .'- 0：正常、无任务；'."\n" .'- 1：变更中、有拆分任务。', 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], 'IsLocked' => [ 'description' => '是否锁定。', 'type' => 'boolean', 'example' => 'false', ], 'ShardKey' => [ 'description' => '拆分键。', 'type' => 'string', 'example' => 'null', ], 'IsShard' => [ 'description' => '是否拆分。', 'type' => 'boolean', 'example' => 'false', ], 'Broadcast' => [ 'description' => '是否为广播表。', 'type' => 'boolean', 'example' => 'false', ], 'AllowFullTableScan' => [ 'description' => '是否允许全表扫描。', 'type' => 'boolean', 'example' => 'false', ], 'Table' => [ 'description' => '表名称。', 'type' => 'string', 'example' => 'test', ], 'DbInstType' => [ 'description' => '实例类型，取值范围如下：'."\n" ."\n" .'- 0：独享型；'."\n" .'- 1：共享型。', 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], ], ], ], ], ], ], ], 'errorCodes' => [ 500 => [ [ 'errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"PageSize\\": 10,\\n \\"PageNumber\\": 1,\\n \\"RequestId\\": \\"83AC3D7E-461C-4D87-8ACD-6CC295******\\",\\n \\"Total\\": 1,\\n \\"Success\\": true,\\n \\"List\\": [\\n {\\n \\"Status\\": 0,\\n \\"IsLocked\\": false,\\n \\"ShardKey\\": \\"null\\",\\n \\"IsShard\\": false,\\n \\"Broadcast\\": false,\\n \\"AllowFullTableScan\\": false,\\n \\"Table\\": \\"test\\",\\n \\"DbInstType\\": 0\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n 10\\n 1\\n 83AC3D7E-461C-4D87-8ACD-6CC295******\\n 1\\n true\\n \\n 0\\n false\\n null\\n false\\n false\\n false\\n test\\n 0\\n \\n","errorExample":""}]', 'title' => '获取表信息列表', ], 'SetupDrdsParams' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'systemTags' => [ 'operationType' => 'update', 'abilityTreeCode' => '76119', 'abilityTreeNodes' => [ 'FEATUREdrds25BO3L', ], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => '地域ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'default' => 'center', ], ], [ 'name' => 'DrdsInstanceId', 'in' => 'query', 'schema' => [ 'description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'drdsjiii1b49****', ], ], [ 'name' => 'ParamLevel', 'in' => 'query', 'schema' => [ 'description' => '参数设置的级别。取值范围如下：'."\n" ."\n" .'- **NSTANCE**：实例级'."\n" .'- **DB**：数据库级', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'DB', ], ], [ 'name' => 'Data', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => '参数列表。', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'DbName' => [ 'description' => '参数对应的数据库名称。', 'type' => 'string', 'required' => false, 'example' => 'test_db', ], 'ParamType' => [ 'description' => '参数类型，取值范围如下：'."\n" ."\n" .'- **ATOM**：三层数据源中的配置项；'."\n" .'- **CONFIG**：Server Config中的配置项；'."\n" .'- **DIAMOND**：Diamond中的配置项。'."\n", 'type' => 'string', 'required' => false, 'example' => 'ATOM', ], 'ParamValue' => [ 'description' => '参数值。', 'type' => 'string', 'required' => false, 'example' => 'true', ], 'ParamVariableName' => [ 'description' => '参数名称。', 'type' => 'string', 'required' => false, 'example' => 'FORBID_EXECUTE_DML_ALL', ], 'ParamRanges' => [ 'description' => '参数取值范围。', 'type' => 'string', 'required' => false, 'example' => '[true|false]', ], ], 'required' => false, ], 'required' => true, 'maxItems' => 20, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Data' => [ 'description' => '返回结果。', 'type' => 'boolean', 'example' => 'true', ], 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => '9B2F3840-5C98-475C-B269-2D5C3A31797C', ], 'Success' => [ 'description' => '请求是否成功。', 'type' => 'boolean', 'example' => 'true', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => '%s', 'errorMessage' => '%s', ], ], 500 => [ [ 'errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"Data\\": true,\\n \\"RequestId\\": \\"9B2F3840-5C98-475C-B269-2D5C3A31797C\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n true\\n 9B2F3840-5C98-475C-B269-2D5C3A31797C\\n true\\n","errorExample":""}]', 'title' => '配置实例的参数', 'summary' => '调用SetupDrdsParams接口配置实例的参数。', ], 'ListTagResources' => [ 'summary' => '调用ListTagResources查询资源标签。', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREdrdsD0NTUP', ], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => '地域ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', ], ], [ 'name' => 'ResourceType', 'in' => 'query', 'schema' => [ 'description' => '资源类型，取值固定为INSTANCE。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'INSTANCE', 'enum' => [ 'INSTANCE', ], ], ], [ 'name' => 'NextToken', 'in' => 'query', 'schema' => [ 'description' => '分页token。', 'type' => 'string', 'required' => false, 'example' => '6ab4640a-479b-41d0-ad3c-c6e888bc3d8f', ], ], [ 'name' => 'Tag', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => '标签列表。', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Key' => [ 'description' => '标签的键。', 'type' => 'string', 'required' => false, 'example' => 'color', ], 'Value' => [ 'description' => '标签的值。', 'type' => 'string', 'required' => false, 'example' => 'red', ], ], 'required' => false, ], 'required' => false, 'maxItems' => 21, ], ], [ 'name' => 'ResourceId', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => '资源列表。', 'type' => 'array', 'items' => [ 'description' => '资源ID。', 'type' => 'string', 'required' => false, 'example' => 'dm-hbgau1zp****', ], 'required' => false, 'maxItems' => 51, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'NextToken' => [ 'description' => '分页token。', 'type' => 'string', 'example' => '6ab4640a-479b-41d0-ad3c-c6e888bc3d8f', ], 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => '58CE1CB0-F0F4-4BA3-B876-135DC47DF52F', ], 'Success' => [ 'description' => '请求是否成功。', 'type' => 'boolean', 'example' => 'true', ], 'TagResources' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'TagResource' => [ 'description' => '标签资源列表。', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'ResourceType' => [ 'description' => '资源类型，取值固定为INSTANCE。', 'type' => 'string', 'example' => 'INSTANCE', ], 'TagValue' => [ 'description' => '标签的值。', 'type' => 'string', 'example' => '1', ], 'ResourceId' => [ 'description' => '资源ID。', 'type' => 'string', 'example' => 'drdshzsd11****', ], 'TagKey' => [ 'description' => '标签的键。', 'type' => 'string', 'example' => 'test', ], ], ], ], ], ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'InvalidParameter.tagKey', 'errorMessage' => 'Check the parameter tagKey %s', ], [ 'errorCode' => 'InvalidParameter.tagValue', 'errorMessage' => 'Check the parameter tagValue %s', ], [ 'errorCode' => 'InvalidParameter.tags.exceed', 'errorMessage' => 'Tags num exceed 10', ], [ 'errorCode' => 'InvalidParameter.instanceId.and.tags', 'errorMessage' => 'you must have one of Tags and InstanceId', ], [ 'errorCode' => 'InvalidParameter.tags.json.error', 'errorMessage' => 'The parameter tags is not a JsonArray', ], [ 'errorCode' => 'TagService.%s', 'errorMessage' => 'TagService return errorMsg: %s', ], [ 'errorCode' => 'TagApi.InvalidParameter.resourceId.exceed', 'errorMessage' => 'ResourceId num exceed 50', ], [ 'errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"NextToken\\": \\"6ab4640a-479b-41d0-ad3c-c6e888bc3d8f\\",\\n \\"RequestId\\": \\"58CE1CB0-F0F4-4BA3-B876-135DC47DF52F\\",\\n \\"Success\\": true,\\n \\"TagResources\\": {\\n \\"TagResource\\": [\\n {\\n \\"ResourceType\\": \\"INSTANCE\\",\\n \\"TagValue\\": \\"1\\",\\n \\"ResourceId\\": \\"drdshzsd11****\\",\\n \\"TagKey\\": \\"test\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 6ab4640a-479b-41d0-ad3c-c6e888bc3d8f\\n 58CE1CB0-F0F4-4BA3-B876-135DC47DF52F\\n true\\n \\n INSTANCE\\n 1\\n drdshzsd11****\\n test\\n \\n","errorExample":""}]', 'title' => '查询资源绑定的标签列表', ], 'TagResources' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'systemTags' => [ 'operationType' => 'none', 'abilityTreeCode' => '76147', 'abilityTreeNodes' => [ 'FEATUREdrds25BO3L', ], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => '地域ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', ], ], [ 'name' => 'ResourceType', 'in' => 'query', 'schema' => [ 'description' => '资源类型，取值固定为INSTANCE。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'INSTANCE', 'enum' => [ 'INSTANCE', ], ], ], [ 'name' => 'Tag', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => '标签列表。', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Key' => [ 'description' => '标签的键。', 'type' => 'string', 'required' => false, 'example' => 'color', ], 'Value' => [ 'description' => '标签的值。', 'type' => 'string', 'required' => false, 'example' => 'red', ], ], 'required' => false, ], 'required' => true, 'maxItems' => 21, ], ], [ 'name' => 'ResourceId', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => '资源列表。', 'type' => 'array', 'items' => [ 'description' => '资源ID。', 'type' => 'string', 'required' => false, 'example' => 'dm-hbgau1zp****', ], 'required' => true, 'maxItems' => 51, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Success' => [ 'description' => '请求是否成功。', 'type' => 'boolean', 'example' => 'true', ], 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => 'FE5D94E3-3C93-3594-95D9-AAED2A980915', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'InvalidParameter.tagKey', 'errorMessage' => 'Check the parameter tagKey %s', ], [ 'errorCode' => 'InvalidParameter.tagValue', 'errorMessage' => 'Check the parameter tagValue %s', ], [ 'errorCode' => 'InvalidParameter.tags.exceed', 'errorMessage' => 'Tags num exceed 10', ], [ 'errorCode' => 'InvalidParameter.tags.notFound', 'errorMessage' => 'Tags connot be empty', ], [ 'errorCode' => 'TagService.%s', 'errorMessage' => 'TagService return errorMsg: %s', ], [ 'errorCode' => 'TagApi.InvalidParameter.resourceId.exceed', 'errorMessage' => 'ResourceId num exceed 50', ], ], 500 => [ [ 'errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"FE5D94E3-3C93-3594-95D9-AAED2A980915\\"\\n}","errorExample":""},{"type":"xml","example":"\\n true\\n FE5D94E3-3C93-3594-95D9-AAED2A980915\\n","errorExample":""}]', 'title' => '为资源打标签', 'summary' => '调用TagResources接口为资源打标签。', ], 'UntagResources' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'systemTags' => [ 'operationType' => 'delete', 'abilityTreeCode' => '76148', 'abilityTreeNodes' => [ 'FEATUREdrds25BO3L', ], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => '地域ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', ], ], [ 'name' => 'ResourceType', 'in' => 'query', 'schema' => [ 'description' => '资源类型，取值固定为INSTANCE。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'INSTANCE', 'enum' => [ 'INSTANCE', ], ], ], [ 'name' => 'All', 'in' => 'query', 'schema' => [ 'description' => '是否删除资源的所有标签。', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'default' => 'false', ], ], [ 'name' => 'ResourceId', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => '资源ID。', 'type' => 'array', 'items' => [ 'type' => 'string', ], 'required' => true, 'example' => 'drds********', 'maxItems' => 51, ], ], [ 'name' => 'TagKey', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => '标签的键。'."\n" .'> N表示传入第几个标签的键。例如：* Tag.1.Key表示传入第一个标签的键。* Tag.2.Key表示传入第二个标签的键。', 'type' => 'array', 'items' => [ 'type' => 'string', ], 'required' => false, 'example' => 'color', 'maxItems' => 21, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Success' => [ 'description' => '请求结果。', 'type' => 'boolean', 'example' => 'true', ], 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => 'DSSDF-SEWE-*****', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'InvalidParameter.tagKey', 'errorMessage' => 'Check the parameter tagKey %s', ], [ 'errorCode' => 'InvalidParameter.tagValue', 'errorMessage' => 'Check the parameter tagValue %s', ], [ 'errorCode' => 'InvalidParameter.tags.exceed', 'errorMessage' => 'Tags num exceed 10', ], [ 'errorCode' => 'InvalidParameter.tags.notFound', 'errorMessage' => 'Tags connot be empty', ], [ 'errorCode' => 'InvalidParameter.tags.json.error', 'errorMessage' => 'Thr parameter tags is not a JsonArray', ], [ 'errorCode' => 'TagService.%s', 'errorMessage' => 'TagService return errorMsg: %s', ], [ 'errorCode' => 'TagApi.InvalidParameter.resourceId.exceed', 'errorMessage' => 'ResourceId num exceed 50', ], ], 500 => [ [ 'errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"DSSDF-SEWE-*****\\"\\n}","errorExample":""},{"type":"xml","example":"DSSDF-SEWE-*****\\ntrue","errorExample":""}]', 'title' => '取消资源的标签', 'summary' => '调用UntagResources接口取消资源的标签。', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'DescribeDrdsInstanceVersion' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'DrdsInstanceId', 'in' => 'query', 'schema' => [ 'description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'drdshbga1138****', ], ], [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => '地域ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Success' => [ 'description' => '请求是否成功。', 'type' => 'boolean', 'example' => 'true', ], 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => '2F7F8080-9132-4279-85D0-B7E5C4305162', ], 'Data' => [ 'description' => '实例版本详情。', 'type' => 'object', 'properties' => [ 'NewestVersion' => [ 'description' => '最新实例版本。', 'type' => 'string', 'example' => '5.4.12-16315258', ], 'InstanceVersion' => [ 'description' => '当前实例版本。', 'type' => 'string', 'example' => '5.3.12-15682777', ], ], ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'ActionUnauthorized', 'errorMessage' => 'The specified action is not available for you', ], ], 404 => [ [ 'errorCode' => 'InvalidDRDSInstanceId.NotFound', 'errorMessage' => 'The DrdsInstanceId provided does not exist in our records.', ], ], 500 => [ [ 'errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"2F7F8080-9132-4279-85D0-B7E5C4305162\\",\\n \\"Data\\": {\\n \\"NewestVersion\\": \\"5.4.12-16315258\\",\\n \\"InstanceVersion\\": \\"5.3.12-15682777\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n true\\n 2F7F8080-9132-4279-85D0-B7E5C4305162\\n \\n 5.4.12-16315258\\n 5.3.12-15682777\\n \\n","errorExample":""}]', 'title' => '查看实例版本', 'summary' => '查询 DRDS 实例版本。', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'DescribeDrdsInstanceLevelTasks' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'DrdsInstanceId', 'in' => 'query', 'schema' => [ 'description' => '实例ID。', 'type' => 'string', 'required' => true, 'example' => 'drdssen12****', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Success' => [ 'description' => '请求是否成功。', 'type' => 'boolean', 'example' => 'true', ], 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => '2F7F8080-9132-4279-85D0-B7E5C4305162', ], 'Tasks' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'Task' => [ 'description' => '未完成任务列表。', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'TaskType' => [ 'description' => '任务类型。', 'type' => 'integer', 'format' => 'int32', 'example' => '11', ], 'TaskPhase' => [ 'description' => '任务阶段。', 'type' => 'string', 'example' => '1', ], 'Progress' => [ 'description' => '任务进度，取值0-100。', 'type' => 'integer', 'format' => 'int32', 'example' => '99', ], 'AllowCancel' => [ 'description' => '是否允许取消。', 'type' => 'boolean', 'example' => 'false', ], 'TaskStatus' => [ 'description' => '任务状态，正在执行0，成功1，失败2，取消3。', 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], 'ShowProgress' => [ 'description' => '是否显示进度。', 'type' => 'boolean', 'example' => 'true', ], 'TaskName' => [ 'description' => '任务名称。', 'type' => 'string', 'example' => 'upgrade_instance', ], 'ProgressDescription' => [ 'description' => '进度描述。', 'type' => 'string', 'example' => '正在执行', ], 'GmtCreate' => [ 'description' => '任务创建时间戳。', 'type' => 'integer', 'format' => 'int64', 'example' => '1568705520000', ], 'TargetId' => [ 'description' => '任务ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '12312', ], 'ErrMsg' => [ 'description' => '任务错误信息。', 'type' => 'string', 'example' => '实例状态异常', ], ], ], ], ], ], ], ], ], ], 'errorCodes' => [ 500 => [ [ 'errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"2F7F8080-9132-4279-85D0-B7E5C4305162\\",\\n \\"Tasks\\": {\\n \\"Task\\": [\\n {\\n \\"TaskType\\": 11,\\n \\"TaskPhase\\": \\"1\\",\\n \\"Progress\\": 99,\\n \\"AllowCancel\\": false,\\n \\"TaskStatus\\": 0,\\n \\"ShowProgress\\": true,\\n \\"TaskName\\": \\"upgrade_instance\\",\\n \\"ProgressDescription\\": \\"正在执行\\",\\n \\"GmtCreate\\": 1568705520000,\\n \\"TargetId\\": 12312,\\n \\"ErrMsg\\": \\"实例状态异常\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n true\\n 2F7F8080-9132-4279-85D0-B7E5C4305162\\n \\n 11\\n 1\\n 99\\n false\\n 0\\n true\\n upgrade_instance\\n 正在执行\\n 1568705520000\\n 12312\\n 实例状态异常\\n \\n","errorExample":""}]', 'title' => '查询 DRDS 实例级未完成任务', 'summary' => '调用DescribeDrdsInstanceLevelTasks接口查询实例中未完成的任务。', ], 'UpgradeInstanceVersion' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'systemTags' => [], 'parameters' => [ [ 'name' => 'DrdsInstanceId', 'in' => 'query', 'schema' => [ 'description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'drdshbgaen89****', ], ], [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => '地域ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'default' => 'center', ], ], [ 'name' => 'Rpm', 'in' => 'query', 'schema' => [ 'description' => '版本号，无需填写。', 'type' => 'string', 'required' => false, 'example' => 't-drds-server-5.4.12-16348095.noarch.rpm', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Data' => [ 'description' => '请求结果。', 'type' => 'string', 'example' => 'success', ], 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => '2F7F8080-9132-4279-85D0-B7E5C4305162', ], ], ], ], ], 'errorCodes' => [ 500 => [ [ 'errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error. 默认错误码', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"Data\\": \\"success\\",\\n \\"RequestId\\": \\"2F7F8080-9132-4279-85D0-B7E5C4305162\\"\\n}","errorExample":""},{"type":"xml","example":"\\n success\\n 2F7F8080-9132-4279-85D0-B7E5C4305162\\n","errorExample":""}]', 'title' => '升级DRDS实例的版本', 'summary' => '调用UpgradeInstanceVersion接口升级DRDS实例的版本。 。', ], 'DescribeDrdsInstanceMonitor' => [ 'summary' => '调用DescribeDrdsInstanceMonitor接口查询实例监控数据详情。', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREdrdsD0NTUP', ], ], 'parameters' => [ [ 'name' => 'DrdsInstanceId', 'in' => 'query', 'schema' => [ 'description' => '实例ID。'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'drds*********', ], ], [ 'name' => 'Key', 'in' => 'query', 'schema' => [ 'description' => '性能监控指标，允许一次传入多个指标进行查询，多个指标参数间用英文逗号（,）隔开。'."\n" .'> 更多关于性能监控指标详情，请参见[实例监控](~~186703~~)。'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cpu', ], ], [ 'name' => 'StartTime', 'in' => 'query', 'schema' => [ 'description' => '查询开始时间，格式为Unix时间戳（UTC时间），单位为毫秒。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '1603123290000', ], ], [ 'name' => 'EndTime', 'in' => 'query', 'schema' => [ 'description' => '查询结束时间，格式为Unix时间戳（UTC时间），单位为毫秒。'."\n" ."\n" .'> 如果查询时间范围小于1小时，会返回结束时间前1小时的数据。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '1603209690000', ], ], [ 'name' => 'PeriodMultiple', 'in' => 'query', 'schema' => [ 'description' => '监控数据周期倍数。例如，各资源监控项的数据采集周期均默认为1分钟，若设置周期倍数为2，则表示当前资源监控项数据采集周期为2分钟。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'default' => '0', ], ], [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => '地域ID。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'cn-hangzhou', 'default' => 'center', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => '2F7F8080-9132-4279-85D0-B7E5C4', ], 'Data' => [ 'description' => '查询结果集。', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Key' => [ 'description' => '监控指标名称。', 'type' => 'string', 'example' => 'cpu', ], 'Unit' => [ 'description' => '监控指标的单位。', 'type' => 'string', 'example' => '%', ], 'NodeNum' => [ 'description' => '节点数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'Values' => [ 'description' => '监控指标数据详情。', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Date' => [ 'description' => '获取监控指标数值的时间点，格式为Unix时间戳（UTC时间），单位为毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1603163400000', ], 'Value' => [ 'description' => '监控指标数值。', 'type' => 'string', 'example' => '1.40', ], ], ], ], ], ], ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'ActionUnauthorized', 'errorMessage' => 'The specified action is not available for you', ], [ 'errorCode' => 'InvalidParameter.Mismatch', 'errorMessage' => 'Invalid parameter of key', ], [ 'errorCode' => 'InvalidParameter.time', 'errorMessage' => 'The startTime and endTime must in one week', ], [ 'errorCode' => 'InvalidParameter.periodMultiple', 'errorMessage' => 'The periodMultiple is too larger than the time between startTime and endTime', ], [ 'errorCode' => 'DrdsInstance.NotExists', 'errorMessage' => 'The drds instance does not exist.', ], [ 'errorCode' => 'InvalidParameter', 'errorMessage' => 'invalid parameter.', ], ], 404 => [ [ 'errorCode' => 'Monitor.QueryRdsFailure', 'errorMessage' => 'Failed to query RDS monitor info.', ], ], 500 => [ [ 'errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"2F7F8080-9132-4279-85D0-B7E5C4\\",\\n \\"Data\\": [\\n {\\n \\"Key\\": \\"cpu\\",\\n \\"Unit\\": \\"%\\",\\n \\"NodeNum\\": 1,\\n \\"Values\\": [\\n {\\n \\"Date\\": 1603163400000,\\n \\"Value\\": \\"1.40\\"\\n }\\n ]\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"2F7F8080-9132-4279-85D0-B7E5C4\\n\\n 1\\n %\\n cpu\\n \\n 1.40\\n 1603163400000\\n \\n","errorExample":""}]', 'title' => '查询实例监控数据详情', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'DescribeDrdsInstanceDbMonitor' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'DrdsInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'PolarDB-X实例ID。'."\n" ."\n" .'DRDS实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'drds*************', ], ], [ 'name' => 'DbName', 'in' => 'query', 'schema' => [ 'description' => '数据库名称。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'drds_test', ], ], [ 'name' => 'Key', 'in' => 'query', 'schema' => [ 'description' => '性能监控指标，允许一次传入多个指标进行查询，多个指标参数间用英文逗号（,）隔开。'."\n" .'>更多关于性能监控指标详情，请参见[数据库监控](~~186704~~)。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'qps', ], ], [ 'name' => 'StartTime', 'in' => 'query', 'schema' => [ 'description' => '开始时间，格式为Unix时间戳（UTC时间），单位为毫秒。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '1603162800000', ], ], [ 'name' => 'EndTime', 'in' => 'query', 'schema' => [ 'description' => '结束时间，格式为Unix时间戳（UTC时间），单位为毫秒。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '1603166400000', ], ], [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => '地域ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'default' => 'center', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Success' => [ 'description' => '请求是否成功。', 'type' => 'boolean', 'example' => 'true', ], 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => '2F7F8080-9132-4279-85D0-B7E5C4******', ], 'Data' => [ 'description' => '监控数据列表。', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Key' => [ 'description' => '监控指标的名称。', 'type' => 'string', 'example' => 'qps', ], 'Unit' => [ 'description' => '监控指标的单位。', 'type' => 'string', 'example' => 'qps', ], 'Values' => [ 'description' => '监控数据值详情。', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Date' => [ 'description' => '获取该监控数据值的时间点，格式为Unix时间戳，单位为毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1603162805000', ], 'Value' => [ 'description' => '数据值。', 'type' => 'string', 'example' => '0', ], ], ], ], ], ], ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'ActionUnauthorized', 'errorMessage' => 'The specified action is not available for you', ], [ 'errorCode' => 'InvalidParameter.Mismatch', 'errorMessage' => 'Invalid parameter of key', ], [ 'errorCode' => 'InvalidParameter.time', 'errorMessage' => 'The startTime and endTime must in one week', ], ], 404 => [ [ 'errorCode' => 'InvalidDbName.NotFound', 'errorMessage' => 'The DrdsInstanceId or DbName provided does not exist in our records.', ], ], 500 => [ [ 'errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"2F7F8080-9132-4279-85D0-B7E5C4******\\",\\n \\"Data\\": [\\n {\\n \\"Key\\": \\"qps\\",\\n \\"Unit\\": \\"qps\\",\\n \\"Values\\": [\\n {\\n \\"Date\\": 1603162805000,\\n \\"Value\\": \\"0\\"\\n }\\n ]\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n01685B03-4099-414F-B9E1-DB994947CA8E\\n\\n \\n 0\\n 1602234005000\\n \\n qps\\n qps\\n\\ntrue\\n","errorExample":""}]', 'title' => '查询数据库的性能监控数据', 'summary' => '调用DescribeDrdsInstanceDbMonitor接口查询数据库的性能监控数据。', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'ChangeAccountPassword' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'systemTags' => [ 'operationType' => 'none', ], 'parameters' => [ [ 'name' => 'DrdsInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'DRDS实例ID。', 'type' => 'string', 'required' => true, 'example' => 'drds********', ], ], [ 'name' => 'AccountName', 'in' => 'query', 'schema' => [ 'description' => '账号名称。', 'type' => 'string', 'required' => true, 'example' => 'test', ], ], [ 'name' => 'Password', 'in' => 'query', 'schema' => [ 'description' => '更新后的密码。', 'type' => 'string', 'required' => true, 'example' => 'test', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Success' => [ 'description' => '是否成功。', 'type' => 'boolean', 'example' => 'true', ], 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => 'DSSDF-SEWE-*****', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'ActionUnauthorized', 'errorMessage' => 'The specified action is not available for you', ], ], 404 => [ [ 'errorCode' => 'InvalidDRDSInstanceId.NotFound', 'errorMessage' => 'The DrdsInstanceId provided does not exist in our records.', ], ], 500 => [ [ 'errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"DSSDF-SEWE-*****\\"\\n}","errorExample":""},{"type":"xml","example":"DSSDF-SEWE-*****\\ntrue","errorExample":""}]', 'title' => '重置DRDS数据库密码', 'summary' => '调用ChangeAccountPassword接口重置DRDS数据库密码。', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'ChangeInstanceAzone' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'systemTags' => [ 'operationType' => 'none', 'abilityTreeCode' => '75934', 'abilityTreeNodes' => [ 'FEATUREdrds25BO3L', ], ], 'parameters' => [ [ 'name' => 'DrdsInstanceId', 'in' => 'query', 'schema' => [ 'description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'drdsjiii1b49****', ], ], [ 'name' => 'OriginAzoneId', 'in' => 'query', 'schema' => [ 'description' => '原可用区ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou-B', ], ], [ 'name' => 'TargetAzoneId', 'in' => 'query', 'schema' => [ 'description' => '目标可用区ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou-A', ], ], [ 'name' => 'DrdsRegionId', 'in' => 'query', 'schema' => [ 'description' => '地域ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', ], ], [ 'name' => 'ChangeVSwitch', 'in' => 'query', 'allowEmptyValue' => true, 'schema' => [ 'description' => '是否更新交换机，取值如下：'."\n" ."\n" .'- **true**：是'."\n" .'- **false**：否', 'type' => 'boolean', 'required' => false, 'example' => 'true', ], ], [ 'name' => 'NewVSwitch', 'in' => 'query', 'allowEmptyValue' => true, 'schema' => [ 'description' => '新交换机的ID。', 'type' => 'string', 'required' => false, 'example' => 'vsw-wz9ckkba51zrh********', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'type' => 'object', 'properties' => [ 'Success' => [ 'description' => '请求是否成功。', 'type' => 'boolean', 'example' => 'true', ], 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => '2F7F8080-9132-4279-85D0-B7E5C4305162', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'ERR_INSTANCE_NOT_RUNNING_STATUS', 'errorMessage' => 'The instance status is not running', ], [ 'errorCode' => 'ERR_OTHER_MULTI_AZONE_SWITCH', 'errorMessage' => 'Change to multiple azone should have even number of nodes', ], ], 500 => [ [ 'errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"2F7F8080-9132-4279-85D0-B7E5C4305162\\"\\n}","errorExample":""},{"type":"xml","example":"\\n true\\n 2F7F8080-9132-4279-85D0-B7E5C4305162\\n","errorExample":""}]', 'title' => '切换实例可用区', 'summary' => '切换 DRDS 实例可用区。', ], 'DescribeBackupLocal' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'systemTags' => [], 'parameters' => [ [ 'name' => 'DrdsInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'DRDS实例ID。', 'type' => 'string', 'required' => true, 'example' => 'drds************', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Success' => [ 'description' => '请求结果。', 'type' => 'boolean', 'example' => 'true', ], 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => 'FDC9CFD5-306D-4A23-9D8C-057274C6****', ], 'BackupPolicyDO' => [ 'description' => '备份策略设置详情。', 'type' => 'object', 'properties' => [ 'BackupDbName' => [ 'description' => '本Api无此返回', 'type' => 'string', 'example' => 'null', ], 'LogBackupRetentionPeriod' => [ 'description' => '本Api无此返回', 'type' => 'integer', 'format' => 'int64', 'example' => '0', ], 'DataBackupRetentionPeriod' => [ 'description' => '本Api无此返回', 'type' => 'integer', 'format' => 'int64', 'example' => '0', ], 'BackupType' => [ 'description' => '本Api无此返回', 'type' => 'string', 'example' => 'null', ], 'BackupLevel' => [ 'description' => '本Api无此返回', 'type' => 'string', 'example' => 'null', ], 'LocalLogRetentionHours' => [ 'description' => '日志备份本地保留小时数，取值范围为0~168，**0**表示不保留，默认值为**18**。', 'type' => 'integer', 'format' => 'int64', 'example' => '18', ], 'HighSpaceUsageProtection' => [ 'description' => '当实例使用空间超过90%或剩余空间小于5GB时，是否开启无条件清理Binlog，取值范围如下：'."\n" .'* 1：开启 '."\n" .'* 0：不开启', 'type' => 'integer', 'format' => 'int64', 'example' => '1', ], 'GmtModified' => [ 'description' => '本Api无此返回', 'type' => 'integer', 'format' => 'int64', 'example' => '0', ], 'BackupRetentionPeriod' => [ 'description' => '本Api无此返回', 'type' => 'integer', 'format' => 'int64', 'example' => '0', ], 'BackupPolicyMode' => [ 'description' => '本Api无此返回', 'type' => 'string', 'example' => 'null', ], 'PreferredBackupPeriod' => [ 'description' => '本Api无此返回', 'type' => 'string', 'example' => 'null', ], 'LocalLogRetentionSpace' => [ 'description' => '本地日志最大空间使用率。 取值范围为0~50，此为循环空间，默认为**30**。', 'type' => 'integer', 'format' => 'int64', 'example' => '30', ], 'BackupAppName' => [ 'description' => '本Api无此返回', 'type' => 'string', 'example' => 'null', ], 'PreferredBackupTime' => [ 'description' => '本Api无此返回', 'type' => 'string', 'example' => 'null', ], 'GmtCreate' => [ 'description' => '本Api无此返回', 'type' => 'integer', 'format' => 'int64', 'example' => '0', ], 'BackupMode' => [ 'description' => '本Api无此返回', 'type' => 'string', 'example' => 'null', ], 'BackupLog' => [ 'description' => '本Api无此返回', 'type' => 'string', 'example' => 'null', ], 'NextBackupActuallyTime' => [ 'description' => '本Api无此返回', 'type' => 'string', 'example' => 'null', ], ], ], ], ], ], ], 'errorCodes' => [ 500 => [ [ 'errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"FDC9CFD5-306D-4A23-9D8C-057274C6****\\",\\n \\"BackupPolicyDO\\": {\\n \\"BackupDbName\\": \\"null\\",\\n \\"LogBackupRetentionPeriod\\": 0,\\n \\"DataBackupRetentionPeriod\\": 0,\\n \\"BackupType\\": \\"null\\",\\n \\"BackupLevel\\": \\"null\\",\\n \\"LocalLogRetentionHours\\": 18,\\n \\"HighSpaceUsageProtection\\": 1,\\n \\"GmtModified\\": 0,\\n \\"BackupRetentionPeriod\\": 0,\\n \\"BackupPolicyMode\\": \\"null\\",\\n \\"PreferredBackupPeriod\\": \\"null\\",\\n \\"LocalLogRetentionSpace\\": 30,\\n \\"BackupAppName\\": \\"null\\",\\n \\"PreferredBackupTime\\": \\"null\\",\\n \\"GmtCreate\\": 0,\\n \\"BackupMode\\": \\"null\\",\\n \\"BackupLog\\": \\"null\\",\\n \\"NextBackupActuallyTime\\": \\"null\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n\\tFDC9CFD5-306D-4A23-9D8C-057274C6****\\n\\ttrue\\n\\t\\n\\t\\t18\\n\\t\\t30\\n\\t\\t1\\n\\t\\n","errorExample":""}]', 'title' => '查看本地备份集', 'summary' => '调用DescribeBackupLocal接口查看本地日志设置。', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'DescribeDrdsRdsInstances' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'systemTags' => [ 'operationType' => 'none', 'abilityTreeCode' => '76007', 'abilityTreeNodes' => [ 'FEATUREdrdsD0NTUP', ], ], 'parameters' => [ [ 'name' => 'DrdsInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'PolarDB-X实例ID。'."\n" .'DRDS实例ID。'."\n" .'> 您可以调用[DescribeDrdsInstances](~~139284~~)查看目标账号下所有实例详情，包括实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'drds*************', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => '123DB16B-02F2-45F7-A571-843991******', ], 'Success' => [ 'description' => '请求是否成功。', 'type' => 'boolean', 'example' => 'true', ], 'DbInstances' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'DbInstance' => [ 'description' => '存储层私有定制RDS实例信息详情。', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'DBInstanceCPU' => [ 'description' => '存储层私有定制RDS实例的CPU核数。', 'type' => 'string', 'example' => '8', ], 'DBInstanceMemory' => [ 'description' => '存储层私有定制RDS实例的内存，单位：M。', 'type' => 'integer', 'format' => 'int64', 'example' => '8192', ], 'PayType' => [ 'description' => '存储层私有定制RDS实例的付费方式，取值范围如下：'."\n" ."\n" .'* Postpaid：按量付费（即后付费）'."\n" .'* Prepaid：包年包月（即预付费）', 'type' => 'string', 'example' => 'PostPaid', ], 'DBInstanceStatus' => [ 'description' => '存储层私有定制RDS实例的状态，取值范围如下：'."\n" .'* 0：创建中'."\n" .'* 1：运行中'."\n" .'* 3：删除中'."\n" .'* 5：重启中'."\n" .'* 6：升降级中'."\n" .'* 7：备份中'."\n" .'* 8：内外网切换中'."\n" .'* 9：迁移中'."\n" .'* 11：迁移数据中'."\n" .'* 12：生成灾备实例中'."\n" .'* 13：数据导入中'."\n" .'* 14：从其他RDS实例导入数据中'."\n" .'* 15：容灾切换中'."\n" .'* 16：创建临时实例中'."\n" .'* 17：网络创建中'."\n" .'* 18：实例克隆中'."\n" .'* 19：链路切换中'."\n" .'* 20：只读实例迁移中', 'type' => 'string', 'example' => '1', ], 'NetworkType' => [ 'description' => '存储层私有定制RDS实例的网络类型，固定为VPC（专有网络）。', 'type' => 'string', 'example' => 'VPC', ], 'Port' => [ 'description' => '内网连接端口。', 'type' => 'integer', 'format' => 'int32', 'example' => '3306', ], 'EngineVersion' => [ 'description' => '存储层私有定制RDS实例的引擎版本号，固定为8.0。', 'type' => 'string', 'example' => '8.0', ], 'DmInstanceId' => [ 'description' => '资源ID。', 'type' => 'string', 'example' => 'dm-*************', ], 'DBInstanceStorage' => [ 'description' => '存储层私有定制RDS实例的存储空间，单位：GB。', 'type' => 'integer', 'format' => 'int64', 'example' => '20', ], 'ConnectUrl' => [ 'description' => '存储层私有定制RDS实例的内网连接地址。', 'type' => 'string', 'example' => 'rm-***************.mysql.rds.aliyuncs.com', ], 'ReadWeight' => [ 'description' => '目标存储层私有定制RDS实例的读写权重。', 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], 'RdsInstType' => [ 'description' => '存储层私有定制RDS实例的类型，取值范围如下：'."\n" ."\n" .'* Primary：主实例'."\n" .'* Readonly：只读实例', 'type' => 'string', 'example' => 'Primary', ], 'DBInstanceClassType' => [ 'description' => '实例规格族，取值范围如下：'."\n" ."\n" .'* **x**：通用型'."\n" .'* **d**：独享套餐'."\n" .'* **h**：独占物理机', 'type' => 'string', 'example' => 'x', ], 'DBInstanceId' => [ 'description' => '存储层私有定制RDS实例ID。', 'type' => 'string', 'example' => 'rm-*****************', ], 'Engine' => [ 'description' => '存储层私有定制RDS实例的引擎类型，固定为MySQL。', 'type' => 'string', 'example' => 'MySQL', ], 'DbInstType' => [ 'description' => '存储层实例类型，固定为RDS。', 'type' => 'string', 'example' => 'RDS', ], 'LockMode' => [ 'description' => 'RDS的锁定状态，取值范围：0|1|2|3|4|5'."\n" ."\n" .' 0，正常'."\n" ."\n" .'1，手动触发锁'."\n" ."\n" .'2，实例过期自动锁定'."\n" ."\n" .'3，实例回滚前的自动锁定'."\n" ."\n" .'4，实例空间满自动锁定'."\n" ."\n" .'5，只读实例空间满自动锁定', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'LockReason' => [ 'description' => 'RDS锁定的原因', 'type' => 'string', 'example' => '手动触发锁', ], ], ], ], ], ], ], ], ], ], 'errorCodes' => [ 500 => [ [ 'errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"123DB16B-02F2-45F7-A571-843991******\\",\\n \\"Success\\": true,\\n \\"DbInstances\\": {\\n \\"DbInstance\\": [\\n {\\n \\"DBInstanceCPU\\": \\"8\\",\\n \\"DBInstanceMemory\\": 8192,\\n \\"PayType\\": \\"PostPaid\\",\\n \\"DBInstanceStatus\\": \\"1\\",\\n \\"NetworkType\\": \\"VPC\\",\\n \\"Port\\": 3306,\\n \\"EngineVersion\\": \\"8.0\\",\\n \\"DmInstanceId\\": \\"dm-*************\\",\\n \\"DBInstanceStorage\\": 20,\\n \\"ConnectUrl\\": \\"rm-***************.mysql.rds.aliyuncs.com\\",\\n \\"ReadWeight\\": 0,\\n \\"RdsInstType\\": \\"Primary\\",\\n \\"DBInstanceClassType\\": \\"x\\",\\n \\"DBInstanceId\\": \\"rm-*****************\\",\\n \\"Engine\\": \\"MySQL\\",\\n \\"DbInstType\\": \\"RDS\\",\\n \\"LockMode\\": 1,\\n \\"LockReason\\": \\"手动触发锁\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"123DB16B-02F2-45F7-A571-843991******\\n\\n \\n RDS\\n 8192\\n 8\\n 6\\n 3306\\n PostPaid\\n 4\\n x\\n rm-************.mysql.rds.aliyuncs.com\\n 0\\n rm-************\\n VPC\\n 20\\n Primary\\n dm-************\\n MySQL\\n \\n\\ntrue","errorExample":""}]', 'title' => '私有定制RDS实例详情', 'summary' => '查看目标PolarDB-X实例下所有的私有定制RDS实例详情。', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'DescribeRecycleBinStatus' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'systemTags' => [], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => '地域ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'default' => 'center', ], ], [ 'name' => 'DrdsInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'DRDS实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'drds************', ], ], [ 'name' => 'DbName', 'in' => 'query', 'schema' => [ 'description' => 'DRDS上创建的数据库名称。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'test', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Status' => [ 'description' => '表回收站状态，取值范围如下：'."\n" .'* disable：未开启'."\n" .'* enable：开启', 'type' => 'string', 'example' => 'disable', ], 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => 'ACB5258F-25AF-4D7C-8FAA-B6FE60******', ], 'Success' => [ 'description' => '请求结果。'."\n" ."\n", 'type' => 'boolean', 'example' => 'true', ], ], ], ], ], 'errorCodes' => [ 500 => [ [ 'errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"Status\\": \\"disable\\",\\n \\"RequestId\\": \\"ACB5258F-25AF-4D7C-8FAA-B6FE60******\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"enable\\nACB5258F-25AF-4D7C-8FAA-B6FE60******\\ntrue","errorExample":""}]', 'title' => '查看表回收站状态', 'summary' => '调用DescribeRecycleBinStatus接口查看表回收站状态。', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'DescribeRecycleBinTables' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'systemTags' => [ 'operationType' => 'none', 'abilityTreeCode' => '76046', 'abilityTreeNodes' => [ 'FEATUREdrdsZVW4NQ', ], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => '地域ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'default' => 'center', ], ], [ 'name' => 'DrdsInstanceId', 'in' => 'query', 'schema' => [ 'description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'drds***********', ], ], [ 'name' => 'DbName', 'in' => 'query', 'schema' => [ 'description' => '数据库名称。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'drds_test', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Success' => [ 'description' => '请求结果。'."\n" ."\n", 'type' => 'boolean', 'example' => 'true', ], 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => '5D64DE5944A1E541E0CB908A', ], 'Data' => [ 'description' => '返回数据对象。', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'OriginalTableName' => [ 'description' => '原始表名。', 'type' => 'string', 'example' => 'BIN_T4AG3CY5WWXPKHITCHJY', ], 'TableName' => [ 'description' => '表名。', 'type' => 'string', 'example' => 'test', ], 'CreateTime' => [ 'description' => '创建时间。', 'type' => 'string', 'example' => '2019-09-16 14:42:06', ], ], ], ], ], ], ], ], 'errorCodes' => [ 500 => [ [ 'errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"5D64DE5944A1E541E0CB908A\\",\\n \\"Data\\": [\\n {\\n \\"OriginalTableName\\": \\"BIN_T4AG3CY5WWXPKHITCHJY\\",\\n \\"TableName\\": \\"test\\",\\n \\"CreateTime\\": \\"2019-09-16 14:42:06\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"EC985705-2D6B-4B84-9732-BF8F5D******\\n\\n BIN_T4AG3CY5WWXPKHITCHJY\\n test\\n 2019-09-16 14:42:06\\n\\ntrue","errorExample":""}]', 'title' => '查询可回收的表', 'summary' => '查询可回收的表。', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'EnableInstanceIpv6Address' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'systemTags' => [ 'operationType' => 'none', 'abilityTreeCode' => '76059', 'abilityTreeNodes' => [ 'FEATUREdrdsBRC5LQ', ], ], 'parameters' => [ [ 'name' => 'DrdsInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'DRDS实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'drds************', ], ], [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => '实例所在地域ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'default' => 'center', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Data' => [ 'description' => '请求结果。', 'type' => 'boolean', 'example' => 'true', ], 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => '7E9F7F16-05B5-42DA-94D6-E36402******', ], ], ], ], ], 'errorCodes' => [ 500 => [ [ 'errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error. 默认错误码', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"Data\\": true,\\n \\"RequestId\\": \\"7E9F7F16-05B5-42DA-94D6-E36402******\\"\\n}","errorExample":""},{"type":"xml","example":"7E9F7F16-05B5-42DA-94D6-E36402******\\ntrue","errorExample":""}]', 'title' => '创建IPv6地址', 'summary' => '调用EnableInstanceIpv6Address接口创建IPv6地址。', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'FlashbackRecycleBinTable' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'systemTags' => [ 'operationType' => 'none', 'abilityTreeCode' => '76063', 'abilityTreeNodes' => [ 'FEATUREdrds25BO3L', ], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => '地域ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'default' => 'center', ], ], [ 'name' => 'DrdsInstanceId', 'in' => 'query', 'schema' => [ 'description' => '表所在的实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'drds************', ], ], [ 'name' => 'DbName', 'in' => 'query', 'schema' => [ 'description' => '表所在的数据库名称。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'test', ], ], [ 'name' => 'TableName', 'in' => 'query', 'schema' => [ 'description' => '需要恢复的逻辑表名称。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'test', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Data' => [ 'description' => '是否成功恢复已删除的逻辑表。', 'type' => 'boolean', 'example' => 'true', ], 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => '463A5F0F-12AD-4544-A902-B2B983******', ], 'Success' => [ 'description' => '请求结果。', 'type' => 'boolean', 'example' => 'true', ], ], ], ], ], 'errorCodes' => [ 500 => [ [ 'errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"Data\\": true,\\n \\"RequestId\\": \\"463A5F0F-12AD-4544-A902-B2B983******\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"true\\n463A5F0F-12AD-4544-A902-B2B983******\\ntrue","errorExample":""}]', 'title' => '恢复删除的逻辑表', 'summary' => '恢复删除的逻辑表。', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'GetDrdsDbRdsRelationInfo' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'abilityTreeCode' => '76066', 'abilityTreeNodes' => [ 'FEATUREdrds25BO3L', ], ], 'parameters' => [ [ 'name' => 'DrdsInstanceId', 'in' => 'query', 'schema' => [ 'description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'drdshbga948vbpd2', ], ], [ 'name' => 'DbName', 'in' => 'query', 'schema' => [ 'description' => 'Db名称。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'testDb', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Success' => [ 'description' => '查询是否成功。', 'type' => 'boolean', 'example' => 'true', ], 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => '82FD0D9B-9A65-40D3-B1D9-8851B1D4AF75', ], 'Data' => [ 'description' => '存储实例结构列表，每一项对应一个主存储实例。', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'RdsInstanceId' => [ 'description' => '存储实例ID。', 'type' => 'string', 'example' => 'rm-bp16ad920ndxxxx02', ], 'UsedInstanceType' => [ 'description' => '使用中的存储实例类型。', 'type' => 'string', 'example' => 'RDS', ], 'UsedInstanceId' => [ 'description' => '使用中的存储实例ID，对主DRDS实例为主存储实例，对只读DRDS实例为选用的存储实例。', 'type' => 'string', 'example' => 'rm-bp1l8xi1dd9xxxxbj', ], 'ReadOnlyInstanceInfo' => [ 'type' => 'array', 'items' => [ 'description' => '只读存储实例ID列表。', 'type' => 'string', 'example' => '[]', ], ], ], ], ], ], ], ], ], 'errorCodes' => [ 500 => [ [ 'errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"82FD0D9B-9A65-40D3-B1D9-8851B1D4AF75\\",\\n \\"Data\\": [\\n {\\n \\"RdsInstanceId\\": \\"rm-bp16ad920ndxxxx02\\",\\n \\"UsedInstanceType\\": \\"RDS\\",\\n \\"UsedInstanceId\\": \\"rm-bp1l8xi1dd9xxxxbj\\",\\n \\"ReadOnlyInstanceInfo\\": [\\n \\"[]\\"\\n ]\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"82FD0D9B-9A65-40D3-B1D9-8851B1D4AF75\\n\\n rm-bp1l8xi1dd9xxxxbj\\n RDS\\n rm-bp16ad920ndxxxx02\\n []\\n\\ntrue","errorExample":""}]', 'title' => '查询数据库存储实例结构', 'summary' => '调用GetDrdsDbRdsRelationInfo接口查询数据库存储实例结构。', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'ManagePrivateRds' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => 'PolarDB-X实例所在的地域ID。'."\n" .'DRDS实例实例所在的地域ID。'."\n" .'> 您可以调用[DescribeDrdsInstances](~~139284~~)查看目标账号下所有实例详情，包括地域ID。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'cn-hanzhou', ], ], [ 'name' => 'DrdsInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'PolarDB-X实例ID。'."\n" .'DRDS实例ID。'."\n" .'> 您可以调用[DescribeDrdsInstances](~~139284~~)查看目标账号下所有实例详情，包括实例ID。'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'drds*************', ], ], [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => '存储层私有定制RDS实例ID。'."\n" ."\n" .'> 您可以调用[DescribeDrdsRdsInstances](~~215526~~)查看所有存储层私有定制RDS实例详情，包括实例ID。'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'rm-***************', ], ], [ 'name' => 'RdsAction', 'in' => 'query', 'schema' => [ 'description' => '当前支持对私有定制RDS实例执行如下管理操作：'."\n" .'* **DescribeDBInstanceAttribute**：查询私有定制RDS实例的详细信息。'."\n" .'* **DescribeAvailableClasses**：查询私有定制RDS实例可购买规格，包括规格代码和存储空间。'."\n" .'* **DescribeSQLCollectorPolicy**：查询私有定制RDS实例的SQL洞察（SQL审计）状态。'."\n" .'* **ModifySQLCollectorPolicy**：开启或关闭私有定制RDS实例的SQL洞察（SQL审计）功能。'."\n" .'* **DescribeParameters**：查询私有定制RDS实例当前的参数配置。'."\n" .'* **ModifyParameter**：修改私有定制RDS实例参数。'."\n" .'* **DescribeDBInstanceHAConfig**：查询私有定制RDS实例的高可用模式和数据复制方式。'."\n" .'* **SwitchDBInstanceHA**：切换私有定制RDS实例的主备实例。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'SwitchDBInstanceHA', ], ], [ 'name' => 'Params', 'in' => 'query', 'schema' => [ 'description' => '需要转发的私有定制RDS接口的请求参数及其值的JSON串，参数的值都是字符串类型，例如`{NodeId:"1797****"}`。'."\n" ."\n" .'各私有定制RDS接口的请求参数及取值范围，请参见如下文档中请求参数的部分：'."\n" .'* [DescribeDBInstanceAttribute](~~26231~~)'."\n" .'* [DescribeAvailableClasses](~~196546~~)'."\n" .'* [DescribeSQLCollectorPolicy](~~26292~~)'."\n" .'* [ModifySQLCollectorPolicy](~~26293~~)'."\n" .'* [DescribeParameters](~~26285~~)'."\n" .'* [ModifyParameter](~~26286~~)'."\n" .'* [DescribeDBInstanceHAConfig](~~26244~~)'."\n" .'* [SwitchDBInstanceHA](~~26251~~)'."\n" ."\n" .'> 针对上述各接口的必选请求参数，`Action`和`DBInstanceId`参数值无需传入，其他必选请求参数必须传入。'."\n", 'type' => 'string', 'required' => false, 'example' => '{NodeId:"1797****"}', 'default' => '{}', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Data' => [ 'description' => '转发私有定制RDS接口返回的参数结果集。', 'type' => 'string', 'example' => '{"requestId":"E63C810A-4A13-47B6-BA67-C0E23A******"}', ], 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => '0237BCD2-2C7A-4F86-A766-657AF6******', ], 'Success' => [ 'description' => '请求是否成功。', 'type' => 'boolean', 'example' => 'true', ], ], ], ], ], 'errorCodes' => [ 500 => [ [ 'errorCode' => 'RDSAPI.ERROR', 'errorMessage' => 'Failed to call the RDS API operation.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"Data\\": \\"{\\\\\\"requestId\\\\\\":\\\\\\"E63C810A-4A13-47B6-BA67-C0E23A******\\\\\\"}\\",\\n \\"RequestId\\": \\"0237BCD2-2C7A-4F86-A766-657AF6******\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"0237BCD2-2C7A-4F86-A766-657AF6******\\n{\\"requestId\\":\\"E63C810A-4A13-47B6-BA67-C0E23A******\\"}\\ntrue","errorExample":""}]', 'title' => '管理私有RDS', 'summary' => '调用ManagePrivateRds接口管理存储层私有定制RDS实例。', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'ModifyAccountDescription' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'systemTags' => [], 'parameters' => [ [ 'name' => 'DrdsInstanceId', 'in' => 'query', 'schema' => [ 'description' => '实例ID。', 'type' => 'string', 'required' => true, 'example' => 'drds************', ], ], [ 'name' => 'AccountName', 'in' => 'query', 'schema' => [ 'description' => '账号名称。', 'type' => 'string', 'required' => true, 'example' => 'test', ], ], [ 'name' => 'Description', 'in' => 'query', 'schema' => [ 'description' => '账号描述。', 'type' => 'string', 'required' => true, 'example' => 'test', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Success' => [ 'description' => '请求结果。', 'type' => 'boolean', 'example' => 'true', ], 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => '2F93CCD5-806F-4470-BBC7-20476A******', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'OperationFailed.ModifyAccountDescription', 'errorMessage' => 'Modify account description failed.', ], ], 500 => [ [ 'errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"2F93CCD5-806F-4470-BBC7-20476A******\\"\\n}","errorExample":""},{"type":"xml","example":"2F93CCD5-806F-4470-BBC7-20476A******\\ntrue","errorExample":""}]', 'title' => '修改账号描述', 'summary' => '调用ModifyAccountDescription接口修改账号描述。', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'ModifyAccountPrivilege' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'systemTags' => [], 'parameters' => [ [ 'name' => 'DrdsInstanceId', 'in' => 'query', 'schema' => [ 'description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'drdshbgaen89****', ], ], [ 'name' => 'AccountName', 'in' => 'query', 'schema' => [ 'description' => '账号名称。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'account_sec', ], ], [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => '地域ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', ], ], [ 'name' => 'DbPrivilege', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => '数据库权限列表。', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'DbName' => [ 'description' => '数据库名称。', 'type' => 'string', 'required' => false, 'example' => 'test123', ], 'Privilege' => [ 'description' => '账号权限。', 'type' => 'string', 'required' => false, 'example' => 'ReadWrite', ], ], 'required' => false, ], 'required' => false, 'maxItems' => 1000, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Success' => [ 'description' => '请求是否成功。', 'type' => 'boolean', 'example' => 'true', ], 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => '73559800-3c8c-11ec-bd40-99cfcff3fe1e', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'OperationFailed.ModifyAccountPrivilege', 'errorMessage' => 'Modify account privilege failed.', ], ], 500 => [ [ 'errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"73559800-3c8c-11ec-bd40-99cfcff3fe1e\\"\\n}","errorExample":""},{"type":"xml","example":"\\n true\\n 73559800-3c8c-11ec-bd40-99cfcff3fe1e\\n","errorExample":""}]', 'title' => '修改账号权限', 'summary' => '修改账号权限。', ], 'ModifyPolarDbReadWeight' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'systemTags' => [ 'operationType' => 'none', ], 'parameters' => [ [ 'name' => 'DrdsInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'DRDS实例ID。', 'type' => 'string', 'required' => true, 'example' => 'drds************', ], ], [ 'name' => 'DbName', 'in' => 'query', 'schema' => [ 'description' => '数据库名称。', 'type' => 'string', 'required' => true, 'example' => 'test', ], ], [ 'name' => 'DbNodeIds', 'in' => 'query', 'schema' => [ 'description' => '目标PolarDB集群下对应的节点列表，不同集群的节点间用英文逗号（,）分组，组内节点用英文冒号（:）隔开。', 'type' => 'string', 'required' => true, 'example' => 'pi-****************,pi-****************:pi-****************', ], ], [ 'name' => 'DbInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'Polar集群ID。', 'type' => 'string', 'required' => true, 'example' => 'pc-****************', ], ], [ 'name' => 'Weights', 'in' => 'query', 'schema' => [ 'description' => 'PolarDB分组对应的权重，多个权重间用英文逗号（,）隔开。', 'type' => 'string', 'required' => true, 'example' => '14,86', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Success' => [ 'description' => '请求结果。', 'type' => 'boolean', 'example' => 'true', ], 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => 'B12FC174-D5CE-4A6E-83C1-0F8F86******', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'InvalidParameter.InvalidDbName', 'errorMessage' => 'The dbName does not exist in this drds instance', ], [ 'errorCode' => 'InvalidParameter.ReadWeighAndRdsNotMapping', 'errorMessage' => 'The parameter read weight and rds instance not mapping', ], [ 'errorCode' => 'InvalidParameter.InvalidReadWeight', 'errorMessage' => 'The parameter read weight is invalid', ], ], 500 => [ [ 'errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"B12FC174-D5CE-4A6E-83C1-0F8F86******\\"\\n}","errorExample":""},{"type":"xml","example":"B12FC174-D5CE-4A6E-83C1-0F8F86******\\ntrue","errorExample":""}]', 'title' => '修改PolarDB的读写权重', 'summary' => '调用ModifyPolarDbReadWeight接口修改PolarDB的读写权重。', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'RefreshDrdsAtomUrl' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'systemTags' => [ 'operationType' => 'none', ], 'parameters' => [ [ 'name' => 'DrdsInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'DRDS实例ID。', 'type' => 'string', 'required' => true, 'example' => 'drds************', ], ], [ 'name' => 'DbName', 'in' => 'query', 'schema' => [ 'description' => '数据库名称。', 'type' => 'string', 'required' => true, 'example' => 'test', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => 'B12FC174-D5CE-4A6E-83C1-0F8F86******', ], 'Result' => [ 'description' => '刷新分库连接结果。', 'type' => 'boolean', 'example' => 'true', ], 'Success' => [ 'description' => '当前API是否请求成功。', 'type' => 'boolean', 'example' => 'true', ], ], ], ], ], 'errorCodes' => [ 500 => [ [ 'errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"B12FC174-D5CE-4A6E-83C1-0F8F86******\\",\\n \\"Result\\": true,\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"B12FC174-D5CE-4A6E-83C1-0F8F86******\\ntrue","errorExample":""}]', 'title' => '刷新DRDS分库连接', 'summary' => 'RDS连接变更后，刷新DRDS分库连接保证其到RDS的链路畅通。', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'RemoveRecycleBinTable' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'systemTags' => [ 'operationType' => 'none', 'abilityTreeCode' => '76111', 'abilityTreeNodes' => [ 'FEATUREdrds25BO3L', ], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => '地域ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'default' => 'center', ], ], [ 'name' => 'DrdsInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'DRDS实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'drds************', ], ], [ 'name' => 'DbName', 'in' => 'query', 'schema' => [ 'description' => 'DRDS数据库名称。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'test', ], ], [ 'name' => 'TableName', 'in' => 'query', 'schema' => [ 'description' => 'DRDS逻辑表名称。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'test', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Data' => [ 'description' => '回收站中的表是否被清除。', 'type' => 'boolean', 'example' => 'true', ], 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => 'A3140FC7-B78B-4D8E-B0C8-926D28******', ], 'Success' => [ 'description' => '请求结果。', 'type' => 'boolean', 'example' => 'true', ], ], ], ], ], 'errorCodes' => [ 500 => [ [ 'errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"Data\\": true,\\n \\"RequestId\\": \\"A3140FC7-B78B-4D8E-B0C8-926D28******\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"A3140FC7-B78B-4D8E-B0C8-926D28******\\ntrue\\ntrue","errorExample":""}]', 'title' => '清除回收站中的表', 'summary' => '清除回收站中的表。', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'RestartDrdsInstance' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'systemTags' => [ 'operationType' => 'none', 'abilityTreeCode' => '76113', 'abilityTreeNodes' => [ 'FEATUREdrds25BO3L', ], ], 'parameters' => [ [ 'name' => 'DrdsInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'DRDS实例ID。', 'type' => 'string', 'required' => true, 'example' => 'drds************', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => 'A3140FC7-B78B-4D8E-B0C8-926D28******', ], 'Success' => [ 'description' => '请求结果。', 'type' => 'boolean', 'example' => 'true', ], 'TaskId' => [ 'description' => '异步任务ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '1', ], ], ], ], ], 'errorCodes' => [ 500 => [ [ 'errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"A3140FC7-B78B-4D8E-B0C8-926D28******\\",\\n \\"Success\\": true,\\n \\"TaskId\\": 1\\n}","errorExample":""},{"type":"xml","example":"A3140FC7-B78B-4D8E-B0C8-926D28******\\ntrue\\n1","errorExample":""}]', 'title' => '重启实例', 'summary' => '调用RestartDrdsInstance接口重启实例。', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'RollbackInstanceVersion' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'systemTags' => [ 'operationType' => 'none', 'abilityTreeCode' => '76115', 'abilityTreeNodes' => [ 'FEATUREdrds25BO3L', ], ], 'parameters' => [ [ 'name' => 'DrdsInstanceId', 'in' => 'query', 'schema' => [ 'description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'drds************', ], ], [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => '地域ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'default' => 'center', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Data' => [ 'description' => '实例版本是否回滚成功。', 'type' => 'string', 'example' => 'true', ], 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => 'DSSDF-SEWE-*****', ], ], ], ], ], 'errorCodes' => [ 500 => [ [ 'errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error. 默认错误码', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"Data\\": \\"true\\",\\n \\"RequestId\\": \\"DSSDF-SEWE-*****\\"\\n}","errorExample":""},{"type":"xml","example":"\\nDSSDF-SEWE-*****\\ntrue\\n","errorExample":""}]', 'title' => '回滚DRDS实例的版本', 'summary' => '回滚DRDS实例的版本。', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'SetBackupLocal' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'systemTags' => [], 'parameters' => [ [ 'name' => 'DrdsInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'DRDS 实例ID', 'type' => 'string', 'required' => true, 'example' => 'drdshbgag23d13fds', ], ], [ 'name' => 'LocalLogRetentionHours', 'in' => 'query', 'schema' => [ 'description' => '日志备份本地保留小时数。取值为0~7*24，0表示不保留，默认为18', 'type' => 'string', 'required' => false, 'example' => '12', ], ], [ 'name' => 'LocalLogRetentionSpace', 'in' => 'query', 'schema' => [ 'description' => '本地日志最大空间使用率。 取值为0~50，此为循环空间，默认为30。', 'type' => 'string', 'required' => false, 'example' => '30', ], ], [ 'name' => 'HighSpaceUsageProtection', 'in' => 'query', 'schema' => [ 'description' => '实例使用空间>= 90%，或者剩余空间小于5GB时，是否无条件清理Binlog：1: 开启 0：不开启', 'type' => 'string', 'required' => false, 'example' => '80', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => '请求ID', 'type' => 'string', 'example' => '6F70CE62-5077-4B7B-95BC-4DAC45614DBE', ], 'Result' => [ 'description' => '操作返回结果', 'type' => 'string', 'example' => 'success', ], 'Success' => [ 'description' => 'api调用结果', 'type' => 'boolean', 'example' => 'true', ], ], ], ], ], 'errorCodes' => [ 500 => [ [ 'errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"6F70CE62-5077-4B7B-95BC-4DAC45614DBE\\",\\n \\"Result\\": \\"success\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n\\t A3140FC7-B78B-4D8E-B0C8-926D28669934\\n\\t true\\n\\t success\\n","errorExample":""}]', 'title' => '设置本地备份集策略', 'summary' => '修改备份策略。', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'SetupRecycleBinStatus' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'systemTags' => [], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => '地域ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'default' => 'center', ], ], [ 'name' => 'DrdsInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'DRDS实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'drds************', ], ], [ 'name' => 'DbName', 'in' => 'query', 'schema' => [ 'description' => '数据库名称。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'test', ], ], [ 'name' => 'StatusAction', 'in' => 'query', 'schema' => [ 'description' => '表回收站的开启状态，取值范围如下：'."\n" .'* enable：开启'."\n" .'* disable：关闭', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'enable', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Data' => [ 'description' => '表回收站是否开启。', 'type' => 'boolean', 'example' => 'true', ], 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => 'A3140FC7-B78B-4D8E-B0C8-926D28******', ], 'Success' => [ 'description' => '请求结果。', 'type' => 'boolean', 'example' => 'true', ], ], ], ], ], 'errorCodes' => [ 500 => [ [ 'errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"Data\\": true,\\n \\"RequestId\\": \\"A3140FC7-B78B-4D8E-B0C8-926D28******\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"A3140FC7-B78B-4D8E-B0C8-926D28******\\ntrue\\ntrue","errorExample":""}]', 'title' => '开启表回收站', 'summary' => '调用SetupRecycleBinStatus接口开启表回收站。', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'SubmitSmoothExpandPreCheckTask' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'systemTags' => [ 'operationType' => 'none', 'abilityTreeCode' => '76140', 'abilityTreeNodes' => [ 'FEATUREdrds25BO3L', ], ], 'parameters' => [ [ 'name' => 'DrdsInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'DRDS 实例 ID', 'type' => 'string', 'required' => true, 'example' => 'drds823s4esd', ], ], [ 'name' => 'DbName', 'in' => 'query', 'schema' => [ 'description' => 'DRDS 数据库名', 'type' => 'string', 'required' => true, 'example' => 'test', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Msg' => [ 'description' => '提交任务的结果信息', 'type' => 'string', 'example' => 'scucess', ], 'RequestId' => [ 'description' => '请求 ID', 'type' => 'string', 'example' => 'DSSDF-SEWE-23ERW', ], 'TaskId' => [ 'description' => '任务 ID', 'type' => 'integer', 'format' => 'int64', 'example' => '2321', ], 'Success' => [ 'description' => '请求是否成功', 'type' => 'boolean', 'example' => 'true', ], ], ], ], ], 'errorCodes' => [ 500 => [ [ 'errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"Msg\\": \\"scucess\\",\\n \\"RequestId\\": \\"DSSDF-SEWE-23ERW\\",\\n \\"TaskId\\": 2321,\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n success\\n FE104D26-AC19-49B5-AC67-947F6915E07E\\n true\\n 97358\\n","errorExample":""}]', 'title' => '提交平滑扩容预检任务', 'summary' => '提交平滑扩容预检任务。', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'UpdatePrivateRdsClass' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'systemTags' => [ 'operationType' => 'update', 'abilityTreeCode' => '76150', 'abilityTreeNodes' => [ 'FEATUREdrds25BO3L', ], ], 'parameters' => [ [ 'name' => 'RdsClass', 'in' => 'query', 'schema' => [ 'description' => '更新后的存储层私有定制RDS实例规格码。'."\n" ."\n" .'> 您可以调用[DescribeAvailableClasses](~~196546~~)接口查看可购买的存储层私有定制RDS实例规格，包括规格代码和存储空间范围。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'rds.mysql.c1.xlarge', ], ], [ 'name' => 'DrdsInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'PolarDB-X实例ID。'."\n" .'DRDS实例ID。'."\n" .'> 您可以调用[DescribeDrdsInstances](~~139284~~)查看目标账号下所有实例详情，包括实例ID。'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'drds*************', ], ], [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => '存储层私有定制RDS实例ID。'."\n" ."\n" .'> 您可以调用[DescribeDrdsRdsInstances](~~xxxx~~)查看目标PolarDB-X实例下所有存储层私有定制RDS实例详情，包括实例ID。'."\n" ."\n" .'> 您可以调用[DescribeDrdsRdsInstances](~~xxxx~~)查看目标DRDS实例下所有存储层RDS实例详情，包括实例ID。'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'rm-***************', ], ], [ 'name' => 'Storage', 'in' => 'query', 'schema' => [ 'description' => '更新后的存储层私有定制RDS实例的存储空间。'."\n" ."\n" .'> 您可以调用[DescribeAvailableClasses](~~196546~~)接口查看可购买的存储层私有定制RDS实例规格，包括规格代码和存储空间范围。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '50', ], ], [ 'name' => 'AutoUseCoupon', 'in' => 'query', 'schema' => [ 'description' => '是否使用代金券抵扣购买费用，取值为：**true**或**false**（默认值）。'."\n" ."\n" .'> 使用代金券后，若需要进行降配操作，由代金券抵扣的金额将不会进行退款。', 'type' => 'boolean', 'required' => false, 'example' => 'true', ], ], [ 'name' => 'PrePayDuration', 'in' => 'query', 'schema' => [ 'description' => '无效字段。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '12', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Data' => [ 'description' => '订单ID。', 'type' => 'string', 'example' => '{ "orderId": "209136011******" }', ], 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => '57D86AB4-8703-4DF4-BAB6-F7DE44******', ], 'Success' => [ 'description' => '请求是否成功。', 'type' => 'boolean', 'example' => 'true', ], ], ], ], ], 'errorCodes' => [ 500 => [ [ 'errorCode' => 'ModifyRdsClassApiError', 'errorMessage' => 'Failed to modify the class of the RDS instance.', ], [ 'errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"Data\\": \\"{ \\\\\\"orderId\\\\\\": \\\\\\"209136011******\\\\\\" }\\",\\n \\"RequestId\\": \\"57D86AB4-8703-4DF4-BAB6-F7DE44******\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"65C49036-181C-40A3-9034-465E417C6491\\n\\n 209136011******\\n\\ntrue","errorExample":""}]', 'title' => '升级或降级存储层私有定制RDS', 'summary' => '升级或降级存储层私有定制RDS实例的规格。', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'UpgradeHiStoreInstance' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'systemTags' => [ 'operationType' => 'none', 'abilityTreeCode' => '76151', 'abilityTreeNodes' => [ 'FEATUREdrds25BO3L', ], ], 'parameters' => [ [ 'name' => 'DrdsInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'DRDS 实例 ID', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'drdssad23sdfc', ], ], [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => '地域 ID ', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'default' => 'center', ], ], [ 'name' => 'HistoreInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'DRDS 列式存储实例 ID', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'hi-sesex2e', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Data' => [ 'description' => '升级版本请求是否成功，成功返回 true， 失败则返回错误信息', 'type' => 'string', 'example' => 'true', ], 'RequestId' => [ 'description' => '请求 ID', 'type' => 'string', 'example' => 'DSSDF-SEWE-23ERW', ], ], ], ], ], 'errorCodes' => [ 500 => [ [ 'errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error. 默认错误码', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"Data\\": \\"true\\",\\n \\"RequestId\\": \\"DSSDF-SEWE-23ERW\\"\\n}","errorExample":""},{"type":"xml","example":"\\n\\tDSSDF-SEWE-23ERW\\n\\tTrue\\n","errorExample":""}]', 'title' => '升级Histore实例', 'summary' => '升级 DRDS 列式存储的版本。', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], ], 'endpoints' => [ [ 'regionId' => 'ap-northeast-1', 'endpoint' => 'drds.ap-southeast-1.aliyuncs.com', ], [ 'regionId' => 'ap-northeast-2-pop', 'endpoint' => 'drds.ap-southeast-1.aliyuncs.com', ], [ 'regionId' => 'ap-south-1', 'endpoint' => 'drds.ap-southeast-1.aliyuncs.com', ], [ 'regionId' => 'ap-southeast-2', 'endpoint' => 'drds.ap-southeast-1.aliyuncs.com', ], [ 'regionId' => 'ap-southeast-3', 'endpoint' => 'drds.ap-southeast-1.aliyuncs.com', ], [ 'regionId' => 'ap-southeast-5', 'endpoint' => 'drds.ap-southeast-1.aliyuncs.com', ], [ 'regionId' => 'cn-beijing-finance-1', 'endpoint' => 'drds.aliyuncs.com', ], [ 'regionId' => 'cn-beijing-finance-pop', 'endpoint' => 'drds.aliyuncs.com', ], [ 'regionId' => 'cn-beijing-gov-1', 'endpoint' => 'drds.aliyuncs.com', ], [ 'regionId' => 'cn-beijing-nu16-b01', 'endpoint' => 'drds.aliyuncs.com', ], [ 'regionId' => 'cn-chengdu', 'endpoint' => 'drds.aliyuncs.com', ], [ 'regionId' => 'cn-edge-1', 'endpoint' => 'drds.aliyuncs.com', ], [ 'regionId' => 'cn-fujian', 'endpoint' => 'drds.aliyuncs.com', ], [ 'regionId' => 'cn-haidian-cm12-c01', 'endpoint' => 'drds.aliyuncs.com', ], [ 'regionId' => 'cn-hangzhou-bj-b01', 'endpoint' => 'drds.aliyuncs.com', ], [ 'regionId' => 'cn-hangzhou-finance', 'endpoint' => 'drds.aliyuncs.com', ], [ 'regionId' => 'cn-hangzhou-internal-prod-1', 'endpoint' => 'drds.aliyuncs.com', ], [ 'regionId' => 'cn-hangzhou-internal-test-1', 'endpoint' => 'drds.aliyuncs.com', ], [ 'regionId' => 'cn-hangzhou-internal-test-2', 'endpoint' => 'drds.aliyuncs.com', ], [ 'regionId' => 'cn-hangzhou-internal-test-3', 'endpoint' => 'drds.aliyuncs.com', ], [ 'regionId' => 'cn-hangzhou-test-306', 'endpoint' => 'drds.aliyuncs.com', ], [ 'regionId' => 'cn-hongkong-finance-pop', 'endpoint' => 'drds.aliyuncs.com', ], [ 'regionId' => 'cn-qingdao-nebula', 'endpoint' => 'drds.aliyuncs.com', ], [ 'regionId' => 'cn-shanghai-et15-b01', 'endpoint' => 'drds.aliyuncs.com', ], [ 'regionId' => 'cn-shanghai-et2-b01', 'endpoint' => 'drds.aliyuncs.com', ], [ 'regionId' => 'cn-shanghai-inner', 'endpoint' => 'drds.aliyuncs.com', ], [ 'regionId' => 'cn-shanghai-internal-test-1', 'endpoint' => 'drds.aliyuncs.com', ], [ 'regionId' => 'cn-shenzhen-inner', 'endpoint' => 'drds.aliyuncs.com', ], [ 'regionId' => 'cn-shenzhen-st4-d01', 'endpoint' => 'drds.aliyuncs.com', ], [ 'regionId' => 'cn-shenzhen-su18-b01', 'endpoint' => 'drds.aliyuncs.com', ], [ 'regionId' => 'cn-wuhan', 'endpoint' => 'drds.aliyuncs.com', ], [ 'regionId' => 'cn-yushanfang', 'endpoint' => 'drds.aliyuncs.com', ], [ 'regionId' => 'cn-zhangbei-na61-b01', 'endpoint' => 'drds.aliyuncs.com', ], [ 'regionId' => 'cn-zhangjiakou-na62-a01', 'endpoint' => 'drds.aliyuncs.com', ], [ 'regionId' => 'cn-zhengzhou-nebula-1', 'endpoint' => 'drds.aliyuncs.com', ], [ 'regionId' => 'eu-central-1', 'endpoint' => 'drds.ap-southeast-1.aliyuncs.com', ], [ 'regionId' => 'eu-west-1', 'endpoint' => 'drds.ap-southeast-1.aliyuncs.com', ], [ 'regionId' => 'eu-west-1-oxs', 'endpoint' => 'drds.ap-southeast-1.aliyuncs.com', ], [ 'regionId' => 'me-east-1', 'endpoint' => 'drds.ap-southeast-1.aliyuncs.com', ], [ 'regionId' => 'rus-west-1-pop', 'endpoint' => 'drds.ap-southeast-1.aliyuncs.com', ], [ 'regionId' => 'us-west-1', 'endpoint' => 'drds.ap-southeast-1.aliyuncs.com', ], [ 'regionId' => 'cn-hangzhou', 'endpoint' => 'drds.cn-hangzhou.aliyuncs.com', ], [ 'regionId' => 'ap-southeast-1', 'endpoint' => 'drds.ap-southeast-1.aliyuncs.com', ], [ 'regionId' => 'cn-beijing', 'endpoint' => 'drds.cn-beijing.aliyuncs.com', ], [ 'regionId' => 'cn-hongkong', 'endpoint' => 'drds.cn-hongkong.aliyuncs.com', ], [ 'regionId' => 'cn-huhehaote', 'endpoint' => 'drds.cn-huhehaote.aliyuncs.com', ], [ 'regionId' => 'cn-north-2-gov-1', 'endpoint' => 'drds.cn-north-2-gov-1.aliyuncs.com', ], [ 'regionId' => 'cn-qingdao', 'endpoint' => 'drds.cn-qingdao.aliyuncs.com', ], [ 'regionId' => 'cn-shanghai', 'endpoint' => 'drds.cn-shanghai.aliyuncs.com', ], [ 'regionId' => 'cn-shanghai-finance-1', 'endpoint' => 'drds.cn-shanghai-finance-1.aliyuncs.com', ], [ 'regionId' => 'cn-shenzhen', 'endpoint' => 'drds.cn-shenzhen.aliyuncs.com', ], [ 'regionId' => 'cn-shenzhen-finance-1', 'endpoint' => 'drds.cn-shenzhen-finance-1.aliyuncs.com', ], [ 'regionId' => 'cn-zhangjiakou', 'endpoint' => 'drds.cn-zhangjiakou.aliyuncs.com', ], [ 'regionId' => 'us-east-1', 'endpoint' => 'drds.us-east-1.aliyuncs.com', ], ], ];